3d154fbf12c5c130bca6a7496581aceef5355d35
[exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.87"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2016
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .endtable
440
441 The main specification and the specification of the filtering language are also
442 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
443 &<<SECTavail>>& below tells you how to get hold of these.
444
445
446
447 .section "FTP and web sites" "SECID2"
448 .cindex "web site"
449 .cindex "FTP site"
450 The primary site for Exim source distributions is currently the University of
451 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
452 distribution'& below. In addition, there is a web site and an FTP site at
453 &%exim.org%&. These are now also hosted at the University of Cambridge. The
454 &%exim.org%& site was previously hosted for a number of years by Energis
455 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
456
457 .cindex "wiki"
458 .cindex "FAQ"
459 As well as Exim distribution tar files, the Exim web site contains a number of
460 differently formatted versions of the documentation. A recent addition to the
461 online information is the Exim wiki (&url(http://wiki.exim.org)),
462 which contains what used to be a separate FAQ, as well as various other
463 examples, tips, and know-how that have been contributed by Exim users.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on this list and not on the general Exim
493 lists.
494
495 .section "Exim training" "SECID4"
496 .cindex "training courses"
497 Training courses in Cambridge (UK) used to be run annually by the author of
498 Exim, before he retired. At the time of writing, there are no plans to run
499 further Exim courses in Cambridge. However, if that changes, relevant
500 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
501
502 .section "Bug reports" "SECID5"
503 .cindex "bug reports"
504 .cindex "reporting bugs"
505 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
506 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
507 whether some behaviour is a bug or not, the best thing to do is to post a
508 message to the &'exim-dev'& mailing list and have it discussed.
509
510
511
512 .section "Where to find the Exim distribution" "SECTavail"
513 .cindex "FTP site"
514 .cindex "distribution" "ftp site"
515 The master ftp site for the Exim distribution is
516 .display
517 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
518 .endd
519 This is mirrored by
520 .display
521 &*ftp://ftp.exim.org/pub/exim*&
522 .endd
523 The file references that follow are relative to the &_exim_& directories at
524 these sites. There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.gz_&
533 &_exim-n.nn.tar.bz2_&
534 .endd
535 where &'n.nn'& is the highest such version number in the directory. The two
536 files contain identical data; the only difference is the type of compression.
537 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
538
539 .cindex "distribution" "signing details"
540 .cindex "distribution" "public key"
541 .cindex "public key for signed distribution"
542 The distributions will be PGP signed by an individual key of the Release
543 Coordinator.  This key will have a uid containing an email address in the
544 &'exim.org'& domain and will have signatures from other people, including
545 other Exim maintainers.  We expect that the key will be in the "strong set" of
546 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
547 PGP key, a version of which can be found in the release directory in the file
548 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
549 such as &'pool.sks-keyservers.net'&.
550
551 At time of last update, releases were being made by Phil Pennock and signed with
552 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
553 A trust path from Nigel's key to Phil's can be observed at
554 &url(https://www.security.spodhuis.org/exim-trustpath).
555
556 Releases have also been authorized to be performed by Todd Lyons who signs with
557 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
558 Pennock and Todd Lyons through a common associate.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.gz.asc_&
563 &_exim-n.nn.tar.bz2.asc_&
564 .endd
565 For each released version, the log of changes is made separately available in a
566 separate file in the directory &_ChangeLogs_& so that it is possible to
567 find out what has changed without having to download the entire distribution.
568
569 .cindex "documentation" "available formats"
570 The main distribution contains ASCII versions of this specification and other
571 documentation; other formats of the documents are available in separate files
572 inside the &_exim4_& directory of the FTP site:
573 .display
574 &_exim-html-n.nn.tar.gz_&
575 &_exim-pdf-n.nn.tar.gz_&
576 &_exim-postscript-n.nn.tar.gz_&
577 &_exim-texinfo-n.nn.tar.gz_&
578 .endd
579 These tar files contain only the &_doc_& directory, not the complete
580 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
581
582
583 .section "Limitations" "SECID6"
584 .ilist
585 .cindex "limitations of Exim"
586 .cindex "bang paths" "not handled by Exim"
587 Exim is designed for use as an Internet MTA, and therefore handles addresses in
588 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
589 simple two-component bang paths can be converted by a straightforward rewriting
590 configuration. This restriction does not prevent Exim from being interfaced to
591 UUCP as a transport mechanism, provided that domain addresses are used.
592 .next
593 .cindex "domainless addresses"
594 .cindex "address" "without domain"
595 Exim insists that every address it handles has a domain attached. For incoming
596 local messages, domainless addresses are automatically qualified with a
597 configured domain value. Configuration options specify from which remote
598 systems unqualified addresses are acceptable. These are then qualified on
599 arrival.
600 .next
601 .cindex "transport" "external"
602 .cindex "external transports"
603 The only external transport mechanisms that are currently implemented are SMTP
604 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
605 transport is available, and there are facilities for writing messages to files
606 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
607 to send messages to other transport mechanisms such as UUCP, provided they can
608 handle domain-style addresses. Batched SMTP input is also catered for.
609 .next
610 Exim is not designed for storing mail for dial-in hosts. When the volumes of
611 such mail are large, it is better to get the messages &"delivered"& into files
612 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
613 other means.
614 .next
615 Although Exim does have basic facilities for scanning incoming messages, these
616 are not comprehensive enough to do full virus or spam scanning. Such operations
617 are best carried out using additional specialized software packages. If you
618 compile Exim with the content-scanning extension, straightforward interfaces to
619 a number of common scanners are provided.
620 .endlist
621
622
623 .section "Run time configuration" "SECID7"
624 Exim's run time configuration is held in a single text file that is divided
625 into a number of sections. The entries in this file consist of keywords and
626 values, in the style of Smail 3 configuration files. A default configuration
627 file which is suitable for simple online installations is provided in the
628 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
629
630
631 .section "Calling interface" "SECID8"
632 .cindex "Sendmail compatibility" "command line interface"
633 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
634 can be a straight replacement for &_/usr/lib/sendmail_& or
635 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
636 about Sendmail in order to run Exim. For actions other than sending messages,
637 Sendmail-compatible options also exist, but those that produce output (for
638 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
639 format. There are also some additional options that are compatible with Smail
640 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
641 documents all Exim's command line options. This information is automatically
642 made into the man page that forms part of the Exim distribution.
643
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called &'eximon'&,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim's command line administration options.
648
649
650
651 .section "Terminology" "SECID9"
652 .cindex "terminology definitions"
653 .cindex "body of message" "definition of"
654 The &'body'& of a message is the actual data that the sender wants to transmit.
655 It is the last part of a message, and is separated from the &'header'& (see
656 below) by a blank line.
657
658 .cindex "bounce message" "definition of"
659 When a message cannot be delivered, it is normally returned to the sender in a
660 delivery failure message or a &"non-delivery report"& (NDR). The term
661 &'bounce'& is commonly used for this action, and the error reports are often
662 called &'bounce messages'&. This is a convenient shorthand for &"delivery
663 failure error report"&. Such messages have an empty sender address in the
664 message's &'envelope'& (see below) to ensure that they cannot themselves give
665 rise to further bounce messages.
666
667 The term &'default'& appears frequently in this manual. It is used to qualify a
668 value which is used in the absence of any setting in the configuration. It may
669 also qualify an action which is taken unless a configuration setting specifies
670 otherwise.
671
672 The term &'defer'& is used when the delivery of a message to a specific
673 destination cannot immediately take place for some reason (a remote host may be
674 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
675 until a later time.
676
677 The word &'domain'& is sometimes used to mean all but the first component of a
678 host's name. It is &'not'& used in that sense here, where it normally refers to
679 the part of an email address following the @ sign.
680
681 .cindex "envelope, definition of"
682 .cindex "sender" "definition of"
683 A message in transit has an associated &'envelope'&, as well as a header and a
684 body. The envelope contains a sender address (to which bounce messages should
685 be delivered), and any number of recipient addresses. References to the
686 sender or the recipients of a message usually mean the addresses in the
687 envelope. An MTA uses these addresses for delivery, and for returning bounce
688 messages, not the addresses that appear in the header lines.
689
690 .cindex "message" "header, definition of"
691 .cindex "header section" "definition of"
692 The &'header'& of a message is the first part of a message's text, consisting
693 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
694 &'Subject:'&, etc. Long header lines can be split over several text lines by
695 indenting the continuations. The header is separated from the body by a blank
696 line.
697
698 .cindex "local part" "definition of"
699 .cindex "domain" "definition of"
700 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
701 part of an email address that precedes the @ sign. The part that follows the
702 @ sign is called the &'domain'& or &'mail domain'&.
703
704 .cindex "local delivery" "definition of"
705 .cindex "remote delivery, definition of"
706 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
707 delivery to a file or a pipe on the local host from delivery by SMTP over
708 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
709 host it is running on are &'remote'&.
710
711 .cindex "return path" "definition of"
712 &'Return path'& is another name that is used for the sender address in a
713 message's envelope.
714
715 .cindex "queue" "definition of"
716 The term &'queue'& is used to refer to the set of messages awaiting delivery,
717 because this term is in widespread use in the context of MTAs. However, in
718 Exim's case the reality is more like a pool than a queue, because there is
719 normally no ordering of waiting messages.
720
721 .cindex "queue runner" "definition of"
722 The term &'queue runner'& is used to describe a process that scans the queue
723 and attempts to deliver those messages whose retry times have come. This term
724 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
725 the waiting messages are normally processed in an unpredictable order.
726
727 .cindex "spool directory" "definition of"
728 The term &'spool directory'& is used for a directory in which Exim keeps the
729 messages on its queue &-- that is, those that it is in the process of
730 delivering. This should not be confused with the directory in which local
731 mailboxes are stored, which is called a &"spool directory"& by some people. In
732 the Exim documentation, &"spool"& is always used in the first sense.
733
734
735
736
737
738
739 . ////////////////////////////////////////////////////////////////////////////
740 . ////////////////////////////////////////////////////////////////////////////
741
742 .chapter "Incorporated code" "CHID2"
743 .cindex "incorporated code"
744 .cindex "regular expressions" "library"
745 .cindex "PCRE"
746 .cindex "OpenDMARC"
747 A number of pieces of external code are included in the Exim distribution.
748
749 .ilist
750 Regular expressions are supported in the main Exim program and in the
751 Exim monitor using the freely-distributable PCRE library, copyright
752 &copy; University of Cambridge. The source to PCRE is no longer shipped with
753 Exim, so you will need to use the version of PCRE shipped with your system,
754 or obtain and install the full version of the library from
755 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
756 .next
757 .cindex "cdb" "acknowledgment"
758 Support for the cdb (Constant DataBase) lookup method is provided by code
759 contributed by Nigel Metheringham of (at the time he contributed it) Planet
760 Online Ltd. The implementation is completely contained within the code of Exim.
761 It does not link against an external cdb library. The code contains the
762 following statements:
763
764 .blockquote
765 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
766
767 This program is free software; you can redistribute it and/or modify it under
768 the terms of the GNU General Public License as published by the Free Software
769 Foundation; either version 2 of the License, or (at your option) any later
770 version.
771 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
772 the spec and sample code for cdb can be obtained from
773 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
774 some code from Dan Bernstein's implementation (which has no license
775 restrictions applied to it).
776 .endblockquote
777 .next
778 .cindex "SPA authentication"
779 .cindex "Samba project"
780 .cindex "Microsoft Secure Password Authentication"
781 Client support for Microsoft's &'Secure Password Authentication'& is provided
782 by code contributed by Marc Prud'hommeaux. Server support was contributed by
783 Tom Kistner. This includes code taken from the Samba project, which is released
784 under the Gnu GPL.
785 .next
786 .cindex "Cyrus"
787 .cindex "&'pwcheck'& daemon"
788 .cindex "&'pwauthd'& daemon"
789 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
790 by code taken from the Cyrus-SASL library and adapted by Alexander S.
791 Sabourenkov. The permission notice appears below, in accordance with the
792 conditions expressed therein.
793
794 .blockquote
795 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
796
797 Redistribution and use in source and binary forms, with or without
798 modification, are permitted provided that the following conditions
799 are met:
800
801 .olist
802 Redistributions of source code must retain the above copyright
803 notice, this list of conditions and the following disclaimer.
804 .next
805 Redistributions in binary form must reproduce the above copyright
806 notice, this list of conditions and the following disclaimer in
807 the documentation and/or other materials provided with the
808 distribution.
809 .next
810 The name &"Carnegie Mellon University"& must not be used to
811 endorse or promote products derived from this software without
812 prior written permission. For permission or any other legal
813 details, please contact
814 .display
815               Office of Technology Transfer
816               Carnegie Mellon University
817               5000 Forbes Avenue
818               Pittsburgh, PA  15213-3890
819               (412) 268-4387, fax: (412) 268-7395
820               tech-transfer@andrew.cmu.edu
821 .endd
822 .next
823 Redistributions of any form whatsoever must retain the following
824 acknowledgment:
825
826 &"This product includes software developed by Computing Services
827 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
828
829 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
830 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
831 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
832 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
833 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
834 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
835 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
836 .endlist
837 .endblockquote
838
839 .next
840 .cindex "Exim monitor" "acknowledgment"
841 .cindex "X-windows"
842 .cindex "Athena"
843 The Exim Monitor program, which is an X-Window application, includes
844 modified versions of the Athena StripChart and TextPop widgets.
845 This code is copyright by DEC and MIT, and their permission notice appears
846 below, in accordance with the conditions expressed therein.
847
848 .blockquote
849 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
850 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
851
852 All Rights Reserved
853
854 Permission to use, copy, modify, and distribute this software and its
855 documentation for any purpose and without fee is hereby granted,
856 provided that the above copyright notice appear in all copies and that
857 both that copyright notice and this permission notice appear in
858 supporting documentation, and that the names of Digital or MIT not be
859 used in advertising or publicity pertaining to distribution of the
860 software without specific, written prior permission.
861
862 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
863 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
864 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
865 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
866 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
867 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
868 SOFTWARE.
869 .endblockquote
870
871 .next
872 .cindex "opendmarc" "acknowledgment"
873 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
874 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
875 derived code are indicated in the respective source files. The full OpenDMARC
876 license is provided in the LICENSE.opendmarc file contained in the distributed
877 source code.
878
879 .next
880 Many people have contributed code fragments, some large, some small, that were
881 not covered by any specific licence requirements. It is assumed that the
882 contributors are happy to see their code incorporated into Exim under the GPL.
883 .endlist
884
885
886
887
888
889 . ////////////////////////////////////////////////////////////////////////////
890 . ////////////////////////////////////////////////////////////////////////////
891
892 .chapter "How Exim receives and delivers mail" "CHID11" &&&
893          "Receiving and delivering mail"
894
895
896 .section "Overall philosophy" "SECID10"
897 .cindex "design philosophy"
898 Exim is designed to work efficiently on systems that are permanently connected
899 to the Internet and are handling a general mix of mail. In such circumstances,
900 most messages can be delivered immediately. Consequently, Exim does not
901 maintain independent queues of messages for specific domains or hosts, though
902 it does try to send several messages in a single SMTP connection after a host
903 has been down, and it also maintains per-host retry information.
904
905
906 .section "Policy control" "SECID11"
907 .cindex "policy control" "overview"
908 Policy controls are now an important feature of MTAs that are connected to the
909 Internet. Perhaps their most important job is to stop MTAs being abused as
910 &"open relays"& by misguided individuals who send out vast amounts of
911 unsolicited junk, and want to disguise its source. Exim provides flexible
912 facilities for specifying policy controls on incoming mail:
913
914 .ilist
915 .cindex "&ACL;" "introduction"
916 Exim 4 (unlike previous versions of Exim) implements policy controls on
917 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
918 series of statements that may either grant or deny access. ACLs can be used at
919 several places in the SMTP dialogue while receiving a message from a remote
920 host. However, the most common places are after each RCPT command, and at the
921 very end of the message. The sysadmin can specify conditions for accepting or
922 rejecting individual recipients or the entire message, respectively, at these
923 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
924 error code.
925 .next
926 An ACL is also available for locally generated, non-SMTP messages. In this
927 case, the only available actions are to accept or deny the entire message.
928 .next
929 When Exim is compiled with the content-scanning extension, facilities are
930 provided in the ACL mechanism for passing the message to external virus and/or
931 spam scanning software. The result of such a scan is passed back to the ACL,
932 which can then use it to decide what to do with the message.
933 .next
934 When a message has been received, either from a remote host or from the local
935 host, but before the final acknowledgment has been sent, a locally supplied C
936 function called &[local_scan()]& can be run to inspect the message and decide
937 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
938 is accepted, the list of recipients can be modified by the function.
939 .next
940 Using the &[local_scan()]& mechanism is another way of calling external scanner
941 software. The &%SA-Exim%& add-on package works this way. It does not require
942 Exim to be compiled with the content-scanning extension.
943 .next
944 After a message has been accepted, a further checking mechanism is available in
945 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
946 runs at the start of every delivery process.
947 .endlist
948
949
950
951 .section "User filters" "SECID12"
952 .cindex "filter" "introduction"
953 .cindex "Sieve filter"
954 In a conventional Exim configuration, users are able to run private filters by
955 setting up appropriate &_.forward_& files in their home directories. See
956 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
957 configuration needed to support this, and the separate document entitled
958 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
959 of filtering are available:
960
961 .ilist
962 Sieve filters are written in the standard filtering language that is defined
963 by RFC 3028.
964 .next
965 Exim filters are written in a syntax that is unique to Exim, but which is more
966 powerful than Sieve, which it pre-dates.
967 .endlist
968
969 User filters are run as part of the routing process, described below.
970
971
972
973 .section "Message identification" "SECTmessiden"
974 .cindex "message ids" "details of format"
975 .cindex "format" "of message id"
976 .cindex "id of message"
977 .cindex "base62"
978 .cindex "base36"
979 .cindex "Darwin"
980 .cindex "Cygwin"
981 Every message handled by Exim is given a &'message id'& which is sixteen
982 characters long. It is divided into three parts, separated by hyphens, for
983 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
984 normally encoding numbers in base 62. However, in the Darwin operating
985 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
986 (avoiding the use of lower case letters) is used instead, because the message
987 id is used to construct file names, and the names of files in those systems are
988 not always case-sensitive.
989
990 .cindex "pid (process id)" "re-use of"
991 The detail of the contents of the message id have changed as Exim has evolved.
992 Earlier versions relied on the operating system not re-using a process id (pid)
993 within one second. On modern operating systems, this assumption can no longer
994 be made, so the algorithm had to be changed. To retain backward compatibility,
995 the format of the message id was retained, which is why the following rules are
996 somewhat eccentric:
997
998 .ilist
999 The first six characters of the message id are the time at which the message
1000 started to be received, to a granularity of one second. That is, this field
1001 contains the number of seconds since the start of the epoch (the normal Unix
1002 way of representing the date and time of day).
1003 .next
1004 After the first hyphen, the next six characters are the id of the process that
1005 received the message.
1006 .next
1007 There are two different possibilities for the final two characters:
1008 .olist
1009 .oindex "&%localhost_number%&"
1010 If &%localhost_number%& is not set, this value is the fractional part of the
1011 time of reception, normally in units of 1/2000 of a second, but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are 1/1000 of a second.
1014 .next
1015 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1016 the fractional part of the time, which in this case is in units of 1/200
1017 (1/100) of a second.
1018 .endlist
1019 .endlist
1020
1021 After a message has been received, Exim waits for the clock to tick at the
1022 appropriate resolution before proceeding, so that if another message is
1023 received by the same process, or by another process with the same (re-used)
1024 pid, it is guaranteed that the time will be different. In most cases, the clock
1025 will already have ticked while the message was being received.
1026
1027
1028 .section "Receiving mail" "SECID13"
1029 .cindex "receiving mail"
1030 .cindex "message" "reception"
1031 The only way Exim can receive mail from another host is using SMTP over
1032 TCP/IP, in which case the sender and recipient addresses are transferred using
1033 SMTP commands. However, from a locally running process (such as a user's MUA),
1034 there are several possibilities:
1035
1036 .ilist
1037 If the process runs Exim with the &%-bm%& option, the message is read
1038 non-interactively (usually via a pipe), with the recipients taken from the
1039 command line, or from the body of the message if &%-t%& is also used.
1040 .next
1041 If the process runs Exim with the &%-bS%& option, the message is also read
1042 non-interactively, but in this case the recipients are listed at the start of
1043 the message in a series of SMTP RCPT commands, terminated by a DATA
1044 command. This is so-called &"batch SMTP"& format,
1045 but it isn't really SMTP. The SMTP commands are just another way of passing
1046 envelope addresses in a non-interactive submission.
1047 .next
1048 If the process runs Exim with the &%-bs%& option, the message is read
1049 interactively, using the SMTP protocol. A two-way pipe is normally used for
1050 passing data between the local process and the Exim process.
1051 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1052 example, the ACLs for SMTP commands are used for this form of submission.
1053 .next
1054 A local process may also make a TCP/IP call to the host's loopback address
1055 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1056 does not treat the loopback address specially. It treats all such connections
1057 in the same way as connections from other hosts.
1058 .endlist
1059
1060
1061 .cindex "message sender, constructed by Exim"
1062 .cindex "sender" "constructed by Exim"
1063 In the three cases that do not involve TCP/IP, the sender address is
1064 constructed from the login name of the user that called Exim and a default
1065 qualification domain (which can be set by the &%qualify_domain%& configuration
1066 option). For local or batch SMTP, a sender address that is passed using the
1067 SMTP MAIL command is ignored. However, the system administrator may allow
1068 certain users (&"trusted users"&) to specify a different sender address
1069 unconditionally, or all users to specify certain forms of different sender
1070 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1071 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1072 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1073 users to change sender addresses.
1074
1075 Messages received by either of the non-interactive mechanisms are subject to
1076 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1077 (either over TCP/IP, or interacting with a local process) can be checked by a
1078 number of ACLs that operate at different times during the SMTP session. Either
1079 individual recipients, or the entire message, can be rejected if local policy
1080 requirements are not met. The &[local_scan()]& function (see chapter
1081 &<<CHAPlocalscan>>&) is run for all incoming messages.
1082
1083 Exim can be configured not to start a delivery process when a message is
1084 received; this can be unconditional, or depend on the number of incoming SMTP
1085 connections or the system load. In these situations, new messages wait on the
1086 queue until a queue runner process picks them up. However, in standard
1087 configurations under normal conditions, delivery is started as soon as a
1088 message is received.
1089
1090
1091
1092
1093
1094 .section "Handling an incoming message" "SECID14"
1095 .cindex "spool directory" "files that hold a message"
1096 .cindex "file" "how a message is held"
1097 When Exim accepts a message, it writes two files in its spool directory. The
1098 first contains the envelope information, the current status of the message, and
1099 the header lines, and the second contains the body of the message. The names of
1100 the two spool files consist of the message id, followed by &`-H`& for the
1101 file containing the envelope and header, and &`-D`& for the data file.
1102
1103 .cindex "spool directory" "&_input_& sub-directory"
1104 By default all these message files are held in a single directory called
1105 &_input_& inside the general Exim spool directory. Some operating systems do
1106 not perform very well if the number of files in a directory gets large; to
1107 improve performance in such cases, the &%split_spool_directory%& option can be
1108 used. This causes Exim to split up the input files into 62 sub-directories
1109 whose names are single letters or digits. When this is done, the queue is
1110 processed one sub-directory at a time instead of all at once, which can improve
1111 overall performance even when there are not enough files in each directory to
1112 affect file system performance.
1113
1114 The envelope information consists of the address of the message's sender and
1115 the addresses of the recipients. This information is entirely separate from
1116 any addresses contained in the header lines. The status of the message includes
1117 a list of recipients who have already received the message. The format of the
1118 first spool file is described in chapter &<<CHAPspool>>&.
1119
1120 .cindex "rewriting" "addresses"
1121 Address rewriting that is specified in the rewrite section of the configuration
1122 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1123 both in the header lines and the envelope, at the time the message is accepted.
1124 If during the course of delivery additional addresses are generated (for
1125 example, via aliasing), these new addresses are rewritten as soon as they are
1126 generated. At the time a message is actually delivered (transported) further
1127 rewriting can take place; because this is a transport option, it can be
1128 different for different forms of delivery. It is also possible to specify the
1129 addition or removal of certain header lines at the time the message is
1130 delivered (see chapters &<<CHAProutergeneric>>& and
1131 &<<CHAPtransportgeneric>>&).
1132
1133
1134
1135 .section "Life of a message" "SECID15"
1136 .cindex "message" "life of"
1137 .cindex "message" "frozen"
1138 A message remains in the spool directory until it is completely delivered to
1139 its recipients or to an error address, or until it is deleted by an
1140 administrator or by the user who originally created it. In cases when delivery
1141 cannot proceed &-- for example, when a message can neither be delivered to its
1142 recipients nor returned to its sender, the message is marked &"frozen"& on the
1143 spool, and no more deliveries are attempted.
1144
1145 .cindex "frozen messages" "thawing"
1146 .cindex "message" "thawing frozen"
1147 An administrator can &"thaw"& such messages when the problem has been
1148 corrected, and can also freeze individual messages by hand if necessary. In
1149 addition, an administrator can force a delivery error, causing a bounce message
1150 to be sent.
1151
1152 .oindex "&%timeout_frozen_after%&"
1153 .oindex "&%ignore_bounce_errors_after%&"
1154 There are options called &%ignore_bounce_errors_after%& and
1155 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1156 The first applies only to frozen bounces, the second to any frozen messages.
1157
1158 .cindex "message" "log file for"
1159 .cindex "log" "file for each message"
1160 While Exim is working on a message, it writes information about each delivery
1161 attempt to its main log file. This includes successful, unsuccessful, and
1162 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1163 lines are also written to a separate &'message log'& file for each message.
1164 These logs are solely for the benefit of the administrator, and are normally
1165 deleted along with the spool files when processing of a message is complete.
1166 The use of individual message logs can be disabled by setting
1167 &%no_message_logs%&; this might give an improvement in performance on very busy
1168 systems.
1169
1170 .cindex "journal file"
1171 .cindex "file" "journal"
1172 All the information Exim itself needs to set up a delivery is kept in the first
1173 spool file, along with the header lines. When a successful delivery occurs, the
1174 address is immediately written at the end of a journal file, whose name is the
1175 message id followed by &`-J`&. At the end of a delivery run, if there are some
1176 addresses left to be tried again later, the first spool file (the &`-H`& file)
1177 is updated to indicate which these are, and the journal file is then deleted.
1178 Updating the spool file is done by writing a new file and renaming it, to
1179 minimize the possibility of data loss.
1180
1181 Should the system or the program crash after a successful delivery but before
1182 the spool file has been updated, the journal is left lying around. The next
1183 time Exim attempts to deliver the message, it reads the journal file and
1184 updates the spool file before proceeding. This minimizes the chances of double
1185 deliveries caused by crashes.
1186
1187
1188
1189 .section "Processing an address for delivery" "SECTprocaddress"
1190 .cindex "drivers" "definition of"
1191 .cindex "router" "definition of"
1192 .cindex "transport" "definition of"
1193 The main delivery processing elements of Exim are called &'routers'& and
1194 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1195 number of them is provided in the source distribution, and compile-time options
1196 specify which ones are included in the binary. Run time options specify which
1197 ones are actually used for delivering messages.
1198
1199 .cindex "drivers" "instance definition"
1200 Each driver that is specified in the run time configuration is an &'instance'&
1201 of that particular driver type. Multiple instances are allowed; for example,
1202 you can set up several different &(smtp)& transports, each with different
1203 option values that might specify different ports or different timeouts. Each
1204 instance has its own identifying name. In what follows we will normally use the
1205 instance name when discussing one particular instance (that is, one specific
1206 configuration of the driver), and the generic driver name when discussing
1207 the driver's features in general.
1208
1209 A &'router'& is a driver that operates on an address, either determining how
1210 its delivery should happen, by assigning it to a specific transport, or
1211 converting the address into one or more new addresses (for example, via an
1212 alias file). A router may also explicitly choose to fail an address, causing it
1213 to be bounced.
1214
1215 A &'transport'& is a driver that transmits a copy of the message from Exim's
1216 spool to some destination. There are two kinds of transport: for a &'local'&
1217 transport, the destination is a file or a pipe on the local host, whereas for a
1218 &'remote'& transport the destination is some other host. A message is passed
1219 to a specific transport as a result of successful routing. If a message has
1220 several recipients, it may be passed to a number of different transports.
1221
1222 .cindex "preconditions" "definition of"
1223 An address is processed by passing it to each configured router instance in
1224 turn, subject to certain preconditions, until a router accepts the address or
1225 specifies that it should be bounced. We will describe this process in more
1226 detail shortly. First, as a simple example, we consider how each recipient
1227 address in a message is processed in a small configuration of three routers.
1228
1229 To make this a more concrete example, it is described in terms of some actual
1230 routers, but remember, this is only an example. You can configure Exim's
1231 routers in many different ways, and there may be any number of routers in a
1232 configuration.
1233
1234 The first router that is specified in a configuration is often one that handles
1235 addresses in domains that are not recognized specially by the local host. These
1236 are typically addresses for arbitrary domains on the Internet. A precondition
1237 is set up which looks for the special domains known to the host (for example,
1238 its own domain name), and the router is run for addresses that do &'not'&
1239 match. Typically, this is a router that looks up domains in the DNS in order to
1240 find the hosts to which this address routes. If it succeeds, the address is
1241 assigned to a suitable SMTP transport; if it does not succeed, the router is
1242 configured to fail the address.
1243
1244 The second router is reached only when the domain is recognized as one that
1245 &"belongs"& to the local host. This router does redirection &-- also known as
1246 aliasing and forwarding. When it generates one or more new addresses from the
1247 original, each of them is routed independently from the start. Otherwise, the
1248 router may cause an address to fail, or it may simply decline to handle the
1249 address, in which case the address is passed to the next router.
1250
1251 The final router in many configurations is one that checks to see if the
1252 address belongs to a local mailbox. The precondition may involve a check to
1253 see if the local part is the name of a login account, or it may look up the
1254 local part in a file or a database. If its preconditions are not met, or if
1255 the router declines, we have reached the end of the routers. When this happens,
1256 the address is bounced.
1257
1258
1259
1260 .section "Processing an address for verification" "SECID16"
1261 .cindex "router" "for verification"
1262 .cindex "verifying address" "overview"
1263 As well as being used to decide how to deliver to an address, Exim's routers
1264 are also used for &'address verification'&. Verification can be requested as
1265 one of the checks to be performed in an ACL for incoming messages, on both
1266 sender and recipient addresses, and it can be tested using the &%-bv%& and
1267 &%-bvs%& command line options.
1268
1269 When an address is being verified, the routers are run in &"verify mode"&. This
1270 does not affect the way the routers work, but it is a state that can be
1271 detected. By this means, a router can be skipped or made to behave differently
1272 when verifying. A common example is a configuration in which the first router
1273 sends all messages to a message-scanning program, unless they have been
1274 previously scanned. Thus, the first router accepts all addresses without any
1275 checking, making it useless for verifying. Normally, the &%no_verify%& option
1276 would be set for such a router, causing it to be skipped in verify mode.
1277
1278
1279
1280
1281 .section "Running an individual router" "SECTrunindrou"
1282 .cindex "router" "running details"
1283 .cindex "preconditions" "checking"
1284 .cindex "router" "result of running"
1285 As explained in the example above, a number of preconditions are checked before
1286 running a router. If any are not met, the router is skipped, and the address is
1287 passed to the next router. When all the preconditions on a router &'are'& met,
1288 the router is run. What happens next depends on the outcome, which is one of
1289 the following:
1290
1291 .ilist
1292 &'accept'&: The router accepts the address, and either assigns it to a
1293 transport, or generates one or more &"child"& addresses. Processing the
1294 original address ceases,
1295 .oindex "&%unseen%&"
1296 unless the &%unseen%& option is set on the router. This option
1297 can be used to set up multiple deliveries with different routing (for example,
1298 for keeping archive copies of messages). When &%unseen%& is set, the address is
1299 passed to the next router. Normally, however, an &'accept'& return marks the
1300 end of routing.
1301
1302 Any child addresses generated by the router are processed independently,
1303 starting with the first router by default. It is possible to change this by
1304 setting the &%redirect_router%& option to specify which router to start at for
1305 child addresses. Unlike &%pass_router%& (see below) the router specified by
1306 &%redirect_router%& may be anywhere in the router configuration.
1307 .next
1308 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1309 requests that the address be passed to another router. By default the address
1310 is passed to the next router, but this can be changed by setting the
1311 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1312 must be below the current router (to avoid loops).
1313 .next
1314 &'decline'&: The router declines to accept the address because it does not
1315 recognize it at all. By default, the address is passed to the next router, but
1316 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1317 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1318 &'decline'& into &'fail'&.
1319 .next
1320 &'fail'&: The router determines that the address should fail, and queues it for
1321 the generation of a bounce message. There is no further processing of the
1322 original address unless &%unseen%& is set on the router.
1323 .next
1324 &'defer'&: The router cannot handle the address at the present time. (A
1325 database may be offline, or a DNS lookup may have timed out.) No further
1326 processing of the address happens in this delivery attempt. It is tried again
1327 next time the message is considered for delivery.
1328 .next
1329 &'error'&: There is some error in the router (for example, a syntax error in
1330 its configuration). The action is as for defer.
1331 .endlist
1332
1333 If an address reaches the end of the routers without having been accepted by
1334 any of them, it is bounced as unrouteable. The default error message in this
1335 situation is &"unrouteable address"&, but you can set your own message by
1336 making use of the &%cannot_route_message%& option. This can be set for any
1337 router; the value from the last router that &"saw"& the address is used.
1338
1339 Sometimes while routing you want to fail a delivery when some conditions are
1340 met but others are not, instead of passing the address on for further routing.
1341 You can do this by having a second router that explicitly fails the delivery
1342 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1343 facility for this purpose.
1344
1345
1346 .section "Duplicate addresses" "SECID17"
1347 .cindex "case of local parts"
1348 .cindex "address duplicate, discarding"
1349 .cindex "duplicate addresses"
1350 Once routing is complete, Exim scans the addresses that are assigned to local
1351 and remote transports, and discards any duplicates that it finds. During this
1352 check, local parts are treated as case-sensitive. This happens only when
1353 actually delivering a message; when testing routers with &%-bt%&, all the
1354 routed addresses are shown.
1355
1356
1357
1358 .section "Router preconditions" "SECTrouprecon"
1359 .cindex "router" "preconditions, order of processing"
1360 .cindex "preconditions" "order of processing"
1361 The preconditions that are tested for each router are listed below, in the
1362 order in which they are tested. The individual configuration options are
1363 described in more detail in chapter &<<CHAProutergeneric>>&.
1364
1365 .ilist
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 If the &%local_parts%& option is set, the local part of the address must be in
1403 the set of local parts that it defines. If &%local_part_prefix%& or
1404 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1405 part before this check. If you want to do precondition tests on local parts
1406 that include affixes, you can do so by using a &%condition%& option (see below)
1407 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1408 &$local_part_suffix$& as necessary.
1409 .next
1410 .vindex "&$local_user_uid$&"
1411 .vindex "&$local_user_gid$&"
1412 .vindex "&$home$&"
1413 If the &%check_local_user%& option is set, the local part must be the name of
1414 an account on the local host. If this check succeeds, the uid and gid of the
1415 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1416 user's home directory is placed in &$home$&; these values can be used in the
1417 remaining preconditions.
1418 .next
1419 If the &%router_home_directory%& option is set, it is expanded at this point,
1420 because it overrides the value of &$home$&. If this expansion were left till
1421 later, the value of &$home$& as set by &%check_local_user%& would be used in
1422 subsequent tests. Having two different values of &$home$& in the same router
1423 could lead to confusion.
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427 .next
1428 If the &%require_files%& option is set, the existence or non-existence of
1429 specified files is tested.
1430 .next
1431 .cindex "customizing" "precondition"
1432 If the &%condition%& option is set, it is evaluated and tested. This option
1433 uses an expanded string to allow you to set up your own custom preconditions.
1434 Expanded strings are described in chapter &<<CHAPexpand>>&.
1435 .endlist
1436
1437
1438 Note that &%require_files%& comes near the end of the list, so you cannot use
1439 it to check for the existence of a file in which to lookup up a domain, local
1440 part, or sender. However, as these options are all expanded, you can use the
1441 &%exists%& expansion condition to make such tests within each condition. The
1442 &%require_files%& option is intended for checking files that the router may be
1443 going to use internally, or which are needed by a specific transport (for
1444 example, &_.procmailrc_&).
1445
1446
1447
1448 .section "Delivery in detail" "SECID18"
1449 .cindex "delivery" "in detail"
1450 When a message is to be delivered, the sequence of events is as follows:
1451
1452 .ilist
1453 If a system-wide filter file is specified, the message is passed to it. The
1454 filter may add recipients to the message, replace the recipients, discard the
1455 message, cause a new message to be generated, or cause the message delivery to
1456 fail. The format of the system filter file is the same as for Exim user filter
1457 files, described in the separate document entitled &'Exim's interfaces to mail
1458 filtering'&.
1459 .cindex "Sieve filter" "not available for system filter"
1460 (&*Note*&: Sieve cannot be used for system filter files.)
1461
1462 Some additional features are available in system filters &-- see chapter
1463 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1464 filter only once per delivery attempt, however many recipients it has. However,
1465 if there are several delivery attempts because one or more addresses could not
1466 be immediately delivered, the system filter is run each time. The filter
1467 condition &%first_delivery%& can be used to detect the first run of the system
1468 filter.
1469 .next
1470 Each recipient address is offered to each configured router in turn, subject to
1471 its preconditions, until one is able to handle it. If no router can handle the
1472 address, that is, if they all decline, the address is failed. Because routers
1473 can be targeted at particular domains, several locally handled domains can be
1474 processed entirely independently of each other.
1475 .next
1476 .cindex "routing" "loops in"
1477 .cindex "loop" "while routing"
1478 A router that accepts an address may assign it to a local or a remote
1479 transport. However, the transport is not run at this time. Instead, the address
1480 is placed on a list for the particular transport, which will be run later.
1481 Alternatively, the router may generate one or more new addresses (typically
1482 from alias, forward, or filter files). New addresses are fed back into this
1483 process from the top, but in order to avoid loops, a router ignores any address
1484 which has an identically-named ancestor that was processed by itself.
1485 .next
1486 When all the routing has been done, addresses that have been successfully
1487 handled are passed to their assigned transports. When local transports are
1488 doing real local deliveries, they handle only one address at a time, but if a
1489 local transport is being used as a pseudo-remote transport (for example, to
1490 collect batched SMTP messages for transmission by some other means) multiple
1491 addresses can be handled. Remote transports can always handle more than one
1492 address at a time, but can be configured not to do so, or to restrict multiple
1493 addresses to the same domain.
1494 .next
1495 Each local delivery to a file or a pipe runs in a separate process under a
1496 non-privileged uid, and these deliveries are run one at a time. Remote
1497 deliveries also run in separate processes, normally under a uid that is private
1498 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1499 run in parallel. The maximum number of simultaneous remote deliveries for any
1500 one message is set by the &%remote_max_parallel%& option.
1501 The order in which deliveries are done is not defined, except that all local
1502 deliveries happen before any remote deliveries.
1503 .next
1504 .cindex "queue runner"
1505 When it encounters a local delivery during a queue run, Exim checks its retry
1506 database to see if there has been a previous temporary delivery failure for the
1507 address before running the local transport. If there was a previous failure,
1508 Exim does not attempt a new delivery until the retry time for the address is
1509 reached. However, this happens only for delivery attempts that are part of a
1510 queue run. Local deliveries are always attempted when delivery immediately
1511 follows message reception, even if retry times are set for them. This makes for
1512 better behaviour if one particular message is causing problems (for example,
1513 causing quota overflow, or provoking an error in a filter file).
1514 .next
1515 .cindex "delivery" "retry in remote transports"
1516 Remote transports do their own retry handling, since an address may be
1517 deliverable to one of a number of hosts, each of which may have a different
1518 retry time. If there have been previous temporary failures and no host has
1519 reached its retry time, no delivery is attempted, whether in a queue run or
1520 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1521 .next
1522 If there were any permanent errors, a bounce message is returned to an
1523 appropriate address (the sender in the common case), with details of the error
1524 for each failing address. Exim can be configured to send copies of bounce
1525 messages to other addresses.
1526 .next
1527 .cindex "delivery" "deferral"
1528 If one or more addresses suffered a temporary failure, the message is left on
1529 the queue, to be tried again later. Delivery of these addresses is said to be
1530 &'deferred'&.
1531 .next
1532 When all the recipient addresses have either been delivered or bounced,
1533 handling of the message is complete. The spool files and message log are
1534 deleted, though the message log can optionally be preserved if required.
1535 .endlist
1536
1537
1538
1539
1540 .section "Retry mechanism" "SECID19"
1541 .cindex "delivery" "retry mechanism"
1542 .cindex "retry" "description of mechanism"
1543 .cindex "queue runner"
1544 Exim's mechanism for retrying messages that fail to get delivered at the first
1545 attempt is the queue runner process. You must either run an Exim daemon that
1546 uses the &%-q%& option with a time interval to start queue runners at regular
1547 intervals, or use some other means (such as &'cron'&) to start them. If you do
1548 not arrange for queue runners to be run, messages that fail temporarily at the
1549 first attempt will remain on your queue for ever. A queue runner process works
1550 its way through the queue, one message at a time, trying each delivery that has
1551 passed its retry time.
1552 You can run several queue runners at once.
1553
1554 Exim uses a set of configured rules to determine when next to retry the failing
1555 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1556 should give up trying to deliver to the address, at which point it generates a
1557 bounce message. If no retry rules are set for a particular host, address, and
1558 error combination, no retries are attempted, and temporary errors are treated
1559 as permanent.
1560
1561
1562
1563 .section "Temporary delivery failure" "SECID20"
1564 .cindex "delivery" "temporary failure"
1565 There are many reasons why a message may not be immediately deliverable to a
1566 particular address. Failure to connect to a remote machine (because it, or the
1567 connection to it, is down) is one of the most common. Temporary failures may be
1568 detected during routing as well as during the transport stage of delivery.
1569 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1570 is on a file system where the user is over quota. Exim can be configured to
1571 impose its own quotas on local mailboxes; where system quotas are set they will
1572 also apply.
1573
1574 If a host is unreachable for a period of time, a number of messages may be
1575 waiting for it by the time it recovers, and sending them in a single SMTP
1576 connection is clearly beneficial. Whenever a delivery to a remote host is
1577 deferred,
1578 .cindex "hints database" "deferred deliveries"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default is set at build time). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&.
1989 Exim used to
1990 have a compile option for including A6 record support but this has now been
1991 withdrawn.
1992
1993
1994
1995 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1996 .cindex "lookup modules"
1997 .cindex "dynamic modules"
1998 .cindex ".so building"
1999 On some platforms, Exim supports not compiling all lookup types directly into
2000 the main binary, instead putting some into external modules which can be loaded
2001 on demand.
2002 This permits packagers to build Exim with support for lookups with extensive
2003 library dependencies without requiring all users to install all of those
2004 dependencies.
2005 Most, but not all, lookup types can be built this way.
2006
2007 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2008 installed; Exim will only load modules from that directory, as a security
2009 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2010 for your OS; see &_OS/Makefile-Linux_& for an example.
2011 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2012 see &_src/EDITME_& for details.
2013
2014 Then, for each module to be loaded dynamically, define the relevant
2015 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2016 For example, this will build in lsearch but load sqlite and mysql support
2017 on demand:
2018 .code
2019 LOOKUP_LSEARCH=yes
2020 LOOKUP_SQLITE=2
2021 LOOKUP_MYSQL=2
2022 .endd
2023
2024
2025 .section "The building process" "SECID29"
2026 .cindex "build directory"
2027 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2028 created, run &'make'& at the top level. It determines the architecture and
2029 operating system types, and creates a build directory if one does not exist.
2030 For example, on a Sun system running Solaris 8, the directory
2031 &_build-SunOS5-5.8-sparc_& is created.
2032 .cindex "symbolic link" "to source files"
2033 Symbolic links to relevant source files are installed in the build directory.
2034
2035 If this is the first time &'make'& has been run, it calls a script that builds
2036 a make file inside the build directory, using the configuration files from the
2037 &_Local_& directory. The new make file is then passed to another instance of
2038 &'make'&. This does the real work, building a number of utility scripts, and
2039 then compiling and linking the binaries for the Exim monitor (if configured), a
2040 number of utility programs, and finally Exim itself. The command &`make
2041 makefile`& can be used to force a rebuild of the make file in the build
2042 directory, should this ever be necessary.
2043
2044 If you have problems building Exim, check for any comments there may be in the
2045 &_README_& file concerning your operating system, and also take a look at the
2046 FAQ, where some common problems are covered.
2047
2048
2049
2050 .section 'Output from &"make"&' "SECID283"
2051 The output produced by the &'make'& process for compile lines is often very
2052 unreadable, because these lines can be very long. For this reason, the normal
2053 output is suppressed by default, and instead output similar to that which
2054 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2055 each module that is being compiled or linked. However, it is still possible to
2056 get the full output, by calling &'make'& like this:
2057 .code
2058 FULLECHO='' make -e
2059 .endd
2060 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2061 command reflection in &'make'&. When you ask for the full output, it is
2062 given in addition to the short output.
2063
2064
2065
2066 .section "Overriding build-time options for Exim" "SECToverride"
2067 .cindex "build-time options, overriding"
2068 The main make file that is created at the beginning of the building process
2069 consists of the concatenation of a number of files which set configuration
2070 values, followed by a fixed set of &'make'& instructions. If a value is set
2071 more than once, the last setting overrides any previous ones. This provides a
2072 convenient way of overriding defaults. The files that are concatenated are, in
2073 order:
2074 .display
2075 &_OS/Makefile-Default_&
2076 &_OS/Makefile-_&<&'ostype'&>
2077 &_Local/Makefile_&
2078 &_Local/Makefile-_&<&'ostype'&>
2079 &_Local/Makefile-_&<&'archtype'&>
2080 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2081 &_OS/Makefile-Base_&
2082 .endd
2083 .cindex "&_Local/Makefile_&"
2084 .cindex "building Exim" "operating system type"
2085 .cindex "building Exim" "architecture type"
2086 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2087 architecture type. &_Local/Makefile_& is required to exist, and the building
2088 process fails if it is absent. The other three &_Local_& files are optional,
2089 and are often not needed.
2090
2091 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2092 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2093 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2094 values are used, thereby providing a means of forcing particular settings.
2095 Otherwise, the scripts try to get values from the &%uname%& command. If this
2096 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2097 of &'ad hoc'& transformations are then applied, to produce the standard names
2098 that Exim expects. You can run these scripts directly from the shell in order
2099 to find out what values are being used on your system.
2100
2101
2102 &_OS/Makefile-Default_& contains comments about the variables that are set
2103 therein. Some (but not all) are mentioned below. If there is something that
2104 needs changing, review the contents of this file and the contents of the make
2105 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2106 default values are.
2107
2108
2109 .cindex "building Exim" "overriding default settings"
2110 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2111 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2112 need to change the original files. Instead, you should make the changes by
2113 putting the new values in an appropriate &_Local_& file. For example,
2114 .cindex "Tru64-Unix build-time settings"
2115 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2116 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2117 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2118 called with the option &%-std1%&, to make it recognize some of the features of
2119 Standard C that Exim uses. (Most other compilers recognize Standard C by
2120 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2121 containing the lines
2122 .code
2123 CC=cc
2124 CFLAGS=-std1
2125 .endd
2126 If you are compiling for just one operating system, it may be easier to put
2127 these lines directly into &_Local/Makefile_&.
2128
2129 Keeping all your local configuration settings separate from the distributed
2130 files makes it easy to transfer them to new versions of Exim simply by copying
2131 the contents of the &_Local_& directory.
2132
2133
2134 .cindex "NIS lookup type" "including support for"
2135 .cindex "NIS+ lookup type" "including support for"
2136 .cindex "LDAP" "including support for"
2137 .cindex "lookup" "inclusion in binary"
2138 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2139 lookup, but not all systems have these components installed, so the default is
2140 not to include the relevant code in the binary. All the different kinds of file
2141 and database lookup that Exim supports are implemented as separate code modules
2142 which are included only if the relevant compile-time options are set. In the
2143 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2144 .code
2145 LOOKUP_LDAP=yes
2146 LOOKUP_NIS=yes
2147 LOOKUP_NISPLUS=yes
2148 .endd
2149 and similar settings apply to the other lookup types. They are all listed in
2150 &_src/EDITME_&. In many cases the relevant include files and interface
2151 libraries need to be installed before compiling Exim.
2152 .cindex "cdb" "including support for"
2153 However, there are some optional lookup types (such as cdb) for which
2154 the code is entirely contained within Exim, and no external include
2155 files or libraries are required. When a lookup type is not included in the
2156 binary, attempts to configure Exim to use it cause run time configuration
2157 errors.
2158
2159 .cindex "pkg-config" "lookups"
2160 .cindex "pkg-config" "authenticators"
2161 Many systems now use a tool called &'pkg-config'& to encapsulate information
2162 about how to compile against a library; Exim has some initial support for
2163 being able to use pkg-config for lookups and authenticators.  For any given
2164 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2165 variable with the &`_PC`& suffix in the name and assign as the value the
2166 name of the package to be queried.  The results of querying via the
2167 &'pkg-config'& command will be added to the appropriate Makefile variables
2168 with &`+=`& directives, so your version of &'make'& will need to support that
2169 syntax.  For instance:
2170 .code
2171 LOOKUP_SQLITE=yes
2172 LOOKUP_SQLITE_PC=sqlite3
2173 AUTH_GSASL=yes
2174 AUTH_GSASL_PC=libgsasl
2175 AUTH_HEIMDAL_GSSAPI=yes
2176 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2177 .endd
2178
2179 .cindex "Perl" "including support for"
2180 Exim can be linked with an embedded Perl interpreter, allowing Perl
2181 subroutines to be called during string expansion. To enable this facility,
2182 .code
2183 EXIM_PERL=perl.o
2184 .endd
2185 must be defined in &_Local/Makefile_&. Details of this facility are given in
2186 chapter &<<CHAPperl>>&.
2187
2188 .cindex "X11 libraries, location of"
2189 The location of the X11 libraries is something that varies a lot between
2190 operating systems, and there may be different versions of X11 to cope
2191 with. Exim itself makes no use of X11, but if you are compiling the Exim
2192 monitor, the X11 libraries must be available.
2193 The following three variables are set in &_OS/Makefile-Default_&:
2194 .code
2195 X11=/usr/X11R6
2196 XINCLUDE=-I$(X11)/include
2197 XLFLAGS=-L$(X11)/lib
2198 .endd
2199 These are overridden in some of the operating-system configuration files. For
2200 example, in &_OS/Makefile-SunOS5_& there is
2201 .code
2202 X11=/usr/openwin
2203 XINCLUDE=-I$(X11)/include
2204 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2205 .endd
2206 If you need to override the default setting for your operating system, place a
2207 definition of all three of these variables into your
2208 &_Local/Makefile-<ostype>_& file.
2209
2210 .cindex "EXTRALIBS"
2211 If you need to add any extra libraries to the link steps, these can be put in a
2212 variable called EXTRALIBS, which appears in all the link commands, but by
2213 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2214 command for linking the main Exim binary, and not for any associated utilities.
2215
2216 .cindex "DBM libraries" "configuration for building"
2217 There is also DBMLIB, which appears in the link commands for binaries that
2218 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2219 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2220 binary, and which can be used, for example, to include additional X11
2221 libraries.
2222
2223 .cindex "configuration file" "editing"
2224 The make file copes with rebuilding Exim correctly if any of the configuration
2225 files are edited. However, if an optional configuration file is deleted, it is
2226 necessary to touch the associated non-optional file (that is,
2227 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2228
2229
2230 .section "OS-specific header files" "SECID30"
2231 .cindex "&_os.h_&"
2232 .cindex "building Exim" "OS-specific C header files"
2233 The &_OS_& directory contains a number of files with names of the form
2234 &_os.h-<ostype>_&. These are system-specific C header files that should not
2235 normally need to be changed. There is a list of macro settings that are
2236 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2237 are porting Exim to a new operating system.
2238
2239
2240
2241 .section "Overriding build-time options for the monitor" "SECID31"
2242 .cindex "building Eximon"
2243 A similar process is used for overriding things when building the Exim monitor,
2244 where the files that are involved are
2245 .display
2246 &_OS/eximon.conf-Default_&
2247 &_OS/eximon.conf-_&<&'ostype'&>
2248 &_Local/eximon.conf_&
2249 &_Local/eximon.conf-_&<&'ostype'&>
2250 &_Local/eximon.conf-_&<&'archtype'&>
2251 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2252 .endd
2253 .cindex "&_Local/eximon.conf_&"
2254 As with Exim itself, the final three files need not exist, and in this case the
2255 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2256 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2257 variables of the same name, preceded by EXIMON_. For example, setting
2258 EXIMON_LOG_DEPTH in the environment overrides the value of
2259 LOG_DEPTH at run time.
2260 .ecindex IIDbuex
2261
2262
2263 .section "Installing Exim binaries and scripts" "SECID32"
2264 .cindex "installing Exim"
2265 .cindex "BIN_DIRECTORY"
2266 The command &`make install`& runs the &(exim_install)& script with no
2267 arguments. The script copies binaries and utility scripts into the directory
2268 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2269 .cindex "setuid" "installing Exim with"
2270 The install script copies files only if they are newer than the files they are
2271 going to replace. The Exim binary is required to be owned by root and have the
2272 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2273 install`& as root so that it can set up the Exim binary in this way. However, in
2274 some special situations (for example, if a host is doing no local deliveries)
2275 it may be possible to run Exim without making the binary setuid root (see
2276 chapter &<<CHAPsecurity>>& for details).
2277
2278 .cindex "CONFIGURE_FILE"
2279 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2280 in &_Local/Makefile_&. If this names a single file, and the file does not
2281 exist, the default configuration file &_src/configure.default_& is copied there
2282 by the installation script. If a run time configuration file already exists, it
2283 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2284 alternative files, no default is installed.
2285
2286 .cindex "system aliases file"
2287 .cindex "&_/etc/aliases_&"
2288 One change is made to the default configuration file when it is installed: the
2289 default configuration contains a router that references a system aliases file.
2290 The path to this file is set to the value specified by
2291 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2292 If the system aliases file does not exist, the installation script creates it,
2293 and outputs a comment to the user.
2294
2295 The created file contains no aliases, but it does contain comments about the
2296 aliases a site should normally have. Mail aliases have traditionally been
2297 kept in &_/etc/aliases_&. However, some operating systems are now using
2298 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2299 Exim's configuration if necessary.
2300
2301 The default configuration uses the local host's name as the only local domain,
2302 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2303 running as the local user. System aliases and &_.forward_& files in users' home
2304 directories are supported, but no NIS or NIS+ support is configured. Domains
2305 other than the name of the local host are routed using the DNS, with delivery
2306 over SMTP.
2307
2308 It is possible to install Exim for special purposes (such as building a binary
2309 distribution) in a private part of the file system. You can do this by a
2310 command such as
2311 .code
2312 make DESTDIR=/some/directory/ install
2313 .endd
2314 This has the effect of pre-pending the specified directory to all the file
2315 paths, except the name of the system aliases file that appears in the default
2316 configuration. (If a default alias file is created, its name &'is'& modified.)
2317 For backwards compatibility, ROOT is used if DESTDIR is not set,
2318 but this usage is deprecated.
2319
2320 .cindex "installing Exim" "what is not installed"
2321 Running &'make install'& does not copy the Exim 4 conversion script
2322 &'convert4r4'&. You will probably run this only once if you are
2323 upgrading from Exim 3. None of the documentation files in the &_doc_&
2324 directory are copied, except for the info files when you have set
2325 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2326
2327 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2328 to their names. The Exim binary itself, however, is handled differently. It is
2329 installed under a name that includes the version number and the compile number,
2330 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2331 called &_exim_& to point to the binary. If you are updating a previous version
2332 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2333 from the directory (as seen by other processes).
2334
2335 .cindex "installing Exim" "testing the script"
2336 If you want to see what the &'make install'& will do before running it for
2337 real, you can pass the &%-n%& option to the installation script by this
2338 command:
2339 .code
2340 make INSTALL_ARG=-n install
2341 .endd
2342 The contents of the variable INSTALL_ARG are passed to the installation
2343 script. You do not need to be root to run this test. Alternatively, you can run
2344 the installation script directly, but this must be from within the build
2345 directory. For example, from the top-level Exim directory you could use this
2346 command:
2347 .code
2348 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2349 .endd
2350 .cindex "installing Exim" "install script options"
2351 There are two other options that can be supplied to the installation script.
2352
2353 .ilist
2354 &%-no_chown%& bypasses the call to change the owner of the installed binary
2355 to root, and the call to make it a setuid binary.
2356 .next
2357 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2358 installed binary.
2359 .endlist
2360
2361 INSTALL_ARG can be used to pass these options to the script. For example:
2362 .code
2363 make INSTALL_ARG=-no_symlink install
2364 .endd
2365 The installation script can also be given arguments specifying which files are
2366 to be copied. For example, to install just the Exim binary, and nothing else,
2367 without creating the symbolic link, you could use:
2368 .code
2369 make INSTALL_ARG='-no_symlink exim' install
2370 .endd
2371
2372
2373
2374 .section "Installing info documentation" "SECTinsinfdoc"
2375 .cindex "installing Exim" "&'info'& documentation"
2376 Not all systems use the GNU &'info'& system for documentation, and for this
2377 reason, the Texinfo source of Exim's documentation is not included in the main
2378 distribution. Instead it is available separately from the ftp site (see section
2379 &<<SECTavail>>&).
2380
2381 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2382 source of the documentation is found in the source tree, running &`make
2383 install`& automatically builds the info files and installs them.
2384
2385
2386
2387 .section "Setting up the spool directory" "SECID33"
2388 .cindex "spool directory" "creating"
2389 When it starts up, Exim tries to create its spool directory if it does not
2390 exist. The Exim uid and gid are used for the owner and group of the spool
2391 directory. Sub-directories are automatically created in the spool directory as
2392 necessary.
2393
2394
2395
2396
2397 .section "Testing" "SECID34"
2398 .cindex "testing" "installation"
2399 Having installed Exim, you can check that the run time configuration file is
2400 syntactically valid by running the following command, which assumes that the
2401 Exim binary directory is within your PATH environment variable:
2402 .code
2403 exim -bV
2404 .endd
2405 If there are any errors in the configuration file, Exim outputs error messages.
2406 Otherwise it outputs the version number and build date,
2407 the DBM library that is being used, and information about which drivers and
2408 other optional code modules are included in the binary.
2409 Some simple routing tests can be done by using the address testing option. For
2410 example,
2411 .display
2412 &`exim -bt`& <&'local username'&>
2413 .endd
2414 should verify that it recognizes a local mailbox, and
2415 .display
2416 &`exim -bt`& <&'remote address'&>
2417 .endd
2418 a remote one. Then try getting it to deliver mail, both locally and remotely.
2419 This can be done by passing messages directly to Exim, without going through a
2420 user agent. For example:
2421 .code
2422 exim -v postmaster@your.domain.example
2423 From: user@your.domain.example
2424 To: postmaster@your.domain.example
2425 Subject: Testing Exim
2426
2427 This is a test message.
2428 ^D
2429 .endd
2430 The &%-v%& option causes Exim to output some verification of what it is doing.
2431 In this case you should see copies of three log lines, one for the message's
2432 arrival, one for its delivery, and one containing &"Completed"&.
2433
2434 .cindex "delivery" "problems with"
2435 If you encounter problems, look at Exim's log files (&'mainlog'& and
2436 &'paniclog'&) to see if there is any relevant information there. Another source
2437 of information is running Exim with debugging turned on, by specifying the
2438 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2439 with debugging turned on by a command of the form
2440 .display
2441 &`exim -d -M`& <&'exim-message-id'&>
2442 .endd
2443 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2444 produces rather a lot of output, but you can cut this down to specific areas.
2445 For example, if you use &%-d-all+route%& only the debugging information
2446 relevant to routing is included. (See the &%-d%& option in chapter
2447 &<<CHAPcommandline>>& for more details.)
2448
2449 .cindex '&"sticky"& bit'
2450 .cindex "lock files"
2451 One specific problem that has shown up on some sites is the inability to do
2452 local deliveries into a shared mailbox directory, because it does not have the
2453 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2454 writing to a mailbox file, and if it cannot create the lock file, the delivery
2455 is deferred. You can get round this either by setting the &"sticky bit"& on the
2456 directory, or by setting a specific group for local deliveries and allowing
2457 that group to create files in the directory (see the comments above the
2458 &(local_delivery)& transport in the default configuration file). Another
2459 approach is to configure Exim not to use lock files, but just to rely on
2460 &[fcntl()]& locking instead. However, you should do this only if all user
2461 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2462 see chapter &<<CHAPappendfile>>&.
2463
2464 One thing that cannot be tested on a system that is already running an MTA is
2465 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2466 &%-oX%& option can be used to run an Exim daemon that listens on some other
2467 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2468 &'exim_checkaccess'& utility can be used to check out policy controls on
2469 incoming SMTP mail.
2470
2471 Testing a new version on a system that is already running Exim can most easily
2472 be done by building a binary with a different CONFIGURE_FILE setting. From
2473 within the run time configuration, all other file and directory names
2474 that Exim uses can be altered, in order to keep it entirely clear of the
2475 production version.
2476
2477
2478 .section "Replacing another MTA with Exim" "SECID35"
2479 .cindex "replacing another MTA"
2480 Building and installing Exim for the first time does not of itself put it in
2481 general use. The name by which the system's MTA is called by mail user agents
2482 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2483 operating system), and it is necessary to make this name point to the &'exim'&
2484 binary in order to get the user agents to pass messages to Exim. This is
2485 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2486 or &_/usr/lib/sendmail_&
2487 .cindex "symbolic link" "to &'exim'& binary"
2488 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2489 privilege and executable status from the old MTA. It is then necessary to stop
2490 and restart the mailer daemon, if one is running.
2491
2492 .cindex "FreeBSD, MTA indirection"
2493 .cindex "&_/etc/mail/mailer.conf_&"
2494 Some operating systems have introduced alternative ways of switching MTAs. For
2495 example, if you are running FreeBSD, you need to edit the file
2496 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2497 described. A typical example of the contents of this file for running Exim is
2498 as follows:
2499 .code
2500 sendmail            /usr/exim/bin/exim
2501 send-mail           /usr/exim/bin/exim
2502 mailq               /usr/exim/bin/exim -bp
2503 newaliases          /usr/bin/true
2504 .endd
2505 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2506 your Exim installation is &"live"&. Check it by sending a message from your
2507 favourite user agent.
2508
2509 You should consider what to tell your users about the change of MTA. Exim may
2510 have different capabilities to what was previously running, and there are
2511 various operational differences such as the text of messages produced by
2512 command line options and in bounce messages. If you allow your users to make
2513 use of Exim's filtering capabilities, you should make the document entitled
2514 &'Exim's interface to mail filtering'& available to them.
2515
2516
2517
2518 .section "Upgrading Exim" "SECID36"
2519 .cindex "upgrading Exim"
2520 If you are already running Exim on your host, building and installing a new
2521 version automatically makes it available to MUAs, or any other programs that
2522 call the MTA directly. However, if you are running an Exim daemon, you do need
2523 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2524 new binary. You do not need to stop processing mail in order to install a new
2525 version of Exim. The install script does not modify an existing runtime
2526 configuration file.
2527
2528
2529
2530
2531 .section "Stopping the Exim daemon on Solaris" "SECID37"
2532 .cindex "Solaris" "stopping Exim on"
2533 The standard command for stopping the mailer daemon on Solaris is
2534 .code
2535 /etc/init.d/sendmail stop
2536 .endd
2537 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2538 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2539 for the text &"sendmail"&; this is not present because the actual program name
2540 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2541 solution is to replace the line that finds the process id with something like
2542 .code
2543 pid=`cat /var/spool/exim/exim-daemon.pid`
2544 .endd
2545 to obtain the daemon's pid directly from the file that Exim saves it in.
2546
2547 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2548 still be received from local processes, and if automatic delivery is configured
2549 (the normal case), deliveries will still occur.
2550
2551
2552
2553
2554 . ////////////////////////////////////////////////////////////////////////////
2555 . ////////////////////////////////////////////////////////////////////////////
2556
2557 .chapter "The Exim command line" "CHAPcommandline"
2558 .scindex IIDclo1 "command line" "options"
2559 .scindex IIDclo2 "options" "command line"
2560 Exim's command line takes the standard Unix form of a sequence of options,
2561 each starting with a hyphen character, followed by a number of arguments. The
2562 options are compatible with the main options of Sendmail, and there are also
2563 some additional options, some of which are compatible with Smail 3. Certain
2564 combinations of options do not make sense, and provoke an error if used.
2565 The form of the arguments depends on which options are set.
2566
2567
2568 .section "Setting options by program name" "SECID38"
2569 .cindex "&'mailq'&"
2570 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2571 were present before any other options.
2572 The &%-bp%& option requests a listing of the contents of the mail queue on the
2573 standard output.
2574 This feature is for compatibility with some systems that contain a command of
2575 that name in one of the standard libraries, symbolically linked to
2576 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2577
2578 .cindex "&'rsmtp'&"
2579 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2580 were present before any other options, for compatibility with Smail. The
2581 &%-bS%& option is used for reading in a number of messages in batched SMTP
2582 format.
2583
2584 .cindex "&'rmail'&"
2585 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2586 &%-oee%& options were present before any other options, for compatibility with
2587 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2588
2589 .cindex "&'runq'&"
2590 .cindex "queue runner"
2591 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2592 were present before any other options, for compatibility with Smail. The &%-q%&
2593 option causes a single queue runner process to be started.
2594
2595 .cindex "&'newaliases'&"
2596 .cindex "alias file" "building"
2597 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2598 If Exim is called under the name &'newaliases'& it behaves as if the option
2599 &%-bi%& were present before any other options, for compatibility with Sendmail.
2600 This option is used for rebuilding Sendmail's alias file. Exim does not have
2601 the concept of a single alias file, but can be configured to run a given
2602 command if called with the &%-bi%& option.
2603
2604
2605 .section "Trusted and admin users" "SECTtrustedadmin"
2606 Some Exim options are available only to &'trusted users'& and others are
2607 available only to &'admin users'&. In the description below, the phrases &"Exim
2608 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2609 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2610 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2611
2612 .ilist
2613 .cindex "trusted users" "definition of"
2614 .cindex "user" "trusted definition of"
2615 The trusted users are root, the Exim user, any user listed in the
2616 &%trusted_users%& configuration option, and any user whose current group or any
2617 supplementary group is one of those listed in the &%trusted_groups%&
2618 configuration option. Note that the Exim group is not automatically trusted.
2619
2620 .cindex '&"From"& line'
2621 .cindex "envelope sender"
2622 Trusted users are always permitted to use the &%-f%& option or a leading
2623 &"From&~"& line to specify the envelope sender of a message that is passed to
2624 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2625 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2626 users to set envelope senders.
2627
2628 .cindex "&'From:'& header line"
2629 .cindex "&'Sender:'& header line"
2630 For a trusted user, there is never any check on the contents of the &'From:'&
2631 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2632 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2633
2634 Trusted users may also specify a host name, host address, interface address,
2635 protocol name, ident value, and authentication data when submitting a message
2636 locally. Thus, they are able to insert messages into Exim's queue locally that
2637 have the characteristics of messages received from a remote host. Untrusted
2638 users may in some circumstances use &%-f%&, but can never set the other values
2639 that are available to trusted users.
2640 .next
2641 .cindex "user" "admin definition of"
2642 .cindex "admin user" "definition of"
2643 The admin users are root, the Exim user, and any user that is a member of the
2644 Exim group or of any group listed in the &%admin_groups%& configuration option.
2645 The current group does not have to be one of these groups.
2646
2647 Admin users are permitted to list the queue, and to carry out certain
2648 operations on messages, for example, to force delivery failures. It is also
2649 necessary to be an admin user in order to see the full information provided by
2650 the Exim monitor, and full debugging output.
2651
2652 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2653 Exim to attempt delivery of messages on its queue is restricted to admin users.
2654 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2655 option false (that is, specifying &%no_prod_requires_admin%&).
2656
2657 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2658 is restricted to admin users unless &%queue_list_requires_admin%& is set
2659 false.
2660 .endlist
2661
2662
2663 &*Warning*&: If you configure your system so that admin users are able to
2664 edit Exim's configuration file, you are giving those users an easy way of
2665 getting root. There is further discussion of this issue at the start of chapter
2666 &<<CHAPconf>>&.
2667
2668
2669
2670
2671 .section "Command line options" "SECID39"
2672 Exim's command line options are described in alphabetical order below. If none
2673 of the options that specifies a specific action (such as starting the daemon or
2674 a queue runner, or testing an address, or receiving a message in a specific
2675 format, or listing the queue) are present, and there is at least one argument
2676 on the command line, &%-bm%& (accept a local message on the standard input,
2677 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2678 outputs a brief message about itself and exits.
2679
2680 . ////////////////////////////////////////////////////////////////////////////
2681 . Insert a stylized XML comment here, to identify the start of the command line
2682 . options. This is for the benefit of the Perl script that automatically
2683 . creates a man page for the options.
2684 . ////////////////////////////////////////////////////////////////////////////
2685
2686 .literal xml
2687 <!-- === Start of command line options === -->
2688 .literal off
2689
2690
2691 .vlist
2692 .vitem &%--%&
2693 .oindex "--"
2694 .cindex "options" "command line; terminating"
2695 This is a pseudo-option whose only purpose is to terminate the options and
2696 therefore to cause subsequent command line items to be treated as arguments
2697 rather than options, even if they begin with hyphens.
2698
2699 .vitem &%--help%&
2700 .oindex "&%--help%&"
2701 This option causes Exim to output a few sentences stating what it is.
2702 The same output is generated if the Exim binary is called with no options and
2703 no arguments.
2704
2705 .vitem &%--version%&
2706 .oindex "&%--version%&"
2707 This option is an alias for &%-bV%& and causes version information to be
2708 displayed.
2709
2710 .vitem &%-Ac%& &&&
2711        &%-Am%&
2712 .oindex "&%-Ac%&"
2713 .oindex "&%-Am%&"
2714 These options are used by Sendmail for selecting configuration files and are
2715 ignored by Exim.
2716
2717 .vitem &%-B%&<&'type'&>
2718 .oindex "&%-B%&"
2719 .cindex "8-bit characters"
2720 .cindex "Sendmail compatibility" "8-bit characters"
2721 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2722 clean; it ignores this option.
2723
2724 .vitem &%-bd%&
2725 .oindex "&%-bd%&"
2726 .cindex "daemon"
2727 .cindex "SMTP" "listener"
2728 .cindex "queue runner"
2729 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2730 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2731 that the daemon should also initiate periodic queue runs.
2732
2733 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2734 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2735 disconnect from the controlling terminal. When running this way, it can be
2736 stopped by pressing ctrl-C.
2737
2738 By default, Exim listens for incoming connections to the standard SMTP port on
2739 all the host's running interfaces. However, it is possible to listen on other
2740 ports, on multiple ports, and only on specific interfaces. Chapter
2741 &<<CHAPinterfaces>>& contains a description of the options that control this.
2742
2743 When a listening daemon
2744 .cindex "daemon" "process id (pid)"
2745 .cindex "pid (process id)" "of daemon"
2746 is started without the use of &%-oX%& (that is, without overriding the normal
2747 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2748 in Exim's spool directory. This location can be overridden by setting
2749 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2750 running as root.
2751
2752 When &%-oX%& is used on the command line to start a listening daemon, the
2753 process id is not written to the normal pid file path. However, &%-oP%& can be
2754 used to specify a path on the command line if a pid file is required.
2755
2756 The SIGHUP signal
2757 .cindex "SIGHUP"
2758 .cindex "daemon" "restarting"
2759 can be used to cause the daemon to re-execute itself. This should be done
2760 whenever Exim's configuration file, or any file that is incorporated into it by
2761 means of the &%.include%& facility, is changed, and also whenever a new version
2762 of Exim is installed. It is not necessary to do this when other files that are
2763 referenced from the configuration (for example, alias files) are changed,
2764 because these are reread each time they are used.
2765
2766 .vitem &%-bdf%&
2767 .oindex "&%-bdf%&"
2768 This option has the same effect as &%-bd%& except that it never disconnects
2769 from the controlling terminal, even when no debugging is specified.
2770
2771 .vitem &%-be%&
2772 .oindex "&%-be%&"
2773 .cindex "testing" "string expansion"
2774 .cindex "expansion" "testing"
2775 Run Exim in expansion testing mode. Exim discards its root privilege, to
2776 prevent ordinary users from using this mode to read otherwise inaccessible
2777 files. If no arguments are given, Exim runs interactively, prompting for lines
2778 of data. Otherwise, it processes each argument in turn.
2779
2780 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2781 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2782 used without command line arguments. If successful, it uses the &[readline()]&
2783 function, which provides extensive line-editing facilities, for reading the
2784 test data. A line history is supported.
2785
2786 Long expansion expressions can be split over several lines by using backslash
2787 continuations. As in Exim's run time configuration, white space at the start of
2788 continuation lines is ignored. Each argument or data line is passed through the
2789 string expansion mechanism, and the result is output. Variable values from the
2790 configuration file (for example, &$qualify_domain$&) are available, but no
2791 message-specific values (such as &$message_exim_id$&) are set, because no message
2792 is being processed (but see &%-bem%& and &%-Mset%&).
2793
2794 &*Note*&: If you use this mechanism to test lookups, and you change the data
2795 files or databases you are using, you must exit and restart Exim before trying
2796 the same lookup again. Otherwise, because each Exim process caches the results
2797 of lookups, you will just get the same result as before.
2798
2799 .vitem &%-bem%&&~<&'filename'&>
2800 .oindex "&%-bem%&"
2801 .cindex "testing" "string expansion"
2802 .cindex "expansion" "testing"
2803 This option operates like &%-be%& except that it must be followed by the name
2804 of a file. For example:
2805 .code
2806 exim -bem /tmp/testmessage
2807 .endd
2808 The file is read as a message (as if receiving a locally-submitted non-SMTP
2809 message) before any of the test expansions are done. Thus, message-specific
2810 variables such as &$message_size$& and &$header_from:$& are available. However,
2811 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2812 recipients are read from the headers in the normal way, and are shown in the
2813 &$recipients$& variable. Note that recipients cannot be given on the command
2814 line, because further arguments are taken as strings to expand (just like
2815 &%-be%&).
2816
2817 .vitem &%-bF%&&~<&'filename'&>
2818 .oindex "&%-bF%&"
2819 .cindex "system filter" "testing"
2820 .cindex "testing" "system filter"
2821 This option is the same as &%-bf%& except that it assumes that the filter being
2822 tested is a system filter. The additional commands that are available only in
2823 system filters are recognized.
2824
2825 .vitem &%-bf%&&~<&'filename'&>
2826 .oindex "&%-bf%&"
2827 .cindex "filter" "testing"
2828 .cindex "testing" "filter file"
2829 .cindex "forward file" "testing"
2830 .cindex "testing" "forward file"
2831 .cindex "Sieve filter" "testing"
2832 This option runs Exim in user filter testing mode; the file is the filter file
2833 to be tested, and a test message must be supplied on the standard input. If
2834 there are no message-dependent tests in the filter, an empty file can be
2835 supplied.
2836
2837 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2838 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2839 filter and a user filter in the same run. For example:
2840 .code
2841 exim -bF /system/filter -bf /user/filter </test/message
2842 .endd
2843 This is helpful when the system filter adds header lines or sets filter
2844 variables that are used by the user filter.
2845
2846 If the test filter file does not begin with one of the special lines
2847 .code
2848 # Exim filter
2849 # Sieve filter
2850 .endd
2851 it is taken to be a normal &_.forward_& file, and is tested for validity under
2852 that interpretation. See sections &<<SECTitenonfilred>>& to
2853 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2854 redirection lists.
2855
2856 The result of an Exim command that uses &%-bf%&, provided no errors are
2857 detected, is a list of the actions that Exim would try to take if presented
2858 with the message for real. More details of filter testing are given in the
2859 separate document entitled &'Exim's interfaces to mail filtering'&.
2860
2861 When testing a filter file,
2862 .cindex "&""From""& line"
2863 .cindex "envelope sender"
2864 .oindex "&%-f%&" "for filter testing"
2865 the envelope sender can be set by the &%-f%& option,
2866 or by a &"From&~"& line at the start of the test message. Various parameters
2867 that would normally be taken from the envelope recipient address of the message
2868 can be set by means of additional command line options (see the next four
2869 options).
2870
2871 .vitem &%-bfd%&&~<&'domain'&>
2872 .oindex "&%-bfd%&"
2873 .vindex "&$qualify_domain$&"
2874 This sets the domain of the recipient address when a filter file is being
2875 tested by means of the &%-bf%& option. The default is the value of
2876 &$qualify_domain$&.
2877
2878 .vitem &%-bfl%&&~<&'local&~part'&>
2879 .oindex "&%-bfl%&"
2880 This sets the local part of the recipient address when a filter file is being
2881 tested by means of the &%-bf%& option. The default is the username of the
2882 process that calls Exim. A local part should be specified with any prefix or
2883 suffix stripped, because that is how it appears to the filter when a message is
2884 actually being delivered.
2885
2886 .vitem &%-bfp%&&~<&'prefix'&>
2887 .oindex "&%-bfp%&"
2888 This sets the prefix of the local part of the recipient address when a filter
2889 file is being tested by means of the &%-bf%& option. The default is an empty
2890 prefix.
2891
2892 .vitem &%-bfs%&&~<&'suffix'&>
2893 .oindex "&%-bfs%&"
2894 This sets the suffix of the local part of the recipient address when a filter
2895 file is being tested by means of the &%-bf%& option. The default is an empty
2896 suffix.
2897
2898 .vitem &%-bh%&&~<&'IP&~address'&>
2899 .oindex "&%-bh%&"
2900 .cindex "testing" "incoming SMTP"
2901 .cindex "SMTP" "testing incoming"
2902 .cindex "testing" "relay control"
2903 .cindex "relaying" "testing configuration"
2904 .cindex "policy control" "testing"
2905 .cindex "debugging" "&%-bh%& option"
2906 This option runs a fake SMTP session as if from the given IP address, using the
2907 standard input and output. The IP address may include a port number at the end,
2908 after a full stop. For example:
2909 .code
2910 exim -bh 10.9.8.7.1234
2911 exim -bh fe80::a00:20ff:fe86:a061.5678
2912 .endd
2913 When an IPv6 address is given, it is converted into canonical form. In the case
2914 of the second example above, the value of &$sender_host_address$& after
2915 conversion to the canonical form is
2916 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2917
2918 Comments as to what is going on are written to the standard error file. These
2919 include lines beginning with &"LOG"& for anything that would have been logged.
2920 This facility is provided for testing configuration options for incoming
2921 messages, to make sure they implement the required policy. For example, you can
2922 test your relay controls using &%-bh%&.
2923
2924 &*Warning 1*&:
2925 .cindex "RFC 1413"
2926 You can test features of the configuration that rely on ident (RFC 1413)
2927 information by using the &%-oMt%& option. However, Exim cannot actually perform
2928 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2929 connection.
2930
2931 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2932 are also skipped when testing using &%-bh%&. If you want these callouts to
2933 occur, use &%-bhc%& instead.
2934
2935 Messages supplied during the testing session are discarded, and nothing is
2936 written to any of the real log files. There may be pauses when DNS (and other)
2937 lookups are taking place, and of course these may time out. The &%-oMi%& option
2938 can be used to specify a specific IP interface and port if this is important,
2939 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2940 session were authenticated.
2941
2942 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2943 output just states whether a given recipient address from a given host is
2944 acceptable or not. See section &<<SECTcheckaccess>>&.
2945
2946 Features such as authentication and encryption, where the client input is not
2947 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2948 specialized SMTP test program such as
2949 &url(http://jetmore.org/john/code/#swaks,swaks).
2950
2951 .vitem &%-bhc%&&~<&'IP&~address'&>
2952 .oindex "&%-bhc%&"
2953 This option operates in the same way as &%-bh%&, except that address
2954 verification callouts are performed if required. This includes consulting and
2955 updating the callout cache database.
2956
2957 .vitem &%-bi%&
2958 .oindex "&%-bi%&"
2959 .cindex "alias file" "building"
2960 .cindex "building alias file"
2961 .cindex "Sendmail compatibility" "&%-bi%& option"
2962 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2963 Exim does not have the concept of a single alias file, and so it cannot mimic
2964 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2965 tend to appear in various scripts such as NIS make files, so the option must be
2966 recognized.
2967
2968 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2969 configuration option is run, under the uid and gid of the caller of Exim. If
2970 the &%-oA%& option is used, its value is passed to the command as an argument.
2971 The command set by &%bi_command%& may not contain arguments. The command can
2972 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2973 if this is required. If the &%bi_command%& option is not set, calling Exim with
2974 &%-bi%& is a no-op.
2975
2976 . // Keep :help first, then the rest in alphabetical order
2977 .vitem &%-bI:help%&
2978 .oindex "&%-bI:help%&"
2979 .cindex "querying exim information"
2980 We shall provide various options starting &`-bI:`& for querying Exim for
2981 information.  The output of many of these will be intended for machine
2982 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2983 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2984 options shall cause Exim to exit after producing the requested output.
2985
2986 .vitem &%-bI:dscp%&
2987 .oindex "&%-bI:dscp%&"
2988 .cindex "DSCP" "values"
2989 This option causes Exim to emit an alphabetically sorted list of all
2990 recognised DSCP names.
2991
2992 .vitem &%-bI:sieve%&
2993 .oindex "&%-bI:sieve%&"
2994 .cindex "Sieve filter" "capabilities"
2995 This option causes Exim to emit an alphabetically sorted list of all supported
2996 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2997 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2998 &`SIEVE`& capability response line.  As the precise list may depend upon
2999 compile-time build options, which this option will adapt to, this is the only
3000 way to guarantee a correct response.
3001
3002 .vitem &%-bm%&
3003 .oindex "&%-bm%&"
3004 .cindex "local message reception"
3005 This option runs an Exim receiving process that accepts an incoming,
3006 locally-generated message on the standard input. The recipients are given as the
3007 command arguments (except when &%-t%& is also present &-- see below). Each
3008 argument can be a comma-separated list of RFC 2822 addresses. This is the
3009 default option for selecting the overall action of an Exim call; it is assumed
3010 if no other conflicting option is present.
3011
3012 If any addresses in the message are unqualified (have no domain), they are
3013 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3014 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3015 suppressing this for special cases.
3016
3017 Policy checks on the contents of local messages can be enforced by means of
3018 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3019
3020 .cindex "return code" "for &%-bm%&"
3021 The return code is zero if the message is successfully accepted. Otherwise, the
3022 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3023
3024 The format
3025 .cindex "message" "format"
3026 .cindex "format" "message"
3027 .cindex "&""From""& line"
3028 .cindex "UUCP" "&""From""& line"
3029 .cindex "Sendmail compatibility" "&""From""& line"
3030 of the message must be as defined in RFC 2822, except that, for
3031 compatibility with Sendmail and Smail, a line in one of the forms
3032 .code
3033 From sender Fri Jan  5 12:55 GMT 1997
3034 From sender Fri, 5 Jan 97 12:55:01
3035 .endd
3036 (with the weekday optional, and possibly with additional text after the date)
3037 is permitted to appear at the start of the message. There appears to be no
3038 authoritative specification of the format of this line. Exim recognizes it by
3039 matching against the regular expression defined by the &%uucp_from_pattern%&
3040 option, which can be changed if necessary.
3041
3042 .oindex "&%-f%&" "overriding &""From""& line"
3043 The specified sender is treated as if it were given as the argument to the
3044 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3045 preference to the address taken from the message. The caller of Exim must be a
3046 trusted user for the sender of a message to be set in this way.
3047
3048 .vitem &%-bmalware%&&~<&'filename'&>
3049 .oindex "&%-bmalware%&"
3050 .cindex "testing", "malware"
3051 .cindex "malware scan test"
3052 This debugging option causes Exim to scan the given file or directory
3053 (depending on the used scanner interface),
3054 using the malware scanning framework.  The option of &%av_scanner%& influences
3055 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3056 the expansion should have defaults which apply to this invocation.  ACLs are
3057 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3058 will never be populated and &%-bmalware%& will fail.
3059
3060 Exim will have changed working directory before resolving the filename, so
3061 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3062 user when it tries to open the file, rather than as the invoking user.
3063 This option requires admin privileges.
3064
3065 The &%-bmalware%& option will not be extended to be more generally useful,
3066 there are better tools for file-scanning.  This option exists to help
3067 administrators verify their Exim and AV scanner configuration.
3068
3069 .vitem &%-bnq%&
3070 .oindex "&%-bnq%&"
3071 .cindex "address qualification, suppressing"
3072 By default, Exim automatically qualifies unqualified addresses (those
3073 without domains) that appear in messages that are submitted locally (that
3074 is, not over TCP/IP). This qualification applies both to addresses in
3075 envelopes, and addresses in header lines. Sender addresses are qualified using
3076 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3077 defaults to the value of &%qualify_domain%&).
3078
3079 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3080 being used to re-submit messages that originally came from remote hosts after
3081 content scanning, you probably do not want to qualify unqualified addresses in
3082 header lines. (Such lines will be present only if you have not enabled a header
3083 syntax check in the appropriate ACL.)
3084
3085 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3086 messages that originate on the local host. When this is used, unqualified
3087 addresses in the envelope provoke errors (causing message rejection) and
3088 unqualified addresses in header lines are left alone.
3089
3090
3091 .vitem &%-bP%&
3092 .oindex "&%-bP%&"
3093 .cindex "configuration options" "extracting"
3094 .cindex "options" "configuration &-- extracting"
3095 If this option is given with no arguments, it causes the values of all Exim's
3096 main configuration options to be written to the standard output. The values
3097 of one or more specific options can be requested by giving their names as
3098 arguments, for example:
3099 .code
3100 exim -bP qualify_domain hold_domains
3101 .endd
3102 .cindex "hiding configuration option values"
3103 .cindex "configuration options" "hiding value of"
3104 .cindex "options" "hiding value of"
3105 However, any option setting that is preceded by the word &"hide"& in the
3106 configuration file is not shown in full, except to an admin user. For other
3107 users, the output is as in this example:
3108 .code
3109 mysql_servers = <value not displayable>
3110 .endd
3111 If &%config%& is given as an argument, the config is
3112 output, as it was parsed, any include file resolved, any comment removed.
3113
3114 If &%config_file%& is given as an argument, the name of the run time
3115 configuration file is output. (&%configure_file%& works too, for
3116 backward compatibility.)
3117 If a list of configuration files was supplied, the value that is output here
3118 is the name of the file that was actually used.
3119
3120 .cindex "options" "hiding name of"
3121 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3122 name will not be output.
3123
3124 .cindex "daemon" "process id (pid)"
3125 .cindex "pid (process id)" "of daemon"
3126 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3127 directories where log files and daemon pid files are written are output,
3128 respectively. If these values are unset, log files are written in a
3129 sub-directory of the spool directory called &%log%&, and the pid file is
3130 written directly into the spool directory.
3131
3132 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3133 .code
3134 exim -bP +local_domains
3135 .endd
3136 it searches for a matching named list of any type (domain, host, address, or
3137 local part) and outputs what it finds.
3138
3139 .cindex "options" "router &-- extracting"
3140 .cindex "options" "transport &-- extracting"
3141 .cindex "options" "authenticator &-- extracting"
3142 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3143 followed by the name of an appropriate driver instance, the option settings for
3144 that driver are output. For example:
3145 .code
3146 exim -bP transport local_delivery
3147 .endd
3148 The generic driver options are output first, followed by the driver's private
3149 options. A list of the names of drivers of a particular type can be obtained by
3150 using one of the words &%router_list%&, &%transport_list%&, or
3151 &%authenticator_list%&, and a complete list of all drivers with their option
3152 settings can be obtained by using &%routers%&, &%transports%&, or
3153 &%authenticators%&.
3154
3155 .cindex "environment"
3156 If &%environment%& is given as an argument, the set of environment
3157 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3158 variables.
3159
3160 .cindex "options" "macro &-- extracting"
3161 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3162 are available, similarly to the drivers.  Because macros are sometimes used
3163 for storing passwords, this option is restricted.
3164 The output format is one item per line.
3165
3166 .vitem &%-bp%&
3167 .oindex "&%-bp%&"
3168 .cindex "queue" "listing messages on"
3169 .cindex "listing" "messages on the queue"
3170 This option requests a listing of the contents of the mail queue on the
3171 standard output. If the &%-bp%& option is followed by a list of message ids,
3172 just those messages are listed. By default, this option can be used only by an
3173 admin user. However, the &%queue_list_requires_admin%& option can be set false
3174 to allow any user to see the queue.
3175
3176 Each message on the queue is displayed as in the following example:
3177 .code
3178 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3179           red.king@looking-glass.fict.example
3180           <other addresses>
3181 .endd
3182 .cindex "message" "size in queue listing"
3183 .cindex "size" "of message"
3184 The first line contains the length of time the message has been on the queue
3185 (in this case 25 minutes), the size of the message (2.9K), the unique local
3186 identifier for the message, and the message sender, as contained in the
3187 envelope. For bounce messages, the sender address is empty, and appears as
3188 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3189 the default sender address, the user's login name is shown in parentheses
3190 before the sender address.
3191
3192 .cindex "frozen messages" "in queue listing"
3193 If the message is frozen (attempts to deliver it are suspended) then the text
3194 &"*** frozen ***"& is displayed at the end of this line.
3195
3196 The recipients of the message (taken from the envelope, not the headers) are
3197 displayed on subsequent lines. Those addresses to which the message has already
3198 been delivered are marked with the letter D. If an original address gets
3199 expanded into several addresses via an alias or forward file, the original is
3200 displayed with a D only when deliveries for all of its child addresses are
3201 complete.
3202
3203
3204 .vitem &%-bpa%&
3205 .oindex "&%-bpa%&"
3206 This option operates like &%-bp%&, but in addition it shows delivered addresses
3207 that were generated from the original top level address(es) in each message by
3208 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3209 of just &"D"&.
3210
3211
3212 .vitem &%-bpc%&
3213 .oindex "&%-bpc%&"
3214 .cindex "queue" "count of messages on"
3215 This option counts the number of messages on the queue, and writes the total
3216 to the standard output. It is restricted to admin users, unless
3217 &%queue_list_requires_admin%& is set false.
3218
3219
3220 .vitem &%-bpr%&
3221 .oindex "&%-bpr%&"
3222 This option operates like &%-bp%&, but the output is not sorted into
3223 chronological order of message arrival. This can speed it up when there are
3224 lots of messages on the queue, and is particularly useful if the output is
3225 going to be post-processed in a way that doesn't need the sorting.
3226
3227 .vitem &%-bpra%&
3228 .oindex "&%-bpra%&"
3229 This option is a combination of &%-bpr%& and &%-bpa%&.
3230
3231 .vitem &%-bpru%&
3232 .oindex "&%-bpru%&"
3233 This option is a combination of &%-bpr%& and &%-bpu%&.
3234
3235
3236 .vitem &%-bpu%&
3237 .oindex "&%-bpu%&"
3238 This option operates like &%-bp%& but shows only undelivered top-level
3239 addresses for each message displayed. Addresses generated by aliasing or
3240 forwarding are not shown, unless the message was deferred after processing by a
3241 router with the &%one_time%& option set.
3242
3243
3244 .vitem &%-brt%&
3245 .oindex "&%-brt%&"
3246 .cindex "testing" "retry configuration"
3247 .cindex "retry" "configuration testing"
3248 This option is for testing retry rules, and it must be followed by up to three
3249 arguments. It causes Exim to look for a retry rule that matches the values
3250 and to write it to the standard output. For example:
3251 .code
3252 exim -brt bach.comp.mus.example
3253 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3254 .endd
3255 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3256 argument, which is required, can be a complete address in the form
3257 &'local_part@domain'&, or it can be just a domain name. If the second argument
3258 contains a dot, it is interpreted as an optional second domain name; if no
3259 retry rule is found for the first argument, the second is tried. This ties in
3260 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3261 rule is found that matches the host, one that matches the mail domain is
3262 sought. Finally, an argument that is the name of a specific delivery error, as
3263 used in setting up retry rules, can be given. For example:
3264 .code
3265 exim -brt haydn.comp.mus.example quota_3d
3266 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3267 .endd
3268
3269 .vitem &%-brw%&
3270 .oindex "&%-brw%&"
3271 .cindex "testing" "rewriting"
3272 .cindex "rewriting" "testing"
3273 This option is for testing address rewriting rules, and it must be followed by
3274 a single argument, consisting of either a local part without a domain, or a
3275 complete address with a fully qualified domain. Exim outputs how this address
3276 would be rewritten for each possible place it might appear. See chapter
3277 &<<CHAPrewrite>>& for further details.
3278
3279 .vitem &%-bS%&
3280 .oindex "&%-bS%&"
3281 .cindex "SMTP" "batched incoming"
3282 .cindex "batched SMTP input"
3283 This option is used for batched SMTP input, which is an alternative interface
3284 for non-interactive local message submission. A number of messages can be
3285 submitted in a single run. However, despite its name, this is not really SMTP
3286 input. Exim reads each message's envelope from SMTP commands on the standard
3287 input, but generates no responses. If the caller is trusted, or
3288 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3289 believed; otherwise the sender is always the caller of Exim.
3290
3291 The message itself is read from the standard input, in SMTP format (leading
3292 dots doubled), terminated by a line containing just a single dot. An error is
3293 provoked if the terminating dot is missing. A further message may then follow.
3294
3295 As for other local message submissions, the contents of incoming batch SMTP
3296 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3297 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3298 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3299
3300 Some other SMTP commands are recognized in the input. HELO and EHLO act
3301 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3302 QUIT quits, ignoring the rest of the standard input.
3303
3304 .cindex "return code" "for &%-bS%&"
3305 If any error is encountered, reports are written to the standard output and
3306 error streams, and Exim gives up immediately. The return code is 0 if no error
3307 was detected; it is 1 if one or more messages were accepted before the error
3308 was detected; otherwise it is 2.
3309
3310 More details of input using batched SMTP are given in section
3311 &<<SECTincomingbatchedSMTP>>&.
3312
3313 .vitem &%-bs%&
3314 .oindex "&%-bs%&"
3315 .cindex "SMTP" "local input"
3316 .cindex "local SMTP input"
3317 This option causes Exim to accept one or more messages by reading SMTP commands
3318 on the standard input, and producing SMTP replies on the standard output. SMTP
3319 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3320 Some user agents use this interface as a way of passing locally-generated
3321 messages to the MTA.
3322
3323 In
3324 .cindex "sender" "source of"
3325 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3326 set, the senders of messages are taken from the SMTP MAIL commands.
3327 Otherwise the content of these commands is ignored and the sender is set up as
3328 the calling user. Unqualified addresses are automatically qualified using
3329 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3330 &%-bnq%& option is used.
3331
3332 .cindex "inetd"
3333 The
3334 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3335 using a listening daemon. Exim can distinguish the two cases by checking
3336 whether the standard input is a TCP/IP socket. When Exim is called from
3337 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3338 above concerning senders and qualification do not apply. In this situation,
3339 Exim behaves in exactly the same way as it does when receiving a message via
3340 the listening daemon.
3341
3342 .vitem &%-bt%&
3343 .oindex "&%-bt%&"
3344 .cindex "testing" "addresses"
3345 .cindex "address" "testing"
3346 This option runs Exim in address testing mode, in which each argument is taken
3347 as a recipient address to be tested for deliverability. The results are
3348 written to the standard output. If a test fails, and the caller is not an admin
3349 user, no details of the failure are output, because these might contain
3350 sensitive information such as usernames and passwords for database lookups.
3351
3352 If no arguments are given, Exim runs in an interactive manner, prompting with a
3353 right angle bracket for addresses to be tested.
3354
3355 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3356 &[readline()]& function, because it is running as &'root'& and there are
3357 security issues.
3358
3359 Each address is handled as if it were the recipient address of a message
3360 (compare the &%-bv%& option). It is passed to the routers and the result is
3361 written to the standard output. However, any router that has
3362 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3363 genuine routing tests if your first router passes everything to a scanner
3364 program.
3365
3366 .cindex "return code" "for &%-bt%&"
3367 The return code is 2 if any address failed outright; it is 1 if no address
3368 failed outright but at least one could not be resolved for some reason. Return
3369 code 0 is given only when all addresses succeed.
3370
3371 .cindex "duplicate addresses"
3372 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3373 addresses after routing is complete, so that only one delivery takes place.
3374 This does not happen when testing with &%-bt%&; the full results of routing are
3375 always shown.
3376
3377 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3378 routers in the configuration makes any tests on the sender address of a
3379 message,
3380 .oindex "&%-f%&" "for address testing"
3381 you can use the &%-f%& option to set an appropriate sender when running
3382 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3383 default qualifying domain. However, if you have set up (for example) routers
3384 whose behaviour depends on the contents of an incoming message, you cannot test
3385 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3386 doing such tests.
3387
3388 .vitem &%-bV%&
3389 .oindex "&%-bV%&"
3390 .cindex "version number of Exim"
3391 This option causes Exim to write the current version number, compilation
3392 number, and compilation date of the &'exim'& binary to the standard output.
3393 It also lists the DBM library that is being used, the optional modules (such as
3394 specific lookup types), the drivers that are included in the binary, and the
3395 name of the run time configuration file that is in use.
3396
3397 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3398 configuration file. However, this is a static check only. It cannot check
3399 values that are to be expanded. For example, although a misspelt ACL verb is
3400 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3401 alone to discover (for example) all the typos in the configuration; some
3402 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3403 dynamic testing facilities.
3404
3405 .vitem &%-bv%&
3406 .oindex "&%-bv%&"
3407 .cindex "verifying address" "using &%-bv%&"
3408 .cindex "address" "verification"
3409 This option runs Exim in address verification mode, in which each argument is
3410 taken as a recipient address to be verified by the routers. (This does
3411 not involve any verification callouts). During normal operation, verification
3412 happens mostly as a consequence processing a &%verify%& condition in an ACL
3413 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3414 including callouts, see the &%-bh%& and &%-bhc%& options.
3415
3416 If verification fails, and the caller is not an admin user, no details of the
3417 failure are output, because these might contain sensitive information such as
3418 usernames and passwords for database lookups.
3419
3420 If no arguments are given, Exim runs in an interactive manner, prompting with a
3421 right angle bracket for addresses to be verified.
3422
3423 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3424 &[readline()]& function, because it is running as &'exim'& and there are
3425 security issues.
3426
3427 Verification differs from address testing (the &%-bt%& option) in that routers
3428 that have &%no_verify%& set are skipped, and if the address is accepted by a
3429 router that has &%fail_verify%& set, verification fails. The address is
3430 verified as a recipient if &%-bv%& is used; to test verification for a sender
3431 address, &%-bvs%& should be used.
3432
3433 If the &%-v%& option is not set, the output consists of a single line for each
3434 address, stating whether it was verified or not, and giving a reason in the
3435 latter case. Without &%-v%&, generating more than one address by redirection
3436 causes verification to end successfully, without considering the generated
3437 addresses. However, if just one address is generated, processing continues,
3438 and the generated address must verify successfully for the overall verification
3439 to succeed.
3440
3441 When &%-v%& is set, more details are given of how the address has been handled,
3442 and in the case of address redirection, all the generated addresses are also
3443 considered. Verification may succeed for some and fail for others.
3444
3445 The
3446 .cindex "return code" "for &%-bv%&"
3447 return code is 2 if any address failed outright; it is 1 if no address
3448 failed outright but at least one could not be resolved for some reason. Return
3449 code 0 is given only when all addresses succeed.
3450
3451 If any of the routers in the configuration makes any tests on the sender
3452 address of a message, you should use the &%-f%& option to set an appropriate
3453 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3454 calling user at the default qualifying domain.
3455
3456 .vitem &%-bvs%&
3457 .oindex "&%-bvs%&"
3458 This option acts like &%-bv%&, but verifies the address as a sender rather
3459 than a recipient address. This affects any rewriting and qualification that
3460 might happen.
3461
3462 .vitem &%-bw%&
3463 .oindex "&%-bw%&"
3464 .cindex "daemon"
3465 .cindex "inetd"
3466 .cindex "inetd" "wait mode"
3467 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3468 similarly to the &%-bd%& option.  All port specifications on the command-line
3469 and in the configuration file are ignored.  Queue-running may not be specified.
3470
3471 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3472 listening for connections.  This permits the system to start up and have
3473 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3474 each port only when the first connection is received.
3475
3476 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3477 which the daemon will exit, which should cause inetd to listen once more.
3478
3479 .vitem &%-C%&&~<&'filelist'&>
3480 .oindex "&%-C%&"
3481 .cindex "configuration file" "alternate"
3482 .cindex "CONFIGURE_FILE"
3483 .cindex "alternate configuration file"
3484 This option causes Exim to find the run time configuration file from the given
3485 list instead of from the list specified by the CONFIGURE_FILE
3486 compile-time setting. Usually, the list will consist of just a single file
3487 name, but it can be a colon-separated list of names. In this case, the first
3488 file that exists is used. Failure to open an existing file stops Exim from
3489 proceeding any further along the list, and an error is generated.
3490
3491 When this option is used by a caller other than root, and the list is different
3492 from the compiled-in list, Exim gives up its root privilege immediately, and
3493 runs with the real and effective uid and gid set to those of the caller.
3494 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3495 file contains a list of full pathnames, one per line, for configuration files
3496 which are trusted. Root privilege is retained for any configuration file so
3497 listed, as long as the caller is the Exim user (or the user specified in the
3498 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3499 not writeable by inappropriate users or groups.
3500
3501 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3502 configuration using &%-C%& right through message reception and delivery,
3503 even if the caller is root. The reception works, but by that time, Exim is
3504 running as the Exim user, so when it re-executes to regain privilege for the
3505 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3506 test reception and delivery using two separate commands (one to put a message
3507 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3508
3509 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3510 prefix string with which any file named in a &%-C%& command line option
3511 must start. In addition, the file name must not contain the sequence &`/../`&.
3512 However, if the value of the &%-C%& option is identical to the value of
3513 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3514 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3515 unset, any file name can be used with &%-C%&.
3516
3517 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3518 to a directory to which only root has access. This prevents someone who has
3519 broken into the Exim account from running a privileged Exim with an arbitrary
3520 configuration file.
3521
3522 The &%-C%& facility is useful for ensuring that configuration files are
3523 syntactically correct, but cannot be used for test deliveries, unless the
3524 caller is privileged, or unless it is an exotic configuration that does not
3525 require privilege. No check is made on the owner or group of the files
3526 specified by this option.
3527
3528
3529 .vitem &%-D%&<&'macro'&>=<&'value'&>
3530 .oindex "&%-D%&"
3531 .cindex "macro" "setting on command line"
3532 This option can be used to override macro definitions in the configuration file
3533 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3534 unprivileged caller, it causes Exim to give up its root privilege.
3535 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3536 completely disabled, and its use causes an immediate error exit.
3537
3538 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3539 colon-separated list of macros which are considered safe and, if &%-D%& only
3540 supplies macros from this list, and the values are acceptable, then Exim will
3541 not give up root privilege if the caller is root, the Exim run-time user, or
3542 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3543 to be removed in the future.  Acceptable values for the macros satisfy the
3544 regexp: &`^[A-Za-z0-9_/.-]*$`&
3545
3546 The entire option (including equals sign if present) must all be within one
3547 command line item. &%-D%& can be used to set the value of a macro to the empty
3548 string, in which case the equals sign is optional. These two commands are
3549 synonymous:
3550 .code
3551 exim -DABC  ...
3552 exim -DABC= ...
3553 .endd
3554 To include spaces in a macro definition item, quotes must be used. If you use
3555 quotes, spaces are permitted around the macro name and the equals sign. For
3556 example:
3557 .code
3558 exim '-D ABC = something' ...
3559 .endd
3560 &%-D%& may be repeated up to 10 times on a command line.
3561 Only macro names up to 22 letters long can be set.
3562
3563
3564 .vitem &%-d%&<&'debug&~options'&>
3565 .oindex "&%-d%&"
3566 .cindex "debugging" "list of selectors"
3567 .cindex "debugging" "&%-d%& option"
3568 This option causes debugging information to be written to the standard
3569 error stream. It is restricted to admin users because debugging output may show
3570 database queries that contain password information. Also, the details of users'
3571 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3572 writes an error message to the standard error stream and exits with a non-zero
3573 return code.
3574
3575 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3576 standard debugging data is output. This can be reduced, or increased to include
3577 some more rarely needed information, by directly following &%-d%& with a string
3578 made up of names preceded by plus or minus characters. These add or remove sets
3579 of debugging data, respectively. For example, &%-d+filter%& adds filter
3580 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3581 no spaces are allowed in the debug setting. The available debugging categories
3582 are:
3583 .display
3584 &`acl            `& ACL interpretation
3585 &`auth           `& authenticators
3586 &`deliver        `& general delivery logic
3587 &`dns            `& DNS lookups (see also resolver)
3588 &`dnsbl          `& DNS black list (aka RBL) code
3589 &`exec           `& arguments for &[execv()]& calls
3590 &`expand         `& detailed debugging for string expansions
3591 &`filter         `& filter handling
3592 &`hints_lookup   `& hints data lookups
3593 &`host_lookup    `& all types of name-to-IP address handling
3594 &`ident          `& ident lookup
3595 &`interface      `& lists of local interfaces
3596 &`lists          `& matching things in lists
3597 &`load           `& system load checks
3598 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3599                     &<<CHAPlocalscan>>&)
3600 &`lookup         `& general lookup code and all lookups
3601 &`memory         `& memory handling
3602 &`pid            `& add pid to debug output lines
3603 &`process_info   `& setting info for the process log
3604 &`queue_run      `& queue runs
3605 &`receive        `& general message reception logic
3606 &`resolver       `& turn on the DNS resolver's debugging output
3607 &`retry          `& retry handling
3608 &`rewrite        `& address rewriting
3609 &`route          `& address routing
3610 &`timestamp      `& add timestamp to debug output lines
3611 &`tls            `& TLS logic
3612 &`transport      `& transports
3613 &`uid            `& changes of uid/gid and looking up uid/gid
3614 &`verify         `& address verification logic
3615 &`all            `& almost all of the above (see below), and also &%-v%&
3616 .endd
3617 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3618 for &`-all`&. The reason for this is that &`+all`& is something that people
3619 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3620 is included, an awful lot of output that is very rarely of interest is
3621 generated, so it now has to be explicitly requested. However, &`-all`& does
3622 turn everything off.
3623
3624 .cindex "resolver, debugging output"
3625 .cindex "DNS resolver, debugging output"
3626 The &`resolver`& option produces output only if the DNS resolver was compiled
3627 with DEBUG enabled. This is not the case in some operating systems. Also,
3628 unfortunately, debugging output from the DNS resolver is written to stdout
3629 rather than stderr.
3630
3631 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3632 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3633 However, the &`pid`& selector is forced when debugging is turned on for a
3634 daemon, which then passes it on to any re-executed Exims. Exim also
3635 automatically adds the pid to debug lines when several remote deliveries are
3636 run in parallel.
3637
3638 The &`timestamp`& selector causes the current time to be inserted at the start
3639 of all debug output lines. This can be useful when trying to track down delays
3640 in processing.
3641
3642 If the &%debug_print%& option is set in any driver, it produces output whenever
3643 any debugging is selected, or if &%-v%& is used.
3644
3645 .vitem &%-dd%&<&'debug&~options'&>
3646 .oindex "&%-dd%&"
3647 This option behaves exactly like &%-d%& except when used on a command that
3648 starts a daemon process. In that case, debugging is turned off for the
3649 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3650 behaviour of the daemon without creating as much output as full debugging does.
3651
3652 .vitem &%-dropcr%&
3653 .oindex "&%-dropcr%&"
3654 This is an obsolete option that is now a no-op. It used to affect the way Exim
3655 handled CR and LF characters in incoming messages. What happens now is
3656 described in section &<<SECTlineendings>>&.
3657
3658 .vitem &%-E%&
3659 .oindex "&%-E%&"
3660 .cindex "bounce message" "generating"
3661 This option specifies that an incoming message is a locally-generated delivery
3662 failure report. It is used internally by Exim when handling delivery failures
3663 and is not intended for external use. Its only effect is to stop Exim
3664 generating certain messages to the postmaster, as otherwise message cascades
3665 could occur in some situations. As part of the same option, a message id may
3666 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3667 new message contains the id, following &"R="&, as a cross-reference.
3668
3669 .vitem &%-e%&&'x'&
3670 .oindex "&%-e%&&'x'&"
3671 There are a number of Sendmail options starting with &%-oe%& which seem to be
3672 called by various programs without the leading &%o%& in the option. For
3673 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3674 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3675
3676 .vitem &%-F%&&~<&'string'&>
3677 .oindex "&%-F%&"
3678 .cindex "sender" "name"
3679 .cindex "name" "of sender"
3680 This option sets the sender's full name for use when a locally-generated
3681 message is being accepted. In the absence of this option, the user's &'gecos'&
3682 entry from the password data is used. As users are generally permitted to alter
3683 their &'gecos'& entries, no security considerations are involved. White space
3684 between &%-F%& and the <&'string'&> is optional.
3685
3686 .vitem &%-f%&&~<&'address'&>
3687 .oindex "&%-f%&"
3688 .cindex "sender" "address"
3689 .cindex "address" "sender"
3690 .cindex "trusted users"
3691 .cindex "envelope sender"
3692 .cindex "user" "trusted"
3693 This option sets the address of the envelope sender of a locally-generated
3694 message (also known as the return path). The option can normally be used only
3695 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3696 users to use it.
3697
3698 Processes running as root or the Exim user are always trusted. Other
3699 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3700 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3701 of a local message is set to the caller's login name at the default qualify
3702 domain.
3703
3704 There is one exception to the restriction on the use of &%-f%&: an empty sender
3705 can be specified by any user, trusted or not, to create a message that can
3706 never provoke a bounce. An empty sender can be specified either as an empty
3707 string, or as a pair of angle brackets with nothing between them, as in these
3708 examples of shell commands:
3709 .code
3710 exim -f '<>' user@domain
3711 exim -f "" user@domain
3712 .endd
3713 In addition, the use of &%-f%& is not restricted when testing a filter file
3714 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3715 &%-bv%& options.
3716
3717 Allowing untrusted users to change the sender address does not of itself make
3718 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3719 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3720 though this can be overridden by setting &%no_local_from_check%&.
3721
3722 White
3723 .cindex "&""From""& line"
3724 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3725 given as two arguments or one combined argument). The sender of a
3726 locally-generated message can also be set (when permitted) by an initial
3727 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3728 if &%-f%& is also present, it overrides &"From&~"&.
3729
3730 .vitem &%-G%&
3731 .oindex "&%-G%&"
3732 .cindex "submission fixups, suppressing (command-line)"
3733 This option is equivalent to an ACL applying:
3734 .code
3735 control = suppress_local_fixups
3736 .endd
3737 for every message received.  Note that Sendmail will complain about such
3738 bad formatting, where Exim silently just does not fix it up.  This may change
3739 in future.
3740
3741 As this affects audit information, the caller must be a trusted user to use
3742 this option.
3743
3744 .vitem &%-h%&&~<&'number'&>
3745 .oindex "&%-h%&"
3746 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3747 This option is accepted for compatibility with Sendmail, but has no effect. (In
3748 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3749 headers.)
3750
3751 .vitem &%-i%&
3752 .oindex "&%-i%&"
3753 .cindex "Solaris" "&'mail'& command"
3754 .cindex "dot" "in incoming non-SMTP message"
3755 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3756 line by itself should not terminate an incoming, non-SMTP message. I can find
3757 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3758 command in Solaris 2.4 uses it. See also &%-ti%&.
3759
3760 .vitem &%-L%&&~<&'tag'&>
3761 .oindex "&%-L%&"
3762 .cindex "syslog" "process name; set with flag"
3763 This option is equivalent to setting &%syslog_processname%& in the config
3764 file and setting &%log_file_path%& to &`syslog`&.
3765 Its use is restricted to administrators.  The configuration file has to be
3766 read and parsed, to determine access rights, before this is set and takes
3767 effect, so early configuration file errors will not honour this flag.
3768
3769 The tag should not be longer than 32 characters.
3770
3771 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3772 .oindex "&%-M%&"
3773 .cindex "forcing delivery"
3774 .cindex "delivery" "forcing attempt"
3775 .cindex "frozen messages" "forcing delivery"
3776 This option requests Exim to run a delivery attempt on each message in turn. If
3777 any of the messages are frozen, they are automatically thawed before the
3778 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3779 and &%hold_domains%& are ignored.
3780
3781 Retry
3782 .cindex "hints database" "overriding retry hints"
3783 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3784 the normal retry time has not yet been reached. This option requires the caller
3785 to be an admin user. However, there is an option called &%prod_requires_admin%&
3786 which can be set false to relax this restriction (and also the same requirement
3787 for the &%-q%&, &%-R%&, and &%-S%& options).
3788
3789 The deliveries happen synchronously, that is, the original Exim process does
3790 not terminate until all the delivery attempts have finished. No output is
3791 produced unless there is a serious error. If you want to see what is happening,
3792 use the &%-v%& option as well, or inspect Exim's main log.
3793
3794 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3795 .oindex "&%-Mar%&"
3796 .cindex "message" "adding recipients"
3797 .cindex "recipient" "adding"
3798 This option requests Exim to add the addresses to the list of recipients of the
3799 message (&"ar"& for &"add recipients"&). The first argument must be a message
3800 id, and the remaining ones must be email addresses. However, if the message is
3801 active (in the middle of a delivery attempt), it is not altered. This option
3802 can be used only by an admin user.
3803
3804 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3805         &~<&'message&~id'&>"
3806 .oindex "&%-MC%&"
3807 .cindex "SMTP" "passed connection"
3808 .cindex "SMTP" "multiple deliveries"
3809 .cindex "multiple SMTP deliveries"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim to invoke another instance of itself to deliver a waiting message using
3812 an existing SMTP connection, which is passed as the standard input. Details are
3813 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3814 must be root or the Exim user in order to use it.
3815
3816 .vitem &%-MCA%&
3817 .oindex "&%-MCA%&"
3818 This option is not intended for use by external callers. It is used internally
3819 by Exim in conjunction with the &%-MC%& option. It signifies that the
3820 connection to the remote host has been authenticated.
3821
3822 .vitem &%-MCD%&
3823 .oindex "&%-MCD%&"
3824 This option is not intended for use by external callers. It is used internally
3825 by Exim in conjunction with the &%-MC%& option. It signifies that the
3826 remote host supports the ESMTP &_DSN_& extension.
3827
3828 .new
3829 .vitem &%-MCG%&
3830 .oindex "&%-MCG%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option. It signifies that an
3833 alternate queue is used, named by the following option.
3834 .wen
3835
3836 .vitem &%-MCP%&
3837 .oindex "&%-MCP%&"
3838 This option is not intended for use by external callers. It is used internally
3839 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3840 which Exim is connected supports pipelining.
3841
3842 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3843 .oindex "&%-MCQ%&"
3844 This option is not intended for use by external callers. It is used internally
3845 by Exim in conjunction with the &%-MC%& option when the original delivery was
3846 started by a queue runner. It passes on the process id of the queue runner,
3847 together with the file descriptor number of an open pipe. Closure of the pipe
3848 signals the final completion of the sequence of processes that are passing
3849 messages through the same SMTP connection.
3850
3851 .vitem &%-MCS%&
3852 .oindex "&%-MCS%&"
3853 This option is not intended for use by external callers. It is used internally
3854 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3855 SMTP SIZE option should be used on messages delivered down the existing
3856 connection.
3857
3858 .vitem &%-MCT%&
3859 .oindex "&%-MCT%&"
3860 This option is not intended for use by external callers. It is used internally
3861 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3862 host to which Exim is connected supports TLS encryption.
3863
3864 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3865 .oindex "&%-Mc%&"
3866 .cindex "hints database" "not overridden by &%-Mc%&"
3867 .cindex "delivery" "manually started &-- not forced"
3868 This option requests Exim to run a delivery attempt on each message in turn,
3869 but unlike the &%-M%& option, it does check for retry hints, and respects any
3870 that are found. This option is not very useful to external callers. It is
3871 provided mainly for internal use by Exim when it needs to re-invoke itself in
3872 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3873 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3874 respects retry times and other options such as &%hold_domains%& that are
3875 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3876 If you want to run a specific delivery as if in a queue run, you should use
3877 &%-q%& with a message id argument. A distinction between queue run deliveries
3878 and other deliveries is made in one or two places.
3879
3880 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3881 .oindex "&%-Mes%&"
3882 .cindex "message" "changing sender"
3883 .cindex "sender" "changing"
3884 This option requests Exim to change the sender address in the message to the
3885 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3886 &"edit sender"&). There must be exactly two arguments. The first argument must
3887 be a message id, and the second one an email address. However, if the message
3888 is active (in the middle of a delivery attempt), its status is not altered.
3889 This option can be used only by an admin user.
3890
3891 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3892 .oindex "&%-Mf%&"
3893 .cindex "freezing messages"
3894 .cindex "message" "manually freezing"
3895 This option requests Exim to mark each listed message as &"frozen"&. This
3896 prevents any delivery attempts taking place until the message is &"thawed"&,
3897 either manually or as a result of the &%auto_thaw%& configuration option.
3898 However, if any of the messages are active (in the middle of a delivery
3899 attempt), their status is not altered. This option can be used only by an admin
3900 user.
3901
3902 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3903 .oindex "&%-Mg%&"
3904 .cindex "giving up on messages"
3905 .cindex "message" "abandoning delivery attempts"
3906 .cindex "delivery" "abandoning further attempts"
3907 This option requests Exim to give up trying to deliver the listed messages,
3908 including any that are frozen. However, if any of the messages are active,
3909 their status is not altered. For non-bounce messages, a delivery error message
3910 is sent to the sender, containing the text &"cancelled by administrator"&.
3911 Bounce messages are just discarded. This option can be used only by an admin
3912 user.
3913
3914 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3915 .oindex "&%-Mmad%&"
3916 .cindex "delivery" "cancelling all"
3917 This option requests Exim to mark all the recipient addresses in the messages
3918 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3919 message is active (in the middle of a delivery attempt), its status is not
3920 altered. This option can be used only by an admin user.
3921
3922 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3923 .oindex "&%-Mmd%&"
3924 .cindex "delivery" "cancelling by address"
3925 .cindex "recipient" "removing"
3926 .cindex "removing recipients"
3927 This option requests Exim to mark the given addresses as already delivered
3928 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3929 the remaining ones must be email addresses. These are matched to recipient
3930 addresses in the message in a case-sensitive manner. If the message is active
3931 (in the middle of a delivery attempt), its status is not altered. This option
3932 can be used only by an admin user.
3933
3934 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3935 .oindex "&%-Mrm%&"
3936 .cindex "removing messages"
3937 .cindex "abandoning mail"
3938 .cindex "message" "manually discarding"
3939 This option requests Exim to remove the given messages from the queue. No
3940 bounce messages are sent; each message is simply forgotten. However, if any of
3941 the messages are active, their status is not altered. This option can be used
3942 only by an admin user or by the user who originally caused the message to be
3943 placed on the queue.
3944
3945 .vitem &%-Mset%&&~<&'message&~id'&>
3946 .oindex "&%-Mset%&
3947 .cindex "testing" "string expansion"
3948 .cindex "expansion" "testing"
3949 This option is useful only in conjunction with &%-be%& (that is, when testing
3950 string expansions). Exim loads the given message from its spool before doing
3951 the test expansions, thus setting message-specific variables such as
3952 &$message_size$& and the header variables. The &$recipients$& variable is made
3953 available. This feature is provided to make it easier to test expansions that
3954 make use of these variables. However, this option can be used only by an admin
3955 user. See also &%-bem%&.
3956
3957 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3958 .oindex "&%-Mt%&"
3959 .cindex "thawing messages"
3960 .cindex "unfreezing messages"
3961 .cindex "frozen messages" "thawing"
3962 .cindex "message" "thawing frozen"
3963 This option requests Exim to &"thaw"& any of the listed messages that are
3964 &"frozen"&, so that delivery attempts can resume. However, if any of the
3965 messages are active, their status is not altered. This option can be used only
3966 by an admin user.
3967
3968 .vitem &%-Mvb%&&~<&'message&~id'&>
3969 .oindex "&%-Mvb%&"
3970 .cindex "listing" "message body"
3971 .cindex "message" "listing body of"
3972 This option causes the contents of the message body (-D) spool file to be
3973 written to the standard output. This option can be used only by an admin user.
3974
3975 .vitem &%-Mvc%&&~<&'message&~id'&>
3976 .oindex "&%-Mvc%&"
3977 .cindex "message" "listing in RFC 2822 format"
3978 .cindex "listing" "message in RFC 2822 format"
3979 This option causes a copy of the complete message (header lines plus body) to
3980 be written to the standard output in RFC 2822 format. This option can be used
3981 only by an admin user.
3982
3983 .vitem &%-Mvh%&&~<&'message&~id'&>
3984 .oindex "&%-Mvh%&"
3985 .cindex "listing" "message headers"
3986 .cindex "header lines" "listing"
3987 .cindex "message" "listing header lines"
3988 This option causes the contents of the message headers (-H) spool file to be
3989 written to the standard output. This option can be used only by an admin user.
3990
3991 .vitem &%-Mvl%&&~<&'message&~id'&>
3992 .oindex "&%-Mvl%&"
3993 .cindex "listing" "message log"
3994 .cindex "message" "listing message log"
3995 This option causes the contents of the message log spool file to be written to
3996 the standard output. This option can be used only by an admin user.
3997
3998 .vitem &%-m%&
3999 .oindex "&%-m%&"
4000 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4001 treats it that way too.
4002
4003 .vitem &%-N%&
4004 .oindex "&%-N%&"
4005 .cindex "debugging" "&%-N%& option"
4006 .cindex "debugging" "suppressing delivery"
4007 This is a debugging option that inhibits delivery of a message at the transport
4008 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4009 it just doesn't actually transport the message, but instead behaves as if it
4010 had successfully done so. However, it does not make any updates to the retry
4011 database, and the log entries for deliveries are flagged with &"*>"& rather
4012 than &"=>"&.
4013
4014 Because &%-N%& discards any message to which it applies, only root or the Exim
4015 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4016 words, an ordinary user can use it only when supplying an incoming message to
4017 which it will apply. Although transportation never fails when &%-N%& is set, an
4018 address may be deferred because of a configuration problem on a transport, or a
4019 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4020 the message, and applies to any subsequent delivery attempts that may happen
4021 for that message.
4022
4023 .vitem &%-n%&
4024 .oindex "&%-n%&"
4025 This option is interpreted by Sendmail to mean &"no aliasing"&.
4026 For normal modes of operation, it is ignored by Exim.
4027 When combined with &%-bP%& it makes the output more terse (suppresses
4028 option names, environment values and config pretty printing).
4029
4030 .vitem &%-O%&&~<&'data'&>
4031 .oindex "&%-O%&"
4032 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4033 Exim.
4034
4035 .vitem &%-oA%&&~<&'file&~name'&>
4036 .oindex "&%-oA%&"
4037 .cindex "Sendmail compatibility" "&%-oA%& option"
4038 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4039 alternative alias file name. Exim handles &%-bi%& differently; see the
4040 description above.
4041
4042 .vitem &%-oB%&&~<&'n'&>
4043 .oindex "&%-oB%&"
4044 .cindex "SMTP" "passed connection"
4045 .cindex "SMTP" "multiple deliveries"
4046 .cindex "multiple SMTP deliveries"
4047 This is a debugging option which limits the maximum number of messages that can
4048 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4049 transport. If <&'n'&> is omitted, the limit is set to 1.
4050
4051 .vitem &%-odb%&
4052 .oindex "&%-odb%&"
4053 .cindex "background delivery"
4054 .cindex "delivery" "in the background"
4055 This option applies to all modes in which Exim accepts incoming messages,
4056 including the listening daemon. It requests &"background"& delivery of such
4057 messages, which means that the accepting process automatically starts a
4058 delivery process for each message received, but does not wait for the delivery
4059 processes to finish.
4060
4061 When all the messages have been received, the reception process exits,
4062 leaving the delivery processes to finish in their own time. The standard output
4063 and error streams are closed at the start of each delivery process.
4064 This is the default action if none of the &%-od%& options are present.
4065
4066 If one of the queueing options in the configuration file
4067 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4068 overrides it if &%queue_only_override%& is set true, which is the default
4069 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4070
4071 .vitem &%-odf%&
4072 .oindex "&%-odf%&"
4073 .cindex "foreground delivery"
4074 .cindex "delivery" "in the foreground"
4075 This option requests &"foreground"& (synchronous) delivery when Exim has
4076 accepted a locally-generated message. (For the daemon it is exactly the same as
4077 &%-odb%&.) A delivery process is automatically started to deliver the message,
4078 and Exim waits for it to complete before proceeding.
4079
4080 The original Exim reception process does not finish until the delivery
4081 process for the final message has ended. The standard error stream is left open
4082 during deliveries.
4083
4084 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4085 false and one of the queueing options in the configuration file is in effect.
4086
4087 If there is a temporary delivery error during foreground delivery, the
4088 message is left on the queue for later delivery, and the original reception
4089 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4090 restricted configuration that never queues messages.
4091
4092
4093 .vitem &%-odi%&
4094 .oindex "&%-odi%&"
4095 This option is synonymous with &%-odf%&. It is provided for compatibility with
4096 Sendmail.
4097
4098 .vitem &%-odq%&
4099 .oindex "&%-odq%&"
4100 .cindex "non-immediate delivery"
4101 .cindex "delivery" "suppressing immediate"
4102 .cindex "queueing incoming messages"
4103 This option applies to all modes in which Exim accepts incoming messages,
4104 including the listening daemon. It specifies that the accepting process should
4105 not automatically start a delivery process for each message received. Messages
4106 are placed on the queue, and remain there until a subsequent queue runner
4107 process encounters them. There are several configuration options (such as
4108 &%queue_only%&) that can be used to queue incoming messages under certain
4109 conditions. This option overrides all of them and also &%-odqs%&. It always
4110 forces queueing.
4111
4112 .vitem &%-odqs%&
4113 .oindex "&%-odqs%&"
4114 .cindex "SMTP" "delaying delivery"
4115 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4116 However, like &%-odb%& and &%-odi%&, this option has no effect if
4117 &%queue_only_override%& is false and one of the queueing options in the
4118 configuration file is in effect.
4119
4120 When &%-odqs%& does operate, a delivery process is started for each incoming
4121 message, in the background by default, but in the foreground if &%-odi%& is
4122 also present. The recipient addresses are routed, and local deliveries are done
4123 in the normal way. However, if any SMTP deliveries are required, they are not
4124 done at this time, so the message remains on the queue until a subsequent queue
4125 runner process encounters it. Because routing was done, Exim knows which
4126 messages are waiting for which hosts, and so a number of messages for the same
4127 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4128 configuration option has the same effect for specific domains. See also the
4129 &%-qq%& option.
4130
4131 .vitem &%-oee%&
4132 .oindex "&%-oee%&"
4133 .cindex "error" "reporting"
4134 If an error is detected while a non-SMTP message is being received (for
4135 example, a malformed address), the error is reported to the sender in a mail
4136 message.
4137
4138 .cindex "return code" "for &%-oee%&"
4139 Provided
4140 this error message is successfully sent, the Exim receiving process
4141 exits with a return code of zero. If not, the return code is 2 if the problem
4142 is that the original message has no recipients, or 1 for any other error.
4143 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4144
4145 .vitem &%-oem%&
4146 .oindex "&%-oem%&"
4147 .cindex "error" "reporting"
4148 .cindex "return code" "for &%-oem%&"
4149 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4150 return code, whether or not the error message was successfully sent.
4151 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4152
4153 .vitem &%-oep%&
4154 .oindex "&%-oep%&"
4155 .cindex "error" "reporting"
4156 If an error is detected while a non-SMTP message is being received, the
4157 error is reported by writing a message to the standard error file (stderr).
4158 .cindex "return code" "for &%-oep%&"
4159 The return code is 1 for all errors.
4160
4161 .vitem &%-oeq%&
4162 .oindex "&%-oeq%&"
4163 .cindex "error" "reporting"
4164 This option is supported for compatibility with Sendmail, but has the same
4165 effect as &%-oep%&.
4166
4167 .vitem &%-oew%&
4168 .oindex "&%-oew%&"
4169 .cindex "error" "reporting"
4170 This option is supported for compatibility with Sendmail, but has the same
4171 effect as &%-oem%&.
4172
4173 .vitem &%-oi%&
4174 .oindex "&%-oi%&"
4175 .cindex "dot" "in incoming non-SMTP message"
4176 This option, which has the same effect as &%-i%&, specifies that a dot on a
4177 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4178 single dot does terminate, though Exim does no special processing for other
4179 lines that start with a dot. This option is set by default if Exim is called as
4180 &'rmail'&. See also &%-ti%&.
4181
4182 .vitem &%-oitrue%&
4183 .oindex "&%-oitrue%&"
4184 This option is treated as synonymous with &%-oi%&.
4185
4186 .vitem &%-oMa%&&~<&'host&~address'&>
4187 .oindex "&%-oMa%&"
4188 .cindex "sender" "host address, specifying for local message"
4189 A number of options starting with &%-oM%& can be used to set values associated
4190 with remote hosts on locally-submitted messages (that is, messages not received
4191 over TCP/IP). These options can be used by any caller in conjunction with the
4192 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4193 other circumstances, they are ignored unless the caller is trusted.
4194
4195 The &%-oMa%& option sets the sender host address. This may include a port
4196 number at the end, after a full stop (period). For example:
4197 .code
4198 exim -bs -oMa 10.9.8.7.1234
4199 .endd
4200 An alternative syntax is to enclose the IP address in square brackets,
4201 followed by a colon and the port number:
4202 .code
4203 exim -bs -oMa [10.9.8.7]:1234
4204 .endd
4205 The IP address is placed in the &$sender_host_address$& variable, and the
4206 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4207 are present on the command line, the sender host IP address is taken from
4208 whichever one is last.
4209
4210 .vitem &%-oMaa%&&~<&'name'&>
4211 .oindex "&%-oMaa%&"
4212 .cindex "authentication" "name, specifying for local message"
4213 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4214 option sets the value of &$sender_host_authenticated$& (the authenticator
4215 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4216 This option can be used with &%-bh%& and &%-bs%& to set up an
4217 authenticated SMTP session without actually using the SMTP AUTH command.
4218
4219 .vitem &%-oMai%&&~<&'string'&>
4220 .oindex "&%-oMai%&"
4221 .cindex "authentication" "id, specifying for local message"
4222 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4223 option sets the value of &$authenticated_id$& (the id that was authenticated).
4224 This overrides the default value (the caller's login id, except with &%-bh%&,
4225 where there is no default) for messages from local sources. See chapter
4226 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4227
4228 .vitem &%-oMas%&&~<&'address'&>
4229 .oindex "&%-oMas%&"
4230 .cindex "authentication" "sender, specifying for local message"
4231 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4232 option sets the authenticated sender value in &$authenticated_sender$&. It
4233 overrides the sender address that is created from the caller's login id for
4234 messages from local sources, except when &%-bh%& is used, when there is no
4235 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4236 specified on a MAIL command overrides this value. See chapter
4237 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4238
4239 .vitem &%-oMi%&&~<&'interface&~address'&>
4240 .oindex "&%-oMi%&"
4241 .cindex "interface" "address, specifying for local message"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4243 option sets the IP interface address value. A port number may be included,
4244 using the same syntax as for &%-oMa%&. The interface address is placed in
4245 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4246
4247 .vitem &%-oMm%&&~<&'message&~reference'&>
4248 .oindex "&%-oMm%&"
4249 .cindex "message reference" "message reference, specifying for local message"
4250 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4251 option sets the message reference, e.g. message-id, and is logged during
4252 delivery. This is useful when some kind of audit trail is required to tie
4253 messages together. The format of the message reference is checked and will
4254 abort if the format is invalid. The option will only be accepted if exim is
4255 running in trusted mode, not as any regular user.
4256
4257 The best example of a message reference is when Exim sends a bounce message.
4258 The message reference is the message-id of the original message for which Exim
4259 is sending the bounce.
4260
4261 .vitem &%-oMr%&&~<&'protocol&~name'&>
4262 .oindex "&%-oMr%&"
4263 .cindex "protocol, specifying for local message"
4264 .vindex "&$received_protocol$&"
4265 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4266 option sets the received protocol value that is stored in
4267 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4268 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4269 SMTP protocol names (see the description of &$received_protocol$& in section
4270 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4271 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4272 be set by &%-oMr%&.
4273
4274 .vitem &%-oMs%&&~<&'host&~name'&>
4275 .oindex "&%-oMs%&"
4276 .cindex "sender" "host name, specifying for local message"
4277 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4278 option sets the sender host name in &$sender_host_name$&. When this option is
4279 present, Exim does not attempt to look up a host name from an IP address; it
4280 uses the name it is given.
4281
4282 .vitem &%-oMt%&&~<&'ident&~string'&>
4283 .oindex "&%-oMt%&"
4284 .cindex "sender" "ident string, specifying for local message"
4285 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4286 option sets the sender ident value in &$sender_ident$&. The default setting for
4287 local callers is the login id of the calling process, except when &%-bh%& is
4288 used, when there is no default.
4289
4290 .vitem &%-om%&
4291 .oindex "&%-om%&"
4292 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4293 In Sendmail, this option means &"me too"&, indicating that the sender of a
4294 message should receive a copy of the message if the sender appears in an alias
4295 expansion. Exim always does this, so the option does nothing.
4296
4297 .vitem &%-oo%&
4298 .oindex "&%-oo%&"
4299 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4300 This option is ignored. In Sendmail it specifies &"old style headers"&,
4301 whatever that means.
4302
4303 .vitem &%-oP%&&~<&'path'&>
4304 .oindex "&%-oP%&"
4305 .cindex "pid (process id)" "of daemon"
4306 .cindex "daemon" "process id (pid)"
4307 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4308 value. The option specifies the file to which the process id of the daemon is
4309 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4310 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4311 because in those cases, the normal pid file is not used.
4312
4313 .vitem &%-or%&&~<&'time'&>
4314 .oindex "&%-or%&"
4315 .cindex "timeout" "for non-SMTP input"
4316 This option sets a timeout value for incoming non-SMTP messages. If it is not
4317 set, Exim will wait forever for the standard input. The value can also be set
4318 by the &%receive_timeout%& option. The format used for specifying times is
4319 described in section &<<SECTtimeformat>>&.
4320
4321 .vitem &%-os%&&~<&'time'&>
4322 .oindex "&%-os%&"
4323 .cindex "timeout" "for SMTP input"
4324 .cindex "SMTP" "input timeout"
4325 This option sets a timeout value for incoming SMTP messages. The timeout
4326 applies to each SMTP command and block of data. The value can also be set by
4327 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4328 for specifying times is described in section &<<SECTtimeformat>>&.
4329
4330 .vitem &%-ov%&
4331 .oindex "&%-ov%&"
4332 This option has exactly the same effect as &%-v%&.
4333
4334 .vitem &%-oX%&&~<&'number&~or&~string'&>
4335 .oindex "&%-oX%&"
4336 .cindex "TCP/IP" "setting listening ports"
4337 .cindex "TCP/IP" "setting listening interfaces"
4338 .cindex "port" "receiving TCP/IP"
4339 This option is relevant only when the &%-bd%& (start listening daemon) option
4340 is also given. It controls which ports and interfaces the daemon uses. Details
4341 of the syntax, and how it interacts with configuration file options, are given
4342 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4343 file is written unless &%-oP%& is also present to specify a pid file name.
4344
4345 .vitem &%-pd%&
4346 .oindex "&%-pd%&"
4347 .cindex "Perl" "starting the interpreter"
4348 This option applies when an embedded Perl interpreter is linked with Exim (see
4349 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4350 option, forcing the starting of the interpreter to be delayed until it is
4351 needed.
4352
4353 .vitem &%-ps%&
4354 .oindex "&%-ps%&"
4355 .cindex "Perl" "starting the interpreter"
4356 This option applies when an embedded Perl interpreter is linked with Exim (see
4357 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4358 option, forcing the starting of the interpreter to occur as soon as Exim is
4359 started.
4360
4361 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4362 .oindex "&%-p%&"
4363 For compatibility with Sendmail, this option is equivalent to
4364 .display
4365 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4366 .endd
4367 It sets the incoming protocol and host name (for trusted callers). The
4368 host name and its colon can be omitted when only the protocol is to be set.
4369 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4370 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4371 or &`s`& using this option (but that does not seem a real limitation).
4372
4373 .vitem &%-q%&
4374 .oindex "&%-q%&"
4375 .cindex "queue runner" "starting manually"
4376 This option is normally restricted to admin users. However, there is a
4377 configuration option called &%prod_requires_admin%& which can be set false to
4378 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4379 and &%-S%& options).
4380
4381 .cindex "queue runner" "description of operation"
4382 .new
4383 If other commandline options do not specify an action,
4384 .wen
4385 the &%-q%& option starts one queue runner process. This scans the queue of
4386 waiting messages, and runs a delivery process for each one in turn. It waits
4387 for each delivery process to finish before starting the next one. A delivery
4388 process may not actually do any deliveries if the retry times for the addresses
4389 have not been reached. Use &%-qf%& (see below) if you want to override this.
4390
4391 If
4392 .cindex "SMTP" "passed connection"
4393 .cindex "SMTP" "multiple deliveries"
4394 .cindex "multiple SMTP deliveries"
4395 the delivery process spawns other processes to deliver other messages down
4396 passed SMTP connections, the queue runner waits for these to finish before
4397 proceeding.
4398
4399 When all the queued messages have been considered, the original queue runner
4400 process terminates. In other words, a single pass is made over the waiting
4401 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4402 this to be repeated periodically.
4403
4404 Exim processes the waiting messages in an unpredictable order. It isn't very
4405 random, but it is likely to be different each time, which is all that matters.
4406 If one particular message screws up a remote MTA, other messages to the same
4407 MTA have a chance of getting through if they get tried first.
4408
4409 It is possible to cause the messages to be processed in lexical message id
4410 order, which is essentially the order in which they arrived, by setting the
4411 &%queue_run_in_order%& option, but this is not recommended for normal use.
4412
4413 .vitem &%-q%&<&'qflags'&>
4414 The &%-q%& option may be followed by one or more flag letters that change its
4415 behaviour. They are all optional, but if more than one is present, they must
4416 appear in the correct order. Each flag is described in a separate item below.
4417
4418 .vitem &%-qq...%&
4419 .oindex "&%-qq%&"
4420 .cindex "queue" "double scanning"
4421 .cindex "queue" "routing"
4422 .cindex "routing" "whole queue before delivery"
4423 An option starting with &%-qq%& requests a two-stage queue run. In the first
4424 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4425 every domain. Addresses are routed, local deliveries happen, but no remote
4426 transports are run.
4427
4428 .cindex "hints database" "remembering routing"
4429 The hints database that remembers which messages are waiting for specific hosts
4430 is updated, as if delivery to those hosts had been deferred. After this is
4431 complete, a second, normal queue scan happens, with routing and delivery taking
4432 place as normal. Messages that are routed to the same host should mostly be
4433 delivered down a single SMTP
4434 .cindex "SMTP" "passed connection"
4435 .cindex "SMTP" "multiple deliveries"
4436 .cindex "multiple SMTP deliveries"
4437 connection because of the hints that were set up during the first queue scan.
4438 This option may be useful for hosts that are connected to the Internet
4439 intermittently.
4440
4441 .vitem &%-q[q]i...%&
4442 .oindex "&%-qi%&"
4443 .cindex "queue" "initial delivery"
4444 If the &'i'& flag is present, the queue runner runs delivery processes only for
4445 those messages that haven't previously been tried. (&'i'& stands for &"initial
4446 delivery"&.) This can be helpful if you are putting messages on the queue using
4447 &%-odq%& and want a queue runner just to process the new messages.
4448
4449 .vitem &%-q[q][i]f...%&
4450 .oindex "&%-qf%&"
4451 .cindex "queue" "forcing delivery"
4452 .cindex "delivery" "forcing in queue run"
4453 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4454 message, whereas without &'f'& only those non-frozen addresses that have passed
4455 their retry times are tried.
4456
4457 .vitem &%-q[q][i]ff...%&
4458 .oindex "&%-qff%&"
4459 .cindex "frozen messages" "forcing delivery"
4460 If &'ff'& is present, a delivery attempt is forced for every message, whether
4461 frozen or not.
4462
4463 .vitem &%-q[q][i][f[f]]l%&
4464 .oindex "&%-ql%&"
4465 .cindex "queue" "local deliveries only"
4466 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4467 be done. If a message requires any remote deliveries, it remains on the queue
4468 for later delivery.
4469
4470 .new
4471 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4472 .oindex "&%-qG%&"
4473 .cindex queue named
4474 .cindex "named queues"
4475 .cindex "queue" "delivering specific messages"
4476 If the &'G'& flag and a name is present, the queue runner operates on the
4477 queue with the given name rather than the default queue.
4478 The name should not contain a &'/'& character.
4479 For a periodic queue run (see below)
4480 append to the name a slash and a time value.
4481
4482 If other commandline options speicify an action, a &'-qG<name>'& option
4483 will specify a queue to operate on.
4484 For example:
4485 .code
4486 exim -bp -qGquarantine
4487 mailq -qGquarantime
4488 exim -qGoffpeak -Rf @special.domain.example
4489 .endd
4490 .wen
4491
4492 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4493 When scanning the queue, Exim can be made to skip over messages whose ids are
4494 lexically less than a given value by following the &%-q%& option with a
4495 starting message id. For example:
4496 .code
4497 exim -q 0t5C6f-0000c8-00
4498 .endd
4499 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4500 second message id is given, messages whose ids are lexically greater than it
4501 are also skipped. If the same id is given twice, for example,
4502 .code
4503 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4504 .endd
4505 just one delivery process is started, for that message. This differs from
4506 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4507 that it counts as a delivery from a queue run. Note that the selection
4508 mechanism does not affect the order in which the messages are scanned. There
4509 are also other ways of selecting specific sets of messages for delivery in a
4510 queue run &-- see &%-R%& and &%-S%&.
4511
4512 .vitem &%-q%&<&'qflags'&><&'time'&>
4513 .cindex "queue runner" "starting periodically"
4514 .cindex "periodic queue running"
4515 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4516 starting a queue runner process at intervals specified by the given time value
4517 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4518 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4519 single daemon process handles both functions. A common way of starting up a
4520 combined daemon at system boot time is to use a command such as
4521 .code
4522 /usr/exim/bin/exim -bd -q30m
4523 .endd
4524 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4525 process every 30 minutes.
4526
4527 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4528 pid file is written unless one is explicitly requested by the &%-oP%& option.
4529
4530 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4531 .oindex "&%-qR%&"
4532 This option is synonymous with &%-R%&. It is provided for Sendmail
4533 compatibility.
4534
4535 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4536 .oindex "&%-qS%&"
4537 This option is synonymous with &%-S%&.
4538
4539 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4540 .oindex "&%-R%&"
4541 .cindex "queue runner" "for specific recipients"
4542 .cindex "delivery" "to given domain"
4543 .cindex "domain" "delivery to"
4544 The <&'rsflags'&> may be empty, in which case the white space before the string
4545 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4546 which are the possible values for <&'rsflags'&>. White space is required if
4547 <&'rsflags'&> is not empty.
4548
4549 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4550 perform a single queue run, except that, when scanning the messages on the
4551 queue, Exim processes only those that have at least one undelivered recipient
4552 address containing the given string, which is checked in a case-independent
4553 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4554 regular expression; otherwise it is a literal string.
4555
4556 If you want to do periodic queue runs for messages with specific recipients,
4557 you can combine &%-R%& with &%-q%& and a time value. For example:
4558 .code
4559 exim -q25m -R @special.domain.example
4560 .endd
4561 This example does a queue run for messages with recipients in the given domain
4562 every 25 minutes. Any additional flags that are specified with &%-q%& are
4563 applied to each queue run.
4564
4565 Once a message is selected for delivery by this mechanism, all its addresses
4566 are processed. For the first selected message, Exim overrides any retry
4567 information and forces a delivery attempt for each undelivered address. This
4568 means that if delivery of any address in the first message is successful, any
4569 existing retry information is deleted, and so delivery attempts for that
4570 address in subsequently selected messages (which are processed without forcing)
4571 will run. However, if delivery of any address does not succeed, the retry
4572 information is updated, and in subsequently selected messages, the failing
4573 address will be skipped.
4574
4575 .cindex "frozen messages" "forcing delivery"
4576 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4577 all selected messages, not just the first; frozen messages are included when
4578 &'ff'& is present.
4579
4580 The &%-R%& option makes it straightforward to initiate delivery of all messages
4581 to a given domain after a host has been down for some time. When the SMTP
4582 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4583 effect is to run Exim with the &%-R%& option, but it can be configured to run
4584 an arbitrary command instead.
4585
4586 .vitem &%-r%&
4587 .oindex "&%-r%&"
4588 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4589
4590 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4591 .oindex "&%-S%&"
4592 .cindex "delivery" "from given sender"
4593 .cindex "queue runner" "for specific senders"
4594 This option acts like &%-R%& except that it checks the string against each
4595 message's sender instead of against the recipients. If &%-R%& is also set, both
4596 conditions must be met for a message to be selected. If either of the options
4597 has &'f'& or &'ff'& in its flags, the associated action is taken.
4598
4599 .vitem &%-Tqt%&&~<&'times'&>
4600 .oindex "&%-Tqt%&"
4601 This is an option that is exclusively for use by the Exim testing suite. It is not
4602 recognized when Exim is run normally. It allows for the setting up of explicit
4603 &"queue times"& so that various warning/retry features can be tested.
4604
4605 .vitem &%-t%&
4606 .oindex "&%-t%&"
4607 .cindex "recipient" "extracting from header lines"
4608 .cindex "&'Bcc:'& header line"
4609 .cindex "&'Cc:'& header line"
4610 .cindex "&'To:'& header line"
4611 When Exim is receiving a locally-generated, non-SMTP message on its standard
4612 input, the &%-t%& option causes the recipients of the message to be obtained
4613 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4614 from the command arguments. The addresses are extracted before any rewriting
4615 takes place and the &'Bcc:'& header line, if present, is then removed.
4616
4617 .cindex "Sendmail compatibility" "&%-t%& option"
4618 If the command has any arguments, they specify addresses to which the message
4619 is &'not'& to be delivered. That is, the argument addresses are removed from
4620 the recipients list obtained from the headers. This is compatible with Smail 3
4621 and in accordance with the documented behaviour of several versions of
4622 Sendmail, as described in man pages on a number of operating systems (e.g.
4623 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4624 argument addresses to those obtained from the headers, and the O'Reilly
4625 Sendmail book documents it that way. Exim can be made to add argument addresses
4626 instead of subtracting them by setting the option
4627 &%extract_addresses_remove_arguments%& false.
4628
4629 .cindex "&%Resent-%& header lines" "with &%-t%&"
4630 If there are any &%Resent-%& header lines in the message, Exim extracts
4631 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4632 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4633 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4634 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4635
4636 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4637 message is resent several times). The RFC also specifies that they should be
4638 added at the front of the message, and separated by &'Received:'& lines. It is
4639 not at all clear how &%-t%& should operate in the present of multiple sets,
4640 nor indeed exactly what constitutes a &"set"&.
4641 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4642 are often added at the end of the header, and if a message is resent more than
4643 once, it is common for the original set of &%Resent-%& headers to be renamed as
4644 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4645
4646 .vitem &%-ti%&
4647 .oindex "&%-ti%&"
4648 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4649 compatibility with Sendmail.
4650
4651 .vitem &%-tls-on-connect%&
4652 .oindex "&%-tls-on-connect%&"
4653 .cindex "TLS" "use without STARTTLS"
4654 .cindex "TLS" "automatic start"
4655 This option is available when Exim is compiled with TLS support. It forces all
4656 incoming SMTP connections to behave as if the incoming port is listed in the
4657 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4658 &<<CHAPTLS>>& for further details.
4659
4660
4661 .vitem &%-U%&
4662 .oindex "&%-U%&"
4663 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4664 Sendmail uses this option for &"initial message submission"&, and its
4665 documentation states that in future releases, it may complain about
4666 syntactically invalid messages rather than fixing them when this flag is not
4667 set. Exim ignores this option.
4668
4669 .vitem &%-v%&
4670 .oindex "&%-v%&"
4671 This option causes Exim to write information to the standard error stream,
4672 describing what it is doing. In particular, it shows the log lines for
4673 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4674 dialogue is shown. Some of the log lines shown may not actually be written to
4675 the log if the setting of &%log_selector%& discards them. Any relevant
4676 selectors are shown with each log line. If none are shown, the logging is
4677 unconditional.
4678
4679 .vitem &%-x%&
4680 .oindex "&%-x%&"
4681 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4682 National Language Support extended characters in the body of the mail item"&).
4683 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4684 this option.
4685
4686 .vitem &%-X%&&~<&'logfile'&>
4687 .oindex "&%-X%&"
4688 This option is interpreted by Sendmail to cause debug information to be sent
4689 to the named file.  It is ignored by Exim.
4690
4691 .vitem &%-z%&&~<&'log-line'&>
4692 .oindex "&%-z%&"
4693 This option writes its argument to Exim's logfile.
4694 Use is restricted to administrators; the intent is for operational notes.
4695 Quotes should be used to maintain a multi-word item as a single argument,
4696 under most shells.
4697 .endlist
4698
4699 .ecindex IIDclo1
4700 .ecindex IIDclo2
4701
4702
4703 . ////////////////////////////////////////////////////////////////////////////
4704 . Insert a stylized DocBook comment here, to identify the end of the command
4705 . line options. This is for the benefit of the Perl script that automatically
4706 . creates a man page for the options.
4707 . ////////////////////////////////////////////////////////////////////////////
4708
4709 .literal xml
4710 <!-- === End of command line options === -->
4711 .literal off
4712
4713
4714
4715
4716
4717 . ////////////////////////////////////////////////////////////////////////////
4718 . ////////////////////////////////////////////////////////////////////////////
4719
4720
4721 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4722          "The runtime configuration file"
4723
4724 .cindex "run time configuration"
4725 .cindex "configuration file" "general description"
4726 .cindex "CONFIGURE_FILE"
4727 .cindex "configuration file" "errors in"
4728 .cindex "error" "in configuration file"
4729 .cindex "return code" "for bad configuration"
4730 Exim uses a single run time configuration file that is read whenever an Exim
4731 binary is executed. Note that in normal operation, this happens frequently,
4732 because Exim is designed to operate in a distributed manner, without central
4733 control.
4734
4735 If a syntax error is detected while reading the configuration file, Exim
4736 writes a message on the standard error, and exits with a non-zero return code.
4737 The message is also written to the panic log. &*Note*&: Only simple syntax
4738 errors can be detected at this time. The values of any expanded options are
4739 not checked until the expansion happens, even when the expansion does not
4740 actually alter the string.
4741
4742 The name of the configuration file is compiled into the binary for security
4743 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4744 most configurations, this specifies a single file. However, it is permitted to
4745 give a colon-separated list of file names, in which case Exim uses the first
4746 existing file in the list.
4747
4748 .cindex "EXIM_USER"
4749 .cindex "EXIM_GROUP"
4750 .cindex "CONFIGURE_OWNER"
4751 .cindex "CONFIGURE_GROUP"
4752 .cindex "configuration file" "ownership"
4753 .cindex "ownership" "configuration file"
4754 The run time configuration file must be owned by root or by the user that is
4755 specified at compile time by the CONFIGURE_OWNER option (if set). The
4756 configuration file must not be world-writeable, or group-writeable unless its
4757 group is the root group or the one specified at compile time by the
4758 CONFIGURE_GROUP option.
4759
4760 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4761 to root, anybody who is able to edit the run time configuration file has an
4762 easy way to run commands as root. If you specify a user or group in the
4763 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4764 who are members of that group will trivially be able to obtain root privileges.
4765
4766 Up to Exim version 4.72, the run time configuration file was also permitted to
4767 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4768 since it offered a simple privilege escalation for any attacker who managed to
4769 compromise the Exim user account.
4770
4771 A default configuration file, which will work correctly in simple situations,
4772 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4773 defines just one file name, the installation process copies the default
4774 configuration to a new file of that name if it did not previously exist. If
4775 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4776 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4777 configuration.
4778
4779
4780
4781 .section "Using a different configuration file" "SECID40"
4782 .cindex "configuration file" "alternate"
4783 A one-off alternate configuration can be specified by the &%-C%& command line
4784 option, which may specify a single file or a list of files. However, when
4785 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4786 unless the argument for &%-C%& is identical to the built-in value from
4787 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4788 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4789 is useful mainly for checking the syntax of configuration files before
4790 installing them. No owner or group checks are done on a configuration file
4791 specified by &%-C%&, if root privilege has been dropped.
4792
4793 Even the Exim user is not trusted to specify an arbitrary configuration file
4794 with the &%-C%& option to be used with root privileges, unless that file is
4795 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4796 testing a configuration using &%-C%& right through message reception and
4797 delivery, even if the caller is root. The reception works, but by that time,
4798 Exim is running as the Exim user, so when it re-execs to regain privilege for
4799 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4800 can test reception and delivery using two separate commands (one to put a
4801 message on the queue, using &%-odq%&, and another to do the delivery, using
4802 &%-M%&).
4803
4804 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4805 prefix string with which any file named in a &%-C%& command line option must
4806 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4807 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4808 name can be used with &%-C%&.
4809
4810 One-off changes to a configuration can be specified by the &%-D%& command line
4811 option, which defines and overrides values for macros used inside the
4812 configuration file. However, like &%-C%&, the use of this option by a
4813 non-privileged user causes Exim to discard its root privilege.
4814 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4815 completely disabled, and its use causes an immediate error exit.
4816
4817 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4818 to declare certain macro names trusted, such that root privilege will not
4819 necessarily be discarded.
4820 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4821 considered safe and, if &%-D%& only supplies macros from this list, and the
4822 values are acceptable, then Exim will not give up root privilege if the caller
4823 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4824 transition mechanism and is expected to be removed in the future.  Acceptable
4825 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4826
4827 Some sites may wish to use the same Exim binary on different machines that
4828 share a file system, but to use different configuration files on each machine.
4829 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4830 looks for a file whose name is the configuration file name followed by a dot
4831 and the machine's node name, as obtained from the &[uname()]& function. If this
4832 file does not exist, the standard name is tried. This processing occurs for
4833 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4834
4835 In some esoteric situations different versions of Exim may be run under
4836 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4837 help with this. See the comments in &_src/EDITME_& for details.
4838
4839
4840
4841 .section "Configuration file format" "SECTconffilfor"
4842 .cindex "configuration file" "format of"
4843 .cindex "format" "configuration file"
4844 Exim's configuration file is divided into a number of different parts. General
4845 option settings must always appear at the start of the file. The other parts
4846 are all optional, and may appear in any order. Each part other than the first
4847 is introduced by the word &"begin"& followed by at least one literal
4848 space, and the name of the part. The optional parts are:
4849
4850 .ilist
4851 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4852 &<<CHAPACL>>&).
4853 .next
4854 .cindex "AUTH" "configuration"
4855 &'authenticators'&: Configuration settings for the authenticator drivers. These
4856 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4857 .next
4858 &'routers'&: Configuration settings for the router drivers. Routers process
4859 addresses and determine how the message is to be delivered (see chapters
4860 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4861 .next
4862 &'transports'&: Configuration settings for the transport drivers. Transports
4863 define mechanisms for copying messages to destinations (see chapters
4864 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4865 .next
4866 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4867 If there is no retry section, or if it is empty (that is, no retry rules are
4868 defined), Exim will not retry deliveries. In this situation, temporary errors
4869 are treated the same as permanent errors. Retry rules are discussed in chapter
4870 &<<CHAPretry>>&.
4871 .next
4872 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4873 when new addresses are generated during delivery. Rewriting is discussed in
4874 chapter &<<CHAPrewrite>>&.
4875 .next
4876 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4877 want to use this feature, you must set
4878 .code
4879 LOCAL_SCAN_HAS_OPTIONS=yes
4880 .endd
4881 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4882 facility are given in chapter &<<CHAPlocalscan>>&.
4883 .endlist
4884
4885 .cindex "configuration file" "leading white space in"
4886 .cindex "configuration file" "trailing white space in"
4887 .cindex "white space" "in configuration file"
4888 Leading and trailing white space in configuration lines is always ignored.
4889
4890 Blank lines in the file, and lines starting with a # character (ignoring
4891 leading white space) are treated as comments and are ignored. &*Note*&: A
4892 # character other than at the beginning of a line is not treated specially,
4893 and does not introduce a comment.
4894
4895 Any non-comment line can be continued by ending it with a backslash. Note that
4896 the general rule for white space means that trailing white space after the
4897 backslash and leading white space at the start of continuation
4898 lines is ignored. Comment lines beginning with # (but not empty lines) may
4899 appear in the middle of a sequence of continuation lines.
4900
4901 A convenient way to create a configuration file is to start from the
4902 default, which is supplied in &_src/configure.default_&, and add, delete, or
4903 change settings as required.
4904
4905 The ACLs, retry rules, and rewriting rules have their own syntax which is
4906 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4907 respectively. The other parts of the configuration file have some syntactic
4908 items in common, and these are described below, from section &<<SECTcos>>&
4909 onwards. Before that, the inclusion, macro, and conditional facilities are
4910 described.
4911
4912
4913
4914 .section "File inclusions in the configuration file" "SECID41"
4915 .cindex "inclusions in configuration file"
4916 .cindex "configuration file" "including other files"
4917 .cindex "&`.include`& in configuration file"
4918 .cindex "&`.include_if_exists`& in configuration file"
4919 You can include other files inside Exim's run time configuration file by
4920 using this syntax:
4921 .display
4922 &`.include`& <&'file name'&>
4923 &`.include_if_exists`& <&'file name'&>
4924 .endd
4925 on a line by itself. Double quotes round the file name are optional. If you use
4926 the first form, a configuration error occurs if the file does not exist; the
4927 second form does nothing for non-existent files. In all cases, an absolute file
4928 name is required.
4929
4930 Includes may be nested to any depth, but remember that Exim reads its
4931 configuration file often, so it is a good idea to keep them to a minimum.
4932 If you change the contents of an included file, you must HUP the daemon,
4933 because an included file is read only when the configuration itself is read.
4934
4935 The processing of inclusions happens early, at a physical line level, so, like
4936 comment lines, an inclusion can be used in the middle of an option setting,
4937 for example:
4938 .code
4939 hosts_lookup = a.b.c \
4940                .include /some/file
4941 .endd
4942 Include processing happens after macro processing (see below). Its effect is to
4943 process the lines of the included file as if they occurred inline where the
4944 inclusion appears.
4945
4946
4947
4948 .section "Macros in the configuration file" "SECTmacrodefs"
4949 .cindex "macro" "description of"
4950 .cindex "configuration file" "macros"
4951 If a line in the main part of the configuration (that is, before the first
4952 &"begin"& line) begins with an upper case letter, it is taken as a macro
4953 definition, and must be of the form
4954 .display
4955 <&'name'&> = <&'rest of line'&>
4956 .endd
4957 The name must consist of letters, digits, and underscores, and need not all be
4958 in upper case, though that is recommended. The rest of the line, including any
4959 continuations, is the replacement text, and has leading and trailing white
4960 space removed. Quotes are not removed. The replacement text can never end with
4961 a backslash character, but this doesn't seem to be a serious limitation.
4962
4963 Macros may also be defined between router, transport, authenticator, or ACL
4964 definitions. They may not, however, be defined within an individual driver or
4965 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4966
4967 .section "Macro substitution" "SECID42"
4968 Once a macro is defined, all subsequent lines in the file (and any included
4969 files) are scanned for the macro name; if there are several macros, the line is
4970 scanned for each in turn, in the order in which the macros are defined. The
4971 replacement text is not re-scanned for the current macro, though it is scanned
4972 for subsequently defined macros. For this reason, a macro name may not contain
4973 the name of a previously defined macro as a substring. You could, for example,
4974 define
4975 .display
4976 &`ABCD_XYZ = `&<&'something'&>
4977 &`ABCD = `&<&'something else'&>
4978 .endd
4979 but putting the definitions in the opposite order would provoke a configuration
4980 error. Macro expansion is applied to individual physical lines from the file,
4981 before checking for line continuation or file inclusion (see above). If a line
4982 consists solely of a macro name, and the expansion of the macro is empty, the
4983 line is ignored. A macro at the start of a line may turn the line into a
4984 comment line or a &`.include`& line.
4985
4986
4987 .section "Redefining macros" "SECID43"
4988 Once defined, the value of a macro can be redefined later in the configuration
4989 (or in an included file). Redefinition is specified by using &'=='& instead of
4990 &'='&. For example:
4991 .code
4992 MAC =  initial value
4993 ...
4994 MAC == updated value
4995 .endd
4996 Redefinition does not alter the order in which the macros are applied to the
4997 subsequent lines of the configuration file. It is still the same order in which
4998 the macros were originally defined. All that changes is the macro's value.
4999 Redefinition makes it possible to accumulate values. For example:
5000 .code
5001 MAC =  initial value
5002 ...
5003 MAC == MAC and something added
5004 .endd
5005 This can be helpful in situations where the configuration file is built
5006 from a number of other files.
5007
5008 .section "Overriding macro values" "SECID44"
5009 The values set for macros in the configuration file can be overridden by the
5010 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5011 used, unless called by root or the Exim user. A definition on the command line
5012 using the &%-D%& option causes all definitions and redefinitions within the
5013 file to be ignored.
5014
5015
5016
5017 .section "Example of macro usage" "SECID45"
5018 As an example of macro usage, consider a configuration where aliases are looked
5019 up in a MySQL database. It helps to keep the file less cluttered if long
5020 strings such as SQL statements are defined separately as macros, for example:
5021 .code
5022 ALIAS_QUERY = select mailbox from user where \
5023               login='${quote_mysql:$local_part}';
5024 .endd
5025 This can then be used in a &(redirect)& router setting like this:
5026 .code
5027 data = ${lookup mysql{ALIAS_QUERY}}
5028 .endd
5029 In earlier versions of Exim macros were sometimes used for domain, host, or
5030 address lists. In Exim 4 these are handled better by named lists &-- see
5031 section &<<SECTnamedlists>>&.
5032
5033
5034 .section "Conditional skips in the configuration file" "SECID46"
5035 .cindex "configuration file" "conditional skips"
5036 .cindex "&`.ifdef`&"
5037 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5038 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5039 portions of the configuration file. The processing happens whenever the file is
5040 read (that is, when an Exim binary starts to run).
5041
5042 The implementation is very simple. Instances of the first four directives must
5043 be followed by text that includes the names of one or macros. The condition
5044 that is tested is whether or not any macro substitution has taken place in the
5045 line. Thus:
5046 .code
5047 .ifdef AAA
5048 message_size_limit = 50M
5049 .else
5050 message_size_limit = 100M
5051 .endif
5052 .endd
5053 sets a message size limit of 50M if the macro &`AAA`& is defined
5054 (or &`A`& or &`AA`&), and 100M
5055 otherwise. If there is more than one macro named on the line, the condition
5056 is true if any of them are defined. That is, it is an &"or"& condition. To
5057 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5058
5059 Although you can use a macro expansion to generate one of these directives,
5060 it is not very useful, because the condition &"there was a macro substitution
5061 in this line"& will always be true.
5062
5063 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5064 to clarify complicated nestings.
5065
5066
5067
5068 .section "Common option syntax" "SECTcos"
5069 .cindex "common option syntax"
5070 .cindex "syntax of common options"
5071 .cindex "configuration file" "common option syntax"
5072 For the main set of options, driver options, and &[local_scan()]& options,
5073 each setting is on a line by itself, and starts with a name consisting of
5074 lower-case letters and underscores. Many options require a data value, and in
5075 these cases the name must be followed by an equals sign (with optional white
5076 space) and then the value. For example:
5077 .code
5078 qualify_domain = mydomain.example.com
5079 .endd
5080 .cindex "hiding configuration option values"
5081 .cindex "configuration options" "hiding value of"
5082 .cindex "options" "hiding value of"
5083 Some option settings may contain sensitive data, for example, passwords for
5084 accessing databases. To stop non-admin users from using the &%-bP%& command
5085 line option to read these values, you can precede the option settings with the
5086 word &"hide"&. For example:
5087 .code
5088 hide mysql_servers = localhost/users/admin/secret-password
5089 .endd
5090 For non-admin users, such options are displayed like this:
5091 .code
5092 mysql_servers = <value not displayable>
5093 .endd
5094 If &"hide"& is used on a driver option, it hides the value of that option on
5095 all instances of the same driver.
5096
5097 The following sections describe the syntax used for the different data types
5098 that are found in option settings.
5099
5100
5101 .section "Boolean options" "SECID47"
5102 .cindex "format" "boolean"
5103 .cindex "boolean configuration values"
5104 .oindex "&%no_%&&'xxx'&"
5105 .oindex "&%not_%&&'xxx'&"
5106 Options whose type is given as boolean are on/off switches. There are two
5107 different ways of specifying such options: with and without a data value. If
5108 the option name is specified on its own without data, the switch is turned on;
5109 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5110 boolean options may be followed by an equals sign and one of the words
5111 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5112 the following two settings have exactly the same effect:
5113 .code
5114 queue_only
5115 queue_only = true
5116 .endd
5117 The following two lines also have the same (opposite) effect:
5118 .code
5119 no_queue_only
5120 queue_only = false
5121 .endd
5122 You can use whichever syntax you prefer.
5123
5124
5125
5126
5127 .section "Integer values" "SECID48"
5128 .cindex "integer configuration values"
5129 .cindex "format" "integer"
5130 If an option's type is given as &"integer"&, the value can be given in decimal,
5131 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5132 number is assumed. Otherwise, it is treated as an octal number unless it starts
5133 with the characters &"0x"&, in which case the remainder is interpreted as a
5134 hexadecimal number.
5135
5136 If an integer value is followed by the letter K, it is multiplied by 1024; if
5137 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5138 of integer option settings are output, values which are an exact multiple of
5139 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5140 and M. The printing style is independent of the actual input format that was
5141 used.
5142
5143
5144 .section "Octal integer values" "SECID49"
5145 .cindex "integer format"
5146 .cindex "format" "octal integer"
5147 If an option's type is given as &"octal integer"&, its value is always
5148 interpreted as an octal number, whether or not it starts with the digit zero.
5149 Such options are always output in octal.
5150
5151
5152 .section "Fixed point numbers" "SECID50"
5153 .cindex "fixed point configuration values"
5154 .cindex "format" "fixed point"
5155 If an option's type is given as &"fixed-point"&, its value must be a decimal
5156 integer, optionally followed by a decimal point and up to three further digits.
5157
5158
5159
5160 .section "Time intervals" "SECTtimeformat"
5161 .cindex "time interval" "specifying in configuration"
5162 .cindex "format" "time interval"
5163 A time interval is specified as a sequence of numbers, each followed by one of
5164 the following letters, with no intervening white space:
5165
5166 .table2 30pt
5167 .irow &%s%& seconds
5168 .irow &%m%& minutes
5169 .irow &%h%& hours
5170 .irow &%d%& days
5171 .irow &%w%& weeks
5172 .endtable
5173
5174 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5175 intervals are output in the same format. Exim does not restrict the values; it
5176 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5177
5178
5179
5180 .section "String values" "SECTstrings"
5181 .cindex "string" "format of configuration values"
5182 .cindex "format" "string"
5183 If an option's type is specified as &"string"&, the value can be specified with
5184 or without double-quotes. If it does not start with a double-quote, the value
5185 consists of the remainder of the line plus any continuation lines, starting at
5186 the first character after any leading white space, with trailing white space
5187 removed, and with no interpretation of the characters in the string. Because
5188 Exim removes comment lines (those beginning with #) at an early stage, they can
5189 appear in the middle of a multi-line string. The following two settings are
5190 therefore equivalent:
5191 .code
5192 trusted_users = uucp:mail
5193 trusted_users = uucp:\
5194                 # This comment line is ignored
5195                 mail
5196 .endd
5197 .cindex "string" "quoted"
5198 .cindex "escape characters in quoted strings"
5199 If a string does start with a double-quote, it must end with a closing
5200 double-quote, and any backslash characters other than those used for line
5201 continuation are interpreted as escape characters, as follows:
5202
5203 .table2 100pt
5204 .irow &`\\`&                     "single backslash"
5205 .irow &`\n`&                     "newline"
5206 .irow &`\r`&                     "carriage return"
5207 .irow &`\t`&                     "tab"
5208 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5209 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5210                                    character"
5211 .endtable
5212
5213 If a backslash is followed by some other character, including a double-quote
5214 character, that character replaces the pair.
5215
5216 Quoting is necessary only if you want to make use of the backslash escapes to
5217 insert special characters, or if you need to specify a value with leading or
5218 trailing spaces. These cases are rare, so quoting is almost never needed in
5219 current versions of Exim. In versions of Exim before 3.14, quoting was required
5220 in order to continue lines, so you may come across older configuration files
5221 and examples that apparently quote unnecessarily.
5222
5223
5224 .section "Expanded strings" "SECID51"
5225 .cindex "expansion" "definition of"
5226 Some strings in the configuration file are subjected to &'string expansion'&,
5227 by which means various parts of the string may be changed according to the
5228 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5229 is as just described; in particular, the handling of backslashes in quoted
5230 strings is done as part of the input process, before expansion takes place.
5231 However, backslash is also an escape character for the expander, so any
5232 backslashes that are required for that reason must be doubled if they are
5233 within a quoted configuration string.
5234
5235
5236 .section "User and group names" "SECID52"
5237 .cindex "user name" "format of"
5238 .cindex "format" "user name"
5239 .cindex "groups" "name format"
5240 .cindex "format" "group name"
5241 User and group names are specified as strings, using the syntax described
5242 above, but the strings are interpreted specially. A user or group name must
5243 either consist entirely of digits, or be a name that can be looked up using the
5244 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5245
5246
5247 .section "List construction" "SECTlistconstruct"
5248 .cindex "list" "syntax of in configuration"
5249 .cindex "format" "list item in configuration"
5250 .cindex "string" "list, definition of"
5251 The data for some configuration options is a list of items, with colon as the
5252 default separator. Many of these options are shown with type &"string list"& in
5253 the descriptions later in this document. Others are listed as &"domain list"&,
5254 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5255 are all the same; however, those other than &"string list"& are subject to
5256 particular kinds of interpretation, as described in chapter
5257 &<<CHAPdomhosaddlists>>&.
5258
5259 In all these cases, the entire list is treated as a single string as far as the
5260 input syntax is concerned. The &%trusted_users%& setting in section
5261 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5262 in a list, it must be entered as two colons. Leading and trailing white space
5263 on each item in a list is ignored. This makes it possible to include items that
5264 start with a colon, and in particular, certain forms of IPv6 address. For
5265 example, the list
5266 .code
5267 local_interfaces = 127.0.0.1 : ::::1
5268 .endd
5269 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5270
5271 &*Note*&: Although leading and trailing white space is ignored in individual
5272 list items, it is not ignored when parsing the list. The space after the first
5273 colon in the example above is necessary. If it were not there, the list would
5274 be interpreted as the two items 127.0.0.1:: and 1.
5275
5276 .section "Changing list separators" "SECTlistsepchange"
5277 .cindex "list separator" "changing"
5278 .cindex "IPv6" "addresses in lists"
5279 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5280 introduced to allow the separator character to be changed. If a list begins
5281 with a left angle bracket, followed by any punctuation character, that
5282 character is used instead of colon as the list separator. For example, the list
5283 above can be rewritten to use a semicolon separator like this:
5284 .code
5285 local_interfaces = <; 127.0.0.1 ; ::1
5286 .endd
5287 This facility applies to all lists, with the exception of the list in
5288 &%log_file_path%&. It is recommended that the use of non-colon separators be
5289 confined to circumstances where they really are needed.
5290
5291 .cindex "list separator" "newline as"
5292 .cindex "newline" "as list separator"
5293 It is also possible to use newline and other control characters (those with
5294 code values less than 32, plus DEL) as separators in lists. Such separators
5295 must be provided literally at the time the list is processed. For options that
5296 are string-expanded, you can write the separator using a normal escape
5297 sequence. This will be processed by the expander before the string is
5298 interpreted as a list. For example, if a newline-separated list of domains is
5299 generated by a lookup, you can process it directly by a line such as this:
5300 .code
5301 domains = <\n ${lookup mysql{.....}}
5302 .endd
5303 This avoids having to change the list separator in such data. You are unlikely
5304 to want to use a control character as a separator in an option that is not
5305 expanded, because the value is literal text. However, it can be done by giving
5306 the value in quotes. For example:
5307 .code
5308 local_interfaces = "<\n 127.0.0.1 \n ::1"
5309 .endd
5310 Unlike printing character separators, which can be included in list items by
5311 doubling, it is not possible to include a control character as data when it is
5312 set as the separator. Two such characters in succession are interpreted as
5313 enclosing an empty list item.
5314
5315
5316
5317 .section "Empty items in lists" "SECTempitelis"
5318 .cindex "list" "empty item in"
5319 An empty item at the end of a list is always ignored. In other words, trailing
5320 separator characters are ignored. Thus, the list in
5321 .code
5322 senders = user@domain :
5323 .endd
5324 contains only a single item. If you want to include an empty string as one item
5325 in a list, it must not be the last item. For example, this list contains three
5326 items, the second of which is empty:
5327 .code
5328 senders = user1@domain : : user2@domain
5329 .endd
5330 &*Note*&: There must be white space between the two colons, as otherwise they
5331 are interpreted as representing a single colon data character (and the list
5332 would then contain just one item). If you want to specify a list that contains
5333 just one, empty item, you can do it as in this example:
5334 .code
5335 senders = :
5336 .endd
5337 In this case, the first item is empty, and the second is discarded because it
5338 is at the end of the list.
5339
5340
5341
5342
5343 .section "Format of driver configurations" "SECTfordricon"
5344 .cindex "drivers" "configuration format"
5345 There are separate parts in the configuration for defining routers, transports,
5346 and authenticators. In each part, you are defining a number of driver
5347 instances, each with its own set of options. Each driver instance is defined by
5348 a sequence of lines like this:
5349 .display
5350 <&'instance name'&>:
5351   <&'option'&>
5352   ...
5353   <&'option'&>
5354 .endd
5355 In the following example, the instance name is &(localuser)&, and it is
5356 followed by three options settings:
5357 .code
5358 localuser:
5359   driver = accept
5360   check_local_user
5361   transport = local_delivery
5362 .endd
5363 For each driver instance, you specify which Exim code module it uses &-- by the
5364 setting of the &%driver%& option &-- and (optionally) some configuration
5365 settings. For example, in the case of transports, if you want a transport to
5366 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5367 a local file you would use the &(appendfile)& driver. Each of the drivers is
5368 described in detail in its own separate chapter later in this manual.
5369
5370 You can have several routers, transports, or authenticators that are based on
5371 the same underlying driver (each must have a different instance name).
5372
5373 The order in which routers are defined is important, because addresses are
5374 passed to individual routers one by one, in order. The order in which
5375 transports are defined does not matter at all. The order in which
5376 authenticators are defined is used only when Exim, as a client, is searching
5377 them to find one that matches an authentication mechanism offered by the
5378 server.
5379
5380 .cindex "generic options"
5381 .cindex "options" "generic &-- definition of"
5382 Within a driver instance definition, there are two kinds of option: &'generic'&
5383 and &'private'&. The generic options are those that apply to all drivers of the
5384 same type (that is, all routers, all transports or all authenticators). The
5385 &%driver%& option is a generic option that must appear in every definition.
5386 .cindex "private options"
5387 The private options are special for each driver, and none need appear, because
5388 they all have default values.
5389
5390 The options may appear in any order, except that the &%driver%& option must
5391 precede any private options, since these depend on the particular driver. For
5392 this reason, it is recommended that &%driver%& always be the first option.
5393
5394 Driver instance names, which are used for reference in log entries and
5395 elsewhere, can be any sequence of letters, digits, and underscores (starting
5396 with a letter) and must be unique among drivers of the same type. A router and
5397 a transport (for example) can each have the same name, but no two router
5398 instances can have the same name. The name of a driver instance should not be
5399 confused with the name of the underlying driver module. For example, the
5400 configuration lines:
5401 .code
5402 remote_smtp:
5403   driver = smtp
5404 .endd
5405 create an instance of the &(smtp)& transport driver whose name is
5406 &(remote_smtp)&. The same driver code can be used more than once, with
5407 different instance names and different option settings each time. A second
5408 instance of the &(smtp)& transport, with different options, might be defined
5409 thus:
5410 .code
5411 special_smtp:
5412   driver = smtp
5413   port = 1234
5414   command_timeout = 10s
5415 .endd
5416 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5417 these transport instances from routers, and these names would appear in log
5418 lines.
5419
5420 Comment lines may be present in the middle of driver specifications. The full
5421 list of option settings for any particular driver instance, including all the
5422 defaulted values, can be extracted by making use of the &%-bP%& command line
5423 option.
5424
5425
5426
5427
5428
5429
5430 . ////////////////////////////////////////////////////////////////////////////
5431 . ////////////////////////////////////////////////////////////////////////////
5432
5433 .chapter "The default configuration file" "CHAPdefconfil"
5434 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5435 .cindex "default" "configuration file &""walk through""&"
5436 The default configuration file supplied with Exim as &_src/configure.default_&
5437 is sufficient for a host with simple mail requirements. As an introduction to
5438 the way Exim is configured, this chapter &"walks through"& the default
5439 configuration, giving brief explanations of the settings. Detailed descriptions
5440 of the options are given in subsequent chapters. The default configuration file
5441 itself contains extensive comments about ways you might want to modify the
5442 initial settings. However, note that there are many options that are not
5443 mentioned at all in the default configuration.
5444
5445
5446
5447 .section "Main configuration settings" "SECTdefconfmain"
5448 The main (global) configuration option settings must always come first in the
5449 file. The first thing you'll see in the file, after some initial comments, is
5450 the line
5451 .code
5452 # primary_hostname =
5453 .endd
5454 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5455 to know the official, fully qualified name of your host, and this is where you
5456 can specify it. However, in most cases you do not need to set this option. When
5457 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5458
5459 The first three non-comment configuration lines are as follows:
5460 .code
5461 domainlist local_domains    = @
5462 domainlist relay_to_domains =
5463 hostlist   relay_from_hosts = 127.0.0.1
5464 .endd
5465 These are not, in fact, option settings. They are definitions of two named
5466 domain lists and one named host list. Exim allows you to give names to lists of
5467 domains, hosts, and email addresses, in order to make it easier to manage the
5468 configuration file (see section &<<SECTnamedlists>>&).
5469
5470 The first line defines a domain list called &'local_domains'&; this is used
5471 later in the configuration to identify domains that are to be delivered
5472 on the local host.
5473
5474 .cindex "@ in a domain list"
5475 There is just one item in this list, the string &"@"&. This is a special form
5476 of entry which means &"the name of the local host"&. Thus, if the local host is
5477 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5478 be delivered locally. Because the local host's name is referenced indirectly,
5479 the same configuration file can be used on different hosts.
5480
5481 The second line defines a domain list called &'relay_to_domains'&, but the
5482 list itself is empty. Later in the configuration we will come to the part that
5483 controls mail relaying through the local host; it allows relaying to any
5484 domains in this list. By default, therefore, no relaying on the basis of a mail
5485 domain is permitted.
5486
5487 The third line defines a host list called &'relay_from_hosts'&. This list is
5488 used later in the configuration to permit relaying from any host or IP address
5489 that matches the list. The default contains just the IP address of the IPv4
5490 loopback interface, which means that processes on the local host are able to
5491 submit mail for relaying by sending it over TCP/IP to that interface. No other
5492 hosts are permitted to submit messages for relaying.
5493
5494 Just to be sure there's no misunderstanding: at this point in the configuration
5495 we aren't actually setting up any controls. We are just defining some domains
5496 and hosts that will be used in the controls that are specified later.
5497
5498 The next two configuration lines are genuine option settings:
5499 .code
5500 acl_smtp_rcpt = acl_check_rcpt
5501 acl_smtp_data = acl_check_data
5502 .endd
5503 These options specify &'Access Control Lists'& (ACLs) that are to be used
5504 during an incoming SMTP session for every recipient of a message (every RCPT
5505 command), and after the contents of the message have been received,
5506 respectively. The names of the lists are &'acl_check_rcpt'& and
5507 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5508 section of the configuration. The RCPT ACL controls which recipients are
5509 accepted for an incoming message &-- if a configuration does not provide an ACL
5510 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5511 contents of a message to be checked.
5512
5513 Two commented-out option settings are next:
5514 .code
5515 # av_scanner = clamd:/tmp/clamd
5516 # spamd_address = 127.0.0.1 783
5517 .endd
5518 These are example settings that can be used when Exim is compiled with the
5519 content-scanning extension. The first specifies the interface to the virus
5520 scanner, and the second specifies the interface to SpamAssassin. Further
5521 details are given in chapter &<<CHAPexiscan>>&.
5522
5523 Three more commented-out option settings follow:
5524 .code
5525 # tls_advertise_hosts = *
5526 # tls_certificate = /etc/ssl/exim.crt
5527 # tls_privatekey = /etc/ssl/exim.pem
5528 .endd
5529 These are example settings that can be used when Exim is compiled with
5530 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5531 first one specifies the list of clients that are allowed to use TLS when
5532 connecting to this server; in this case the wildcard means all clients. The
5533 other options specify where Exim should find its TLS certificate and private
5534 key, which together prove the server's identity to any clients that connect.
5535 More details are given in chapter &<<CHAPTLS>>&.
5536
5537 Another two commented-out option settings follow:
5538 .code
5539 # daemon_smtp_ports = 25 : 465 : 587
5540 # tls_on_connect_ports = 465
5541 .endd
5542 .cindex "port" "465 and 587"
5543 .cindex "port" "for message submission"
5544 .cindex "message" "submission, ports for"
5545 .cindex "ssmtp protocol"
5546 .cindex "smtps protocol"
5547 .cindex "SMTP" "ssmtp protocol"
5548 .cindex "SMTP" "smtps protocol"
5549 These options provide better support for roaming users who wish to use this
5550 server for message submission. They are not much use unless you have turned on
5551 TLS (as described in the previous paragraph) and authentication (about which
5552 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5553 on end-user networks, so RFC 4409 specifies that message submission should use
5554 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5555 configured to use port 587 correctly, so these settings also enable the
5556 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5557 &<<SECTsupobssmt>>&).
5558
5559 Two more commented-out options settings follow:
5560 .code
5561 # qualify_domain =
5562 # qualify_recipient =
5563 .endd
5564 The first of these specifies a domain that Exim uses when it constructs a
5565 complete email address from a local login name. This is often needed when Exim
5566 receives a message from a local process. If you do not set &%qualify_domain%&,
5567 the value of &%primary_hostname%& is used. If you set both of these options,
5568 you can have different qualification domains for sender and recipient
5569 addresses. If you set only the first one, its value is used in both cases.
5570
5571 .cindex "domain literal" "recognizing format"
5572 The following line must be uncommented if you want Exim to recognize
5573 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5574 (an IP address within square brackets) instead of a named domain.
5575 .code
5576 # allow_domain_literals
5577 .endd
5578 The RFCs still require this form, but many people think that in the modern
5579 Internet it makes little sense to permit mail to be sent to specific hosts by
5580 quoting their IP addresses. This ancient format has been used by people who
5581 try to abuse hosts by using them for unwanted relaying. However, some
5582 people believe there are circumstances (for example, messages addressed to
5583 &'postmaster'&) where domain literals are still useful.
5584
5585 The next configuration line is a kind of trigger guard:
5586 .code
5587 never_users = root
5588 .endd
5589 It specifies that no delivery must ever be run as the root user. The normal
5590 convention is to set up &'root'& as an alias for the system administrator. This
5591 setting is a guard against slips in the configuration.
5592 The list of users specified by &%never_users%& is not, however, the complete
5593 list; the build-time configuration in &_Local/Makefile_& has an option called
5594 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5595 contents of &%never_users%& are added to this list. By default
5596 FIXED_NEVER_USERS also specifies root.
5597
5598 When a remote host connects to Exim in order to send mail, the only information
5599 Exim has about the host's identity is its IP address. The next configuration
5600 line,
5601 .code
5602 host_lookup = *
5603 .endd
5604 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5605 in order to get a host name. This improves the quality of the logging
5606 information, but if you feel it is too expensive, you can remove it entirely,
5607 or restrict the lookup to hosts on &"nearby"& networks.
5608 Note that it is not always possible to find a host name from an IP address,
5609 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5610 unreachable.
5611
5612 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5613 1413 (hence their names):
5614 .code
5615 rfc1413_hosts = *
5616 rfc1413_query_timeout = 0s
5617 .endd
5618 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5619 Few hosts offer RFC1413 service these days; calls have to be
5620 terminated by a timeout and this needlessly delays the startup
5621 of an incoming SMTP connection.
5622 If you have hosts for which you trust RFC1413 and need this
5623 information, you can change this.
5624
5625 This line enables an efficiency SMTP option.  It is negotiated by clients
5626 and not expected to cause problems but can be disabled if needed.
5627 .code
5628 prdr_enable = true
5629 .endd
5630
5631 When Exim receives messages over SMTP connections, it expects all addresses to
5632 be fully qualified with a domain, as required by the SMTP definition. However,
5633 if you are running a server to which simple clients submit messages, you may
5634 find that they send unqualified addresses. The two commented-out options:
5635 .code
5636 # sender_unqualified_hosts =
5637 # recipient_unqualified_hosts =
5638 .endd
5639 show how you can specify hosts that are permitted to send unqualified sender
5640 and recipient addresses, respectively.
5641
5642 The &%log_selector%& option is used to increase the detail of logging
5643 over the default:
5644 .code
5645 log_selector = +smtp_protocol_error +smtp_syntax_error \
5646                +tls_certificate_verified
5647 .endd
5648
5649 The &%percent_hack_domains%& option is also commented out:
5650 .code
5651 # percent_hack_domains =
5652 .endd
5653 It provides a list of domains for which the &"percent hack"& is to operate.
5654 This is an almost obsolete form of explicit email routing. If you do not know
5655 anything about it, you can safely ignore this topic.
5656
5657 The next two settings in the main part of the default configuration are
5658 concerned with messages that have been &"frozen"& on Exim's queue. When a
5659 message is frozen, Exim no longer continues to try to deliver it. Freezing
5660 occurs when a bounce message encounters a permanent failure because the sender
5661 address of the original message that caused the bounce is invalid, so the
5662 bounce cannot be delivered. This is probably the most common case, but there
5663 are also other conditions that cause freezing, and frozen messages are not
5664 always bounce messages.
5665 .code
5666 ignore_bounce_errors_after = 2d
5667 timeout_frozen_after = 7d
5668 .endd
5669 The first of these options specifies that failing bounce messages are to be
5670 discarded after 2 days on the queue. The second specifies that any frozen
5671 message (whether a bounce message or not) is to be timed out (and discarded)
5672 after a week. In this configuration, the first setting ensures that no failing
5673 bounce message ever lasts a week.
5674
5675 Exim queues it's messages in a spool directory. If you expect to have
5676 large queues, you may consider using this option. It splits the spool
5677 directory into subdirectories to avoid file system degradation from
5678 many files in a single directory, resulting in better performance.
5679 Manual manipulation of queued messages becomes more complex (though fortunately
5680 not often needed).
5681 .code
5682 # split_spool_directory = true
5683 .endd
5684
5685 In an ideal world everybody follows the standards. For non-ASCII
5686 messages RFC 2047 is a standard, allowing a maximum line length of 76
5687 characters. Exim adheres that standard and won't process messages which
5688 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5689 In particular, the Exim maintainers have had multiple reports of
5690 problems from Russian administrators of issues until they disable this
5691 check, because of some popular, yet buggy, mail composition software.
5692 .code
5693 # check_rfc2047_length = false
5694 .endd
5695
5696 If you need to be strictly RFC compliant you may wish to disable the
5697 8BITMIME advertisement. Use this, if you exchange mails with systems
5698 that are not 8-bit clean.
5699 .code
5700 # accept_8bitmime = false
5701 .endd
5702
5703 Libraries you use may depend on specific environment settings.  This
5704 imposes a security risk (e.g. PATH). There are two lists:
5705 &%keep_environment%& for the variables to import as they are, and
5706 &%add_environment%& for variables we want to set to a fixed value.
5707 Note that TZ is handled separately, by the $%timezone%$ runtime
5708 option and by the TIMEZONE_DEFAULT buildtime option.
5709 .code
5710 # keep_environment = ^LDAP
5711 # add_environment = PATH=/usr/bin::/bin
5712 .endd
5713
5714
5715 .section "ACL configuration" "SECID54"
5716 .cindex "default" "ACLs"
5717 .cindex "&ACL;" "default configuration"
5718 In the default configuration, the ACL section follows the main configuration.
5719 It starts with the line
5720 .code
5721 begin acl
5722 .endd
5723 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5724 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5725 and &%acl_smtp_data%& above.
5726
5727 .cindex "RCPT" "ACL for"
5728 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5729 RCPT command specifies one of the message's recipients. The ACL statements
5730 are considered in order, until the recipient address is either accepted or
5731 rejected. The RCPT command is then accepted or rejected, according to the
5732 result of the ACL processing.
5733 .code
5734 acl_check_rcpt:
5735 .endd
5736 This line, consisting of a name terminated by a colon, marks the start of the
5737 ACL, and names it.
5738 .code
5739 accept  hosts = :
5740 .endd
5741 This ACL statement accepts the recipient if the sending host matches the list.
5742 But what does that strange list mean? It doesn't actually contain any host
5743 names or IP addresses. The presence of the colon puts an empty item in the
5744 list; Exim matches this only if the incoming message did not come from a remote
5745 host, because in that case, the remote hostname is empty. The colon is
5746 important. Without it, the list itself is empty, and can never match anything.
5747
5748 What this statement is doing is to accept unconditionally all recipients in
5749 messages that are submitted by SMTP from local processes using the standard
5750 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5751 manner.
5752 .code
5753 deny    message       = Restricted characters in address
5754         domains       = +local_domains
5755         local_parts   = ^[.] : ^.*[@%!/|]
5756
5757 deny    message       = Restricted characters in address
5758         domains       = !+local_domains
5759         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5760 .endd
5761 These statements are concerned with local parts that contain any of the
5762 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5763 Although these characters are entirely legal in local parts (in the case of
5764 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5765 in Internet mail addresses.
5766
5767 The first three have in the past been associated with explicitly routed
5768 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5769 option). Addresses containing these characters are regularly tried by spammers
5770 in an attempt to bypass relaying restrictions, and also by open relay testing
5771 programs. Unless you really need them it is safest to reject these characters
5772 at this early stage. This configuration is heavy-handed in rejecting these
5773 characters for all messages it accepts from remote hosts. This is a deliberate
5774 policy of being as safe as possible.
5775
5776 The first rule above is stricter, and is applied to messages that are addressed
5777 to one of the local domains handled by this host. This is implemented by the
5778 first condition, which restricts it to domains that are listed in the
5779 &'local_domains'& domain list. The &"+"& character is used to indicate a
5780 reference to a named list. In this configuration, there is just one domain in
5781 &'local_domains'&, but in general there may be many.
5782
5783 The second condition on the first statement uses two regular expressions to
5784 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5785 or &"|"&. If you have local accounts that include these characters, you will
5786 have to modify this rule.
5787
5788 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5789 allows them because they have been encountered in practice. (Consider the
5790 common convention of local parts constructed as
5791 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5792 the author of Exim, who has no second initial.) However, a local part starting
5793 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5794 file name (for example, for a mailing list). This is also true for local parts
5795 that contain slashes. A pipe symbol can also be troublesome if the local part
5796 is incorporated unthinkingly into a shell command line.
5797
5798 The second rule above applies to all other domains, and is less strict. This
5799 allows your own users to send outgoing messages to sites that use slashes
5800 and vertical bars in their local parts. It blocks local parts that begin
5801 with a dot, slash, or vertical bar, but allows these characters within the
5802 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5803 and &"!"& is blocked, as before. The motivation here is to prevent your users
5804 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5805 .code
5806 accept  local_parts   = postmaster
5807         domains       = +local_domains
5808 .endd
5809 This statement, which has two conditions, accepts an incoming address if the
5810 local part is &'postmaster'& and the domain is one of those listed in the
5811 &'local_domains'& domain list. The &"+"& character is used to indicate a
5812 reference to a named list. In this configuration, there is just one domain in
5813 &'local_domains'&, but in general there may be many.
5814
5815 The presence of this statement means that mail to postmaster is never blocked
5816 by any of the subsequent tests. This can be helpful while sorting out problems
5817 in cases where the subsequent tests are incorrectly denying access.
5818 .code
5819 require verify        = sender
5820 .endd
5821 This statement requires the sender address to be verified before any subsequent
5822 ACL statement can be used. If verification fails, the incoming recipient
5823 address is refused. Verification consists of trying to route the address, to
5824 see if a bounce message could be delivered to it. In the case of remote
5825 addresses, basic verification checks only the domain, but &'callouts'& can be
5826 used for more verification if required. Section &<<SECTaddressverification>>&
5827 discusses the details of address verification.
5828 .code
5829 accept  hosts         = +relay_from_hosts
5830         control       = submission
5831 .endd
5832 This statement accepts the address if the message is coming from one of the
5833 hosts that are defined as being allowed to relay through this host. Recipient
5834 verification is omitted here, because in many cases the clients are dumb MUAs
5835 that do not cope well with SMTP error responses. For the same reason, the
5836 second line specifies &"submission mode"& for messages that are accepted. This
5837 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5838 messages that are deficient in some way, for example, because they lack a
5839 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5840 probably add recipient verification here, and disable submission mode.
5841 .code
5842 accept  authenticated = *
5843         control       = submission
5844 .endd
5845 This statement accepts the address if the client host has authenticated itself.
5846 Submission mode is again specified, on the grounds that such messages are most
5847 likely to come from MUAs. The default configuration does not define any
5848 authenticators, though it does include some nearly complete commented-out
5849 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5850 fact authenticate until you complete the authenticator definitions.
5851 .code
5852 require message = relay not permitted
5853         domains = +local_domains : +relay_to_domains
5854 .endd
5855 This statement rejects the address if its domain is neither a local domain nor
5856 one of the domains for which this host is a relay.
5857 .code
5858 require verify = recipient
5859 .endd
5860 This statement requires the recipient address to be verified; if verification
5861 fails, the address is rejected.
5862 .code
5863 # deny    message     = rejected because $sender_host_address \
5864 #                       is in a black list at $dnslist_domain\n\
5865 #                       $dnslist_text
5866 #         dnslists    = black.list.example
5867 #
5868 # warn    dnslists    = black.list.example
5869 #         add_header  = X-Warning: $sender_host_address is in \
5870 #                       a black list at $dnslist_domain
5871 #         log_message = found in $dnslist_domain
5872 .endd
5873 These commented-out lines are examples of how you could configure Exim to check
5874 sending hosts against a DNS black list. The first statement rejects messages
5875 from blacklisted hosts, whereas the second just inserts a warning header
5876 line.
5877 .code
5878 # require verify = csa
5879 .endd
5880 This commented-out line is an example of how you could turn on client SMTP
5881 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5882 records.
5883 .code
5884 accept
5885 .endd
5886 The final statement in the first ACL unconditionally accepts any recipient
5887 address that has successfully passed all the previous tests.
5888 .code
5889 acl_check_data:
5890 .endd
5891 This line marks the start of the second ACL, and names it. Most of the contents
5892 of this ACL are commented out:
5893 .code
5894 # deny    malware   = *
5895 #         message   = This message contains a virus \
5896 #                     ($malware_name).
5897 .endd
5898 These lines are examples of how to arrange for messages to be scanned for
5899 viruses when Exim has been compiled with the content-scanning extension, and a
5900 suitable virus scanner is installed. If the message is found to contain a
5901 virus, it is rejected with the given custom error message.
5902 .code
5903 # warn    spam      = nobody
5904 #         message   = X-Spam_score: $spam_score\n\
5905 #                     X-Spam_score_int: $spam_score_int\n\
5906 #                     X-Spam_bar: $spam_bar\n\
5907 #                     X-Spam_report: $spam_report
5908 .endd
5909 These lines are an example of how to arrange for messages to be scanned by
5910 SpamAssassin when Exim has been compiled with the content-scanning extension,
5911 and SpamAssassin has been installed. The SpamAssassin check is run with
5912 &`nobody`& as its user parameter, and the results are added to the message as a
5913 series of extra header line. In this case, the message is not rejected,
5914 whatever the spam score.
5915 .code
5916 accept
5917 .endd
5918 This final line in the DATA ACL accepts the message unconditionally.
5919
5920
5921 .section "Router configuration" "SECID55"
5922 .cindex "default" "routers"
5923 .cindex "routers" "default"
5924 The router configuration comes next in the default configuration, introduced
5925 by the line
5926 .code
5927 begin routers
5928 .endd
5929 Routers are the modules in Exim that make decisions about where to send
5930 messages. An address is passed to each router in turn, until it is either
5931 accepted, or failed. This means that the order in which you define the routers
5932 matters. Each router is fully described in its own chapter later in this
5933 manual. Here we give only brief overviews.
5934 .code
5935 # domain_literal:
5936 #   driver = ipliteral
5937 #   domains = !+local_domains
5938 #   transport = remote_smtp
5939 .endd
5940 .cindex "domain literal" "default router"
5941 This router is commented out because the majority of sites do not want to
5942 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5943 you uncomment this router, you also need to uncomment the setting of
5944 &%allow_domain_literals%& in the main part of the configuration.
5945 .code
5946 dnslookup:
5947   driver = dnslookup
5948   domains = ! +local_domains
5949   transport = remote_smtp
5950   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5951   no_more
5952 .endd
5953 The first uncommented router handles addresses that do not involve any local
5954 domains. This is specified by the line
5955 .code
5956 domains = ! +local_domains
5957 .endd
5958 The &%domains%& option lists the domains to which this router applies, but the
5959 exclamation mark is a negation sign, so the router is used only for domains
5960 that are not in the domain list called &'local_domains'& (which was defined at
5961 the start of the configuration). The plus sign before &'local_domains'&
5962 indicates that it is referring to a named list. Addresses in other domains are
5963 passed on to the following routers.
5964
5965 The name of the router driver is &(dnslookup)&,
5966 and is specified by the &%driver%& option. Do not be confused by the fact that
5967 the name of this router instance is the same as the name of the driver. The
5968 instance name is arbitrary, but the name set in the &%driver%& option must be
5969 one of the driver modules that is in the Exim binary.
5970
5971 The &(dnslookup)& router routes addresses by looking up their domains in the
5972 DNS in order to obtain a list of hosts to which the address is routed. If the
5973 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5974 specified by the &%transport%& option. If the router does not find the domain
5975 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5976 the address fails and is bounced.
5977
5978 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5979 be entirely ignored. This option is present because a number of cases have been
5980 encountered where MX records in the DNS point to host names
5981 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5982 Completely ignoring these IP addresses causes Exim to fail to route the
5983 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5984 continue to try to deliver the message periodically until the address timed
5985 out.
5986 .code
5987 system_aliases:
5988   driver = redirect
5989   allow_fail
5990   allow_defer
5991   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5992 # user = exim
5993   file_transport = address_file
5994   pipe_transport = address_pipe
5995 .endd
5996 Control reaches this and subsequent routers only for addresses in the local
5997 domains. This router checks to see whether the local part is defined as an
5998 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5999 data that it looks up from that file. If no data is found for the local part,
6000 the value of the &%data%& option is empty, causing the address to be passed to
6001 the next router.
6002
6003 &_/etc/aliases_& is a conventional name for the system aliases file that is
6004 often used. That is why it is referenced by from the default configuration
6005 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6006 &_Local/Makefile_& before building Exim.
6007 .code
6008 userforward:
6009   driver = redirect
6010   check_local_user
6011 # local_part_suffix = +* : -*
6012 # local_part_suffix_optional
6013   file = $home/.forward
6014 # allow_filter
6015   no_verify
6016   no_expn
6017   check_ancestor
6018   file_transport = address_file
6019   pipe_transport = address_pipe
6020   reply_transport = address_reply
6021 .endd
6022 This is the most complicated router in the default configuration. It is another
6023 redirection router, but this time it is looking for forwarding data set up by
6024 individual users. The &%check_local_user%& setting specifies a check that the
6025 local part of the address is the login name of a local user. If it is not, the
6026 router is skipped. The two commented options that follow &%check_local_user%&,
6027 namely:
6028 .code
6029 # local_part_suffix = +* : -*
6030 # local_part_suffix_optional
6031 .endd
6032 .vindex "&$local_part_suffix$&"
6033 show how you can specify the recognition of local part suffixes. If the first
6034 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6035 by any sequence of characters, is removed from the local part and placed in the
6036 variable &$local_part_suffix$&. The second suffix option specifies that the
6037 presence of a suffix in the local part is optional. When a suffix is present,
6038 the check for a local login uses the local part with the suffix removed.
6039
6040 When a local user account is found, the file called &_.forward_& in the user's
6041 home directory is consulted. If it does not exist, or is empty, the router
6042 declines. Otherwise, the contents of &_.forward_& are interpreted as
6043 redirection data (see chapter &<<CHAPredirect>>& for more details).
6044
6045 .cindex "Sieve filter" "enabling in default router"
6046 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6047 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6048 is commented out by default), the contents of the file are interpreted as a set
6049 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6050 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6051 separate document entitled &'Exim's interfaces to mail filtering'&.
6052
6053 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6054 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6055 There are two reasons for doing this:
6056
6057 .olist
6058 Whether or not a local user has a &_.forward_& file is not really relevant when
6059 checking an address for validity; it makes sense not to waste resources doing
6060 unnecessary work.
6061 .next
6062 More importantly, when Exim is verifying addresses or handling an EXPN
6063 command during an SMTP session, it is running as the Exim user, not as root.
6064 The group is the Exim group, and no additional groups are set up.
6065 It may therefore not be possible for Exim to read users' &_.forward_& files at
6066 this time.
6067 .endlist
6068
6069 The setting of &%check_ancestor%& prevents the router from generating a new
6070 address that is the same as any previous address that was redirected. (This
6071 works round a problem concerning a bad interaction between aliasing and
6072 forwarding &-- see section &<<SECTredlocmai>>&).
6073
6074 The final three option settings specify the transports that are to be used when
6075 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6076 auto-reply, respectively. For example, if a &_.forward_& file contains
6077 .code
6078 a.nother@elsewhere.example, /home/spqr/archive
6079 .endd
6080 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6081 transport.
6082 .code
6083 localuser:
6084   driver = accept
6085   check_local_user
6086 # local_part_suffix = +* : -*
6087 # local_part_suffix_optional
6088   transport = local_delivery
6089 .endd
6090 The final router sets up delivery into local mailboxes, provided that the local
6091 part is the name of a local login, by accepting the address and assigning it to
6092 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6093 routers, so the address is bounced. The commented suffix settings fulfil the
6094 same purpose as they do for the &(userforward)& router.
6095
6096
6097 .section "Transport configuration" "SECID56"
6098 .cindex "default" "transports"
6099 .cindex "transports" "default"
6100 Transports define mechanisms for actually delivering messages. They operate
6101 only when referenced from routers, so the order in which they are defined does
6102 not matter. The transports section of the configuration starts with
6103 .code
6104 begin transports
6105 .endd
6106 One remote transport and four local transports are defined.
6107 .code
6108 remote_smtp:
6109   driver = smtp
6110   hosts_try_prdr = *
6111 .endd
6112 This transport is used for delivering messages over SMTP connections.
6113 The list of remote hosts comes from the router.
6114 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6115 It is negotiated between client and server
6116 and not expected to cause problems but can be disabled if needed.
6117 All other options are defaulted.
6118 .code
6119 local_delivery:
6120   driver = appendfile
6121   file = /var/mail/$local_part
6122   delivery_date_add
6123   envelope_to_add
6124   return_path_add
6125 # group = mail
6126 # mode = 0660
6127 .endd
6128 This &(appendfile)& transport is used for local delivery to user mailboxes in
6129 traditional BSD mailbox format. By default it runs under the uid and gid of the
6130 local user, which requires the sticky bit to be set on the &_/var/mail_&
6131 directory. Some systems use the alternative approach of running mail deliveries
6132 under a particular group instead of using the sticky bit. The commented options
6133 show how this can be done.
6134
6135 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6136 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6137 similarly-named options above.
6138 .code
6139 address_pipe:
6140   driver = pipe
6141   return_output
6142 .endd
6143 This transport is used for handling deliveries to pipes that are generated by
6144 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6145 option specifies that any output on stdout or stderr generated by the pipe is to
6146 be returned to the sender.
6147 .code
6148 address_file:
6149   driver = appendfile
6150   delivery_date_add
6151   envelope_to_add
6152   return_path_add
6153 .endd
6154 This transport is used for handling deliveries to files that are generated by
6155 redirection. The name of the file is not specified in this instance of
6156 &(appendfile)&, because it comes from the &(redirect)& router.
6157 .code
6158 address_reply:
6159   driver = autoreply
6160 .endd
6161 This transport is used for handling automatic replies generated by users'
6162 filter files.
6163
6164
6165
6166 .section "Default retry rule" "SECID57"
6167 .cindex "retry" "default rule"
6168 .cindex "default" "retry rule"
6169 The retry section of the configuration file contains rules which affect the way
6170 Exim retries deliveries that cannot be completed at the first attempt. It is
6171 introduced by the line
6172 .code
6173 begin retry
6174 .endd
6175 In the default configuration, there is just one rule, which applies to all
6176 errors:
6177 .code
6178 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6179 .endd
6180 This causes any temporarily failing address to be retried every 15 minutes for
6181 2 hours, then at intervals starting at one hour and increasing by a factor of
6182 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6183 is not delivered after 4 days of temporary failure, it is bounced. The time is
6184 measured from first failure, not from the time the message was received.
6185
6186 If the retry section is removed from the configuration, or is empty (that is,
6187 if no retry rules are defined), Exim will not retry deliveries. This turns
6188 temporary errors into permanent errors.
6189
6190
6191 .section "Rewriting configuration" "SECID58"
6192 The rewriting section of the configuration, introduced by
6193 .code
6194 begin rewrite
6195 .endd
6196 contains rules for rewriting addresses in messages as they arrive. There are no
6197 rewriting rules in the default configuration file.
6198
6199
6200
6201 .section "Authenticators configuration" "SECTdefconfauth"
6202 .cindex "AUTH" "configuration"
6203 The authenticators section of the configuration, introduced by
6204 .code
6205 begin authenticators
6206 .endd
6207 defines mechanisms for the use of the SMTP AUTH command. The default
6208 configuration file contains two commented-out example authenticators
6209 which support plaintext username/password authentication using the
6210 standard PLAIN mechanism and the traditional but non-standard LOGIN
6211 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6212 to support most MUA software.
6213
6214 The example PLAIN authenticator looks like this:
6215 .code
6216 #PLAIN:
6217 #  driver                  = plaintext
6218 #  server_set_id           = $auth2
6219 #  server_prompts          = :
6220 #  server_condition        = Authentication is not yet configured
6221 #  server_advertise_condition = ${if def:tls_in_cipher }
6222 .endd
6223 And the example LOGIN authenticator looks like this:
6224 .code
6225 #LOGIN:
6226 #  driver                  = plaintext
6227 #  server_set_id           = $auth1
6228 #  server_prompts          = <| Username: | Password:
6229 #  server_condition        = Authentication is not yet configured
6230 #  server_advertise_condition = ${if def:tls_in_cipher }
6231 .endd
6232
6233 The &%server_set_id%& option makes Exim remember the authenticated username
6234 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6235 &%server_prompts%& option configures the &(plaintext)& authenticator so
6236 that it implements the details of the specific authentication mechanism,
6237 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6238 when Exim offers authentication to clients; in the examples, this is only
6239 when TLS or SSL has been started, so to enable the authenticators you also
6240 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6241
6242 The &%server_condition%& setting defines how to verify that the username and
6243 password are correct. In the examples it just produces an error message.
6244 To make the authenticators work, you can use a string expansion
6245 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6246
6247 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6248 usercode and password are in different positions.
6249 Chapter &<<CHAPplaintext>>& covers both.
6250
6251 .ecindex IIDconfiwal
6252
6253
6254
6255 . ////////////////////////////////////////////////////////////////////////////
6256 . ////////////////////////////////////////////////////////////////////////////
6257
6258 .chapter "Regular expressions" "CHAPregexp"
6259
6260 .cindex "regular expressions" "library"
6261 .cindex "PCRE"
6262 Exim supports the use of regular expressions in many of its options. It
6263 uses the PCRE regular expression library; this provides regular expression
6264 matching that is compatible with Perl 5. The syntax and semantics of
6265 regular expressions is discussed in many Perl reference books, and also in
6266 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6267 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6268
6269 The documentation for the syntax and semantics of the regular expressions that
6270 are supported by PCRE is included in the PCRE distribution, and no further
6271 description is included here. The PCRE functions are called from Exim using
6272 the default option settings (that is, with no PCRE options set), except that
6273 the PCRE_CASELESS option is set when the matching is required to be
6274 case-insensitive.
6275
6276 In most cases, when a regular expression is required in an Exim configuration,
6277 it has to start with a circumflex, in order to distinguish it from plain text
6278 or an &"ends with"& wildcard. In this example of a configuration setting, the
6279 second item in the colon-separated list is a regular expression.
6280 .code
6281 domains = a.b.c : ^\\d{3} : *.y.z : ...
6282 .endd
6283 The doubling of the backslash is required because of string expansion that
6284 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6285 of this issue, and a way of avoiding the need for doubling backslashes. The
6286 regular expression that is eventually used in this example contains just one
6287 backslash. The circumflex is included in the regular expression, and has the
6288 normal effect of &"anchoring"& it to the start of the string that is being
6289 matched.
6290
6291 There are, however, two cases where a circumflex is not required for the
6292 recognition of a regular expression: these are the &%match%& condition in a
6293 string expansion, and the &%matches%& condition in an Exim filter file. In
6294 these cases, the relevant string is always treated as a regular expression; if
6295 it does not start with a circumflex, the expression is not anchored, and can
6296 match anywhere in the subject string.
6297
6298 In all cases, if you want a regular expression to match at the end of a string,
6299 you must code the $ metacharacter to indicate this. For example:
6300 .code
6301 domains = ^\\d{3}\\.example
6302 .endd
6303 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6304 You need to use:
6305 .code
6306 domains = ^\\d{3}\\.example\$
6307 .endd
6308 if you want &'example'& to be the top-level domain. The backslash before the
6309 $ is needed because string expansion also interprets dollar characters.
6310
6311
6312
6313 . ////////////////////////////////////////////////////////////////////////////
6314 . ////////////////////////////////////////////////////////////////////////////
6315
6316 .chapter "File and database lookups" "CHAPfdlookup"
6317 .scindex IIDfidalo1 "file" "lookups"
6318 .scindex IIDfidalo2 "database" "lookups"
6319 .cindex "lookup" "description of"
6320 Exim can be configured to look up data in files or databases as it processes
6321 messages. Two different kinds of syntax are used:
6322
6323 .olist
6324 A string that is to be expanded may contain explicit lookup requests. These
6325 cause parts of the string to be replaced by data that is obtained from the
6326 lookup. Lookups of this type are conditional expansion items. Different results
6327 can be defined for the cases of lookup success and failure. See chapter
6328 &<<CHAPexpand>>&, where string expansions are described in detail.
6329 The key for the lookup is specified as part of the string expansion.
6330 .next
6331 Lists of domains, hosts, and email addresses can contain lookup requests as a
6332 way of avoiding excessively long linear lists. In this case, the data that is
6333 returned by the lookup is often (but not always) discarded; whether the lookup
6334 succeeds or fails is what really counts. These kinds of list are described in
6335 chapter &<<CHAPdomhosaddlists>>&.
6336 The key for the lookup is given by the context in which the list is expanded.
6337 .endlist
6338
6339 String expansions, lists, and lookups interact with each other in such a way
6340 that there is no order in which to describe any one of them that does not
6341 involve references to the others. Each of these three chapters makes more sense
6342 if you have read the other two first. If you are reading this for the first
6343 time, be aware that some of it will make a lot more sense after you have read
6344 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6345
6346 .section "Examples of different lookup syntax" "SECID60"
6347 It is easy to confuse the two different kinds of lookup, especially as the
6348 lists that may contain the second kind are always expanded before being
6349 processed as lists. Therefore, they may also contain lookups of the first kind.
6350 Be careful to distinguish between the following two examples:
6351 .code
6352 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6353 domains = lsearch;/some/file
6354 .endd
6355 The first uses a string expansion, the result of which must be a domain list.
6356 No strings have been specified for a successful or a failing lookup; the
6357 defaults in this case are the looked-up data and an empty string, respectively.
6358 The expansion takes place before the string is processed as a list, and the
6359 file that is searched could contain lines like this:
6360 .code
6361 192.168.3.4: domain1:domain2:...
6362 192.168.1.9: domain3:domain4:...
6363 .endd
6364 When the lookup succeeds, the result of the expansion is a list of domains (and
6365 possibly other types of item that are allowed in domain lists).
6366
6367 In the second example, the lookup is a single item in a domain list. It causes
6368 Exim to use a lookup to see if the domain that is being processed can be found
6369 in the file. The file could contains lines like this:
6370 .code
6371 domain1:
6372 domain2:
6373 .endd
6374 Any data that follows the keys is not relevant when checking that the domain
6375 matches the list item.
6376
6377 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6378 Consider a file containing lines like this:
6379 .code
6380 192.168.5.6: lsearch;/another/file
6381 .endd
6382 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6383 first &%domains%& setting above generates the second setting, which therefore
6384 causes a second lookup to occur.
6385
6386 The rest of this chapter describes the different lookup types that are
6387 available. Any of them can be used in any part of the configuration where a
6388 lookup is permitted.
6389
6390
6391 .section "Lookup types" "SECID61"
6392 .cindex "lookup" "types of"
6393 .cindex "single-key lookup" "definition of"
6394 Two different types of data lookup are implemented:
6395
6396 .ilist
6397 The &'single-key'& type requires the specification of a file in which to look,
6398 and a single key to search for. The key must be a non-empty string for the
6399 lookup to succeed. The lookup type determines how the file is searched.
6400 .next
6401 .cindex "query-style lookup" "definition of"
6402 The &'query-style'& type accepts a generalized database query. No particular
6403 key value is assumed by Exim for query-style lookups. You can use whichever
6404 Exim variables you need to construct the database query.
6405 .endlist
6406
6407 The code for each lookup type is in a separate source file that is included in
6408 the binary of Exim only if the corresponding compile-time option is set. The
6409 default settings in &_src/EDITME_& are:
6410 .code
6411 LOOKUP_DBM=yes
6412 LOOKUP_LSEARCH=yes
6413 .endd
6414 which means that only linear searching and DBM lookups are included by default.
6415 For some types of lookup (e.g. SQL databases), you need to install appropriate
6416 libraries and header files before building Exim.
6417
6418
6419
6420
6421 .section "Single-key lookup types" "SECTsinglekeylookups"
6422 .cindex "lookup" "single-key types"
6423 .cindex "single-key lookup" "list of types"
6424 The following single-key lookup types are implemented:
6425
6426 .ilist
6427 .cindex "cdb" "description of"
6428 .cindex "lookup" "cdb"
6429 .cindex "binary zero" "in lookup key"
6430 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6431 string without a terminating binary zero. The cdb format is designed for
6432 indexed files that are read frequently and never updated, except by total
6433 re-creation. As such, it is particularly suitable for large files containing
6434 aliases or other indexed data referenced by an MTA. Information about cdb can
6435 be found in several places:
6436 .display
6437 &url(http://www.pobox.com/~djb/cdb.html)
6438 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6439 &url(http://packages.debian.org/stable/utils/freecdb.html)
6440 .endd
6441 A cdb distribution is not needed in order to build Exim with cdb support,
6442 because the code for reading cdb files is included directly in Exim itself.
6443 However, no means of building or testing cdb files is provided with Exim, so
6444 you need to obtain a cdb distribution in order to do this.
6445 .next
6446 .cindex "DBM" "lookup type"
6447 .cindex "lookup" "dbm"
6448 .cindex "binary zero" "in lookup key"
6449 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6450 DBM file by looking up the record with the given key. A terminating binary
6451 zero is included in the key that is passed to the DBM library. See section
6452 &<<SECTdb>>& for a discussion of DBM libraries.
6453
6454 .cindex "Berkeley DB library" "file format"
6455 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6456 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6457 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6458 the DB_UNKNOWN option. This enables it to handle any of the types of database
6459 that the library supports, and can be useful for accessing DBM files created by
6460 other applications. (For earlier DB versions, DB_HASH is always used.)
6461 .next
6462 .cindex "lookup" "dbmjz"
6463 .cindex "lookup" "dbm &-- embedded NULs"
6464 .cindex "sasldb2"
6465 .cindex "dbmjz lookup type"
6466 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6467 interpreted as an Exim list; the elements of the list are joined together with
6468 ASCII NUL characters to form the lookup key.  An example usage would be to
6469 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6470 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6471 &(cram_md5)& authenticator.
6472 .next
6473 .cindex "lookup" "dbmnz"
6474 .cindex "lookup" "dbm &-- terminating zero"
6475 .cindex "binary zero" "in lookup key"
6476 .cindex "Courier"
6477 .cindex "&_/etc/userdbshadow.dat_&"
6478 .cindex "dbmnz lookup type"
6479 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6480 is not included in the key that is passed to the DBM library. You may need this
6481 if you want to look up data in files that are created by or shared with some
6482 other application that does not use terminating zeros. For example, you need to
6483 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6484 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6485 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6486 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6487 .next
6488 .cindex "lookup" "dsearch"
6489 .cindex "dsearch lookup type"
6490 &(dsearch)&: The given file must be a directory; this is searched for an entry
6491 whose name is the key by calling the &[lstat()]& function. The key may not
6492 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6493 the lookup is the name of the entry, which may be a file, directory,
6494 symbolic link, or any other kind of directory entry. An example of how this
6495 lookup can be used to support virtual domains is given in section
6496 &<<SECTvirtualdomains>>&.
6497 .next
6498 .cindex "lookup" "iplsearch"
6499 .cindex "iplsearch lookup type"
6500 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6501 terminated by a colon or white space or the end of the line. The keys in the
6502 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6503 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6504 being interpreted as a key terminator. For example:
6505 .code
6506 1.2.3.4:           data for 1.2.3.4
6507 192.168.0.0/16:    data for 192.168.0.0/16
6508 "abcd::cdab":      data for abcd::cdab
6509 "abcd:abcd::/32"   data for abcd:abcd::/32
6510 .endd
6511 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6512 file is searched linearly, using the CIDR masks where present, until a matching
6513 key is found. The first key that matches is used; there is no attempt to find a
6514 &"best"& match. Apart from the way the keys are matched, the processing for
6515 &(iplsearch)& is the same as for &(lsearch)&.
6516
6517 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6518 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6519 lookup types support only literal keys.
6520
6521 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6522 the implicit key is the host's IP address rather than its name (see section
6523 &<<SECThoslispatsikey>>&).
6524 .next
6525 .cindex "linear search"
6526 .cindex "lookup" "lsearch"
6527 .cindex "lsearch lookup type"
6528 .cindex "case sensitivity" "in lsearch lookup"
6529 &(lsearch)&: The given file is a text file that is searched linearly for a
6530 line beginning with the search key, terminated by a colon or white space or the
6531 end of the line. The search is case-insensitive; that is, upper and lower case
6532 letters are treated as the same. The first occurrence of the key that is found
6533 in the file is used.
6534
6535 White space between the key and the colon is permitted. The remainder of the
6536 line, with leading and trailing white space removed, is the data. This can be
6537 continued onto subsequent lines by starting them with any amount of white
6538 space, but only a single space character is included in the data at such a
6539 junction. If the data begins with a colon, the key must be terminated by a
6540 colon, for example:
6541 .code
6542 baduser:  :fail:
6543 .endd
6544 Empty lines and lines beginning with # are ignored, even if they occur in the
6545 middle of an item. This is the traditional textual format of alias files. Note
6546 that the keys in an &(lsearch)& file are literal strings. There is no
6547 wildcarding of any kind.
6548
6549 .cindex "lookup" "lsearch &-- colons in keys"
6550 .cindex "white space" "in lsearch key"
6551 In most &(lsearch)& files, keys are not required to contain colons or #
6552 characters, or white space. However, if you need this feature, it is available.
6553 If a key begins with a doublequote character, it is terminated only by a
6554 matching quote (or end of line), and the normal escaping rules apply to its
6555 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6556 quoted keys (exactly as for unquoted keys). There is no special handling of
6557 quotes for the data part of an &(lsearch)& line.
6558
6559 .next
6560 .cindex "NIS lookup type"
6561 .cindex "lookup" "NIS"
6562 .cindex "binary zero" "in lookup key"
6563 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6564 the given key, without a terminating binary zero. There is a variant called
6565 &(nis0)& which does include the terminating binary zero in the key. This is
6566 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6567 aliases; the full map names must be used.
6568
6569 .next
6570 .cindex "wildlsearch lookup type"
6571 .cindex "lookup" "wildlsearch"
6572 .cindex "nwildlsearch lookup type"
6573 .cindex "lookup" "nwildlsearch"
6574 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6575 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6576 the file may be wildcarded. The difference between these two lookup types is
6577 that for &(wildlsearch)&, each key in the file is string-expanded before being
6578 used, whereas for &(nwildlsearch)&, no expansion takes place.
6579
6580 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6581 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6582 file that are regular expressions can be made case-sensitive by the use of
6583 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6584
6585 . ==== As this is a nested list, any displays it contains must be indented
6586 . ==== as otherwise they are too far to the left.
6587
6588 .olist
6589 The string may begin with an asterisk to mean &"ends with"&. For example:
6590 .code
6591     *.a.b.c       data for anything.a.b.c
6592     *fish         data for anythingfish
6593 .endd
6594 .next
6595 The string may begin with a circumflex to indicate a regular expression. For
6596 example, for &(wildlsearch)&:
6597 .code
6598     ^\N\d+\.a\.b\N    data for <digits>.a.b
6599 .endd
6600 Note the use of &`\N`& to disable expansion of the contents of the regular
6601 expression. If you are using &(nwildlsearch)&, where the keys are not
6602 string-expanded, the equivalent entry is:
6603 .code
6604     ^\d+\.a\.b        data for <digits>.a.b
6605 .endd
6606 The case-insensitive flag is set at the start of compiling the regular
6607 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6608 For example, to make the entire pattern case-sensitive:
6609 .code
6610     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6611 .endd
6612
6613 If the regular expression contains white space or colon characters, you must
6614 either quote it (see &(lsearch)& above), or represent these characters in other
6615 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6616 colon. This may be easier than quoting, because if you quote, you have to
6617 escape all the backslashes inside the quotes.
6618
6619 &*Note*&: It is not possible to capture substrings in a regular expression
6620 match for later use, because the results of all lookups are cached. If a lookup
6621 is repeated, the result is taken from the cache, and no actual pattern matching
6622 takes place. The values of all the numeric variables are unset after a
6623 &((n)wildlsearch)& match.
6624
6625 .next
6626 Although I cannot see it being of much use, the general matching function that
6627 is used to implement &((n)wildlsearch)& means that the string may begin with a
6628 lookup name terminated by a semicolon, and followed by lookup data. For
6629 example:
6630 .code
6631     cdb;/some/file  data for keys that match the file
6632 .endd
6633 The data that is obtained from the nested lookup is discarded.
6634 .endlist olist
6635
6636 Keys that do not match any of these patterns are interpreted literally. The
6637 continuation rules for the data are the same as for &(lsearch)&, and keys may
6638 be followed by optional colons.
6639
6640 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6641 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6642 lookup types support only literal keys.
6643 .endlist ilist
6644
6645
6646 .section "Query-style lookup types" "SECTquerystylelookups"
6647 .cindex "lookup" "query-style types"
6648 .cindex "query-style lookup" "list of types"
6649 The supported query-style lookup types are listed below. Further details about
6650 many of them are given in later sections.
6651
6652 .ilist
6653 .cindex "DNS" "as a lookup type"
6654 .cindex "lookup" "DNS"
6655 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6656 are given in the supplied query. The resulting data is the contents of the
6657 records. See section &<<SECTdnsdb>>&.
6658 .next
6659 .cindex "InterBase lookup type"
6660 .cindex "lookup" "InterBase"
6661 &(ibase)&: This does a lookup in an InterBase database.
6662 .next
6663 .cindex "LDAP" "lookup type"
6664 .cindex "lookup" "LDAP"
6665 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6666 returns attributes from a single entry. There is a variant called &(ldapm)&
6667 that permits values from multiple entries to be returned. A third variant
6668 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6669 any attribute values. See section &<<SECTldap>>&.
6670 .next
6671 .cindex "MySQL" "lookup type"
6672 .cindex "lookup" "MySQL"
6673 &(mysql)&: The format of the query is an SQL statement that is passed to a
6674 MySQL database. See section &<<SECTsql>>&.
6675 .next
6676 .cindex "NIS+ lookup type"
6677 .cindex "lookup" "NIS+"
6678 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6679 the field to be returned. See section &<<SECTnisplus>>&.
6680 .next
6681 .cindex "Oracle" "lookup type"
6682 .cindex "lookup" "Oracle"
6683 &(oracle)&: The format of the query is an SQL statement that is passed to an
6684 Oracle database. See section &<<SECTsql>>&.
6685 .next
6686 .cindex "lookup" "passwd"
6687 .cindex "passwd lookup type"
6688 .cindex "&_/etc/passwd_&"
6689 &(passwd)& is a query-style lookup with queries that are just user names. The
6690 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6691 success, the result string is the same as you would get from an &(lsearch)&
6692 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6693 password value. For example:
6694 .code
6695 *:42:42:King Rat:/home/kr:/bin/bash
6696 .endd
6697 .next
6698 .cindex "PostgreSQL lookup type"
6699 .cindex "lookup" "PostgreSQL"
6700 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6701 PostgreSQL database. See section &<<SECTsql>>&.
6702
6703 .next
6704 .cindex "Redis lookup type"
6705 .cindex lookup Redis
6706 &(redis)&: The format of the query is an SQL statement that is passed to a
6707 Redis database. See section &<<SECTsql>>&.
6708
6709 .next
6710 .cindex "sqlite lookup type"
6711 .cindex "lookup" "sqlite"
6712 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6713 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6714
6715 .next
6716 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6717 not likely to be useful in normal operation.
6718 .next
6719 .cindex "whoson lookup type"
6720 .cindex "lookup" "whoson"
6721 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6722 allows a server to check whether a particular (dynamically allocated) IP
6723 address is currently allocated to a known (trusted) user and, optionally, to
6724 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6725 at one time for &"POP before SMTP"& authentication, but that approach has been
6726 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6727 &"POP before SMTP"& checking using ACL statements such as
6728 .code
6729 require condition = \
6730   ${lookup whoson {$sender_host_address}{yes}{no}}
6731 .endd
6732 The query consists of a single IP address. The value returned is the name of
6733 the authenticated user, which is stored in the variable &$value$&. However, in
6734 this example, the data in &$value$& is not used; the result of the lookup is
6735 one of the fixed strings &"yes"& or &"no"&.
6736 .endlist
6737
6738
6739
6740 .section "Temporary errors in lookups" "SECID63"
6741 .cindex "lookup" "temporary error in"
6742 Lookup functions can return temporary error codes if the lookup cannot be
6743 completed. For example, an SQL or LDAP database might be unavailable. For this
6744 reason, it is not advisable to use a lookup that might do this for critical
6745 options such as a list of local domains.
6746
6747 When a lookup cannot be completed in a router or transport, delivery
6748 of the message (to the relevant address) is deferred, as for any other
6749 temporary error. In other circumstances Exim may assume the lookup has failed,
6750 or may give up altogether.
6751
6752
6753
6754 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6755 .cindex "wildcard lookups"
6756 .cindex "lookup" "default values"
6757 .cindex "lookup" "wildcard"
6758 .cindex "lookup" "* added to type"
6759 .cindex "default" "in single-key lookups"
6760 In this context, a &"default value"& is a value specified by the administrator
6761 that is to be used if a lookup fails.
6762
6763 &*Note:*& This section applies only to single-key lookups. For query-style
6764 lookups, the facilities of the query language must be used. An attempt to
6765 specify a default for a query-style lookup provokes an error.
6766
6767 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6768 and the initial lookup fails, the key &"*"& is looked up in the file to
6769 provide a default value. See also the section on partial matching below.
6770
6771 .cindex "*@ with single-key lookup"
6772 .cindex "lookup" "*@ added to type"
6773 .cindex "alias file" "per-domain default"
6774 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6775 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6776 character, a second lookup is done with everything before the last @ replaced
6777 by *. This makes it possible to provide per-domain defaults in alias files
6778 that include the domains in the keys. If the second lookup fails (or doesn't
6779 take place because there is no @ in the key), &"*"& is looked up.
6780 For example, a &(redirect)& router might contain:
6781 .code
6782 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6783 .endd
6784 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6785 looks up these keys, in this order:
6786 .code
6787 jane@eyre.example
6788 *@eyre.example
6789 *
6790 .endd
6791 The data is taken from whichever key it finds first. &*Note*&: In an
6792 &(lsearch)& file, this does not mean the first of these keys in the file. A
6793 complete scan is done for each key, and only if it is not found at all does
6794 Exim move on to try the next key.
6795
6796
6797
6798 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6799 .cindex "partial matching"
6800 .cindex "wildcard lookups"
6801 .cindex "lookup" "partial matching"
6802 .cindex "lookup" "wildcard"
6803 .cindex "asterisk" "in search type"
6804 The normal operation of a single-key lookup is to search the file for an exact
6805 match with the given key. However, in a number of situations where domains are
6806 being looked up, it is useful to be able to do partial matching. In this case,
6807 information in the file that has a key starting with &"*."& is matched by any
6808 domain that ends with the components that follow the full stop. For example, if
6809 a key in a DBM file is
6810 .code
6811 *.dates.fict.example
6812 .endd
6813 then when partial matching is enabled this is matched by (amongst others)
6814 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6815 by &'dates.fict.example'&, if that does not appear as a separate key in the
6816 file.
6817
6818 &*Note*&: Partial matching is not available for query-style lookups. It is
6819 also not available for any lookup items in address lists (see section
6820 &<<SECTaddresslist>>&).
6821
6822 Partial matching is implemented by doing a series of separate lookups using
6823 keys constructed by modifying the original subject key. This means that it can
6824 be used with any of the single-key lookup types, provided that
6825 partial matching keys
6826 beginning with a special prefix (default &"*."&) are included in the data file.
6827 Keys in the file that do not begin with the prefix are matched only by
6828 unmodified subject keys when partial matching is in use.
6829
6830 Partial matching is requested by adding the string &"partial-"& to the front of
6831 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6832 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6833 is added at the start of the subject key, and it is looked up again. If that
6834 fails, further lookups are tried with dot-separated components removed from the
6835 start of the subject key, one-by-one, and &"*."& added on the front of what
6836 remains.
6837
6838 A minimum number of two non-* components are required. This can be adjusted
6839 by including a number before the hyphen in the search type. For example,
6840 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6841 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6842 subject key is &'2250.dates.fict.example'& then the following keys are looked
6843 up when the minimum number of non-* components is two:
6844 .code
6845 2250.dates.fict.example
6846 *.2250.dates.fict.example
6847 *.dates.fict.example
6848 *.fict.example
6849 .endd
6850 As soon as one key in the sequence is successfully looked up, the lookup
6851 finishes.
6852
6853 .cindex "lookup" "partial matching &-- changing prefix"
6854 .cindex "prefix" "for partial matching"
6855 The use of &"*."& as the partial matching prefix is a default that can be
6856 changed. The motivation for this feature is to allow Exim to operate with file
6857 formats that are used by other MTAs. A different prefix can be supplied in
6858 parentheses instead of the hyphen after &"partial"&. For example:
6859 .code
6860 domains = partial(.)lsearch;/some/file
6861 .endd
6862 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6863 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6864 components is unchanged). The prefix may consist of any punctuation characters
6865 other than a closing parenthesis. It may be empty, for example:
6866 .code
6867 domains = partial1()cdb;/some/file
6868 .endd
6869 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6870 &`a.b.c`&, &`b.c`&, and &`c`&.
6871
6872 If &"partial0"& is specified, what happens at the end (when the lookup with
6873 just one non-wild component has failed, and the original key is shortened right
6874 down to the null string) depends on the prefix:
6875
6876 .ilist
6877 If the prefix has zero length, the whole lookup fails.
6878 .next
6879 If the prefix has length 1, a lookup for just the prefix is done. For
6880 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6881 .next
6882 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6883 remainder is looked up. With the default prefix, therefore, the final lookup is
6884 for &"*"& on its own.
6885 .next
6886 Otherwise, the whole prefix is looked up.
6887 .endlist
6888
6889
6890 If the search type ends in &"*"& or &"*@"& (see section
6891 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6892 this implies happens after all partial lookups have failed. If &"partial0"& is
6893 specified, adding &"*"& to the search type has no effect with the default
6894 prefix, because the &"*"& key is already included in the sequence of partial
6895 lookups. However, there might be a use for lookup types such as
6896 &"partial0(.)lsearch*"&.
6897
6898 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6899 in domain lists and the like. Partial matching works only in terms of
6900 dot-separated components; a key such as &`*fict.example`&
6901 in a database file is useless, because the asterisk in a partial matching
6902 subject key is always followed by a dot.
6903
6904
6905
6906
6907 .section "Lookup caching" "SECID64"
6908 .cindex "lookup" "caching"
6909 .cindex "caching" "lookup data"
6910 Exim caches all lookup results in order to avoid needless repetition of
6911 lookups. However, because (apart from the daemon) Exim operates as a collection
6912 of independent, short-lived processes, this caching applies only within a
6913 single Exim process. There is no inter-process lookup caching facility.
6914
6915 For single-key lookups, Exim keeps the relevant files open in case there is
6916 another lookup that needs them. In some types of configuration this can lead to
6917 many files being kept open for messages with many recipients. To avoid hitting
6918 the operating system limit on the number of simultaneously open files, Exim
6919 closes the least recently used file when it needs to open more files than its
6920 own internal limit, which can be changed via the &%lookup_open_max%& option.
6921
6922 The single-key lookup files are closed and the lookup caches are flushed at
6923 strategic points during delivery &-- for example, after all routing is
6924 complete.
6925
6926
6927
6928
6929 .section "Quoting lookup data" "SECID65"
6930 .cindex "lookup" "quoting"
6931 .cindex "quoting" "in lookups"
6932 When data from an incoming message is included in a query-style lookup, there
6933 is the possibility of special characters in the data messing up the syntax of
6934 the query. For example, a NIS+ query that contains
6935 .code
6936 [name=$local_part]
6937 .endd
6938 will be broken if the local part happens to contain a closing square bracket.
6939 For NIS+, data can be enclosed in double quotes like this:
6940 .code
6941 [name="$local_part"]
6942 .endd
6943 but this still leaves the problem of a double quote in the data. The rule for
6944 NIS+ is that double quotes must be doubled. Other lookup types have different
6945 rules, and to cope with the differing requirements, an expansion operator
6946 of the following form is provided:
6947 .code
6948 ${quote_<lookup-type>:<string>}
6949 .endd
6950 For example, the safest way to write the NIS+ query is
6951 .code
6952 [name="${quote_nisplus:$local_part}"]
6953 .endd
6954 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6955 operator can be used for all lookup types, but has no effect for single-key
6956 lookups, since no quoting is ever needed in their key strings.
6957
6958
6959
6960
6961 .section "More about dnsdb" "SECTdnsdb"
6962 .cindex "dnsdb lookup"
6963 .cindex "lookup" "dnsdb"
6964 .cindex "DNS" "as a lookup type"
6965 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6966 of a record type and a domain name, separated by an equals sign. For example,
6967 an expansion string could contain:
6968 .code
6969 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6970 .endd
6971 If the lookup succeeds, the result is placed in &$value$&, which in this case
6972 is used on its own as the result. If the lookup does not succeed, the
6973 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6974 &<<SECTforexpfai>>& for an explanation of what this means.
6975
6976 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6977 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6978 If no type is given, TXT is assumed.
6979
6980 For any record type, if multiple records are found, the data is returned as a
6981 concatenation, with newline as the default separator. The order, of course,
6982 depends on the DNS resolver. You can specify a different separator character
6983 between multiple records by putting a right angle-bracket followed immediately
6984 by the new separator at the start of the query. For example:
6985 .code
6986 ${lookup dnsdb{>: a=host1.example}}
6987 .endd
6988 It is permitted to specify a space as the separator character. Further
6989 white space is ignored.
6990 For lookup types that return multiple fields per record,
6991 an alternate field separator can be specified using a comma after the main
6992 separator character, followed immediately by the field separator.
6993
6994 .cindex "PTR record" "in &(dnsdb)& lookup"
6995 When the type is PTR,
6996 the data can be an IP address, written as normal; inversion and the addition of
6997 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6998 .code
6999 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7000 .endd
7001 If the data for a PTR record is not a syntactically valid IP address, it is not
7002 altered and nothing is added.
7003
7004 .cindex "MX record" "in &(dnsdb)& lookup"
7005 .cindex "SRV record" "in &(dnsdb)& lookup"
7006 For an MX lookup, both the preference value and the host name are returned for
7007 each record, separated by a space. For an SRV lookup, the priority, weight,
7008 port, and host name are returned for each record, separated by spaces.
7009 The field separator can be modified as above.
7010
7011 .cindex "TXT record" "in &(dnsdb)& lookup"
7012 .cindex "SPF record" "in &(dnsdb)& lookup"
7013 For TXT records with multiple items of data, only the first item is returned,
7014 unless a field separator is specified.
7015 To concatenate items without a separator, use a semicolon instead.
7016 For SPF records the
7017 default behaviour is to concatenate multiple items without using a separator.
7018 .code
7019 ${lookup dnsdb{>\n,: txt=a.b.example}}
7020 ${lookup dnsdb{>\n; txt=a.b.example}}
7021 ${lookup dnsdb{spf=example.org}}
7022 .endd
7023 It is permitted to specify a space as the separator character. Further
7024 white space is ignored.
7025
7026 .cindex "SOA record" "in &(dnsdb)& lookup"
7027 For an SOA lookup, while no result is obtained the lookup is redone with
7028 successively more leading components dropped from the given domain.
7029 Only the primary-nameserver field is returned unless a field separator is
7030 specified.
7031 .code
7032 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7033 .endd
7034
7035 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7036 .cindex "dnsdb modifiers"
7037 .cindex "modifiers" "dnsdb"
7038 .cindex "options" "dnsdb"
7039 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7040 each followed by a comma,
7041 that may appear before the record type.
7042
7043 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7044 temporary DNS error for any of them, the behaviour is controlled by
7045 a defer-option modifier.
7046 The possible keywords are
7047 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7048 With &"strict"& behaviour, any temporary DNS error causes the
7049 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7050 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7051 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7052 error causes the whole lookup to defer only if none of the other lookups
7053 succeed. The default is &"lax"&, so the following lookups are equivalent:
7054 .code
7055 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7056 ${lookup dnsdb{a=one.host.com:two.host.com}}
7057 .endd
7058 Thus, in the default case, as long as at least one of the DNS lookups
7059 yields some data, the lookup succeeds.
7060
7061 .cindex "DNSSEC" "dns lookup"
7062 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7063 The possible keywords are
7064 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7065 With &"strict"& or &"lax"& DNSSEC information is requested
7066 with the lookup.
7067 With &"strict"& a response from the DNS resolver that
7068 is not labelled as authenticated data
7069 is treated as equivalent to a temporary DNS error.
7070 The default is &"never"&.
7071
7072 See also the &$lookup_dnssec_authenticated$& variable.
7073
7074 .cindex timeout "dns lookup"
7075 .cindex "DNS" timeout
7076 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7077 The form is &"retrans_VAL"& where VAL is an Exim time specification
7078 (e.g. &"5s"&).
7079 The default value is set by the main configuration option &%dns_retrans%&.
7080
7081 Retries for the dnsdb lookup can be controlled by a retry modifier.
7082 The form if &"retry_VAL"& where VAL is an integer.
7083 The default count is set by the main configuration option &%dns_retry%&.
7084
7085 .cindex cacheing "of dns lookup"
7086 .cindex TTL "of dns lookup"
7087 .cindex DNS TTL
7088 Dnsdb lookup results are cached within a single process (and its children).
7089 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7090 value of the set of returned DNS records.
7091
7092
7093 .section "Pseudo dnsdb record types" "SECID66"
7094 .cindex "MX record" "in &(dnsdb)& lookup"
7095 By default, both the preference value and the host name are returned for
7096 each MX record, separated by a space. If you want only host names, you can use
7097 the pseudo-type MXH:
7098 .code
7099 ${lookup dnsdb{mxh=a.b.example}}
7100 .endd
7101 In this case, the preference values are omitted, and just the host names are
7102 returned.
7103
7104 .cindex "name server for enclosing domain"
7105 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7106 records on the given domain, but if none are found, it removes the first
7107 component of the domain name, and tries again. This process continues until NS
7108 records are found or there are no more components left (or there is a DNS
7109 error). In other words, it may return the name servers for a top-level domain,
7110 but it never returns the root name servers. If there are no NS records for the
7111 top-level domain, the lookup fails. Consider these examples:
7112 .code
7113 ${lookup dnsdb{zns=xxx.quercite.com}}
7114 ${lookup dnsdb{zns=xxx.edu}}
7115 .endd
7116 Assuming that in each case there are no NS records for the full domain name,
7117 the first returns the name servers for &%quercite.com%&, and the second returns
7118 the name servers for &%edu%&.
7119
7120 You should be careful about how you use this lookup because, unless the
7121 top-level domain does not exist, the lookup always returns some host names. The
7122 sort of use to which this might be put is for seeing if the name servers for a
7123 given domain are on a blacklist. You can probably assume that the name servers
7124 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7125 such a list.
7126
7127 .cindex "CSA" "in &(dnsdb)& lookup"
7128 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7129 records according to the CSA rules, which are described in section
7130 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7131 not sufficient because of the extra parent domain search behaviour of CSA. The
7132 result of a successful lookup such as:
7133 .code
7134 ${lookup dnsdb {csa=$sender_helo_name}}
7135 .endd
7136 has two space-separated fields: an authorization code and a target host name.
7137 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7138 authorization required but absent, or &"?"& for unknown.
7139
7140 .cindex "A+" "in &(dnsdb)& lookup"
7141 The pseudo-type A+ performs an AAAA
7142 and then an A lookup.  All results are returned; defer processing
7143 (see below) is handled separately for each lookup.  Example:
7144 .code
7145 ${lookup dnsdb {>; a+=$sender_helo_name}}
7146 .endd
7147
7148
7149 .section "Multiple dnsdb lookups" "SECID67"
7150 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7151 However, you can specify a list of domains or IP addresses in a single
7152 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7153 the default separator, but with the ability to change this. For example:
7154 .code
7155 ${lookup dnsdb{one.domain.com:two.domain.com}}
7156 ${lookup dnsdb{a=one.host.com:two.host.com}}
7157 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7158 .endd
7159 In order to retain backwards compatibility, there is one special case: if
7160 the lookup type is PTR and no change of separator is specified, Exim looks
7161 to see if the rest of the string is precisely one IPv6 address. In this
7162 case, it does not treat it as a list.
7163
7164 The data from each lookup is concatenated, with newline separators by default,
7165 in the same way that multiple DNS records for a single item are handled. A
7166 different separator can be specified, as described above.
7167
7168
7169
7170
7171 .section "More about LDAP" "SECTldap"
7172 .cindex "LDAP" "lookup, more about"
7173 .cindex "lookup" "LDAP"
7174 .cindex "Solaris" "LDAP"
7175 The original LDAP implementation came from the University of Michigan; this has
7176 become &"Open LDAP"&, and there are now two different releases. Another
7177 implementation comes from Netscape, and Solaris 7 and subsequent releases
7178 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7179 the lookup function level, their error handling is different. For this reason
7180 it is necessary to set a compile-time variable when building Exim with LDAP, to
7181 indicate which LDAP library is in use. One of the following should appear in
7182 your &_Local/Makefile_&:
7183 .code
7184 LDAP_LIB_TYPE=UMICHIGAN
7185 LDAP_LIB_TYPE=OPENLDAP1
7186 LDAP_LIB_TYPE=OPENLDAP2
7187 LDAP_LIB_TYPE=NETSCAPE
7188 LDAP_LIB_TYPE=SOLARIS
7189 .endd
7190 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7191 same interface as the University of Michigan version.
7192
7193 There are three LDAP lookup types in Exim. These behave slightly differently in
7194 the way they handle the results of a query:
7195
7196 .ilist
7197 &(ldap)& requires the result to contain just one entry; if there are more, it
7198 gives an error.
7199 .next
7200 &(ldapdn)& also requires the result to contain just one entry, but it is the
7201 Distinguished Name that is returned rather than any attribute values.
7202 .next
7203 &(ldapm)& permits the result to contain more than one entry; the attributes
7204 from all of them are returned.
7205 .endlist
7206
7207
7208 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7209 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7210 the data returned by a successful lookup is described in the next section.
7211 First we explain how LDAP queries are coded.
7212
7213
7214 .section "Format of LDAP queries" "SECTforldaque"
7215 .cindex "LDAP" "query format"
7216 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7217 the configuration of a &(redirect)& router one might have this setting:
7218 .code
7219 data = ${lookup ldap \
7220   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7221   c=UK?mailbox?base?}}
7222 .endd
7223 .cindex "LDAP" "with TLS"
7224 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7225 secure (encrypted) LDAP connections. The second of these ensures that an
7226 encrypted TLS connection is used.
7227
7228 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7229 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7230 See the &%ldap_start_tls%& option.
7231
7232 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7233 controlled. Every part of the TLS configuration can be configured by settings in
7234 &_exim.conf_&. Depending on the version of the client libraries installed on
7235 your system, some of the initialization may have required setting options in
7236 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7237 certificates. This revealed a nuance where the current UID that exim was
7238 running as could affect which config files it read. With Exim 4.83, these
7239 methods become optional, only taking effect if not specifically set in
7240 &_exim.conf_&.
7241
7242
7243 .section "LDAP quoting" "SECID68"
7244 .cindex "LDAP" "quoting"
7245 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7246 and the second because the LDAP query is represented as a URL. Furthermore,
7247 within an LDAP query, two different kinds of quoting are required. For this
7248 reason, there are two different LDAP-specific quoting operators.
7249
7250 The &%quote_ldap%& operator is designed for use on strings that are part of
7251 filter specifications. Conceptually, it first does the following conversions on
7252 the string:
7253 .code
7254 *   =>   \2A
7255 (   =>   \28
7256 )   =>   \29
7257 \   =>   \5C
7258 .endd
7259 in accordance with RFC 2254. The resulting string is then quoted according
7260 to the rules for URLs, that is, all non-alphanumeric characters except
7261 .code
7262 ! $ ' - . _ ( ) * +
7263 .endd
7264 are converted to their hex values, preceded by a percent sign. For example:
7265 .code
7266 ${quote_ldap: a(bc)*, a<yz>; }
7267 .endd
7268 yields
7269 .code
7270 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7271 .endd
7272 Removing the URL quoting, this is (with a leading and a trailing space):
7273 .code
7274 a\28bc\29\2A, a<yz>;
7275 .endd
7276 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7277 base DN specifications in queries. Conceptually, it first converts the string
7278 by inserting a backslash in front of any of the following characters:
7279 .code
7280 , + " \ < > ;
7281 .endd
7282 It also inserts a backslash before any leading spaces or # characters, and
7283 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7284 is then quoted according to the rules for URLs. For example:
7285 .code
7286 ${quote_ldap_dn: a(bc)*, a<yz>; }
7287 .endd
7288 yields
7289 .code
7290 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7291 .endd
7292 Removing the URL quoting, this is (with a trailing space):
7293 .code
7294 \ a(bc)*\, a\<yz\>\;\
7295 .endd
7296 There are some further comments about quoting in the section on LDAP
7297 authentication below.
7298
7299
7300 .section "LDAP connections" "SECID69"
7301 .cindex "LDAP" "connections"
7302 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7303 is in use, via a Unix domain socket. The example given above does not specify
7304 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7305 by starting it with
7306 .code
7307 ldap://<hostname>:<port>/...
7308 .endd
7309 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7310 used. When no server is specified in a query, a list of default servers is
7311 taken from the &%ldap_default_servers%& configuration option. This supplies a
7312 colon-separated list of servers which are tried in turn until one successfully
7313 handles a query, or there is a serious error. Successful handling either
7314 returns the requested data, or indicates that it does not exist. Serious errors
7315 are syntactical, or multiple values when only a single value is expected.
7316 Errors which cause the next server to be tried are connection failures, bind
7317 failures, and timeouts.
7318
7319 For each server name in the list, a port number can be given. The standard way
7320 of specifying a host and port is to use a colon separator (RFC 1738). Because
7321 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7322 doubled. For example
7323 .code
7324 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7325 .endd
7326 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7327 to the LDAP library with no server name, and the library's default (normally
7328 the local host) is used.
7329
7330 If you are using the OpenLDAP library, you can connect to an LDAP server using
7331 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7332 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7333 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7334 not available.
7335
7336 For this type of connection, instead of a host name for the server, a pathname
7337 for the socket is required, and the port number is not relevant. The pathname
7338 can be specified either as an item in &%ldap_default_servers%&, or inline in
7339 the query. In the former case, you can have settings such as
7340 .code
7341 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7342 .endd
7343 When the pathname is given in the query, you have to escape the slashes as
7344 &`%2F`& to fit in with the LDAP URL syntax. For example:
7345 .code
7346 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7347 .endd
7348 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7349 a pathname, it uses the Unix domain socket code, even if the query actually
7350 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7351 socket connection. This behaviour means that you can use a setting of
7352 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7353 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7354 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7355 backup host.
7356
7357 If an explicit &`ldapi`& type is given in a query when a host name is
7358 specified, an error is diagnosed. However, if there are more items in
7359 &%ldap_default_servers%&, they are tried. In other words:
7360
7361 .ilist
7362 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7363 interface.
7364 .next
7365 Using &`ldapi`& with a host name causes an error.
7366 .endlist
7367
7368
7369 Using &`ldapi`& with no host or path in the query, and no setting of
7370 &%ldap_default_servers%&, does whatever the library does by default.
7371
7372
7373
7374 .section "LDAP authentication and control information" "SECID70"
7375 .cindex "LDAP" "authentication"
7376 The LDAP URL syntax provides no way of passing authentication and other control
7377 information to the server. To make this possible, the URL in an LDAP query may
7378 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7379 spaces. If a value contains spaces it must be enclosed in double quotes, and
7380 when double quotes are used, backslash is interpreted in the usual way inside
7381 them. The following names are recognized:
7382 .display
7383 &`DEREFERENCE`&  set the dereferencing parameter
7384 &`NETTIME    `&  set a timeout for a network operation
7385 &`USER       `&  set the DN, for authenticating the LDAP bind
7386 &`PASS       `&  set the password, likewise
7387 &`REFERRALS  `&  set the referrals parameter
7388 &`SERVERS    `&  set alternate server list for this query only
7389 &`SIZE       `&  set the limit for the number of entries returned
7390 &`TIME       `&  set the maximum waiting time for a query
7391 .endd
7392 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7393 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7394 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7395 library from trying to follow referrals issued by the LDAP server.
7396
7397 .cindex LDAP timeout
7398 .cindex timeout "LDAP lookup"
7399 The name CONNECT is an obsolete name for NETTIME, retained for
7400 backwards compatibility. This timeout (specified as a number of seconds) is
7401 enforced from the client end for operations that can be carried out over a
7402 network. Specifically, it applies to network connections and calls to the
7403 &'ldap_result()'& function. If the value is greater than zero, it is used if
7404 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7405 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7406 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7407 Netscape SDK; for OpenLDAP no action is taken.
7408
7409 The TIME parameter (also a number of seconds) is passed to the server to
7410 set a server-side limit on the time taken to complete a search.
7411
7412 The SERVERS parameter allows you to specify an alternate list of ldap servers
7413 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7414 default list of ldap servers, and a single lookup can specify a single ldap
7415 server to use.  But when you need to do a lookup with a list of servers that is
7416 different than the default list (maybe different order, maybe a completely
7417 different set of servers), the SERVERS parameter allows you to specify this
7418 alternate list (colon-separated).
7419
7420 Here is an example of an LDAP query in an Exim lookup that uses some of these
7421 values. This is a single line, folded to fit on the page:
7422 .code
7423 ${lookup ldap
7424   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7425   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7426   {$value}fail}
7427 .endd
7428 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7429 any of the auxiliary data. Exim configuration settings that include lookups
7430 which contain password information should be preceded by &"hide"& to prevent
7431 non-admin users from using the &%-bP%& option to see their values.
7432
7433 The auxiliary data items may be given in any order. The default is no
7434 connection timeout (the system timeout is used), no user or password, no limit
7435 on the number of entries returned, and no time limit on queries.
7436
7437 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7438 removes any URL quoting that it may contain before passing it LDAP. Apparently
7439 some libraries do this for themselves, but some do not. Removing the URL
7440 quoting has two advantages:
7441
7442 .ilist
7443 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7444 DNs as with DNs inside actual queries.
7445 .next
7446 It permits spaces inside USER= DNs.
7447 .endlist
7448
7449 For example, a setting such as
7450 .code
7451 USER=cn=${quote_ldap_dn:$1}
7452 .endd
7453 should work even if &$1$& contains spaces.
7454
7455 Expanded data for the PASS= value should be quoted using the &%quote%&
7456 expansion operator, rather than the LDAP quote operators. The only reason this
7457 field needs quoting is to ensure that it conforms to the Exim syntax, which
7458 does not allow unquoted spaces. For example:
7459 .code
7460 PASS=${quote:$3}
7461 .endd
7462 The LDAP authentication mechanism can be used to check passwords as part of
7463 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7464 &<<CHAPexpand>>&.
7465
7466
7467
7468 .section "Format of data returned by LDAP" "SECID71"
7469 .cindex "LDAP" "returned data formats"
7470 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7471 as a sequence of values, for example
7472 .code
7473 cn=manager,o=University of Cambridge,c=UK
7474 .endd
7475 The &(ldap)& lookup type generates an error if more than one entry matches the
7476 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7477 the result between the data from different entries. It is possible for multiple
7478 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7479 you know that whatever values are returned all came from a single entry in the
7480 directory.
7481
7482 In the common case where you specify a single attribute in your LDAP query, the
7483 result is not quoted, and does not contain the attribute name. If the attribute
7484 has multiple values, they are separated by commas. Any comma that is
7485 part of an attribute's value is doubled.
7486
7487 If you specify multiple attributes, the result contains space-separated, quoted
7488 strings, each preceded by the attribute name and an equals sign. Within the
7489 quotes, the quote character, backslash, and newline are escaped with
7490 backslashes, and commas are used to separate multiple values for the attribute.
7491 Any commas in attribute values are doubled
7492 (permitting treatment of the values as a comma-separated list).
7493 Apart from the escaping, the string within quotes takes the same form as the
7494 output when a single attribute is requested. Specifying no attributes is the
7495 same as specifying all of an entry's attributes.
7496
7497 Here are some examples of the output format. The first line of each pair is an
7498 LDAP query, and the second is the data that is returned. The attribute called
7499 &%attr1%& has two values, one of them with an embedded comma, whereas
7500 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7501 (they have SUP &%attr%& in their schema definitions).
7502
7503 .code
7504 ldap:///o=base?attr1?sub?(uid=fred)
7505 value1.1,value1,,2
7506
7507 ldap:///o=base?attr2?sub?(uid=fred)
7508 value two
7509
7510 ldap:///o=base?attr?sub?(uid=fred)
7511 value1.1,value1,,2,value two
7512
7513 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7514 attr1="value1.1,value1,,2" attr2="value two"
7515
7516 ldap:///o=base??sub?(uid=fred)
7517 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7518 .endd
7519 You can
7520 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7521 results of LDAP lookups.
7522 The &%extract%& operator in string expansions can be used to pick out
7523 individual fields from data that consists of &'key'&=&'value'& pairs.
7524 The &%listextract%& operator should be used to pick out individual values
7525 of attributes, even when only a single value is expected.
7526 The doubling of embedded commas allows you to use the returned data as a
7527 comma separated list (using the "<," syntax for changing the input list separator).
7528
7529
7530
7531
7532 .section "More about NIS+" "SECTnisplus"
7533 .cindex "NIS+ lookup type"
7534 .cindex "lookup" "NIS+"
7535 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7536 and field name. If this is given, the result of a successful query is the
7537 contents of the named field; otherwise the result consists of a concatenation
7538 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7539 values containing spaces are quoted. For example, the query
7540 .code
7541 [name=mg1456],passwd.org_dir
7542 .endd
7543 might return the string
7544 .code
7545 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7546 home=/home/mg1456 shell=/bin/bash shadow=""
7547 .endd
7548 (split over two lines here to fit on the page), whereas
7549 .code
7550 [name=mg1456],passwd.org_dir:gcos
7551 .endd
7552 would just return
7553 .code
7554 Martin Guerre
7555 .endd
7556 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7557 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7558 operator is to double any quote characters within the text.
7559
7560
7561
7562 .section "SQL lookups" "SECTsql"
7563 .cindex "SQL lookup types"
7564 .cindex "MySQL" "lookup type"
7565 .cindex "PostgreSQL lookup type"
7566 .cindex "lookup" "MySQL"
7567 .cindex "lookup" "PostgreSQL"
7568 .cindex "Oracle" "lookup type"
7569 .cindex "lookup" "Oracle"
7570 .cindex "InterBase lookup type"
7571 .cindex "lookup" "InterBase"
7572 .cindex "Redis lookup type"
7573 .cindex lookup Redis
7574 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7575 and SQLite
7576 databases. Queries for these databases contain SQL statements, so an example
7577 might be
7578 .code
7579 ${lookup mysql{select mailbox from users where id='userx'}\
7580   {$value}fail}
7581 .endd
7582 If the result of the query contains more than one field, the data for each
7583 field in the row is returned, preceded by its name, so the result of
7584 .code
7585 ${lookup pgsql{select home,name from users where id='userx'}\
7586   {$value}}
7587 .endd
7588 might be
7589 .code
7590 home=/home/userx name="Mister X"
7591 .endd
7592 Empty values and values containing spaces are double quoted, with embedded
7593 quotes escaped by a backslash. If the result of the query contains just one
7594 field, the value is passed back verbatim, without a field name, for example:
7595 .code
7596 Mister X
7597 .endd
7598 If the result of the query yields more than one row, it is all concatenated,
7599 with a newline between the data for each row.
7600
7601
7602 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7603 .cindex "MySQL" "lookup type"
7604 .cindex "PostgreSQL lookup type"
7605 .cindex "lookup" "MySQL"
7606 .cindex "lookup" "PostgreSQL"
7607 .cindex "Oracle" "lookup type"
7608 .cindex "lookup" "Oracle"
7609 .cindex "InterBase lookup type"
7610 .cindex "lookup" "InterBase"
7611 .cindex "Redis lookup type"
7612 .cindex lookup Redis
7613 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7614 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7615 or &%redis_servers%&
7616 option (as appropriate) must be set to a colon-separated list of server
7617 information.
7618 (For MySQL and PostgreSQL, the global option need not be set if all
7619 queries contain their own server information &-- see section
7620 &<<SECTspeserque>>&.)
7621 For all but Redis
7622 each item in the list is a slash-separated list of four
7623 items: host name, database name, user name, and password. In the case of
7624 Oracle, the host name field is used for the &"service name"&, and the database
7625 name field is not used and should be empty. For example:
7626 .code
7627 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7628 .endd
7629 Because password data is sensitive, you should always precede the setting with
7630 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7631 option. Here is an example where two MySQL servers are listed:
7632 .code
7633 hide mysql_servers = localhost/users/root/secret:\
7634                      otherhost/users/root/othersecret
7635 .endd
7636 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7637 because this is a colon-separated list, the colon has to be doubled. For each
7638 query, these parameter groups are tried in order until a connection is made and
7639 a query is successfully processed. The result of a query may be that no data is
7640 found, but that is still a successful query. In other words, the list of
7641 servers provides a backup facility, not a list of different places to look.
7642
7643 For Redis the global option need not be specified if all queries contain their
7644 own server information &-- see section &<<SECTspeserque>>&.
7645 If specified, the option must be set to a colon-separated list of server
7646 information.
7647 Each item in the list is a slash-separated list of three items:
7648 host, database number, and password.
7649 .olist
7650 The host is required and may be either an IPv4 address and optional
7651 port number (separated by a colon, which needs doubling due to the
7652 higher-level list), or a Unix socket pathname enclosed in parentheses
7653 .next
7654 The database number is optional; if present that number is selected in the backend
7655 .next
7656 The password is optional; if present it is used to authenticate to the backend
7657 .endlist
7658
7659 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7660 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7661 respectively, and the characters single-quote, double-quote, and backslash
7662 itself are escaped with backslashes.
7663
7664 The &%quote_redis%& expansion operator
7665 escapes whitespace and backslash characters with a backslash.
7666
7667 .section "Specifying the server in the query" "SECTspeserque"
7668 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7669 it is possible to specify a list of servers with an individual query. This is
7670 done by starting the query with
7671 .display
7672 &`servers=`&&'server1:server2:server3:...'&&`;`&
7673 .endd
7674 Each item in the list may take one of two forms:
7675 .olist
7676 If it contains no slashes it is assumed to be just a host name. The appropriate
7677 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7678 of the same name, and the remaining parameters (database, user, password) are
7679 taken from there.
7680 .next
7681 If it contains any slashes, it is taken as a complete parameter set.
7682 .endlist
7683 The list of servers is used in exactly the same way as the global list.
7684 Once a connection to a server has happened and a query has been
7685 successfully executed, processing of the lookup ceases.
7686
7687 This feature is intended for use in master/slave situations where updates
7688 are occurring and you want to update the master rather than a slave. If the
7689 master is in the list as a backup for reading, you might have a global setting
7690 like this:
7691 .code
7692 mysql_servers = slave1/db/name/pw:\
7693                 slave2/db/name/pw:\
7694                 master/db/name/pw
7695 .endd
7696 In an updating lookup, you could then write:
7697 .code
7698 ${lookup mysql{servers=master; UPDATE ...} }
7699 .endd
7700 That query would then be sent only to the master server. If, on the other hand,
7701 the master is not to be used for reading, and so is not present in the global
7702 option, you can still update it by a query of this form:
7703 .code
7704 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7705 .endd
7706
7707
7708 .section "Special MySQL features" "SECID73"
7709 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7710 causes a connection to the server on the local host by means of a Unix domain
7711 socket. An alternate socket can be specified in parentheses.
7712 An option group name for MySQL option files can be specified in square brackets;
7713 the default value is &"exim"&.
7714 The full syntax of each item in &%mysql_servers%& is:
7715 .display
7716 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7717   <&'database'&>/<&'user'&>/<&'password'&>
7718 .endd
7719 Any of the four sub-parts of the first field can be omitted. For normal use on
7720 the local host it can be left blank or set to just &"localhost"&.
7721
7722 No database need be supplied &-- but if it is absent here, it must be given in
7723 the queries.
7724
7725 If a MySQL query is issued that does not request any data (an insert, update,
7726 or delete command), the result of the lookup is the number of rows affected.
7727
7728 &*Warning*&: This can be misleading. If an update does not actually change
7729 anything (for example, setting a field to the value it already has), the result
7730 is zero because no rows are affected.
7731
7732
7733 .section "Special PostgreSQL features" "SECID74"
7734 PostgreSQL lookups can also use Unix domain socket connections to the database.
7735 This is usually faster and costs less CPU time than a TCP/IP connection.
7736 However it can be used only if the mail server runs on the same machine as the
7737 database server. A configuration line for PostgreSQL via Unix domain sockets
7738 looks like this:
7739 .code
7740 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7741 .endd
7742 In other words, instead of supplying a host name, a path to the socket is
7743 given. The path name is enclosed in parentheses so that its slashes aren't
7744 visually confused with the delimiters for the other server parameters.
7745
7746 If a PostgreSQL query is issued that does not request any data (an insert,
7747 update, or delete command), the result of the lookup is the number of rows
7748 affected.
7749
7750 .section "More about SQLite" "SECTsqlite"
7751 .cindex "lookup" "SQLite"
7752 .cindex "sqlite lookup type"
7753 SQLite is different to the other SQL lookups because a file name is required in
7754 addition to the SQL query. An SQLite database is a single file, and there is no
7755 daemon as in the other SQL databases. The interface to Exim requires the name
7756 of the file, as an absolute path, to be given at the start of the query. It is
7757 separated from the query by white space. This means that the path name cannot
7758 contain white space. Here is a lookup expansion example:
7759 .code
7760 ${lookup sqlite {/some/thing/sqlitedb \
7761   select name from aliases where id='userx';}}
7762 .endd
7763 In a list, the syntax is similar. For example:
7764 .code
7765 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7766    select * from relays where ip='$sender_host_address';
7767 .endd
7768 The only character affected by the &%quote_sqlite%& operator is a single
7769 quote, which it doubles.
7770
7771 .cindex timeout SQLite
7772 .cindex sqlite "lookup timeout"
7773 The SQLite library handles multiple simultaneous accesses to the database
7774 internally. Multiple readers are permitted, but only one process can
7775 update at once. Attempts to access the database while it is being updated
7776 are rejected after a timeout period, during which the SQLite library
7777 waits for the lock to be released. In Exim, the default timeout is set
7778 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7779 option.
7780 .ecindex IIDfidalo1
7781 .ecindex IIDfidalo2
7782
7783
7784 . ////////////////////////////////////////////////////////////////////////////
7785 . ////////////////////////////////////////////////////////////////////////////
7786
7787 .chapter "Domain, host, address, and local part lists" &&&
7788          "CHAPdomhosaddlists" &&&
7789          "Domain, host, and address lists"
7790 .scindex IIDdohoadli "lists of domains; hosts; etc."
7791 A number of Exim configuration options contain lists of domains, hosts,
7792 email addresses, or local parts. For example, the &%hold_domains%& option
7793 contains a list of domains whose delivery is currently suspended. These lists
7794 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7795 arguments to expansion conditions such as &%match_domain%&.
7796
7797 Each item in one of these lists is a pattern to be matched against a domain,
7798 host, email address, or local part, respectively. In the sections below, the
7799 different types of pattern for each case are described, but first we cover some
7800 general facilities that apply to all four kinds of list.
7801
7802 Note that other parts of Exim use a &'string list'& which does not
7803 support all the complexity available in
7804 domain, host, address and local part lists.
7805
7806
7807
7808 .section "Expansion of lists" "SECTlistexpand"
7809 .cindex "expansion" "of lists"
7810 Each list is expanded as a single string before it is used.
7811
7812 .new
7813 &'Exception: the router headers_remove option, where list-item
7814 splitting is done before string-expansion.'&
7815 .wen
7816
7817 The result of
7818 expansion must be a list, possibly containing empty items, which is split up
7819 into separate items for matching. By default, colon is the separator character,
7820 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7821 &<<SECTempitelis>>& for details of the list syntax; the second of these
7822 discusses the way to specify empty list items.
7823
7824
7825 If the string expansion is forced to fail, Exim behaves as if the item it is
7826 testing (domain, host, address, or local part) is not in the list. Other
7827 expansion failures cause temporary errors.
7828
7829 If an item in a list is a regular expression, backslashes, dollars and possibly
7830 other special characters in the expression must be protected against
7831 misinterpretation by the string expander. The easiest way to do this is to use
7832 the &`\N`& expansion feature to indicate that the contents of the regular
7833 expression should not be expanded. For example, in an ACL you might have:
7834 .code
7835 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7836                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7837 .endd
7838 The first item is a regular expression that is protected from expansion by
7839 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7840 senders based on the receiving domain.
7841
7842
7843
7844
7845 .section "Negated items in lists" "SECID76"
7846 .cindex "list" "negation"
7847 .cindex "negation" "in lists"
7848 Items in a list may be positive or negative. Negative items are indicated by a
7849 leading exclamation mark, which may be followed by optional white space. A list
7850 defines a set of items (domains, etc). When Exim processes one of these lists,
7851 it is trying to find out whether a domain, host, address, or local part
7852 (respectively) is in the set that is defined by the list. It works like this:
7853
7854 The list is scanned from left to right. If a positive item is matched, the
7855 subject that is being checked is in the set; if a negative item is matched, the
7856 subject is not in the set. If the end of the list is reached without the
7857 subject having matched any of the patterns, it is in the set if the last item
7858 was a negative one, but not if it was a positive one. For example, the list in
7859 .code
7860 domainlist relay_to_domains = !a.b.c : *.b.c
7861 .endd
7862 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7863 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7864 list is positive. However, if the setting were
7865 .code
7866 domainlist relay_to_domains = !a.b.c
7867 .endd
7868 then all domains other than &'a.b.c'& would match because the last item in the
7869 list is negative. In other words, a list that ends with a negative item behaves
7870 as if it had an extra item &`:*`& on the end.
7871
7872 Another way of thinking about positive and negative items in lists is to read
7873 the connector as &"or"& after a positive item and as &"and"& after a negative
7874 item.
7875
7876
7877
7878 .section "File names in lists" "SECTfilnamlis"
7879 .cindex "list" "file name in"
7880 If an item in a domain, host, address, or local part list is an absolute file
7881 name (beginning with a slash character), each line of the file is read and
7882 processed as if it were an independent item in the list, except that further
7883 file names are not allowed,
7884 and no expansion of the data from the file takes place.
7885 Empty lines in the file are ignored, and the file may also contain comment
7886 lines:
7887
7888 .ilist
7889 For domain and host lists, if a # character appears anywhere in a line of the
7890 file, it and all following characters are ignored.
7891 .next
7892 Because local parts may legitimately contain # characters, a comment in an
7893 address list or local part list file is recognized only if # is preceded by
7894 white space or the start of the line. For example:
7895 .code
7896 not#comment@x.y.z   # but this is a comment
7897 .endd
7898 .endlist
7899
7900 Putting a file name in a list has the same effect as inserting each line of the
7901 file as an item in the list (blank lines and comments excepted). However, there
7902 is one important difference: the file is read each time the list is processed,
7903 so if its contents vary over time, Exim's behaviour changes.
7904
7905 If a file name is preceded by an exclamation mark, the sense of any match
7906 within the file is inverted. For example, if
7907 .code
7908 hold_domains = !/etc/nohold-domains
7909 .endd
7910 and the file contains the lines
7911 .code
7912 !a.b.c
7913 *.b.c
7914 .endd
7915 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7916 any domain matching &`*.b.c`& is not.
7917
7918
7919
7920 .section "An lsearch file is not an out-of-line list" "SECID77"
7921 As will be described in the sections that follow, lookups can be used in lists
7922 to provide indexed methods of checking list membership. There has been some
7923 confusion about the way &(lsearch)& lookups work in lists. Because
7924 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7925 sometimes thought that it is allowed to contain wild cards and other kinds of
7926 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7927 always fixed strings, just as for any other single-key lookup type.
7928
7929 If you want to use a file to contain wild-card patterns that form part of a
7930 list, just give the file name on its own, without a search type, as described
7931 in the previous section. You could also use the &(wildlsearch)& or
7932 &(nwildlsearch)&, but there is no advantage in doing this.
7933
7934
7935
7936
7937 .section "Named lists" "SECTnamedlists"
7938 .cindex "named lists"
7939 .cindex "list" "named"
7940 A list of domains, hosts, email addresses, or local parts can be given a name
7941 which is then used to refer to the list elsewhere in the configuration. This is
7942 particularly convenient if the same list is required in several different
7943 places. It also allows lists to be given meaningful names, which can improve
7944 the readability of the configuration. For example, it is conventional to define
7945 a domain list called &'local_domains'& for all the domains that are handled
7946 locally on a host, using a configuration line such as
7947 .code
7948 domainlist local_domains = localhost:my.dom.example
7949 .endd
7950 Named lists are referenced by giving their name preceded by a plus sign, so,
7951 for example, a router that is intended to handle local domains would be
7952 configured with the line
7953 .code
7954 domains = +local_domains
7955 .endd
7956 The first router in a configuration is often one that handles all domains
7957 except the local ones, using a configuration with a negated item like this:
7958 .code
7959 dnslookup:
7960   driver = dnslookup
7961   domains = ! +local_domains
7962   transport = remote_smtp
7963   no_more
7964 .endd
7965 The four kinds of named list are created by configuration lines starting with
7966 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7967 respectively. Then there follows the name that you are defining, followed by an
7968 equals sign and the list itself. For example:
7969 .code
7970 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7971 addresslist bad_senders = cdb;/etc/badsenders
7972 .endd
7973 A named list may refer to other named lists:
7974 .code
7975 domainlist  dom1 = first.example : second.example
7976 domainlist  dom2 = +dom1 : third.example
7977 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7978 .endd
7979 &*Warning*&: If the last item in a referenced list is a negative one, the
7980 effect may not be what you intended, because the negation does not propagate
7981 out to the higher level. For example, consider:
7982 .code
7983 domainlist  dom1 = !a.b
7984 domainlist  dom2 = +dom1 : *.b
7985 .endd
7986 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7987 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7988 means it matches the second list as well. The effect is not the same as
7989 .code
7990 domainlist  dom2 = !a.b : *.b
7991 .endd
7992 where &'x.y'& does not match. It's best to avoid negation altogether in
7993 referenced lists if you can.
7994
7995 Named lists may have a performance advantage. When Exim is routing an
7996 address or checking an incoming message, it caches the result of tests on named
7997 lists. So, if you have a setting such as
7998 .code
7999 domains = +local_domains
8000 .endd
8001 on several of your routers
8002 or in several ACL statements,
8003 the actual test is done only for the first one. However, the caching works only
8004 if there are no expansions within the list itself or any sublists that it
8005 references. In other words, caching happens only for lists that are known to be
8006 the same each time they are referenced.
8007
8008 By default, there may be up to 16 named lists of each type. This limit can be
8009 extended by changing a compile-time variable. The use of domain and host lists
8010 is recommended for concepts such as local domains, relay domains, and relay
8011 hosts. The default configuration is set up like this.
8012
8013
8014
8015 .section "Named lists compared with macros" "SECID78"
8016 .cindex "list" "named compared with macro"
8017 .cindex "macro" "compared with named list"
8018 At first sight, named lists might seem to be no different from macros in the
8019 configuration file. However, macros are just textual substitutions. If you
8020 write
8021 .code
8022 ALIST = host1 : host2
8023 auth_advertise_hosts = !ALIST
8024 .endd
8025 it probably won't do what you want, because that is exactly the same as
8026 .code
8027 auth_advertise_hosts = !host1 : host2
8028 .endd
8029 Notice that the second host name is not negated. However, if you use a host
8030 list, and write
8031 .code
8032 hostlist alist = host1 : host2
8033 auth_advertise_hosts = ! +alist
8034 .endd
8035 the negation applies to the whole list, and so that is equivalent to
8036 .code
8037 auth_advertise_hosts = !host1 : !host2
8038 .endd
8039
8040
8041 .section "Named list caching" "SECID79"
8042 .cindex "list" "caching of named"
8043 .cindex "caching" "named lists"
8044 While processing a message, Exim caches the result of checking a named list if
8045 it is sure that the list is the same each time. In practice, this means that
8046 the cache operates only if the list contains no $ characters, which guarantees
8047 that it will not change when it is expanded. Sometimes, however, you may have
8048 an expanded list that you know will be the same each time within a given
8049 message. For example:
8050 .code
8051 domainlist special_domains = \
8052            ${lookup{$sender_host_address}cdb{/some/file}}
8053 .endd
8054 This provides a list of domains that depends only on the sending host's IP
8055 address. If this domain list is referenced a number of times (for example,
8056 in several ACL lines, or in several routers) the result of the check is not
8057 cached by default, because Exim does not know that it is going to be the
8058 same list each time.
8059
8060 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8061 cache the result anyway. For example:
8062 .code
8063 domainlist_cache special_domains = ${lookup{...
8064 .endd
8065 If you do this, you should be absolutely sure that caching is going to do
8066 the right thing in all cases. When in doubt, leave it out.
8067
8068
8069
8070 .section "Domain lists" "SECTdomainlist"
8071 .cindex "domain list" "patterns for"
8072 .cindex "list" "domain list"
8073 Domain lists contain patterns that are to be matched against a mail domain.
8074 The following types of item may appear in domain lists:
8075
8076 .ilist
8077 .cindex "primary host name"
8078 .cindex "host name" "matched in domain list"
8079 .oindex "&%primary_hostname%&"
8080 .cindex "domain list" "matching primary host name"
8081 .cindex "@ in a domain list"
8082 If a pattern consists of a single @ character, it matches the local host name,
8083 as set by the &%primary_hostname%& option (or defaulted). This makes it
8084 possible to use the same configuration file on several different hosts that
8085 differ only in their names.
8086 .next
8087 .cindex "@[] in a domain list"
8088 .cindex "domain list" "matching local IP interfaces"
8089 .cindex "domain literal"
8090 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8091 in square brackets (as in an email address that contains a domain literal), but
8092 only if that IP address is recognized as local for email routing purposes. The
8093 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8094 control which of a host's several IP addresses are treated as local.
8095 In today's Internet, the use of domain literals is controversial.
8096 .next
8097 .cindex "@mx_any"
8098 .cindex "@mx_primary"
8099 .cindex "@mx_secondary"
8100 .cindex "domain list" "matching MX pointers to local host"
8101 If a pattern consists of the string &`@mx_any`& it matches any domain that
8102 has an MX record pointing to the local host or to any host that is listed in
8103 .oindex "&%hosts_treat_as_local%&"
8104 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8105 are similar, except that the first matches only when a primary MX target is the
8106 local host, and the second only when no primary MX target is the local host,
8107 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8108 preference value &-- there may of course be more than one of them.
8109
8110 The MX lookup that takes place when matching a pattern of this type is
8111 performed with the resolver options for widening names turned off. Thus, for
8112 example, a single-component domain will &'not'& be expanded by adding the
8113 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8114 options of the &(dnslookup)& router for a discussion of domain widening.
8115
8116 Sometimes you may want to ignore certain IP addresses when using one of these
8117 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8118 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8119 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8120 on a router). For example:
8121 .code
8122 domains = @mx_any/ignore=127.0.0.1
8123 .endd
8124 This example matches any domain that has an MX record pointing to one of
8125 the local host's IP addresses other than 127.0.0.1.
8126
8127 The list of IP addresses is in fact processed by the same code that processes
8128 host lists, so it may contain CIDR-coded network specifications and it may also
8129 contain negative items.
8130
8131 Because the list of IP addresses is a sublist within a domain list, you have to
8132 be careful about delimiters if there is more than one address. Like any other
8133 list, the default delimiter can be changed. Thus, you might have:
8134 .code
8135 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8136           an.other.domain : ...
8137 .endd
8138 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8139 involved, it is easiest to change the delimiter for the main list as well:
8140 .code
8141 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8142           an.other.domain ? ...
8143 .endd
8144 .next
8145 .cindex "asterisk" "in domain list"
8146 .cindex "domain list" "asterisk in"
8147 .cindex "domain list" "matching &""ends with""&"
8148 If a pattern starts with an asterisk, the remaining characters of the pattern
8149 are compared with the terminating characters of the domain. The use of &"*"& in
8150 domain lists differs from its use in partial matching lookups. In a domain
8151 list, the character following the asterisk need not be a dot, whereas partial
8152 matching works only in terms of dot-separated components. For example, a domain
8153 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8154 &'cipher.key.ex'&.
8155
8156 .next
8157 .cindex "regular expressions" "in domain list"
8158 .cindex "domain list" "matching regular expression"
8159 If a pattern starts with a circumflex character, it is treated as a regular
8160 expression, and matched against the domain using a regular expression matching
8161 function. The circumflex is treated as part of the regular expression.
8162 Email domains are case-independent, so this regular expression match is by
8163 default case-independent, but you can make it case-dependent by starting it
8164 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8165 are given in chapter &<<CHAPregexp>>&.
8166
8167 &*Warning*&: Because domain lists are expanded before being processed, you
8168 must escape any backslash and dollar characters in the regular expression, or
8169 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8170 it is not to be expanded (unless you really do want to build a regular
8171 expression by expansion, of course).
8172 .next
8173 .cindex "lookup" "in domain list"
8174 .cindex "domain list" "matching by lookup"
8175 If a pattern starts with the name of a single-key lookup type followed by a
8176 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8177 must be a file name in a suitable format for the lookup type. For example, for
8178 &"cdb;"& it must be an absolute path:
8179 .code
8180 domains = cdb;/etc/mail/local_domains.cdb
8181 .endd
8182 The appropriate type of lookup is done on the file using the domain name as the
8183 key. In most cases, the data that is looked up is not used; Exim is interested
8184 only in whether or not the key is present in the file. However, when a lookup
8185 is used for the &%domains%& option on a router
8186 or a &%domains%& condition in an ACL statement, the data is preserved in the
8187 &$domain_data$& variable and can be referred to in other router options or
8188 other statements in the same ACL.
8189
8190 .next
8191 Any of the single-key lookup type names may be preceded by
8192 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8193 .code
8194 domains = partial-dbm;/partial/domains
8195 .endd
8196 This causes partial matching logic to be invoked; a description of how this
8197 works is given in section &<<SECTpartiallookup>>&.
8198
8199 .next
8200 .cindex "asterisk" "in lookup type"
8201 Any of the single-key lookup types may be followed by an asterisk. This causes
8202 a default lookup for a key consisting of a single asterisk to be done if the
8203 original lookup fails. This is not a useful feature when using a domain list to
8204 select particular domains (because any domain would match), but it might have
8205 value if the result of the lookup is being used via the &$domain_data$&
8206 expansion variable.
8207 .next
8208 If the pattern starts with the name of a query-style lookup type followed by a
8209 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8210 pattern must be an appropriate query for the lookup type, as described in
8211 chapter &<<CHAPfdlookup>>&. For example:
8212 .code
8213 hold_domains = mysql;select domain from holdlist \
8214   where domain = '${quote_mysql:$domain}';
8215 .endd
8216 In most cases, the data that is looked up is not used (so for an SQL query, for
8217 example, it doesn't matter what field you select). Exim is interested only in
8218 whether or not the query succeeds. However, when a lookup is used for the
8219 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8220 variable and can be referred to in other options.
8221 .next
8222 .cindex "domain list" "matching literal domain name"
8223 If none of the above cases apply, a caseless textual comparison is made
8224 between the pattern and the domain.
8225 .endlist
8226
8227 Here is an example that uses several different kinds of pattern:
8228 .code
8229 domainlist funny_domains = \
8230   @ : \
8231   lib.unseen.edu : \
8232   *.foundation.fict.example : \
8233   \N^[1-2]\d{3}\.fict\.example$\N : \
8234   partial-dbm;/opt/data/penguin/book : \
8235   nis;domains.byname : \
8236   nisplus;[name=$domain,status=local],domains.org_dir
8237 .endd
8238 There are obvious processing trade-offs among the various matching modes. Using
8239 an asterisk is faster than a regular expression, and listing a few names
8240 explicitly probably is too. The use of a file or database lookup is expensive,
8241 but may be the only option if hundreds of names are required. Because the
8242 patterns are tested in order, it makes sense to put the most commonly matched
8243 patterns earlier.
8244
8245
8246
8247 .section "Host lists" "SECThostlist"
8248 .cindex "host list" "patterns in"
8249 .cindex "list" "host list"
8250 Host lists are used to control what remote hosts are allowed to do. For
8251 example, some hosts may be allowed to use the local host as a relay, and some
8252 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8253 two different ways, by name or by IP address. In a host list, some types of
8254 pattern are matched to a host name, and some are matched to an IP address.
8255 You need to be particularly careful with this when single-key lookups are
8256 involved, to ensure that the right value is being used as the key.
8257
8258
8259 .section "Special host list patterns" "SECID80"
8260 .cindex "empty item in hosts list"
8261 .cindex "host list" "empty string in"
8262 If a host list item is the empty string, it matches only when no remote host is
8263 involved. This is the case when a message is being received from a local
8264 process using SMTP on the standard input, that is, when a TCP/IP connection is
8265 not used.
8266
8267 .cindex "asterisk" "in host list"
8268 The special pattern &"*"& in a host list matches any host or no host. Neither
8269 the IP address nor the name is actually inspected.
8270
8271
8272
8273 .section "Host list patterns that match by IP address" "SECThoslispatip"
8274 .cindex "host list" "matching IP addresses"
8275 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8276 the incoming address actually appears in the IPv6 host as
8277 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8278 list, it is converted into a traditional IPv4 address first. (Not all operating
8279 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8280 concerns.)
8281
8282 The following types of pattern in a host list check the remote host by
8283 inspecting its IP address:
8284
8285 .ilist
8286 If the pattern is a plain domain name (not a regular expression, not starting
8287 with *, not a lookup of any kind), Exim calls the operating system function
8288 to find the associated IP address(es). Exim uses the newer
8289 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8290 This typically causes a forward DNS lookup of the name. The result is compared
8291 with the IP address of the subject host.
8292
8293 If there is a temporary problem (such as a DNS timeout) with the host name
8294 lookup, a temporary error occurs. For example, if the list is being used in an
8295 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8296 temporary SMTP error code. If no IP address can be found for the host name,
8297 what happens is described in section &<<SECTbehipnot>>& below.
8298
8299 .next
8300 .cindex "@ in a host list"
8301 If the pattern is &"@"&, the primary host name is substituted and used as a
8302 domain name, as just described.
8303
8304 .next
8305 If the pattern is an IP address, it is matched against the IP address of the
8306 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8307 IPv6 addresses can be given in colon-separated format, but the colons have to
8308 be doubled so as not to be taken as item separators when the default list
8309 separator is used. IPv6 addresses are recognized even when Exim is compiled
8310 without IPv6 support. This means that if they appear in a host list on an
8311 IPv4-only host, Exim will not treat them as host names. They are just addresses
8312 that can never match a client host.
8313
8314 .next
8315 .cindex "@[] in a host list"
8316 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8317 the local host. For example, if the local host is an IPv4 host with one
8318 interface address 10.45.23.56, these two ACL statements have the same effect:
8319 .code
8320 accept hosts = 127.0.0.1 : 10.45.23.56
8321 accept hosts = @[]
8322 .endd
8323 .next
8324 .cindex "CIDR notation"
8325 If the pattern is an IP address followed by a slash and a mask length (for
8326 example 10.11.42.0/24), it is matched against the IP address of the subject
8327 host under the given mask. This allows, an entire network of hosts to be
8328 included (or excluded) by a single item. The mask uses CIDR notation; it
8329 specifies the number of address bits that must match, starting from the most
8330 significant end of the address.
8331
8332 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8333 of a range of addresses. It is the number of bits in the network portion of the
8334 address. The above example specifies a 24-bit netmask, so it matches all 256
8335 addresses in the 10.11.42.0 network. An item such as
8336 .code
8337 192.168.23.236/31
8338 .endd
8339 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8340 32 for an IPv4 address is the same as no mask at all; just a single address
8341 matches.
8342
8343 Here is another example which shows an IPv4 and an IPv6 network:
8344 .code
8345 recipient_unqualified_hosts = 192.168.0.0/16: \
8346                               3ffe::ffff::836f::::/48
8347 .endd
8348 The doubling of list separator characters applies only when these items
8349 appear inline in a host list. It is not required when indirecting via a file.
8350 For example:
8351 .code
8352 recipient_unqualified_hosts = /opt/exim/unqualnets
8353 .endd
8354 could make use of a file containing
8355 .code
8356 172.16.0.0/12
8357 3ffe:ffff:836f::/48
8358 .endd
8359 to have exactly the same effect as the previous example. When listing IPv6
8360 addresses inline, it is usually more convenient to use the facility for
8361 changing separator characters. This list contains the same two networks:
8362 .code
8363 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8364                                  3ffe:ffff:836f::/48
8365 .endd
8366 The separator is changed to semicolon by the leading &"<;"& at the start of the
8367 list.
8368 .endlist
8369
8370
8371
8372 .section "Host list patterns for single-key lookups by host address" &&&
8373          "SECThoslispatsikey"
8374 .cindex "host list" "lookup of IP address"
8375 When a host is to be identified by a single-key lookup of its complete IP
8376 address, the pattern takes this form:
8377 .display
8378 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8379 .endd
8380 For example:
8381 .code
8382 hosts_lookup = net-cdb;/hosts-by-ip.db
8383 .endd
8384 The text form of the IP address of the subject host is used as the lookup key.
8385 IPv6 addresses are converted to an unabbreviated form, using lower case
8386 letters, with dots as separators because colon is the key terminator in
8387 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8388 quoting the keys, but this is a facility that was added later.] The data
8389 returned by the lookup is not used.
8390
8391 .cindex "IP address" "masking"
8392 .cindex "host list" "masked IP address"
8393 Single-key lookups can also be performed using masked IP addresses, using
8394 patterns of this form:
8395 .display
8396 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8397 .endd
8398 For example:
8399 .code
8400 net24-dbm;/networks.db
8401 .endd
8402 The IP address of the subject host is masked using <&'number'&> as the mask
8403 length. A textual string is constructed from the masked value, followed by the
8404 mask, and this is used as the lookup key. For example, if the host's IP address
8405 is 192.168.34.6, the key that is looked up for the above example is
8406 &"192.168.34.0/24"&.
8407
8408 When an IPv6 address is converted to a string, dots are normally used instead
8409 of colons, so that keys in &(lsearch)& files need not contain colons (which
8410 terminate &(lsearch)& keys). This was implemented some time before the ability
8411 to quote keys was made available in &(lsearch)& files. However, the more
8412 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8413 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8414 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8415 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8416 addresses are always used.
8417
8418 Ideally, it would be nice to tidy up this anomalous situation by changing to
8419 colons in all cases, given that quoting is now available for &(lsearch)&.
8420 However, this would be an incompatible change that might break some existing
8421 configurations.
8422
8423 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8424 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8425 the former case the key strings include the mask value, whereas in the latter
8426 case the IP address is used on its own.
8427
8428
8429
8430 .section "Host list patterns that match by host name" "SECThoslispatnam"
8431 .cindex "host" "lookup failures"
8432 .cindex "unknown host name"
8433 .cindex "host list" "matching host name"
8434 There are several types of pattern that require Exim to know the name of the
8435 remote host. These are either wildcard patterns or lookups by name. (If a
8436 complete hostname is given without any wildcarding, it is used to find an IP
8437 address to match against, as described in section &<<SECThoslispatip>>&
8438 above.)
8439
8440 If the remote host name is not already known when Exim encounters one of these
8441 patterns, it has to be found from the IP address.
8442 Although many sites on the Internet are conscientious about maintaining reverse
8443 DNS data for their hosts, there are also many that do not do this.
8444 Consequently, a name cannot always be found, and this may lead to unwanted
8445 effects. Take care when configuring host lists with wildcarded name patterns.
8446 Consider what will happen if a name cannot be found.
8447
8448 Because of the problems of determining host names from IP addresses, matching
8449 against host names is not as common as matching against IP addresses.
8450
8451 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8452 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8453 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8454 are done can be changed by setting the &%host_lookup_order%& option. For
8455 security, once Exim has found one or more names, it looks up the IP addresses
8456 for these names and compares them with the IP address that it started with.
8457 Only those names whose IP addresses match are accepted. Any other names are
8458 discarded. If no names are left, Exim behaves as if the host name cannot be
8459 found. In the most common case there is only one name and one IP address.
8460
8461 There are some options that control what happens if a host name cannot be
8462 found. These are described in section &<<SECTbehipnot>>& below.
8463
8464 .cindex "host" "alias for"
8465 .cindex "alias for host"
8466 As a result of aliasing, hosts may have more than one name. When processing any
8467 of the following types of pattern, all the host's names are checked:
8468
8469 .ilist
8470 .cindex "asterisk" "in host list"
8471 If a pattern starts with &"*"& the remainder of the item must match the end of
8472 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8473 &'.b.c'&. This special simple form is provided because this is a very common
8474 requirement. Other kinds of wildcarding require the use of a regular
8475 expression.
8476 .next
8477 .cindex "regular expressions" "in host list"
8478 .cindex "host list" "regular expression in"
8479 If the item starts with &"^"& it is taken to be a regular expression which is
8480 matched against the host name. Host names are case-independent, so this regular
8481 expression match is by default case-independent, but you can make it
8482 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8483 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8484 example,
8485 .code
8486 ^(a|b)\.c\.d$
8487 .endd
8488 is a regular expression that matches either of the two hosts &'a.c.d'& or
8489 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8490 that backslash and dollar characters are not misinterpreted as part of the
8491 string expansion. The simplest way to do this is to use &`\N`& to mark that
8492 part of the string as non-expandable. For example:
8493 .code
8494 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8495 .endd
8496 &*Warning*&: If you want to match a complete host name, you must include the
8497 &`$`& terminating metacharacter in the regular expression, as in the above
8498 example. Without it, a match at the start of the host name is all that is
8499 required.
8500 .endlist
8501
8502
8503
8504
8505 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8506 .cindex "host" "lookup failures, permanent"
8507 While processing a host list, Exim may need to look up an IP address from a
8508 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8509 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8510 behaviour when it fails to find the information it is seeking is the same.
8511
8512 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8513 apply to temporary DNS errors, whose handling is described in the next section.
8514
8515 .cindex "&`+include_unknown`&"
8516 .cindex "&`+ignore_unknown`&"
8517 Exim parses a host list from left to right. If it encounters a permanent
8518 lookup failure in any item in the host list before it has found a match,
8519 Exim treats it as a failure and the default behavior is as if the host
8520 does not match the list. This may not always be what you want to happen.
8521 To change Exim's behaviour, the special items &`+include_unknown`& or
8522 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8523 not recognized in an indirected file).
8524
8525 .ilist
8526 If any item that follows &`+include_unknown`& requires information that
8527 cannot found, Exim behaves as if the host does match the list. For example,
8528 .code
8529 host_reject_connection = +include_unknown:*.enemy.ex
8530 .endd
8531 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8532 any hosts whose name it cannot find.
8533
8534 .next
8535 If any item that follows &`+ignore_unknown`& requires information that cannot
8536 be found, Exim ignores that item and proceeds to the rest of the list. For
8537 example:
8538 .code
8539 accept hosts = +ignore_unknown : friend.example : \
8540                192.168.4.5
8541 .endd
8542 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8543 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8544 name can be found for 192.168.4.5, it is rejected.
8545 .endlist
8546
8547 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8548 list. The effect of each one lasts until the next, or until the end of the
8549 list.
8550
8551 .section "Mixing wildcarded host names and addresses in host lists" &&&
8552          "SECTmixwilhos"
8553 .cindex "host list" "mixing names and addresses in"
8554
8555 This section explains the host/ip processing logic with the same concepts
8556 as the previous section, but specifically addresses what happens when a
8557 wildcarded hostname is one of the items in the hostlist.
8558
8559 .ilist
8560 If you have name lookups or wildcarded host names and
8561 IP addresses in the same host list, you should normally put the IP
8562 addresses first. For example, in an ACL you could have:
8563 .code
8564 accept hosts = 10.9.8.7 : *.friend.example
8565 .endd
8566 The reason you normally would order it this way lies in the
8567 left-to-right way that Exim processes lists.  It can test IP addresses
8568 without doing any DNS lookups, but when it reaches an item that requires
8569 a host name, it fails if it cannot find a host name to compare with the
8570 pattern. If the above list is given in the opposite order, the
8571 &%accept%& statement fails for a host whose name cannot be found, even
8572 if its IP address is 10.9.8.7.
8573
8574 .next
8575 If you really do want to do the name check first, and still recognize the IP
8576 address, you can rewrite the ACL like this:
8577 .code
8578 accept hosts = *.friend.example
8579 accept hosts = 10.9.8.7
8580 .endd
8581 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8582 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8583 &`+ignore_unknown`&, which was discussed in depth in the first example in
8584 this section.
8585 .endlist
8586
8587
8588 .section "Temporary DNS errors when looking up host information" &&&
8589          "SECTtemdnserr"
8590 .cindex "host" "lookup failures, temporary"
8591 .cindex "&`+include_defer`&"
8592 .cindex "&`+ignore_defer`&"
8593 A temporary DNS lookup failure normally causes a defer action (except when
8594 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8595 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8596 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8597 section. These options should be used with care, probably only in non-critical
8598 host lists such as whitelists.
8599
8600
8601
8602 .section "Host list patterns for single-key lookups by host name" &&&
8603          "SECThoslispatnamsk"
8604 .cindex "unknown host name"
8605 .cindex "host list" "matching host name"
8606 If a pattern is of the form
8607 .display
8608 <&'single-key-search-type'&>;<&'search-data'&>
8609 .endd
8610 for example
8611 .code
8612 dbm;/host/accept/list
8613 .endd
8614 a single-key lookup is performed, using the host name as its key. If the
8615 lookup succeeds, the host matches the item. The actual data that is looked up
8616 is not used.
8617
8618 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8619 keys in the file, not IP addresses. If you want to do lookups based on IP
8620 addresses, you must precede the search type with &"net-"& (see section
8621 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8622 two items in the same list, one doing an address lookup and one doing a name
8623 lookup, both using the same file.
8624
8625
8626
8627 .section "Host list patterns for query-style lookups" "SECID81"
8628 If a pattern is of the form
8629 .display
8630 <&'query-style-search-type'&>;<&'query'&>
8631 .endd
8632 the query is obeyed, and if it succeeds, the host matches the item. The actual
8633 data that is looked up is not used. The variables &$sender_host_address$& and
8634 &$sender_host_name$& can be used in the query. For example:
8635 .code
8636 hosts_lookup = pgsql;\
8637   select ip from hostlist where ip='$sender_host_address'
8638 .endd
8639 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8640 can use the &%sg%& expansion item to change this if you need to. If you want to
8641 use masked IP addresses in database queries, you can use the &%mask%& expansion
8642 operator.
8643
8644 If the query contains a reference to &$sender_host_name$&, Exim automatically
8645 looks up the host name if it has not already done so. (See section
8646 &<<SECThoslispatnam>>& for comments on finding host names.)
8647
8648 Historical note: prior to release 4.30, Exim would always attempt to find a
8649 host name before running the query, unless the search type was preceded by
8650 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8651 still recognized for query-style lookups, but its presence or absence has no
8652 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8653 See section &<<SECThoslispatsikey>>&.)
8654
8655
8656
8657
8658
8659 .section "Address lists" "SECTaddresslist"
8660 .cindex "list" "address list"
8661 .cindex "address list" "empty item"
8662 .cindex "address list" "patterns"
8663 Address lists contain patterns that are matched against mail addresses. There
8664 is one special case to be considered: the sender address of a bounce message is
8665 always empty. You can test for this by providing an empty item in an address
8666 list. For example, you can set up a router to process bounce messages by
8667 using this option setting:
8668 .code
8669 senders = :
8670 .endd
8671 The presence of the colon creates an empty item. If you do not provide any
8672 data, the list is empty and matches nothing. The empty sender can also be
8673 detected by a regular expression that matches an empty string,
8674 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8675
8676 Non-empty items in an address list can be straightforward email addresses. For
8677 example:
8678 .code
8679 senders = jbc@askone.example : hs@anacreon.example
8680 .endd
8681 A certain amount of wildcarding is permitted. If a pattern contains an @
8682 character, but is not a regular expression and does not begin with a
8683 semicolon-terminated lookup type (described below), the local part of the
8684 subject address is compared with the local part of the pattern, which may start
8685 with an asterisk. If the local parts match, the domain is checked in exactly
8686 the same way as for a pattern in a domain list. For example, the domain can be
8687 wildcarded, refer to a named list, or be a lookup:
8688 .code
8689 deny senders = *@*.spamming.site:\
8690                *@+hostile_domains:\
8691                bozo@partial-lsearch;/list/of/dodgy/sites:\
8692                *@dbm;/bad/domains.db
8693 .endd
8694 .cindex "local part" "starting with !"
8695 .cindex "address list" "local part starting with !"
8696 If a local part that begins with an exclamation mark is required, it has to be
8697 specified using a regular expression, because otherwise the exclamation mark is
8698 treated as a sign of negation, as is standard in lists.
8699
8700 If a non-empty pattern that is not a regular expression or a lookup does not
8701 contain an @ character, it is matched against the domain part of the subject
8702 address. The only two formats that are recognized this way are a literal
8703 domain, or a domain pattern that starts with *. In both these cases, the effect
8704 is the same as if &`*@`& preceded the pattern. For example:
8705 .code
8706 deny senders = enemy.domain : *.enemy.domain
8707 .endd
8708
8709 The following kinds of more complicated address list pattern can match any
8710 address, including the empty address that is characteristic of bounce message
8711 senders:
8712
8713 .ilist
8714 .cindex "regular expressions" "in address list"
8715 .cindex "address list" "regular expression in"
8716 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8717 done against the complete address, with the pattern as the regular expression.
8718 You must take care that backslash and dollar characters are not misinterpreted
8719 as part of the string expansion. The simplest way to do this is to use &`\N`&
8720 to mark that part of the string as non-expandable. For example:
8721 .code
8722 deny senders = \N^.*this.*@example\.com$\N : \
8723                \N^\d{8}.+@spamhaus.example$\N : ...
8724 .endd
8725 The &`\N`& sequences are removed by the expansion, so these items do indeed
8726 start with &"^"& by the time they are being interpreted as address patterns.
8727
8728 .next
8729 .cindex "address list" "lookup for complete address"
8730 Complete addresses can be looked up by using a pattern that starts with a
8731 lookup type terminated by a semicolon, followed by the data for the lookup. For
8732 example:
8733 .code
8734 deny senders = cdb;/etc/blocked.senders : \
8735   mysql;select address from blocked where \
8736   address='${quote_mysql:$sender_address}'
8737 .endd
8738 Both query-style and single-key lookup types can be used. For a single-key
8739 lookup type, Exim uses the complete address as the key. However, empty keys are
8740 not supported for single-key lookups, so a match against the empty address
8741 always fails. This restriction does not apply to query-style lookups.
8742
8743 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8744 cannot be used, and is ignored if specified, with an entry being written to the
8745 panic log.
8746 .cindex "*@ with single-key lookup"
8747 However, you can configure lookup defaults, as described in section
8748 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8749 default. For example, with this lookup:
8750 .code
8751 accept senders = lsearch*@;/some/file
8752 .endd
8753 the file could contains lines like this:
8754 .code
8755 user1@domain1.example
8756 *@domain2.example
8757 .endd
8758 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8759 that are tried is:
8760 .code
8761 nimrod@jaeger.example
8762 *@jaeger.example
8763 *
8764 .endd
8765 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8766 would mean that every address matches, thus rendering the test useless.
8767
8768 &*Warning 2*&: Do not confuse these two kinds of item:
8769 .code
8770 deny recipients = dbm*@;/some/file
8771 deny recipients = *@dbm;/some/file
8772 .endd
8773 The first does a whole address lookup, with defaulting, as just described,
8774 because it starts with a lookup type. The second matches the local part and
8775 domain independently, as described in a bullet point below.
8776 .endlist
8777
8778
8779 The following kinds of address list pattern can match only non-empty addresses.
8780 If the subject address is empty, a match against any of these pattern types
8781 always fails.
8782
8783
8784 .ilist
8785 .cindex "@@ with single-key lookup"
8786 .cindex "address list" "@@ lookup type"
8787 .cindex "address list" "split local part and domain"
8788 If a pattern starts with &"@@"& followed by a single-key lookup item
8789 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8790 split into a local part and a domain. The domain is looked up in the file. If
8791 it is not found, there is no match. If it is found, the data that is looked up
8792 from the file is treated as a colon-separated list of local part patterns, each
8793 of which is matched against the subject local part in turn.
8794
8795 .cindex "asterisk" "in address list"
8796 The lookup may be a partial one, and/or one involving a search for a default
8797 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8798 patterns that are looked up can be regular expressions or begin with &"*"&, or
8799 even be further lookups. They may also be independently negated. For example,
8800 with
8801 .code
8802 deny senders = @@dbm;/etc/reject-by-domain
8803 .endd
8804 the data from which the DBM file is built could contain lines like
8805 .code
8806 baddomain.com:  !postmaster : *
8807 .endd
8808 to reject all senders except &%postmaster%& from that domain.
8809
8810 .cindex "local part" "starting with !"
8811 If a local part that actually begins with an exclamation mark is required, it
8812 has to be specified using a regular expression. In &(lsearch)& files, an entry
8813 may be split over several lines by indenting the second and subsequent lines,
8814 but the separating colon must still be included at line breaks. White space
8815 surrounding the colons is ignored. For example:
8816 .code
8817 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8818   spammer3 : spammer4
8819 .endd
8820 As in all colon-separated lists in Exim, a colon can be included in an item by
8821 doubling.
8822
8823 If the last item in the list starts with a right angle-bracket, the remainder
8824 of the item is taken as a new key to look up in order to obtain a continuation
8825 list of local parts. The new key can be any sequence of characters. Thus one
8826 might have entries like
8827 .code
8828 aol.com: spammer1 : spammer 2 : >*
8829 xyz.com: spammer3 : >*
8830 *:       ^\d{8}$
8831 .endd
8832 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8833 local parts for all domains, in addition to the specific local parts listed for
8834 each domain. Of course, using this feature costs another lookup each time a
8835 chain is followed, but the effort needed to maintain the data is reduced.
8836
8837 .cindex "loop" "in lookups"
8838 It is possible to construct loops using this facility, and in order to catch
8839 them, the chains may be no more than fifty items long.
8840
8841 .next
8842 The @@<&'lookup'&> style of item can also be used with a query-style
8843 lookup, but in this case, the chaining facility is not available. The lookup
8844 can only return a single list of local parts.
8845 .endlist
8846
8847 &*Warning*&: There is an important difference between the address list items
8848 in these two examples:
8849 .code
8850 senders = +my_list
8851 senders = *@+my_list
8852 .endd
8853 In the first one, &`my_list`& is a named address list, whereas in the second
8854 example it is a named domain list.
8855
8856
8857
8858
8859 .section "Case of letters in address lists" "SECTcasletadd"
8860 .cindex "case of local parts"
8861 .cindex "address list" "case forcing"
8862 .cindex "case forcing in address lists"
8863 Domains in email addresses are always handled caselessly, but for local parts
8864 case may be significant on some systems (see &%caseful_local_part%& for how
8865 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8866 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8867 blocking lists should be done in a case-independent manner. Since most address
8868 lists in Exim are used for this kind of control, Exim attempts to do this by
8869 default.
8870
8871 The domain portion of an address is always lowercased before matching it to an
8872 address list. The local part is lowercased by default, and any string
8873 comparisons that take place are done caselessly. This means that the data in
8874 the address list itself, in files included as plain file names, and in any file
8875 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8876 keys in files that are looked up by a search type other than &(lsearch)& (which
8877 works caselessly) must be in lower case, because these lookups are not
8878 case-independent.
8879
8880 .cindex "&`+caseful`&"
8881 To allow for the possibility of caseful address list matching, if an item in
8882 an address list is the string &"+caseful"&, the original case of the local
8883 part is restored for any comparisons that follow, and string comparisons are no
8884 longer case-independent. This does not affect the domain, which remains in
8885 lower case. However, although independent matches on the domain alone are still
8886 performed caselessly, regular expressions that match against an entire address
8887 become case-sensitive after &"+caseful"& has been seen.
8888
8889
8890
8891 .section "Local part lists" "SECTlocparlis"
8892 .cindex "list" "local part list"
8893 .cindex "local part" "list"
8894 Case-sensitivity in local part lists is handled in the same way as for address
8895 lists, as just described. The &"+caseful"& item can be used if required. In a
8896 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8897 set false, the subject is lowercased and the matching is initially
8898 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8899 matching in the local part list, but not elsewhere in the router. If
8900 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8901 option is case-sensitive from the start.
8902
8903 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8904 comments are handled in the same way as address lists &-- they are recognized
8905 only if the # is preceded by white space or the start of the line.
8906 Otherwise, local part lists are matched in the same way as domain lists, except
8907 that the special items that refer to the local host (&`@`&, &`@[]`&,
8908 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8909 Refer to section &<<SECTdomainlist>>& for details of the other available item
8910 types.
8911 .ecindex IIDdohoadli
8912
8913
8914
8915
8916 . ////////////////////////////////////////////////////////////////////////////
8917 . ////////////////////////////////////////////////////////////////////////////
8918
8919 .chapter "String expansions" "CHAPexpand"
8920 .scindex IIDstrexp "expansion" "of strings"
8921 Many strings in Exim's run time configuration are expanded before use. Some of
8922 them are expanded every time they are used; others are expanded only once.
8923
8924 When a string is being expanded it is copied verbatim from left to right except
8925 when a dollar or backslash character is encountered. A dollar specifies the
8926 start of a portion of the string that is interpreted and replaced as described
8927 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8928 escape character, as described in the following section.
8929
8930 Whether a string is expanded depends upon the context.  Usually this is solely
8931 dependent upon the option for which a value is sought; in this documentation,
8932 options for which string expansion is performed are marked with &dagger; after
8933 the data type.  ACL rules always expand strings.  A couple of expansion
8934 conditions do not expand some of the brace-delimited branches, for security
8935 reasons.
8936
8937
8938
8939 .section "Literal text in expanded strings" "SECTlittext"
8940 .cindex "expansion" "including literal text"
8941 An uninterpreted dollar can be included in an expanded string by putting a
8942 backslash in front of it. A backslash can be used to prevent any special
8943 character being treated specially in an expansion, including backslash itself.
8944 If the string appears in quotes in the configuration file, two backslashes are
8945 required because the quotes themselves cause interpretation of backslashes when
8946 the string is read in (see section &<<SECTstrings>>&).
8947
8948 .cindex "expansion" "non-expandable substrings"
8949 A portion of the string can specified as non-expandable by placing it between
8950 two occurrences of &`\N`&. This is particularly useful for protecting regular
8951 expressions, which often contain backslashes and dollar signs. For example:
8952 .code
8953 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8954 .endd
8955 On encountering the first &`\N`&, the expander copies subsequent characters
8956 without interpretation until it reaches the next &`\N`& or the end of the
8957 string.
8958
8959
8960
8961 .section "Character escape sequences in expanded strings" "SECID82"
8962 .cindex "expansion" "escape sequences"
8963 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8964 expanded string is recognized as an escape sequence for the character newline,
8965 carriage return, or tab, respectively. A backslash followed by up to three
8966 octal digits is recognized as an octal encoding for a single character, and a
8967 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8968 encoding.
8969
8970 These escape sequences are also recognized in quoted strings when they are read
8971 in. Their interpretation in expansions as well is useful for unquoted strings,
8972 and for other cases such as looked-up strings that are then expanded.
8973
8974
8975 .section "Testing string expansions" "SECID83"
8976 .cindex "expansion" "testing"
8977 .cindex "testing" "string expansion"
8978 .oindex "&%-be%&"
8979 Many expansions can be tested by calling Exim with the &%-be%& option. This
8980 takes the command arguments, or lines from the standard input if there are no
8981 arguments, runs them through the string expansion code, and writes the results
8982 to the standard output. Variables based on configuration values are set up, but
8983 since no message is being processed, variables such as &$local_part$& have no
8984 value. Nevertheless the &%-be%& option can be useful for checking out file and
8985 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8986 and &%nhash%&.
8987
8988 Exim gives up its root privilege when it is called with the &%-be%& option, and
8989 instead runs under the uid and gid it was called with, to prevent users from
8990 using &%-be%& for reading files to which they do not have access.
8991
8992 .oindex "&%-bem%&"
8993 If you want to test expansions that include variables whose values are taken
8994 from a message, there are two other options that can be used. The &%-bem%&
8995 option is like &%-be%& except that it is followed by a file name. The file is
8996 read as a message before doing the test expansions. For example:
8997 .code
8998 exim -bem /tmp/test.message '$h_subject:'
8999 .endd
9000 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9001 Exim message identifier. For example:
9002 .code
9003 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9004 .endd
9005 This loads the message from Exim's spool before doing the test expansions, and
9006 is therefore restricted to admin users.
9007
9008
9009 .section "Forced expansion failure" "SECTforexpfai"
9010 .cindex "expansion" "forced failure"
9011 A number of expansions that are described in the following section have
9012 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9013 (which are sometimes called &"curly brackets"&). Which of the two strings is
9014 used depends on some condition that is evaluated as part of the expansion. If,
9015 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9016 the entire string expansion fails in a way that can be detected by the code
9017 that requested the expansion. This is called &"forced expansion failure"&, and
9018 its consequences depend on the circumstances. In some cases it is no different
9019 from any other expansion failure, but in others a different action may be
9020 taken. Such variations are mentioned in the documentation of the option that is
9021 being expanded.
9022
9023
9024
9025
9026 .section "Expansion items" "SECTexpansionitems"
9027 The following items are recognized in expanded strings. White space may be used
9028 between sub-items that are keywords or substrings enclosed in braces inside an
9029 outer set of braces, to improve readability. &*Warning*&: Within braces,
9030 white space is significant.
9031
9032 .vlist
9033 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9034 .cindex "expansion" "variables"
9035 Substitute the contents of the named variable, for example:
9036 .code
9037 $local_part
9038 ${domain}
9039 .endd
9040 The second form can be used to separate the name from subsequent alphanumeric
9041 characters. This form (using braces) is available only for variables; it does
9042 &'not'& apply to message headers. The names of the variables are given in
9043 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9044 given, the expansion fails.
9045
9046 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9047 .cindex "expansion" "operators"
9048 The string is first itself expanded, and then the operation specified by
9049 <&'op'&> is applied to it. For example:
9050 .code
9051 ${lc:$local_part}
9052 .endd
9053 The string starts with the first character after the colon, which may be
9054 leading white space. A list of operators is given in section &<<SECTexpop>>&
9055 below. The operator notation is used for simple expansion items that have just
9056 one argument, because it reduces the number of braces and therefore makes the
9057 string easier to understand.
9058
9059 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9060 This item inserts &"basic"& header lines. It is described with the &%header%&
9061 expansion item below.
9062
9063
9064 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9065 .cindex "expansion" "calling an acl"
9066 .cindex "&%acl%&" "call from expansion"
9067 The name and zero to nine argument strings are first expanded separately.  The expanded
9068 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9069 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9070 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9071 and may use the variables; if another acl expansion is used the values
9072 are restored after it returns.  If the ACL sets
9073 a value using a "message =" modifier and returns accept or deny, the value becomes
9074 the result of the expansion.
9075 If no message is set and the ACL returns accept or deny
9076 the expansion result is an empty string.
9077 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9078
9079
9080 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9081        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9082 .cindex "expansion" "extracting cerificate fields"
9083 .cindex "&%certextract%&" "certificate fields"
9084 .cindex "certificate" "extracting fields"
9085 The <&'certificate'&> must be a variable of type certificate.
9086 The field name is expanded and used to retrieve the relevant field from
9087 the certificate.  Supported fields are:
9088 .display
9089 &`version        `&
9090 &`serial_number  `&
9091 &`subject        `& RFC4514 DN
9092 &`issuer         `& RFC4514 DN
9093 &`notbefore      `& time
9094 &`notafter       `& time
9095 &`sig_algorithm  `&
9096 &`signature      `&
9097 &`subj_altname   `& tagged list
9098 &`ocsp_uri       `& list
9099 &`crl_uri        `& list
9100 .endd
9101 If the field is found,
9102 <&'string2'&> is expanded, and replaces the whole item;
9103 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9104 variable &$value$& contains the value that has been extracted. Afterwards, it
9105 is restored to any previous value it might have had.
9106
9107 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9108 key is not found. If {<&'string2'&>} is also omitted, the value that was
9109 extracted is used.
9110
9111 Some field names take optional modifiers, appended and separated by commas.
9112
9113 The field selectors marked as "RFC4514" above
9114 output a Distinguished Name string which is
9115 not quite
9116 parseable by Exim as a comma-separated tagged list
9117 (the exceptions being elements containing commas).
9118 RDN elements of a single type may be selected by
9119 a modifier of the type label; if so the expansion
9120 result is a list (newline-separated by default).
9121 The separator may be changed by another modifier of
9122 a right angle-bracket followed immediately by the new separator.
9123 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9124
9125 The field selectors marked as "time" above
9126 take an optional modifier of "int"
9127 for which the result is the number of seconds since epoch.
9128 Otherwise the result is a human-readable string
9129 in the timezone selected by the main "timezone" option.
9130
9131 The field selectors marked as "list" above return a list,
9132 newline-separated by default,
9133 (embedded separator characters in elements are doubled).
9134 The separator may be changed by a modifier of
9135 a right angle-bracket followed immediately by the new separator.
9136
9137 The field selectors marked as "tagged" above
9138 prefix each list element with a type string and an equals sign.
9139 Elements of only one type may be selected by a modifier
9140 which is one of "dns", "uri" or "mail";
9141 if so the element tags are omitted.
9142
9143 If not otherwise noted field values are presented in human-readable form.
9144
9145 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9146        {*&<&'arg'&>&*}...}*&"
9147 .cindex &%dlfunc%&
9148 This expansion dynamically loads and then calls a locally-written C function.
9149 This functionality is available only if Exim is compiled with
9150 .code
9151 EXPAND_DLFUNC=yes
9152 .endd
9153 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9154 object so that it doesn't reload the same object file in the same Exim process
9155 (but of course Exim does start new processes frequently).
9156
9157 There may be from zero to eight arguments to the function. When compiling
9158 a local function that is to be called in this way, &_local_scan.h_& should be
9159 included. The Exim variables and functions that are defined by that API
9160 are also available for dynamically loaded functions. The function itself
9161 must have the following type:
9162 .code
9163 int dlfunction(uschar **yield, int argc, uschar *argv[])
9164 .endd
9165 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9166 function should return one of the following values:
9167
9168 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9169 into the expanded string that is being built.
9170
9171 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9172 from &'yield'&, if it is set.
9173
9174 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9175 taken from &'yield'& if it is set.
9176
9177 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9178
9179 When compiling a function that is to be used in this way with gcc,
9180 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9181 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9182
9183
9184 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9185 .cindex "expansion" "extracting value from environment"
9186 .cindex "environment" "values from"
9187 The key is first expanded separately, and leading and trailing white space
9188 removed.
9189 This is then searched for as a name in the environment.
9190 If a variable is found then its value is placed in &$value$&
9191 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9192
9193 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9194 appear, for example:
9195 .code
9196 ${env{USER}{$value} fail }
9197 .endd
9198 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9199 {<&'string1'&>} must be present for &"fail"& to be recognized.
9200
9201 If {<&'string2'&>} is omitted an empty string is substituted on
9202 search failure.
9203 If {<&'string1'&>} is omitted the search result is substituted on
9204 search success.
9205
9206 The environment is adjusted by the &%keep_environment%& and
9207 &%add_environment%& main section options.
9208
9209
9210 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9211        {*&<&'string3'&>&*}}*&"
9212 .cindex "expansion" "extracting substrings by key"
9213 .cindex "&%extract%&" "substrings by key"
9214 The key and <&'string1'&> are first expanded separately. Leading and trailing
9215 white space is removed from the key (but not from any of the strings). The key
9216 must not be empty and must not consist entirely of digits.
9217 The expanded <&'string1'&> must be of the form:
9218 .display
9219 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9220 .endd
9221 .vindex "&$value$&"
9222 where the equals signs and spaces (but not both) are optional. If any of the
9223 values contain white space, they must be enclosed in double quotes, and any
9224 values that are enclosed in double quotes are subject to escape processing as
9225 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9226 for the value that corresponds to the key. The search is case-insensitive. If
9227 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9228 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9229 variable &$value$& contains the value that has been extracted. Afterwards, it
9230 is restored to any previous value it might have had.
9231
9232 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9233 key is not found. If {<&'string2'&>} is also omitted, the value that was
9234 extracted is used. Thus, for example, these two expansions are identical, and
9235 yield &"2001"&:
9236 .code
9237 ${extract{gid}{uid=1984 gid=2001}}
9238 ${extract{gid}{uid=1984 gid=2001}{$value}}
9239 .endd
9240 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9241 appear, for example:
9242 .code
9243 ${extract{Z}{A=... B=...}{$value} fail }
9244 .endd
9245 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9246 {<&'string2'&>} must be present for &"fail"& to be recognized.
9247
9248
9249 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9250         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9251 .cindex "expansion" "extracting substrings by number"
9252 .cindex "&%extract%&" "substrings by number"
9253 The <&'number'&> argument must consist entirely of decimal digits,
9254 apart from leading and trailing white space, which is ignored.
9255 This is what distinguishes this form of &%extract%& from the previous kind. It
9256 behaves in the same way, except that, instead of extracting a named field, it
9257 extracts from <&'string1'&> the field whose number is given as the first
9258 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9259 <&'string3'&> as before.
9260
9261 The fields in the string are separated by any one of the characters in the
9262 separator string. These may include space or tab characters.
9263 The first field is numbered one. If the number is negative, the fields are
9264 counted from the end of the string, with the rightmost one numbered -1. If the
9265 number given is zero, the entire string is returned. If the modulus of the
9266 number is greater than the number of fields in the string, the result is the
9267 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9268 provided. For example:
9269 .code
9270 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9271 .endd
9272 yields &"42"&, and
9273 .code
9274 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9275 .endd
9276 yields &"99"&. Two successive separators mean that the field between them is
9277 empty (for example, the fifth field above).
9278
9279
9280 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9281 .cindex "list" "selecting by condition"
9282 .cindex "expansion" "selecting from list by condition"
9283 .vindex "&$item$&"
9284 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9285 default, but the separator can be changed in the usual way. For each item
9286 in this list, its value is place in &$item$&, and then the condition is
9287 evaluated. If the condition is true, &$item$& is added to the output as an
9288 item in a new list; if the condition is false, the item is discarded. The
9289 separator used for the output list is the same as the one used for the
9290 input, but a separator setting is not included in the output. For example:
9291 .code
9292 ${filter{a:b:c}{!eq{$item}{b}}
9293 .endd
9294 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9295 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9296
9297
9298 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9299 .cindex "hash function" "textual"
9300 .cindex "expansion" "textual hash"
9301 This is a textual hashing function, and was the first to be implemented in
9302 early versions of Exim. In current releases, there are other hashing functions
9303 (numeric, MD5, and SHA-1), which are described below.
9304
9305 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9306 <&'n'&>. If you are using fixed values for these numbers, that is, if
9307 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9308 use the simpler operator notation that avoids some of the braces:
9309 .code
9310 ${hash_<n>_<m>:<string>}
9311 .endd
9312 The second number is optional (in both notations). If <&'n'&> is greater than
9313 or equal to the length of the string, the expansion item returns the string.
9314 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9315 function to the string. The new string consists of characters taken from the
9316 first <&'m'&> characters of the string
9317 .code
9318 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9319 .endd
9320 If <&'m'&> is not present the value 26 is used, so that only lower case
9321 letters appear. For example:
9322 .display
9323 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9324 &`$hash{5}{monty}}           `&   yields  &`monty`&
9325 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9326 .endd
9327
9328 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9329         &*$h_*&<&'header&~name'&>&*:*&" &&&
9330        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9331         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9332        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9333         &*$rh_*&<&'header&~name'&>&*:*&"
9334 .cindex "expansion" "header insertion"
9335 .vindex "&$header_$&"
9336 .vindex "&$bheader_$&"
9337 .vindex "&$rheader_$&"
9338 .cindex "header lines" "in expansion strings"
9339 .cindex "header lines" "character sets"
9340 .cindex "header lines" "decoding"
9341 Substitute the contents of the named message header line, for example
9342 .code
9343 $header_reply-to:
9344 .endd
9345 The newline that terminates a header line is not included in the expansion, but
9346 internal newlines (caused by splitting the header line over several physical
9347 lines) may be present.
9348
9349 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9350 the data in the header line is interpreted.
9351
9352 .ilist
9353 .cindex "white space" "in header lines"
9354 &%rheader%& gives the original &"raw"& content of the header line, with no
9355 processing at all, and without the removal of leading and trailing white space.
9356
9357 .next
9358 .cindex "base64 encoding" "in header lines"
9359 &%bheader%& removes leading and trailing white space, and then decodes base64
9360 or quoted-printable MIME &"words"& within the header text, but does no
9361 character set translation. If decoding of what looks superficially like a MIME
9362 &"word"& fails, the raw string is returned. If decoding
9363 .cindex "binary zero" "in header line"
9364 produces a binary zero character, it is replaced by a question mark &-- this is
9365 what Exim does for binary zeros that are actually received in header lines.
9366
9367 .next
9368 &%header%& tries to translate the string as decoded by &%bheader%& to a
9369 standard character set. This is an attempt to produce the same string as would
9370 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9371 returned. Translation is attempted only on operating systems that support the
9372 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9373 a system Makefile or in &_Local/Makefile_&.
9374 .endlist ilist
9375
9376 In a filter file, the target character set for &%header%& can be specified by a
9377 command of the following form:
9378 .code
9379 headers charset "UTF-8"
9380 .endd
9381 This command affects all references to &$h_$& (or &$header_$&) expansions in
9382 subsequently obeyed filter commands. In the absence of this command, the target
9383 character set in a filter is taken from the setting of the &%headers_charset%&
9384 option in the runtime configuration. The value of this option defaults to the
9385 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9386 ISO-8859-1.
9387
9388 Header names follow the syntax of RFC 2822, which states that they may contain
9389 any printing characters except space and colon. Consequently, curly brackets
9390 &'do not'& terminate header names, and should not be used to enclose them as
9391 if they were variables. Attempting to do so causes a syntax error.
9392
9393 Only header lines that are common to all copies of a message are visible to
9394 this mechanism. These are the original header lines that are received with the
9395 message, and any that are added by an ACL statement or by a system
9396 filter. Header lines that are added to a particular copy of a message by a
9397 router or transport are not accessible.
9398
9399 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9400 before the DATA ACL, because the header structure is not set up until the
9401 message is received. Header lines that are added in a RCPT ACL (for example)
9402 are saved until the message's incoming header lines are available, at which
9403 point they are added. When a DATA ACL is running, however, header lines added
9404 by earlier ACLs are visible.
9405
9406 Upper case and lower case letters are synonymous in header names. If the
9407 following character is white space, the terminating colon may be omitted, but
9408 this is not recommended, because you may then forget it when it is needed. When
9409 white space terminates the header name, this white space is included in the
9410 expanded string.  If the message does not contain the given header, the
9411 expansion item is replaced by an empty string. (See the &%def%& condition in
9412 section &<<SECTexpcond>>& for a means of testing for the existence of a
9413 header.)
9414
9415 If there is more than one header with the same name, they are all concatenated
9416 to form the substitution string, up to a maximum length of 64K. Unless
9417 &%rheader%& is being used, leading and trailing white space is removed from
9418 each header before concatenation, and a completely empty header is ignored. A
9419 newline character is then inserted between non-empty headers, but there is no
9420 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9421 those headers that contain lists of addresses, a comma is also inserted at the
9422 junctions between headers. This does not happen for the &%rheader%& expansion.
9423
9424
9425 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9426 .cindex "expansion" "hmac hashing"
9427 .cindex &%hmac%&
9428 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9429 shared secret and some text into a message authentication code, as specified in
9430 RFC 2104. This differs from &`${md5:secret_text...}`& or
9431 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9432 cryptographic hash, allowing for authentication that is not possible with MD5
9433 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9434 present. For example:
9435 .code
9436 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9437 .endd
9438 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9439 produces:
9440 .code
9441 dd97e3ba5d1a61b5006108f8c8252953
9442 .endd
9443 As an example of how this might be used, you might put in the main part of
9444 an Exim configuration:
9445 .code
9446 SPAMSCAN_SECRET=cohgheeLei2thahw
9447 .endd
9448 In a router or a transport you could then have:
9449 .code
9450 headers_add = \
9451   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9452   ${hmac{md5}{SPAMSCAN_SECRET}\
9453   {${primary_hostname},${message_exim_id},$h_message-id:}}
9454 .endd
9455 Then given a message, you can check where it was scanned by looking at the
9456 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9457 this header line is authentic by recomputing the authentication code from the
9458 host name, message ID and the &'Message-id:'& header line. This can be done
9459 using Exim's &%-be%& option, or by other means, for example by using the
9460 &'hmac_md5_hex()'& function in Perl.
9461
9462
9463 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9464 .cindex "expansion" "conditional"
9465 .cindex "&%if%&, expansion item"
9466 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9467 item; otherwise <&'string2'&> is used. The available conditions are described
9468 in section &<<SECTexpcond>>& below. For example:
9469 .code
9470 ${if eq {$local_part}{postmaster} {yes}{no} }
9471 .endd
9472 The second string need not be present; if it is not and the condition is not
9473 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9474 be present instead of the second string (without any curly brackets). In this
9475 case, the expansion is forced to fail if the condition is not true (see section
9476 &<<SECTforexpfai>>&).
9477
9478 If both strings are omitted, the result is the string &`true`& if the condition
9479 is true, and the empty string if the condition is false. This makes it less
9480 cumbersome to write custom ACL and router conditions. For example, instead of
9481 .code
9482 condition = ${if >{$acl_m4}{3}{true}{false}}
9483 .endd
9484 you can use
9485 .code
9486 condition = ${if >{$acl_m4}{3}}
9487 .endd
9488
9489
9490
9491 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9492 .cindex expansion "imap folder"
9493 .cindex "&%imapfolder%& expansion item"
9494 This item converts a (possibly multilevel, or with non-ASCII characters)
9495 folder specification to a Maildir name for filesystem use.
9496 For information on internationalisation support see &<<SECTi18nMDA>>&.
9497
9498
9499
9500 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9501 .cindex "expansion" "string truncation"
9502 .cindex "&%length%& expansion item"
9503 The &%length%& item is used to extract the initial portion of a string. Both
9504 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9505 you are using a fixed value for the number, that is, if <&'string1'&> does not
9506 change when expanded, you can use the simpler operator notation that avoids
9507 some of the braces:
9508 .code
9509 ${length_<n>:<string>}
9510 .endd
9511 The result of this item is either the first <&'n'&> characters or the whole
9512 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9513 &%strlen%&, which gives the length of a string.
9514
9515
9516 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9517         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9518 .cindex "expansion" "extracting list elements by number"
9519 .cindex "&%listextract%&" "extract list elements by number"
9520 .cindex "list" "extracting elements by number"
9521 The <&'number'&> argument must consist entirely of decimal digits,
9522 apart from an optional leading minus,
9523 and leading and trailing white space (which is ignored).
9524
9525 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9526 default, but the separator can be changed in the usual way.
9527
9528 The first field of the list is numbered one.
9529 If the number is negative, the fields are
9530 counted from the end of the list, with the rightmost one numbered -1.
9531 The numbered element of the list is extracted and placed in &$value$&,
9532 then <&'string2'&> is expanded as the result.
9533
9534 If the modulus of the
9535 number is zero or greater than the number of fields in the string,
9536 the result is the expansion of <&'string3'&>.
9537
9538 For example:
9539 .code
9540 ${listextract{2}{x:42:99}}
9541 .endd
9542 yields &"42"&, and
9543 .code
9544 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9545 .endd
9546 yields &"result: 42"&.
9547
9548 If {<&'string3'&>} is omitted, an empty string is used for string3.
9549 If {<&'string2'&>} is also omitted, the value that was
9550 extracted is used.
9551 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9552
9553
9554 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9555         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9556 This is the first of one of two different types of lookup item, which are both
9557 described in the next item.
9558
9559 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9560         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9561 .cindex "expansion" "lookup in"
9562 .cindex "file" "lookups"
9563 .cindex "lookup" "in expanded string"
9564 The two forms of lookup item specify data lookups in files and databases, as
9565 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9566 lookups, and the second is used for query-style lookups. The <&'key'&>,
9567 <&'file'&>, and <&'query'&> strings are expanded before use.
9568
9569 If there is any white space in a lookup item which is part of a filter command,
9570 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9571 other place where white space is significant, the lookup item must be enclosed
9572 in double quotes. The use of data lookups in users' filter files may be locked
9573 out by the system administrator.
9574
9575 .vindex "&$value$&"
9576 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9577 During its expansion, the variable &$value$& contains the data returned by the
9578 lookup. Afterwards it reverts to the value it had previously (at the outer
9579 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9580 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9581 string on failure. If <&'string2'&> is provided, it can itself be a nested
9582 lookup, thus providing a mechanism for looking up a default value when the
9583 original lookup fails.
9584
9585 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9586 data for the outer lookup while the parameters of the second lookup are
9587 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9588 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9589 appear, and in this case, if the lookup fails, the entire expansion is forced
9590 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9591 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9592 successful lookup, and nothing in the case of failure.
9593
9594 For single-key lookups, the string &"partial"& is permitted to precede the
9595 search type in order to do partial matching, and * or *@ may follow a search
9596 type to request default lookups if the key does not match (see sections
9597 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9598
9599 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9600 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9601 and non-wild parts of the key during the expansion of the replacement text.
9602 They return to their previous values at the end of the lookup item.
9603
9604 This example looks up the postmaster alias in the conventional alias file:
9605 .code
9606 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9607 .endd
9608 This example uses NIS+ to look up the full name of the user corresponding to
9609 the local part of an address, forcing the expansion to fail if it is not found:
9610 .code
9611 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9612   {$value}fail}
9613 .endd
9614
9615
9616 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9617 .cindex "expansion" "list creation"
9618 .vindex "&$item$&"
9619 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9620 default, but the separator can be changed in the usual way. For each item
9621 in this list, its value is place in &$item$&, and then <&'string2'&> is
9622 expanded and added to the output as an item in a new list. The separator used
9623 for the output list is the same as the one used for the input, but a separator
9624 setting is not included in the output. For example:
9625 .code
9626 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9627 .endd
9628 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9629 value of &$item$& is restored to what it was before. See also the &*filter*&
9630 and &*reduce*& expansion items.
9631
9632 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9633 .cindex "expansion" "numeric hash"
9634 .cindex "hash function" "numeric"
9635 The three strings are expanded; the first two must yield numbers. Call them
9636 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9637 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9638 can use the simpler operator notation that avoids some of the braces:
9639 .code
9640 ${nhash_<n>_<m>:<string>}
9641 .endd
9642 The second number is optional (in both notations). If there is only one number,
9643 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9644 processed by a div/mod hash function that returns two numbers, separated by a
9645 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9646 example,
9647 .code
9648 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9649 .endd
9650 returns the string &"6/33"&.
9651
9652
9653
9654 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9655 .cindex "Perl" "use in expanded string"
9656 .cindex "expansion" "calling Perl from"
9657 This item is available only if Exim has been built to include an embedded Perl
9658 interpreter. The subroutine name and the arguments are first separately
9659 expanded, and then the Perl subroutine is called with those arguments. No
9660 additional arguments need be given; the maximum number permitted, including the
9661 name of the subroutine, is nine.
9662
9663 The return value of the subroutine is inserted into the expanded string, unless
9664 the return value is &%undef%&. In that case, the expansion fails in the same
9665 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9666 Whatever you return is evaluated in a scalar context. For example, if you
9667 return the name of a Perl vector, the return value is the size of the vector,
9668 not its contents.
9669
9670 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9671 with the error message that was passed to &%die%&. More details of the embedded
9672 Perl facility are given in chapter &<<CHAPperl>>&.
9673
9674 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9675 out the use of this expansion item in filter files.
9676
9677
9678 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9679 .cindex "&%prvs%& expansion item"
9680 The first argument is a complete email address and the second is secret
9681 keystring. The third argument, specifying a key number, is optional. If absent,
9682 it defaults to 0. The result of the expansion is a prvs-signed email address,
9683 to be typically used with the &%return_path%& option on an &(smtp)& transport
9684 as part of a bounce address tag validation (BATV) scheme. For more discussion
9685 and an example, see section &<<SECTverifyPRVS>>&.
9686
9687 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9688         {*&<&'string'&>&*}}*&"
9689 .cindex "&%prvscheck%& expansion item"
9690 This expansion item is the complement of the &%prvs%& item. It is used for
9691 checking prvs-signed addresses. If the expansion of the first argument does not
9692 yield a syntactically valid prvs-signed address, the whole item expands to the
9693 empty string. When the first argument does expand to a syntactically valid
9694 prvs-signed address, the second argument is expanded, with the prvs-decoded
9695 version of the address and the key number extracted from the address in the
9696 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9697
9698 These two variables can be used in the expansion of the second argument to
9699 retrieve the secret. The validity of the prvs-signed address is then checked
9700 against the secret. The result is stored in the variable &$prvscheck_result$&,
9701 which is empty for failure or &"1"& for success.
9702
9703 The third argument is optional; if it is missing, it defaults to an empty
9704 string. This argument is now expanded. If the result is an empty string, the
9705 result of the expansion is the decoded version of the address. This is the case
9706 whether or not the signature was valid. Otherwise, the result of the expansion
9707 is the expansion of the third argument.
9708
9709 All three variables can be used in the expansion of the third argument.
9710 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9711 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9712
9713 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9714 .cindex "expansion" "inserting an entire file"
9715 .cindex "file" "inserting into expansion"
9716 .cindex "&%readfile%& expansion item"
9717 The file name and end-of-line string are first expanded separately. The file is
9718 then read, and its contents replace the entire item. All newline characters in
9719 the file are replaced by the end-of-line string if it is present. Otherwise,
9720 newlines are left in the string.
9721 String expansion is not applied to the contents of the file. If you want this,
9722 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9723 the string expansion fails.
9724
9725 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9726 locks out the use of this expansion item in filter files.
9727
9728
9729
9730 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9731         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9732 .cindex "expansion" "inserting from a socket"
9733 .cindex "socket, use of in expansion"
9734 .cindex "&%readsocket%& expansion item"
9735 This item inserts data from a Unix domain or TCP socket into the expanded
9736 string. The minimal way of using it uses just two arguments, as in these
9737 examples:
9738 .code
9739 ${readsocket{/socket/name}{request string}}
9740 ${readsocket{inet:some.host:1234}{request string}}
9741 .endd
9742 For a Unix domain socket, the first substring must be the path to the socket.
9743 For an Internet socket, the first substring must contain &`inet:`& followed by
9744 a host name or IP address, followed by a colon and a port, which can be a
9745 number or the name of a TCP port in &_/etc/services_&. An IP address may
9746 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9747 example:
9748 .code
9749 ${readsocket{inet:[::1]:1234}{request string}}
9750 .endd
9751 Only a single host name may be given, but if looking it up yields more than
9752 one IP address, they are each tried in turn until a connection is made. For
9753 both kinds of socket, Exim makes a connection, writes the request string
9754 unless it is an empty string; and no terminating NUL is ever sent)
9755 and reads from the socket until an end-of-file
9756 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9757 extend what can be done. Firstly, you can vary the timeout. For example:
9758 .code
9759 ${readsocket{/socket/name}{request string}{3s}}
9760 .endd
9761 A fourth argument allows you to change any newlines that are in the data
9762 that is read, in the same way as for &%readfile%& (see above). This example
9763 turns them into spaces:
9764 .code
9765 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9766 .endd
9767 As with all expansions, the substrings are expanded before the processing
9768 happens. Errors in these sub-expansions cause the expansion to fail. In
9769 addition, the following errors can occur:
9770
9771 .ilist
9772 Failure to create a socket file descriptor;
9773 .next
9774 Failure to connect the socket;
9775 .next
9776 Failure to write the request string;
9777 .next
9778 Timeout on reading from the socket.
9779 .endlist
9780
9781 By default, any of these errors causes the expansion to fail. However, if
9782 you supply a fifth substring, it is expanded and used when any of the above
9783 errors occurs. For example:
9784 .code
9785 ${readsocket{/socket/name}{request string}{3s}{\n}\
9786   {socket failure}}
9787 .endd
9788 You can test for the existence of a Unix domain socket by wrapping this
9789 expansion in &`${if exists`&, but there is a race condition between that test
9790 and the actual opening of the socket, so it is safer to use the fifth argument
9791 if you want to be absolutely sure of avoiding an expansion error for a
9792 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9793
9794 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9795 locks out the use of this expansion item in filter files.
9796
9797
9798 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9799 .cindex "expansion" "reducing a list to a scalar"
9800 .cindex "list" "reducing to a scalar"
9801 .vindex "&$value$&"
9802 .vindex "&$item$&"
9803 This operation reduces a list to a single, scalar string. After expansion,
9804 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9805 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9806 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9807 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9808 them. The result of that expansion is assigned to &$value$& before the next
9809 iteration. When the end of the list is reached, the final value of &$value$& is
9810 added to the expansion output. The &*reduce*& expansion item can be used in a
9811 number of ways. For example, to add up a list of numbers:
9812 .code
9813 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9814 .endd
9815 The result of that expansion would be &`6`&. The maximum of a list of numbers
9816 can be found:
9817 .code
9818 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9819 .endd
9820 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9821 restored to what they were before. See also the &*filter*& and &*map*&
9822 expansion items.
9823
9824 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9825 This item inserts &"raw"& header lines. It is described with the &%header%&
9826 expansion item above.
9827
9828 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9829         {*&<&'string2'&>&*}}*&"
9830 .cindex "expansion" "running a command"
9831 .cindex "&%run%& expansion item"
9832 The command and its arguments are first expanded as one string. The string is
9833 split apart into individual arguments by spaces, and then the command is run
9834 in a separate process, but under the same uid and gid.  As in other command
9835 executions from Exim, a shell is not used by default. If the command requires
9836 a shell, you must explicitly code it.
9837
9838 Since the arguments are split by spaces, when there is a variable expansion
9839 which has an empty result, it will cause the situation that the argument will
9840 simply be omitted when the program is actually executed by Exim. If the
9841 script/program requires a specific number of arguments and the expanded
9842 variable could possibly result in this empty expansion, the variable must be
9843 quoted. This is more difficult if the expanded variable itself could result
9844 in a string containing quotes, because it would interfere with the quotes
9845 around the command arguments. A possible guard against this is to wrap the
9846 variable in the &%sg%& operator to change any quote marks to some other
9847 character.
9848
9849 The standard input for the command exists, but is empty. The standard output
9850 and standard error are set to the same file descriptor.
9851 .cindex "return code" "from &%run%& expansion"
9852 .vindex "&$value$&"
9853 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9854 and replaces the entire item; during this expansion, the standard output/error
9855 from the command is in the variable &$value$&. If the command fails,
9856 <&'string2'&>, if present, is expanded and used. Once again, during the
9857 expansion, the standard output/error from the command is in the variable
9858 &$value$&.
9859
9860 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9861 can be the word &"fail"& (not in braces) to force expansion failure if the
9862 command does not succeed. If both strings are omitted, the result is contents
9863 of the standard output/error on success, and nothing on failure.
9864
9865 .vindex "&$run_in_acl$&"
9866 The standard output/error of the command is put in the variable &$value$&.
9867 In this ACL example, the output of a command is logged for the admin to
9868 troubleshoot:
9869 .code
9870 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9871       log_message  = Output of id: $value
9872 .endd
9873 If the command requires shell idioms, such as the > redirect operator, the
9874 shell must be invoked directly, such as with:
9875 .code
9876 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9877 .endd
9878
9879 .vindex "&$runrc$&"
9880 The return code from the command is put in the variable &$runrc$&, and this
9881 remains set afterwards, so in a filter file you can do things like this:
9882 .code
9883 if "${run{x y z}{}}$runrc" is 1 then ...
9884   elif $runrc is 2 then ...
9885   ...
9886 endif
9887 .endd
9888 If execution of the command fails (for example, the command does not exist),
9889 the return code is 127 &-- the same code that shells use for non-existent
9890 commands.
9891
9892 &*Warning*&: In a router or transport, you cannot assume the order in which
9893 option values are expanded, except for those preconditions whose order of
9894 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9895 by the expansion of one option, and use it in another.
9896
9897 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9898 out the use of this expansion item in filter files.
9899
9900
9901 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9902 .cindex "expansion" "string substitution"
9903 .cindex "&%sg%& expansion item"
9904 This item works like Perl's substitution operator (s) with the global (/g)
9905 option; hence its name. However, unlike the Perl equivalent, Exim does not
9906 modify the subject string; instead it returns the modified string for insertion
9907 into the overall expansion. The item takes three arguments: the subject string,
9908 a regular expression, and a substitution string. For example:
9909 .code
9910 ${sg{abcdefabcdef}{abc}{xyz}}
9911 .endd
9912 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9913 if any $ or \ characters are required in the regular expression or in the
9914 substitution string, they have to be escaped. For example:
9915 .code
9916 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9917 .endd
9918 yields &"defabc"&, and
9919 .code
9920 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9921 .endd
9922 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9923 the regular expression from string expansion.
9924
9925
9926
9927 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9928 .cindex sorting "a list"
9929 .cindex list sorting
9930 .cindex expansion "list sorting"
9931 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9932 default, but the separator can be changed in the usual way.
9933 The <&'comparator'&> argument is interpreted as the operator
9934 of a two-argument expansion condition.
9935 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9936 The comparison should return true when applied to two values
9937 if the first value should sort before the second value.
9938 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9939 the element being placed in &$item$&,
9940 to give values for comparison.
9941
9942 The item result is a sorted list,
9943 with the original list separator,
9944 of the list elements (in full) of the original.
9945
9946 Examples:
9947 .code
9948 ${sort{3:2:1:4}{<}{$item}}
9949 .endd
9950 sorts a list of numbers, and
9951 .code
9952 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9953 .endd
9954 will sort an MX lookup into priority order.
9955
9956
9957 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9958 .cindex "&%substr%& expansion item"
9959 .cindex "substring extraction"
9960 .cindex "expansion" "substring extraction"
9961 The three strings are expanded; the first two must yield numbers. Call them
9962 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9963 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9964 can use the simpler operator notation that avoids some of the braces:
9965 .code
9966 ${substr_<n>_<m>:<string>}
9967 .endd
9968 The second number is optional (in both notations).
9969 If it is absent in the simpler format, the preceding underscore must also be
9970 omitted.
9971
9972 The &%substr%& item can be used to extract more general substrings than
9973 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9974 length required. For example
9975 .code
9976 ${substr{3}{2}{$local_part}}
9977 .endd
9978 If the starting offset is greater than the string length the result is the
9979 null string; if the length plus starting offset is greater than the string
9980 length, the result is the right-hand part of the string, starting from the
9981 given offset. The first character in the string has offset zero.
9982
9983 The &%substr%& expansion item can take negative offset values to count
9984 from the right-hand end of its operand. The last character is offset -1, the
9985 second-last is offset -2, and so on. Thus, for example,
9986 .code
9987 ${substr{-5}{2}{1234567}}
9988 .endd
9989 yields &"34"&. If the absolute value of a negative offset is greater than the
9990 length of the string, the substring starts at the beginning of the string, and
9991 the length is reduced by the amount of overshoot. Thus, for example,
9992 .code
9993 ${substr{-5}{2}{12}}
9994 .endd
9995 yields an empty string, but
9996 .code
9997 ${substr{-3}{2}{12}}
9998 .endd
9999 yields &"1"&.
10000
10001 When the second number is omitted from &%substr%&, the remainder of the string
10002 is taken if the offset is positive. If it is negative, all characters in the
10003 string preceding the offset point are taken. For example, an offset of -1 and
10004 no length, as in these semantically identical examples:
10005 .code
10006 ${substr_-1:abcde}
10007 ${substr{-1}{abcde}}
10008 .endd
10009 yields all but the last character of the string, that is, &"abcd"&.
10010
10011
10012
10013 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10014         {*&<&'replacements'&>&*}}*&"
10015 .cindex "expansion" "character translation"
10016 .cindex "&%tr%& expansion item"
10017 This item does single-character translation on its subject string. The second
10018 argument is a list of characters to be translated in the subject string. Each
10019 matching character is replaced by the corresponding character from the
10020 replacement list. For example
10021 .code
10022 ${tr{abcdea}{ac}{13}}
10023 .endd
10024 yields &`1b3de1`&. If there are duplicates in the second character string, the
10025 last occurrence is used. If the third string is shorter than the second, its
10026 last character is replicated. However, if it is empty, no translation takes
10027 place.
10028 .endlist
10029
10030
10031
10032 .section "Expansion operators" "SECTexpop"
10033 .cindex "expansion" "operators"
10034 For expansion items that perform transformations on a single argument string,
10035 the &"operator"& notation is used because it is simpler and uses fewer braces.
10036 The substring is first expanded before the operation is applied to it. The
10037 following operations can be performed:
10038
10039 .vlist
10040 .vitem &*${address:*&<&'string'&>&*}*&
10041 .cindex "expansion" "RFC 2822 address handling"
10042 .cindex "&%address%& expansion item"
10043 The string is interpreted as an RFC 2822 address, as it might appear in a
10044 header line, and the effective address is extracted from it. If the string does
10045 not parse successfully, the result is empty.
10046
10047
10048 .vitem &*${addresses:*&<&'string'&>&*}*&
10049 .cindex "expansion" "RFC 2822 address handling"
10050 .cindex "&%addresses%& expansion item"
10051 The string (after expansion) is interpreted as a list of addresses in RFC
10052 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10053 operative address (&'local-part@domain'&) is extracted from each item, and the
10054 result of the expansion is a colon-separated list, with appropriate
10055 doubling of colons should any happen to be present in the email addresses.
10056 Syntactically invalid RFC2822 address items are omitted from the output.
10057
10058 It is possible to specify a character other than colon for the output
10059 separator by starting the string with > followed by the new separator
10060 character. For example:
10061 .code
10062 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10063 .endd
10064 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10065 expansion item, which extracts the working address from a single RFC2822
10066 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10067 processing lists.
10068
10069 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10070 a strict interpretation of header line formatting.  Exim parses the bare,
10071 unquoted portion of an email address and if it finds a comma, treats it as an
10072 email address separator. For the example header line:
10073 .code
10074 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10075 .endd
10076 The first example below demonstrates that Q-encoded email addresses are parsed
10077 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10078 It does not see the comma because it's still encoded as "=2C".  The second
10079 example below is passed the contents of &`$header_from:`&, meaning it gets
10080 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10081 The third example shows that the presence of a comma is skipped when it is
10082 quoted.
10083 .code
10084 # exim -be '${addresses:From: \
10085 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10086 user@example.com
10087 # exim -be '${addresses:From: Last, First <user@example.com>}'
10088 Last:user@example.com
10089 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10090 user@example.com
10091 .endd
10092
10093 .vitem &*${base62:*&<&'digits'&>&*}*&
10094 .cindex "&%base62%& expansion item"
10095 .cindex "expansion" "conversion to base 62"
10096 The string must consist entirely of decimal digits. The number is converted to
10097 base 62 and output as a string of six characters, including leading zeros. In
10098 the few operating environments where Exim uses base 36 instead of base 62 for
10099 its message identifiers (because those systems do not have case-sensitive file
10100 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10101 be absolutely clear: this is &'not'& base64 encoding.
10102
10103 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10104 .cindex "&%base62d%& expansion item"
10105 .cindex "expansion" "conversion to base 62"
10106 The string must consist entirely of base-62 digits, or, in operating
10107 environments where Exim uses base 36 instead of base 62 for its message
10108 identifiers, base-36 digits. The number is converted to decimal and output as a
10109 string.
10110
10111 .vitem &*${base64:*&<&'string'&>&*}*&
10112 .cindex "expansion" "base64 encoding"
10113 .cindex "base64 encoding" "in string expansion"
10114 .cindex "&%base64%& expansion item"
10115 .cindex certificate "base64 of DER"
10116 This operator converts a string into one that is base64 encoded.
10117
10118 If the string is a single variable of type certificate,
10119 returns the base64 encoding of the DER form of the certificate.
10120
10121
10122 .vitem &*${base64d:*&<&'string'&>&*}*&
10123 .cindex "expansion" "base64 decoding"
10124 .cindex "base64 decoding" "in string expansion"
10125 .cindex "&%base64d%& expansion item"
10126 This operator converts a base64-encoded string into the un-coded form.
10127
10128
10129 .vitem &*${domain:*&<&'string'&>&*}*&
10130 .cindex "domain" "extraction"
10131 .cindex "expansion" "domain extraction"
10132 The string is interpreted as an RFC 2822 address and the domain is extracted
10133 from it. If the string does not parse successfully, the result is empty.
10134
10135
10136 .vitem &*${escape:*&<&'string'&>&*}*&
10137 .cindex "expansion" "escaping non-printing characters"
10138 .cindex "&%escape%& expansion item"
10139 If the string contains any non-printing characters, they are converted to
10140 escape sequences starting with a backslash. Whether characters with the most
10141 significant bit set (so-called &"8-bit characters"&) count as printing or not
10142 is controlled by the &%print_topbitchars%& option.
10143
10144
10145 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10146 .cindex "expansion" "expression evaluation"
10147 .cindex "expansion" "arithmetic expression"
10148 .cindex "&%eval%& expansion item"
10149 These items supports simple arithmetic and bitwise logical operations in
10150 expansion strings. The string (after expansion) must be a conventional
10151 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10152 logical operators, and parentheses. All operations are carried out using
10153 integer arithmetic. The operator priorities are as follows (the same as in the
10154 C programming language):
10155 .table2 70pt 300pt
10156 .irow &'highest:'& "not (~), negate (-)"
10157 .irow ""   "multiply (*), divide (/), remainder (%)"
10158 .irow ""   "plus (+), minus (-)"
10159 .irow ""   "shift-left (<<), shift-right (>>)"
10160 .irow ""   "and (&&)"
10161 .irow ""   "xor (^)"
10162 .irow &'lowest:'&  "or (|)"
10163 .endtable
10164 Binary operators with the same priority are evaluated from left to right. White
10165 space is permitted before or after operators.
10166
10167 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10168 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10169 decimal, even if they start with a leading zero; hexadecimal numbers are not
10170 permitted. This can be useful when processing numbers extracted from dates or
10171 times, which often do have leading zeros.
10172
10173 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10174 or 1024*1024*1024,
10175 respectively. Negative numbers are supported. The result of the computation is
10176 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10177
10178 .display
10179 &`${eval:1+1}            `&  yields 2
10180 &`${eval:1+2*3}          `&  yields 7
10181 &`${eval:(1+2)*3}        `&  yields 9
10182 &`${eval:2+42%5}         `&  yields 4
10183 &`${eval:0xc&amp;5}          `&  yields 4
10184 &`${eval:0xc|5}          `&  yields 13
10185 &`${eval:0xc^5}          `&  yields 9
10186 &`${eval:0xc>>1}         `&  yields 6
10187 &`${eval:0xc<<1}         `&  yields 24
10188 &`${eval:~255&amp;0x1234}    `&  yields 4608
10189 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10190 .endd
10191
10192 As a more realistic example, in an ACL you might have
10193 .code
10194 deny   message = Too many bad recipients
10195        condition =                    \
10196          ${if and {                   \
10197            {>{$rcpt_count}{10}}       \
10198            {                          \
10199            <                          \
10200              {$recipients_count}      \
10201              {${eval:$rcpt_count/2}}  \
10202            }                          \
10203          }{yes}{no}}
10204 .endd
10205 The condition is true if there have been more than 10 RCPT commands and
10206 fewer than half of them have resulted in a valid recipient.
10207
10208
10209 .vitem &*${expand:*&<&'string'&>&*}*&
10210 .cindex "expansion" "re-expansion of substring"
10211 The &%expand%& operator causes a string to be expanded for a second time. For
10212 example,
10213 .code
10214 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10215 .endd
10216 first looks up a string in a file while expanding the operand for &%expand%&,
10217 and then re-expands what it has found.
10218
10219
10220 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10221 .cindex "Unicode"
10222 .cindex "UTF-8" "conversion from"
10223 .cindex "expansion" "UTF-8 conversion"
10224 .cindex "&%from_utf8%& expansion item"
10225 The world is slowly moving towards Unicode, although there are no standards for
10226 email yet. However, other applications (including some databases) are starting
10227 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10228 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10229 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10230 the result is an undefined sequence of bytes.
10231
10232 Unicode code points with values less than 256 are compatible with ASCII and
10233 ISO-8859-1 (also known as Latin-1).
10234 For example, character 169 is the copyright symbol in both cases, though the
10235 way it is encoded is different. In UTF-8, more than one byte is needed for
10236 characters with code values greater than 127, whereas ISO-8859-1 is a
10237 single-byte encoding (but thereby limited to 256 characters). This makes
10238 translation from UTF-8 to ISO-8859-1 straightforward.
10239
10240
10241 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10242 .cindex "hash function" "textual"
10243 .cindex "expansion" "textual hash"
10244 The &%hash%& operator is a simpler interface to the hashing function that can
10245 be used when the two parameters are fixed numbers (as opposed to strings that
10246 change when expanded). The effect is the same as
10247 .code
10248 ${hash{<n>}{<m>}{<string>}}
10249 .endd
10250 See the description of the general &%hash%& item above for details. The
10251 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10252
10253
10254
10255 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10256 .cindex "base64 encoding" "conversion from hex"
10257 .cindex "expansion" "hex to base64"
10258 .cindex "&%hex2b64%& expansion item"
10259 This operator converts a hex string into one that is base64 encoded. This can
10260 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10261
10262
10263
10264 .vitem &*${hexquote:*&<&'string'&>&*}*&
10265 .cindex "quoting" "hex-encoded unprintable characters"
10266 .cindex "&%hexquote%& expansion item"
10267 This operator converts non-printable characters in a string into a hex
10268 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10269 as is, and other byte values are converted to &`\xNN`&, for example a
10270 byte value 127 is converted to &`\x7f`&.
10271
10272
10273 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10274 .cindex "&%ipv6denorm%& expansion item"
10275 .cindex "IP address" normalisation
10276 This expands an IPv6 address to a full eight-element colon-separated set
10277 of hex digits including leading zeroes.
10278 A trailing ipv4-style dotted-decimal set is converted to hex.
10279 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10280
10281 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10282 .cindex "&%ipv6norm%& expansion item"
10283 .cindex "IP address" normalisation
10284 .cindex "IP address" "canonical form"
10285 This converts an IPv6 address to canonical form.
10286 Leading zeroes of groups are omitted, and the longest
10287 set of zero-valued groups is replaced with a double colon.
10288 A trailing ipv4-style dotted-decimal set is converted to hex.
10289 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10290
10291
10292 .vitem &*${lc:*&<&'string'&>&*}*&
10293 .cindex "case forcing in strings"
10294 .cindex "string" "case forcing"
10295 .cindex "lower casing"
10296 .cindex "expansion" "case forcing"
10297 .cindex "&%lc%& expansion item"
10298 This forces the letters in the string into lower-case, for example:
10299 .code
10300 ${lc:$local_part}
10301 .endd
10302
10303 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10304 .cindex "expansion" "string truncation"
10305 .cindex "&%length%& expansion item"
10306 The &%length%& operator is a simpler interface to the &%length%& function that
10307 can be used when the parameter is a fixed number (as opposed to a string that
10308 changes when expanded). The effect is the same as
10309 .code
10310 ${length{<number>}{<string>}}
10311 .endd
10312 See the description of the general &%length%& item above for details. Note that
10313 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10314 when &%length%& is used as an operator.
10315
10316
10317 .vitem &*${listcount:*&<&'string'&>&*}*&
10318 .cindex "expansion" "list item count"
10319 .cindex "list" "item count"
10320 .cindex "list" "count of items"
10321 .cindex "&%listcount%& expansion item"
10322 The string is interpreted as a list and the number of items is returned.
10323
10324
10325 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10326 .cindex "expansion" "named list"
10327 .cindex "&%listnamed%& expansion item"
10328 The name is interpreted as a named list and the content of the list is returned,
10329 expanding any referenced lists, re-quoting as needed for colon-separation.
10330 If the optional type is given it must be one of "a", "d", "h" or "l"
10331 and selects address-, domain-, host- or localpart- lists to search among respectively.
10332 Otherwise all types are searched in an undefined order and the first
10333 matching list is returned.
10334
10335
10336 .vitem &*${local_part:*&<&'string'&>&*}*&
10337 .cindex "expansion" "local part extraction"
10338 .cindex "&%local_part%& expansion item"
10339 The string is interpreted as an RFC 2822 address and the local part is
10340 extracted from it. If the string does not parse successfully, the result is
10341 empty.
10342
10343
10344 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10345 .cindex "masked IP address"
10346 .cindex "IP address" "masking"
10347 .cindex "CIDR notation"
10348 .cindex "expansion" "IP address masking"
10349 .cindex "&%mask%& expansion item"
10350 If the form of the string to be operated on is not an IP address followed by a
10351 slash and an integer (that is, a network address in CIDR notation), the
10352 expansion fails. Otherwise, this operator converts the IP address to binary,
10353 masks off the least significant bits according to the bit count, and converts
10354 the result back to text, with mask appended. For example,
10355 .code
10356 ${mask:10.111.131.206/28}
10357 .endd
10358 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10359 be mostly used for looking up masked addresses in files, the result for an IPv6
10360 address uses dots to separate components instead of colons, because colon
10361 terminates a key string in lsearch files. So, for example,
10362 .code
10363 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10364 .endd
10365 returns the string
10366 .code
10367 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10368 .endd
10369 Letters in IPv6 addresses are always output in lower case.
10370
10371
10372 .vitem &*${md5:*&<&'string'&>&*}*&
10373 .cindex "MD5 hash"
10374 .cindex "expansion" "MD5 hash"
10375 .cindex certificate fingerprint
10376 .cindex "&%md5%& expansion item"
10377 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10378 as a 32-digit hexadecimal number, in which any letters are in lower case.
10379
10380 If the string is a single variable of type certificate,
10381 returns the MD5 hash fingerprint of the certificate.
10382
10383
10384 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10385 .cindex "expansion" "numeric hash"
10386 .cindex "hash function" "numeric"
10387 The &%nhash%& operator is a simpler interface to the numeric hashing function
10388 that can be used when the two parameters are fixed numbers (as opposed to
10389 strings that change when expanded). The effect is the same as
10390 .code
10391 ${nhash{<n>}{<m>}{<string>}}
10392 .endd
10393 See the description of the general &%nhash%& item above for details.
10394
10395
10396 .vitem &*${quote:*&<&'string'&>&*}*&
10397 .cindex "quoting" "in string expansions"
10398 .cindex "expansion" "quoting"
10399 .cindex "&%quote%& expansion item"
10400 The &%quote%& operator puts its argument into double quotes if it
10401 is an empty string or
10402 contains anything other than letters, digits, underscores, dots, and hyphens.
10403 Any occurrences of double quotes and backslashes are escaped with a backslash.
10404 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10405 respectively For example,
10406 .code
10407 ${quote:ab"*"cd}
10408 .endd
10409 becomes
10410 .code
10411 "ab\"*\"cd"
10412 .endd
10413 The place where this is useful is when the argument is a substitution from a
10414 variable or a message header.
10415
10416 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10417 .cindex "&%quote_local_part%& expansion item"
10418 This operator is like &%quote%&, except that it quotes the string only if
10419 required to do so by the rules of RFC 2822 for quoting local parts. For
10420 example, a plus sign would not cause quoting (but it would for &%quote%&).
10421 If you are creating a new email address from the contents of &$local_part$&
10422 (or any other unknown data), you should always use this operator.
10423
10424
10425 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10426 .cindex "quoting" "lookup-specific"
10427 This operator applies lookup-specific quoting rules to the string. Each
10428 query-style lookup type has its own quoting rules which are described with
10429 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10430 .code
10431 ${quote_ldap:two * two}
10432 .endd
10433 returns
10434 .code
10435 two%20%5C2A%20two
10436 .endd
10437 For single-key lookup types, no quoting is ever necessary and this operator
10438 yields an unchanged string.
10439
10440
10441 .vitem &*${randint:*&<&'n'&>&*}*&
10442 .cindex "random number"
10443 This operator returns a somewhat random number which is less than the
10444 supplied number and is at least 0.  The quality of this randomness depends
10445 on how Exim was built; the values are not suitable for keying material.
10446 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10447 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10448 for versions of GnuTLS with that function.
10449 Otherwise, the implementation may be arc4random(), random() seeded by
10450 srandomdev() or srandom(), or a custom implementation even weaker than
10451 random().
10452
10453
10454 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10455 .cindex "expansion" "IP address"
10456 This operator reverses an IP address; for IPv4 addresses, the result is in
10457 dotted-quad decimal form, while for IPv6 addresses the result is in
10458 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10459 for DNS.  For example,
10460 .code
10461 ${reverse_ip:192.0.2.4}
10462 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10463 .endd
10464 returns
10465 .code
10466 4.2.0.192
10467 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
10468 .endd
10469
10470
10471 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10472 .cindex "expansion" "RFC 2047"
10473 .cindex "RFC 2047" "expansion operator"
10474 .cindex "&%rfc2047%& expansion item"
10475 This operator encodes text according to the rules of RFC 2047. This is an
10476 encoding that is used in header lines to encode non-ASCII characters. It is
10477 assumed that the input string is in the encoding specified by the
10478 &%headers_charset%& option, which gets its default at build time. If the string
10479 contains only characters in the range 33&--126, and no instances of the
10480 characters
10481 .code
10482 ? = ( ) < > @ , ; : \ " . [ ] _
10483 .endd
10484 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10485 string, using as many &"encoded words"& as necessary to encode all the
10486 characters.
10487
10488
10489 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10490 .cindex "expansion" "RFC 2047"
10491 .cindex "RFC 2047" "decoding"
10492 .cindex "&%rfc2047d%& expansion item"
10493 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10494 bytes are replaced by question marks. Characters are converted into the
10495 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10496 not recognized unless &%check_rfc2047_length%& is set false.
10497
10498 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10499 access a header line, RFC 2047 decoding is done automatically. You do not need
10500 to use this operator as well.
10501
10502
10503
10504 .vitem &*${rxquote:*&<&'string'&>&*}*&
10505 .cindex "quoting" "in regular expressions"
10506 .cindex "regular expressions" "quoting"
10507 .cindex "&%rxquote%& expansion item"
10508 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10509 characters in its argument. This is useful when substituting the values of
10510 variables or headers inside regular expressions.
10511
10512
10513 .vitem &*${sha1:*&<&'string'&>&*}*&
10514 .cindex "SHA-1 hash"
10515 .cindex "expansion" "SHA-1 hashing"
10516 .cindex certificate fingerprint
10517 .cindex "&%sha1%& expansion item"
10518 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10519 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10520
10521 If the string is a single variable of type certificate,
10522 returns the SHA-1 hash fingerprint of the certificate.
10523
10524
10525 .vitem &*${sha256:*&<&'string'&>&*}*&
10526 .cindex "SHA-256 hash"
10527 .cindex certificate fingerprint
10528 .cindex "expansion" "SHA-256 hashing"
10529 .cindex "&%sha256%& expansion item"
10530 .new
10531 The &%sha256%& operator computes the SHA-256 hash value of the string
10532 and returns
10533 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10534 .wen
10535
10536 If the string is a single variable of type certificate,
10537 returns the SHA-256 hash fingerprint of the certificate.
10538
10539
10540 .new
10541 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10542        &*${sha3_<n>:*&<&'string'&>&*}*&
10543 .cindex "SHA3 hash"
10544 .cindex "expansion" "SHA3 hashing"
10545 .cindex "&%sha3%& expansion item"
10546 The &%sha3%& operator computes the SHA3-256 hash value of the string
10547 and returns
10548 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10549
10550 If a number is appended, separated by an underbar, it specifies
10551 the output length.  Values of 224, 256, 384 and 512 are accepted;
10552 with 256 being the default.
10553
10554 The &%sha3%& expansion item is only supported if Exim has been
10555 compiled with GnuTLS 3.5.0 or later.
10556 .wen
10557
10558
10559 .vitem &*${stat:*&<&'string'&>&*}*&
10560 .cindex "expansion" "statting a file"
10561 .cindex "file" "extracting characteristics"
10562 .cindex "&%stat%& expansion item"
10563 The string, after expansion, must be a file path. A call to the &[stat()]&
10564 function is made for this path. If &[stat()]& fails, an error occurs and the
10565 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10566 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10567 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10568 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10569 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10570 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10571 can extract individual fields using the &%extract%& expansion item.
10572
10573 The use of the &%stat%& expansion in users' filter files can be locked out by
10574 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10575 systems for files larger than 2GB.
10576
10577 .vitem &*${str2b64:*&<&'string'&>&*}*&
10578 .cindex "&%str2b64%& expansion item"
10579 Now deprecated, a synonym for the &%base64%& expansion operator.
10580
10581
10582
10583 .vitem &*${strlen:*&<&'string'&>&*}*&
10584 .cindex "expansion" "string length"
10585 .cindex "string" "length in expansion"
10586 .cindex "&%strlen%& expansion item"
10587 The item is replace by the length of the expanded string, expressed as a
10588 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10589
10590
10591 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10592 .cindex "&%substr%& expansion item"
10593 .cindex "substring extraction"
10594 .cindex "expansion" "substring expansion"
10595 The &%substr%& operator is a simpler interface to the &%substr%& function that
10596 can be used when the two parameters are fixed numbers (as opposed to strings
10597 that change when expanded). The effect is the same as
10598 .code
10599 ${substr{<start>}{<length>}{<string>}}
10600 .endd
10601 See the description of the general &%substr%& item above for details. The
10602 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10603
10604 .vitem &*${time_eval:*&<&'string'&>&*}*&
10605 .cindex "&%time_eval%& expansion item"
10606 .cindex "time interval" "decoding"
10607 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10608 seconds.
10609
10610 .vitem &*${time_interval:*&<&'string'&>&*}*&
10611 .cindex "&%time_interval%& expansion item"
10612 .cindex "time interval" "formatting"
10613 The argument (after sub-expansion) must be a sequence of decimal digits that
10614 represents an interval of time as a number of seconds. It is converted into a
10615 number of larger units and output in Exim's normal time format, for example,
10616 &`1w3d4h2m6s`&.
10617
10618 .vitem &*${uc:*&<&'string'&>&*}*&
10619 .cindex "case forcing in strings"
10620 .cindex "string" "case forcing"
10621 .cindex "upper casing"
10622 .cindex "expansion" "case forcing"
10623 .cindex "&%uc%& expansion item"
10624 This forces the letters in the string into upper-case.
10625
10626 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10627 .cindex "correction of invalid utf-8 sequences in strings"
10628 .cindex "utf-8" "utf-8 sequences"
10629 .cindex "incorrect utf-8"
10630 .cindex "expansion" "utf-8 forcing"
10631 .cindex "&%utf8clean%& expansion item"
10632 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10633
10634 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10635        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10636        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10637        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10638 .cindex expansion UTF-8
10639 .cindex UTF-8 expansion
10640 .cindex EAI
10641 .cindex internationalisation
10642 .cindex "&%utf8_domain_to_alabel%& expansion item"
10643 .cindex "&%utf8_domain_from_alabel%& expansion item"
10644 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10645 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10646 These convert EAI mail name components between UTF-8 and a-label forms.
10647 For information on internationalisation support see &<<SECTi18nMTA>>&.
10648 .endlist
10649
10650
10651
10652
10653
10654
10655 .section "Expansion conditions" "SECTexpcond"
10656 .scindex IIDexpcond "expansion" "conditions"
10657 The following conditions are available for testing by the &%${if%& construct
10658 while expanding strings:
10659
10660 .vlist
10661 .vitem &*!*&<&'condition'&>
10662 .cindex "expansion" "negating a condition"
10663 .cindex "negation" "in expansion condition"
10664 Preceding any condition with an exclamation mark negates the result of the
10665 condition.
10666
10667 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10668 .cindex "numeric comparison"
10669 .cindex "expansion" "numeric comparison"
10670 There are a number of symbolic operators for doing numeric comparisons. They
10671 are:
10672 .display
10673 &`=   `&   equal
10674 &`==  `&   equal
10675 &`>   `&   greater
10676 &`>=  `&   greater or equal
10677 &`<   `&   less
10678 &`<=  `&   less or equal
10679 .endd
10680 For example:
10681 .code
10682 ${if >{$message_size}{10M} ...
10683 .endd
10684 Note that the general negation operator provides for inequality testing. The
10685 two strings must take the form of optionally signed decimal integers,
10686 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10687 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10688 As a special case, the numerical value of an empty string is taken as
10689 zero.
10690
10691 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10692 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10693 10M, not if 10M is larger than &$message_size$&.
10694
10695
10696 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10697         {*&<&'arg2'&>&*}...}*&
10698 .cindex "expansion" "calling an acl"
10699 .cindex "&%acl%&" "expansion condition"
10700 The name and zero to nine argument strings are first expanded separately.  The expanded
10701 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10702 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10703 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10704 and may use the variables; if another acl expansion is used the values
10705 are restored after it returns.  If the ACL sets
10706 a value using a "message =" modifier the variable $value becomes
10707 the result of the expansion, otherwise it is empty.
10708 If the ACL returns accept the condition is true; if deny, false.
10709 If the ACL returns defer the result is a forced-fail.
10710
10711 .vitem &*bool&~{*&<&'string'&>&*}*&
10712 .cindex "expansion" "boolean parsing"
10713 .cindex "&%bool%& expansion condition"
10714 This condition turns a string holding a true or false representation into
10715 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10716 (case-insensitively); also integer numbers map to true if non-zero,
10717 false if zero.
10718 An empty string is treated as false.
10719 Leading and trailing whitespace is ignored;
10720 thus a string consisting only of whitespace is false.
10721 All other string values will result in expansion failure.
10722
10723 When combined with ACL variables, this expansion condition will let you
10724 make decisions in one place and act on those decisions in another place.
10725 For example:
10726 .code
10727 ${if bool{$acl_m_privileged_sender} ...
10728 .endd
10729
10730
10731 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10732 .cindex "expansion" "boolean parsing"
10733 .cindex "&%bool_lax%& expansion condition"
10734 Like &%bool%&, this condition turns a string into a boolean state.  But
10735 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10736 loose definition that the Router &%condition%& option uses.  The empty string
10737 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10738 true.  Leading and trailing whitespace is ignored.
10739
10740 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10741
10742 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10743 .cindex "expansion" "encrypted comparison"
10744 .cindex "encrypted strings, comparing"
10745 .cindex "&%crypteq%& expansion condition"
10746 This condition is included in the Exim binary if it is built to support any
10747 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10748 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10749 included in the binary.
10750
10751 The &%crypteq%& condition has two arguments. The first is encrypted and
10752 compared against the second, which is already encrypted. The second string may
10753 be in the LDAP form for storing encrypted strings, which starts with the
10754 encryption type in curly brackets, followed by the data. If the second string
10755 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10756 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10757 Typically this will be a field from a password file. An example of an encrypted
10758 string in LDAP form is:
10759 .code
10760 {md5}CY9rzUYh03PK3k6DJie09g==
10761 .endd
10762 If such a string appears directly in an expansion, the curly brackets have to
10763 be quoted, because they are part of the expansion syntax. For example:
10764 .code
10765 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10766 .endd
10767 The following encryption types (whose names are matched case-independently) are
10768 supported:
10769
10770 .ilist
10771 .cindex "MD5 hash"
10772 .cindex "base64 encoding" "in encrypted password"
10773 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10774 printable characters to compare with the remainder of the second string. If the
10775 length of the comparison string is 24, Exim assumes that it is base64 encoded
10776 (as in the above example). If the length is 32, Exim assumes that it is a
10777 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10778 comparison fails.
10779
10780 .next
10781 .cindex "SHA-1 hash"
10782 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10783 printable characters to compare with the remainder of the second string. If the
10784 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10785 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10786 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10787
10788 .next
10789 .cindex "&[crypt()]&"
10790 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10791 only the first eight characters of the password. However, in modern operating
10792 systems this is no longer true, and in many cases the entire password is used,
10793 whatever its length.
10794
10795 .next
10796 .cindex "&[crypt16()]&"
10797 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10798 use up to 16 characters of the password in some operating systems. Again, in
10799 modern operating systems, more characters may be used.
10800 .endlist
10801 Exim has its own version of &[crypt16()]&, which is just a double call to
10802 &[crypt()]&. For operating systems that have their own version, setting
10803 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10804 operating system version instead of its own. This option is set by default in
10805 the OS-dependent &_Makefile_& for those operating systems that are known to
10806 support &[crypt16()]&.
10807
10808 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10809 it was not using the same algorithm as some operating systems' versions. It
10810 turns out that as well as &[crypt16()]& there is a function called
10811 &[bigcrypt()]& in some operating systems. This may or may not use the same
10812 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10813
10814 However, since there is now a move away from the traditional &[crypt()]&
10815 functions towards using SHA1 and other algorithms, tidying up this area of
10816 Exim is seen as very low priority.
10817
10818 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10819 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10820 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10821 default is &`{crypt}`&. Whatever the default, you can always use either
10822 function by specifying it explicitly in curly brackets.
10823
10824 .vitem &*def:*&<&'variable&~name'&>
10825 .cindex "expansion" "checking for empty variable"
10826 .cindex "&%def%& expansion condition"
10827 The &%def%& condition must be followed by the name of one of the expansion
10828 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10829 variable does not contain the empty string. For example:
10830 .code
10831 ${if def:sender_ident {from $sender_ident}}
10832 .endd
10833 Note that the variable name is given without a leading &%$%& character. If the
10834 variable does not exist, the expansion fails.
10835
10836 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10837         &~&*def:h_*&<&'header&~name'&>&*:*&"
10838 .cindex "expansion" "checking header line existence"
10839 This condition is true if a message is being processed and the named header
10840 exists in the message. For example,
10841 .code
10842 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10843 .endd
10844 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10845 the header name must be terminated by a colon if white space does not follow.
10846
10847 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10848        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10849 .cindex "string" "comparison"
10850 .cindex "expansion" "string comparison"
10851 .cindex "&%eq%& expansion condition"
10852 .cindex "&%eqi%& expansion condition"
10853 The two substrings are first expanded. The condition is true if the two
10854 resulting strings are identical. For &%eq%& the comparison includes the case of
10855 letters, whereas for &%eqi%& the comparison is case-independent.
10856
10857 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10858 .cindex "expansion" "file existence test"
10859 .cindex "file" "existence test"
10860 .cindex "&%exists%&, expansion condition"
10861 The substring is first expanded and then interpreted as an absolute path. The
10862 condition is true if the named file (or directory) exists. The existence test
10863 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10864 users' filter files may be locked out by the system administrator.
10865
10866 .vitem &*first_delivery*&
10867 .cindex "delivery" "first"
10868 .cindex "first delivery"
10869 .cindex "expansion" "first delivery test"
10870 .cindex "&%first_delivery%& expansion condition"
10871 This condition, which has no data, is true during a message's first delivery
10872 attempt. It is false during any subsequent delivery attempts.
10873
10874
10875 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10876        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10877 .cindex "list" "iterative conditions"
10878 .cindex "expansion" "&*forall*& condition"
10879 .cindex "expansion" "&*forany*& condition"
10880 .vindex "&$item$&"
10881 These conditions iterate over a list. The first argument is expanded to form
10882 the list. By default, the list separator is a colon, but it can be changed by
10883 the normal method. The second argument is interpreted as a condition that is to
10884 be applied to each item in the list in turn. During the interpretation of the
10885 condition, the current list item is placed in a variable called &$item$&.
10886 .ilist
10887 For &*forany*&, interpretation stops if the condition is true for any item, and
10888 the result of the whole condition is true. If the condition is false for all
10889 items in the list, the overall condition is false.
10890 .next
10891 For &*forall*&, interpretation stops if the condition is false for any item,
10892 and the result of the whole condition is false. If the condition is true for
10893 all items in the list, the overall condition is true.
10894 .endlist
10895 Note that negation of &*forany*& means that the condition must be false for all
10896 items for the overall condition to succeed, and negation of &*forall*& means
10897 that the condition must be false for at least one item. In this example, the
10898 list separator is changed to a comma:
10899 .code
10900 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10901 .endd
10902 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10903 being processed, to enable these expansion items to be nested.
10904
10905 To scan a named list, expand it with the &*listnamed*& operator.
10906
10907
10908 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10909        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10910 .cindex "string" "comparison"
10911 .cindex "expansion" "string comparison"
10912 .cindex "&%ge%& expansion condition"
10913 .cindex "&%gei%& expansion condition"
10914 The two substrings are first expanded. The condition is true if the first
10915 string is lexically greater than or equal to the second string. For &%ge%& the
10916 comparison includes the case of letters, whereas for &%gei%& the comparison is
10917 case-independent.
10918
10919 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10920        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10921 .cindex "string" "comparison"
10922 .cindex "expansion" "string comparison"
10923 .cindex "&%gt%& expansion condition"
10924 .cindex "&%gti%& expansion condition"
10925 The two substrings are first expanded. The condition is true if the first
10926 string is lexically greater than the second string. For &%gt%& the comparison
10927 includes the case of letters, whereas for &%gti%& the comparison is
10928 case-independent.
10929
10930 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10931        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10932 .cindex "string" "comparison"
10933 .cindex "list" "iterative conditions"
10934 Both strings are expanded; the second string is treated as a list of simple
10935 strings; if the first string is a member of the second, then the condition
10936 is true.
10937
10938 These are simpler to use versions of the more powerful &*forany*& condition.
10939 Examples, and the &*forany*& equivalents:
10940 .code
10941 ${if inlist{needle}{foo:needle:bar}}
10942   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10943 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10944   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10945 .endd
10946
10947 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10948        &*isip4&~{*&<&'string'&>&*}*& &&&
10949        &*isip6&~{*&<&'string'&>&*}*&
10950 .cindex "IP address" "testing string format"
10951 .cindex "string" "testing for IP address"
10952 .cindex "&%isip%& expansion condition"
10953 .cindex "&%isip4%& expansion condition"
10954 .cindex "&%isip6%& expansion condition"
10955 The substring is first expanded, and then tested to see if it has the form of
10956 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10957 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10958
10959 For an IPv4 address, the test is for four dot-separated components, each of
10960 which consists of from one to three digits. For an IPv6 address, up to eight
10961 colon-separated components are permitted, each containing from one to four
10962 hexadecimal digits. There may be fewer than eight components if an empty
10963 component (adjacent colons) is present. Only one empty component is permitted.
10964
10965 &*Note*&: The checks are just on the form of the address; actual numerical
10966 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10967 check. The main use of these tests is to distinguish between IP addresses and
10968 host names, or between IPv4 and IPv6 addresses. For example, you could use
10969 .code
10970 ${if isip4{$sender_host_address}...
10971 .endd
10972 to test which IP version an incoming SMTP connection is using.
10973
10974 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10975 .cindex "LDAP" "use for authentication"
10976 .cindex "expansion" "LDAP authentication test"
10977 .cindex "&%ldapauth%& expansion condition"
10978 This condition supports user authentication using LDAP. See section
10979 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10980 queries. For this use, the query must contain a user name and password. The
10981 query itself is not used, and can be empty. The condition is true if the
10982 password is not empty, and the user name and password are accepted by the LDAP
10983 server. An empty password is rejected without calling LDAP because LDAP binds
10984 with an empty password are considered anonymous regardless of the username, and
10985 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10986 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10987 this can be used.
10988
10989
10990 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10991        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10992 .cindex "string" "comparison"
10993 .cindex "expansion" "string comparison"
10994 .cindex "&%le%& expansion condition"
10995 .cindex "&%lei%& expansion condition"
10996 The two substrings are first expanded. The condition is true if the first
10997 string is lexically less than or equal to the second string. For &%le%& the
10998 comparison includes the case of letters, whereas for &%lei%& the comparison is
10999 case-independent.
11000
11001 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11002        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11003 .cindex "string" "comparison"
11004 .cindex "expansion" "string comparison"
11005 .cindex "&%lt%& expansion condition"
11006 .cindex "&%lti%& expansion condition"
11007 The two substrings are first expanded. The condition is true if the first
11008 string is lexically less than the second string. For &%lt%& the comparison
11009 includes the case of letters, whereas for &%lti%& the comparison is
11010 case-independent.
11011
11012
11013 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11014 .cindex "expansion" "regular expression comparison"
11015 .cindex "regular expressions" "match in expanded string"
11016 .cindex "&%match%& expansion condition"
11017 The two substrings are first expanded. The second is then treated as a regular
11018 expression and applied to the first. Because of the pre-expansion, if the
11019 regular expression contains dollar, or backslash characters, they must be
11020 escaped. Care must also be taken if the regular expression contains braces
11021 (curly brackets). A closing brace must be escaped so that it is not taken as a
11022 premature termination of <&'string2'&>. The easiest approach is to use the
11023 &`\N`& feature to disable expansion of the regular expression.
11024 For example,
11025 .code
11026 ${if match {$local_part}{\N^\d{3}\N} ...
11027 .endd
11028 If the whole expansion string is in double quotes, further escaping of
11029 backslashes is also required.
11030
11031 The condition is true if the regular expression match succeeds.
11032 The regular expression is not required to begin with a circumflex
11033 metacharacter, but if there is no circumflex, the expression is not anchored,
11034 and it may match anywhere in the subject, not just at the start. If you want
11035 the pattern to match at the end of the subject, you must include the &`$`&
11036 metacharacter at an appropriate point.
11037
11038 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11039 At the start of an &%if%& expansion the values of the numeric variable
11040 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11041 succeeds causes them to be reset to the substrings of that condition and they
11042 will have these values during the expansion of the success string. At the end
11043 of the &%if%& expansion, the previous values are restored. After testing a
11044 combination of conditions using &%or%&, the subsequent values of the numeric
11045 variables are those of the condition that succeeded.
11046
11047 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11048 .cindex "&%match_address%& expansion condition"
11049 See &*match_local_part*&.
11050
11051 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11052 .cindex "&%match_domain%& expansion condition"
11053 See &*match_local_part*&.
11054
11055 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11056 .cindex "&%match_ip%& expansion condition"
11057 This condition matches an IP address to a list of IP address patterns. It must
11058 be followed by two argument strings. The first (after expansion) must be an IP
11059 address or an empty string. The second (not expanded) is a restricted host
11060 list that can match only an IP address, not a host name. For example:
11061 .code
11062 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11063 .endd
11064 The specific types of host list item that are permitted in the list are:
11065
11066 .ilist
11067 An IP address, optionally with a CIDR mask.
11068 .next
11069 A single asterisk, which matches any IP address.
11070 .next
11071 An empty item, which matches only if the IP address is empty. This could be
11072 useful for testing for a locally submitted message or one from specific hosts
11073 in a single test such as
11074 . ==== As this is a nested list, any displays it contains must be indented
11075 . ==== as otherwise they are too far to the left. This comment applies to
11076 . ==== the use of xmlto plus fop. There's no problem when formatting with
11077 . ==== sdop, with or without the extra indent.
11078 .code
11079   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11080 .endd
11081 where the first item in the list is the empty string.
11082 .next
11083 The item @[] matches any of the local host's interface addresses.
11084 .next
11085 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11086 even if &`net-`& is not specified. There is never any attempt to turn the IP
11087 address into a host name. The most common type of linear search for
11088 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11089 masks. For example:
11090 .code
11091   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11092 .endd
11093 It is of course possible to use other kinds of lookup, and in such a case, you
11094 do need to specify the &`net-`& prefix if you want to specify a specific
11095 address mask, for example:
11096 .code
11097   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11098 .endd
11099 However, unless you are combining a &%match_ip%& condition with others, it is
11100 just as easy to use the fact that a lookup is itself a condition, and write:
11101 .code
11102   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11103 .endd
11104 .endlist ilist
11105
11106 Note that <&'string2'&> is not itself subject to string expansion, unless
11107 Exim was built with the EXPAND_LISTMATCH_RHS option.
11108
11109 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11110
11111 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11112 .cindex "domain list" "in expansion condition"
11113 .cindex "address list" "in expansion condition"
11114 .cindex "local part" "list, in expansion condition"
11115 .cindex "&%match_local_part%& expansion condition"
11116 This condition, together with &%match_address%& and &%match_domain%&, make it
11117 possible to test domain, address, and local part lists within expansions. Each
11118 condition requires two arguments: an item and a list to match. A trivial
11119 example is:
11120 .code
11121 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11122 .endd
11123 In each case, the second argument may contain any of the allowable items for a
11124 list of the appropriate type. Also, because the second argument (after
11125 expansion) is a standard form of list, it is possible to refer to a named list.
11126 Thus, you can use conditions like this:
11127 .code
11128 ${if match_domain{$domain}{+local_domains}{...
11129 .endd
11130 .cindex "&`+caseful`&"
11131 For address lists, the matching starts off caselessly, but the &`+caseful`&
11132 item can be used, as in all address lists, to cause subsequent items to
11133 have their local parts matched casefully. Domains are always matched
11134 caselessly.
11135
11136 Note that <&'string2'&> is not itself subject to string expansion, unless
11137 Exim was built with the EXPAND_LISTMATCH_RHS option.
11138
11139 &*Note*&: Host lists are &'not'& supported in this way. This is because
11140 hosts have two identities: a name and an IP address, and it is not clear
11141 how to specify cleanly how such a test would work. However, IP addresses can be
11142 matched using &%match_ip%&.
11143
11144 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11145 .cindex "PAM authentication"
11146 .cindex "AUTH" "with PAM"
11147 .cindex "Solaris" "PAM support"
11148 .cindex "expansion" "PAM authentication test"
11149 .cindex "&%pam%& expansion condition"
11150 &'Pluggable Authentication Modules'&
11151 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11152 available in the latest releases of Solaris and in some GNU/Linux
11153 distributions. The Exim support, which is intended for use in conjunction with
11154 the SMTP AUTH command, is available only if Exim is compiled with
11155 .code
11156 SUPPORT_PAM=yes
11157 .endd
11158 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11159 in some releases of GNU/Linux &%-ldl%& is also needed.
11160
11161 The argument string is first expanded, and the result must be a
11162 colon-separated list of strings. Leading and trailing white space is ignored.
11163 The PAM module is initialized with the service name &"exim"& and the user name
11164 taken from the first item in the colon-separated data string (<&'string1'&>).
11165 The remaining items in the data string are passed over in response to requests
11166 from the authentication function. In the simple case there will only be one
11167 request, for a password, so the data consists of just two strings.
11168
11169 There can be problems if any of the strings are permitted to contain colon
11170 characters. In the usual way, these have to be doubled to avoid being taken as
11171 separators. If the data is being inserted from a variable, the &%sg%& expansion
11172 item can be used to double any existing colons. For example, the configuration
11173 of a LOGIN authenticator might contain this setting:
11174 .code
11175 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11176 .endd
11177 For a PLAIN authenticator you could use:
11178 .code
11179 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11180 .endd
11181 In some operating systems, PAM authentication can be done only from a process
11182 running as root. Since Exim is running as the Exim user when receiving
11183 messages, this means that PAM cannot be used directly in those systems.
11184 A patched version of the &'pam_unix'& module that comes with the
11185 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11186 The patched module allows one special uid/gid combination, in addition to root,
11187 to authenticate. If you build the patched module to allow the Exim user and
11188 group, PAM can then be used from an Exim authenticator.
11189
11190
11191 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11192 .cindex "&'pwcheck'& daemon"
11193 .cindex "Cyrus"
11194 .cindex "expansion" "&'pwcheck'& authentication test"
11195 .cindex "&%pwcheck%& expansion condition"
11196 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11197 This is one way of making it possible for passwords to be checked by a process
11198 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11199 deprecated. Its replacement is &'saslauthd'& (see below).
11200
11201 The pwcheck support is not included in Exim by default. You need to specify
11202 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11203 building Exim. For example:
11204 .code
11205 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11206 .endd
11207 You do not need to install the full Cyrus software suite in order to use
11208 the pwcheck daemon. You can compile and install just the daemon alone
11209 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11210 access to the &_/var/pwcheck_& directory.
11211
11212 The &%pwcheck%& condition takes one argument, which must be the user name and
11213 password, separated by a colon. For example, in a LOGIN authenticator
11214 configuration, you might have this:
11215 .code
11216 server_condition = ${if pwcheck{$auth1:$auth2}}
11217 .endd
11218 Again, for a PLAIN authenticator configuration, this would be:
11219 .code
11220 server_condition = ${if pwcheck{$auth2:$auth3}}
11221 .endd
11222 .vitem &*queue_running*&
11223 .cindex "queue runner" "detecting when delivering from"
11224 .cindex "expansion" "queue runner test"
11225 .cindex "&%queue_running%& expansion condition"
11226 This condition, which has no data, is true during delivery attempts that are
11227 initiated by queue runner processes, and false otherwise.
11228
11229
11230 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11231 .cindex "Radius"
11232 .cindex "expansion" "Radius authentication"
11233 .cindex "&%radius%& expansion condition"
11234 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11235 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11236 the Radius client configuration file in order to build Exim with Radius
11237 support.
11238
11239 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11240 library, using the original API. If you are using release 0.4.0 or later of
11241 this library, you need to set
11242 .code
11243 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11244 .endd
11245 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11246 &%libradius%& library that comes with FreeBSD. To do this, set
11247 .code
11248 RADIUS_LIB_TYPE=RADLIB
11249 .endd
11250 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11251 You may also have to supply a suitable setting in EXTRALIBS so that the
11252 Radius library can be found when Exim is linked.
11253
11254 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11255 Radius client library, which calls the Radius server. The condition is true if
11256 the authentication is successful. For example:
11257 .code
11258 server_condition = ${if radius{<arguments>}}
11259 .endd
11260
11261
11262 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11263         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11264 .cindex "&'saslauthd'& daemon"
11265 .cindex "Cyrus"
11266 .cindex "expansion" "&'saslauthd'& authentication test"
11267 .cindex "&%saslauthd%& expansion condition"
11268 This condition supports user authentication using the Cyrus &'saslauthd'&
11269 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11270 Using this daemon is one way of making it possible for passwords to be checked
11271 by a process that is not running as root.
11272
11273 The saslauthd support is not included in Exim by default. You need to specify
11274 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11275 building Exim. For example:
11276 .code
11277 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11278 .endd
11279 You do not need to install the full Cyrus software suite in order to use
11280 the saslauthd daemon. You can compile and install just the daemon alone
11281 from the Cyrus SASL library.
11282
11283 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11284 two are mandatory. For example:
11285 .code
11286 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11287 .endd
11288 The service and the realm are optional (which is why the arguments are enclosed
11289 in their own set of braces). For details of the meaning of the service and
11290 realm, and how to run the daemon, consult the Cyrus documentation.
11291 .endlist vlist
11292
11293
11294
11295 .section "Combining expansion conditions" "SECID84"
11296 .cindex "expansion" "combining conditions"
11297 Several conditions can be tested at once by combining them using the &%and%&
11298 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11299 conditions on their own, and precede their lists of sub-conditions. Each
11300 sub-condition must be enclosed in braces within the overall braces that contain
11301 the list. No repetition of &%if%& is used.
11302
11303
11304 .vlist
11305 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11306 .cindex "&""or""& expansion condition"
11307 .cindex "expansion" "&""or""& of conditions"
11308 The sub-conditions are evaluated from left to right. The condition is true if
11309 any one of the sub-conditions is true.
11310 For example,
11311 .code
11312 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11313 .endd
11314 When a true sub-condition is found, the following ones are parsed but not
11315 evaluated. If there are several &"match"& sub-conditions the values of the
11316 numeric variables afterwards are taken from the first one that succeeds.
11317
11318 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11319 .cindex "&""and""& expansion condition"
11320 .cindex "expansion" "&""and""& of conditions"
11321 The sub-conditions are evaluated from left to right. The condition is true if
11322 all of the sub-conditions are true. If there are several &"match"&
11323 sub-conditions, the values of the numeric variables afterwards are taken from
11324 the last one. When a false sub-condition is found, the following ones are
11325 parsed but not evaluated.
11326 .endlist
11327 .ecindex IIDexpcond
11328
11329
11330
11331
11332 .section "Expansion variables" "SECTexpvar"
11333 .cindex "expansion" "variables, list of"
11334 This section contains an alphabetical list of all the expansion variables. Some
11335 of them are available only when Exim is compiled with specific options such as
11336 support for TLS or the content scanning extension.
11337
11338 .vlist
11339 .vitem "&$0$&, &$1$&, etc"
11340 .cindex "numerical variables (&$1$& &$2$& etc)"
11341 When a &%match%& expansion condition succeeds, these variables contain the
11342 captured substrings identified by the regular expression during subsequent
11343 processing of the success string of the containing &%if%& expansion item.
11344 In the expansion condition case
11345 they do not retain their values afterwards; in fact, their previous
11346 values are restored at the end of processing an &%if%& item. The numerical
11347 variables may also be set externally by some other matching process which
11348 precedes the expansion of the string. For example, the commands available in
11349 Exim filter files include an &%if%& command with its own regular expression
11350 matching condition.
11351
11352 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11353 Within an acl condition, expansion condition or expansion item
11354 any arguments are copied to these variables,
11355 any unused variables being made empty.
11356
11357 .vitem "&$acl_c...$&"
11358 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11359 can be given any name that starts with &$acl_c$& and is at least six characters
11360 long, but the sixth character must be either a digit or an underscore. For
11361 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11362 variables persist throughout the lifetime of an SMTP connection. They can be
11363 used to pass information between ACLs and between different invocations of the
11364 same ACL. When a message is received, the values of these variables are saved
11365 with the message, and can be accessed by filters, routers, and transports
11366 during subsequent delivery.
11367
11368 .vitem "&$acl_m...$&"
11369 These variables are like the &$acl_c...$& variables, except that their values
11370 are reset after a message has been received. Thus, if several messages are
11371 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11372 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11373 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11374 message is received, the values of these variables are saved with the message,
11375 and can be accessed by filters, routers, and transports during subsequent
11376 delivery.
11377
11378 .vitem &$acl_narg$&
11379 Within an acl condition, expansion condition or expansion item
11380 this variable has the number of arguments.
11381
11382 .vitem &$acl_verify_message$&
11383 .vindex "&$acl_verify_message$&"
11384 After an address verification has failed, this variable contains the failure
11385 message. It retains its value for use in subsequent modifiers. The message can
11386 be preserved by coding like this:
11387 .code
11388 warn !verify = sender
11389      set acl_m0 = $acl_verify_message
11390 .endd
11391 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11392 &%log_message%& modifiers, to include information about the verification
11393 failure.
11394
11395 .vitem &$address_data$&
11396 .vindex "&$address_data$&"
11397 This variable is set by means of the &%address_data%& option in routers. The
11398 value then remains with the address while it is processed by subsequent routers
11399 and eventually a transport. If the transport is handling multiple addresses,
11400 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11401 for more details. &*Note*&: The contents of &$address_data$& are visible in
11402 user filter files.
11403
11404 If &$address_data$& is set when the routers are called from an ACL to verify
11405 a recipient address, the final value is still in the variable for subsequent
11406 conditions and modifiers of the ACL statement. If routing the address caused it
11407 to be redirected to just one address, the child address is also routed as part
11408 of the verification, and in this case the final value of &$address_data$& is
11409 from the child's routing.
11410
11411 If &$address_data$& is set when the routers are called from an ACL to verify a
11412 sender address, the final value is also preserved, but this time in
11413 &$sender_address_data$&, to distinguish it from data from a recipient
11414 address.
11415
11416 In both cases (recipient and sender verification), the value does not persist
11417 after the end of the current ACL statement. If you want to preserve
11418 these values for longer, you can save them in ACL variables.
11419
11420 .vitem &$address_file$&
11421 .vindex "&$address_file$&"
11422 When, as a result of aliasing, forwarding, or filtering, a message is directed
11423 to a specific file, this variable holds the name of the file when the transport
11424 is running. At other times, the variable is empty. For example, using the
11425 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11426 .code
11427 /home/r2d2/savemail
11428 .endd
11429 then when the &(address_file)& transport is running, &$address_file$&
11430 contains the text string &`/home/r2d2/savemail`&.
11431 .cindex "Sieve filter" "value of &$address_file$&"
11432 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11433 then up to the transport configuration to generate an appropriate absolute path
11434 to the relevant file.
11435
11436 .vitem &$address_pipe$&
11437 .vindex "&$address_pipe$&"
11438 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11439 this variable holds the pipe command when the transport is running.
11440
11441 .vitem "&$auth1$& &-- &$auth3$&"
11442 .vindex "&$auth1$&, &$auth2$&, etc"
11443 These variables are used in SMTP authenticators (see chapters
11444 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11445
11446 .vitem &$authenticated_id$&
11447 .cindex "authentication" "id"
11448 .vindex "&$authenticated_id$&"
11449 When a server successfully authenticates a client it may be configured to
11450 preserve some of the authentication information in the variable
11451 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11452 user/password authenticator configuration might preserve the user name for use
11453 in the routers. Note that this is not the same information that is saved in
11454 &$sender_host_authenticated$&.
11455 When a message is submitted locally (that is, not over a TCP connection)
11456 the value of &$authenticated_id$& is normally the login name of the calling
11457 process. However, a trusted user can override this by means of the &%-oMai%&
11458 command line option.
11459
11460 .vitem &$authenticated_fail_id$&
11461 .cindex "authentication" "fail" "id"
11462 .vindex "&$authenticated_fail_id$&"
11463 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11464 will contain the failed authentication id. If more than one authentication
11465 id is attempted, it will contain only the last one. The variable is
11466 available for processing in the ACL's, generally the quit or notquit ACL.
11467 A message to a local recipient could still be accepted without requiring
11468 authentication, which means this variable could also be visible in all of
11469 the ACL's as well.
11470
11471
11472 .vitem &$authenticated_sender$&
11473 .cindex "sender" "authenticated"
11474 .cindex "authentication" "sender"
11475 .cindex "AUTH" "on MAIL command"
11476 .vindex "&$authenticated_sender$&"
11477 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11478 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11479 described in section &<<SECTauthparamail>>&. Unless the data is the string
11480 &"<>"&, it is set as the authenticated sender of the message, and the value is
11481 available during delivery in the &$authenticated_sender$& variable. If the
11482 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11483
11484 .vindex "&$qualify_domain$&"
11485 When a message is submitted locally (that is, not over a TCP connection), the
11486 value of &$authenticated_sender$& is an address constructed from the login
11487 name of the calling process and &$qualify_domain$&, except that a trusted user
11488 can override this by means of the &%-oMas%& command line option.
11489
11490
11491 .vitem &$authentication_failed$&
11492 .cindex "authentication" "failure"
11493 .vindex "&$authentication_failed$&"
11494 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11495 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11496 possible to distinguish between &"did not try to authenticate"&
11497 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11498 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11499 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11500 negative response to an AUTH command, including (for example) an attempt to use
11501 an undefined mechanism.
11502
11503 .vitem &$av_failed$&
11504 .cindex "content scanning" "AV scanner failure"
11505 This variable is available when Exim is compiled with the content-scanning
11506 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11507 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11508 the ACL malware condition.
11509
11510 .vitem &$body_linecount$&
11511 .cindex "message body" "line count"
11512 .cindex "body of message" "line count"
11513 .vindex "&$body_linecount$&"
11514 When a message is being received or delivered, this variable contains the
11515 number of lines in the message's body. See also &$message_linecount$&.
11516
11517 .vitem &$body_zerocount$&
11518 .cindex "message body" "binary zero count"
11519 .cindex "body of message" "binary zero count"
11520 .cindex "binary zero" "in message body"
11521 .vindex "&$body_zerocount$&"
11522 When a message is being received or delivered, this variable contains the
11523 number of binary zero bytes (ASCII NULs) in the message's body.
11524
11525 .vitem &$bounce_recipient$&
11526 .vindex "&$bounce_recipient$&"
11527 This is set to the recipient address of a bounce message while Exim is creating
11528 it. It is useful if a customized bounce message text file is in use (see
11529 chapter &<<CHAPemsgcust>>&).
11530
11531 .vitem &$bounce_return_size_limit$&
11532 .vindex "&$bounce_return_size_limit$&"
11533 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11534 up to a multiple of 1000. It is useful when a customized error message text
11535 file is in use (see chapter &<<CHAPemsgcust>>&).
11536
11537 .vitem &$caller_gid$&
11538 .cindex "gid (group id)" "caller"
11539 .vindex "&$caller_gid$&"
11540 The real group id under which the process that called Exim was running. This is
11541 not the same as the group id of the originator of a message (see
11542 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11543 incarnation normally contains the Exim gid.
11544
11545 .vitem &$caller_uid$&
11546 .cindex "uid (user id)" "caller"
11547 .vindex "&$caller_uid$&"
11548 The real user id under which the process that called Exim was running. This is
11549 not the same as the user id of the originator of a message (see
11550 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11551 incarnation normally contains the Exim uid.
11552
11553 .vitem &$callout_address$&
11554 .vindex "&$callout_address$&"
11555 After a callout for verification, spamd or malware daemon service, the
11556 address that was connected to.
11557
11558 .vitem &$compile_number$&
11559 .vindex "&$compile_number$&"
11560 The building process for Exim keeps a count of the number
11561 of times it has been compiled. This serves to distinguish different
11562 compilations of the same version of the program.
11563
11564 .vitem &$config_dir$&
11565 .vindex "&$config_dir$&"
11566 The directory name of the main configuration file. That is, the content of
11567 &$config_file$& with the last component stripped. The value does not
11568 contain the trailing slash. If &$config_file$& does not contain a slash,
11569 &$config_dir$& is ".".
11570
11571 .vitem &$config_file$&
11572 .vindex "&$config_file$&"
11573 The name of the main configuration file Exim is using.
11574
11575 .vitem &$dkim_cur_signer$& &&&
11576        &$dkim_verify_status$& &&&
11577        &$dkim_verify_reason$& &&&
11578        &$dkim_domain$& &&&
11579        &$dkim_identity$& &&&
11580        &$dkim_selector$& &&&
11581        &$dkim_algo$& &&&
11582        &$dkim_canon_body$& &&&
11583        &$dkim_canon_headers$& &&&
11584        &$dkim_copiedheaders$& &&&
11585        &$dkim_bodylength$& &&&
11586        &$dkim_created$& &&&
11587        &$dkim_expires$& &&&
11588        &$dkim_headernames$& &&&
11589        &$dkim_key_testing$& &&&
11590        &$dkim_key_nosubdomains$& &&&
11591        &$dkim_key_srvtype$& &&&
11592        &$dkim_key_granularity$& &&&
11593        &$dkim_key_notes$& &&&
11594        &$dkim_key_length$&
11595 These variables are only available within the DKIM ACL.
11596 For details see chapter &<<CHAPdkim>>&.
11597
11598 .vitem &$dkim_signers$&
11599 .vindex &$dkim_signers$&
11600 When a message has been received this variable contains
11601 a colon-separated list of signer domains and identities for the message.
11602 For details see chapter &<<CHAPdkim>>&.
11603
11604 .vitem &$dnslist_domain$& &&&
11605        &$dnslist_matched$& &&&
11606        &$dnslist_text$& &&&
11607        &$dnslist_value$&
11608 .vindex "&$dnslist_domain$&"
11609 .vindex "&$dnslist_matched$&"
11610 .vindex "&$dnslist_text$&"
11611 .vindex "&$dnslist_value$&"
11612 .cindex "black list (DNS)"
11613 When a DNS (black) list lookup succeeds, these variables are set to contain
11614 the following data from the lookup: the list's domain name, the key that was
11615 looked up, the contents of any associated TXT record, and the value from the
11616 main A record. See section &<<SECID204>>& for more details.
11617
11618 .vitem &$domain$&
11619 .vindex "&$domain$&"
11620 When an address is being routed, or delivered on its own, this variable
11621 contains the domain. Uppercase letters in the domain are converted into lower
11622 case for &$domain$&.
11623
11624 Global address rewriting happens when a message is received, so the value of
11625 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11626 is set during user filtering, but not during system filtering, because a
11627 message may have many recipients and the system filter is called just once.
11628
11629 When more than one address is being delivered at once (for example, several
11630 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11631 have the same domain. Transports can be restricted to handling only one domain
11632 at a time if the value of &$domain$& is required at transport time &-- this is
11633 the default for local transports. For further details of the environment in
11634 which local transports are run, see chapter &<<CHAPenvironment>>&.
11635
11636 .oindex "&%delay_warning_condition%&"
11637 At the end of a delivery, if all deferred addresses have the same domain, it is
11638 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11639
11640 The &$domain$& variable is also used in some other circumstances:
11641
11642 .ilist
11643 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11644 the recipient address. The domain of the &'sender'& address is in
11645 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11646 normally set during the running of the MAIL ACL. However, if the sender address
11647 is verified with a callout during the MAIL ACL, the sender domain is placed in
11648 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11649 the &(smtp)& transport.
11650
11651 .next
11652 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11653 &$domain$& contains the domain portion of the address that is being rewritten;
11654 it can be used in the expansion of the replacement address, for example, to
11655 rewrite domains by file lookup.
11656
11657 .next
11658 With one important exception, whenever a domain list is being scanned,
11659 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11660 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11661 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11662 that, in a RCPT ACL, the sender domain list can be dependent on the
11663 recipient domain (which is what is in &$domain$& at this time).
11664
11665 .next
11666 .cindex "ETRN" "value of &$domain$&"
11667 .oindex "&%smtp_etrn_command%&"
11668 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11669 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11670 .endlist
11671
11672
11673 .vitem &$domain_data$&
11674 .vindex "&$domain_data$&"
11675 When the &%domains%& option on a router matches a domain by
11676 means of a lookup, the data read by the lookup is available during the running
11677 of the router as &$domain_data$&. In addition, if the driver routes the
11678 address to a transport, the value is available in that transport. If the
11679 transport is handling multiple addresses, the value from the first address is
11680 used.
11681
11682 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11683 domain by means of a lookup. The data read by the lookup is available during
11684 the rest of the ACL statement. In all other situations, this variable expands
11685 to nothing.
11686
11687 .vitem &$exim_gid$&
11688 .vindex "&$exim_gid$&"
11689 This variable contains the numerical value of the Exim group id.
11690
11691 .vitem &$exim_path$&
11692 .vindex "&$exim_path$&"
11693 This variable contains the path to the Exim binary.
11694
11695 .vitem &$exim_uid$&
11696 .vindex "&$exim_uid$&"
11697 This variable contains the numerical value of the Exim user id.
11698
11699 .vitem &$exim_version$&
11700 .vindex "&$exim_version$&"
11701 This variable contains the version string of the Exim build.
11702 The first character is a major version number, currently 4.
11703 Then after a dot, the next group of digits is a minor version number.
11704 There may be other characters following the minor version.
11705
11706 .vitem &$header_$&<&'name'&>
11707 This is not strictly an expansion variable. It is expansion syntax for
11708 inserting the message header line with the given name. Note that the name must
11709 be terminated by colon or white space, because it may contain a wide variety of
11710 characters. Note also that braces must &'not'& be used.
11711
11712 .vitem &$headers_added$&
11713 .vindex "&$headers_added$&"
11714 Within an ACL this variable contains the headers added so far by
11715 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11716 The headers are a newline-separated list.
11717
11718 .vitem &$home$&
11719 .vindex "&$home$&"
11720 When the &%check_local_user%& option is set for a router, the user's home
11721 directory is placed in &$home$& when the check succeeds. In particular, this
11722 means it is set during the running of users' filter files. A router may also
11723 explicitly set a home directory for use by a transport; this can be overridden
11724 by a setting on the transport itself.
11725
11726 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11727 of the environment variable HOME, which is subject to the
11728 &%keep_environment%& and &%add_environment%& main config options.
11729
11730 .vitem &$host$&
11731 .vindex "&$host$&"
11732 If a router assigns an address to a transport (any transport), and passes a
11733 list of hosts with the address, the value of &$host$& when the transport starts
11734 to run is the name of the first host on the list. Note that this applies both
11735 to local and remote transports.
11736
11737 .cindex "transport" "filter"
11738 .cindex "filter" "transport filter"
11739 For the &(smtp)& transport, if there is more than one host, the value of
11740 &$host$& changes as the transport works its way through the list. In
11741 particular, when the &(smtp)& transport is expanding its options for encryption
11742 using TLS, or for specifying a transport filter (see chapter
11743 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11744 is connected.
11745
11746 When used in the client part of an authenticator configuration (see chapter
11747 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11748 client is connected.
11749
11750
11751 .vitem &$host_address$&
11752 .vindex "&$host_address$&"
11753 This variable is set to the remote host's IP address whenever &$host$& is set
11754 for a remote connection. It is also set to the IP address that is being checked
11755 when the &%ignore_target_hosts%& option is being processed.
11756
11757 .vitem &$host_data$&
11758 .vindex "&$host_data$&"
11759 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11760 result of the lookup is made available in the &$host_data$& variable. This
11761 allows you, for example, to do things like this:
11762 .code
11763 deny  hosts = net-lsearch;/some/file
11764 message = $host_data
11765 .endd
11766 .vitem &$host_lookup_deferred$&
11767 .cindex "host name" "lookup, failure of"
11768 .vindex "&$host_lookup_deferred$&"
11769 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11770 message comes from a remote host and there is an attempt to look up the host's
11771 name from its IP address, and the attempt is not successful, one of these
11772 variables is set to &"1"&.
11773
11774 .ilist
11775 If the lookup receives a definite negative response (for example, a DNS lookup
11776 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11777
11778 .next
11779 If there is any kind of problem during the lookup, such that Exim cannot
11780 tell whether or not the host name is defined (for example, a timeout for a DNS
11781 lookup), &$host_lookup_deferred$& is set to &"1"&.
11782 .endlist ilist
11783
11784 Looking up a host's name from its IP address consists of more than just a
11785 single reverse lookup. Exim checks that a forward lookup of at least one of the
11786 names it receives from a reverse lookup yields the original IP address. If this
11787 is not the case, Exim does not accept the looked up name(s), and
11788 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11789 IP address (for example, the existence of a PTR record in the DNS) is not
11790 sufficient on its own for the success of a host name lookup. If the reverse
11791 lookup succeeds, but there is a lookup problem such as a timeout when checking
11792 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11793 &"1"&. See also &$sender_host_name$&.
11794
11795 .vitem &$host_lookup_failed$&
11796 .vindex "&$host_lookup_failed$&"
11797 See &$host_lookup_deferred$&.
11798
11799 .vitem &$host_port$&
11800 .vindex "&$host_port$&"
11801 This variable is set to the remote host's TCP port whenever &$host$& is set
11802 for an outbound connection.
11803
11804 .vitem &$initial_cwd$&
11805 .vindex "&$initial_cwd$&
11806 This variable contains the full path name of the initial working
11807 directory of the current Exim process. This may differ from the current
11808 working directory, as Exim changes this to "/" during early startup, and
11809 to &$spool_directory$& later.
11810
11811 .vitem &$inode$&
11812 .vindex "&$inode$&"
11813 The only time this variable is set is while expanding the &%directory_file%&
11814 option in the &(appendfile)& transport. The variable contains the inode number
11815 of the temporary file which is about to be renamed. It can be used to construct
11816 a unique name for the file.
11817
11818 .vitem &$interface_address$&
11819 .vindex "&$interface_address$&"
11820 This is an obsolete name for &$received_ip_address$&.
11821
11822 .vitem &$interface_port$&
11823 .vindex "&$interface_port$&"
11824 This is an obsolete name for &$received_port$&.
11825
11826 .vitem &$item$&
11827 .vindex "&$item$&"
11828 This variable is used during the expansion of &*forall*& and &*forany*&
11829 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11830 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11831 empty.
11832
11833 .vitem &$ldap_dn$&
11834 .vindex "&$ldap_dn$&"
11835 This variable, which is available only when Exim is compiled with LDAP support,
11836 contains the DN from the last entry in the most recently successful LDAP
11837 lookup.
11838
11839 .vitem &$load_average$&
11840 .vindex "&$load_average$&"
11841 This variable contains the system load average, multiplied by 1000 so that it
11842 is an integer. For example, if the load average is 0.21, the value of the
11843 variable is 210. The value is recomputed every time the variable is referenced.
11844
11845 .vitem &$local_part$&
11846 .vindex "&$local_part$&"
11847 When an address is being routed, or delivered on its own, this
11848 variable contains the local part. When a number of addresses are being
11849 delivered together (for example, multiple RCPT commands in an SMTP
11850 session), &$local_part$& is not set.
11851
11852 Global address rewriting happens when a message is received, so the value of
11853 &$local_part$& during routing and delivery is the value after rewriting.
11854 &$local_part$& is set during user filtering, but not during system filtering,
11855 because a message may have many recipients and the system filter is called just
11856 once.
11857
11858 .vindex "&$local_part_prefix$&"
11859 .vindex "&$local_part_suffix$&"
11860 If a local part prefix or suffix has been recognized, it is not included in the
11861 value of &$local_part$& during routing and subsequent delivery. The values of
11862 any prefix or suffix are in &$local_part_prefix$& and
11863 &$local_part_suffix$&, respectively.
11864
11865 When a message is being delivered to a file, pipe, or autoreply transport as a
11866 result of aliasing or forwarding, &$local_part$& is set to the local part of
11867 the parent address, not to the file name or command (see &$address_file$& and
11868 &$address_pipe$&).
11869
11870 When an ACL is running for a RCPT command, &$local_part$& contains the
11871 local part of the recipient address.
11872
11873 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11874 &$local_part$& contains the local part of the address that is being rewritten;
11875 it can be used in the expansion of the replacement address, for example.
11876
11877 In all cases, all quoting is removed from the local part. For example, for both
11878 the addresses
11879 .code
11880 "abc:xyz"@test.example
11881 abc\:xyz@test.example
11882 .endd
11883 the value of &$local_part$& is
11884 .code
11885 abc:xyz
11886 .endd
11887 If you use &$local_part$& to create another address, you should always wrap it
11888 inside a quoting operator. For example, in a &(redirect)& router you could
11889 have:
11890 .code
11891 data = ${quote_local_part:$local_part}@new.domain.example
11892 .endd
11893 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11894 to process local parts in a case-dependent manner in a router, you can set the
11895 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11896
11897 .vitem &$local_part_data$&
11898 .vindex "&$local_part_data$&"
11899 When the &%local_parts%& option on a router matches a local part by means of a
11900 lookup, the data read by the lookup is available during the running of the
11901 router as &$local_part_data$&. In addition, if the driver routes the address
11902 to a transport, the value is available in that transport. If the transport is
11903 handling multiple addresses, the value from the first address is used.
11904
11905 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11906 matches a local part by means of a lookup. The data read by the lookup is
11907 available during the rest of the ACL statement. In all other situations, this
11908 variable expands to nothing.
11909
11910 .vitem &$local_part_prefix$&
11911 .vindex "&$local_part_prefix$&"
11912 When an address is being routed or delivered, and a
11913 specific prefix for the local part was recognized, it is available in this
11914 variable, having been removed from &$local_part$&.
11915
11916 .vitem &$local_part_suffix$&
11917 .vindex "&$local_part_suffix$&"
11918 When an address is being routed or delivered, and a
11919 specific suffix for the local part was recognized, it is available in this
11920 variable, having been removed from &$local_part$&.
11921
11922 .vitem &$local_scan_data$&
11923 .vindex "&$local_scan_data$&"
11924 This variable contains the text returned by the &[local_scan()]& function when
11925 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11926
11927 .vitem &$local_user_gid$&
11928 .vindex "&$local_user_gid$&"
11929 See &$local_user_uid$&.
11930
11931 .vitem &$local_user_uid$&
11932 .vindex "&$local_user_uid$&"
11933 This variable and &$local_user_gid$& are set to the uid and gid after the
11934 &%check_local_user%& router precondition succeeds. This means that their values
11935 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11936 and &%condition%&), for the &%address_data%& expansion, and for any
11937 router-specific expansions. At all other times, the values in these variables
11938 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11939
11940 .vitem &$localhost_number$&
11941 .vindex "&$localhost_number$&"
11942 This contains the expanded value of the
11943 &%localhost_number%& option. The expansion happens after the main options have
11944 been read.
11945
11946 .vitem &$log_inodes$&
11947 .vindex "&$log_inodes$&"
11948 The number of free inodes in the disk partition where Exim's
11949 log files are being written. The value is recalculated whenever the variable is
11950 referenced. If the relevant file system does not have the concept of inodes,
11951 the value of is -1. See also the &%check_log_inodes%& option.
11952
11953 .vitem &$log_space$&
11954 .vindex "&$log_space$&"
11955 The amount of free space (as a number of kilobytes) in the disk
11956 partition where Exim's log files are being written. The value is recalculated
11957 whenever the variable is referenced. If the operating system does not have the
11958 ability to find the amount of free space (only true for experimental systems),
11959 the space value is -1. See also the &%check_log_space%& option.
11960
11961
11962 .vitem &$lookup_dnssec_authenticated$&
11963 .vindex "&$lookup_dnssec_authenticated$&"
11964 This variable is set after a DNS lookup done by
11965 a dnsdb lookup expansion, dnslookup router or smtp transport.
11966 .cindex "DNS" "DNSSEC"
11967 It will be empty if &(DNSSEC)& was not requested,
11968 &"no"& if the result was not labelled as authenticated data
11969 and &"yes"& if it was.
11970 Results that are labelled as authoritative answer that match
11971 the &%dns_trust_aa%& configuration variable count also
11972 as authenticated data.
11973
11974 .vitem &$mailstore_basename$&
11975 .vindex "&$mailstore_basename$&"
11976 This variable is set only when doing deliveries in &"mailstore"& format in the
11977 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11978 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11979 contains the basename of the files that are being written, that is, the name
11980 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11981 variable is empty.
11982
11983 .vitem &$malware_name$&
11984 .vindex "&$malware_name$&"
11985 This variable is available when Exim is compiled with the
11986 content-scanning extension. It is set to the name of the virus that was found
11987 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11988
11989 .vitem &$max_received_linelength$&
11990 .vindex "&$max_received_linelength$&"
11991 .cindex "maximum" "line length"
11992 .cindex "line length" "maximum"
11993 This variable contains the number of bytes in the longest line that was
11994 received as part of the message, not counting the line termination
11995 character(s).
11996
11997 .vitem &$message_age$&
11998 .cindex "message" "age of"
11999 .vindex "&$message_age$&"
12000 This variable is set at the start of a delivery attempt to contain the number
12001 of seconds since the message was received. It does not change during a single
12002 delivery attempt.
12003
12004 .vitem &$message_body$&
12005 .cindex "body of message" "expansion variable"
12006 .cindex "message body" "in expansion"
12007 .cindex "binary zero" "in message body"
12008 .vindex "&$message_body$&"
12009 .oindex "&%message_body_visible%&"
12010 This variable contains the initial portion of a message's body while it is
12011 being delivered, and is intended mainly for use in filter files. The maximum
12012 number of characters of the body that are put into the variable is set by the
12013 &%message_body_visible%& configuration option; the default is 500.
12014
12015 .oindex "&%message_body_newlines%&"
12016 By default, newlines are converted into spaces in &$message_body$&, to make it
12017 easier to search for phrases that might be split over a line break. However,
12018 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12019 zeros are always converted into spaces.
12020
12021 .vitem &$message_body_end$&
12022 .cindex "body of message" "expansion variable"
12023 .cindex "message body" "in expansion"
12024 .vindex "&$message_body_end$&"
12025 This variable contains the final portion of a message's
12026 body while it is being delivered. The format and maximum size are as for
12027 &$message_body$&.
12028
12029 .vitem &$message_body_size$&
12030 .cindex "body of message" "size"
12031 .cindex "message body" "size"
12032 .vindex "&$message_body_size$&"
12033 When a message is being delivered, this variable contains the size of the body
12034 in bytes. The count starts from the character after the blank line that
12035 separates the body from the header. Newlines are included in the count. See
12036 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12037
12038 .vitem &$message_exim_id$&
12039 .vindex "&$message_exim_id$&"
12040 When a message is being received or delivered, this variable contains the
12041 unique message id that is generated and used by Exim to identify the message.
12042 An id is not created for a message until after its header has been successfully
12043 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12044 line; it is the local id that Exim assigns to the message, for example:
12045 &`1BXTIK-0001yO-VA`&.
12046
12047 .vitem &$message_headers$&
12048 .vindex &$message_headers$&
12049 This variable contains a concatenation of all the header lines when a message
12050 is being processed, except for lines added by routers or transports. The header
12051 lines are separated by newline characters. Their contents are decoded in the
12052 same way as a header line that is inserted by &%bheader%&.
12053
12054 .vitem &$message_headers_raw$&
12055 .vindex &$message_headers_raw$&
12056 This variable is like &$message_headers$& except that no processing of the
12057 contents of header lines is done.
12058
12059 .vitem &$message_id$&
12060 This is an old name for &$message_exim_id$&. It is now deprecated.
12061
12062 .vitem &$message_linecount$&
12063 .vindex "&$message_linecount$&"
12064 This variable contains the total number of lines in the header and body of the
12065 message. Compare &$body_linecount$&, which is the count for the body only.
12066 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12067 number of lines received. Before delivery happens (that is, before filters,
12068 routers, and transports run) the count is increased to include the
12069 &'Received:'& header line that Exim standardly adds, and also any other header
12070 lines that are added by ACLs. The blank line that separates the message header
12071 from the body is not counted.
12072
12073 As with the special case of &$message_size$&, during the expansion of the
12074 appendfile transport's maildir_tag option in maildir format, the value of
12075 &$message_linecount$& is the precise size of the number of newlines in the
12076 file that has been written (minus one for the blank line between the
12077 header and the body).
12078
12079 Here is an example of the use of this variable in a DATA ACL:
12080 .code
12081 deny message   = Too many lines in message header
12082      condition = \
12083       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12084 .endd
12085 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12086 message has not yet been received.
12087
12088 .vitem &$message_size$&
12089 .cindex "size" "of message"
12090 .cindex "message" "size"
12091 .vindex "&$message_size$&"
12092 When a message is being processed, this variable contains its size in bytes. In
12093 most cases, the size includes those headers that were received with the
12094 message, but not those (such as &'Envelope-to:'&) that are added to individual
12095 deliveries as they are written. However, there is one special case: during the
12096 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12097 doing a delivery in maildir format, the value of &$message_size$& is the
12098 precise size of the file that has been written. See also
12099 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12100
12101 .cindex "RCPT" "value of &$message_size$&"
12102 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12103 contains the size supplied on the MAIL command, or -1 if no size was given. The
12104 value may not, of course, be truthful.
12105
12106 .vitem &$mime_$&&'xxx'&
12107 A number of variables whose names start with &$mime$& are
12108 available when Exim is compiled with the content-scanning extension. For
12109 details, see section &<<SECTscanmimepart>>&.
12110
12111 .vitem "&$n0$& &-- &$n9$&"
12112 These variables are counters that can be incremented by means
12113 of the &%add%& command in filter files.
12114
12115 .vitem &$original_domain$&
12116 .vindex "&$domain$&"
12117 .vindex "&$original_domain$&"
12118 When a top-level address is being processed for delivery, this contains the
12119 same value as &$domain$&. However, if a &"child"& address (for example,
12120 generated by an alias, forward, or filter file) is being processed, this
12121 variable contains the domain of the original address (lower cased). This
12122 differs from &$parent_domain$& only when there is more than one level of
12123 aliasing or forwarding. When more than one address is being delivered in a
12124 single transport run, &$original_domain$& is not set.
12125
12126 If a new address is created by means of a &%deliver%& command in a system
12127 filter, it is set up with an artificial &"parent"& address. This has the local
12128 part &'system-filter'& and the default qualify domain.
12129
12130 .vitem &$original_local_part$&
12131 .vindex "&$local_part$&"
12132 .vindex "&$original_local_part$&"
12133 When a top-level address is being processed for delivery, this contains the
12134 same value as &$local_part$&, unless a prefix or suffix was removed from the
12135 local part, because &$original_local_part$& always contains the full local
12136 part. When a &"child"& address (for example, generated by an alias, forward, or
12137 filter file) is being processed, this variable contains the full local part of
12138 the original address.
12139
12140 If the router that did the redirection processed the local part
12141 case-insensitively, the value in &$original_local_part$& is in lower case.
12142 This variable differs from &$parent_local_part$& only when there is more than
12143 one level of aliasing or forwarding. When more than one address is being
12144 delivered in a single transport run, &$original_local_part$& is not set.
12145
12146 If a new address is created by means of a &%deliver%& command in a system
12147 filter, it is set up with an artificial &"parent"& address. This has the local
12148 part &'system-filter'& and the default qualify domain.
12149
12150 .vitem &$originator_gid$&
12151 .cindex "gid (group id)" "of originating user"
12152 .cindex "sender" "gid"
12153 .vindex "&$caller_gid$&"
12154 .vindex "&$originator_gid$&"
12155 This variable contains the value of &$caller_gid$& that was set when the
12156 message was received. For messages received via the command line, this is the
12157 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12158 normally the gid of the Exim user.
12159
12160 .vitem &$originator_uid$&
12161 .cindex "uid (user id)" "of originating user"
12162 .cindex "sender" "uid"
12163 .vindex "&$caller_uid$&"
12164 .vindex "&$originaltor_uid$&"
12165 The value of &$caller_uid$& that was set when the message was received. For
12166 messages received via the command line, this is the uid of the sending user.
12167 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12168 user.
12169
12170 .vitem &$parent_domain$&
12171 .vindex "&$parent_domain$&"
12172 This variable is similar to &$original_domain$& (see
12173 above), except that it refers to the immediately preceding parent address.
12174
12175 .vitem &$parent_local_part$&
12176 .vindex "&$parent_local_part$&"
12177 This variable is similar to &$original_local_part$&
12178 (see above), except that it refers to the immediately preceding parent address.
12179
12180 .vitem &$pid$&
12181 .cindex "pid (process id)" "of current process"
12182 .vindex "&$pid$&"
12183 This variable contains the current process id.
12184
12185 .vitem &$pipe_addresses$&
12186 .cindex "filter" "transport filter"
12187 .cindex "transport" "filter"
12188 .vindex "&$pipe_addresses$&"
12189 This is not an expansion variable, but is mentioned here because the string
12190 &`$pipe_addresses`& is handled specially in the command specification for the
12191 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12192 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12193 It cannot be used in general expansion strings, and provokes an &"unknown
12194 variable"& error if encountered.
12195
12196 .vitem &$primary_hostname$&
12197 .vindex "&$primary_hostname$&"
12198 This variable contains the value set by &%primary_hostname%& in the
12199 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12200 a single-component name, Exim calls &[gethostbyname()]& (or
12201 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12202 qualified host name. See also &$smtp_active_hostname$&.
12203
12204
12205 .new
12206 .vitem &$proxy_external_address$& &&&
12207        &$proxy_external_port$& &&&
12208        &$proxy_local_address$& &&&
12209        &$proxy_local_port$& &&&
12210        &$proxy_session$&
12211 These variables are only available when built with Proxy Protocol
12212 or Socks5 support
12213 For details see chapter &<<SECTproxyInbound>>&.
12214 .wen
12215
12216 .vitem &$prdr_requested$&
12217 .cindex "PRDR" "variable for"
12218 This variable is set to &"yes"& if PRDR was requested by the client for the
12219 current message, otherwise &"no"&.
12220
12221 .vitem &$prvscheck_address$&
12222 This variable is used in conjunction with the &%prvscheck%& expansion item,
12223 which is described in sections &<<SECTexpansionitems>>& and
12224 &<<SECTverifyPRVS>>&.
12225
12226 .vitem &$prvscheck_keynum$&
12227 This variable is used in conjunction with the &%prvscheck%& expansion item,
12228 which is described in sections &<<SECTexpansionitems>>& and
12229 &<<SECTverifyPRVS>>&.
12230
12231 .vitem &$prvscheck_result$&
12232 This variable is used in conjunction with the &%prvscheck%& expansion item,
12233 which is described in sections &<<SECTexpansionitems>>& and
12234 &<<SECTverifyPRVS>>&.
12235
12236 .vitem &$qualify_domain$&
12237 .vindex "&$qualify_domain$&"
12238 The value set for the &%qualify_domain%& option in the configuration file.
12239
12240 .vitem &$qualify_recipient$&
12241 .vindex "&$qualify_recipient$&"
12242 The value set for the &%qualify_recipient%& option in the configuration file,
12243 or if not set, the value of &$qualify_domain$&.
12244
12245 .new
12246 .vitem &$queue_name$&
12247 .vindex &$queue_name$&
12248 .cindex "named queues"
12249 .cindex queues named
12250 The name of the spool queue in use; empty for the default queue.
12251 .wen
12252
12253 .vitem &$rcpt_count$&
12254 .vindex "&$rcpt_count$&"
12255 When a message is being received by SMTP, this variable contains the number of
12256 RCPT commands received for the current message. If this variable is used in a
12257 RCPT ACL, its value includes the current command.
12258
12259 .vitem &$rcpt_defer_count$&
12260 .vindex "&$rcpt_defer_count$&"
12261 .cindex "4&'xx'& responses" "count of"
12262 When a message is being received by SMTP, this variable contains the number of
12263 RCPT commands in the current message that have previously been rejected with a
12264 temporary (4&'xx'&) response.
12265
12266 .vitem &$rcpt_fail_count$&
12267 .vindex "&$rcpt_fail_count$&"
12268 When a message is being received by SMTP, this variable contains the number of
12269 RCPT commands in the current message that have previously been rejected with a
12270 permanent (5&'xx'&) response.
12271
12272 .vitem &$received_count$&
12273 .vindex "&$received_count$&"
12274 This variable contains the number of &'Received:'& header lines in the message,
12275 including the one added by Exim (so its value is always greater than zero). It
12276 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12277 delivering.
12278
12279 .vitem &$received_for$&
12280 .vindex "&$received_for$&"
12281 If there is only a single recipient address in an incoming message, this
12282 variable contains that address when the &'Received:'& header line is being
12283 built. The value is copied after recipient rewriting has happened, but before
12284 the &[local_scan()]& function is run.
12285
12286 .vitem &$received_ip_address$&
12287 .vindex "&$received_ip_address$&"
12288 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12289 variable is set to the address of the local IP interface, and &$received_port$&
12290 is set to the local port number. (The remote IP address and port are in
12291 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12292 the port value is -1 unless it has been set using the &%-oMi%& command line
12293 option.
12294
12295 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12296 could be used, for example, to make the file name for a TLS certificate depend
12297 on which interface and/or port is being used for the incoming connection. The
12298 values of &$received_ip_address$& and &$received_port$& are saved with any
12299 messages that are received, thus making these variables available at delivery
12300 time.
12301 For outbound connections see &$sending_ip_address$&.
12302
12303 .vitem &$received_port$&
12304 .vindex "&$received_port$&"
12305 See &$received_ip_address$&.
12306
12307 .vitem &$received_protocol$&
12308 .vindex "&$received_protocol$&"
12309 When a message is being processed, this variable contains the name of the
12310 protocol by which it was received. Most of the names used by Exim are defined
12311 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12312 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12313 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12314 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12315 connection and the client was successfully authenticated.
12316
12317 Exim uses the protocol name &"smtps"& for the case when encryption is
12318 automatically set up on connection without the use of STARTTLS (see
12319 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12320 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12321 where the client initially uses EHLO, sets up an encrypted connection using
12322 STARTTLS, and then uses HELO afterwards.
12323
12324 The &%-oMr%& option provides a way of specifying a custom protocol name for
12325 messages that are injected locally by trusted callers. This is commonly used to
12326 identify messages that are being re-injected after some kind of scanning.
12327
12328 .vitem &$received_time$&
12329 .vindex "&$received_time$&"
12330 This variable contains the date and time when the current message was received,
12331 as a number of seconds since the start of the Unix epoch.
12332
12333 .vitem &$recipient_data$&
12334 .vindex "&$recipient_data$&"
12335 This variable is set after an indexing lookup success in an ACL &%recipients%&
12336 condition. It contains the data from the lookup, and the value remains set
12337 until the next &%recipients%& test. Thus, you can do things like this:
12338 .display
12339 &`require recipients  = cdb*@;/some/file`&
12340 &`deny    `&&'some further test involving'& &`$recipient_data`&
12341 .endd
12342 &*Warning*&: This variable is set only when a lookup is used as an indexing
12343 method in the address list, using the semicolon syntax as in the example above.
12344 The variable is not set for a lookup that is used as part of the string
12345 expansion that all such lists undergo before being interpreted.
12346
12347 .vitem &$recipient_verify_failure$&
12348 .vindex "&$recipient_verify_failure$&"
12349 In an ACL, when a recipient verification fails, this variable contains
12350 information about the failure. It is set to one of the following words:
12351
12352 .ilist
12353 &"qualify"&: The address was unqualified (no domain), and the message
12354 was neither local nor came from an exempted host.
12355
12356 .next
12357 &"route"&: Routing failed.
12358
12359 .next
12360 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12361 or before the MAIL command (that is, on initial connection, HELO, or
12362 MAIL).
12363
12364 .next
12365 &"recipient"&: The RCPT command in a callout was rejected.
12366 .next
12367
12368 &"postmaster"&: The postmaster check in a callout was rejected.
12369 .endlist
12370
12371 The main use of this variable is expected to be to distinguish between
12372 rejections of MAIL and rejections of RCPT.
12373
12374 .vitem &$recipients$&
12375 .vindex "&$recipients$&"
12376 This variable contains a list of envelope recipients for a message. A comma and
12377 a space separate the addresses in the replacement text. However, the variable
12378 is not generally available, to prevent exposure of Bcc recipients in
12379 unprivileged users' filter files. You can use &$recipients$& only in these
12380 cases:
12381
12382 .olist
12383 In a system filter file.
12384 .next
12385 In the ACLs associated with the DATA command and with non-SMTP messages, that
12386 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12387 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12388 &%acl_not_smtp_mime%&.
12389 .next
12390 From within a &[local_scan()]& function.
12391 .endlist
12392
12393
12394 .vitem &$recipients_count$&
12395 .vindex "&$recipients_count$&"
12396 When a message is being processed, this variable contains the number of
12397 envelope recipients that came with the message. Duplicates are not excluded
12398 from the count. While a message is being received over SMTP, the number
12399 increases for each accepted recipient. It can be referenced in an ACL.
12400
12401
12402 .vitem &$regex_match_string$&
12403 .vindex "&$regex_match_string$&"
12404 This variable is set to contain the matching regular expression after a
12405 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12406
12407 .vitem "&$regex1$&, &$regex2$&, etc"
12408 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12409 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12410 these variables contain the
12411 captured substrings identified by the regular expression.
12412
12413
12414 .vitem &$reply_address$&
12415 .vindex "&$reply_address$&"
12416 When a message is being processed, this variable contains the contents of the
12417 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12418 contents of the &'From:'& header line. Apart from the removal of leading
12419 white space, the value is not processed in any way. In particular, no RFC 2047
12420 decoding or character code translation takes place.
12421
12422 .vitem &$return_path$&
12423 .vindex "&$return_path$&"
12424 When a message is being delivered, this variable contains the return path &--
12425 the sender field that will be sent as part of the envelope. It is not enclosed
12426 in <> characters. At the start of routing an address, &$return_path$& has the
12427 same value as &$sender_address$&, but if, for example, an incoming message to a
12428 mailing list has been expanded by a router which specifies a different address
12429 for bounce messages, &$return_path$& subsequently contains the new bounce
12430 address, whereas &$sender_address$& always contains the original sender address
12431 that was received with the message. In other words, &$sender_address$& contains
12432 the incoming envelope sender, and &$return_path$& contains the outgoing
12433 envelope sender.
12434
12435 .vitem &$return_size_limit$&
12436 .vindex "&$return_size_limit$&"
12437 This is an obsolete name for &$bounce_return_size_limit$&.
12438
12439 .vitem &$router_name$&
12440 .cindex "router" "name"
12441 .cindex "name" "of router"
12442 .vindex "&$router_name$&"
12443 During the running of a router this variable contains its name.
12444
12445 .vitem &$runrc$&
12446 .cindex "return code" "from &%run%& expansion"
12447 .vindex "&$runrc$&"
12448 This variable contains the return code from a command that is run by the
12449 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12450 assume the order in which option values are expanded, except for those
12451 preconditions whose order of testing is documented. Therefore, you cannot
12452 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12453 another.
12454
12455 .vitem &$self_hostname$&
12456 .oindex "&%self%&" "value of host name"
12457 .vindex "&$self_hostname$&"
12458 When an address is routed to a supposedly remote host that turns out to be the
12459 local host, what happens is controlled by the &%self%& generic router option.
12460 One of its values causes the address to be passed to another router. When this
12461 happens, &$self_hostname$& is set to the name of the local host that the
12462 original router encountered. In other circumstances its contents are null.
12463
12464 .vitem &$sender_address$&
12465 .vindex "&$sender_address$&"
12466 When a message is being processed, this variable contains the sender's address
12467 that was received in the message's envelope. The case of letters in the address
12468 is retained, in both the local part and the domain. For bounce messages, the
12469 value of this variable is the empty string. See also &$return_path$&.
12470
12471 .vitem &$sender_address_data$&
12472 .vindex "&$address_data$&"
12473 .vindex "&$sender_address_data$&"
12474 If &$address_data$& is set when the routers are called from an ACL to verify a
12475 sender address, the final value is preserved in &$sender_address_data$&, to
12476 distinguish it from data from a recipient address. The value does not persist
12477 after the end of the current ACL statement. If you want to preserve it for
12478 longer, you can save it in an ACL variable.
12479
12480 .vitem &$sender_address_domain$&
12481 .vindex "&$sender_address_domain$&"
12482 The domain portion of &$sender_address$&.
12483
12484 .vitem &$sender_address_local_part$&
12485 .vindex "&$sender_address_local_part$&"
12486 The local part portion of &$sender_address$&.
12487
12488 .vitem &$sender_data$&
12489 .vindex "&$sender_data$&"
12490 This variable is set after a lookup success in an ACL &%senders%& condition or
12491 in a router &%senders%& option. It contains the data from the lookup, and the
12492 value remains set until the next &%senders%& test. Thus, you can do things like
12493 this:
12494 .display
12495 &`require senders      = cdb*@;/some/file`&
12496 &`deny    `&&'some further test involving'& &`$sender_data`&
12497 .endd
12498 &*Warning*&: This variable is set only when a lookup is used as an indexing
12499 method in the address list, using the semicolon syntax as in the example above.
12500 The variable is not set for a lookup that is used as part of the string
12501 expansion that all such lists undergo before being interpreted.
12502
12503 .vitem &$sender_fullhost$&
12504 .vindex "&$sender_fullhost$&"
12505 When a message is received from a remote host, this variable contains the host
12506 name and IP address in a single string. It ends with the IP address in square
12507 brackets, followed by a colon and a port number if the logging of ports is
12508 enabled. The format of the rest of the string depends on whether the host
12509 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12510 looking up its IP address. (Looking up the IP address can be forced by the
12511 &%host_lookup%& option, independent of verification.) A plain host name at the
12512 start of the string is a verified host name; if this is not present,
12513 verification either failed or was not requested. A host name in parentheses is
12514 the argument of a HELO or EHLO command. This is omitted if it is identical to
12515 the verified host name or to the host's IP address in square brackets.
12516
12517 .vitem &$sender_helo_dnssec$&
12518 .vindex "&$sender_helo_dnssec$&"
12519 This boolean variable is true if a successful HELO verification was
12520 .cindex "DNS" "DNSSEC"
12521 done using DNS information the resolver library stated was authenticated data.
12522
12523 .vitem &$sender_helo_name$&
12524 .vindex "&$sender_helo_name$&"
12525 When a message is received from a remote host that has issued a HELO or EHLO
12526 command, the argument of that command is placed in this variable. It is also
12527 set if HELO or EHLO is used when a message is received using SMTP locally via
12528 the &%-bs%& or &%-bS%& options.
12529
12530 .vitem &$sender_host_address$&
12531 .vindex "&$sender_host_address$&"
12532 When a message is received from a remote host using SMTP,
12533 this variable contains that
12534 host's IP address. For locally non-SMTP submitted messages, it is empty.
12535
12536 .vitem &$sender_host_authenticated$&
12537 .vindex "&$sender_host_authenticated$&"
12538 This variable contains the name (not the public name) of the authenticator
12539 driver that successfully authenticated the client from which the message was
12540 received. It is empty if there was no successful authentication. See also
12541 &$authenticated_id$&.
12542
12543 .vitem &$sender_host_dnssec$&
12544 .vindex "&$sender_host_dnssec$&"
12545 If an attempt to populate &$sender_host_name$& has been made
12546 (by reference, &%hosts_lookup%& or
12547 otherwise) then this boolean will have been set true if, and only if, the
12548 resolver library states that both
12549 the reverse and forward DNS were authenticated data.  At all
12550 other times, this variable is false.
12551
12552 .cindex "DNS" "DNSSEC"
12553 It is likely that you will need to coerce DNSSEC support on in the resolver
12554 library, by setting:
12555 .code
12556 dns_dnssec_ok = 1
12557 .endd
12558
12559 Exim does not perform DNSSEC validation itself, instead leaving that to a
12560 validating resolver (e.g. unbound, or bind with suitable configuration).
12561
12562 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12563 mechanism in the list, then this variable will be false.
12564
12565
12566 .vitem &$sender_host_name$&
12567 .vindex "&$sender_host_name$&"
12568 When a message is received from a remote host, this variable contains the
12569 host's name as obtained by looking up its IP address. For messages received by
12570 other means, this variable is empty.
12571
12572 .vindex "&$host_lookup_failed$&"
12573 If the host name has not previously been looked up, a reference to
12574 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12575 A looked up name is accepted only if it leads back to the original IP address
12576 via a forward lookup. If either the reverse or the forward lookup fails to find
12577 any data, or if the forward lookup does not yield the original IP address,
12578 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12579
12580 .vindex "&$host_lookup_deferred$&"
12581 However, if either of the lookups cannot be completed (for example, there is a
12582 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12583 &$host_lookup_failed$& remains set to &"0"&.
12584
12585 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12586 host name again if there is a subsequent reference to &$sender_host_name$&
12587 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12588 is set to &"1"&.
12589
12590 Exim does not automatically look up every calling host's name. If you want
12591 maximum efficiency, you should arrange your configuration so that it avoids
12592 these lookups altogether. The lookup happens only if one or more of the
12593 following are true:
12594
12595 .ilist
12596 A string containing &$sender_host_name$& is expanded.
12597 .next
12598 The calling host matches the list in &%host_lookup%&. In the default
12599 configuration, this option is set to *, so it must be changed if lookups are
12600 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12601 .next
12602 Exim needs the host name in order to test an item in a host list. The items
12603 that require this are described in sections &<<SECThoslispatnam>>& and
12604 &<<SECThoslispatnamsk>>&.
12605 .next
12606 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12607 In this case, the host name is required to compare with the name quoted in any
12608 EHLO or HELO commands that the client issues.
12609 .next
12610 The remote host issues a EHLO or HELO command that quotes one of the
12611 domains in &%helo_lookup_domains%&. The default value of this option is
12612 . ==== As this is a nested list, any displays it contains must be indented
12613 . ==== as otherwise they are too far to the left.
12614 .code
12615   helo_lookup_domains = @ : @[]
12616 .endd
12617 which causes a lookup if a remote host (incorrectly) gives the server's name or
12618 IP address in an EHLO or HELO command.
12619 .endlist
12620
12621
12622 .vitem &$sender_host_port$&
12623 .vindex "&$sender_host_port$&"
12624 When a message is received from a remote host, this variable contains the port
12625 number that was used on the remote host.
12626
12627 .vitem &$sender_ident$&
12628 .vindex "&$sender_ident$&"
12629 When a message is received from a remote host, this variable contains the
12630 identification received in response to an RFC 1413 request. When a message has
12631 been received locally, this variable contains the login name of the user that
12632 called Exim.
12633
12634 .vitem &$sender_rate_$&&'xxx'&
12635 A number of variables whose names begin &$sender_rate_$& are set as part of the
12636 &%ratelimit%& ACL condition. Details are given in section
12637 &<<SECTratelimiting>>&.
12638
12639 .vitem &$sender_rcvhost$&
12640 .cindex "DNS" "reverse lookup"
12641 .cindex "reverse DNS lookup"
12642 .vindex "&$sender_rcvhost$&"
12643 This is provided specifically for use in &'Received:'& headers. It starts with
12644 either the verified host name (as obtained from a reverse DNS lookup) or, if
12645 there is no verified host name, the IP address in square brackets. After that
12646 there may be text in parentheses. When the first item is a verified host name,
12647 the first thing in the parentheses is the IP address in square brackets,
12648 followed by a colon and a port number if port logging is enabled. When the
12649 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12650 the parentheses.
12651
12652 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12653 was used and its argument was not identical to the real host name or IP
12654 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12655 all three items are present in the parentheses, a newline and tab are inserted
12656 into the string, to improve the formatting of the &'Received:'& header.
12657
12658 .vitem &$sender_verify_failure$&
12659 .vindex "&$sender_verify_failure$&"
12660 In an ACL, when a sender verification fails, this variable contains information
12661 about the failure. The details are the same as for
12662 &$recipient_verify_failure$&.
12663
12664 .vitem &$sending_ip_address$&
12665 .vindex "&$sending_ip_address$&"
12666 This variable is set whenever an outgoing SMTP connection to another host has
12667 been set up. It contains the IP address of the local interface that is being
12668 used. This is useful if a host that has more than one IP address wants to take
12669 on different personalities depending on which one is being used. For incoming
12670 connections, see &$received_ip_address$&.
12671
12672 .vitem &$sending_port$&
12673 .vindex "&$sending_port$&"
12674 This variable is set whenever an outgoing SMTP connection to another host has
12675 been set up. It contains the local port that is being used. For incoming
12676 connections, see &$received_port$&.
12677
12678 .vitem &$smtp_active_hostname$&
12679 .vindex "&$smtp_active_hostname$&"
12680 During an incoming SMTP session, this variable contains the value of the active
12681 host name, as specified by the &%smtp_active_hostname%& option. The value of
12682 &$smtp_active_hostname$& is saved with any message that is received, so its
12683 value can be consulted during routing and delivery.
12684
12685 .vitem &$smtp_command$&
12686 .vindex "&$smtp_command$&"
12687 During the processing of an incoming SMTP command, this variable contains the
12688 entire command. This makes it possible to distinguish between HELO and EHLO in
12689 the HELO ACL, and also to distinguish between commands such as these:
12690 .code
12691 MAIL FROM:<>
12692 MAIL FROM: <>
12693 .endd
12694 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12695 command, the address in &$smtp_command$& is the original address before any
12696 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12697 the address after SMTP-time rewriting.
12698
12699 .vitem &$smtp_command_argument$&
12700 .cindex "SMTP" "command, argument for"
12701 .vindex "&$smtp_command_argument$&"
12702 While an ACL is running to check an SMTP command, this variable contains the
12703 argument, that is, the text that follows the command name, with leading white
12704 space removed. Following the introduction of &$smtp_command$&, this variable is
12705 somewhat redundant, but is retained for backwards compatibility.
12706
12707 .vitem &$smtp_count_at_connection_start$&
12708 .vindex "&$smtp_count_at_connection_start$&"
12709 This variable is set greater than zero only in processes spawned by the Exim
12710 daemon for handling incoming SMTP connections. The name is deliberately long,
12711 in order to emphasize what the contents are. When the daemon accepts a new
12712 connection, it increments this variable. A copy of the variable is passed to
12713 the child process that handles the connection, but its value is fixed, and
12714 never changes. It is only an approximation of how many incoming connections
12715 there actually are, because many other connections may come and go while a
12716 single connection is being processed. When a child process terminates, the
12717 daemon decrements its copy of the variable.
12718
12719 .vitem "&$sn0$& &-- &$sn9$&"
12720 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12721 that were current at the end of the system filter file. This allows a system
12722 filter file to set values that can be tested in users' filter files. For
12723 example, a system filter could set a value indicating how likely it is that a
12724 message is junk mail.
12725
12726 .vitem &$spam_$&&'xxx'&
12727 A number of variables whose names start with &$spam$& are available when Exim
12728 is compiled with the content-scanning extension. For details, see section
12729 &<<SECTscanspamass>>&.
12730
12731
12732 .vitem &$spool_directory$&
12733 .vindex "&$spool_directory$&"
12734 The name of Exim's spool directory.
12735
12736 .vitem &$spool_inodes$&
12737 .vindex "&$spool_inodes$&"
12738 The number of free inodes in the disk partition where Exim's spool files are
12739 being written. The value is recalculated whenever the variable is referenced.
12740 If the relevant file system does not have the concept of inodes, the value of
12741 is -1. See also the &%check_spool_inodes%& option.
12742
12743 .vitem &$spool_space$&
12744 .vindex "&$spool_space$&"
12745 The amount of free space (as a number of kilobytes) in the disk partition where
12746 Exim's spool files are being written. The value is recalculated whenever the
12747 variable is referenced. If the operating system does not have the ability to
12748 find the amount of free space (only true for experimental systems), the space
12749 value is -1. For example, to check in an ACL that there is at least 50
12750 megabytes free on the spool, you could write:
12751 .code
12752 condition = ${if > {$spool_space}{50000}}
12753 .endd
12754 See also the &%check_spool_space%& option.
12755
12756
12757 .vitem &$thisaddress$&
12758 .vindex "&$thisaddress$&"
12759 This variable is set only during the processing of the &%foranyaddress%&
12760 command in a filter file. Its use is explained in the description of that
12761 command, which can be found in the separate document entitled &'Exim's
12762 interfaces to mail filtering'&.
12763
12764 .vitem &$tls_in_bits$&
12765 .vindex "&$tls_in_bits$&"
12766 Contains an approximation of the TLS cipher's bit-strength
12767 on the inbound connection; the meaning of
12768 this depends upon the TLS implementation used.
12769 If TLS has not been negotiated, the value will be 0.
12770 The value of this is automatically fed into the Cyrus SASL authenticator
12771 when acting as a server, to specify the "external SSF" (a SASL term).
12772
12773 The deprecated &$tls_bits$& variable refers to the inbound side
12774 except when used in the context of an outbound SMTP delivery, when it refers to
12775 the outbound.
12776
12777 .vitem &$tls_out_bits$&
12778 .vindex "&$tls_out_bits$&"
12779 Contains an approximation of the TLS cipher's bit-strength
12780 on an outbound SMTP connection; the meaning of
12781 this depends upon the TLS implementation used.
12782 If TLS has not been negotiated, the value will be 0.
12783
12784 .vitem &$tls_in_ourcert$&
12785 .vindex "&$tls_in_ourcert$&"
12786 .cindex certificate veriables
12787 This variable refers to the certificate presented to the peer of an
12788 inbound connection when the message was received.
12789 It is only useful as the argument of a
12790 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12791 or a &%def%& condition.
12792
12793 .vitem &$tls_in_peercert$&
12794 .vindex "&$tls_in_peercert$&"
12795 This variable refers to the certificate presented by the peer of an
12796 inbound connection when the message was received.
12797 It is only useful as the argument of a
12798 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12799 or a &%def%& condition.
12800 If certificate verification fails it may refer to a failing chain element
12801 which is not the leaf.
12802
12803 .vitem &$tls_out_ourcert$&
12804 .vindex "&$tls_out_ourcert$&"
12805 This variable refers to the certificate presented to the peer of an
12806 outbound connection.  It is only useful as the argument of a
12807 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12808 or a &%def%& condition.
12809
12810 .vitem &$tls_out_peercert$&
12811 .vindex "&$tls_out_peercert$&"
12812 This variable refers to the certificate presented by the peer of an
12813 outbound connection.  It is only useful as the argument of a
12814 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12815 or a &%def%& condition.
12816 If certificate verification fails it may refer to a failing chain element
12817 which is not the leaf.
12818
12819 .vitem &$tls_in_certificate_verified$&
12820 .vindex "&$tls_in_certificate_verified$&"
12821 This variable is set to &"1"& if a TLS certificate was verified when the
12822 message was received, and &"0"& otherwise.
12823
12824 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12825 except when used in the context of an outbound SMTP delivery, when it refers to
12826 the outbound.
12827
12828 .vitem &$tls_out_certificate_verified$&
12829 .vindex "&$tls_out_certificate_verified$&"
12830 This variable is set to &"1"& if a TLS certificate was verified when an
12831 outbound SMTP connection was made,
12832 and &"0"& otherwise.
12833
12834 .vitem &$tls_in_cipher$&
12835 .vindex "&$tls_in_cipher$&"
12836 .vindex "&$tls_cipher$&"
12837 When a message is received from a remote host over an encrypted SMTP
12838 connection, this variable is set to the cipher suite that was negotiated, for
12839 example DES-CBC3-SHA. In other circumstances, in particular, for message
12840 received over unencrypted connections, the variable is empty. Testing
12841 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
12842 non-encrypted connections during ACL processing.
12843
12844 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12845 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12846 becomes the same as &$tls_out_cipher$&.
12847
12848 .vitem &$tls_out_cipher$&
12849 .vindex "&$tls_out_cipher$&"
12850 This variable is
12851 cleared before any outgoing SMTP connection is made,
12852 and then set to the outgoing cipher suite if one is negotiated. See chapter
12853 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12854 details of the &(smtp)& transport.
12855
12856 .vitem &$tls_in_ocsp$&
12857 .vindex "&$tls_in_ocsp$&"
12858 When a message is received from a remote client connection
12859 the result of any OCSP request from the client is encoded in this variable:
12860 .code
12861 0 OCSP proof was not requested (default value)
12862 1 No response to request
12863 2 Response not verified
12864 3 Verification failed
12865 4 Verification succeeded
12866 .endd
12867
12868 .vitem &$tls_out_ocsp$&
12869 .vindex "&$tls_out_ocsp$&"
12870 When a message is sent to a remote host connection
12871 the result of any OCSP request made is encoded in this variable.
12872 See &$tls_in_ocsp$& for values.
12873
12874 .vitem &$tls_in_peerdn$&
12875 .vindex "&$tls_in_peerdn$&"
12876 .vindex "&$tls_peerdn$&"
12877 .cindex certificate "extracting fields"
12878 When a message is received from a remote host over an encrypted SMTP
12879 connection, and Exim is configured to request a certificate from the client,
12880 the value of the Distinguished Name of the certificate is made available in the
12881 &$tls_in_peerdn$& during subsequent processing.
12882 If certificate verification fails it may refer to a failing chain element
12883 which is not the leaf.
12884
12885 The deprecated &$tls_peerdn$& variable refers to the inbound side
12886 except when used in the context of an outbound SMTP delivery, when it refers to
12887 the outbound.
12888
12889 .vitem &$tls_out_peerdn$&
12890 .vindex "&$tls_out_peerdn$&"
12891 When a message is being delivered to a remote host over an encrypted SMTP
12892 connection, and Exim is configured to request a certificate from the server,
12893 the value of the Distinguished Name of the certificate is made available in the
12894 &$tls_out_peerdn$& during subsequent processing.
12895 If certificate verification fails it may refer to a failing chain element
12896 which is not the leaf.
12897
12898 .vitem &$tls_in_sni$&
12899 .vindex "&$tls_in_sni$&"
12900 .vindex "&$tls_sni$&"
12901 .cindex "TLS" "Server Name Indication"
12902 When a TLS session is being established, if the client sends the Server
12903 Name Indication extension, the value will be placed in this variable.
12904 If the variable appears in &%tls_certificate%& then this option and
12905 some others, described in &<<SECTtlssni>>&,
12906 will be re-expanded early in the TLS session, to permit
12907 a different certificate to be presented (and optionally a different key to be
12908 used) to the client, based upon the value of the SNI extension.
12909
12910 The deprecated &$tls_sni$& variable refers to the inbound side
12911 except when used in the context of an outbound SMTP delivery, when it refers to
12912 the outbound.
12913
12914 .vitem &$tls_out_sni$&
12915 .vindex "&$tls_out_sni$&"
12916 .cindex "TLS" "Server Name Indication"
12917 During outbound
12918 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12919 the transport.
12920
12921 .vitem &$tod_bsdinbox$&
12922 .vindex "&$tod_bsdinbox$&"
12923 The time of day and the date, in the format required for BSD-style mailbox
12924 files, for example: Thu Oct 17 17:14:09 1995.
12925
12926 .vitem &$tod_epoch$&
12927 .vindex "&$tod_epoch$&"
12928 The time and date as a number of seconds since the start of the Unix epoch.
12929
12930 .vitem &$tod_epoch_l$&
12931 .vindex "&$tod_epoch_l$&"
12932 The time and date as a number of microseconds since the start of the Unix epoch.
12933
12934 .vitem &$tod_full$&
12935 .vindex "&$tod_full$&"
12936 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12937 +0100. The timezone is always given as a numerical offset from UTC, with
12938 positive values used for timezones that are ahead (east) of UTC, and negative
12939 values for those that are behind (west).
12940
12941 .vitem &$tod_log$&
12942 .vindex "&$tod_log$&"
12943 The time and date in the format used for writing Exim's log files, for example:
12944 1995-10-12 15:32:29, but without a timezone.
12945
12946 .vitem &$tod_logfile$&
12947 .vindex "&$tod_logfile$&"
12948 This variable contains the date in the format yyyymmdd. This is the format that
12949 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12950 flag.
12951
12952 .vitem &$tod_zone$&
12953 .vindex "&$tod_zone$&"
12954 This variable contains the numerical value of the local timezone, for example:
12955 -0500.
12956
12957 .vitem &$tod_zulu$&
12958 .vindex "&$tod_zulu$&"
12959 This variable contains the UTC date and time in &"Zulu"& format, as specified
12960 by ISO 8601, for example: 20030221154023Z.
12961
12962 .vitem &$transport_name$&
12963 .cindex "transport" "name"
12964 .cindex "name" "of transport"
12965 .vindex "&$transport_name$&"
12966 During the running of a transport, this variable contains its name.
12967
12968 .vitem &$value$&
12969 .vindex "&$value$&"
12970 This variable contains the result of an expansion lookup, extraction operation,
12971 or external command, as described above. It is also used during a
12972 &*reduce*& expansion.
12973
12974 .vitem &$verify_mode$&
12975 .vindex "&$verify_mode$&"
12976 While a router or transport is being run in verify mode
12977 or for cutthrough delivery,
12978 contains "S" for sender-verification or "R" for recipient-verification.
12979 Otherwise, empty.
12980
12981 .vitem &$version_number$&
12982 .vindex "&$version_number$&"
12983 The version number of Exim.
12984
12985 .vitem &$warn_message_delay$&
12986 .vindex "&$warn_message_delay$&"
12987 This variable is set only during the creation of a message warning about a
12988 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12989
12990 .vitem &$warn_message_recipients$&
12991 .vindex "&$warn_message_recipients$&"
12992 This variable is set only during the creation of a message warning about a
12993 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12994 .endlist
12995 .ecindex IIDstrexp
12996
12997
12998
12999 . ////////////////////////////////////////////////////////////////////////////
13000 . ////////////////////////////////////////////////////////////////////////////
13001
13002 .chapter "Embedded Perl" "CHAPperl"
13003 .scindex IIDperl "Perl" "calling from Exim"
13004 Exim can be built to include an embedded Perl interpreter. When this is done,
13005 Perl subroutines can be called as part of the string expansion process. To make
13006 use of the Perl support, you need version 5.004 or later of Perl installed on
13007 your system. To include the embedded interpreter in the Exim binary, include
13008 the line
13009 .code
13010 EXIM_PERL = perl.o
13011 .endd
13012 in your &_Local/Makefile_& and then build Exim in the normal way.
13013
13014
13015 .section "Setting up so Perl can be used" "SECID85"
13016 .oindex "&%perl_startup%&"
13017 Access to Perl subroutines is via a global configuration option called
13018 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13019 no &%perl_startup%& option in the Exim configuration file then no Perl
13020 interpreter is started and there is almost no overhead for Exim (since none of
13021 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13022 option then the associated value is taken to be Perl code which is executed in
13023 a newly created Perl interpreter.
13024
13025 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13026 need backslashes before any characters to escape special meanings. The option
13027 should usually be something like
13028 .code
13029 perl_startup = do '/etc/exim.pl'
13030 .endd
13031 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13032 use from Exim. Exim can be configured either to start up a Perl interpreter as
13033 soon as it is entered, or to wait until the first time it is needed. Starting
13034 the interpreter at the beginning ensures that it is done while Exim still has
13035 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13036 fact used in a particular run. Also, note that this does not mean that Exim is
13037 necessarily running as root when Perl is called at a later time. By default,
13038 the interpreter is started only when it is needed, but this can be changed in
13039 two ways:
13040
13041 .ilist
13042 .oindex "&%perl_at_start%&"
13043 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13044 a startup when Exim is entered.
13045 .next
13046 The command line option &%-ps%& also requests a startup when Exim is entered,
13047 overriding the setting of &%perl_at_start%&.
13048 .endlist
13049
13050 There is also a command line option &%-pd%& (for delay) which suppresses the
13051 initial startup, even if &%perl_at_start%& is set.
13052
13053 .new
13054 .ilist
13055 .oindex "&%perl_taintmode%&"
13056 .cindex "Perl" "taintmode"
13057 To provide more security executing Perl code via the embedded Perl
13058 interpeter, the &%perl_taintmode%& option can be set. This enables the
13059 taint mode of the Perl interpreter. You are encouraged to set this
13060 option to a true value. To avoid breaking existing installations, it
13061 defaults to false.
13062 .wen
13063
13064
13065 .section "Calling Perl subroutines" "SECID86"
13066 When the configuration file includes a &%perl_startup%& option you can make use
13067 of the string expansion item to call the Perl subroutines that are defined
13068 by the &%perl_startup%& code. The operator is used in any of the following
13069 forms:
13070 .code
13071 ${perl{foo}}
13072 ${perl{foo}{argument}}
13073 ${perl{foo}{argument1}{argument2} ... }
13074 .endd
13075 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13076 arguments may be passed. Passing more than this results in an expansion failure
13077 with an error message of the form
13078 .code
13079 Too many arguments passed to Perl subroutine "foo" (max is 8)
13080 .endd
13081 The return value of the Perl subroutine is evaluated in a scalar context before
13082 it is passed back to Exim to be inserted into the expanded string. If the
13083 return value is &'undef'&, the expansion is forced to fail in the same way as
13084 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13085 by obeying Perl's &%die%& function, the expansion fails with the error message
13086 that was passed to &%die%&.
13087
13088
13089 .section "Calling Exim functions from Perl" "SECID87"
13090 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13091 is available to call back into Exim's string expansion function. For example,
13092 the Perl code
13093 .code
13094 my $lp = Exim::expand_string('$local_part');
13095 .endd
13096 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13097 Note those are single quotes and not double quotes to protect against
13098 &$local_part$& being interpolated as a Perl variable.
13099
13100 If the string expansion is forced to fail by a &"fail"& item, the result of
13101 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13102 expansion string, the Perl call from the original expansion string fails with
13103 an appropriate error message, in the same way as if &%die%& were used.
13104
13105 .cindex "debugging" "from embedded Perl"
13106 .cindex "log" "writing from embedded Perl"
13107 Two other Exim functions are available for use from within Perl code.
13108 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13109 debugging is enabled. If you want a newline at the end, you must supply it.
13110 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13111 timestamp. In this case, you should not supply a terminating newline.
13112
13113
13114 .section "Use of standard output and error by Perl" "SECID88"
13115 .cindex "Perl" "standard output and error"
13116 You should not write to the standard error or output streams from within your
13117 Perl code, as it is not defined how these are set up. In versions of Exim
13118 before 4.50, it is possible for the standard output or error to refer to the
13119 SMTP connection during message reception via the daemon. Writing to this stream
13120 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13121 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13122 avoided, but the output is lost.
13123
13124 .cindex "Perl" "use of &%warn%&"
13125 The Perl &%warn%& statement writes to the standard error stream by default.
13126 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13127 you have no control. When Exim starts up the Perl interpreter, it arranges for
13128 output from the &%warn%& statement to be written to the Exim main log. You can
13129 change this by including appropriate Perl magic somewhere in your Perl code.
13130 For example, to discard &%warn%& output completely, you need this:
13131 .code
13132 $SIG{__WARN__} = sub { };
13133 .endd
13134 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13135 example, the code for the subroutine is empty, so it does nothing, but you can
13136 include any Perl code that you like. The text of the &%warn%& message is passed
13137 as the first subroutine argument.
13138 .ecindex IIDperl
13139
13140
13141 . ////////////////////////////////////////////////////////////////////////////
13142 . ////////////////////////////////////////////////////////////////////////////
13143
13144 .chapter "Starting the daemon and the use of network interfaces" &&&
13145          "CHAPinterfaces" &&&
13146          "Starting the daemon"
13147 .cindex "daemon" "starting"
13148 .cindex "interface" "listening"
13149 .cindex "network interface"
13150 .cindex "interface" "network"
13151 .cindex "IP address" "for listening"
13152 .cindex "daemon" "listening IP addresses"
13153 .cindex "TCP/IP" "setting listening interfaces"
13154 .cindex "TCP/IP" "setting listening ports"
13155 A host that is connected to a TCP/IP network may have one or more physical
13156 hardware network interfaces. Each of these interfaces may be configured as one
13157 or more &"logical"& interfaces, which are the entities that a program actually
13158 works with. Each of these logical interfaces is associated with an IP address.
13159 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13160 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13161 knowledge about the host's interfaces for use in three different circumstances:
13162
13163 .olist
13164 When a listening daemon is started, Exim needs to know which interfaces
13165 and ports to listen on.
13166 .next
13167 When Exim is routing an address, it needs to know which IP addresses
13168 are associated with local interfaces. This is required for the correct
13169 processing of MX lists by removing the local host and others with the
13170 same or higher priority values. Also, Exim needs to detect cases
13171 when an address is routed to an IP address that in fact belongs to the
13172 local host. Unless the &%self%& router option or the &%allow_localhost%&
13173 option of the smtp transport is set (as appropriate), this is treated
13174 as an error situation.
13175 .next
13176 When Exim connects to a remote host, it may need to know which interface to use
13177 for the outgoing connection.
13178 .endlist
13179
13180
13181 Exim's default behaviour is likely to be appropriate in the vast majority
13182 of cases. If your host has only one interface, and you want all its IP
13183 addresses to be treated in the same way, and you are using only the
13184 standard SMTP port, you should not need to take any special action. The
13185 rest of this chapter does not apply to you.
13186
13187 In a more complicated situation you may want to listen only on certain
13188 interfaces, or on different ports, and for this reason there are a number of
13189 options that can be used to influence Exim's behaviour. The rest of this
13190 chapter describes how they operate.
13191
13192 When a message is received over TCP/IP, the interface and port that were
13193 actually used are set in &$received_ip_address$& and &$received_port$&.
13194
13195
13196
13197 .section "Starting a listening daemon" "SECID89"
13198 When a listening daemon is started (by means of the &%-bd%& command line
13199 option), the interfaces and ports on which it listens are controlled by the
13200 following options:
13201
13202 .ilist
13203 &%daemon_smtp_ports%& contains a list of default ports
13204 or service names.
13205 (For backward compatibility, this option can also be specified in the singular.)
13206 .next
13207 &%local_interfaces%& contains list of interface IP addresses on which to
13208 listen. Each item may optionally also specify a port.
13209 .endlist
13210
13211 The default list separator in both cases is a colon, but this can be changed as
13212 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13213 it is usually best to change the separator to avoid having to double all the
13214 colons. For example:
13215 .code
13216 local_interfaces = <; 127.0.0.1 ; \
13217                       192.168.23.65 ; \
13218                       ::1 ; \
13219                       3ffe:ffff:836f::fe86:a061
13220 .endd
13221 There are two different formats for specifying a port along with an IP address
13222 in &%local_interfaces%&:
13223
13224 .olist
13225 The port is added onto the address with a dot separator. For example, to listen
13226 on port 1234 on two different IP addresses:
13227 .code
13228 local_interfaces = <; 192.168.23.65.1234 ; \
13229                       3ffe:ffff:836f::fe86:a061.1234
13230 .endd
13231 .next
13232 The IP address is enclosed in square brackets, and the port is added
13233 with a colon separator, for example:
13234 .code
13235 local_interfaces = <; [192.168.23.65]:1234 ; \
13236                       [3ffe:ffff:836f::fe86:a061]:1234
13237 .endd
13238 .endlist
13239
13240 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13241 default setting contains just one port:
13242 .code
13243 daemon_smtp_ports = smtp
13244 .endd
13245 If more than one port is listed, each interface that does not have its own port
13246 specified listens on all of them. Ports that are listed in
13247 &%daemon_smtp_ports%& can be identified either by name (defined in
13248 &_/etc/services_&) or by number. However, when ports are given with individual
13249 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13250
13251
13252
13253 .section "Special IP listening addresses" "SECID90"
13254 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13255 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13256 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13257 instead of setting up separate listening sockets for each interface. The
13258 default value of &%local_interfaces%& is
13259 .code
13260 local_interfaces = 0.0.0.0
13261 .endd
13262 when Exim is built without IPv6 support; otherwise it is:
13263 .code
13264 local_interfaces = <; ::0 ; 0.0.0.0
13265 .endd
13266 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13267
13268
13269
13270 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13271 The &%-oX%& command line option can be used to override the values of
13272 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13273 instance. Another way of doing this would be to use macros and the &%-D%&
13274 option. However, &%-oX%& can be used by any admin user, whereas modification of
13275 the runtime configuration by &%-D%& is allowed only when the caller is root or
13276 exim.
13277
13278 The value of &%-oX%& is a list of items. The default colon separator can be
13279 changed in the usual way if required. If there are any items that do not
13280 contain dots or colons (that is, are not IP addresses), the value of
13281 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13282 items that do contain dots or colons, the value of &%local_interfaces%& is
13283 replaced by those items. Thus, for example,
13284 .code
13285 -oX 1225
13286 .endd
13287 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13288 whereas
13289 .code
13290 -oX 192.168.34.5.1125
13291 .endd
13292 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13293 (However, since &%local_interfaces%& now contains no items without ports, the
13294 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13295
13296
13297
13298 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13299 .cindex "ssmtp protocol"
13300 .cindex "smtps protocol"
13301 .cindex "SMTP" "ssmtp protocol"
13302 .cindex "SMTP" "smtps protocol"
13303 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13304 before the STARTTLS command was standardized for SMTP. Some legacy clients
13305 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13306 list of port numbers or service names,
13307 connections to those ports must use SSMTP. The most
13308 common use of this option is expected to be
13309 .code
13310 tls_on_connect_ports = 465
13311 .endd
13312 because 465 is the usual port number used by the legacy clients. There is also
13313 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13314 this way when a daemon is started.
13315
13316 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13317 daemon to listen on those ports. You must still specify them in
13318 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13319 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13320 connections via the daemon.)
13321
13322
13323
13324
13325 .section "IPv6 address scopes" "SECID92"
13326 .cindex "IPv6" "address scopes"
13327 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13328 can, in principle, have the same link-local IPv6 address on different
13329 interfaces. Thus, additional information is needed, over and above the IP
13330 address, to distinguish individual interfaces. A convention of using a
13331 percent sign followed by something (often the interface name) has been
13332 adopted in some cases, leading to addresses like this:
13333 .code
13334 fe80::202:b3ff:fe03:45c1%eth0
13335 .endd
13336 To accommodate this usage, a percent sign followed by an arbitrary string is
13337 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13338 to convert a textual IPv6 address for actual use. This function recognizes the
13339 percent convention in operating systems that support it, and it processes the
13340 address appropriately. Unfortunately, some older libraries have problems with
13341 &[getaddrinfo()]&. If
13342 .code
13343 IPV6_USE_INET_PTON=yes
13344 .endd
13345 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13346 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13347 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13348 function.) Of course, this means that the additional functionality of
13349 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13350
13351 .section "Disabling IPv6" "SECID93"
13352 .cindex "IPv6" "disabling"
13353 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13354 run on a host whose kernel does not support IPv6. The binary will fall back to
13355 using IPv4, but it may waste resources looking up AAAA records, and trying to
13356 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13357 .oindex "&%disable_ipv6%&"
13358 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13359 activities take place. AAAA records are never looked up, and any IPv6 addresses
13360 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13361 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13362 to handle IPv6 literal addresses.
13363
13364 On the other hand, when IPv6 is in use, there may be times when you want to
13365 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13366 option to globally suppress the lookup of AAAA records for specified domains,
13367 and you can use the &%ignore_target_hosts%& generic router option to ignore
13368 IPv6 addresses in an individual router.
13369
13370
13371
13372 .section "Examples of starting a listening daemon" "SECID94"
13373 The default case in an IPv6 environment is
13374 .code
13375 daemon_smtp_ports = smtp
13376 local_interfaces = <; ::0 ; 0.0.0.0
13377 .endd
13378 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13379 Either one or two sockets may be used, depending on the characteristics of
13380 the TCP/IP stack. (This is complicated and messy; for more information,
13381 read the comments in the &_daemon.c_& source file.)
13382
13383 To specify listening on ports 25 and 26 on all interfaces:
13384 .code
13385 daemon_smtp_ports = 25 : 26
13386 .endd
13387 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13388 .code
13389 local_interfaces = <; ::0.25     ; ::0.26 \
13390                       0.0.0.0.25 ; 0.0.0.0.26
13391 .endd
13392 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13393 IPv4 loopback address only:
13394 .code
13395 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13396 .endd
13397 To specify listening on the default port on specific interfaces only:
13398 .code
13399 local_interfaces = 10.0.0.67 : 192.168.34.67
13400 .endd
13401 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13402
13403
13404
13405 .section "Recognizing the local host" "SECTreclocipadd"
13406 The &%local_interfaces%& option is also used when Exim needs to determine
13407 whether or not an IP address refers to the local host. That is, the IP
13408 addresses of all the interfaces on which a daemon is listening are always
13409 treated as local.
13410
13411 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13412 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13413 available interfaces from the operating system, and extracts the relevant
13414 (that is, IPv4 or IPv6) addresses to use for checking.
13415
13416 Some systems set up large numbers of virtual interfaces in order to provide
13417 many virtual web servers. In this situation, you may want to listen for
13418 email on only a few of the available interfaces, but nevertheless treat all
13419 interfaces as local when routing. You can do this by setting
13420 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13421 &"all"& wildcard values. These addresses are recognized as local, but are not
13422 used for listening. Consider this example:
13423 .code
13424 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13425                       192.168.53.235 ; \
13426                       3ffe:2101:12:1:a00:20ff:fe86:a061
13427
13428 extra_local_interfaces = <; ::0 ; 0.0.0.0
13429 .endd
13430 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13431 address, but all available interface addresses are treated as local when
13432 Exim is routing.
13433
13434 In some environments the local host name may be in an MX list, but with an IP
13435 address that is not assigned to any local interface. In other cases it may be
13436 desirable to treat other host names as if they referred to the local host. Both
13437 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13438 This contains host names rather than IP addresses. When a host is referenced
13439 during routing, either via an MX record or directly, it is treated as the local
13440 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13441 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13442
13443
13444
13445 .section "Delivering to a remote host" "SECID95"
13446 Delivery to a remote host is handled by the smtp transport. By default, it
13447 allows the system's TCP/IP functions to choose which interface to use (if
13448 there is more than one) when connecting to a remote host. However, the
13449 &%interface%& option can be set to specify which interface is used. See the
13450 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13451 details.
13452
13453
13454
13455
13456 . ////////////////////////////////////////////////////////////////////////////
13457 . ////////////////////////////////////////////////////////////////////////////
13458
13459 .chapter "Main configuration" "CHAPmainconfig"
13460 .scindex IIDconfima "configuration file" "main section"
13461 .scindex IIDmaiconf "main configuration"
13462 The first part of the run time configuration file contains three types of item:
13463
13464 .ilist
13465 Macro definitions: These lines start with an upper case letter. See section
13466 &<<SECTmacrodefs>>& for details of macro processing.
13467 .next
13468 Named list definitions: These lines start with one of the words &"domainlist"&,
13469 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13470 section &<<SECTnamedlists>>&.
13471 .next
13472 Main configuration settings: Each setting occupies one line of the file
13473 (with possible continuations). If any setting is preceded by the word
13474 &"hide"&, the &%-bP%& command line option displays its value to admin users
13475 only. See section &<<SECTcos>>& for a description of the syntax of these option
13476 settings.
13477 .endlist
13478
13479 This chapter specifies all the main configuration options, along with their
13480 types and default values. For ease of finding a particular option, they appear
13481 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13482 are now so many options, they are first listed briefly in functional groups, as
13483 an aid to finding the name of the option you are looking for. Some options are
13484 listed in more than one group.
13485
13486 .section "Miscellaneous" "SECID96"
13487 .table2
13488 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13489 .row &%disable_ipv6%&                "do no IPv6 processing"
13490 .row &%keep_malformed%&              "for broken files &-- should not happen"
13491 .row &%localhost_number%&            "for unique message ids in clusters"
13492 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13493 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13494 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13495 .row &%print_topbitchars%&           "top-bit characters are printing"
13496 .row &%timezone%&                    "force time zone"
13497 .endtable
13498
13499
13500 .section "Exim parameters" "SECID97"
13501 .table2
13502 .row &%exim_group%&                  "override compiled-in value"
13503 .row &%exim_path%&                   "override compiled-in value"
13504 .row &%exim_user%&                   "override compiled-in value"
13505 .row &%primary_hostname%&            "default from &[uname()]&"
13506 .row &%split_spool_directory%&       "use multiple directories"
13507 .row &%spool_directory%&             "override compiled-in value"
13508 .endtable
13509
13510
13511
13512 .section "Privilege controls" "SECID98"
13513 .table2
13514 .row &%admin_groups%&                "groups that are Exim admin users"
13515 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13516 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13517 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13518 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13519 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13520 .row &%never_users%&                 "do not run deliveries as these"
13521 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13522 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13523 .row &%trusted_groups%&              "groups that are trusted"
13524 .row &%trusted_users%&               "users that are trusted"
13525 .endtable
13526
13527
13528
13529 .section "Logging" "SECID99"
13530 .table2
13531 .row &%event_action%&                "custom logging"
13532 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13533 .row &%log_file_path%&               "override compiled-in value"
13534 .row &%log_selector%&                "set/unset optional logging"
13535 .row &%log_timezone%&                "add timezone to log lines"
13536 .row &%message_logs%&                "create per-message logs"
13537 .row &%preserve_message_logs%&       "after message completion"
13538 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13539 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13540 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13541 .row &%syslog_facility%&             "set syslog &""facility""& field"
13542 .row &%syslog_processname%&          "set syslog &""ident""& field"
13543 .row &%syslog_timestamp%&            "timestamp syslog lines"
13544 .row &%write_rejectlog%&             "control use of message log"
13545 .endtable
13546
13547
13548
13549 .section "Frozen messages" "SECID100"
13550 .table2
13551 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13552 .row &%freeze_tell%&                 "send message when freezing"
13553 .row &%move_frozen_messages%&        "to another directory"
13554 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13555 .endtable
13556
13557
13558
13559 .section "Data lookups" "SECID101"
13560 .table2
13561 .row &%ibase_servers%&               "InterBase servers"
13562 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13563 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13564 .row &%ldap_cert_file%&              "client cert file for LDAP"
13565 .row &%ldap_cert_key%&               "client key file for LDAP"
13566 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13567 .row &%ldap_default_servers%&        "used if no server in query"
13568 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13569 .row &%ldap_start_tls%&              "require TLS within LDAP"
13570 .row &%ldap_version%&                "set protocol version"
13571 .row &%lookup_open_max%&             "lookup files held open"
13572 .row &%mysql_servers%&               "default MySQL servers"
13573 .row &%oracle_servers%&              "Oracle servers"
13574 .row &%pgsql_servers%&               "default PostgreSQL servers"
13575 .row &%sqlite_lock_timeout%&         "as it says"
13576 .endtable
13577
13578
13579
13580 .section "Message ids" "SECID102"
13581 .table2
13582 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13583 .row &%message_id_header_text%&      "ditto"
13584 .endtable
13585
13586
13587
13588 .section "Embedded Perl Startup" "SECID103"
13589 .table2
13590 .row &%perl_at_start%&               "always start the interpreter"
13591 .row &%perl_startup%&                "code to obey when starting Perl"
13592 .row &%perl_taintmode%&              "enable taint mode in Perl"
13593 .endtable
13594
13595
13596
13597 .section "Daemon" "SECID104"
13598 .table2
13599 .row &%daemon_smtp_ports%&           "default ports"
13600 .row &%daemon_startup_retries%&      "number of times to retry"
13601 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13602 .row &%extra_local_interfaces%&      "not necessarily listened on"
13603 .row &%local_interfaces%&            "on which to listen, with optional ports"
13604 .row &%pid_file_path%&               "override compiled-in value"
13605 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13606 .endtable
13607
13608
13609
13610 .section "Resource control" "SECID105"
13611 .table2
13612 .row &%check_log_inodes%&            "before accepting a message"
13613 .row &%check_log_space%&             "before accepting a message"
13614 .row &%check_spool_inodes%&          "before accepting a message"
13615 .row &%check_spool_space%&           "before accepting a message"
13616 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13617 .row &%queue_only_load%&             "queue incoming if load high"
13618 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13619 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13620 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13621 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13622 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13623 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13624 .row &%smtp_accept_max_per_connection%& "messages per connection"
13625 .row &%smtp_accept_max_per_host%&    "connections from one host"
13626 .row &%smtp_accept_queue%&           "queue mail if more connections"
13627 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13628                                            connection"
13629 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13630 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13631 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13632 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13633 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13634 .endtable
13635
13636
13637
13638 .section "Policy controls" "SECID106"
13639 .table2
13640 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13641 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13642 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13643 .row &%acl_smtp_auth%&               "ACL for AUTH"
13644 .row &%acl_smtp_connect%&            "ACL for connection"
13645 .row &%acl_smtp_data%&               "ACL for DATA"
13646 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13647 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13648 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13649 .row &%acl_smtp_expn%&               "ACL for EXPN"
13650 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13651 .row &%acl_smtp_mail%&               "ACL for MAIL"
13652 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13653 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13654 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13655 .row &%acl_smtp_predata%&            "ACL for start of data"
13656 .row &%acl_smtp_quit%&               "ACL for QUIT"
13657 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13658 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13659 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13660 .row &%av_scanner%&                  "specify virus scanner"
13661 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13662                                       words""&"
13663 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13664 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13665 .row &%header_maxsize%&              "total size of message header"
13666 .row &%header_line_maxsize%&         "individual header line limit"
13667 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13668 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13669 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13670 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13671 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13672 .row &%host_lookup%&                 "host name looked up for these hosts"
13673 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13674 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13675 .row &%host_reject_connection%&      "reject connection from these hosts"
13676 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13677 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13678 .row &%message_size_limit%&          "for all messages"
13679 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13680 .row &%spamd_address%&               "set interface to SpamAssassin"
13681 .row &%strict_acl_vars%&             "object to unset ACL variables"
13682 .endtable
13683
13684
13685
13686 .section "Callout cache" "SECID107"
13687 .table2
13688 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13689                                          item"
13690 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13691                                          item"
13692 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13693 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13694 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13695 .endtable
13696
13697
13698
13699 .section "TLS" "SECID108"
13700 .table2
13701 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13702 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13703 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13704 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13705 .row &%tls_certificate%&             "location of server certificate"
13706 .row &%tls_crl%&                     "certificate revocation list"
13707 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13708 .row &%tls_dhparam%&                 "DH parameters for server"
13709 .row &%tls_eccurve%&                 "EC curve selection for server"
13710 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13711 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13712 .row &%tls_privatekey%&              "location of server private key"
13713 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13714 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13715 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13716 .row &%tls_verify_certificates%&     "expected client certificates"
13717 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13718 .endtable
13719
13720
13721
13722 .section "Local user handling" "SECID109"
13723 .table2
13724 .row &%finduser_retries%&            "useful in NIS environments"
13725 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13726 .row &%gecos_pattern%&               "ditto"
13727 .row &%max_username_length%&         "for systems that truncate"
13728 .row &%unknown_login%&               "used when no login name found"
13729 .row &%unknown_username%&            "ditto"
13730 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13731 .row &%uucp_from_sender%&            "ditto"
13732 .endtable
13733
13734
13735
13736 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13737 .table2
13738 .row &%header_maxsize%&              "total size of message header"
13739 .row &%header_line_maxsize%&         "individual header line limit"
13740 .row &%message_size_limit%&          "applies to all messages"
13741 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13742 .row &%received_header_text%&        "expanded to make &'Received:'&"
13743 .row &%received_headers_max%&        "for mail loop detection"
13744 .row &%recipients_max%&              "limit per message"
13745 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13746 .endtable
13747
13748
13749
13750
13751 .section "Non-SMTP incoming messages" "SECID111"
13752 .table2
13753 .row &%receive_timeout%&             "for non-SMTP messages"
13754 .endtable
13755
13756
13757
13758
13759
13760 .section "Incoming SMTP messages" "SECID112"
13761 See also the &'Policy controls'& section above.
13762
13763 .table2
13764 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13765 .row &%host_lookup%&                 "host name looked up for these hosts"
13766 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13767 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13768 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13769 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13770 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13771 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13772 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13773 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13774 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13775 .row &%smtp_accept_max_per_connection%& "messages per connection"
13776 .row &%smtp_accept_max_per_host%&    "connections from one host"
13777 .row &%smtp_accept_queue%&           "queue mail if more connections"
13778 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13779                                            connection"
13780 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13781 .row &%smtp_active_hostname%&        "host name to use in messages"
13782 .row &%smtp_banner%&                 "text for welcome banner"
13783 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13784 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13785 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13786 .row &%smtp_etrn_command%&           "what to run for ETRN"
13787 .row &%smtp_etrn_serialize%&         "only one at once"
13788 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13789 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13790 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13791 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13792 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13793 .row &%smtp_receive_timeout%&        "per command or data line"
13794 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13795 .row &%smtp_return_error_details%&   "give detail on rejections"
13796 .endtable
13797
13798
13799
13800 .section "SMTP extensions" "SECID113"
13801 .table2
13802 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13803 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13804 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13805 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13806 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13807 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13808 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13809 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13810 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13811 .endtable
13812
13813
13814
13815 .section "Processing messages" "SECID114"
13816 .table2
13817 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13818 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13819 .row &%allow_utf8_domains%&          "in addresses"
13820 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13821                                       words""&"
13822 .row &%delivery_date_remove%&        "from incoming messages"
13823 .row &%envelope_to_remove%&          "from incoming messages"
13824 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13825 .row &%headers_charset%&             "default for translations"
13826 .row &%qualify_domain%&              "default for senders"
13827 .row &%qualify_recipient%&           "default for recipients"
13828 .row &%return_path_remove%&          "from incoming messages"
13829 .row &%strip_excess_angle_brackets%& "in addresses"
13830 .row &%strip_trailing_dot%&          "at end of addresses"
13831 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13832 .endtable
13833
13834
13835
13836 .section "System filter" "SECID115"
13837 .table2
13838 .row &%system_filter%&               "locate system filter"
13839 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13840                                             directory"
13841 .row &%system_filter_file_transport%& "transport for delivery to a file"
13842 .row &%system_filter_group%&         "group for filter running"
13843 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13844 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13845 .row &%system_filter_user%&          "user for filter running"
13846 .endtable
13847
13848
13849
13850 .section "Routing and delivery" "SECID116"
13851 .table2
13852 .row &%disable_ipv6%&                "do no IPv6 processing"
13853 .row &%dns_again_means_nonexist%&    "for broken domains"
13854 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13855 .row &%dns_dnssec_ok%&               "parameter for resolver"
13856 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13857 .row &%dns_retrans%&                 "parameter for resolver"
13858 .row &%dns_retry%&                   "parameter for resolver"
13859 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13860 .row &%dns_use_edns0%&               "parameter for resolver"
13861 .row &%hold_domains%&                "hold delivery for these domains"
13862 .row &%local_interfaces%&            "for routing checks"
13863 .row &%queue_domains%&               "no immediate delivery for these"
13864 .row &%queue_only%&                  "no immediate delivery at all"
13865 .row &%queue_only_file%&             "no immediate delivery if file exists"
13866 .row &%queue_only_load%&             "no immediate delivery if load is high"
13867 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13868 .row &%queue_only_override%&         "allow command line to override"
13869 .row &%queue_run_in_order%&          "order of arrival"
13870 .row &%queue_run_max%&               "of simultaneous queue runners"
13871 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13872 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13873 .row &%remote_sort_domains%&         "order of remote deliveries"
13874 .row &%retry_data_expire%&           "timeout for retry data"
13875 .row &%retry_interval_max%&          "safety net for retry rules"
13876 .endtable
13877
13878
13879
13880 .section "Bounce and warning messages" "SECID117"
13881 .table2
13882 .row &%bounce_message_file%&         "content of bounce"
13883 .row &%bounce_message_text%&         "content of bounce"
13884 .row &%bounce_return_body%&          "include body if returning message"
13885 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13886 .row &%bounce_return_message%&       "include original message in bounce"
13887 .row &%bounce_return_size_limit%&    "limit on returned message"
13888 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13889 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13890 .row &%errors_copy%&                 "copy bounce messages"
13891 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13892 .row &%delay_warning%&               "time schedule"
13893 .row &%delay_warning_condition%&     "condition for warning messages"
13894 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13895 .row &%smtp_return_error_details%&   "give detail on rejections"
13896 .row &%warn_message_file%&           "content of warning message"
13897 .endtable
13898
13899
13900
13901 .section "Alphabetical list of main options" "SECTalomo"
13902 Those options that undergo string expansion before use are marked with
13903 &dagger;.
13904
13905 .option accept_8bitmime main boolean true
13906 .cindex "8BITMIME"
13907 .cindex "8-bit characters"
13908 .cindex "log" "selectors"
13909 .cindex "log" "8BITMIME"
13910 This option causes Exim to send 8BITMIME in its response to an SMTP
13911 EHLO command, and to accept the BODY= parameter on MAIL commands.
13912 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13913 takes no steps to do anything special with messages received by this route.
13914
13915 Historically Exim kept this option off by default, but the maintainers
13916 feel that in today's Internet, this causes more problems than it solves.
13917 It now defaults to true.
13918 A more detailed analysis of the issues is provided by Dan Bernstein:
13919 .display
13920 &url(http://cr.yp.to/smtp/8bitmime.html)
13921 .endd
13922
13923 To log received 8BITMIME status use
13924 .code
13925 log_selector = +8bitmime
13926 .endd
13927
13928 .option acl_not_smtp main string&!! unset
13929 .cindex "&ACL;" "for non-SMTP messages"
13930 .cindex "non-SMTP messages" "ACLs for"
13931 This option defines the ACL that is run when a non-SMTP message has been
13932 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13933 further details.
13934
13935 .option acl_not_smtp_mime main string&!! unset
13936 This option defines the ACL that is run for individual MIME parts of non-SMTP
13937 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13938 SMTP messages.
13939
13940 .option acl_not_smtp_start main string&!! unset
13941 .cindex "&ACL;" "at start of non-SMTP message"
13942 .cindex "non-SMTP messages" "ACLs for"
13943 This option defines the ACL that is run before Exim starts reading a
13944 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13945
13946 .option acl_smtp_auth main string&!! unset
13947 .cindex "&ACL;" "setting up for SMTP commands"
13948 .cindex "AUTH" "ACL for"
13949 This option defines the ACL that is run when an SMTP AUTH command is
13950 received. See chapter &<<CHAPACL>>& for further details.
13951
13952 .option acl_smtp_connect main string&!! unset
13953 .cindex "&ACL;" "on SMTP connection"
13954 This option defines the ACL that is run when an SMTP connection is received.
13955 See chapter &<<CHAPACL>>& for further details.
13956
13957 .option acl_smtp_data main string&!! unset
13958 .cindex "DATA" "ACL for"
13959 This option defines the ACL that is run after an SMTP DATA command has been
13960 processed and the message itself has been received, but before the final
13961 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13962
13963 .option acl_smtp_data_prdr main string&!! accept
13964 .cindex "PRDR" "ACL for"
13965 .cindex "DATA" "PRDR ACL for"
13966 .cindex "&ACL;" "PRDR-related"
13967 .cindex "&ACL;" "per-user data processing"
13968 This option defines the ACL that,
13969 if the PRDR feature has been negotiated,
13970 is run for each recipient after an SMTP DATA command has been
13971 processed and the message itself has been received, but before the
13972 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13973
13974 .option acl_smtp_dkim main string&!! unset
13975 .cindex DKIM "ACL for"
13976 This option defines the ACL that is run for each DKIM signature
13977 of a received message.
13978 See chapter &<<CHAPdkim>>& for further details.
13979
13980 .option acl_smtp_etrn main string&!! unset
13981 .cindex "ETRN" "ACL for"
13982 This option defines the ACL that is run when an SMTP ETRN command is
13983 received. See chapter &<<CHAPACL>>& for further details.
13984
13985 .option acl_smtp_expn main string&!! unset
13986 .cindex "EXPN" "ACL for"
13987 This option defines the ACL that is run when an SMTP EXPN command is
13988 received. See chapter &<<CHAPACL>>& for further details.
13989
13990 .option acl_smtp_helo main string&!! unset
13991 .cindex "EHLO" "ACL for"
13992 .cindex "HELO" "ACL for"
13993 This option defines the ACL that is run when an SMTP EHLO or HELO
13994 command is received. See chapter &<<CHAPACL>>& for further details.
13995
13996
13997 .option acl_smtp_mail main string&!! unset
13998 .cindex "MAIL" "ACL for"
13999 This option defines the ACL that is run when an SMTP MAIL command is
14000 received. See chapter &<<CHAPACL>>& for further details.
14001
14002 .option acl_smtp_mailauth main string&!! unset
14003 .cindex "AUTH" "on MAIL command"
14004 This option defines the ACL that is run when there is an AUTH parameter on
14005 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14006 &<<CHAPSMTPAUTH>>& for details of authentication.
14007
14008 .option acl_smtp_mime main string&!! unset
14009 .cindex "MIME content scanning" "ACL for"
14010 This option is available when Exim is built with the content-scanning
14011 extension. It defines the ACL that is run for each MIME part in a message. See
14012 section &<<SECTscanmimepart>>& for details.
14013
14014 .option acl_smtp_notquit main string&!! unset
14015 .cindex "not-QUIT, ACL for"
14016 This option defines the ACL that is run when an SMTP session
14017 ends without a QUIT command being received.
14018 See chapter &<<CHAPACL>>& for further details.
14019
14020 .option acl_smtp_predata main string&!! unset
14021 This option defines the ACL that is run when an SMTP DATA command is
14022 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14023 further details.
14024
14025 .option acl_smtp_quit main string&!! unset
14026 .cindex "QUIT, ACL for"
14027 This option defines the ACL that is run when an SMTP QUIT command is
14028 received. See chapter &<<CHAPACL>>& for further details.
14029
14030 .option acl_smtp_rcpt main string&!! unset
14031 .cindex "RCPT" "ACL for"
14032 This option defines the ACL that is run when an SMTP RCPT command is
14033 received. See chapter &<<CHAPACL>>& for further details.
14034
14035 .option acl_smtp_starttls main string&!! unset
14036 .cindex "STARTTLS, ACL for"
14037 This option defines the ACL that is run when an SMTP STARTTLS command is
14038 received. See chapter &<<CHAPACL>>& for further details.
14039
14040 .option acl_smtp_vrfy main string&!! unset
14041 .cindex "VRFY" "ACL for"
14042 This option defines the ACL that is run when an SMTP VRFY command is
14043 received. See chapter &<<CHAPACL>>& for further details.
14044
14045 .option add_environment main "string list" empty
14046 .cindex "environment" "set values"
14047 This option allows to set individual environment variables that the
14048 currently linked libraries and programs in child processes use.
14049 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14050
14051 .option admin_groups main "string list&!!" unset
14052 .cindex "admin user"
14053 This option is expanded just once, at the start of Exim's processing. If the
14054 current group or any of the supplementary groups of an Exim caller is in this
14055 colon-separated list, the caller has admin privileges. If all your system
14056 programmers are in a specific group, for example, you can give them all Exim
14057 admin privileges by putting that group in &%admin_groups%&. However, this does
14058 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14059 To permit this, you have to add individuals to the Exim group.
14060
14061 .option allow_domain_literals main boolean false
14062 .cindex "domain literal"
14063 If this option is set, the RFC 2822 domain literal format is permitted in
14064 email addresses. The option is not set by default, because the domain literal
14065 format is not normally required these days, and few people know about it. It
14066 has, however, been exploited by mail abusers.
14067
14068 Unfortunately, it seems that some DNS black list maintainers are using this
14069 format to report black listing to postmasters. If you want to accept messages
14070 addressed to your hosts by IP address, you need to set
14071 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14072 domains (defined in the named domain list &%local_domains%& in the default
14073 configuration). This &"magic string"& matches the domain literal form of all
14074 the local host's IP addresses.
14075
14076
14077 .option allow_mx_to_ip main boolean false
14078 .cindex "MX record" "pointing to IP address"
14079 It appears that more and more DNS zone administrators are breaking the rules
14080 and putting domain names that look like IP addresses on the right hand side of
14081 MX records. Exim follows the rules and rejects this, giving an error message
14082 that explains the misconfiguration. However, some other MTAs support this
14083 practice, so to avoid &"Why can't Exim do this?"& complaints,
14084 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14085 recommended, except when you have no other choice.
14086
14087 .option allow_utf8_domains main boolean false
14088 .cindex "domain" "UTF-8 characters in"
14089 .cindex "UTF-8" "in domain name"
14090 Lots of discussion is going on about internationalized domain names. One
14091 camp is strongly in favour of just using UTF-8 characters, and it seems
14092 that at least two other MTAs permit this. This option allows Exim users to
14093 experiment if they wish.
14094
14095 If it is set true, Exim's domain parsing function allows valid
14096 UTF-8 multicharacters to appear in domain name components, in addition to
14097 letters, digits, and hyphens. However, just setting this option is not
14098 enough; if you want to look up these domain names in the DNS, you must also
14099 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14100 suitable setting is:
14101 .code
14102 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14103   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14104 .endd
14105 Alternatively, you can just disable this feature by setting
14106 .code
14107 dns_check_names_pattern =
14108 .endd
14109 That is, set the option to an empty string so that no check is done.
14110
14111
14112 .option auth_advertise_hosts main "host list&!!" *
14113 .cindex "authentication" "advertising"
14114 .cindex "AUTH" "advertising"
14115 If any server authentication mechanisms are configured, Exim advertises them in
14116 response to an EHLO command only if the calling host matches this list.
14117 Otherwise, Exim does not advertise AUTH.
14118 Exim does not accept AUTH commands from clients to which it has not
14119 advertised the availability of AUTH. The advertising of individual
14120 authentication mechanisms can be controlled by the use of the
14121 &%server_advertise_condition%& generic authenticator option on the individual
14122 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14123
14124 Certain mail clients (for example, Netscape) require the user to provide a name
14125 and password for authentication if AUTH is advertised, even though it may
14126 not be needed (the host may accept messages from hosts on its local LAN without
14127 authentication, for example). The &%auth_advertise_hosts%& option can be used
14128 to make these clients more friendly by excluding them from the set of hosts to
14129 which Exim advertises AUTH.
14130
14131 .cindex "AUTH" "advertising when encrypted"
14132 If you want to advertise the availability of AUTH only when the connection
14133 is encrypted using TLS, you can make use of the fact that the value of this
14134 option is expanded, with a setting like this:
14135 .code
14136 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14137 .endd
14138 .vindex "&$tls_in_cipher$&"
14139 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14140 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14141 expansion is *, which matches all hosts.
14142
14143
14144 .option auto_thaw main time 0s
14145 .cindex "thawing messages"
14146 .cindex "unfreezing messages"
14147 If this option is set to a time greater than zero, a queue runner will try a
14148 new delivery attempt on any frozen message, other than a bounce message, if
14149 this much time has passed since it was frozen. This may result in the message
14150 being re-frozen if nothing has changed since the last attempt. It is a way of
14151 saying &"keep on trying, even though there are big problems"&.
14152
14153 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14154 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14155 thought to be very useful any more, and its use should probably be avoided.
14156
14157
14158 .option av_scanner main string "see below"
14159 This option is available if Exim is built with the content-scanning extension.
14160 It specifies which anti-virus scanner to use. The default value is:
14161 .code
14162 sophie:/var/run/sophie
14163 .endd
14164 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14165 before use. See section &<<SECTscanvirus>>& for further details.
14166
14167
14168 .option bi_command main string unset
14169 .oindex "&%-bi%&"
14170 This option supplies the name of a command that is run when Exim is called with
14171 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14172 just the command name, it is not a complete command line. If an argument is
14173 required, it must come from the &%-oA%& command line option.
14174
14175
14176 .option bounce_message_file main string unset
14177 .cindex "bounce message" "customizing"
14178 .cindex "customizing" "bounce message"
14179 This option defines a template file containing paragraphs of text to be used
14180 for constructing bounce messages.  Details of the file's contents are given in
14181 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14182
14183
14184 .option bounce_message_text main string unset
14185 When this option is set, its contents are included in the default bounce
14186 message immediately after &"This message was created automatically by mail
14187 delivery software."& It is not used if &%bounce_message_file%& is set.
14188
14189 .option bounce_return_body main boolean true
14190 .cindex "bounce message" "including body"
14191 This option controls whether the body of an incoming message is included in a
14192 bounce message when &%bounce_return_message%& is true. The default setting
14193 causes the entire message, both header and body, to be returned (subject to the
14194 value of &%bounce_return_size_limit%&). If this option is false, only the
14195 message header is included. In the case of a non-SMTP message containing an
14196 error that is detected during reception, only those header lines preceding the
14197 point at which the error was detected are returned.
14198 .cindex "bounce message" "including original"
14199
14200 .option bounce_return_linesize_limit main integer 998
14201 .cindex "size" "of bounce lines, limit"
14202 .cindex "bounce message" "line length limit"
14203 .cindex "limit" "bounce message line length"
14204 This option sets a limit in bytes on the line length of messages
14205 that are returned to senders due to delivery problems,
14206 when &%bounce_return_message%& is true.
14207 The default value corresponds to RFC limits.
14208 If the message being returned has lines longer than this value it is
14209 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14210
14211 The option also applies to bounces returned when an error is detected
14212 during reception of a message.
14213 In this case lines from the original are truncated.
14214
14215 The option does not apply to messages generated by an &(autoreply)& transport.
14216
14217
14218 .option bounce_return_message main boolean true
14219 If this option is set false, none of the original message is included in
14220 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14221 &%bounce_return_body%&.
14222
14223
14224 .option bounce_return_size_limit main integer 100K
14225 .cindex "size" "of bounce, limit"
14226 .cindex "bounce message" "size limit"
14227 .cindex "limit" "bounce message size"
14228 This option sets a limit in bytes on the size of messages that are returned to
14229 senders as part of bounce messages when &%bounce_return_message%& is true. The
14230 limit should be less than the value of the global &%message_size_limit%& and of
14231 any &%message_size_limit%& settings on transports, to allow for the bounce text
14232 that Exim generates. If this option is set to zero there is no limit.
14233
14234 When the body of any message that is to be included in a bounce message is
14235 greater than the limit, it is truncated, and a comment pointing this out is
14236 added at the top. The actual cutoff may be greater than the value given, owing
14237 to the use of buffering for transferring the message in chunks (typically 8K in
14238 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14239 messages.
14240
14241 .option bounce_sender_authentication main string unset
14242 .cindex "bounce message" "sender authentication"
14243 .cindex "authentication" "bounce message"
14244 .cindex "AUTH" "on bounce message"
14245 This option provides an authenticated sender address that is sent with any
14246 bounce messages generated by Exim that are sent over an authenticated SMTP
14247 connection. A typical setting might be:
14248 .code
14249 bounce_sender_authentication = mailer-daemon@my.domain.example
14250 .endd
14251 which would cause bounce messages to be sent using the SMTP command:
14252 .code
14253 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14254 .endd
14255 The value of &%bounce_sender_authentication%& must always be a complete email
14256 address.
14257
14258 .option callout_domain_negative_expire main time 3h
14259 .cindex "caching" "callout timeouts"
14260 .cindex "callout" "caching timeouts"
14261 This option specifies the expiry time for negative callout cache data for a
14262 domain. See section &<<SECTcallver>>& for details of callout verification, and
14263 section &<<SECTcallvercache>>& for details of the caching.
14264
14265
14266 .option callout_domain_positive_expire main time 7d
14267 This option specifies the expiry time for positive callout cache data for a
14268 domain. See section &<<SECTcallver>>& for details of callout verification, and
14269 section &<<SECTcallvercache>>& for details of the caching.
14270
14271
14272 .option callout_negative_expire main time 2h
14273 This option specifies the expiry time for negative callout cache data for an
14274 address. See section &<<SECTcallver>>& for details of callout verification, and
14275 section &<<SECTcallvercache>>& for details of the caching.
14276
14277
14278 .option callout_positive_expire main time 24h
14279 This option specifies the expiry time for positive callout cache data for an
14280 address. See section &<<SECTcallver>>& for details of callout verification, and
14281 section &<<SECTcallvercache>>& for details of the caching.
14282
14283
14284 .option callout_random_local_part main string&!! "see below"
14285 This option defines the &"random"& local part that can be used as part of
14286 callout verification. The default value is
14287 .code
14288 $primary_hostname-$tod_epoch-testing
14289 .endd
14290 See section &<<CALLaddparcall>>& for details of how this value is used.
14291
14292
14293 .option check_log_inodes main integer 0
14294 See &%check_spool_space%& below.
14295
14296
14297 .option check_log_space main integer 0
14298 See &%check_spool_space%& below.
14299
14300 .oindex "&%check_rfc2047_length%&"
14301 .cindex "RFC 2047" "disabling length check"
14302 .option check_rfc2047_length main boolean true
14303 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14304 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14305 word; strings to be encoded that exceed this length are supposed to use
14306 multiple encoded words. By default, Exim does not recognize encoded words that
14307 exceed the maximum length. However, it seems that some software, in violation
14308 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14309 set false, Exim recognizes encoded words of any length.
14310
14311
14312 .option check_spool_inodes main integer 0
14313 See &%check_spool_space%& below.
14314
14315
14316 .option check_spool_space main integer 0
14317 .cindex "checking disk space"
14318 .cindex "disk space, checking"
14319 .cindex "spool directory" "checking space"
14320 The four &%check_...%& options allow for checking of disk resources before a
14321 message is accepted.
14322
14323 .vindex "&$log_inodes$&"
14324 .vindex "&$log_space$&"
14325 .vindex "&$spool_inodes$&"
14326 .vindex "&$spool_space$&"
14327 When any of these options are set, they apply to all incoming messages. If you
14328 want to apply different checks to different kinds of message, you can do so by
14329 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14330 &$spool_space$& in an ACL with appropriate additional conditions.
14331
14332
14333 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14334 either value is greater than zero, for example:
14335 .code
14336 check_spool_space = 10M
14337 check_spool_inodes = 100
14338 .endd
14339 The spool partition is the one that contains the directory defined by
14340 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14341 transit.
14342
14343 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14344 files are written if either is greater than zero. These should be set only if
14345 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14346
14347 If there is less space or fewer inodes than requested, Exim refuses to accept
14348 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14349 error response to the MAIL command. If ESMTP is in use and there was a
14350 SIZE parameter on the MAIL command, its value is added to the
14351 &%check_spool_space%& value, and the check is performed even if
14352 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14353
14354 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14355 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14356
14357 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14358 failure a message is written to stderr and Exim exits with a non-zero code, as
14359 it obviously cannot send an error message of any kind.
14360
14361 .option daemon_smtp_ports main string &`smtp`&
14362 .cindex "port" "for daemon"
14363 .cindex "TCP/IP" "setting listening ports"
14364 This option specifies one or more default SMTP ports on which the Exim daemon
14365 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14366 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14367
14368 .option daemon_startup_retries main integer 9
14369 .cindex "daemon startup, retrying"
14370 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14371 the daemon at startup when it cannot immediately bind a listening socket
14372 (typically because the socket is already in use): &%daemon_startup_retries%&
14373 defines the number of retries after the first failure, and
14374 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14375
14376 .option daemon_startup_sleep main time 30s
14377 See &%daemon_startup_retries%&.
14378
14379 .option delay_warning main "time list" 24h
14380 .cindex "warning of delay"
14381 .cindex "delay warning, specifying"
14382 When a message is delayed, Exim sends a warning message to the sender at
14383 intervals specified by this option. The data is a colon-separated list of times
14384 after which to send warning messages. If the value of the option is an empty
14385 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14386 message has been on the queue for longer than the last time, the last interval
14387 between the times is used to compute subsequent warning times. For example,
14388 with
14389 .code
14390 delay_warning = 4h:8h:24h
14391 .endd
14392 the first message is sent after 4 hours, the second after 8 hours, and
14393 the third one after 24 hours. After that, messages are sent every 16 hours,
14394 because that is the interval between the last two times on the list. If you set
14395 just one time, it specifies the repeat interval. For example, with:
14396 .code
14397 delay_warning = 6h
14398 .endd
14399 messages are repeated every six hours. To stop warnings after a given time, set
14400 a very large time at the end of the list. For example:
14401 .code
14402 delay_warning = 2h:12h:99d
14403 .endd
14404 Note that the option is only evaluated at the time a delivery attempt fails,
14405 which depends on retry and queue-runner configuration.
14406 Typically retries will be configured more frequently than warning messages.
14407
14408 .option delay_warning_condition main string&!! "see below"
14409 .vindex "&$domain$&"
14410 The string is expanded at the time a warning message might be sent. If all the
14411 deferred addresses have the same domain, it is set in &$domain$& during the
14412 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14413 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14414 &"false"& (the comparison being done caselessly) then the warning message is
14415 not sent. The default is:
14416 .code
14417 delay_warning_condition = ${if or {\
14418   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14419   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14420   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14421   } {no}{yes}}
14422 .endd
14423 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14424 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14425 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14426 &"auto-replied"& in an &'Auto-Submitted:'& header.
14427
14428 .option deliver_drop_privilege main boolean false
14429 .cindex "unprivileged delivery"
14430 .cindex "delivery" "unprivileged"
14431 If this option is set true, Exim drops its root privilege at the start of a
14432 delivery process, and runs as the Exim user throughout. This severely restricts
14433 the kinds of local delivery that are possible, but is viable in certain types
14434 of configuration. There is a discussion about the use of root privilege in
14435 chapter &<<CHAPsecurity>>&.
14436
14437 .option deliver_queue_load_max main fixed-point unset
14438 .cindex "load average"
14439 .cindex "queue runner" "abandoning"
14440 When this option is set, a queue run is abandoned if the system load average
14441 becomes greater than the value of the option. The option has no effect on
14442 ancient operating systems on which Exim cannot determine the load average.
14443 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14444
14445
14446 .option delivery_date_remove main boolean true
14447 .cindex "&'Delivery-date:'& header line"
14448 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14449 message when it is delivered, in exactly the same way as &'Return-path:'& is
14450 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14451 should not be present in incoming messages, and this option causes them to be
14452 removed at the time the message is received, to avoid any problems that might
14453 occur when a delivered message is subsequently sent on to some other recipient.
14454
14455 .option disable_fsync main boolean false
14456 .cindex "&[fsync()]&, disabling"
14457 This option is available only if Exim was built with the compile-time option
14458 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14459 a runtime configuration generates an &"unknown option"& error. You should not
14460 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14461 really, really, really understand what you are doing. &'No pre-compiled
14462 distributions of Exim should ever make this option available.'&
14463
14464 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14465 updated files' data to be written to disc before continuing. Unexpected events
14466 such as crashes and power outages may cause data to be lost or scrambled.
14467 Here be Dragons. &*Beware.*&
14468
14469
14470 .option disable_ipv6 main boolean false
14471 .cindex "IPv6" "disabling"
14472 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14473 activities take place. AAAA records are never looked up, and any IPv6 addresses
14474 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14475 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14476 to handle IPv6 literal addresses.
14477
14478
14479 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14480 .cindex DKIM "controlling calls to the ACL"
14481 This option gives a list of DKIM domains for which the DKIM ACL is run.
14482 It is expanded after the message is received; by default it runs
14483 the ACL once for each signature in the message.
14484 See chapter &<<CHAPdkim>>&.
14485
14486
14487 .option dns_again_means_nonexist main "domain list&!!" unset
14488 .cindex "DNS" "&""try again""& response; overriding"
14489 DNS lookups give a &"try again"& response for the DNS errors
14490 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14491 keep trying to deliver a message, or to give repeated temporary errors to
14492 incoming mail. Sometimes the effect is caused by a badly set up name server and
14493 may persist for a long time. If a domain which exhibits this problem matches
14494 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14495 This option should be used with care. You can make it apply to reverse lookups
14496 by a setting such as this:
14497 .code
14498 dns_again_means_nonexist = *.in-addr.arpa
14499 .endd
14500 This option applies to all DNS lookups that Exim does. It also applies when the
14501 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14502 since these are most likely to be caused by DNS lookup problems. The
14503 &(dnslookup)& router has some options of its own for controlling what happens
14504 when lookups for MX or SRV records give temporary errors. These more specific
14505 options are applied after this global option.
14506
14507 .option dns_check_names_pattern main string "see below"
14508 .cindex "DNS" "pre-check of name syntax"
14509 When this option is set to a non-empty string, it causes Exim to check domain
14510 names for characters that are not allowed in host names before handing them to
14511 the DNS resolver, because some resolvers give temporary errors for names that
14512 contain unusual characters. If a domain name contains any unwanted characters,
14513 a &"not found"& result is forced, and the resolver is not called. The check is
14514 done by matching the domain name against a regular expression, which is the
14515 value of this option. The default pattern is
14516 .code
14517 dns_check_names_pattern = \
14518   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14519 .endd
14520 which permits only letters, digits, slashes, and hyphens in components, but
14521 they must start and end with a letter or digit. Slashes are not, in fact,
14522 permitted in host names, but they are found in certain NS records (which can be
14523 accessed in Exim by using a &%dnsdb%& lookup). If you set
14524 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14525 empty string.
14526
14527 .option dns_csa_search_limit main integer 5
14528 This option controls the depth of parental searching for CSA SRV records in the
14529 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14530
14531 .option dns_csa_use_reverse main boolean true
14532 This option controls whether or not an IP address, given as a CSA domain, is
14533 reversed and looked up in the reverse DNS, as described in more detail in
14534 section &<<SECTverifyCSA>>&.
14535
14536
14537 .option dns_dnssec_ok main integer -1
14538 .cindex "DNS" "resolver options"
14539 .cindex "DNS" "DNSSEC"
14540 If this option is set to a non-negative number then Exim will initialise the
14541 DNS resolver library to either use or not use DNSSEC, overriding the system
14542 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14543
14544 If the resolver library does not support DNSSEC then this option has no effect.
14545
14546
14547 .option dns_ipv4_lookup main "domain list&!!" unset
14548 .cindex "IPv6" "DNS lookup for AAAA records"
14549 .cindex "DNS" "IPv6 lookup for AAAA records"
14550 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14551 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14552 (A records) when trying to find IP addresses for hosts, unless the host's
14553 domain matches this list.
14554
14555 This is a fudge to help with name servers that give big delays or otherwise do
14556 not work for the AAAA record type. In due course, when the world's name
14557 servers have all been upgraded, there should be no need for this option.
14558
14559
14560 .option dns_retrans main time 0s
14561 .cindex "DNS" "resolver options"
14562 .cindex timeout "dns lookup"
14563 .cindex "DNS" timeout
14564 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14565 retransmission and retry parameters for DNS lookups. Values of zero (the
14566 defaults) leave the system default settings unchanged. The first value is the
14567 time between retries, and the second is the number of retries. It isn't
14568 totally clear exactly how these settings affect the total time a DNS lookup may
14569 take. I haven't found any documentation about timeouts on DNS lookups; these
14570 parameter values are available in the external resolver interface structure,
14571 but nowhere does it seem to describe how they are used or what you might want
14572 to set in them.
14573 See also the &%slow_lookup_log%& option.
14574
14575
14576 .option dns_retry main integer 0
14577 See &%dns_retrans%& above.
14578
14579
14580 .option dns_trust_aa main "domain list&!!" unset
14581 .cindex "DNS" "resolver options"
14582 .cindex "DNS" "DNSSEC"
14583 If this option is set then lookup results marked with the AA bit
14584 (Authoritative Answer) are trusted the same way as if they were
14585 DNSSEC-verified. The authority section's name of the answer must
14586 match with this expanded domain list.
14587
14588 Use this option only if you talk directly to a resolver that is
14589 authoritative for some zones and does not set the AD (Authentic Data)
14590 bit in the answer. Some DNS servers may have an configuration option to
14591 mark the answers from their own zones as verified (they set the AD bit).
14592 Others do not have this option. It is considered as poor practice using
14593 a resolver that is an authoritative server for some zones.
14594
14595 Use this option only if you really have to (e.g. if you want
14596 to use DANE for remote delivery to a server that is listed in the DNS
14597 zones that your resolver is authoritative for).
14598
14599 If the DNS answer packet has the AA bit set and contains resource record
14600 in the answer section, the name of the first NS record appearing in the
14601 authority section is compared against the list. If the answer packet is
14602 authoritative but the answer section is empty, the name of the first SOA
14603 record in the authoritative section is used instead.
14604
14605 .cindex "DNS" "resolver options"
14606 .option dns_use_edns0 main integer -1
14607 .cindex "DNS" "resolver options"
14608 .cindex "DNS" "EDNS0"
14609 If this option is set to a non-negative number then Exim will initialise the
14610 DNS resolver library to either use or not use EDNS0 extensions, overriding
14611 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14612 on.
14613
14614 If the resolver library does not support EDNS0 then this option has no effect.
14615
14616
14617 .option drop_cr main boolean false
14618 This is an obsolete option that is now a no-op. It used to affect the way Exim
14619 handled CR and LF characters in incoming messages. What happens now is
14620 described in section &<<SECTlineendings>>&.
14621
14622 .option dsn_advertise_hosts main "host list&!!" unset
14623 .cindex "bounce messages" "success"
14624 .cindex "DSN" "success"
14625 .cindex "Delivery Status Notification" "success"
14626 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14627 and accepted from, these hosts.
14628 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14629 and RET and ORCPT options on MAIL FROM commands.
14630 A NOTIFY=SUCCESS option requests success-DSN messages.
14631 A NOTIFY= option with no argument requests that no delay or failure DSNs
14632 are sent.
14633
14634 .option dsn_from main "string&!!" "see below"
14635 .cindex "&'From:'& header line" "in bounces"
14636 .cindex "bounce messages" "&'From:'& line, specifying"
14637 This option can be used to vary the contents of &'From:'& header lines in
14638 bounces and other automatically generated messages (&"Delivery Status
14639 Notifications"& &-- hence the name of the option). The default setting is:
14640 .code
14641 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14642 .endd
14643 The value is expanded every time it is needed. If the expansion fails, a
14644 panic is logged, and the default value is used.
14645
14646 .option envelope_to_remove main boolean true
14647 .cindex "&'Envelope-to:'& header line"
14648 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14649 message when it is delivered, in exactly the same way as &'Return-path:'& is
14650 handled. &'Envelope-to:'& records the original recipient address from the
14651 message's envelope that caused the delivery to happen. Such headers should not
14652 be present in incoming messages, and this option causes them to be removed at
14653 the time the message is received, to avoid any problems that might occur when a
14654 delivered message is subsequently sent on to some other recipient.
14655
14656
14657 .option errors_copy main "string list&!!" unset
14658 .cindex "bounce message" "copy to other address"
14659 .cindex "copy of bounce message"
14660 Setting this option causes Exim to send bcc copies of bounce messages that it
14661 generates to other addresses. &*Note*&: This does not apply to bounce messages
14662 coming from elsewhere. The value of the option is a colon-separated list of
14663 items. Each item consists of a pattern, terminated by white space, followed by
14664 a comma-separated list of email addresses. If a pattern contains spaces, it
14665 must be enclosed in double quotes.
14666
14667 Each pattern is processed in the same way as a single item in an address list
14668 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14669 the bounce message, the message is copied to the addresses on the list. The
14670 items are scanned in order, and once a matching one is found, no further items
14671 are examined. For example:
14672 .code
14673 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14674               rqps@mydomain   hostmaster@mydomain.example,\
14675                               postmaster@mydomain.example
14676 .endd
14677 .vindex "&$domain$&"
14678 .vindex "&$local_part$&"
14679 The address list is expanded before use. The expansion variables &$local_part$&
14680 and &$domain$& are set from the original recipient of the error message, and if
14681 there was any wildcard matching in the pattern, the expansion
14682 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14683 variables &$0$&, &$1$&, etc. are set in the normal way.
14684
14685
14686 .option errors_reply_to main string unset
14687 .cindex "bounce message" "&'Reply-to:'& in"
14688 By default, Exim's bounce and delivery warning messages contain the header line
14689 .display
14690 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14691 .endd
14692 .oindex &%quota_warn_message%&
14693 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14694 A warning message that is generated by the &%quota_warn_message%& option in an
14695 &(appendfile)& transport may contain its own &'From:'& header line that
14696 overrides the default.
14697
14698 Experience shows that people reply to bounce messages. If the
14699 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14700 and warning messages. For example:
14701 .code
14702 errors_reply_to = postmaster@my.domain.example
14703 .endd
14704 The value of the option is not expanded. It must specify a valid RFC 2822
14705 address. However, if a warning message that is generated by the
14706 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14707 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14708 not used.
14709
14710
14711 .option event_action main string&!! unset
14712 .cindex events
14713 This option declares a string to be expanded for Exim's events mechanism.
14714 For details see &<<CHAPevents>>&.
14715
14716
14717 .option exim_group main string "compile-time configured"
14718 .cindex "gid (group id)" "Exim's own"
14719 .cindex "Exim group"
14720 This option changes the gid under which Exim runs when it gives up root
14721 privilege. The default value is compiled into the binary. The value of this
14722 option is used only when &%exim_user%& is also set. Unless it consists entirely
14723 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14724 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14725 security issues.
14726
14727
14728 .option exim_path main string "see below"
14729 .cindex "Exim binary, path name"
14730 This option specifies the path name of the Exim binary, which is used when Exim
14731 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14732 the directory configured at compile time by the BIN_DIRECTORY setting. It
14733 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14734 other place.
14735 &*Warning*&: Do not use a macro to define the value of this option, because
14736 you will break those Exim utilities that scan the configuration file to find
14737 where the binary is. (They then use the &%-bP%& option to extract option
14738 settings such as the value of &%spool_directory%&.)
14739
14740
14741 .option exim_user main string "compile-time configured"
14742 .cindex "uid (user id)" "Exim's own"
14743 .cindex "Exim user"
14744 This option changes the uid under which Exim runs when it gives up root
14745 privilege. The default value is compiled into the binary. Ownership of the run
14746 time configuration file and the use of the &%-C%& and &%-D%& command line
14747 options is checked against the values in the binary, not what is set here.
14748
14749 Unless it consists entirely of digits, the string is looked up using
14750 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14751 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14752 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14753
14754
14755 .option extra_local_interfaces main "string list" unset
14756 This option defines network interfaces that are to be considered local when
14757 routing, but which are not used for listening by the daemon. See section
14758 &<<SECTreclocipadd>>& for details.
14759
14760
14761 . Allow this long option name to split; give it unsplit as a fifth argument
14762 . for the automatic .oindex that is generated by .option.
14763
14764 .option "extract_addresses_remove_arguments" main boolean true &&&
14765          extract_addresses_remove_arguments
14766 .oindex "&%-t%&"
14767 .cindex "command line" "addresses with &%-t%&"
14768 .cindex "Sendmail compatibility" "&%-t%& option"
14769 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14770 are present on the command line when the &%-t%& option is used to build an
14771 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14772 line addresses are removed from the recipients list. This is also how Smail
14773 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14774 command line addresses are added to those obtained from the header lines. When
14775 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14776 argument headers. If it is set false, Exim adds rather than removes argument
14777 addresses.
14778
14779
14780 .option finduser_retries main integer 0
14781 .cindex "NIS, retrying user lookups"
14782 On systems running NIS or other schemes in which user and group information is
14783 distributed from a remote system, there can be times when &[getpwnam()]& and
14784 related functions fail, even when given valid data, because things time out.
14785 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14786 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14787 many extra times to find a user or a group, waiting for one second between
14788 retries.
14789
14790 .cindex "&_/etc/passwd_&" "multiple reading of"
14791 You should not set this option greater than zero if your user information is in
14792 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14793 search the file multiple times for non-existent users, and also cause delay.
14794
14795
14796
14797 .option freeze_tell main "string list, comma separated" unset
14798 .cindex "freezing messages" "sending a message when freezing"
14799 On encountering certain errors, or when configured to do so in a system filter,
14800 ACL, or special router, Exim freezes a message. This means that no further
14801 delivery attempts take place until an administrator thaws the message, or the
14802 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14803 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14804 warning message whenever it freezes something, unless the message it is
14805 freezing is a locally-generated bounce message. (Without this exception there
14806 is the possibility of looping.) The warning message is sent to the addresses
14807 supplied as the comma-separated value of this option. If several of the
14808 message's addresses cause freezing, only a single message is sent. If the
14809 freezing was automatic, the reason(s) for freezing can be found in the message
14810 log. If you configure freezing in a filter or ACL, you must arrange for any
14811 logging that you require.
14812
14813
14814 .option gecos_name main string&!! unset
14815 .cindex "HP-UX"
14816 .cindex "&""gecos""& field, parsing"
14817 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14818 password file to hold other information in addition to users' real names. Exim
14819 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14820 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14821 of the field are used unchanged, except that, if an ampersand is encountered,
14822 it is replaced by the user's login name with the first character forced to
14823 upper case, since this is a convention that is observed on many systems.
14824
14825 When these options are set, &%gecos_pattern%& is treated as a regular
14826 expression that is to be applied to the field (again with && replaced by the
14827 login name), and if it matches, &%gecos_name%& is expanded and used as the
14828 user's name.
14829
14830 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14831 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14832 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14833 name terminates at the first comma, the following can be used:
14834 .code
14835 gecos_pattern = ([^,]*)
14836 gecos_name = $1
14837 .endd
14838
14839 .option gecos_pattern main string unset
14840 See &%gecos_name%& above.
14841
14842
14843 .option gnutls_compat_mode main boolean unset
14844 This option controls whether GnuTLS is used in compatibility mode in an Exim
14845 server. This reduces security slightly, but improves interworking with older
14846 implementations of TLS.
14847
14848
14849 option gnutls_allow_auto_pkcs11 main boolean unset
14850 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14851 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14852
14853 See
14854 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14855 for documentation.
14856
14857
14858
14859 .option headers_charset main string "see below"
14860 This option sets a default character set for translating from encoded MIME
14861 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14862 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14863 ultimate default is ISO-8859-1. For more details see the description of header
14864 insertions in section &<<SECTexpansionitems>>&.
14865
14866
14867
14868 .option header_maxsize main integer "see below"
14869 .cindex "header section" "maximum size of"
14870 .cindex "limit" "size of message header section"
14871 This option controls the overall maximum size of a message's header
14872 section. The default is the value of HEADER_MAXSIZE in
14873 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14874 sections are rejected.
14875
14876
14877 .option header_line_maxsize main integer 0
14878 .cindex "header lines" "maximum size of"
14879 .cindex "limit" "size of one header line"
14880 This option limits the length of any individual header line in a message, after
14881 all the continuations have been joined together. Messages with individual
14882 header lines that are longer than the limit are rejected. The default value of
14883 zero means &"no limit"&.
14884
14885
14886
14887
14888 .option helo_accept_junk_hosts main "host list&!!" unset
14889 .cindex "HELO" "accepting junk data"
14890 .cindex "EHLO" "accepting junk data"
14891 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14892 mail, and gives an error response for invalid data. Unfortunately, there are
14893 some SMTP clients that send syntactic junk. They can be accommodated by setting
14894 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14895 if you want to do semantic checking.
14896 See also &%helo_allow_chars%& for a way of extending the permitted character
14897 set.
14898
14899
14900 .option helo_allow_chars main string unset
14901 .cindex "HELO" "underscores in"
14902 .cindex "EHLO" "underscores in"
14903 .cindex "underscore in EHLO/HELO"
14904 This option can be set to a string of rogue characters that are permitted in
14905 all EHLO and HELO names in addition to the standard letters, digits,
14906 hyphens, and dots. If you really must allow underscores, you can set
14907 .code
14908 helo_allow_chars = _
14909 .endd
14910 Note that the value is one string, not a list.
14911
14912
14913 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14914 .cindex "HELO" "forcing reverse lookup"
14915 .cindex "EHLO" "forcing reverse lookup"
14916 If the domain given by a client in a HELO or EHLO command matches this
14917 list, a reverse lookup is done in order to establish the host's true name. The
14918 default forces a lookup if the client host gives the server's name or any of
14919 its IP addresses (in brackets), something that broken clients have been seen to
14920 do.
14921
14922
14923 .option helo_try_verify_hosts main "host list&!!" unset
14924 .cindex "HELO verifying" "optional"
14925 .cindex "EHLO" "verifying, optional"
14926 By default, Exim just checks the syntax of HELO and EHLO commands (see
14927 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14928 to do more extensive checking of the data supplied by these commands. The ACL
14929 condition &`verify = helo`& is provided to make this possible.
14930 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14931 to force the check to occur. From release 4.53 onwards, this is no longer
14932 necessary. If the check has not been done before &`verify = helo`& is
14933 encountered, it is done at that time. Consequently, this option is obsolete.
14934 Its specification is retained here for backwards compatibility.
14935
14936 When an EHLO or HELO command is received, if the calling host matches
14937 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14938 EHLO command either:
14939
14940 .ilist
14941 is an IP literal matching the calling address of the host, or
14942 .next
14943 .cindex "DNS" "reverse lookup"
14944 .cindex "reverse DNS lookup"
14945 matches the host name that Exim obtains by doing a reverse lookup of the
14946 calling host address, or
14947 .next
14948 when looked up in DNS yields the calling host address.
14949 .endlist
14950
14951 However, the EHLO or HELO command is not rejected if any of the checks
14952 fail. Processing continues, but the result of the check is remembered, and can
14953 be detected later in an ACL by the &`verify = helo`& condition.
14954
14955 If DNS was used for successful verification, the variable
14956 .cindex "DNS" "DNSSEC"
14957 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14958
14959 .option helo_verify_hosts main "host list&!!" unset
14960 .cindex "HELO verifying" "mandatory"
14961 .cindex "EHLO" "verifying, mandatory"
14962 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14963 backwards compatibility. For hosts that match this option, Exim checks the host
14964 name given in the HELO or EHLO in the same way as for
14965 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14966 rejected with a 550 error, and entries are written to the main and reject logs.
14967 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14968 error.
14969
14970 .option hold_domains main "domain list&!!" unset
14971 .cindex "domain" "delaying delivery"
14972 .cindex "delivery" "delaying certain domains"
14973 This option allows mail for particular domains to be held on the queue
14974 manually. The option is overridden if a message delivery is forced with the
14975 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14976 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14977 item in &%hold_domains%&, no routing or delivery for that address is done, and
14978 it is deferred every time the message is looked at.
14979
14980 This option is intended as a temporary operational measure for delaying the
14981 delivery of mail while some problem is being sorted out, or some new
14982 configuration tested. If you just want to delay the processing of some
14983 domains until a queue run occurs, you should use &%queue_domains%& or
14984 &%queue_smtp_domains%&, not &%hold_domains%&.
14985
14986 A setting of &%hold_domains%& does not override Exim's code for removing
14987 messages from the queue if they have been there longer than the longest retry
14988 time in any retry rule. If you want to hold messages for longer than the normal
14989 retry times, insert a dummy retry rule with a long retry time.
14990
14991
14992 .option host_lookup main "host list&!!" unset
14993 .cindex "host name" "lookup, forcing"
14994 Exim does not look up the name of a calling host from its IP address unless it
14995 is required to compare against some host list, or the host matches
14996 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14997 option (which normally contains IP addresses rather than host names). The
14998 default configuration file contains
14999 .code
15000 host_lookup = *
15001 .endd
15002 which causes a lookup to happen for all hosts. If the expense of these lookups
15003 is felt to be too great, the setting can be changed or removed.
15004
15005 After a successful reverse lookup, Exim does a forward lookup on the name it
15006 has obtained, to verify that it yields the IP address that it started with. If
15007 this check fails, Exim behaves as if the name lookup failed.
15008
15009 .vindex "&$host_lookup_failed$&"
15010 .vindex "&$sender_host_name$&"
15011 After any kind of failure, the host name (in &$sender_host_name$&) remains
15012 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15013 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15014 &`verify = reverse_host_lookup`& in ACLs.
15015
15016
15017 .option host_lookup_order main "string list" &`bydns:byaddr`&
15018 This option specifies the order of different lookup methods when Exim is trying
15019 to find a host name from an IP address. The default is to do a DNS lookup
15020 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15021 if that fails. You can change the order of these lookups, or omit one entirely,
15022 if you want.
15023
15024 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15025 multiple PTR records in the DNS and the IP address is not listed in
15026 &_/etc/hosts_&. Different operating systems give different results in this
15027 case. That is why the default tries a DNS lookup first.
15028
15029
15030
15031 .option host_reject_connection main "host list&!!" unset
15032 .cindex "host" "rejecting connections from"
15033 If this option is set, incoming SMTP calls from the hosts listed are rejected
15034 as soon as the connection is made.
15035 This option is obsolete, and retained only for backward compatibility, because
15036 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15037 connections immediately.
15038
15039 The ability to give an immediate rejection (either by this option or using an
15040 ACL) is provided for use in unusual cases. Many hosts will just try again,
15041 sometimes without much delay. Normally, it is better to use an ACL to reject
15042 incoming messages at a later stage, such as after RCPT commands. See
15043 chapter &<<CHAPACL>>&.
15044
15045
15046 .option hosts_connection_nolog main "host list&!!" unset
15047 .cindex "host" "not logging connections from"
15048 This option defines a list of hosts for which connection logging does not
15049 happen, even though the &%smtp_connection%& log selector is set. For example,
15050 you might want not to log SMTP connections from local processes, or from
15051 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15052 the daemon; you should therefore strive to restrict its value to a short inline
15053 list of IP addresses and networks. To disable logging SMTP connections from
15054 local processes, you must create a host list with an empty item. For example:
15055 .code
15056 hosts_connection_nolog = :
15057 .endd
15058 If the &%smtp_connection%& log selector is not set, this option has no effect.
15059
15060
15061
15062 .option hosts_proxy main "host list&!!" unset
15063 .cindex proxy "proxy protocol"
15064 This option enables use of Proxy Protocol proxies for incoming
15065 connections.  For details see &<<SECTproxyInbound>>&.
15066
15067
15068 .option hosts_treat_as_local main "domain list&!!" unset
15069 .cindex "local host" "domains treated as"
15070 .cindex "host" "treated as local"
15071 If this option is set, any host names that match the domain list are treated as
15072 if they were the local host when Exim is scanning host lists obtained from MX
15073 records
15074 or other sources. Note that the value of this option is a domain list, not a
15075 host list, because it is always used to check host names, not IP addresses.
15076
15077 This option also applies when Exim is matching the special items
15078 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15079 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15080 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15081 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15082 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15083 interfaces and recognizing the local host.
15084
15085
15086 .option ibase_servers main "string list" unset
15087 .cindex "InterBase" "server list"
15088 This option provides a list of InterBase servers and associated connection data,
15089 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15090 The option is available only if Exim has been built with InterBase support.
15091
15092
15093
15094 .option ignore_bounce_errors_after main time 10w
15095 .cindex "bounce message" "discarding"
15096 .cindex "discarding bounce message"
15097 This option affects the processing of bounce messages that cannot be delivered,
15098 that is, those that suffer a permanent delivery failure. (Bounce messages that
15099 suffer temporary delivery failures are of course retried in the usual way.)
15100
15101 After a permanent delivery failure, bounce messages are frozen,
15102 because there is no sender to whom they can be returned. When a frozen bounce
15103 message has been on the queue for more than the given time, it is unfrozen at
15104 the next queue run, and a further delivery is attempted. If delivery fails
15105 again, the bounce message is discarded. This makes it possible to keep failed
15106 bounce messages around for a shorter time than the normal maximum retry time
15107 for frozen messages. For example,
15108 .code
15109 ignore_bounce_errors_after = 12h
15110 .endd
15111 retries failed bounce message deliveries after 12 hours, discarding any further
15112 failures. If the value of this option is set to a zero time period, bounce
15113 failures are discarded immediately. Setting a very long time (as in the default
15114 value) has the effect of disabling this option. For ways of automatically
15115 dealing with other kinds of frozen message, see &%auto_thaw%& and
15116 &%timeout_frozen_after%&.
15117
15118
15119 .option ignore_fromline_hosts main "host list&!!" unset
15120 .cindex "&""From""& line"
15121 .cindex "UUCP" "&""From""& line"
15122 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15123 the headers of a message. By default this is treated as the start of the
15124 message's body, which means that any following headers are not recognized as
15125 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15126 match those hosts that insist on sending it. If the sender is actually a local
15127 process rather than a remote host, and is using &%-bs%& to inject the messages,
15128 &%ignore_fromline_local%& must be set to achieve this effect.
15129
15130
15131 .option ignore_fromline_local main boolean false
15132 See &%ignore_fromline_hosts%& above.
15133
15134 .option keep_environment main "string list" unset
15135 .cindex "environment" "values from"
15136 This option contains a string list of environment variables to keep.
15137 You have to trust these variables or you have to be sure that
15138 these variables do not impose any security risk. Keep in mind that
15139 during the startup phase Exim is running with an effective UID 0 in most
15140 installations. As the default value is an empty list, the default
15141 environment for using libraries, running embedded Perl code, or running
15142 external binaries is empty, and does not not even contain PATH or HOME.
15143
15144 Actually the list is interpreted as a list of patterns
15145 (&<<SECTlistexpand>>&), except that it is not expanded first.
15146
15147 WARNING: Macro substitution is still done first, so having a macro
15148 FOO and having FOO_HOME in your &%keep_environment%& option may have
15149 unexpected results. You may work around this using a regular expression
15150 that does not match the macro name: ^[F]OO_HOME$.
15151
15152 Current versions of Exim issue a warning during startup if you do not mention
15153 &%keep_environment%& in your runtime configuration file and if your
15154 current environment is not empty. Future versions may not issue that warning
15155 anymore.
15156
15157 See the &%add_environment%& main config option for a way to set
15158 environment variables to a fixed value.  The environment for &(pipe)&
15159 transports is handled separately, see section &<<SECTpipeenv>>& for
15160 details.
15161
15162
15163 .option keep_malformed main time 4d
15164 This option specifies the length of time to keep messages whose spool files
15165 have been corrupted in some way. This should, of course, never happen. At the
15166 next attempt to deliver such a message, it gets removed. The incident is
15167 logged.
15168
15169
15170 .option ldap_ca_cert_dir main string unset
15171 .cindex "LDAP", "TLS CA certificate directory"
15172 .cindex certificate "directory for LDAP"
15173 This option indicates which directory contains CA certificates for verifying
15174 a TLS certificate presented by an LDAP server.
15175 While Exim does not provide a default value, your SSL library may.
15176 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15177 and constrained to be a directory.
15178
15179
15180 .option ldap_ca_cert_file main string unset
15181 .cindex "LDAP", "TLS CA certificate file"
15182 .cindex certificate "file for LDAP"
15183 This option indicates which file contains CA certificates for verifying
15184 a TLS certificate presented by an LDAP server.
15185 While Exim does not provide a default value, your SSL library may.
15186 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15187 and constrained to be a file.
15188
15189
15190 .option ldap_cert_file main string unset
15191 .cindex "LDAP" "TLS client certificate file"
15192 .cindex certificate "file for LDAP"
15193 This option indicates which file contains an TLS client certificate which
15194 Exim should present to the LDAP server during TLS negotiation.
15195 Should be used together with &%ldap_cert_key%&.
15196
15197
15198 .option ldap_cert_key main string unset
15199 .cindex "LDAP" "TLS client key file"
15200 .cindex certificate "key for LDAP"
15201 This option indicates which file contains the secret/private key to use
15202 to prove identity to the LDAP server during TLS negotiation.
15203 Should be used together with &%ldap_cert_file%&, which contains the
15204 identity to be proven.
15205
15206
15207 .option ldap_cipher_suite main string unset
15208 .cindex "LDAP" "TLS cipher suite"
15209 This controls the TLS cipher-suite negotiation during TLS negotiation with
15210 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15211 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15212
15213
15214 .option ldap_default_servers main "string list" unset
15215 .cindex "LDAP" "default servers"
15216 This option provides a list of LDAP servers which are tried in turn when an
15217 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15218 details of LDAP queries. This option is available only when Exim has been built
15219 with LDAP support.
15220
15221
15222 .option ldap_require_cert main string unset.
15223 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15224 This should be one of the values "hard", "demand", "allow", "try" or "never".
15225 A value other than one of these is interpreted as "never".
15226 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15227 Although Exim does not set a default, the LDAP library probably defaults
15228 to hard/demand.
15229
15230
15231 .option ldap_start_tls main boolean false
15232 .cindex "LDAP" "whether or not to negotiate TLS"
15233 If set, Exim will attempt to negotiate TLS with the LDAP server when
15234 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15235 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15236 of SSL-on-connect.
15237 In the event of failure to negotiate TLS, the action taken is controlled
15238 by &%ldap_require_cert%&.
15239
15240
15241 .option ldap_version main integer unset
15242 .cindex "LDAP" "protocol version, forcing"
15243 This option can be used to force Exim to set a specific protocol version for
15244 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15245 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15246 the LDAP headers; otherwise it is 2. This option is available only when Exim
15247 has been built with LDAP support.
15248
15249
15250
15251 .option local_from_check main boolean true
15252 .cindex "&'Sender:'& header line" "disabling addition of"
15253 .cindex "&'From:'& header line" "disabling checking of"
15254 When a message is submitted locally (that is, not over a TCP/IP connection) by
15255 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15256 checks that the &'From:'& header line matches the login of the calling user and
15257 the domain specified by &%qualify_domain%&.
15258
15259 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15260 locally submitted message is automatically qualified by Exim, unless the
15261 &%-bnq%& command line option is used.
15262
15263 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15264 on the local part. If the &'From:'& header line does not match, Exim adds a
15265 &'Sender:'& header with an address constructed from the calling user's login
15266 and the default qualify domain.
15267
15268 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15269 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15270 &'Sender:'& header lines supplied by untrusted users, you must also set
15271 &%local_sender_retain%& to be true.
15272
15273 .cindex "envelope sender"
15274 These options affect only the header lines in the message. The envelope sender
15275 is still forced to be the login id at the qualify domain unless
15276 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15277
15278 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15279 request similar header line checking. See section &<<SECTthesenhea>>&, which
15280 has more details about &'Sender:'& processing.
15281
15282
15283
15284
15285 .option local_from_prefix main string unset
15286 When Exim checks the &'From:'& header line of locally submitted messages for
15287 matching the login id (see &%local_from_check%& above), it can be configured to
15288 ignore certain prefixes and suffixes in the local part of the address. This is
15289 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15290 appropriate lists, in the same form as the &%local_part_prefix%& and
15291 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15292 example, if
15293 .code
15294 local_from_prefix = *-
15295 .endd
15296 is set, a &'From:'& line containing
15297 .code
15298 From: anything-user@your.domain.example
15299 .endd
15300 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15301 matches the actual sender address that is constructed from the login name and
15302 qualify domain.
15303
15304
15305 .option local_from_suffix main string unset
15306 See &%local_from_prefix%& above.
15307
15308
15309 .option local_interfaces main "string list" "see below"
15310 This option controls which network interfaces are used by the daemon for
15311 listening; they are also used to identify the local host when routing. Chapter
15312 &<<CHAPinterfaces>>& contains a full description of this option and the related
15313 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15314 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15315 &%local_interfaces%& is
15316 .code
15317 local_interfaces = 0.0.0.0
15318 .endd
15319 when Exim is built without IPv6 support; otherwise it is
15320 .code
15321 local_interfaces = <; ::0 ; 0.0.0.0
15322 .endd
15323
15324 .option local_scan_timeout main time 5m
15325 .cindex "timeout" "for &[local_scan()]& function"
15326 .cindex "&[local_scan()]& function" "timeout"
15327 This timeout applies to the &[local_scan()]& function (see chapter
15328 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15329 the incoming message is rejected with a temporary error if it is an SMTP
15330 message. For a non-SMTP message, the message is dropped and Exim ends with a
15331 non-zero code. The incident is logged on the main and reject logs.
15332
15333
15334
15335 .option local_sender_retain main boolean false
15336 .cindex "&'Sender:'& header line" "retaining from local submission"
15337 When a message is submitted locally (that is, not over a TCP/IP connection) by
15338 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15339 do not want this to happen, you must set &%local_sender_retain%&, and you must
15340 also set &%local_from_check%& to be false (Exim will complain if you do not).
15341 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15342 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15343
15344
15345
15346
15347 .option localhost_number main string&!! unset
15348 .cindex "host" "locally unique number for"
15349 .cindex "message ids" "with multiple hosts"
15350 .vindex "&$localhost_number$&"
15351 Exim's message ids are normally unique only within the local host. If
15352 uniqueness among a set of hosts is required, each host must set a different
15353 value for the &%localhost_number%& option. The string is expanded immediately
15354 after reading the configuration file (so that a number can be computed from the
15355 host name, for example) and the result of the expansion must be a number in the
15356 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15357 systems). This is available in subsequent string expansions via the variable
15358 &$localhost_number$&. When &%localhost_number is set%&, the final two
15359 characters of the message id, instead of just being a fractional part of the
15360 time, are computed from the time and the local host number as described in
15361 section &<<SECTmessiden>>&.
15362
15363
15364
15365 .option log_file_path main "string list&!!" "set at compile time"
15366 .cindex "log" "file path for"
15367 This option sets the path which is used to determine the names of Exim's log
15368 files, or indicates that logging is to be to syslog, or both. It is expanded
15369 when Exim is entered, so it can, for example, contain a reference to the host
15370 name. If no specific path is set for the log files at compile or run time,
15371 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15372 they are written in a sub-directory called &_log_& in Exim's spool directory.
15373 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15374 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15375 used. If this string is fixed at your installation (contains no expansion
15376 variables) it is recommended that you do not set this option in the
15377 configuration file, but instead supply the path using LOG_FILE_PATH in
15378 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15379 early on &-- in particular, failure to read the configuration file.
15380
15381
15382 .option log_selector main string unset
15383 .cindex "log" "selectors"
15384 This option can be used to reduce or increase the number of things that Exim
15385 writes to its log files. Its argument is made up of names preceded by plus or
15386 minus characters. For example:
15387 .code
15388 log_selector = +arguments -retry_defer
15389 .endd
15390 A list of possible names and what they control is given in the chapter on
15391 logging, in section &<<SECTlogselector>>&.
15392
15393
15394 .option log_timezone main boolean false
15395 .cindex "log" "timezone for entries"
15396 .vindex "&$tod_log$&"
15397 .vindex "&$tod_zone$&"
15398 By default, the timestamps on log lines are in local time without the
15399 timezone. This means that if your timezone changes twice a year, the timestamps
15400 in log lines are ambiguous for an hour when the clocks go back. One way of
15401 avoiding this problem is to set the timezone to UTC. An alternative is to set
15402 &%log_timezone%& true. This turns on the addition of the timezone offset to
15403 timestamps in log lines. Turning on this option can add quite a lot to the size
15404 of log files because each line is extended by 6 characters. Note that the
15405 &$tod_log$& variable contains the log timestamp without the zone, but there is
15406 another variable called &$tod_zone$& that contains just the timezone offset.
15407
15408
15409 .option lookup_open_max main integer 25
15410 .cindex "too many open files"
15411 .cindex "open files, too many"
15412 .cindex "file" "too many open"
15413 .cindex "lookup" "maximum open files"
15414 .cindex "limit" "open files for lookups"
15415 This option limits the number of simultaneously open files for single-key
15416 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15417 Exim normally keeps these files open during routing, because often the same
15418 file is required several times. If the limit is reached, Exim closes the least
15419 recently used file. Note that if you are using the &'ndbm'& library, it
15420 actually opens two files for each logical DBM database, though it still counts
15421 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15422 open files"& errors with NDBM, you need to reduce the value of
15423 &%lookup_open_max%&.
15424
15425
15426 .option max_username_length main integer 0
15427 .cindex "length of login name"
15428 .cindex "user name" "maximum length"
15429 .cindex "limit" "user name length"
15430 Some operating systems are broken in that they truncate long arguments to
15431 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15432 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15433 an argument that is longer behaves as if &[getpwnam()]& failed.
15434
15435
15436 .option message_body_newlines main bool false
15437 .cindex "message body" "newlines in variables"
15438 .cindex "newline" "in message body variables"
15439 .vindex "&$message_body$&"
15440 .vindex "&$message_body_end$&"
15441 By default, newlines in the message body are replaced by spaces when setting
15442 the &$message_body$& and &$message_body_end$& expansion variables. If this
15443 option is set true, this no longer happens.
15444
15445
15446 .option message_body_visible main integer 500
15447 .cindex "body of message" "visible size"
15448 .cindex "message body" "visible size"
15449 .vindex "&$message_body$&"
15450 .vindex "&$message_body_end$&"
15451 This option specifies how much of a message's body is to be included in the
15452 &$message_body$& and &$message_body_end$& expansion variables.
15453
15454
15455 .option message_id_header_domain main string&!! unset
15456 .cindex "&'Message-ID:'& header line"
15457 If this option is set, the string is expanded and used as the right hand side
15458 (domain) of the &'Message-ID:'& header that Exim creates if a
15459 locally-originated incoming message does not have one. &"Locally-originated"&
15460 means &"not received over TCP/IP."&
15461 Otherwise, the primary host name is used.
15462 Only letters, digits, dot and hyphen are accepted; any other characters are
15463 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15464 empty string, the option is ignored.
15465
15466
15467 .option message_id_header_text main string&!! unset
15468 If this variable is set, the string is expanded and used to augment the text of
15469 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15470 message does not have one. The text of this header is required by RFC 2822 to
15471 take the form of an address. By default, Exim uses its internal message id as
15472 the local part, and the primary host name as the domain. If this option is set,
15473 it is expanded, and provided the expansion is not forced to fail, and does not
15474 yield an empty string, the result is inserted into the header immediately
15475 before the @, separated from the internal message id by a dot. Any characters
15476 that are illegal in an address are automatically converted into hyphens. This
15477 means that variables such as &$tod_log$& can be used, because the spaces and
15478 colons will become hyphens.
15479
15480
15481 .option message_logs main boolean true
15482 .cindex "message logs" "disabling"
15483 .cindex "log" "message log; disabling"
15484 If this option is turned off, per-message log files are not created in the
15485 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15486 Exim, by reducing the number of files involved in handling a message from a
15487 minimum of four (header spool file, body spool file, delivery journal, and
15488 per-message log) to three. The other major I/O activity is Exim's main log,
15489 which is not affected by this option.
15490
15491
15492 .option message_size_limit main string&!! 50M
15493 .cindex "message" "size limit"
15494 .cindex "limit" "message size"
15495 .cindex "size" "of message, limit"
15496 This option limits the maximum size of message that Exim will process. The
15497 value is expanded for each incoming connection so, for example, it can be made
15498 to depend on the IP address of the remote host for messages arriving via
15499 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15500 optionally followed by K or M.
15501
15502 &*Note*&: This limit cannot be made to depend on a message's sender or any
15503 other properties of an individual message, because it has to be advertised in
15504 the server's response to EHLO. String expansion failure causes a temporary
15505 error. A value of zero means no limit, but its use is not recommended. See also
15506 &%bounce_return_size_limit%&.
15507
15508 Incoming SMTP messages are failed with a 552 error if the limit is
15509 exceeded; locally-generated messages either get a stderr message or a delivery
15510 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15511 an oversized message is logged in both the main and the reject logs. See also
15512 the generic transport option &%message_size_limit%&, which limits the size of
15513 message that an individual transport can process.
15514
15515 If you use a virus-scanner and set this option to to a value larger than the
15516 maximum size that your virus-scanner is configured to support, you may get
15517 failures triggered by large mails.  The right size to configure for the
15518 virus-scanner depends upon what data is passed and the options in use but it's
15519 probably safest to just set it to a little larger than this value.  E.g., with a
15520 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15521 some problems may result.
15522
15523 A value of 0 will disable size limit checking; Exim will still advertise the
15524 SIZE extension in an EHLO response, but without a limit, so as to permit
15525 SMTP clients to still indicate the message size along with the MAIL verb.
15526
15527
15528 .option move_frozen_messages main boolean false
15529 .cindex "frozen messages" "moving"
15530 This option, which is available only if Exim has been built with the setting
15531 .code
15532 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15533 .endd
15534 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15535 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15536 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15537 standard utilities for handling such moved messages, and they do not show up in
15538 lists generated by &%-bp%& or by the Exim monitor.
15539
15540
15541 .option mua_wrapper main boolean false
15542 Setting this option true causes Exim to run in a very restrictive mode in which
15543 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15544 contains a full description of this facility.
15545
15546
15547
15548 .option mysql_servers main "string list" unset
15549 .cindex "MySQL" "server list"
15550 This option provides a list of MySQL servers and associated connection data, to
15551 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15552 option is available only if Exim has been built with MySQL support.
15553
15554
15555 .option never_users main "string list&!!" unset
15556 This option is expanded just once, at the start of Exim's processing. Local
15557 message deliveries are normally run in processes that are setuid to the
15558 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15559 It is usually desirable to prevent any deliveries from running as root, as a
15560 safety precaution.
15561
15562 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15563 list of users that must not be used for local deliveries. This list is fixed in
15564 the binary and cannot be overridden by the configuration file. By default, it
15565 contains just the single user name &"root"&. The &%never_users%& runtime option
15566 can be used to add more users to the fixed list.
15567
15568 If a message is to be delivered as one of the users on the fixed list or the
15569 &%never_users%& list, an error occurs, and delivery is deferred. A common
15570 example is
15571 .code
15572 never_users = root:daemon:bin
15573 .endd
15574 Including root is redundant if it is also on the fixed list, but it does no
15575 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15576 transport driver.
15577
15578
15579 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15580 .cindex "OpenSSL "compatibility options"
15581 This option allows an administrator to adjust the SSL options applied
15582 by OpenSSL to connections.  It is given as a space-separated list of items,
15583 each one to be +added or -subtracted from the current value.
15584
15585 This option is only available if Exim is built against OpenSSL.  The values
15586 available for this option vary according to the age of your OpenSSL install.
15587 The &"all"& value controls a subset of flags which are available, typically
15588 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15589 list the values known on your system and Exim should support all the
15590 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15591 names lose the leading &"SSL_OP_"& and are lower-cased.
15592
15593 Note that adjusting the options can have severe impact upon the security of
15594 SSL as used by Exim.  It is possible to disable safety checks and shoot
15595 yourself in the foot in various unpleasant ways.  This option should not be
15596 adjusted lightly.  An unrecognised item will be detected at startup, by
15597 invoking Exim with the &%-bV%& flag.
15598
15599 The option affects Exim operating both as a server and as a client.
15600
15601 Historical note: prior to release 4.80, Exim defaulted this value to
15602 "+dont_insert_empty_fragments", which may still be needed for compatibility
15603 with some clients, but which lowers security by increasing exposure to
15604 some now infamous attacks.
15605
15606 Examples:
15607 .code
15608 # Make both old MS and old Eudora happy:
15609 openssl_options = -all +microsoft_big_sslv3_buffer \
15610                        +dont_insert_empty_fragments
15611
15612 # Disable older protocol versions:
15613 openssl_options = +no_sslv2 +no_sslv3
15614 .endd
15615
15616 Possible options may include:
15617 .ilist
15618 &`all`&
15619 .next
15620 &`allow_unsafe_legacy_renegotiation`&
15621 .next
15622 &`cipher_server_preference`&
15623 .next
15624 &`dont_insert_empty_fragments`&
15625 .next
15626 &`ephemeral_rsa`&
15627 .next
15628 &`legacy_server_connect`&
15629 .next
15630 &`microsoft_big_sslv3_buffer`&
15631 .next
15632 &`microsoft_sess_id_bug`&
15633 .next
15634 &`msie_sslv2_rsa_padding`&
15635 .next
15636 &`netscape_challenge_bug`&
15637 .next
15638 &`netscape_reuse_cipher_change_bug`&
15639 .next
15640 &`no_compression`&
15641 .next
15642 &`no_session_resumption_on_renegotiation`&
15643 .next
15644 &`no_sslv2`&
15645 .next
15646 &`no_sslv3`&
15647 .next
15648 &`no_ticket`&
15649 .next
15650 &`no_tlsv1`&
15651 .next
15652 &`no_tlsv1_1`&
15653 .next
15654 &`no_tlsv1_2`&
15655 .next
15656 &`safari_ecdhe_ecdsa_bug`&
15657 .next
15658 &`single_dh_use`&
15659 .next
15660 &`single_ecdh_use`&
15661 .next
15662 &`ssleay_080_client_dh_bug`&
15663 .next
15664 &`sslref2_reuse_cert_type_bug`&
15665 .next
15666 &`tls_block_padding_bug`&
15667 .next
15668 &`tls_d5_bug`&
15669 .next
15670 &`tls_rollback_bug`&
15671 .endlist
15672
15673 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15674 all clients connecting using the MacOS SecureTransport TLS facility prior
15675 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15676 to negotiate TLS then this option value might help, provided that your OpenSSL
15677 release is new enough to contain this work-around.  This may be a situation
15678 where you have to upgrade OpenSSL to get buggy clients working.
15679
15680
15681 .option oracle_servers main "string list" unset
15682 .cindex "Oracle" "server list"
15683 This option provides a list of Oracle servers and associated connection data,
15684 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15685 The option is available only if Exim has been built with Oracle support.
15686
15687
15688 .option percent_hack_domains main "domain list&!!" unset
15689 .cindex "&""percent hack""&"
15690 .cindex "source routing" "in email address"
15691 .cindex "address" "source-routed"
15692 The &"percent hack"& is the convention whereby a local part containing a
15693 percent sign is re-interpreted as a new email address, with the percent
15694 replaced by @. This is sometimes called &"source routing"&, though that term is
15695 also applied to RFC 2822 addresses that begin with an @ character. If this
15696 option is set, Exim implements the percent facility for those domains listed,
15697 but no others. This happens before an incoming SMTP address is tested against
15698 an ACL.
15699
15700 &*Warning*&: The &"percent hack"& has often been abused by people who are
15701 trying to get round relaying restrictions. For this reason, it is best avoided
15702 if at all possible. Unfortunately, a number of less security-conscious MTAs
15703 implement it unconditionally. If you are running Exim on a gateway host, and
15704 routing mail through to internal MTAs without processing the local parts, it is
15705 a good idea to reject recipient addresses with percent characters in their
15706 local parts. Exim's default configuration does this.
15707
15708
15709 .option perl_at_start main boolean false
15710 .cindex "Perl"
15711 This option is available only when Exim is built with an embedded Perl
15712 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15713
15714
15715 .option perl_startup main string unset
15716 .cindex "Perl"
15717 This option is available only when Exim is built with an embedded Perl
15718 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15719
15720 .option perl_startup main boolean false
15721 .cindex "Perl"
15722 This Option enables the taint mode of the embedded Perl interpreter.
15723
15724
15725 .option pgsql_servers main "string list" unset
15726 .cindex "PostgreSQL lookup type" "server list"
15727 This option provides a list of PostgreSQL servers and associated connection
15728 data, to be used in conjunction with &(pgsql)& lookups (see section
15729 &<<SECID72>>&). The option is available only if Exim has been built with
15730 PostgreSQL support.
15731
15732
15733 .option pid_file_path main string&!! "set at compile time"
15734 .cindex "daemon" "pid file path"
15735 .cindex "pid file, path for"
15736 This option sets the name of the file to which the Exim daemon writes its
15737 process id. The string is expanded, so it can contain, for example, references
15738 to the host name:
15739 .code
15740 pid_file_path = /var/log/$primary_hostname/exim.pid
15741 .endd
15742 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15743 spool directory.
15744 The value set by the option can be overridden by the &%-oP%& command line
15745 option. A pid file is not written if a &"non-standard"& daemon is run by means
15746 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15747
15748
15749 .option pipelining_advertise_hosts main "host list&!!" *
15750 .cindex "PIPELINING" "suppressing advertising"
15751 This option can be used to suppress the advertisement of the SMTP
15752 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15753 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15754 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15755 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15756 that clients will use it; &"out of order"& commands that are &"expected"& do
15757 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15758
15759
15760 .option prdr_enable main boolean false
15761 .cindex "PRDR" "enabling on server"
15762 This option can be used to enable the Per-Recipient Data Response extension
15763 to SMTP, defined by Eric Hall.
15764 If the option is set, PRDR is advertised by Exim when operating as a server.
15765 If the client requests PRDR, and more than one recipient, for a message
15766 an additional ACL is called for each recipient after the message content
15767 is received.  See section &<<SECTPRDRACL>>&.
15768
15769 .option preserve_message_logs main boolean false
15770 .cindex "message logs" "preserving"
15771 If this option is set, message log files are not deleted when messages are
15772 completed. Instead, they are moved to a sub-directory of the spool directory
15773 called &_msglog.OLD_&, where they remain available for statistical or debugging
15774 purposes. This is a dangerous option to set on systems with any appreciable
15775 volume of mail. Use with care!
15776
15777
15778 .option primary_hostname main string "see below"
15779 .cindex "name" "of local host"
15780 .cindex "host" "name of local"
15781 .cindex "local host" "name of"
15782 .vindex "&$primary_hostname$&"
15783 This specifies the name of the current host. It is used in the default EHLO or
15784 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15785 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15786 The value is also used by default in some SMTP response messages from an Exim
15787 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15788
15789 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15790 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15791 contains only one component, Exim passes it to &[gethostbyname()]& (or
15792 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15793 version. The variable &$primary_hostname$& contains the host name, whether set
15794 explicitly by this option, or defaulted.
15795
15796
15797 .option print_topbitchars main boolean false
15798 .cindex "printing characters"
15799 .cindex "8-bit characters"
15800 By default, Exim considers only those characters whose codes lie in the range
15801 32&--126 to be printing characters. In a number of circumstances (for example,
15802 when writing log entries) non-printing characters are converted into escape
15803 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15804 is set, code values of 128 and above are also considered to be printing
15805 characters.
15806
15807 This option also affects the header syntax checks performed by the
15808 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15809 the user's full name when constructing From: and Sender: addresses (as
15810 described in section &<<SECTconstr>>&). Setting this option can cause
15811 Exim to generate eight bit message headers that do not conform to the
15812 standards.
15813
15814
15815 .option process_log_path main string unset
15816 .cindex "process log path"
15817 .cindex "log" "process log"
15818 .cindex "&'exiwhat'&"
15819 This option sets the name of the file to which an Exim process writes its
15820 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15821 utility script. If this option is unset, the file called &_exim-process.info_&
15822 in Exim's spool directory is used. The ability to specify the name explicitly
15823 can be useful in environments where two different Exims are running, using
15824 different spool directories.
15825
15826
15827 .option prod_requires_admin main boolean true
15828 .oindex "&%-M%&"
15829 .oindex "&%-R%&"
15830 .oindex "&%-q%&"
15831 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15832 admin user unless &%prod_requires_admin%& is set false. See also
15833 &%queue_list_requires_admin%&.
15834
15835
15836 .option qualify_domain main string "see below"
15837 .cindex "domain" "for qualifying addresses"
15838 .cindex "address" "qualification"
15839 This option specifies the domain name that is added to any envelope sender
15840 addresses that do not have a domain qualification. It also applies to
15841 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15842 are accepted by default only for locally-generated messages. Qualification is
15843 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15844 locally-generated messages, unless the &%-bnq%& command line option is used.
15845
15846 Messages from external sources must always contain fully qualified addresses,
15847 unless the sending host matches &%sender_unqualified_hosts%& or
15848 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15849 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15850 necessary. Internally, Exim always works with fully qualified envelope
15851 addresses. If &%qualify_domain%& is not set, it defaults to the
15852 &%primary_hostname%& value.
15853
15854
15855 .option qualify_recipient main string "see below"
15856 This option allows you to specify a different domain for qualifying recipient
15857 addresses to the one that is used for senders. See &%qualify_domain%& above.
15858
15859
15860
15861 .option queue_domains main "domain list&!!" unset
15862 .cindex "domain" "specifying non-immediate delivery"
15863 .cindex "queueing incoming messages"
15864 .cindex "message" "queueing certain domains"
15865 This option lists domains for which immediate delivery is not required.
15866 A delivery process is started whenever a message is received, but only those
15867 domains that do not match are processed. All other deliveries wait until the
15868 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15869
15870
15871 .option queue_list_requires_admin main boolean true
15872 .oindex "&%-bp%&"
15873 The &%-bp%& command-line option, which lists the messages that are on the
15874 queue, requires the caller to be an admin user unless
15875 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15876
15877
15878 .option queue_only main boolean false
15879 .cindex "queueing incoming messages"
15880 .cindex "message" "queueing unconditionally"
15881 If &%queue_only%& is set, a delivery process is not automatically started
15882 whenever a message is received. Instead, the message waits on the queue for the
15883 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15884 delivered immediately when certain conditions (such as heavy load) occur.
15885
15886 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15887 and &%-odi%& command line options override &%queue_only%& unless
15888 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15889 &%queue_only_load%&, and &%smtp_accept_queue%&.
15890
15891
15892 .option queue_only_file main string unset
15893 .cindex "queueing incoming messages"
15894 .cindex "message" "queueing by file existence"
15895 This option can be set to a colon-separated list of absolute path names, each
15896 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15897 it tests for the existence of each listed path using a call to &[stat()]&. For
15898 each path that exists, the corresponding queueing option is set.
15899 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15900 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15901 .code
15902 queue_only_file = smtp/some/file
15903 .endd
15904 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15905 &_/some/file_& exists.
15906
15907
15908 .option queue_only_load main fixed-point unset
15909 .cindex "load average"
15910 .cindex "queueing incoming messages"
15911 .cindex "message" "queueing by load"
15912 If the system load average is higher than this value, incoming messages from
15913 all sources are queued, and no automatic deliveries are started. If this
15914 happens during local or remote SMTP input, all subsequent messages received on
15915 the same SMTP connection are queued by default, whatever happens to the load in
15916 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15917 false.
15918
15919 Deliveries will subsequently be performed by queue runner processes. This
15920 option has no effect on ancient operating systems on which Exim cannot
15921 determine the load average. See also &%deliver_queue_load_max%& and
15922 &%smtp_load_reserve%&.
15923
15924
15925 .option queue_only_load_latch main boolean true
15926 .cindex "load average" "re-evaluating per message"
15927 When this option is true (the default), once one message has been queued
15928 because the load average is higher than the value set by &%queue_only_load%&,
15929 all subsequent messages received on the same SMTP connection are also queued.
15930 This is a deliberate choice; even though the load average may fall below the
15931 threshold, it doesn't seem right to deliver later messages on the same
15932 connection when not delivering earlier ones. However, there are special
15933 circumstances such as very long-lived connections from scanning appliances
15934 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15935 should be set false. This causes the value of the load average to be
15936 re-evaluated for each message.
15937
15938
15939 .option queue_only_override main boolean true
15940 .cindex "queueing incoming messages"
15941 When this option is true, the &%-od%&&'x'& command line options override the
15942 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15943 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15944 to override; they are accepted, but ignored.
15945
15946
15947 .option queue_run_in_order main boolean false
15948 .cindex "queue runner" "processing messages in order"
15949 If this option is set, queue runs happen in order of message arrival instead of
15950 in an arbitrary order. For this to happen, a complete list of the entire queue
15951 must be set up before the deliveries start. When the queue is all held in a
15952 single directory (the default), a single list is created for both the ordered
15953 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15954 single list is not created when &%queue_run_in_order%& is false. In this case,
15955 the sub-directories are processed one at a time (in a random order), and this
15956 avoids setting up one huge list for the whole queue. Thus, setting
15957 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15958 when the queue is large, because of the extra work in setting up the single,
15959 large list. In most situations, &%queue_run_in_order%& should not be set.
15960
15961
15962
15963 .option queue_run_max main integer&!! 5
15964 .cindex "queue runner" "maximum number of"
15965 This controls the maximum number of queue runner processes that an Exim daemon
15966 can run simultaneously. This does not mean that it starts them all at once,
15967 but rather that if the maximum number are still running when the time comes to
15968 start another one, it refrains from starting another one. This can happen with
15969 very large queues and/or very sluggish deliveries. This option does not,
15970 however, interlock with other processes, so additional queue runners can be
15971 started by other means, or by killing and restarting the daemon.
15972
15973 Setting this option to zero does not suppress queue runs; rather, it disables
15974 the limit, allowing any number of simultaneous queue runner processes to be
15975 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15976 the daemon's command line.
15977
15978 .new
15979 .cindex queues named
15980 .cindex "named queues"
15981 To set limits for different named queues use
15982 an expansion depending on the &$queue_name$& variable.
15983 .wen
15984
15985 .option queue_smtp_domains main "domain list&!!" unset
15986 .cindex "queueing incoming messages"
15987 .cindex "message" "queueing remote deliveries"
15988 When this option is set, a delivery process is started whenever a message is
15989 received, routing is performed, and local deliveries take place.
15990 However, if any SMTP deliveries are required for domains that match
15991 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15992 message waits on the queue for the next queue run. Since routing of the message
15993 has taken place, Exim knows to which remote hosts it must be delivered, and so
15994 when the queue run happens, multiple messages for the same host are delivered
15995 over a single SMTP connection. The &%-odqs%& command line option causes all
15996 SMTP deliveries to be queued in this way, and is equivalent to setting
15997 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15998 &%queue_domains%&.
15999
16000
16001 .option receive_timeout main time 0s
16002 .cindex "timeout" "for non-SMTP input"
16003 This option sets the timeout for accepting a non-SMTP message, that is, the
16004 maximum time that Exim waits when reading a message on the standard input. If
16005 the value is zero, it will wait for ever. This setting is overridden by the
16006 &%-or%& command line option. The timeout for incoming SMTP messages is
16007 controlled by &%smtp_receive_timeout%&.
16008
16009 .option received_header_text main string&!! "see below"
16010 .cindex "customizing" "&'Received:'& header"
16011 .cindex "&'Received:'& header line" "customizing"
16012 This string defines the contents of the &'Received:'& message header that is
16013 added to each message, except for the timestamp, which is automatically added
16014 on at the end (preceded by a semicolon). The string is expanded each time it is
16015 used. If the expansion yields an empty string, no &'Received:'& header line is
16016 added to the message. Otherwise, the string should start with the text
16017 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16018 header lines. The default setting is:
16019
16020 .code
16021 received_header_text = Received: \
16022   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16023   {${if def:sender_ident \
16024   {from ${quote_local_part:$sender_ident} }}\
16025   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16026   by $primary_hostname \
16027   ${if def:received_protocol {with $received_protocol}} \
16028   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16029   (Exim $version_number)\n\t\
16030   ${if def:sender_address \
16031   {(envelope-from <$sender_address>)\n\t}}\
16032   id $message_exim_id\
16033   ${if def:received_for {\n\tfor $received_for}}
16034 .endd
16035
16036 The reference to the TLS cipher is omitted when Exim is built without TLS
16037 support. The use of conditional expansions ensures that this works for both
16038 locally generated messages and messages received from remote hosts, giving
16039 header lines such as the following:
16040 .code
16041 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16042 by marley.carol.example with esmtp (Exim 4.00)
16043 (envelope-from <bob@carol.example>)
16044 id 16IOWa-00019l-00
16045 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16046 Received: by scrooge.carol.example with local (Exim 4.00)
16047 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16048 .endd
16049 Until the body of the message has been received, the timestamp is the time when
16050 the message started to be received. Once the body has arrived, and all policy
16051 checks have taken place, the timestamp is updated to the time at which the
16052 message was accepted.
16053
16054
16055 .option received_headers_max main integer 30
16056 .cindex "loop" "prevention"
16057 .cindex "mail loop prevention"
16058 .cindex "&'Received:'& header line" "counting"
16059 When a message is to be delivered, the number of &'Received:'& headers is
16060 counted, and if it is greater than this parameter, a mail loop is assumed to
16061 have occurred, the delivery is abandoned, and an error message is generated.
16062 This applies to both local and remote deliveries.
16063
16064
16065 .option recipient_unqualified_hosts main "host list&!!" unset
16066 .cindex "unqualified addresses"
16067 .cindex "host" "unqualified addresses from"
16068 This option lists those hosts from which Exim is prepared to accept unqualified
16069 recipient addresses in message envelopes. The addresses are made fully
16070 qualified by the addition of the &%qualify_recipient%& value. This option also
16071 affects message header lines. Exim does not reject unqualified recipient
16072 addresses in headers, but it qualifies them only if the message came from a
16073 host that matches &%recipient_unqualified_hosts%&,
16074 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16075 option was not set.
16076
16077
16078 .option recipients_max main integer 0
16079 .cindex "limit" "number of recipients"
16080 .cindex "recipient" "maximum number"
16081 If this option is set greater than zero, it specifies the maximum number of
16082 original recipients for any message. Additional recipients that are generated
16083 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16084 all recipients over the limit; earlier recipients are delivered as normal.
16085 Non-SMTP messages with too many recipients are failed, and no deliveries are
16086 done.
16087
16088 .cindex "RCPT" "maximum number of incoming"
16089 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16090 RCPT commands in a single message.
16091
16092
16093 .option recipients_max_reject main boolean false
16094 If this option is set true, Exim rejects SMTP messages containing too many
16095 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16096 error to the eventual DATA command. Otherwise (the default) it gives a 452
16097 error to the surplus RCPT commands and accepts the message on behalf of the
16098 initial set of recipients. The remote server should then re-send the message
16099 for the remaining recipients at a later time.
16100
16101
16102 .option remote_max_parallel main integer 2
16103 .cindex "delivery" "parallelism for remote"
16104 This option controls parallel delivery of one message to a number of remote
16105 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16106 does all the remote deliveries for a message one by one. Otherwise, if a single
16107 message has to be delivered to more than one remote host, or if several copies
16108 have to be sent to the same remote host, up to &%remote_max_parallel%&
16109 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16110 deliveries are required, the maximum number of processes are started, and as
16111 each one finishes, another is begun. The order of starting processes is the
16112 same as if sequential delivery were being done, and can be controlled by the
16113 &%remote_sort_domains%& option. If parallel delivery takes place while running
16114 with debugging turned on, the debugging output from each delivery process is
16115 tagged with its process id.
16116
16117 This option controls only the maximum number of parallel deliveries for one
16118 message in one Exim delivery process. Because Exim has no central queue
16119 manager, there is no way of controlling the total number of simultaneous
16120 deliveries if the configuration allows a delivery attempt as soon as a message
16121 is received.
16122
16123 .cindex "number of deliveries"
16124 .cindex "delivery" "maximum number of"
16125 If you want to control the total number of deliveries on the system, you
16126 need to set the &%queue_only%& option. This ensures that all incoming messages
16127 are added to the queue without starting a delivery process. Then set up an Exim
16128 daemon to start queue runner processes at appropriate intervals (probably
16129 fairly often, for example, every minute), and limit the total number of queue
16130 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16131 delivers only one message at a time, the maximum number of deliveries that can
16132 then take place at once is &%queue_run_max%& multiplied by
16133 &%remote_max_parallel%&.
16134
16135 If it is purely remote deliveries you want to control, use
16136 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16137 doing the SMTP routing before queueing, so that several messages for the same
16138 host will eventually get delivered down the same connection.
16139
16140
16141 .option remote_sort_domains main "domain list&!!" unset
16142 .cindex "sorting remote deliveries"
16143 .cindex "delivery" "sorting remote"
16144 When there are a number of remote deliveries for a message, they are sorted by
16145 domain into the order given by this list. For example,
16146 .code
16147 remote_sort_domains = *.cam.ac.uk:*.uk
16148 .endd
16149 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16150 then to those in the &%uk%& domain, then to any others.
16151
16152
16153 .option retry_data_expire main time 7d
16154 .cindex "hints database" "data expiry"
16155 This option sets a &"use before"& time on retry information in Exim's hints
16156 database. Any older retry data is ignored. This means that, for example, once a
16157 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16158 past failures.
16159
16160
16161 .option retry_interval_max main time 24h
16162 .cindex "retry" "limit on interval"
16163 .cindex "limit" "on retry interval"
16164 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16165 intervals between delivery attempts for messages that cannot be delivered
16166 straight away. This option sets an overall limit to the length of time between
16167 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16168 the default value.
16169
16170
16171 .option return_path_remove main boolean true
16172 .cindex "&'Return-path:'& header line" "removing"
16173 RFC 2821, section 4.4, states that an SMTP server must insert a
16174 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16175 The &'Return-path:'& header preserves the sender address as received in the
16176 MAIL command. This description implies that this header should not be present
16177 in an incoming message. If &%return_path_remove%& is true, any existing
16178 &'Return-path:'& headers are removed from messages at the time they are
16179 received. Exim's transports have options for adding &'Return-path:'& headers at
16180 the time of delivery. They are normally used only for final local deliveries.
16181
16182
16183 .option return_size_limit main integer 100K
16184 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16185
16186
16187 .option rfc1413_hosts main "host list&!!" @[]
16188 .cindex "RFC 1413"
16189 .cindex "host" "for RFC 1413 calls"
16190 RFC 1413 identification calls are made to any client host which matches
16191 an item in the list.
16192 The default value specifies just this host, being any local interface
16193 for the system.
16194
16195 .option rfc1413_query_timeout main time 0s
16196 .cindex "RFC 1413" "query timeout"
16197 .cindex "timeout" "for RFC 1413 call"
16198 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16199 no RFC 1413 calls are ever made.
16200
16201
16202 .option sender_unqualified_hosts main "host list&!!" unset
16203 .cindex "unqualified addresses"
16204 .cindex "host" "unqualified addresses from"
16205 This option lists those hosts from which Exim is prepared to accept unqualified
16206 sender addresses. The addresses are made fully qualified by the addition of
16207 &%qualify_domain%&. This option also affects message header lines. Exim does
16208 not reject unqualified addresses in headers that contain sender addresses, but
16209 it qualifies them only if the message came from a host that matches
16210 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16211 using TCP/IP), and the &%-bnq%& option was not set.
16212
16213 .option set_environment main "string list" empty
16214 .cindex "environment"
16215 This option allows to set individual environment variables that the
16216 currently linked libraries and programs in child processes use. The
16217 default list is empty,
16218
16219
16220 .option slow_lookup_log main integer 0
16221 .cindex "logging" "slow lookups"
16222 .cindex "dns" "logging slow lookups"
16223 This option controls logging of slow lookups.
16224 If the value is nonzero it is taken as a number of milliseconds
16225 and lookups taking longer than this are logged.
16226 Currently this applies only to DNS lookups.
16227
16228
16229
16230 .option smtp_accept_keepalive main boolean true
16231 .cindex "keepalive" "on incoming connection"
16232 This option controls the setting of the SO_KEEPALIVE option on incoming
16233 TCP/IP socket connections. When set, it causes the kernel to probe idle
16234 connections periodically, by sending packets with &"old"& sequence numbers. The
16235 other end of the connection should send an acknowledgment if the connection is
16236 still okay or a reset if the connection has been aborted. The reason for doing
16237 this is that it has the beneficial effect of freeing up certain types of
16238 connection that can get stuck when the remote host is disconnected without
16239 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16240 hours to detect unreachable hosts.
16241
16242
16243
16244 .option smtp_accept_max main integer 20
16245 .cindex "limit" "incoming SMTP connections"
16246 .cindex "SMTP" "incoming connection count"
16247 .cindex "inetd"
16248 This option specifies the maximum number of simultaneous incoming SMTP calls
16249 that Exim will accept. It applies only to the listening daemon; there is no
16250 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16251 value is set to zero, no limit is applied. However, it is required to be
16252 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16253 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16254
16255 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16256 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16257 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16258 and &%smtp_load_reserve%& are then checked before accepting the connection.
16259
16260
16261 .option smtp_accept_max_nonmail main integer 10
16262 .cindex "limit" "non-mail SMTP commands"
16263 .cindex "SMTP" "limiting non-mail commands"
16264 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16265 the connection if there are too many. This option defines &"too many"&. The
16266 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16267 client looping sending EHLO, for example. The check is applied only if the
16268 client host matches &%smtp_accept_max_nonmail_hosts%&.
16269
16270 When a new message is expected, one occurrence of RSET is not counted. This
16271 allows a client to send one RSET between messages (this is not necessary,
16272 but some clients do it). Exim also allows one uncounted occurrence of HELO
16273 or EHLO, and one occurrence of STARTTLS between messages. After
16274 starting up a TLS session, another EHLO is expected, and so it too is not
16275 counted. The first occurrence of AUTH in a connection, or immediately
16276 following STARTTLS is not counted. Otherwise, all commands other than
16277 MAIL, RCPT, DATA, and QUIT are counted.
16278
16279
16280 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16281 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16282 check by setting this option. The default value makes it apply to all hosts. By
16283 changing the value, you can exclude any badly-behaved hosts that you have to
16284 live with.
16285
16286
16287 . Allow this long option name to split; give it unsplit as a fifth argument
16288 . for the automatic .oindex that is generated by .option.
16289 . We insert " &~&~" which is both pretty nasty visually and results in
16290 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16291 . zero-width-space, which would be nicer visually and results in (at least)
16292 . html that Firefox will split on when it's forced to reflow (rather than
16293 . inserting a horizontal scrollbar).  However, the text is still not
16294 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16295 . the option name to split.
16296
16297 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16298          smtp_accept_max_per_connection
16299 .cindex "SMTP" "limiting incoming message count"
16300 .cindex "limit" "messages per SMTP connection"
16301 The value of this option limits the number of MAIL commands that Exim is
16302 prepared to accept over a single SMTP connection, whether or not each command
16303 results in the transfer of a message. After the limit is reached, a 421
16304 response is given to subsequent MAIL commands. This limit is a safety
16305 precaution against a client that goes mad (incidents of this type have been
16306 seen).
16307
16308
16309 .option smtp_accept_max_per_host main string&!! unset
16310 .cindex "limit" "SMTP connections from one host"
16311 .cindex "host" "limiting SMTP connections from"
16312 This option restricts the number of simultaneous IP connections from a single
16313 host (strictly, from a single IP address) to the Exim daemon. The option is
16314 expanded, to enable different limits to be applied to different hosts by
16315 reference to &$sender_host_address$&. Once the limit is reached, additional
16316 connection attempts from the same host are rejected with error code 421. This
16317 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16318 of zero imposes no limit. If this option is set greater than zero, it is
16319 required that &%smtp_accept_max%& be non-zero.
16320
16321 &*Warning*&: When setting this option you should not use any expansion
16322 constructions that take an appreciable amount of time. The expansion and test
16323 happen in the main daemon loop, in order to reject additional connections
16324 without forking additional processes (otherwise a denial-of-service attack
16325 could cause a vast number or processes to be created). While the daemon is
16326 doing this processing, it cannot accept any other incoming connections.
16327
16328
16329
16330 .option smtp_accept_queue main integer 0
16331 .cindex "SMTP" "incoming connection count"
16332 .cindex "queueing incoming messages"
16333 .cindex "message" "queueing by SMTP connection count"
16334 If the number of simultaneous incoming SMTP connections being handled via the
16335 listening daemon exceeds this value, messages received by SMTP are just placed
16336 on the queue; no delivery processes are started automatically. The count is
16337 fixed at the start of an SMTP connection. It cannot be updated in the
16338 subprocess that receives messages, and so the queueing or not queueing applies
16339 to all messages received in the same connection.
16340
16341 A value of zero implies no limit, and clearly any non-zero value is useful only
16342 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16343 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16344 various &%-od%&&'x'& command line options.
16345
16346
16347 . See the comment on smtp_accept_max_per_connection
16348
16349 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16350          smtp_accept_queue_per_connection
16351 .cindex "queueing incoming messages"
16352 .cindex "message" "queueing by message count"
16353 This option limits the number of delivery processes that Exim starts
16354 automatically when receiving messages via SMTP, whether via the daemon or by
16355 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16356 and the number of messages received in a single SMTP session exceeds this
16357 number, subsequent messages are placed on the queue, but no delivery processes
16358 are started. This helps to limit the number of Exim processes when a server
16359 restarts after downtime and there is a lot of mail waiting for it on other
16360 systems. On large systems, the default should probably be increased, and on
16361 dial-in client systems it should probably be set to zero (that is, disabled).
16362
16363
16364 .option smtp_accept_reserve main integer 0
16365 .cindex "SMTP" "incoming call count"
16366 .cindex "host" "reserved"
16367 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16368 number of SMTP connections that are reserved for connections from the hosts
16369 that are specified in &%smtp_reserve_hosts%&. The value set in
16370 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16371 restricted to this number of connections; the option specifies a minimum number
16372 of connection slots for them, not a maximum. It is a guarantee that this group
16373 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16374 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16375 individual host.
16376
16377 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16378 set to 5, once there are 45 active connections (from any hosts), new
16379 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16380 provided the other criteria for acceptance are met.
16381
16382
16383 .option smtp_active_hostname main string&!! unset
16384 .cindex "host" "name in SMTP responses"
16385 .cindex "SMTP" "host name in responses"
16386 .vindex "&$primary_hostname$&"
16387 This option is provided for multi-homed servers that want to masquerade as
16388 several different hosts. At the start of an incoming SMTP connection, its value
16389 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16390 responses. For example, it is used as domain name in the response to an
16391 incoming HELO or EHLO command.
16392
16393 .vindex "&$smtp_active_hostname$&"
16394 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16395 is saved with any messages that are received. It is therefore available for use
16396 in routers and transports when the message is later delivered.
16397
16398 If this option is unset, or if its expansion is forced to fail, or if the
16399 expansion results in an empty string, the value of &$primary_hostname$& is
16400 used. Other expansion failures cause a message to be written to the main and
16401 panic logs, and the SMTP command receives a temporary error. Typically, the
16402 value of &%smtp_active_hostname%& depends on the incoming interface address.
16403 For example:
16404 .code
16405 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16406   {cox.mydomain}{box.mydomain}}
16407 .endd
16408
16409 Although &$smtp_active_hostname$& is primarily concerned with incoming
16410 messages, it is also used as the default for HELO commands in callout
16411 verification if there is no remote transport from which to obtain a
16412 &%helo_data%& value.
16413
16414 .option smtp_banner main string&!! "see below"
16415 .cindex "SMTP" "welcome banner"
16416 .cindex "banner for SMTP"
16417 .cindex "welcome banner for SMTP"
16418 .cindex "customizing" "SMTP banner"
16419 This string, which is expanded every time it is used, is output as the initial
16420 positive response to an SMTP connection. The default setting is:
16421 .code
16422 smtp_banner = $smtp_active_hostname ESMTP Exim \
16423   $version_number $tod_full
16424 .endd
16425 Failure to expand the string causes a panic error. If you want to create a
16426 multiline response to the initial SMTP connection, use &"\n"& in the string at
16427 appropriate points, but not at the end. Note that the 220 code is not included
16428 in this string. Exim adds it automatically (several times in the case of a
16429 multiline response).
16430
16431
16432 .option smtp_check_spool_space main boolean true
16433 .cindex "checking disk space"
16434 .cindex "disk space, checking"
16435 .cindex "spool directory" "checking space"
16436 When this option is set, if an incoming SMTP session encounters the SIZE
16437 option on a MAIL command, it checks that there is enough space in the
16438 spool directory's partition to accept a message of that size, while still
16439 leaving free the amount specified by &%check_spool_space%& (even if that value
16440 is zero). If there isn't enough space, a temporary error code is returned.
16441
16442
16443 .option smtp_connect_backlog main integer 20
16444 .cindex "connection backlog"
16445 .cindex "SMTP" "connection backlog"
16446 .cindex "backlog of connections"
16447 This option specifies a maximum number of waiting SMTP connections. Exim passes
16448 this value to the TCP/IP system when it sets up its listener. Once this number
16449 of connections are waiting for the daemon's attention, subsequent connection
16450 attempts are refused at the TCP/IP level. At least, that is what the manuals
16451 say; in some circumstances such connection attempts have been observed to time
16452 out instead. For large systems it is probably a good idea to increase the
16453 value (to 50, say). It also gives some protection against denial-of-service
16454 attacks by SYN flooding.
16455
16456
16457 .option smtp_enforce_sync main boolean true
16458 .cindex "SMTP" "synchronization checking"
16459 .cindex "synchronization checking in SMTP"
16460 The SMTP protocol specification requires the client to wait for a response from
16461 the server at certain points in the dialogue. Without PIPELINING these
16462 synchronization points are after every command; with PIPELINING they are
16463 fewer, but they still exist.
16464
16465 Some spamming sites send out a complete set of SMTP commands without waiting
16466 for any response. Exim protects against this by rejecting a message if the
16467 client has sent further input when it should not have. The error response &"554
16468 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16469 for this error cannot be perfect because of transmission delays (unexpected
16470 input may be on its way but not yet received when Exim checks). However, it
16471 does detect many instances.
16472
16473 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16474 If you want to disable the check selectively (for example, only for certain
16475 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16476 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16477
16478
16479
16480 .option smtp_etrn_command main string&!! unset
16481 .cindex "ETRN" "command to be run"
16482 .vindex "&$domain$&"
16483 If this option is set, the given command is run whenever an SMTP ETRN
16484 command is received from a host that is permitted to issue such commands (see
16485 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16486 are independently expanded. The expansion variable &$domain$& is set to the
16487 argument of the ETRN command, and no syntax checking is done on it. For
16488 example:
16489 .code
16490 smtp_etrn_command = /etc/etrn_command $domain \
16491                     $sender_host_address
16492 .endd
16493 A new process is created to run the command, but Exim does not wait for it to
16494 complete. Consequently, its status cannot be checked. If the command cannot be
16495 run, a line is written to the panic log, but the ETRN caller still receives
16496 a 250 success response. Exim is normally running under its own uid when
16497 receiving SMTP, so it is not possible for it to change the uid before running
16498 the command.
16499
16500
16501 .option smtp_etrn_serialize main boolean true
16502 .cindex "ETRN" "serializing"
16503 When this option is set, it prevents the simultaneous execution of more than
16504 one identical command as a result of ETRN in an SMTP connection. See
16505 section &<<SECTETRN>>& for details.
16506
16507
16508 .option smtp_load_reserve main fixed-point unset
16509 .cindex "load average"
16510 If the system load average ever gets higher than this, incoming SMTP calls are
16511 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16512 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16513 the load is over the limit. The option has no effect on ancient operating
16514 systems on which Exim cannot determine the load average. See also
16515 &%deliver_queue_load_max%& and &%queue_only_load%&.
16516
16517
16518
16519 .option smtp_max_synprot_errors main integer 3
16520 .cindex "SMTP" "limiting syntax and protocol errors"
16521 .cindex "limit" "SMTP syntax and protocol errors"
16522 Exim rejects SMTP commands that contain syntax or protocol errors. In
16523 particular, a syntactically invalid email address, as in this command:
16524 .code
16525 RCPT TO:<abc xyz@a.b.c>
16526 .endd
16527 causes immediate rejection of the command, before any other tests are done.
16528 (The ACL cannot be run if there is no valid address to set up for it.) An
16529 example of a protocol error is receiving RCPT before MAIL. If there are
16530 too many syntax or protocol errors in one SMTP session, the connection is
16531 dropped. The limit is set by this option.
16532
16533 .cindex "PIPELINING" "expected errors"
16534 When the PIPELINING extension to SMTP is in use, some protocol errors are
16535 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16536 Exim assumes that PIPELINING will be used if it advertises it (see
16537 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16538 not count towards the limit.
16539
16540
16541
16542 .option smtp_max_unknown_commands main integer 3
16543 .cindex "SMTP" "limiting unknown commands"
16544 .cindex "limit" "unknown SMTP commands"
16545 If there are too many unrecognized commands in an incoming SMTP session, an
16546 Exim server drops the connection. This is a defence against some kinds of abuse
16547 that subvert web
16548 clients
16549 into making connections to SMTP ports; in these circumstances, a number of
16550 non-SMTP command lines are sent first.
16551
16552
16553
16554 .option smtp_ratelimit_hosts main "host list&!!" unset
16555 .cindex "SMTP" "rate limiting"
16556 .cindex "limit" "rate of message arrival"
16557 .cindex "RCPT" "rate limiting"
16558 Some sites find it helpful to be able to limit the rate at which certain hosts
16559 can send them messages, and the rate at which an individual message can specify
16560 recipients.
16561
16562 Exim has two rate-limiting facilities. This section describes the older
16563 facility, which can limit rates within a single connection. The newer
16564 &%ratelimit%& ACL condition can limit rates across all connections. See section
16565 &<<SECTratelimiting>>& for details of the newer facility.
16566
16567 When a host matches &%smtp_ratelimit_hosts%&, the values of
16568 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16569 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16570 respectively. Each option, if set, must contain a set of four comma-separated
16571 values:
16572
16573 .ilist
16574 A threshold, before which there is no rate limiting.
16575 .next
16576 An initial time delay. Unlike other times in Exim, numbers with decimal
16577 fractional parts are allowed here.
16578 .next
16579 A factor by which to increase the delay each time.
16580 .next
16581 A maximum value for the delay. This should normally be less than 5 minutes,
16582 because after that time, the client is liable to timeout the SMTP command.
16583 .endlist
16584
16585 For example, these settings have been used successfully at the site which
16586 first suggested this feature, for controlling mail from their customers:
16587 .code
16588 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16589 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16590 .endd
16591 The first setting specifies delays that are applied to MAIL commands after
16592 two have been received over a single connection. The initial delay is 0.5
16593 seconds, increasing by a factor of 1.05 each time. The second setting applies
16594 delays to RCPT commands when more than four occur in a single message.
16595
16596
16597 .option smtp_ratelimit_mail main string unset
16598 See &%smtp_ratelimit_hosts%& above.
16599
16600
16601 .option smtp_ratelimit_rcpt main string unset
16602 See &%smtp_ratelimit_hosts%& above.
16603
16604
16605 .option smtp_receive_timeout main time&!! 5m
16606 .cindex "timeout" "for SMTP input"
16607 .cindex "SMTP" "input timeout"
16608 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16609 input, including batch SMTP. If a line of input (either an SMTP command or a
16610 data line) is not received within this time, the SMTP connection is dropped and
16611 the message is abandoned.
16612 A line is written to the log containing one of the following messages:
16613 .code
16614 SMTP command timeout on connection from...
16615 SMTP data timeout on connection from...
16616 .endd
16617 The former means that Exim was expecting to read an SMTP command; the latter
16618 means that it was in the DATA phase, reading the contents of a message.
16619
16620 If the first character of the option is a &"$"& the option is
16621 expanded before use and may depend on
16622 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16623
16624
16625 .oindex "&%-os%&"
16626 The value set by this option can be overridden by the
16627 &%-os%& command-line option. A setting of zero time disables the timeout, but
16628 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16629 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16630 timeout is controlled by &%receive_timeout%& and &%-or%&.
16631
16632
16633 .option smtp_reserve_hosts main "host list&!!" unset
16634 This option defines hosts for which SMTP connections are reserved; see
16635 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16636
16637
16638 .option smtp_return_error_details main boolean false
16639 .cindex "SMTP" "details policy failures"
16640 .cindex "policy control" "rejection, returning details"
16641 In the default state, Exim uses bland messages such as
16642 &"Administrative prohibition"& when it rejects SMTP commands for policy
16643 reasons. Many sysadmins like this because it gives away little information
16644 to spammers. However, some other sysadmins who are applying strict checking
16645 policies want to give out much fuller information about failures. Setting
16646 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16647 example, instead of &"Administrative prohibition"&, it might give:
16648 .code
16649 550-Rejected after DATA: '>' missing at end of address:
16650 550 failing address in "From" header is: <user@dom.ain
16651 .endd
16652
16653
16654 .option smtputf8_advertise_hosts main "host list&!!" *
16655 .cindex "SMTPUTF8" "advertising"
16656 When Exim is built with support for internationalised mail names,
16657 the availability therof is advertised in
16658 response to EHLO only to those client hosts that match this option. See
16659 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16660
16661
16662 .option spamd_address main string "see below"
16663 This option is available when Exim is compiled with the content-scanning
16664 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16665 The default value is
16666 .code
16667 127.0.0.1 783
16668 .endd
16669 See section &<<SECTscanspamass>>& for more details.
16670
16671
16672
16673 .option split_spool_directory main boolean false
16674 .cindex "multiple spool directories"
16675 .cindex "spool directory" "split"
16676 .cindex "directories, multiple"
16677 If this option is set, it causes Exim to split its input directory into 62
16678 subdirectories, each with a single alphanumeric character as its name. The
16679 sixth character of the message id is used to allocate messages to
16680 subdirectories; this is the least significant base-62 digit of the time of
16681 arrival of the message.
16682
16683 Splitting up the spool in this way may provide better performance on systems
16684 where there are long mail queues, by reducing the number of files in any one
16685 directory. The msglog directory is also split up in a similar way to the input
16686 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16687 are still placed in the single directory &_msglog.OLD_&.
16688
16689 It is not necessary to take any special action for existing messages when
16690 changing &%split_spool_directory%&. Exim notices messages that are in the
16691 &"wrong"& place, and continues to process them. If the option is turned off
16692 after a period of being on, the subdirectories will eventually empty and be
16693 automatically deleted.
16694
16695 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16696 changes. Instead of creating a list of all messages in the queue, and then
16697 trying to deliver each one in turn, it constructs a list of those in one
16698 sub-directory and tries to deliver them, before moving on to the next
16699 sub-directory. The sub-directories are processed in a random order. This
16700 spreads out the scanning of the input directories, and uses less memory. It is
16701 particularly beneficial when there are lots of messages on the queue. However,
16702 if &%queue_run_in_order%& is set, none of this new processing happens. The
16703 entire queue has to be scanned and sorted before any deliveries can start.
16704
16705
16706 .option spool_directory main string&!! "set at compile time"
16707 .cindex "spool directory" "path to"
16708 This defines the directory in which Exim keeps its spool, that is, the messages
16709 it is waiting to deliver. The default value is taken from the compile-time
16710 configuration setting, if there is one. If not, this option must be set. The
16711 string is expanded, so it can contain, for example, a reference to
16712 &$primary_hostname$&.
16713
16714 If the spool directory name is fixed on your installation, it is recommended
16715 that you set it at build time rather than from this option, particularly if the
16716 log files are being written to the spool directory (see &%log_file_path%&).
16717 Otherwise log files cannot be used for errors that are detected early on, such
16718 as failures in the configuration file.
16719
16720 By using this option to override the compiled-in path, it is possible to run
16721 tests of Exim without using the standard spool.
16722
16723 .option sqlite_lock_timeout main time 5s
16724 .cindex "sqlite lookup type" "lock timeout"
16725 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16726 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16727
16728 .option strict_acl_vars main boolean false
16729 .cindex "&ACL;" "variables, handling unset"
16730 This option controls what happens if a syntactically valid but undefined ACL
16731 variable is referenced. If it is false (the default), an empty string
16732 is substituted; if it is true, an error is generated. See section
16733 &<<SECTaclvariables>>& for details of ACL variables.
16734
16735 .option strip_excess_angle_brackets main boolean false
16736 .cindex "angle brackets, excess"
16737 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16738 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16739 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16740 passed on to another MTA, the excess angle brackets are not passed on. If this
16741 option is not set, multiple pairs of angle brackets cause a syntax error.
16742
16743
16744 .option strip_trailing_dot main boolean false
16745 .cindex "trailing dot on domain"
16746 .cindex "dot" "trailing on domain"
16747 If this option is set, a trailing dot at the end of a domain in an address is
16748 ignored. If this is in the envelope and the message is passed on to another
16749 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16750 domain causes a syntax error.
16751 However, addresses in header lines are checked only when an ACL requests header
16752 syntax checking.
16753
16754
16755 .option syslog_duplication main boolean true
16756 .cindex "syslog" "duplicate log lines; suppressing"
16757 When Exim is logging to syslog, it writes the log lines for its three
16758 separate logs at different syslog priorities so that they can in principle
16759 be separated on the logging hosts. Some installations do not require this
16760 separation, and in those cases, the duplication of certain log lines is a
16761 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16762 particular log line is written to syslog. For lines that normally go to
16763 both the main log and the reject log, the reject log version (possibly
16764 containing message header lines) is written, at LOG_NOTICE priority.
16765 Lines that normally go to both the main and the panic log are written at
16766 the LOG_ALERT priority.
16767
16768
16769 .option syslog_facility main string unset
16770 .cindex "syslog" "facility; setting"
16771 This option sets the syslog &"facility"& name, used when Exim is logging to
16772 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16773 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16774 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16775 details of Exim's logging.
16776
16777
16778
16779 .option syslog_processname main string &`exim`&
16780 .cindex "syslog" "process name; setting"
16781 This option sets the syslog &"ident"& name, used when Exim is logging to
16782 syslog. The value must be no longer than 32 characters. See chapter
16783 &<<CHAPlog>>& for details of Exim's logging.
16784
16785
16786
16787 .option syslog_timestamp main boolean true
16788 .cindex "syslog" "timestamps"
16789 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16790 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16791 details of Exim's logging.
16792
16793
16794 .option system_filter main string&!! unset
16795 .cindex "filter" "system filter"
16796 .cindex "system filter" "specifying"
16797 .cindex "Sieve filter" "not available for system filter"
16798 This option specifies an Exim filter file that is applied to all messages at
16799 the start of each delivery attempt, before any routing is done. System filters
16800 must be Exim filters; they cannot be Sieve filters. If the system filter
16801 generates any deliveries to files or pipes, or any new mail messages, the
16802 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16803 which transports are to be used. Details of this facility are given in chapter
16804 &<<CHAPsystemfilter>>&.
16805
16806
16807 .option system_filter_directory_transport main string&!! unset
16808 .vindex "&$address_file$&"
16809 This sets the name of the transport driver that is to be used when the
16810 &%save%& command in a system message filter specifies a path ending in &"/"&,
16811 implying delivery of each message into a separate file in some directory.
16812 During the delivery, the variable &$address_file$& contains the path name.
16813
16814
16815 .option system_filter_file_transport main string&!! unset
16816 .cindex "file" "transport for system filter"
16817 This sets the name of the transport driver that is to be used when the &%save%&
16818 command in a system message filter specifies a path not ending in &"/"&. During
16819 the delivery, the variable &$address_file$& contains the path name.
16820
16821 .option system_filter_group main string unset
16822 .cindex "gid (group id)" "system filter"
16823 This option is used only when &%system_filter_user%& is also set. It sets the
16824 gid under which the system filter is run, overriding any gid that is associated
16825 with the user. The value may be numerical or symbolic.
16826
16827 .option system_filter_pipe_transport main string&!! unset
16828 .cindex "&(pipe)& transport" "for system filter"
16829 .vindex "&$address_pipe$&"
16830 This specifies the transport driver that is to be used when a &%pipe%& command
16831 is used in a system filter. During the delivery, the variable &$address_pipe$&
16832 contains the pipe command.
16833
16834
16835 .option system_filter_reply_transport main string&!! unset
16836 .cindex "&(autoreply)& transport" "for system filter"
16837 This specifies the transport driver that is to be used when a &%mail%& command
16838 is used in a system filter.
16839
16840
16841 .option system_filter_user main string unset
16842 .cindex "uid (user id)" "system filter"
16843 If this option is set to root, the system filter is run in the main Exim
16844 delivery process, as root.  Otherwise, the system filter runs in a separate
16845 process, as the given user, defaulting to the Exim run-time user.
16846 Unless the string consists entirely of digits, it
16847 is looked up in the password data. Failure to find the named user causes a
16848 configuration error. The gid is either taken from the password data, or
16849 specified by &%system_filter_group%&. When the uid is specified numerically,
16850 &%system_filter_group%& is required to be set.
16851
16852 If the system filter generates any pipe, file, or reply deliveries, the uid
16853 under which the filter is run is used when transporting them, unless a
16854 transport option overrides.
16855
16856
16857 .option tcp_nodelay main boolean true
16858 .cindex "daemon" "TCP_NODELAY on sockets"
16859 .cindex "Nagle algorithm"
16860 .cindex "TCP_NODELAY on listening sockets"
16861 If this option is set false, it stops the Exim daemon setting the
16862 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16863 turns off the &"Nagle algorithm"&, which is a way of improving network
16864 performance in interactive (character-by-character) situations. Turning it off
16865 should improve Exim's performance a bit, so that is what happens by default.
16866 However, it appears that some broken clients cannot cope, and time out. Hence
16867 this option. It affects only those sockets that are set up for listening by the
16868 daemon. Sockets created by the smtp transport for delivering mail always set
16869 TCP_NODELAY.
16870
16871
16872 .option timeout_frozen_after main time 0s
16873 .cindex "frozen messages" "timing out"
16874 .cindex "timeout" "frozen messages"
16875 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16876 message of any kind that has been on the queue for longer than the given time
16877 is automatically cancelled at the next queue run. If the frozen message is a
16878 bounce message, it is just discarded; otherwise, a bounce is sent to the
16879 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16880 If you want to timeout frozen bounce messages earlier than other kinds of
16881 frozen message, see &%ignore_bounce_errors_after%&.
16882
16883 &*Note:*& the default value of zero means no timeouts; with this setting,
16884 frozen messages remain on the queue forever (except for any frozen bounce
16885 messages that are released by &%ignore_bounce_errors_after%&).
16886
16887
16888 .option timezone main string unset
16889 .cindex "timezone, setting"
16890 .cindex "environment" "values from"
16891 The value of &%timezone%& is used to set the environment variable TZ while
16892 running Exim (if it is different on entry). This ensures that all timestamps
16893 created by Exim are in the required timezone. If you want all your timestamps
16894 to be in UTC (aka GMT) you should set
16895 .code
16896 timezone = UTC
16897 .endd
16898 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16899 or, if that is not set, from the value of the TZ environment variable when Exim
16900 is built. If &%timezone%& is set to the empty string, either at build or run
16901 time, any existing TZ variable is removed from the environment when Exim
16902 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16903 unfortunately not all, operating systems.
16904
16905
16906 .option tls_advertise_hosts main "host list&!!" *
16907 .cindex "TLS" "advertising"
16908 .cindex "encryption" "on SMTP connection"
16909 .cindex "SMTP" "encrypted connection"
16910 When Exim is built with support for TLS encrypted connections, the availability
16911 of the STARTTLS command to set up an encrypted session is advertised in
16912 response to EHLO only to those client hosts that match this option. See
16913 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16914 Note that the default value requires that a certificate be supplied
16915 using the &%tls_certificate%& option.  If TLS support for incoming connections
16916 is not required the &%tls_advertise_hosts%& option should be set empty.
16917
16918
16919 .option tls_certificate main string&!! unset
16920 .cindex "TLS" "server certificate; location of"
16921 .cindex "certificate" "server, location of"
16922 The value of this option is expanded, and must then be the absolute path to a
16923 file which contains the server's certificates. The server's private key is also
16924 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16925 &<<CHAPTLS>>& for further details.
16926
16927 &*Note*&: The certificates defined by this option are used only when Exim is
16928 receiving incoming messages as a server. If you want to supply certificates for
16929 use when sending messages as a client, you must set the &%tls_certificate%&
16930 option in the relevant &(smtp)& transport.
16931
16932 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16933 if the OpenSSL build supports TLS extensions and the TLS client sends the
16934 Server Name Indication extension, then this option and others documented in
16935 &<<SECTtlssni>>& will be re-expanded.
16936
16937 .new
16938 If this option is unset or empty a fresh self-signed certificate will be
16939 generated for every connection.
16940 .wen
16941
16942 .option tls_crl main string&!! unset
16943 .cindex "TLS" "server certificate revocation list"
16944 .cindex "certificate" "revocation list for server"
16945 This option specifies a certificate revocation list. The expanded value must
16946 be the name of a file that contains a CRL in PEM format.
16947
16948 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16949
16950
16951 .option tls_dh_max_bits main integer 2236
16952 .cindex "TLS" "D-H bit count"
16953 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16954 the chosen TLS library.  That value might prove to be too high for
16955 interoperability.  This option provides a maximum clamp on the value
16956 suggested, trading off security for interoperability.
16957
16958 The value must be at least 1024.
16959
16960 The value 2236 was chosen because, at time of adding the option, it was the
16961 hard-coded maximum value supported by the NSS cryptographic library, as used
16962 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16963
16964 If you prefer more security and are willing to break some clients, raise this
16965 number.
16966
16967 Note that the value passed to GnuTLS for *generating* a new prime may be a
16968 little less than this figure, because GnuTLS is inexact and may produce a
16969 larger prime than requested.
16970
16971
16972 .option tls_dhparam main string&!! unset
16973 .cindex "TLS" "D-H parameters for server"
16974 The value of this option is expanded and indicates the source of DH parameters
16975 to be used by Exim.
16976
16977 If it is a filename starting with a &`/`&, then it names a file from which DH
16978 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16979 PKCS#3 representation of the DH prime.  If the file does not exist, for
16980 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16981 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16982 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16983 and treated as though the &%tls_dhparam%& were set to "none".
16984
16985 If this option expands to the string "none", then no DH parameters will be
16986 loaded by Exim.
16987
16988 If this option expands to the string "historic" and Exim is using GnuTLS, then
16989 Exim will attempt to load a file from inside the spool directory.  If the file
16990 does not exist, Exim will attempt to create it.
16991 See section &<<SECTgnutlsparam>>& for further details.
16992
16993 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16994 a default DH prime; the default is the 2048 bit prime described in section
16995 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16996 in IKE is assigned number 23.
16997
16998 Otherwise, the option must expand to the name used by Exim for any of a number
16999 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
17000 "ike" followed by the number used by IKE, or "default" which corresponds to
17001 "ike23".
17002
17003 The available primes are:
17004 &`ike1`&, &`ike2`&, &`ike5`&,
17005 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17006 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
17007
17008 Some of these will be too small to be accepted by clients.
17009 Some may be too large to be accepted by clients.
17010
17011 The TLS protocol does not negotiate an acceptable size for this; clients tend
17012 to hard-drop connections if what is offered by the server is unacceptable,
17013 whether too large or too small, and there's no provision for the client to
17014 tell the server what these constraints are.  Thus, as a server operator, you
17015 need to make an educated guess as to what is most likely to work for your
17016 userbase.
17017
17018 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17019 is most likely to maximise interoperability.  The upper bound comes from
17020 applications using the Mozilla Network Security Services (NSS) library, which
17021 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17022 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17023 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17024 acceptable bound from 1024 to 2048.
17025
17026
17027 .option tls_eccurve main string&!! prime256v1
17028 .cindex TLS "EC cryptography"
17029 If built with a recent-enough version of OpenSSL,
17030 this option selects a EC curve for use by Exim.
17031
17032 Curve names of the form &'prime256v1'& are accepted.
17033 For even more-recent library versions, names of the form &'P-512'&
17034 are also accepted, plus the special value &'auto'&
17035 which tells the library to choose.
17036
17037 If the option is set to an empty string, no EC curves will be enabled.
17038
17039
17040 .option tls_ocsp_file main string&!! unset
17041 .cindex TLS "certificate status"
17042 .cindex TLS "OCSP proof file"
17043 This option
17044 must if set expand to the absolute path to a file which contains a current
17045 status proof for the server's certificate, as obtained from the
17046 Certificate Authority.
17047
17048 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17049
17050
17051 .option tls_on_connect_ports main "string list" unset
17052 .cindex SSMTP
17053 .cindex SMTPS
17054 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17055 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17056 set up without waiting for the client to issue a STARTTLS command. For
17057 further details, see section &<<SECTsupobssmt>>&.
17058
17059
17060
17061 .option tls_privatekey main string&!! unset
17062 .cindex "TLS" "server private key; location of"
17063 The value of this option is expanded, and must then be the absolute path to a
17064 file which contains the server's private key. If this option is unset, or if
17065 the expansion is forced to fail, or the result is an empty string, the private
17066 key is assumed to be in the same file as the server's certificates. See chapter
17067 &<<CHAPTLS>>& for further details.
17068
17069 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17070
17071
17072 .option tls_remember_esmtp main boolean false
17073 .cindex "TLS" "esmtp state; remembering"
17074 .cindex "TLS" "broken clients"
17075 If this option is set true, Exim violates the RFCs by remembering that it is in
17076 &"esmtp"& state after successfully negotiating a TLS session. This provides
17077 support for broken clients that fail to send a new EHLO after starting a
17078 TLS session.
17079
17080
17081 .option tls_require_ciphers main string&!! unset
17082 .cindex "TLS" "requiring specific ciphers"
17083 .cindex "cipher" "requiring specific"
17084 This option controls which ciphers can be used for incoming TLS connections.
17085 The &(smtp)& transport has an option of the same name for controlling outgoing
17086 connections. This option is expanded for each connection, so can be varied for
17087 different clients if required. The value of this option must be a list of
17088 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17089 in somewhat different ways. If GnuTLS is being used, the client controls the
17090 preference order of the available ciphers. Details are given in sections
17091 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17092
17093
17094 .option tls_try_verify_hosts main "host list&!!" unset
17095 .cindex "TLS" "client certificate verification"
17096 .cindex "certificate" "verification of client"
17097 See &%tls_verify_hosts%& below.
17098
17099
17100 .option tls_verify_certificates main string&!! system
17101 .cindex "TLS" "client certificate verification"
17102 .cindex "certificate" "verification of client"
17103 The value of this option is expanded, and must then be either the
17104 word "system"
17105 or the absolute path to
17106 a file or directory containing permitted certificates for clients that
17107 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17108
17109 The "system" value for the option will use a
17110 system default location compiled into the SSL library.
17111 This is not available for GnuTLS versions preceding 3.0.20,
17112 and will be taken as empty; an explicit location
17113 must be specified.
17114
17115 The use of a directory for the option value is not available for GnuTLS versions
17116 preceding 3.3.6 and a single file must be used.
17117
17118 With OpenSSL the certificates specified
17119 explicitly
17120 either by file or directory
17121 are added to those given by the system default location.
17122
17123 These certificates should be for the certificate authorities trusted, rather
17124 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17125 the value is a file then the certificates are sent by Exim as a server to
17126 connecting clients, defining the list of accepted certificate authorities.
17127 Thus the values defined should be considered public data.  To avoid this,
17128 use the explicit directory version.
17129
17130 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17131
17132 A forced expansion failure or setting to an empty string is equivalent to
17133 being unset.
17134
17135
17136 .option tls_verify_hosts main "host list&!!" unset
17137 .cindex "TLS" "client certificate verification"
17138 .cindex "certificate" "verification of client"
17139 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17140 certificates from clients. The expected certificates are defined by
17141 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17142 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17143 &%tls_verify_certificates%& is not set.
17144
17145 Any client that matches &%tls_verify_hosts%& is constrained by
17146 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17147 present one of the listed certificates. If it does not, the connection is
17148 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17149 the host to use TLS. It can still send SMTP commands through unencrypted
17150 connections. Forcing a client to use TLS has to be done separately using an
17151 ACL to reject inappropriate commands when the connection is not encrypted.
17152
17153 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17154 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17155 certificate and checks it against &%tls_verify_certificates%&, but does not
17156 abort the connection if there is no certificate or if it does not match. This
17157 state can be detected in an ACL, which makes it possible to implement policies
17158 such as &"accept for relay only if a verified certificate has been received,
17159 but accept for local delivery if encrypted, even without a verified
17160 certificate"&.
17161
17162 Client hosts that match neither of these lists are not asked to present
17163 certificates.
17164
17165
17166 .option trusted_groups main "string list&!!" unset
17167 .cindex "trusted groups"
17168 .cindex "groups" "trusted"
17169 This option is expanded just once, at the start of Exim's processing. If this
17170 option is set, any process that is running in one of the listed groups, or
17171 which has one of them as a supplementary group, is trusted. The groups can be
17172 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17173 details of what trusted callers are permitted to do. If neither
17174 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17175 are trusted.
17176
17177 .option trusted_users main "string list&!!" unset
17178 .cindex "trusted users"
17179 .cindex "user" "trusted"
17180 This option is expanded just once, at the start of Exim's processing. If this
17181 option is set, any process that is running as one of the listed users is
17182 trusted. The users can be specified numerically or by name. See section
17183 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17184 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17185 Exim user are trusted.
17186
17187 .option unknown_login main string&!! unset
17188 .cindex "uid (user id)" "unknown caller"
17189 .vindex "&$caller_uid$&"
17190 This is a specialized feature for use in unusual configurations. By default, if
17191 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17192 gives up. The &%unknown_login%& option can be used to set a login name to be
17193 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17194 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17195 is used for the user's real name (gecos field), unless this has been set by the
17196 &%-F%& option.
17197
17198 .option unknown_username main string unset
17199 See &%unknown_login%&.
17200
17201 .option untrusted_set_sender main "address list&!!" unset
17202 .cindex "trusted users"
17203 .cindex "sender" "setting by untrusted user"
17204 .cindex "untrusted user setting sender"
17205 .cindex "user" "untrusted setting sender"
17206 .cindex "envelope sender"
17207 When an untrusted user submits a message to Exim using the standard input, Exim
17208 normally creates an envelope sender address from the user's login and the
17209 default qualification domain. Data from the &%-f%& option (for setting envelope
17210 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17211 is used) is ignored.
17212
17213 However, untrusted users are permitted to set an empty envelope sender address,
17214 to declare that a message should never generate any bounces. For example:
17215 .code
17216 exim -f '<>' user@domain.example
17217 .endd
17218 .vindex "&$sender_ident$&"
17219 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17220 other envelope sender addresses in a controlled way. When it is set, untrusted
17221 users are allowed to set envelope sender addresses that match any of the
17222 patterns in the list. Like all address lists, the string is expanded. The
17223 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17224 users to setting senders that start with their login ids
17225 followed by a hyphen
17226 by a setting like this:
17227 .code
17228 untrusted_set_sender = ^$sender_ident-
17229 .endd
17230 If you want to allow untrusted users to set envelope sender addresses without
17231 restriction, you can use
17232 .code
17233 untrusted_set_sender = *
17234 .endd
17235 The &%untrusted_set_sender%& option applies to all forms of local input, but
17236 only to the setting of the envelope sender. It does not permit untrusted users
17237 to use the other options which trusted user can use to override message
17238 parameters. Furthermore, it does not stop Exim from removing an existing
17239 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17240 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17241 overriding these actions. The handling of the &'Sender:'& header is also
17242 described in section &<<SECTthesenhea>>&.
17243
17244 The log line for a message's arrival shows the envelope sender following
17245 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17246 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17247 envelope sender address, the user's login is shown in parentheses after the
17248 sender address.
17249
17250
17251 .option uucp_from_pattern main string "see below"
17252 .cindex "&""From""& line"
17253 .cindex "UUCP" "&""From""& line"
17254 Some applications that pass messages to an MTA via a command line interface use
17255 an initial line starting with &"From&~"& to pass the envelope sender. In
17256 particular, this is used by UUCP software. Exim recognizes such a line by means
17257 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17258 matches, the sender address is constructed by expanding the contents of
17259 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17260 default pattern recognizes lines in the following two forms:
17261 .code
17262 From ph10 Fri Jan  5 12:35 GMT 1996
17263 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17264 .endd
17265 The pattern can be seen by running
17266 .code
17267 exim -bP uucp_from_pattern
17268 .endd
17269 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17270 year in the second case. The first word after &"From&~"& is matched in the
17271 regular expression by a parenthesized subpattern. The default value for
17272 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17273 (&"ph10"& in the example above) as the message's sender. See also
17274 &%ignore_fromline_hosts%&.
17275
17276
17277 .option uucp_from_sender main string&!! &`$1`&
17278 See &%uucp_from_pattern%& above.
17279
17280
17281 .option warn_message_file main string unset
17282 .cindex "warning of delay" "customizing the message"
17283 .cindex "customizing" "warning message"
17284 This option defines a template file containing paragraphs of text to be used
17285 for constructing the warning message which is sent by Exim when a message has
17286 been on the queue for a specified amount of time, as specified by
17287 &%delay_warning%&. Details of the file's contents are given in chapter
17288 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17289
17290
17291 .option write_rejectlog main boolean true
17292 .cindex "reject log" "disabling"
17293 If this option is set false, Exim no longer writes anything to the reject log.
17294 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17295 .ecindex IIDconfima
17296 .ecindex IIDmaiconf
17297
17298
17299
17300
17301 . ////////////////////////////////////////////////////////////////////////////
17302 . ////////////////////////////////////////////////////////////////////////////
17303
17304 .chapter "Generic options for routers" "CHAProutergeneric"
17305 .scindex IIDgenoprou1 "options" "generic; for routers"
17306 .scindex IIDgenoprou2 "generic options" "router"
17307 This chapter describes the generic options that apply to all routers.
17308 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17309
17310 For a general description of how a router operates, see sections
17311 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17312 which the preconditions are tested. The order of expansion of the options that
17313 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17314 &%headers_remove%&, &%transport%&.
17315
17316
17317
17318 .option address_data routers string&!! unset
17319 .cindex "router" "data attached to address"
17320 The string is expanded just before the router is run, that is, after all the
17321 precondition tests have succeeded. If the expansion is forced to fail, the
17322 router declines, the value of &%address_data%& remains unchanged, and the
17323 &%more%& option controls what happens next. Other expansion failures cause
17324 delivery of the address to be deferred.
17325
17326 .vindex "&$address_data$&"
17327 When the expansion succeeds, the value is retained with the address, and can be
17328 accessed using the variable &$address_data$& in the current router, subsequent
17329 routers, and the eventual transport.
17330
17331 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17332 that runs a user's filter file, the contents of &$address_data$& are accessible
17333 in the filter. This is not normally a problem, because such data is usually
17334 either not confidential or it &"belongs"& to the current user, but if you do
17335 put confidential data into &$address_data$& you need to remember this point.
17336
17337 Even if the router declines or passes, the value of &$address_data$& remains
17338 with the address, though it can be changed by another &%address_data%& setting
17339 on a subsequent router. If a router generates child addresses, the value of
17340 &$address_data$& propagates to them. This also applies to the special kind of
17341 &"child"& that is generated by a router with the &%unseen%& option.
17342
17343 The idea of &%address_data%& is that you can use it to look up a lot of data
17344 for the address once, and then pick out parts of the data later. For example,
17345 you could use a single LDAP lookup to return a string of the form
17346 .code
17347 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17348 .endd
17349 In the transport you could pick out the mailbox by a setting such as
17350 .code
17351 file = ${extract{mailbox}{$address_data}}
17352 .endd
17353 This makes the configuration file less messy, and also reduces the number of
17354 lookups (though Exim does cache lookups).
17355
17356 .vindex "&$sender_address_data$&"
17357 .vindex "&$address_data$&"
17358 The &%address_data%& facility is also useful as a means of passing information
17359 from one router to another, and from a router to a transport. In addition, if
17360 &$address_data$& is set by a router when verifying a recipient address from an
17361 ACL, it remains available for use in the rest of the ACL statement. After
17362 verifying a sender, the value is transferred to &$sender_address_data$&.
17363
17364
17365
17366 .option address_test routers&!? boolean true
17367 .oindex "&%-bt%&"
17368 .cindex "router" "skipping when address testing"
17369 If this option is set false, the router is skipped when routing is being tested
17370 by means of the &%-bt%& command line option. This can be a convenience when
17371 your first router sends messages to an external scanner, because it saves you
17372 having to set the &"already scanned"& indicator when testing real address
17373 routing.
17374
17375
17376
17377 .option cannot_route_message routers string&!! unset
17378 .cindex "router" "customizing &""cannot route""& message"
17379 .cindex "customizing" "&""cannot route""& message"
17380 This option specifies a text message that is used when an address cannot be
17381 routed because Exim has run out of routers. The default message is
17382 &"Unrouteable address"&. This option is useful only on routers that have
17383 &%more%& set false, or on the very last router in a configuration, because the
17384 value that is used is taken from the last router that is considered. This
17385 includes a router that is skipped because its preconditions are not met, as
17386 well as a router that declines. For example, using the default configuration,
17387 you could put:
17388 .code
17389 cannot_route_message = Remote domain not found in DNS
17390 .endd
17391 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17392 and
17393 .code
17394 cannot_route_message = Unknown local user
17395 .endd
17396 on the final router that checks for local users. If string expansion fails for
17397 this option, the default message is used. Unless the expansion failure was
17398 explicitly forced, a message about the failure is written to the main and panic
17399 logs, in addition to the normal message about the routing failure.
17400
17401
17402 .option caseful_local_part routers boolean false
17403 .cindex "case of local parts"
17404 .cindex "router" "case of local parts"
17405 By default, routers handle the local parts of addresses in a case-insensitive
17406 manner, though the actual case is preserved for transmission with the message.
17407 If you want the case of letters to be significant in a router, you must set
17408 this option true. For individual router options that contain address or local
17409 part lists (for example, &%local_parts%&), case-sensitive matching can be
17410 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17411 more details.
17412
17413 .vindex "&$local_part$&"
17414 .vindex "&$original_local_part$&"
17415 .vindex "&$parent_local_part$&"
17416 The value of the &$local_part$& variable is forced to lower case while a
17417 router is running unless &%caseful_local_part%& is set. When a router assigns
17418 an address to a transport, the value of &$local_part$& when the transport runs
17419 is the same as it was in the router. Similarly, when a router generates child
17420 addresses by aliasing or forwarding, the values of &$original_local_part$&
17421 and &$parent_local_part$& are those that were used by the redirecting router.
17422
17423 This option applies to the processing of an address by a router. When a
17424 recipient address is being processed in an ACL, there is a separate &%control%&
17425 modifier that can be used to specify case-sensitive processing within the ACL
17426 (see section &<<SECTcontrols>>&).
17427
17428
17429
17430 .option check_local_user routers&!? boolean false
17431 .cindex "local user, checking in router"
17432 .cindex "router" "checking for local user"
17433 .cindex "&_/etc/passwd_&"
17434 .vindex "&$home$&"
17435 When this option is true, Exim checks that the local part of the recipient
17436 address (with affixes removed if relevant) is the name of an account on the
17437 local system. The check is done by calling the &[getpwnam()]& function rather
17438 than trying to read &_/etc/passwd_& directly. This means that other methods of
17439 holding password data (such as NIS) are supported. If the local part is a local
17440 user, &$home$& is set from the password data, and can be tested in other
17441 preconditions that are evaluated after this one (the order of evaluation is
17442 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17443 overridden by &%router_home_directory%&. If the local part is not a local user,
17444 the router is skipped.
17445
17446 If you want to check that the local part is either the name of a local user
17447 or matches something else, you cannot combine &%check_local_user%& with a
17448 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17449 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17450 setting to achieve this. For example:
17451 .code
17452 local_parts = passwd;$local_part : lsearch;/etc/other/users
17453 .endd
17454 Note, however, that the side effects of &%check_local_user%& (such as setting
17455 up a home directory) do not occur when a &(passwd)& lookup is used in a
17456 &%local_parts%& (or any other) precondition.
17457
17458
17459
17460 .option condition routers&!? string&!! unset
17461 .cindex "router" "customized precondition"
17462 This option specifies a general precondition test that has to succeed for the
17463 router to be called. The &%condition%& option is the last precondition to be
17464 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17465 result is a forced failure, or an empty string, or one of the strings &"0"& or
17466 &"no"& or &"false"& (checked without regard to the case of the letters), the
17467 router is skipped, and the address is offered to the next one.
17468
17469 If the result is any other value, the router is run (as this is the last
17470 precondition to be evaluated, all the other preconditions must be true).
17471
17472 This option is unusual in that multiple &%condition%& options may be present.
17473 All &%condition%& options must succeed.
17474
17475 The &%condition%& option provides a means of applying custom conditions to the
17476 running of routers. Note that in the case of a simple conditional expansion,
17477 the default expansion values are exactly what is wanted. For example:
17478 .code
17479 condition = ${if >{$message_age}{600}}
17480 .endd
17481 Because of the default behaviour of the string expansion, this is equivalent to
17482 .code
17483 condition = ${if >{$message_age}{600}{true}{}}
17484 .endd
17485
17486 A multiple condition example, which succeeds:
17487 .code
17488 condition = ${if >{$message_age}{600}}
17489 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17490 condition = foobar
17491 .endd
17492
17493 If the expansion fails (other than forced failure) delivery is deferred. Some
17494 of the other precondition options are common special cases that could in fact
17495 be specified using &%condition%&.
17496
17497 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17498 are far older, and use one set of semantics.  ACLs are newer and when
17499 they were created, the ACL &%condition%& process was given far stricter
17500 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17501 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17502 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17503 Router rules processing behavior.
17504
17505 This is best illustrated in an example:
17506 .code
17507 # If used in an ACL condition will fail with a syntax error, but
17508 # in a router condition any extra characters are treated as a string
17509
17510 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17511 true {yes} {no}}
17512
17513 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17514  {yes} {no}}
17515 .endd
17516 In each example above, the &%if%& statement actually ends after
17517 &"{google.com}}"&.  Since no true or false braces were defined, the
17518 default &%if%& behavior is to return a boolean true or a null answer
17519 (which evaluates to false). The rest of the line is then treated as a
17520 string. So the first example resulted in the boolean answer &"true"&
17521 with the string &" {yes} {no}}"& appended to it. The second example
17522 resulted in the null output (indicating false) with the string
17523 &" {yes} {no}}"& appended to it.
17524
17525 In fact you can put excess forward braces in too.  In the router
17526 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17527 mean something, like after a &"$"& or when required as part of a
17528 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17529 string characters.
17530
17531 Thus, in a Router, the above expansion strings will both always evaluate
17532 true, as the result of expansion is a non-empty string which doesn't
17533 match an explicit false value.  This can be tricky to debug.  By
17534 contrast, in an ACL either of those strings will always result in an
17535 expansion error because the result doesn't look sufficiently boolean.
17536
17537
17538 .option debug_print routers string&!! unset
17539 .cindex "testing" "variables in drivers"
17540 If this option is set and debugging is enabled (see the &%-d%& command line
17541 option) or in address-testing mode (see the &%-bt%& command line option),
17542 the string is expanded and included in the debugging output.
17543 If expansion of the string fails, the error message is written to the debugging
17544 output, and Exim carries on processing.
17545 This option is provided to help with checking out the values of variables and
17546 so on when debugging router configurations. For example, if a &%condition%&
17547 option appears not to be working, &%debug_print%& can be used to output the
17548 variables it references. The output happens after checks for &%domains%&,
17549 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17550 are tested. A newline is added to the text if it does not end with one.
17551 The variable &$router_name$& contains the name of the router.
17552
17553
17554
17555 .option disable_logging routers boolean false
17556 If this option is set true, nothing is logged for any routing errors
17557 or for any deliveries caused by this router. You should not set this option
17558 unless you really, really know what you are doing. See also the generic
17559 transport option of the same name.
17560
17561 .option dnssec_request_domains routers "domain list&!!" unset
17562 .cindex "MX record" "security"
17563 .cindex "DNSSEC" "MX lookup"
17564 .cindex "security" "MX lookup"
17565 .cindex "DNS" "DNSSEC"
17566 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17567 the dnssec request bit set.
17568 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17569
17570 .option dnssec_require_domains routers "domain list&!!" unset
17571 .cindex "MX record" "security"
17572 .cindex "DNSSEC" "MX lookup"
17573 .cindex "security" "MX lookup"
17574 .cindex "DNS" "DNSSEC"
17575 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17576 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17577 (AD bit) set will be ignored and logged as a host-lookup failure.
17578 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17579
17580
17581 .option domains routers&!? "domain list&!!" unset
17582 .cindex "router" "restricting to specific domains"
17583 .vindex "&$domain_data$&"
17584 If this option is set, the router is skipped unless the current domain matches
17585 the list. If the match is achieved by means of a file lookup, the data that the
17586 lookup returned for the domain is placed in &$domain_data$& for use in string
17587 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17588 a list of the order in which preconditions are evaluated.
17589
17590
17591
17592 .option driver routers string unset
17593 This option must always be set. It specifies which of the available routers is
17594 to be used.
17595
17596
17597 .option dsn_lasthop routers boolean false
17598 .cindex "DSN" "success"
17599 .cindex "Delivery Status Notification" "success"
17600 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17601 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17602 instead send a success DSN as if the next hop does not support DSN.
17603 Not effective on redirect routers.
17604
17605
17606
17607 .option errors_to routers string&!! unset
17608 .cindex "envelope sender"
17609 .cindex "router" "changing address for errors"
17610 If a router successfully handles an address, it may assign the address to a
17611 transport for delivery or it may generate child addresses. In both cases, if
17612 there is a delivery problem during later processing, the resulting bounce
17613 message is sent to the address that results from expanding this string,
17614 provided that the address verifies successfully. The &%errors_to%& option is
17615 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17616
17617 The &%errors_to%& setting associated with an address can be overridden if it
17618 subsequently passes through other routers that have their own &%errors_to%&
17619 settings, or if the message is delivered by a transport with a &%return_path%&
17620 setting.
17621
17622 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17623 the expansion fails to verify, the errors address associated with the incoming
17624 address is used. At top level, this is the envelope sender. A non-forced
17625 expansion failure causes delivery to be deferred.
17626
17627 If an address for which &%errors_to%& has been set ends up being delivered over
17628 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17629 any bounces that are generated by other MTAs on the delivery route are also
17630 sent there. You can set &%errors_to%& to the empty string by either of these
17631 settings:
17632 .code
17633 errors_to =
17634 errors_to = ""
17635 .endd
17636 An expansion item that yields an empty string has the same effect. If you do
17637 this, a locally detected delivery error for addresses processed by this router
17638 no longer gives rise to a bounce message; the error is discarded. If the
17639 address is delivered to a remote host, the return path is set to &`<>`&, unless
17640 overridden by the &%return_path%& option on the transport.
17641
17642 .vindex "&$address_data$&"
17643 If for some reason you want to discard local errors, but use a non-empty
17644 MAIL command for remote delivery, you can preserve the original return
17645 path in &$address_data$& in the router, and reinstate it in the transport by
17646 setting &%return_path%&.
17647
17648 The most common use of &%errors_to%& is to direct mailing list bounces to the
17649 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17650 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17651
17652
17653
17654 .option expn routers&!? boolean true
17655 .cindex "address" "testing"
17656 .cindex "testing" "addresses"
17657 .cindex "EXPN" "router skipping"
17658 .cindex "router" "skipping for EXPN"
17659 If this option is turned off, the router is skipped when testing an address
17660 as a result of processing an SMTP EXPN command. You might, for example,
17661 want to turn it off on a router for users' &_.forward_& files, while leaving it
17662 on for the system alias file.
17663 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17664 are evaluated.
17665
17666 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17667 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17668 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17669
17670
17671
17672 .option fail_verify routers boolean false
17673 .cindex "router" "forcing verification failure"
17674 Setting this option has the effect of setting both &%fail_verify_sender%& and
17675 &%fail_verify_recipient%& to the same value.
17676
17677
17678
17679 .option fail_verify_recipient routers boolean false
17680 If this option is true and an address is accepted by this router when
17681 verifying a recipient, verification fails.
17682
17683
17684
17685 .option fail_verify_sender routers boolean false
17686 If this option is true and an address is accepted by this router when
17687 verifying a sender, verification fails.
17688
17689
17690
17691 .option fallback_hosts routers "string list" unset
17692 .cindex "router" "fallback hosts"
17693 .cindex "fallback" "hosts specified on router"
17694 String expansion is not applied to this option. The argument must be a
17695 colon-separated list of host names or IP addresses. The list separator can be
17696 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17697 each name or address. In fact, the format of each item is exactly the same as
17698 defined for the list of hosts in a &(manualroute)& router (see section
17699 &<<SECTformatonehostitem>>&).
17700
17701 If a router queues an address for a remote transport, this host list is
17702 associated with the address, and used instead of the transport's fallback host
17703 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17704 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17705 transport for further details.
17706
17707
17708 .option group routers string&!! "see below"
17709 .cindex "gid (group id)" "local delivery"
17710 .cindex "local transports" "uid and gid"
17711 .cindex "transport" "local"
17712 .cindex "router" "setting group"
17713 When a router queues an address for a transport, and the transport does not
17714 specify a group, the group given here is used when running the delivery
17715 process.
17716 The group may be specified numerically or by name. If expansion fails, the
17717 error is logged and delivery is deferred.
17718 The default is unset, unless &%check_local_user%& is set, when the default
17719 is taken from the password information. See also &%initgroups%& and &%user%&
17720 and the discussion in chapter &<<CHAPenvironment>>&.
17721
17722
17723
17724 .option headers_add routers list&!! unset
17725 .cindex "header lines" "adding"
17726 .cindex "router" "adding header lines"
17727 This option specifies a list of text headers,
17728 newline-separated (by default, changeable in the usual way),
17729 that is associated with any addresses that are accepted by the router.
17730 Each item is separately expanded, at routing time.  However, this
17731 option has no effect when an address is just being verified. The way in which
17732 the text is used to add header lines at transport time is described in section
17733 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17734 message is in the process of being transported. This means that references to
17735 header lines in string expansions in the transport's configuration do not
17736 &"see"& the added header lines.
17737
17738 The &%headers_add%& option is expanded after &%errors_to%&, but before
17739 &%headers_remove%& and &%transport%&. If an item is empty, or if
17740 an item expansion is forced to fail, the item has no effect. Other expansion
17741 failures are treated as configuration errors.
17742
17743 Unlike most options, &%headers_add%& can be specified multiple times
17744 for a router; all listed headers are added.
17745
17746 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17747 router that has the &%one_time%& option set.
17748
17749 .cindex "duplicate addresses"
17750 .oindex "&%unseen%&"
17751 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17752 additions are deleted when the address is passed on to subsequent routers.
17753 For a &%redirect%& router, if a generated address is the same as the incoming
17754 address, this can lead to duplicate addresses with different header
17755 modifications. Exim does not do duplicate deliveries (except, in certain
17756 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17757 which of the duplicates is discarded, so this ambiguous situation should be
17758 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17759
17760
17761
17762 .option headers_remove routers list&!! unset
17763 .cindex "header lines" "removing"
17764 .cindex "router" "removing header lines"
17765 This option specifies a list of text headers,
17766 colon-separated (by default, changeable in the usual way),
17767 that is associated with any addresses that are accepted by the router.
17768 Each item is separately expanded, at routing time.  However, this
17769 option has no effect when an address is just being verified. The way in which
17770 the text is used to remove header lines at transport time is described in
17771 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17772 the message is in the process of being transported. This means that references
17773 to header lines in string expansions in the transport's configuration still
17774 &"see"& the original header lines.
17775
17776 The &%headers_remove%& option is expanded after &%errors_to%& and
17777 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17778 the item has no effect. Other expansion failures are treated as configuration
17779 errors.
17780
17781 Unlike most options, &%headers_remove%& can be specified multiple times
17782 for a router; all listed headers are removed.
17783
17784 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17785 router that has the &%one_time%& option set.
17786
17787 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17788 removal requests are deleted when the address is passed on to subsequent
17789 routers, and this can lead to problems with duplicates -- see the similar
17790 warning for &%headers_add%& above.
17791
17792 &*Warning 3*&: Because of the separate expansion of the list items,
17793 items that contain a list separator must have it doubled.
17794 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17795
17796
17797
17798 .option ignore_target_hosts routers "host list&!!" unset
17799 .cindex "IP address" "discarding"
17800 .cindex "router" "discarding IP addresses"
17801 Although this option is a host list, it should normally contain IP address
17802 entries rather than names. If any host that is looked up by the router has an
17803 IP address that matches an item in this list, Exim behaves as if that IP
17804 address did not exist. This option allows you to cope with rogue DNS entries
17805 like
17806 .code
17807 remote.domain.example.  A  127.0.0.1
17808 .endd
17809 by setting
17810 .code
17811 ignore_target_hosts = 127.0.0.1
17812 .endd
17813 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17814 discarded in this way, the router declines. In a conventional configuration, an
17815 attempt to mail to such a domain would normally provoke the &"unrouteable
17816 domain"& error, and an attempt to verify an address in the domain would fail.
17817 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17818 router declines if presented with one of the listed addresses.
17819
17820 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17821 means of the first or the second of the following settings, respectively:
17822 .code
17823 ignore_target_hosts = 0.0.0.0/0
17824 ignore_target_hosts = <; 0::0/0
17825 .endd
17826 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17827 in the second line matches all IPv6 addresses.
17828
17829 This option may also be useful for ignoring link-local and site-local IPv6
17830 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17831 is expanded before use as a list, it is possible to make it dependent on the
17832 domain that is being routed.
17833
17834 .vindex "&$host_address$&"
17835 During its expansion, &$host_address$& is set to the IP address that is being
17836 checked.
17837
17838 .option initgroups routers boolean false
17839 .cindex "additional groups"
17840 .cindex "groups" "additional"
17841 .cindex "local transports" "uid and gid"
17842 .cindex "transport" "local"
17843 If the router queues an address for a transport, and this option is true, and
17844 the uid supplied by the router is not overridden by the transport, the
17845 &[initgroups()]& function is called when running the transport to ensure that
17846 any additional groups associated with the uid are set up. See also &%group%&
17847 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17848
17849
17850
17851 .option local_part_prefix routers&!? "string list" unset
17852 .cindex "router" "prefix for local part"
17853 .cindex "prefix" "for local part, used in router"
17854 If this option is set, the router is skipped unless the local part starts with
17855 one of the given strings, or &%local_part_prefix_optional%& is true. See
17856 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17857 evaluated.
17858
17859 The list is scanned from left to right, and the first prefix that matches is
17860 used. A limited form of wildcard is available; if the prefix begins with an
17861 asterisk, it matches the longest possible sequence of arbitrary characters at
17862 the start of the local part. An asterisk should therefore always be followed by
17863 some character that does not occur in normal local parts.
17864 .cindex "multiple mailboxes"
17865 .cindex "mailbox" "multiple"
17866 Wildcarding can be used to set up multiple user mailboxes, as described in
17867 section &<<SECTmulbox>>&.
17868
17869 .vindex "&$local_part$&"
17870 .vindex "&$local_part_prefix$&"
17871 During the testing of the &%local_parts%& option, and while the router is
17872 running, the prefix is removed from the local part, and is available in the
17873 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17874 the router accepts the address, this remains true during subsequent delivery by
17875 a transport. In particular, the local part that is transmitted in the RCPT
17876 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17877 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17878 the relevant transport.
17879
17880 When an address is being verified, &%local_part_prefix%& affects only the
17881 behaviour of the router. If the callout feature of verification is in use, this
17882 means that the full address, including the prefix, will be used during the
17883 callout.
17884
17885 The prefix facility is commonly used to handle local parts of the form
17886 &%owner-something%&. Another common use is to support local parts of the form
17887 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17888 to tell a user their forwarding is broken &-- by placing a router like this one
17889 immediately before the router that handles &_.forward_& files:
17890 .code
17891 real_localuser:
17892   driver = accept
17893   local_part_prefix = real-
17894   check_local_user
17895   transport = local_delivery
17896 .endd
17897 For security, it would probably be a good idea to restrict the use of this
17898 router to locally-generated messages, using a condition such as this:
17899 .code
17900   condition = ${if match {$sender_host_address}\
17901                          {\N^(|127\.0\.0\.1)$\N}}
17902 .endd
17903
17904 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17905 both conditions must be met if not optional. Care must be taken if wildcards
17906 are used in both a prefix and a suffix on the same router. Different
17907 separator characters must be used to avoid ambiguity.
17908
17909
17910 .option local_part_prefix_optional routers boolean false
17911 See &%local_part_prefix%& above.
17912
17913
17914
17915 .option local_part_suffix routers&!? "string list" unset
17916 .cindex "router" "suffix for local part"
17917 .cindex "suffix for local part" "used in router"
17918 This option operates in the same way as &%local_part_prefix%&, except that the
17919 local part must end (rather than start) with the given string, the
17920 &%local_part_suffix_optional%& option determines whether the suffix is
17921 mandatory, and the wildcard * character, if present, must be the last
17922 character of the suffix. This option facility is commonly used to handle local
17923 parts of the form &%something-request%& and multiple user mailboxes of the form
17924 &%username-foo%&.
17925
17926
17927 .option local_part_suffix_optional routers boolean false
17928 See &%local_part_suffix%& above.
17929
17930
17931
17932 .option local_parts routers&!? "local part list&!!" unset
17933 .cindex "router" "restricting to specific local parts"
17934 .cindex "local part" "checking in router"
17935 The router is run only if the local part of the address matches the list.
17936 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17937 are evaluated, and
17938 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17939 string is expanded, it is possible to make it depend on the domain, for
17940 example:
17941 .code
17942 local_parts = dbm;/usr/local/specials/$domain
17943 .endd
17944 .vindex "&$local_part_data$&"
17945 If the match is achieved by a lookup, the data that the lookup returned
17946 for the local part is placed in the variable &$local_part_data$& for use in
17947 expansions of the router's private options. You might use this option, for
17948 example, if you have a large number of local virtual domains, and you want to
17949 send all postmaster mail to the same place without having to set up an alias in
17950 each virtual domain:
17951 .code
17952 postmaster:
17953   driver = redirect
17954   local_parts = postmaster
17955   data = postmaster@real.domain.example
17956 .endd
17957
17958
17959 .option log_as_local routers boolean "see below"
17960 .cindex "log" "delivery line"
17961 .cindex "delivery" "log line format"
17962 Exim has two logging styles for delivery, the idea being to make local
17963 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17964 recipient address is given just as the local part, without a domain. The use of
17965 this style is controlled by this option. It defaults to true for the &(accept)&
17966 router, and false for all the others. This option applies only when a
17967 router assigns an address to a transport. It has no effect on routers that
17968 redirect addresses.
17969
17970
17971
17972 .option more routers boolean&!! true
17973 The result of string expansion for this option must be a valid boolean value,
17974 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17975 result causes an error, and delivery is deferred. If the expansion is forced to
17976 fail, the default value for the option (true) is used. Other failures cause
17977 delivery to be deferred.
17978
17979 If this option is set false, and the router declines to handle the address, no
17980 further routers are tried, routing fails, and the address is bounced.
17981 .oindex "&%self%&"
17982 However, if the router explicitly passes an address to the following router by
17983 means of the setting
17984 .code
17985 self = pass
17986 .endd
17987 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17988 does not affect the behaviour if one of the precondition tests fails. In that
17989 case, the address is always passed to the next router.
17990
17991 Note that &%address_data%& is not considered to be a precondition. If its
17992 expansion is forced to fail, the router declines, and the value of &%more%&
17993 controls what happens next.
17994
17995
17996 .option pass_on_timeout routers boolean false
17997 .cindex "timeout" "of router"
17998 .cindex "router" "timeout"
17999 If a router times out during a host lookup, it normally causes deferral of the
18000 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18001 router, overriding &%no_more%&. This may be helpful for systems that are
18002 intermittently connected to the Internet, or those that want to pass to a smart
18003 host any messages that cannot immediately be delivered.
18004
18005 There are occasional other temporary errors that can occur while doing DNS
18006 lookups. They are treated in the same way as a timeout, and this option
18007 applies to all of them.
18008
18009
18010
18011 .option pass_router routers string unset
18012 .cindex "router" "go to after &""pass""&"
18013 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18014 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18015 routing to continue, and overriding a false setting of &%more%&. When one of
18016 these routers returns &"pass"&, the address is normally handed on to the next
18017 router in sequence. This can be changed by setting &%pass_router%& to the name
18018 of another router. However (unlike &%redirect_router%&) the named router must
18019 be below the current router, to avoid loops. Note that this option applies only
18020 to the special case of &"pass"&. It does not apply when a router returns
18021 &"decline"& because it cannot handle an address.
18022
18023
18024
18025 .option redirect_router routers string unset
18026 .cindex "router" "start at after redirection"
18027 Sometimes an administrator knows that it is pointless to reprocess addresses
18028 generated from alias or forward files with the same router again. For
18029 example, if an alias file translates real names into login ids there is no
18030 point searching the alias file a second time, especially if it is a large file.
18031
18032 The &%redirect_router%& option can be set to the name of any router instance.
18033 It causes the routing of any generated addresses to start at the named router
18034 instead of at the first router. This option has no effect if the router in
18035 which it is set does not generate new addresses.
18036
18037
18038
18039 .option require_files routers&!? "string list&!!" unset
18040 .cindex "file" "requiring for router"
18041 .cindex "router" "requiring file existence"
18042 This option provides a general mechanism for predicating the running of a
18043 router on the existence or non-existence of certain files or directories.
18044 Before running a router, as one of its precondition tests, Exim works its way
18045 through the &%require_files%& list, expanding each item separately.
18046
18047 Because the list is split before expansion, any colons in expansion items must
18048 be doubled, or the facility for using a different list separator must be used.
18049 If any expansion is forced to fail, the item is ignored. Other expansion
18050 failures cause routing of the address to be deferred.
18051
18052 If any expanded string is empty, it is ignored. Otherwise, except as described
18053 below, each string must be a fully qualified file path, optionally preceded by
18054 &"!"&. The paths are passed to the &[stat()]& function to test for the
18055 existence of the files or directories. The router is skipped if any paths not
18056 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18057
18058 .cindex "NFS"
18059 If &[stat()]& cannot determine whether a file exists or not, delivery of
18060 the message is deferred. This can happen when NFS-mounted filesystems are
18061 unavailable.
18062
18063 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18064 options, so you cannot use it to check for the existence of a file in which to
18065 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18066 full list of the order in which preconditions are evaluated.) However, as
18067 these options are all expanded, you can use the &%exists%& expansion condition
18068 to make such tests. The &%require_files%& option is intended for checking files
18069 that the router may be going to use internally, or which are needed by a
18070 transport (for example &_.procmailrc_&).
18071
18072 During delivery, the &[stat()]& function is run as root, but there is a
18073 facility for some checking of the accessibility of a file by another user.
18074 This is not a proper permissions check, but just a &"rough"& check that
18075 operates as follows:
18076
18077 If an item in a &%require_files%& list does not contain any forward slash
18078 characters, it is taken to be the user (and optional group, separated by a
18079 comma) to be checked for subsequent files in the list. If no group is specified
18080 but the user is specified symbolically, the gid associated with the uid is
18081 used. For example:
18082 .code
18083 require_files = mail:/some/file
18084 require_files = $local_part:$home/.procmailrc
18085 .endd
18086 If a user or group name in a &%require_files%& list does not exist, the
18087 &%require_files%& condition fails.
18088
18089 Exim performs the check by scanning along the components of the file path, and
18090 checking the access for the given uid and gid. It checks for &"x"& access on
18091 directories, and &"r"& access on the final file. Note that this means that file
18092 access control lists, if the operating system has them, are ignored.
18093
18094 &*Warning 1*&: When the router is being run to verify addresses for an
18095 incoming SMTP message, Exim is not running as root, but under its own uid. This
18096 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18097 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18098 user is not permitted to read one of the directories on the file's path.
18099
18100 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18101 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18102 without root access. In this case, if a check for access by a particular user
18103 is requested, Exim creates a subprocess that runs as that user, and tries the
18104 check again in that process.
18105
18106 The default action for handling an unresolved EACCES is to consider it to
18107 be caused by a configuration error, and routing is deferred because the
18108 existence or non-existence of the file cannot be determined. However, in some
18109 circumstances it may be desirable to treat this condition as if the file did
18110 not exist. If the file name (or the exclamation mark that precedes the file
18111 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18112 as if the file did not exist. For example:
18113 .code
18114 require_files = +/some/file
18115 .endd
18116 If the router is not an essential part of verification (for example, it
18117 handles users' &_.forward_& files), another solution is to set the &%verify%&
18118 option false so that the router is skipped when verifying.
18119
18120
18121
18122 .option retry_use_local_part routers boolean "see below"
18123 .cindex "hints database" "retry keys"
18124 .cindex "local part" "in retry keys"
18125 When a delivery suffers a temporary routing failure, a retry record is created
18126 in Exim's hints database. For addresses whose routing depends only on the
18127 domain, the key for the retry record should not involve the local part, but for
18128 other addresses, both the domain and the local part should be included.
18129 Usually, remote routing is of the former kind, and local routing is of the
18130 latter kind.
18131
18132 This option controls whether the local part is used to form the key for retry
18133 hints for addresses that suffer temporary errors while being handled by this
18134 router. The default value is true for any router that has &%check_local_user%&
18135 set, and false otherwise. Note that this option does not apply to hints keys
18136 for transport delays; they are controlled by a generic transport option of the
18137 same name.
18138
18139 The setting of &%retry_use_local_part%& applies only to the router on which it
18140 appears. If the router generates child addresses, they are routed
18141 independently; this setting does not become attached to them.
18142
18143
18144
18145 .option router_home_directory routers string&!! unset
18146 .cindex "router" "home directory for"
18147 .cindex "home directory" "for router"
18148 .vindex "&$home$&"
18149 This option sets a home directory for use while the router is running. (Compare
18150 &%transport_home_directory%&, which sets a home directory for later
18151 transporting.) In particular, if used on a &(redirect)& router, this option
18152 sets a value for &$home$& while a filter is running. The value is expanded;
18153 forced expansion failure causes the option to be ignored &-- other failures
18154 cause the router to defer.
18155
18156 Expansion of &%router_home_directory%& happens immediately after the
18157 &%check_local_user%& test (if configured), before any further expansions take
18158 place.
18159 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18160 are evaluated.)
18161 While the router is running, &%router_home_directory%& overrides the value of
18162 &$home$& that came from &%check_local_user%&.
18163
18164 When a router accepts an address and assigns it to a local transport (including
18165 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18166 delivery), the home directory setting for the transport is taken from the first
18167 of these values that is set:
18168
18169 .ilist
18170 The &%home_directory%& option on the transport;
18171 .next
18172 The &%transport_home_directory%& option on the router;
18173 .next
18174 The password data if &%check_local_user%& is set on the router;
18175 .next
18176 The &%router_home_directory%& option on the router.
18177 .endlist
18178
18179 In other words, &%router_home_directory%& overrides the password data for the
18180 router, but not for the transport.
18181
18182
18183
18184 .option self routers string freeze
18185 .cindex "MX record" "pointing to local host"
18186 .cindex "local host" "MX pointing to"
18187 This option applies to those routers that use a recipient address to find a
18188 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18189 and &(manualroute)& routers.
18190 Certain configurations of the &(queryprogram)& router can also specify a list
18191 of remote hosts.
18192 Usually such routers are configured to send the message to a remote host via an
18193 &(smtp)& transport. The &%self%& option specifies what happens when the first
18194 host on the list turns out to be the local host.
18195 The way in which Exim checks for the local host is described in section
18196 &<<SECTreclocipadd>>&.
18197
18198 Normally this situation indicates either an error in Exim's configuration (for
18199 example, the router should be configured not to process this domain), or an
18200 error in the DNS (for example, the MX should not point to this host). For this
18201 reason, the default action is to log the incident, defer the address, and
18202 freeze the message. The following alternatives are provided for use in special
18203 cases:
18204
18205 .vlist
18206 .vitem &%defer%&
18207 Delivery of the message is tried again later, but the message is not frozen.
18208
18209 .vitem "&%reroute%&: <&'domain'&>"
18210 The domain is changed to the given domain, and the address is passed back to
18211 be reprocessed by the routers. No rewriting of headers takes place. This
18212 behaviour is essentially a redirection.
18213
18214 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18215 The domain is changed to the given domain, and the address is passed back to be
18216 reprocessed by the routers. Any headers that contain the original domain are
18217 rewritten.
18218
18219 .vitem &%pass%&
18220 .oindex "&%more%&"
18221 .vindex "&$self_hostname$&"
18222 The router passes the address to the next router, or to the router named in the
18223 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18224 subsequent routing and delivery, the variable &$self_hostname$& contains the
18225 name of the local host that the router encountered. This can be used to
18226 distinguish between different cases for hosts with multiple names. The
18227 combination
18228 .code
18229 self = pass
18230 no_more
18231 .endd
18232 ensures that only those addresses that routed to the local host are passed on.
18233 Without &%no_more%&, addresses that were declined for other reasons would also
18234 be passed to the next router.
18235
18236 .vitem &%fail%&
18237 Delivery fails and an error report is generated.
18238
18239 .vitem &%send%&
18240 .cindex "local host" "sending to"
18241 The anomaly is ignored and the address is queued for the transport. This
18242 setting should be used with extreme caution. For an &(smtp)& transport, it
18243 makes sense only in cases where the program that is listening on the SMTP port
18244 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18245 different configuration file that handles the domain in another way.
18246 .endlist
18247
18248
18249
18250 .option senders routers&!? "address list&!!" unset
18251 .cindex "router" "checking senders"
18252 If this option is set, the router is skipped unless the message's sender
18253 address matches something on the list.
18254 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18255 are evaluated.
18256
18257 There are issues concerning verification when the running of routers is
18258 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18259 setting, it sets the sender to the null string. When using the &%-bt%& option
18260 to check a configuration file, it is necessary also to use the &%-f%& option to
18261 set an appropriate sender. For incoming mail, the sender is unset when
18262 verifying the sender, but is available when verifying any recipients. If the
18263 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18264 matters.
18265
18266
18267 .option translate_ip_address routers string&!! unset
18268 .cindex "IP address" "translating"
18269 .cindex "packet radio"
18270 .cindex "router" "IP address translation"
18271 There exist some rare networking situations (for example, packet radio) where
18272 it is helpful to be able to translate IP addresses generated by normal routing
18273 mechanisms into other IP addresses, thus performing a kind of manual IP
18274 routing. This should be done only if the normal IP routing of the TCP/IP stack
18275 is inadequate or broken. Because this is an extremely uncommon requirement, the
18276 code to support this option is not included in the Exim binary unless
18277 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18278
18279 .vindex "&$host_address$&"
18280 The &%translate_ip_address%& string is expanded for every IP address generated
18281 by the router, with the generated address set in &$host_address$&. If the
18282 expansion is forced to fail, no action is taken.
18283 For any other expansion error, delivery of the message is deferred.
18284 If the result of the expansion is an IP address, that replaces the original
18285 address; otherwise the result is assumed to be a host name &-- this is looked
18286 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18287 produce one or more replacement IP addresses. For example, to subvert all IP
18288 addresses in some specific networks, this could be added to a router:
18289 .code
18290 translate_ip_address = \
18291   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18292     {$value}fail}}
18293 .endd
18294 The file would contain lines like
18295 .code
18296 10.2.3.128/26    some.host
18297 10.8.4.34/26     10.44.8.15
18298 .endd
18299 You should not make use of this facility unless you really understand what you
18300 are doing.
18301
18302
18303
18304 .option transport routers string&!! unset
18305 This option specifies the transport to be used when a router accepts an address
18306 and sets it up for delivery. A transport is never needed if a router is used
18307 only for verification. The value of the option is expanded at routing time,
18308 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18309 and result must be the name of one of the configured transports. If it is not,
18310 delivery is deferred.
18311
18312 The &%transport%& option is not used by the &(redirect)& router, but it does
18313 have some private options that set up transports for pipe and file deliveries
18314 (see chapter &<<CHAPredirect>>&).
18315
18316
18317
18318 .option transport_current_directory routers string&!! unset
18319 .cindex "current directory for local transport"
18320 This option associates a current directory with any address that is routed
18321 to a local transport. This can happen either because a transport is
18322 explicitly configured for the router, or because it generates a delivery to a
18323 file or a pipe. During the delivery process (that is, at transport time), this
18324 option string is expanded and is set as the current directory, unless
18325 overridden by a setting on the transport.
18326 If the expansion fails for any reason, including forced failure, an error is
18327 logged, and delivery is deferred.
18328 See chapter &<<CHAPenvironment>>& for details of the local delivery
18329 environment.
18330
18331
18332
18333
18334 .option transport_home_directory routers string&!! "see below"
18335 .cindex "home directory" "for local transport"
18336 This option associates a home directory with any address that is routed to a
18337 local transport. This can happen either because a transport is explicitly
18338 configured for the router, or because it generates a delivery to a file or a
18339 pipe. During the delivery process (that is, at transport time), the option
18340 string is expanded and is set as the home directory, unless overridden by a
18341 setting of &%home_directory%& on the transport.
18342 If the expansion fails for any reason, including forced failure, an error is
18343 logged, and delivery is deferred.
18344
18345 If the transport does not specify a home directory, and
18346 &%transport_home_directory%& is not set for the router, the home directory for
18347 the transport is taken from the password data if &%check_local_user%& is set for
18348 the router. Otherwise it is taken from &%router_home_directory%& if that option
18349 is set; if not, no home directory is set for the transport.
18350
18351 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18352 environment.
18353
18354
18355
18356
18357 .option unseen routers boolean&!! false
18358 .cindex "router" "carrying on after success"
18359 The result of string expansion for this option must be a valid boolean value,
18360 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18361 result causes an error, and delivery is deferred. If the expansion is forced to
18362 fail, the default value for the option (false) is used. Other failures cause
18363 delivery to be deferred.
18364
18365 When this option is set true, routing does not cease if the router accepts the
18366 address. Instead, a copy of the incoming address is passed to the next router,
18367 overriding a false setting of &%more%&. There is little point in setting
18368 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18369 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18370 sometimes true and sometimes false).
18371
18372 .cindex "copy of message (&%unseen%& option)"
18373 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18374 qualifier in filter files. It can be used to cause copies of messages to be
18375 delivered to some other destination, while also carrying out a normal delivery.
18376 In effect, the current address is made into a &"parent"& that has two children
18377 &-- one that is delivered as specified by this router, and a clone that goes on
18378 to be routed further. For this reason, &%unseen%& may not be combined with the
18379 &%one_time%& option in a &(redirect)& router.
18380
18381 &*Warning*&: Header lines added to the address (or specified for removal) by
18382 this router or by previous routers affect the &"unseen"& copy of the message
18383 only. The clone that continues to be processed by further routers starts with
18384 no added headers and none specified for removal. For a &%redirect%& router, if
18385 a generated address is the same as the incoming address, this can lead to
18386 duplicate addresses with different header modifications. Exim does not do
18387 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18388 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18389 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18390 &%redirect%& router may be of help.
18391
18392 Unlike the handling of header modifications, any data that was set by the
18393 &%address_data%& option in the current or previous routers &'is'& passed on to
18394 subsequent routers.
18395
18396
18397 .option user routers string&!! "see below"
18398 .cindex "uid (user id)" "local delivery"
18399 .cindex "local transports" "uid and gid"
18400 .cindex "transport" "local"
18401 .cindex "router" "user for filter processing"
18402 .cindex "filter" "user for processing"
18403 When a router queues an address for a transport, and the transport does not
18404 specify a user, the user given here is used when running the delivery process.
18405 The user may be specified numerically or by name. If expansion fails, the
18406 error is logged and delivery is deferred.
18407 This user is also used by the &(redirect)& router when running a filter file.
18408 The default is unset, except when &%check_local_user%& is set. In this case,
18409 the default is taken from the password information. If the user is specified as
18410 a name, and &%group%& is not set, the group associated with the user is used.
18411 See also &%initgroups%& and &%group%& and the discussion in chapter
18412 &<<CHAPenvironment>>&.
18413
18414
18415
18416 .option verify routers&!? boolean true
18417 Setting this option has the effect of setting &%verify_sender%& and
18418 &%verify_recipient%& to the same value.
18419
18420
18421 .option verify_only routers&!? boolean false
18422 .cindex "EXPN" "with &%verify_only%&"
18423 .oindex "&%-bv%&"
18424 .cindex "router" "used only when verifying"
18425 If this option is set, the router is used only when verifying an address,
18426 delivering in cutthrough mode or
18427 testing with the &%-bv%& option, not when actually doing a delivery, testing
18428 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18429 restricted to verifying only senders or recipients by means of
18430 &%verify_sender%& and &%verify_recipient%&.
18431
18432 &*Warning*&: When the router is being run to verify addresses for an incoming
18433 SMTP message, Exim is not running as root, but under its own uid. If the router
18434 accesses any files, you need to make sure that they are accessible to the Exim
18435 user or group.
18436
18437
18438 .option verify_recipient routers&!? boolean true
18439 If this option is false, the router is skipped when verifying recipient
18440 addresses,
18441 delivering in cutthrough mode
18442 or testing recipient verification using &%-bv%&.
18443 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18444 are evaluated.
18445 See also the &$verify_mode$& variable.
18446
18447
18448 .option verify_sender routers&!? boolean true
18449 If this option is false, the router is skipped when verifying sender addresses
18450 or testing sender verification using &%-bvs%&.
18451 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18452 are evaluated.
18453 See also the &$verify_mode$& variable.
18454 .ecindex IIDgenoprou1
18455 .ecindex IIDgenoprou2
18456
18457
18458
18459
18460
18461
18462 . ////////////////////////////////////////////////////////////////////////////
18463 . ////////////////////////////////////////////////////////////////////////////
18464
18465 .chapter "The accept router" "CHID4"
18466 .cindex "&(accept)& router"
18467 .cindex "routers" "&(accept)&"
18468 The &(accept)& router has no private options of its own. Unless it is being
18469 used purely for verification (see &%verify_only%&) a transport is required to
18470 be defined by the generic &%transport%& option. If the preconditions that are
18471 specified by generic options are met, the router accepts the address and queues
18472 it for the given transport. The most common use of this router is for setting
18473 up deliveries to local mailboxes. For example:
18474 .code
18475 localusers:
18476   driver = accept
18477   domains = mydomain.example
18478   check_local_user
18479   transport = local_delivery
18480 .endd
18481 The &%domains%& condition in this example checks the domain of the address, and
18482 &%check_local_user%& checks that the local part is the login of a local user.
18483 When both preconditions are met, the &(accept)& router runs, and queues the
18484 address for the &(local_delivery)& transport.
18485
18486
18487
18488
18489
18490
18491 . ////////////////////////////////////////////////////////////////////////////
18492 . ////////////////////////////////////////////////////////////////////////////
18493
18494 .chapter "The dnslookup router" "CHAPdnslookup"
18495 .scindex IIDdnsrou1 "&(dnslookup)& router"
18496 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18497 The &(dnslookup)& router looks up the hosts that handle mail for the
18498 recipient's domain in the DNS. A transport must always be set for this router,
18499 unless &%verify_only%& is set.
18500
18501 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18502 SRV records. If none are found, or if SRV support is not configured,
18503 MX records are looked up. If no MX records exist, address records are sought.
18504 However, &%mx_domains%& can be set to disable the direct use of address
18505 records.
18506
18507 MX records of equal priority are sorted by Exim into a random order. Exim then
18508 looks for address records for the host names obtained from MX or SRV records.
18509 When a host has more than one IP address, they are sorted into a random order,
18510 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18511 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18512 generic option, the router declines.
18513
18514 Unless they have the highest priority (lowest MX value), MX records that point
18515 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18516 are discarded, together with any other MX records of equal or lower priority.
18517
18518 .cindex "MX record" "pointing to local host"
18519 .cindex "local host" "MX pointing to"
18520 .oindex "&%self%&" "in &(dnslookup)& router"
18521 If the host pointed to by the highest priority MX record, or looked up as an
18522 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18523 happens is controlled by the generic &%self%& option.
18524
18525
18526 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18527 There have been problems with DNS servers when SRV records are looked up.
18528 Some misbehaving servers return a DNS error or timeout when a non-existent
18529 SRV record is sought. Similar problems have in the past been reported for
18530 MX records. The global &%dns_again_means_nonexist%& option can help with this
18531 problem, but it is heavy-handed because it is a global option.
18532
18533 For this reason, there are two options, &%srv_fail_domains%& and
18534 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18535 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18536 an attempt to look up an SRV or MX record causes one of these results, and the
18537 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18538 such record"&. In the case of an SRV lookup, this means that the router
18539 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18540 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18541 case routing fails.
18542
18543
18544 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18545 .cindex "&(dnslookup)& router" "declines"
18546 There are a few cases where a &(dnslookup)& router will decline to accept
18547 an address; if such a router is expected to handle "all remaining non-local
18548 domains", then it is important to set &%no_more%&.
18549
18550 The router will defer rather than decline if the domain
18551 is found in the &%fail_defer_domains%& router option.
18552
18553 Reasons for a &(dnslookup)& router to decline currently include:
18554 .ilist
18555 The domain does not exist in DNS
18556 .next
18557 The domain exists but the MX record's host part is just "."; this is a common
18558 convention (borrowed from SRV) used to indicate that there is no such service
18559 for this domain and to not fall back to trying A/AAAA records.
18560 .next
18561 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18562 .next
18563 MX record points to a non-existent host.
18564 .next
18565 MX record points to an IP address and the main section option
18566 &%allow_mx_to_ip%& is not set.
18567 .next
18568 MX records exist and point to valid hosts, but all hosts resolve only to
18569 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18570 .next
18571 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18572 &%dns_check_names_pattern%& for handling one variant of this)
18573 .next
18574 &%check_secondary_mx%& is set on this router but the local host can
18575 not be found in the MX records (see below)
18576 .endlist
18577
18578
18579
18580
18581 .section "Private options for dnslookup" "SECID118"
18582 .cindex "options" "&(dnslookup)& router"
18583 The private options for the &(dnslookup)& router are as follows:
18584
18585 .option check_secondary_mx dnslookup boolean false
18586 .cindex "MX record" "checking for secondary"
18587 If this option is set, the router declines unless the local host is found in
18588 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18589 process domains for which the local host is a secondary mail exchanger
18590 differently to other domains. The way in which Exim decides whether a host is
18591 the local host is described in section &<<SECTreclocipadd>>&.
18592
18593
18594 .option check_srv dnslookup string&!! unset
18595 .cindex "SRV record" "enabling use of"
18596 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18597 addition to MX and address records. The support is disabled by default. To
18598 enable SRV support, set the &%check_srv%& option to the name of the service
18599 required. For example,
18600 .code
18601 check_srv = smtp
18602 .endd
18603 looks for SRV records that refer to the normal smtp service. The option is
18604 expanded, so the service name can vary from message to message or address
18605 to address. This might be helpful if SRV records are being used for a
18606 submission service. If the expansion is forced to fail, the &%check_srv%&
18607 option is ignored, and the router proceeds to look for MX records in the
18608 normal way.
18609
18610 When the expansion succeeds, the router searches first for SRV records for
18611 the given service (it assumes TCP protocol). A single SRV record with a
18612 host name that consists of just a single dot indicates &"no such service for
18613 this domain"&; if this is encountered, the router declines. If other kinds of
18614 SRV record are found, they are used to construct a host list for delivery
18615 according to the rules of RFC 2782. MX records are not sought in this case.
18616
18617 When no SRV records are found, MX records (and address records) are sought in
18618 the traditional way. In other words, SRV records take precedence over MX
18619 records, just as MX records take precedence over address records. Note that
18620 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18621 defined it. It is apparently believed that MX records are sufficient for email
18622 and that SRV records should not be used for this purpose. However, SRV records
18623 have an additional &"weight"& feature which some people might find useful when
18624 trying to split an SMTP load between hosts of different power.
18625
18626 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18627 when there is a DNS lookup error.
18628
18629
18630
18631
18632 .option fail_defer_domains dnslookup "domain list&!!" unset
18633 .cindex "MX record" "not found"
18634 DNS lookups for domains matching &%fail_defer_domains%&
18635 which find no matching record will cause the router to defer
18636 rather than the default behaviour of decline.
18637 This maybe be useful for queueing messages for a newly created
18638 domain while the DNS configuration is not ready.
18639 However, it will result in any message with mistyped domains
18640 also being queued.
18641
18642
18643 .option mx_domains dnslookup "domain list&!!" unset
18644 .cindex "MX record" "required to exist"
18645 .cindex "SRV record" "required to exist"
18646 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18647 record in order to be recognized. (The name of this option could be improved.)
18648 For example, if all the mail hosts in &'fict.example'& are known to have MX
18649 records, except for those in &'discworld.fict.example'&, you could use this
18650 setting:
18651 .code
18652 mx_domains = ! *.discworld.fict.example : *.fict.example
18653 .endd
18654 This specifies that messages addressed to a domain that matches the list but
18655 has no MX record should be bounced immediately instead of being routed using
18656 the address record.
18657
18658
18659 .option mx_fail_domains dnslookup "domain list&!!" unset
18660 If the DNS lookup for MX records for one of the domains in this list causes a
18661 DNS lookup error, Exim behaves as if no MX records were found. See section
18662 &<<SECTprowitdnsloo>>& for more discussion.
18663
18664
18665
18666
18667 .option qualify_single dnslookup boolean true
18668 .cindex "DNS" "resolver options"
18669 .cindex "DNS" "qualifying single-component names"
18670 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18671 lookups. Typically, but not standardly, this causes the resolver to qualify
18672 single-component names with the default domain. For example, on a machine
18673 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18674 &'thesaurus.ref.example'& inside the resolver. For details of what your
18675 resolver actually does, consult your man pages for &'resolver'& and
18676 &'resolv.conf'&.
18677
18678
18679
18680 .option rewrite_headers dnslookup boolean true
18681 .cindex "rewriting" "header lines"
18682 .cindex "header lines" "rewriting"
18683 If the domain name in the address that is being processed is not fully
18684 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18685 an address is specified as &'dormouse@teaparty'&, the domain might be
18686 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18687 occur as a result of setting the &%widen_domains%& option. If
18688 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18689 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18690 header lines of the message are rewritten with the full domain name.
18691
18692 This option should be turned off only when it is known that no message is
18693 ever going to be sent outside an environment where the abbreviation makes
18694 sense.
18695
18696 When an MX record is looked up in the DNS and matches a wildcard record, name
18697 servers normally return a record containing the name that has been looked up,
18698 making it impossible to detect whether a wildcard was present or not. However,
18699 some name servers have recently been seen to return the wildcard entry. If the
18700 name returned by a DNS lookup begins with an asterisk, it is not used for
18701 header rewriting.
18702
18703
18704 .option same_domain_copy_routing dnslookup boolean false
18705 .cindex "address" "copying routing"
18706 Addresses with the same domain are normally routed by the &(dnslookup)& router
18707 to the same list of hosts. However, this cannot be presumed, because the router
18708 options and preconditions may refer to the local part of the address. By
18709 default, therefore, Exim routes each address in a message independently. DNS
18710 servers run caches, so repeated DNS lookups are not normally expensive, and in
18711 any case, personal messages rarely have more than a few recipients.
18712
18713 If you are running mailing lists with large numbers of subscribers at the same
18714 domain, and you are using a &(dnslookup)& router which is independent of the
18715 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18716 lookups for identical domains in one message. In this case, when &(dnslookup)&
18717 routes an address to a remote transport, any other unrouted addresses in the
18718 message that have the same domain are automatically given the same routing
18719 without processing them independently,
18720 provided the following conditions are met:
18721
18722 .ilist
18723 No router that processed the address specified &%headers_add%& or
18724 &%headers_remove%&.
18725 .next
18726 The router did not change the address in any way, for example, by &"widening"&
18727 the domain.
18728 .endlist
18729
18730
18731
18732
18733 .option search_parents dnslookup boolean false
18734 .cindex "DNS" "resolver options"
18735 When this option is true, the resolver option RES_DNSRCH is set for DNS
18736 lookups. This is different from the &%qualify_single%& option in that it
18737 applies to domains containing dots. Typically, but not standardly, it causes
18738 the resolver to search for the name in the current domain and in parent
18739 domains. For example, on a machine in the &'fict.example'& domain, if looking
18740 up &'teaparty.wonderland'& failed, the resolver would try
18741 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18742 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18743
18744 Setting this option true can cause problems in domains that have a wildcard MX
18745 record, because any domain that does not have its own MX record matches the
18746 local wildcard.
18747
18748
18749
18750 .option srv_fail_domains dnslookup "domain list&!!" unset
18751 If the DNS lookup for SRV records for one of the domains in this list causes a
18752 DNS lookup error, Exim behaves as if no SRV records were found. See section
18753 &<<SECTprowitdnsloo>>& for more discussion.
18754
18755
18756
18757
18758 .option widen_domains dnslookup "string list" unset
18759 .cindex "domain" "partial; widening"
18760 If a DNS lookup fails and this option is set, each of its strings in turn is
18761 added onto the end of the domain, and the lookup is tried again. For example,
18762 if
18763 .code
18764 widen_domains = fict.example:ref.example
18765 .endd
18766 is set and a lookup of &'klingon.dictionary'& fails,
18767 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18768 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18769 and &%search_parents%& options can cause some widening to be undertaken inside
18770 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18771 when verifying, unless &%rewrite_headers%& is false (not the default).
18772
18773
18774 .section "Effect of qualify_single and search_parents" "SECID119"
18775 When a domain from an envelope recipient is changed by the resolver as a result
18776 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18777 corresponding address in the message's header lines unless &%rewrite_headers%&
18778 is set false. Exim then re-routes the address, using the full domain.
18779
18780 These two options affect only the DNS lookup that takes place inside the router
18781 for the domain of the address that is being routed. They do not affect lookups
18782 such as that implied by
18783 .code
18784 domains = @mx_any
18785 .endd
18786 that may happen while processing a router precondition before the router is
18787 entered. No widening ever takes place for these lookups.
18788 .ecindex IIDdnsrou1
18789 .ecindex IIDdnsrou2
18790
18791
18792
18793
18794
18795
18796
18797
18798
18799 . ////////////////////////////////////////////////////////////////////////////
18800 . ////////////////////////////////////////////////////////////////////////////
18801
18802 .chapter "The ipliteral router" "CHID5"
18803 .cindex "&(ipliteral)& router"
18804 .cindex "domain literal" "routing"
18805 .cindex "routers" "&(ipliteral)&"
18806 This router has no private options. Unless it is being used purely for
18807 verification (see &%verify_only%&) a transport is required to be defined by the
18808 generic &%transport%& option. The router accepts the address if its domain part
18809 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18810 router handles the address
18811 .code
18812 root@[192.168.1.1]
18813 .endd
18814 by setting up delivery to the host with that IP address. IPv4 domain literals
18815 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18816 are similar, but the address is preceded by &`ipv6:`&. For example:
18817 .code
18818 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18819 .endd
18820 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18821 grounds that sooner or later somebody will try it.
18822
18823 .oindex "&%self%&" "in &(ipliteral)& router"
18824 If the IP address matches something in &%ignore_target_hosts%&, the router
18825 declines. If an IP literal turns out to refer to the local host, the generic
18826 &%self%& option determines what happens.
18827
18828 The RFCs require support for domain literals; however, their use is
18829 controversial in today's Internet. If you want to use this router, you must
18830 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18831 Exim will not recognize the domain literal syntax in addresses.
18832
18833
18834
18835 . ////////////////////////////////////////////////////////////////////////////
18836 . ////////////////////////////////////////////////////////////////////////////
18837
18838 .chapter "The iplookup router" "CHID6"
18839 .cindex "&(iplookup)& router"
18840 .cindex "routers" "&(iplookup)&"
18841 The &(iplookup)& router was written to fulfil a specific requirement in
18842 Cambridge University (which in fact no longer exists). For this reason, it is
18843 not included in the binary of Exim by default. If you want to include it, you
18844 must set
18845 .code
18846 ROUTER_IPLOOKUP=yes
18847 .endd
18848 in your &_Local/Makefile_& configuration file.
18849
18850 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18851 connection to one or more specific hosts. The host can then return the same or
18852 a different address &-- in effect rewriting the recipient address in the
18853 message's envelope. The new address is then passed on to subsequent routers. If
18854 this process fails, the address can be passed on to other routers, or delivery
18855 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18856 must not be specified for it.
18857
18858 .cindex "options" "&(iplookup)& router"
18859 .option hosts iplookup string unset
18860 This option must be supplied. Its value is a colon-separated list of host
18861 names. The hosts are looked up using &[gethostbyname()]&
18862 (or &[getipnodebyname()]& when available)
18863 and are tried in order until one responds to the query. If none respond, what
18864 happens is controlled by &%optional%&.
18865
18866
18867 .option optional iplookup boolean false
18868 If &%optional%& is true, if no response is obtained from any host, the address
18869 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18870 delivery to the address is deferred.
18871
18872
18873 .option port iplookup integer 0
18874 .cindex "port" "&(iplookup)& router"
18875 This option must be supplied. It specifies the port number for the TCP or UDP
18876 call.
18877
18878
18879 .option protocol iplookup string udp
18880 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18881 protocols is to be used.
18882
18883
18884 .option query iplookup string&!! "see below"
18885 This defines the content of the query that is sent to the remote hosts. The
18886 default value is:
18887 .code
18888 $local_part@$domain $local_part@$domain
18889 .endd
18890 The repetition serves as a way of checking that a response is to the correct
18891 query in the default case (see &%response_pattern%& below).
18892
18893
18894 .option reroute iplookup string&!! unset
18895 If this option is not set, the rerouted address is precisely the byte string
18896 returned by the remote host, up to the first white space, if any. If set, the
18897 string is expanded to form the rerouted address. It can include parts matched
18898 in the response by &%response_pattern%& by means of numeric variables such as
18899 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18900 whether or not a pattern is in use. In all cases, the rerouted address must end
18901 up in the form &'local_part@domain'&.
18902
18903
18904 .option response_pattern iplookup string unset
18905 This option can be set to a regular expression that is applied to the string
18906 returned from the remote host. If the pattern does not match the response, the
18907 router declines. If &%response_pattern%& is not set, no checking of the
18908 response is done, unless the query was defaulted, in which case there is a
18909 check that the text returned after the first white space is the original
18910 address. This checks that the answer that has been received is in response to
18911 the correct question. For example, if the response is just a new domain, the
18912 following could be used:
18913 .code
18914 response_pattern = ^([^@]+)$
18915 reroute = $local_part@$1
18916 .endd
18917
18918 .option timeout iplookup time 5s
18919 This specifies the amount of time to wait for a response from the remote
18920 machine. The same timeout is used for the &[connect()]& function for a TCP
18921 call. It does not apply to UDP.
18922
18923
18924
18925
18926 . ////////////////////////////////////////////////////////////////////////////
18927 . ////////////////////////////////////////////////////////////////////////////
18928
18929 .chapter "The manualroute router" "CHID7"
18930 .scindex IIDmanrou1 "&(manualroute)& router"
18931 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18932 .cindex "domain" "manually routing"
18933 The &(manualroute)& router is so-called because it provides a way of manually
18934 routing an address according to its domain. It is mainly used when you want to
18935 route addresses to remote hosts according to your own rules, bypassing the
18936 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18937 route to local transports, a facility that may be useful if you want to save
18938 messages for dial-in hosts in local files.
18939
18940 The &(manualroute)& router compares a list of domain patterns with the domain
18941 it is trying to route. If there is no match, the router declines. Each pattern
18942 has associated with it a list of hosts and some other optional data, which may
18943 include a transport. The combination of a pattern and its data is called a
18944 &"routing rule"&. For patterns that do not have an associated transport, the
18945 generic &%transport%& option must specify a transport, unless the router is
18946 being used purely for verification (see &%verify_only%&).
18947
18948 .vindex "&$host$&"
18949 In the case of verification, matching the domain pattern is sufficient for the
18950 router to accept the address. When actually routing an address for delivery,
18951 an address that matches a domain pattern is queued for the associated
18952 transport. If the transport is not a local one, a host list must be associated
18953 with the pattern; IP addresses are looked up for the hosts, and these are
18954 passed to the transport along with the mail address. For local transports, a
18955 host list is optional. If it is present, it is passed in &$host$& as a single
18956 text string.
18957
18958 The list of routing rules can be provided as an inline string in
18959 &%route_list%&, or the data can be obtained by looking up the domain in a file
18960 or database by setting &%route_data%&. Only one of these settings may appear in
18961 any one instance of &(manualroute)&. The format of routing rules is described
18962 below, following the list of private options.
18963
18964
18965 .section "Private options for manualroute" "SECTprioptman"
18966
18967 .cindex "options" "&(manualroute)& router"
18968 The private options for the &(manualroute)& router are as follows:
18969
18970 .option host_all_ignored manualroute string defer
18971 See &%host_find_failed%&.
18972
18973 .option host_find_failed manualroute string freeze
18974 This option controls what happens when &(manualroute)& tries to find an IP
18975 address for a host, and the host does not exist. The option can be set to one
18976 of the following values:
18977 .code
18978 decline
18979 defer
18980 fail
18981 freeze
18982 ignore
18983 pass
18984 .endd
18985 The default (&"freeze"&) assumes that this state is a serious configuration
18986 error. The difference between &"pass"& and &"decline"& is that the former
18987 forces the address to be passed to the next router (or the router defined by
18988 &%pass_router%&),
18989 .oindex "&%more%&"
18990 overriding &%no_more%&, whereas the latter passes the address to the next
18991 router only if &%more%& is true.
18992
18993 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18994 cannot be found. If all the hosts in the list are ignored, the behaviour is
18995 controlled by the &%host_all_ignored%& option. This takes the same values
18996 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18997
18998 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18999 state; if a host lookup gets a temporary error, delivery is deferred unless the
19000 generic &%pass_on_timeout%& option is set.
19001
19002
19003 .option hosts_randomize manualroute boolean false
19004 .cindex "randomized host list"
19005 .cindex "host" "list of; randomized"
19006 If this option is set, the order of the items in a host list in a routing rule
19007 is randomized each time the list is used, unless an option in the routing rule
19008 overrides (see below). Randomizing the order of a host list can be used to do
19009 crude load sharing. However, if more than one mail address is routed by the
19010 same router to the same host list, the host lists are considered to be the same
19011 (even though they may be randomized into different orders) for the purpose of
19012 deciding whether to batch the deliveries into a single SMTP transaction.
19013
19014 When &%hosts_randomize%& is true, a host list may be split
19015 into groups whose order is separately randomized. This makes it possible to
19016 set up MX-like behaviour. The boundaries between groups are indicated by an
19017 item that is just &`+`& in the host list. For example:
19018 .code
19019 route_list = * host1:host2:host3:+:host4:host5
19020 .endd
19021 The order of the first three hosts and the order of the last two hosts is
19022 randomized for each use, but the first three always end up before the last two.
19023 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19024 randomized host list is passed to an &(smtp)& transport that also has
19025 &%hosts_randomize set%&, the list is not re-randomized.
19026
19027
19028 .option route_data manualroute string&!! unset
19029 If this option is set, it must expand to yield the data part of a routing rule.
19030 Typically, the expansion string includes a lookup based on the domain. For
19031 example:
19032 .code
19033 route_data = ${lookup{$domain}dbm{/etc/routes}}
19034 .endd
19035 If the expansion is forced to fail, or the result is an empty string, the
19036 router declines. Other kinds of expansion failure cause delivery to be
19037 deferred.
19038
19039
19040 .option route_list manualroute "string list" unset
19041 This string is a list of routing rules, in the form defined below. Note that,
19042 unlike most string lists, the items are separated by semicolons. This is so
19043 that they may contain colon-separated host lists.
19044
19045
19046 .option same_domain_copy_routing manualroute boolean false
19047 .cindex "address" "copying routing"
19048 Addresses with the same domain are normally routed by the &(manualroute)&
19049 router to the same list of hosts. However, this cannot be presumed, because the
19050 router options and preconditions may refer to the local part of the address. By
19051 default, therefore, Exim routes each address in a message independently. DNS
19052 servers run caches, so repeated DNS lookups are not normally expensive, and in
19053 any case, personal messages rarely have more than a few recipients.
19054
19055 If you are running mailing lists with large numbers of subscribers at the same
19056 domain, and you are using a &(manualroute)& router which is independent of the
19057 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19058 lookups for identical domains in one message. In this case, when
19059 &(manualroute)& routes an address to a remote transport, any other unrouted
19060 addresses in the message that have the same domain are automatically given the
19061 same routing without processing them independently. However, this is only done
19062 if &%headers_add%& and &%headers_remove%& are unset.
19063
19064
19065
19066
19067 .section "Routing rules in route_list" "SECID120"
19068 The value of &%route_list%& is a string consisting of a sequence of routing
19069 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19070 entered as two semicolons. Alternatively, the list separator can be changed as
19071 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19072 Empty rules are ignored. The format of each rule is
19073 .display
19074 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19075 .endd
19076 The following example contains two rules, each with a simple domain pattern and
19077 no options:
19078 .code
19079 route_list = \
19080   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19081   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19082 .endd
19083 The three parts of a rule are separated by white space. The pattern and the
19084 list of hosts can be enclosed in quotes if necessary, and if they are, the
19085 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19086 single domain pattern, which is the only mandatory item in the rule. The
19087 pattern is in the same format as one item in a domain list (see section
19088 &<<SECTdomainlist>>&),
19089 except that it may not be the name of an interpolated file.
19090 That is, it may be wildcarded, or a regular expression, or a file or database
19091 lookup (with semicolons doubled, because of the use of semicolon as a separator
19092 in a &%route_list%&).
19093
19094 The rules in &%route_list%& are searched in order until one of the patterns
19095 matches the domain that is being routed. The list of hosts and then options are
19096 then used as described below. If there is no match, the router declines. When
19097 &%route_list%& is set, &%route_data%& must not be set.
19098
19099
19100
19101 .section "Routing rules in route_data" "SECID121"
19102 The use of &%route_list%& is convenient when there are only a small number of
19103 routing rules. For larger numbers, it is easier to use a file or database to
19104 hold the routing information, and use the &%route_data%& option instead.
19105 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19106 Most commonly, &%route_data%& is set as a string that contains an
19107 expansion lookup. For example, suppose we place two routing rules in a file
19108 like this:
19109 .code
19110 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19111 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19112 .endd
19113 This data can be accessed by setting
19114 .code
19115 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19116 .endd
19117 Failure of the lookup results in an empty string, causing the router to
19118 decline. However, you do not have to use a lookup in &%route_data%&. The only
19119 requirement is that the result of expanding the string is a list of hosts,
19120 possibly followed by options, separated by white space. The list of hosts must
19121 be enclosed in quotes if it contains white space.
19122
19123
19124
19125
19126 .section "Format of the list of hosts" "SECID122"
19127 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19128 always separately expanded before use. If the expansion fails, the router
19129 declines. The result of the expansion must be a colon-separated list of names
19130 and/or IP addresses, optionally also including ports. The format of each item
19131 in the list is described in the next section. The list separator can be changed
19132 as described in section &<<SECTlistconstruct>>&.
19133
19134 If the list of hosts was obtained from a &%route_list%& item, the following
19135 variables are set during its expansion:
19136
19137 .ilist
19138 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19139 If the domain was matched against a regular expression, the numeric variables
19140 &$1$&, &$2$&, etc. may be set. For example:
19141 .code
19142 route_list = ^domain(\d+)   host-$1.text.example
19143 .endd
19144 .next
19145 &$0$& is always set to the entire domain.
19146 .next
19147 &$1$& is also set when partial matching is done in a file lookup.
19148
19149 .next
19150 .vindex "&$value$&"
19151 If the pattern that matched the domain was a lookup item, the data that was
19152 looked up is available in the expansion variable &$value$&. For example:
19153 .code
19154 route_list = lsearch;;/some/file.routes  $value
19155 .endd
19156 .endlist
19157
19158 Note the doubling of the semicolon in the pattern that is necessary because
19159 semicolon is the default route list separator.
19160
19161
19162
19163 .section "Format of one host item" "SECTformatonehostitem"
19164 Each item in the list of hosts is either a host name or an IP address,
19165 optionally with an attached port number. When no port is given, an IP address
19166 is not enclosed in brackets. When a port is specified, it overrides the port
19167 specification on the transport. The port is separated from the name or address
19168 by a colon. This leads to some complications:
19169
19170 .ilist
19171 Because colon is the default separator for the list of hosts, either
19172 the colon that specifies a port must be doubled, or the list separator must
19173 be changed. The following two examples have the same effect:
19174 .code
19175 route_list = * "host1.tld::1225 : host2.tld::1226"
19176 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19177 .endd
19178 .next
19179 When IPv6 addresses are involved, it gets worse, because they contain
19180 colons of their own. To make this case easier, it is permitted to
19181 enclose an IP address (either v4 or v6) in square brackets if a port
19182 number follows. For example:
19183 .code
19184 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19185 .endd
19186 .endlist
19187
19188 .section "How the list of hosts is used" "SECThostshowused"
19189 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19190 the hosts is tried, in the order specified, when carrying out the SMTP
19191 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19192 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19193 transport.
19194
19195 Hosts may be listed by name or by IP address. An unadorned name in the list of
19196 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19197 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19198 records in the DNS. For example:
19199 .code
19200 route_list = *  x.y.z:p.q.r/MX:e.f.g
19201 .endd
19202 If this feature is used with a port specifier, the port must come last. For
19203 example:
19204 .code
19205 route_list = *  dom1.tld/mx::1225
19206 .endd
19207 If the &%hosts_randomize%& option is set, the order of the items in the list is
19208 randomized before any lookups are done. Exim then scans the list; for any name
19209 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19210 be an interface on the local host and the item is not the first in the list,
19211 Exim discards it and any subsequent items. If it is the first item, what
19212 happens is controlled by the
19213 .oindex "&%self%&" "in &(manualroute)& router"
19214 &%self%& option of the router.
19215
19216 A name on the list that is followed by &`/MX`& is replaced with the list of
19217 hosts obtained by looking up MX records for the name. This is always a DNS
19218 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19219 below) are not relevant here. The order of these hosts is determined by the
19220 preference values in the MX records, according to the usual rules. Because
19221 randomizing happens before the MX lookup, it does not affect the order that is
19222 defined by MX preferences.
19223
19224 If the local host is present in the sublist obtained from MX records, but is
19225 not the most preferred host in that list, it and any equally or less
19226 preferred hosts are removed before the sublist is inserted into the main list.
19227
19228 If the local host is the most preferred host in the MX list, what happens
19229 depends on where in the original list of hosts the &`/MX`& item appears. If it
19230 is not the first item (that is, there are previous hosts in the main list),
19231 Exim discards this name and any subsequent items in the main list.
19232
19233 If the MX item is first in the list of hosts, and the local host is the
19234 most preferred host, what happens is controlled by the &%self%& option of the
19235 router.
19236
19237 DNS failures when lookup up the MX records are treated in the same way as DNS
19238 failures when looking up IP addresses: &%pass_on_timeout%& and
19239 &%host_find_failed%& are used when relevant.
19240
19241 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19242 whether obtained from an MX lookup or not.
19243
19244
19245
19246 .section "How the options are used" "SECThowoptused"
19247 The options are a sequence of words; in practice no more than three are ever
19248 present. One of the words can be the name of a transport; this overrides the
19249 &%transport%& option on the router for this particular routing rule only. The
19250 other words (if present) control randomization of the list of hosts on a
19251 per-rule basis, and how the IP addresses of the hosts are to be found when
19252 routing to a remote transport. These options are as follows:
19253
19254 .ilist
19255 &%randomize%&: randomize the order of the hosts in this list, overriding the
19256 setting of &%hosts_randomize%& for this routing rule only.
19257 .next
19258 &%no_randomize%&: do not randomize the order of the hosts in this list,
19259 overriding the setting of &%hosts_randomize%& for this routing rule only.
19260 .next
19261 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19262 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19263 also look in &_/etc/hosts_& or other sources of information.
19264 .next
19265 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19266 no address records are found. If there is a temporary DNS error (such as a
19267 timeout), delivery is deferred.
19268 .endlist
19269
19270 For example:
19271 .code
19272 route_list = domain1  host1:host2:host3  randomize bydns;\
19273              domain2  host4:host5
19274 .endd
19275 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19276 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19277 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19278 or &[gethostbyname()]&, and the result of the lookup is the result of that
19279 call.
19280
19281 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19282 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19283 instead of TRY_AGAIN. That is why the default action is to try a DNS
19284 lookup first. Only if that gives a definite &"no such host"& is the local
19285 function called.
19286
19287
19288
19289 If no IP address for a host can be found, what happens is controlled by the
19290 &%host_find_failed%& option.
19291
19292 .vindex "&$host$&"
19293 When an address is routed to a local transport, IP addresses are not looked up.
19294 The host list is passed to the transport in the &$host$& variable.
19295
19296
19297
19298 .section "Manualroute examples" "SECID123"
19299 In some of the examples that follow, the presence of the &%remote_smtp%&
19300 transport, as defined in the default configuration file, is assumed:
19301
19302 .ilist
19303 .cindex "smart host" "example router"
19304 The &(manualroute)& router can be used to forward all external mail to a
19305 &'smart host'&. If you have set up, in the main part of the configuration, a
19306 named domain list that contains your local domains, for example:
19307 .code
19308 domainlist local_domains = my.domain.example
19309 .endd
19310 You can arrange for all other domains to be routed to a smart host by making
19311 your first router something like this:
19312 .code
19313 smart_route:
19314   driver = manualroute
19315   domains = !+local_domains
19316   transport = remote_smtp
19317   route_list = * smarthost.ref.example
19318 .endd
19319 This causes all non-local addresses to be sent to the single host
19320 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19321 they are tried in order
19322 (but you can use &%hosts_randomize%& to vary the order each time).
19323 Another way of configuring the same thing is this:
19324 .code
19325 smart_route:
19326   driver = manualroute
19327   transport = remote_smtp
19328   route_list = !+local_domains  smarthost.ref.example
19329 .endd
19330 There is no difference in behaviour between these two routers as they stand.
19331 However, they behave differently if &%no_more%& is added to them. In the first
19332 example, the router is skipped if the domain does not match the &%domains%&
19333 precondition; the following router is always tried. If the router runs, it
19334 always matches the domain and so can never decline. Therefore, &%no_more%&
19335 would have no effect. In the second case, the router is never skipped; it
19336 always runs. However, if it doesn't match the domain, it declines. In this case
19337 &%no_more%& would prevent subsequent routers from running.
19338
19339 .next
19340 .cindex "mail hub example"
19341 A &'mail hub'& is a host which receives mail for a number of domains via MX
19342 records in the DNS and delivers it via its own private routing mechanism. Often
19343 the final destinations are behind a firewall, with the mail hub being the one
19344 machine that can connect to machines both inside and outside the firewall. The
19345 &(manualroute)& router is usually used on a mail hub to route incoming messages
19346 to the correct hosts. For a small number of domains, the routing can be inline,
19347 using the &%route_list%& option, but for a larger number a file or database
19348 lookup is easier to manage.
19349
19350 If the domain names are in fact the names of the machines to which the mail is
19351 to be sent by the mail hub, the configuration can be quite simple. For
19352 example:
19353 .code
19354 hub_route:
19355   driver = manualroute
19356   transport = remote_smtp
19357   route_list = *.rhodes.tvs.example  $domain
19358 .endd
19359 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19360 whose names are the same as the mail domains. A similar approach can be taken
19361 if the host name can be obtained from the domain name by a string manipulation
19362 that the expansion facilities can handle. Otherwise, a lookup based on the
19363 domain can be used to find the host:
19364 .code
19365 through_firewall:
19366   driver = manualroute
19367   transport = remote_smtp
19368   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19369 .endd
19370 The result of the lookup must be the name or IP address of the host (or
19371 hosts) to which the address is to be routed. If the lookup fails, the route
19372 data is empty, causing the router to decline. The address then passes to the
19373 next router.
19374
19375 .next
19376 .cindex "batched SMTP output example"
19377 .cindex "SMTP" "batched outgoing; example"
19378 You can use &(manualroute)& to deliver messages to pipes or files in batched
19379 SMTP format for onward transportation by some other means. This is one way of
19380 storing mail for a dial-up host when it is not connected. The route list entry
19381 can be as simple as a single domain name in a configuration like this:
19382 .code
19383 save_in_file:
19384   driver = manualroute
19385   transport = batchsmtp_appendfile
19386   route_list = saved.domain.example
19387 .endd
19388 though often a pattern is used to pick up more than one domain. If there are
19389 several domains or groups of domains with different transport requirements,
19390 different transports can be listed in the routing information:
19391 .code
19392 save_in_file:
19393   driver = manualroute
19394   route_list = \
19395     *.saved.domain1.example  $domain  batch_appendfile; \
19396     *.saved.domain2.example  \
19397       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19398       batch_pipe
19399 .endd
19400 .vindex "&$domain$&"
19401 .vindex "&$host$&"
19402 The first of these just passes the domain in the &$host$& variable, which
19403 doesn't achieve much (since it is also in &$domain$&), but the second does a
19404 file lookup to find a value to pass, causing the router to decline to handle
19405 the address if the lookup fails.
19406
19407 .next
19408 .cindex "UUCP" "example of router for"
19409 Routing mail directly to UUCP software is a specific case of the use of
19410 &(manualroute)& in a gateway to another mail environment. This is an example of
19411 one way it can be done:
19412 .code
19413 # Transport
19414 uucp:
19415   driver = pipe
19416   user = nobody
19417   command = /usr/local/bin/uux -r - \
19418     ${substr_-5:$host}!rmail ${local_part}
19419   return_fail_output = true
19420
19421 # Router
19422 uucphost:
19423   transport = uucp
19424   driver = manualroute
19425   route_data = \
19426     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19427 .endd
19428 The file &_/usr/local/exim/uucphosts_& contains entries like
19429 .code
19430 darksite.ethereal.example:           darksite.UUCP
19431 .endd
19432 It can be set up more simply without adding and removing &".UUCP"& but this way
19433 makes clear the distinction between the domain name
19434 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19435 .endlist
19436 .ecindex IIDmanrou1
19437 .ecindex IIDmanrou2
19438
19439
19440
19441
19442
19443
19444
19445
19446 . ////////////////////////////////////////////////////////////////////////////
19447 . ////////////////////////////////////////////////////////////////////////////
19448
19449 .chapter "The queryprogram router" "CHAPdriverlast"
19450 .scindex IIDquerou1 "&(queryprogram)& router"
19451 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19452 .cindex "routing" "by external program"
19453 The &(queryprogram)& router routes an address by running an external command
19454 and acting on its output. This is an expensive way to route, and is intended
19455 mainly for use in lightly-loaded systems, or for performing experiments.
19456 However, if it is possible to use the precondition options (&%domains%&,
19457 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19458 be used in special cases, even on a busy host. There are the following private
19459 options:
19460 .cindex "options" "&(queryprogram)& router"
19461
19462 .option command queryprogram string&!! unset
19463 This option must be set. It specifies the command that is to be run. The
19464 command is split up into a command name and arguments, and then each is
19465 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19466 &<<CHAPpipetransport>>&).
19467
19468
19469 .option command_group queryprogram string unset
19470 .cindex "gid (group id)" "in &(queryprogram)& router"
19471 This option specifies a gid to be set when running the command while routing an
19472 address for deliver. It must be set if &%command_user%& specifies a numerical
19473 uid. If it begins with a digit, it is interpreted as the numerical value of the
19474 gid. Otherwise it is looked up using &[getgrnam()]&.
19475
19476
19477 .option command_user queryprogram string unset
19478 .cindex "uid (user id)" "for &(queryprogram)&"
19479 This option must be set. It specifies the uid which is set when running the
19480 command while routing an address for delivery. If the value begins with a digit,
19481 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19482 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19483 not set, a value for the gid also.
19484
19485 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19486 root, which it does during a normal delivery in a conventional configuration.
19487 However, when an address is being verified during message reception, Exim is
19488 usually running as the Exim user, not as root. If the &(queryprogram)& router
19489 is called from a non-root process, Exim cannot change uid or gid before running
19490 the command. In this circumstance the command runs under the current uid and
19491 gid.
19492
19493
19494 .option current_directory queryprogram string /
19495 This option specifies an absolute path which is made the current directory
19496 before running the command.
19497
19498
19499 .option timeout queryprogram time 1h
19500 If the command does not complete within the timeout period, its process group
19501 is killed and the message is frozen. A value of zero time specifies no
19502 timeout.
19503
19504
19505 The standard output of the command is connected to a pipe, which is read when
19506 the command terminates. It should consist of a single line of output,
19507 containing up to five fields, separated by white space. The maximum length of
19508 the line is 1023 characters. Longer lines are silently truncated. The first
19509 field is one of the following words (case-insensitive):
19510
19511 .ilist
19512 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19513 below).
19514 .next
19515 &'Decline'&: the router declines; pass the address to the next router, unless
19516 &%no_more%& is set.
19517 .next
19518 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19519 subsequent text on the line is an error message. If the router is run as part
19520 of address verification during an incoming SMTP message, the message is
19521 included in the SMTP response.
19522 .next
19523 &'Defer'&: routing could not be completed at this time; try again later. Any
19524 subsequent text on the line is an error message which is logged. It is not
19525 included in any SMTP response.
19526 .next
19527 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19528 .next
19529 &'Pass'&: pass the address to the next router (or the router specified by
19530 &%pass_router%&), overriding &%no_more%&.
19531 .next
19532 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19533 new addresses, which are routed independently, starting with the first router,
19534 or the router specified by &%redirect_router%&, if set.
19535 .endlist
19536
19537 When the first word is &'accept'&, the remainder of the line consists of a
19538 number of keyed data values, as follows (split into two lines here, to fit on
19539 the page):
19540 .code
19541 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19542 LOOKUP=byname|bydns DATA=<text>
19543 .endd
19544 The data items can be given in any order, and all are optional. If no transport
19545 is included, the transport specified by the generic &%transport%& option is
19546 used. The list of hosts and the lookup type are needed only if the transport is
19547 an &(smtp)& transport that does not itself supply a list of hosts.
19548
19549 The format of the list of hosts is the same as for the &(manualroute)& router.
19550 As well as host names and IP addresses with optional port numbers, as described
19551 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19552 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19553 (see section &<<SECThostshowused>>&).
19554
19555 If the lookup type is not specified, Exim behaves as follows when trying to
19556 find an IP address for each host: First, a DNS lookup is done. If this yields
19557 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19558 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19559 result of the lookup is the result of that call.
19560
19561 .vindex "&$address_data$&"
19562 If the DATA field is set, its value is placed in the &$address_data$&
19563 variable. For example, this return line
19564 .code
19565 accept hosts=x1.y.example:x2.y.example data="rule1"
19566 .endd
19567 routes the address to the default transport, passing a list of two hosts. When
19568 the transport runs, the string &"rule1"& is in &$address_data$&.
19569 .ecindex IIDquerou1
19570 .ecindex IIDquerou2
19571
19572
19573
19574
19575 . ////////////////////////////////////////////////////////////////////////////
19576 . ////////////////////////////////////////////////////////////////////////////
19577
19578 .chapter "The redirect router" "CHAPredirect"
19579 .scindex IIDredrou1 "&(redirect)& router"
19580 .scindex IIDredrou2 "routers" "&(redirect)&"
19581 .cindex "alias file" "in a &(redirect)& router"
19582 .cindex "address redirection" "&(redirect)& router"
19583 The &(redirect)& router handles several kinds of address redirection. Its most
19584 common uses are for resolving local part aliases from a central alias file
19585 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19586 files, but it has many other potential uses. The incoming address can be
19587 redirected in several different ways:
19588
19589 .ilist
19590 It can be replaced by one or more new addresses which are themselves routed
19591 independently.
19592 .next
19593 It can be routed to be delivered to a given file or directory.
19594 .next
19595 It can be routed to be delivered to a specified pipe command.
19596 .next
19597 It can cause an automatic reply to be generated.
19598 .next
19599 It can be forced to fail, optionally with a custom error message.
19600 .next
19601 It can be temporarily deferred, optionally with a custom message.
19602 .next
19603 It can be discarded.
19604 .endlist
19605
19606 The generic &%transport%& option must not be set for &(redirect)& routers.
19607 However, there are some private options which define transports for delivery to
19608 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19609 &%pipe_transport%& and &%reply_transport%& descriptions below.
19610
19611 If success DSNs have been requested
19612 .cindex "DSN" "success"
19613 .cindex "Delivery Status Notification" "success"
19614 redirection triggers one and the DSN options are not passed any further.
19615
19616
19617
19618 .section "Redirection data" "SECID124"
19619 The router operates by interpreting a text string which it obtains either by
19620 expanding the contents of the &%data%& option, or by reading the entire
19621 contents of a file whose name is given in the &%file%& option. These two
19622 options are mutually exclusive. The first is commonly used for handling system
19623 aliases, in a configuration like this:
19624 .code
19625 system_aliases:
19626   driver = redirect
19627   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19628 .endd
19629 If the lookup fails, the expanded string in this example is empty. When the
19630 expansion of &%data%& results in an empty string, the router declines. A forced
19631 expansion failure also causes the router to decline; other expansion failures
19632 cause delivery to be deferred.
19633
19634 A configuration using &%file%& is commonly used for handling users'
19635 &_.forward_& files, like this:
19636 .code
19637 userforward:
19638   driver = redirect
19639   check_local_user
19640   file = $home/.forward
19641   no_verify
19642 .endd
19643 If the file does not exist, or causes no action to be taken (for example, it is
19644 empty or consists only of comments), the router declines. &*Warning*&: This
19645 is not the case when the file contains syntactically valid items that happen to
19646 yield empty addresses, for example, items containing only RFC 2822 address
19647 comments.
19648
19649
19650
19651 .section "Forward files and address verification" "SECID125"
19652 .cindex "address redirection" "while verifying"
19653 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19654 &_.forward_& files, as in the example above. There are two reasons for this:
19655
19656 .ilist
19657 When Exim is receiving an incoming SMTP message from a remote host, it is
19658 running under the Exim uid, not as root. Exim is unable to change uid to read
19659 the file as the user, and it may not be able to read it as the Exim user. So in
19660 practice the router may not be able to operate.
19661 .next
19662 However, even when the router can operate, the existence of a &_.forward_& file
19663 is unimportant when verifying an address. What should be checked is whether the
19664 local part is a valid user name or not. Cutting out the redirection processing
19665 saves some resources.
19666 .endlist
19667
19668
19669
19670
19671
19672
19673 .section "Interpreting redirection data" "SECID126"
19674 .cindex "Sieve filter" "specifying in redirection data"
19675 .cindex "filter" "specifying in redirection data"
19676 The contents of the data string, whether obtained from &%data%& or &%file%&,
19677 can be interpreted in two different ways:
19678
19679 .ilist
19680 If the &%allow_filter%& option is set true, and the data begins with the text
19681 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19682 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19683 respectively. Details of the syntax and semantics of filter files are described
19684 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19685 document is intended for use by end users.
19686 .next
19687 Otherwise, the data must be a comma-separated list of redirection items, as
19688 described in the next section.
19689 .endlist
19690
19691 When a message is redirected to a file (a &"mail folder"&), the file name given
19692 in a non-filter redirection list must always be an absolute path. A filter may
19693 generate a relative path &-- how this is handled depends on the transport's
19694 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19695 for the &(appendfile)& transport.
19696
19697
19698
19699 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19700 .cindex "address redirection" "non-filter list items"
19701 When the redirection data is not an Exim or Sieve filter, for example, if it
19702 comes from a conventional alias or forward file, it consists of a list of
19703 addresses, file names, pipe commands, or certain special items (see section
19704 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19705 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19706 depending on their default values. The items in the list are separated by
19707 commas or newlines.
19708 If a comma is required in an item, the entire item must be enclosed in double
19709 quotes.
19710
19711 Lines starting with a # character are comments, and are ignored, and # may
19712 also appear following a comma, in which case everything between the # and the
19713 next newline character is ignored.
19714
19715 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19716 double quotes are retained because some forms of mail address require their use
19717 (but never to enclose the entire address). In the following description,
19718 &"item"& refers to what remains after any surrounding double quotes have been
19719 removed.
19720
19721 .vindex "&$local_part$&"
19722 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19723 and the expansion contains a reference to &$local_part$&, you should make use
19724 of the &%quote_local_part%& expansion operator, in case the local part contains
19725 special characters. For example, to redirect all mail for the domain
19726 &'obsolete.example'&, retaining the existing local part, you could use this
19727 setting:
19728 .code
19729 data = ${quote_local_part:$local_part}@newdomain.example
19730 .endd
19731
19732
19733 .section "Redirecting to a local mailbox" "SECTredlocmai"
19734 .cindex "routing" "loops in"
19735 .cindex "loop" "while routing, avoidance of"
19736 .cindex "address redirection" "to local mailbox"
19737 A redirection item may safely be the same as the address currently under
19738 consideration. This does not cause a routing loop, because a router is
19739 automatically skipped if any ancestor of the address that is being processed
19740 is the same as the current address and was processed by the current router.
19741 Such an address is therefore passed to the following routers, so it is handled
19742 as if there were no redirection. When making this loop-avoidance test, the
19743 complete local part, including any prefix or suffix, is used.
19744
19745 .cindex "address redirection" "local part without domain"
19746 Specifying the same local part without a domain is a common usage in personal
19747 filter files when the user wants to have messages delivered to the local
19748 mailbox and also forwarded elsewhere. For example, the user whose login is
19749 &'cleo'& might have a &_.forward_& file containing this:
19750 .code
19751 cleo, cleopatra@egypt.example
19752 .endd
19753 .cindex "backslash in alias file"
19754 .cindex "alias file" "backslash in"
19755 For compatibility with other MTAs, such unqualified local parts may be
19756 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19757 it does make a difference if more than one domain is being handled
19758 synonymously.
19759
19760 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19761 2822 address that does not include a domain, the item is qualified using the
19762 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19763 addresses are qualified using the value in &%qualify_recipient%&, but you can
19764 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19765
19766 Care must be taken if there are alias names for local users.
19767 Consider an MTA handling a single local domain where the system alias file
19768 contains:
19769 .code
19770 Sam.Reman: spqr
19771 .endd
19772 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19773 messages in the local mailbox, and also forward copies elsewhere. He creates
19774 this forward file:
19775 .code
19776 Sam.Reman, spqr@reme.elsewhere.example
19777 .endd
19778 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19779 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19780 second time round, because it has previously routed it,
19781 and the following routers presumably cannot handle the alias. The forward file
19782 should really contain
19783 .code
19784 spqr, spqr@reme.elsewhere.example
19785 .endd
19786 but because this is such a common error, the &%check_ancestor%& option (see
19787 below) exists to provide a way to get round it. This is normally set on a
19788 &(redirect)& router that is handling users' &_.forward_& files.
19789
19790
19791
19792 .section "Special items in redirection lists" "SECTspecitredli"
19793 In addition to addresses, the following types of item may appear in redirection
19794 lists (that is, in non-filter redirection data):
19795
19796 .ilist
19797 .cindex "pipe" "in redirection list"
19798 .cindex "address redirection" "to pipe"
19799 An item is treated as a pipe command if it begins with &"|"& and does not parse
19800 as a valid RFC 2822 address that includes a domain. A transport for running the
19801 command must be specified by the &%pipe_transport%& option.
19802 Normally, either the router or the transport specifies a user and a group under
19803 which to run the delivery. The default is to use the Exim user and group.
19804
19805 Single or double quotes can be used for enclosing the individual arguments of
19806 the pipe command; no interpretation of escapes is done for single quotes. If
19807 the command contains a comma character, it is necessary to put the whole item
19808 in double quotes, for example:
19809 .code
19810 "|/some/command ready,steady,go"
19811 .endd
19812 since items in redirection lists are terminated by commas. Do not, however,
19813 quote just the command. An item such as
19814 .code
19815 |"/some/command ready,steady,go"
19816 .endd
19817 is interpreted as a pipe with a rather strange command name, and no arguments.
19818
19819 Note that the above example assumes that the text comes from a lookup source
19820 of some sort, so that the quotes are part of the data.  If composing a
19821 redirect router with a &%data%& option directly specifying this command, the
19822 quotes will be used by the configuration parser to define the extent of one
19823 string, but will not be passed down into the redirect router itself.  There
19824 are two main approaches to get around this: escape quotes to be part of the
19825 data itself, or avoid using this mechanism and instead create a custom
19826 transport with the &%command%& option set and reference that transport from
19827 an &%accept%& router.
19828
19829 .next
19830 .cindex "file" "in redirection list"
19831 .cindex "address redirection" "to file"
19832 An item is interpreted as a path name if it begins with &"/"& and does not
19833 parse as a valid RFC 2822 address that includes a domain. For example,
19834 .code
19835 /home/world/minbari
19836 .endd
19837 is treated as a file name, but
19838 .code
19839 /s=molari/o=babylon/@x400gate.way
19840 .endd
19841 is treated as an address. For a file name, a transport must be specified using
19842 the &%file_transport%& option. However, if the generated path name ends with a
19843 forward slash character, it is interpreted as a directory name rather than a
19844 file name, and &%directory_transport%& is used instead.
19845
19846 Normally, either the router or the transport specifies a user and a group under
19847 which to run the delivery. The default is to use the Exim user and group.
19848
19849 .cindex "&_/dev/null_&"
19850 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19851 bypassed at a high level, and the log entry shows &"**bypassed**"&
19852 instead of a transport name. In this case the user and group are not used.
19853
19854 .next
19855 .cindex "included address list"
19856 .cindex "address redirection" "included external list"
19857 If an item is of the form
19858 .code
19859 :include:<path name>
19860 .endd
19861 a list of further items is taken from the given file and included at that
19862 point. &*Note*&: Such a file can not be a filter file; it is just an
19863 out-of-line addition to the list. The items in the included list are separated
19864 by commas or newlines and are not subject to expansion. If this is the first
19865 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19866 the alias name. This example is incorrect:
19867 .code
19868 list1    :include:/opt/lists/list1
19869 .endd
19870 It must be given as
19871 .code
19872 list1:   :include:/opt/lists/list1
19873 .endd
19874 .next
19875 .cindex "address redirection" "to black hole"
19876 Sometimes you want to throw away mail to a particular local part. Making the
19877 &%data%& option expand to an empty string does not work, because that causes
19878 the router to decline. Instead, the alias item
19879 .cindex "black hole"
19880 .cindex "abandoning mail"
19881 &':blackhole:'& can be used. It does what its name implies. No delivery is
19882 done, and no error message is generated. This has the same effect as specifying
19883 &_/dev/null_& as a destination, but it can be independently disabled.
19884
19885 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19886 delivery is done for the original local part, even if other redirection items
19887 are present. If you are generating a multi-item list (for example, by reading a
19888 database) and need the ability to provide a no-op item, you must use
19889 &_/dev/null_&.
19890
19891 .next
19892 .cindex "delivery" "forcing failure"
19893 .cindex "delivery" "forcing deferral"
19894 .cindex "failing delivery" "forcing"
19895 .cindex "deferred delivery, forcing"
19896 .cindex "customizing" "failure message"
19897 An attempt to deliver a particular address can be deferred or forced to fail by
19898 redirection items of the form
19899 .code
19900 :defer:
19901 :fail:
19902 .endd
19903 respectively. When a redirection list contains such an item, it applies
19904 to the entire redirection; any other items in the list are ignored. Any
19905 text following &':fail:'& or &':defer:'& is placed in the error text
19906 associated with the failure. For example, an alias file might contain:
19907 .code
19908 X.Employee:  :fail: Gone away, no forwarding address
19909 .endd
19910 In the case of an address that is being verified from an ACL or as the subject
19911 of a
19912 .cindex "VRFY" "error text, display of"
19913 VRFY command, the text is included in the SMTP error response by
19914 default.
19915 .cindex "EXPN" "error text, display of"
19916 The text is not included in the response to an EXPN command. In non-SMTP cases
19917 the text is included in the error message that Exim generates.
19918
19919 .cindex "SMTP" "error codes"
19920 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19921 &':fail:'&. However, if the message starts with three digits followed by a
19922 space, optionally followed by an extended code of the form &'n.n.n'&, also
19923 followed by a space, and the very first digit is the same as the default error
19924 code, the code from the message is used instead. If the very first digit is
19925 incorrect, a panic error is logged, and the default code is used. You can
19926 suppress the use of the supplied code in a redirect router by setting the
19927 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19928 ignored.
19929
19930 .vindex "&$acl_verify_message$&"
19931 In an ACL, an explicitly provided message overrides the default, but the
19932 default message is available in the variable &$acl_verify_message$& and can
19933 therefore be included in a custom message if this is desired.
19934
19935 Normally the error text is the rest of the redirection list &-- a comma does
19936 not terminate it &-- but a newline does act as a terminator. Newlines are not
19937 normally present in alias expansions. In &(lsearch)& lookups they are removed
19938 as part of the continuation process, but they may exist in other kinds of
19939 lookup and in &':include:'& files.
19940
19941 During routing for message delivery (as opposed to verification), a redirection
19942 containing &':fail:'& causes an immediate failure of the incoming address,
19943 whereas &':defer:'& causes the message to remain on the queue so that a
19944 subsequent delivery attempt can happen at a later time. If an address is
19945 deferred for too long, it will ultimately fail, because the normal retry
19946 rules still apply.
19947
19948 .next
19949 .cindex "alias file" "exception to default"
19950 Sometimes it is useful to use a single-key search type with a default (see
19951 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19952 for exceptions to the default. These can be handled by aliasing them to
19953 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19954 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19955 results in an empty redirection list has the same effect.
19956 .endlist
19957
19958
19959 .section "Duplicate addresses" "SECTdupaddr"
19960 .cindex "duplicate addresses"
19961 .cindex "address duplicate, discarding"
19962 .cindex "pipe" "duplicated"
19963 Exim removes duplicate addresses from the list to which it is delivering, so as
19964 to deliver just one copy to each address. This does not apply to deliveries
19965 routed to pipes by different immediate parent addresses, but an indirect
19966 aliasing scheme of the type
19967 .code
19968 pipe:       |/some/command $local_part
19969 localpart1: pipe
19970 localpart2: pipe
19971 .endd
19972 does not work with a message that is addressed to both local parts, because
19973 when the second is aliased to the intermediate local part &"pipe"& it gets
19974 discarded as being the same as a previously handled address. However, a scheme
19975 such as
19976 .code
19977 localpart1: |/some/command $local_part
19978 localpart2: |/some/command $local_part
19979 .endd
19980 does result in two different pipe deliveries, because the immediate parents of
19981 the pipes are distinct.
19982
19983
19984
19985 .section "Repeated redirection expansion" "SECID128"
19986 .cindex "repeated redirection expansion"
19987 .cindex "address redirection" "repeated for each delivery attempt"
19988 When a message cannot be delivered to all of its recipients immediately,
19989 leading to two or more delivery attempts, redirection expansion is carried out
19990 afresh each time for those addresses whose children were not all previously
19991 delivered. If redirection is being used as a mailing list, this can lead to new
19992 members of the list receiving copies of old messages. The &%one_time%& option
19993 can be used to avoid this.
19994
19995
19996 .section "Errors in redirection lists" "SECID129"
19997 .cindex "address redirection" "errors"
19998 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19999 error is skipped, and an entry is written to the main log. This may be useful
20000 for mailing lists that are automatically managed. Otherwise, if an error is
20001 detected while generating the list of new addresses, the original address is
20002 deferred. See also &%syntax_errors_to%&.
20003
20004
20005
20006 .section "Private options for the redirect router" "SECID130"
20007
20008 .cindex "options" "&(redirect)& router"
20009 The private options for the &(redirect)& router are as follows:
20010
20011
20012 .option allow_defer redirect boolean false
20013 Setting this option allows the use of &':defer:'& in non-filter redirection
20014 data, or the &%defer%& command in an Exim filter file.
20015
20016
20017 .option allow_fail redirect boolean false
20018 .cindex "failing delivery" "from filter"
20019 If this option is true, the &':fail:'& item can be used in a redirection list,
20020 and the &%fail%& command may be used in an Exim filter file.
20021
20022
20023 .option allow_filter redirect boolean false
20024 .cindex "filter" "enabling use of"
20025 .cindex "Sieve filter" "enabling use of"
20026 Setting this option allows Exim to interpret redirection data that starts with
20027 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20028 are some features of Exim filter files that some administrators may wish to
20029 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20030
20031 It is also possible to lock out Exim filters or Sieve filters while allowing
20032 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20033
20034
20035 The filter is run using the uid and gid set by the generic &%user%& and
20036 &%group%& options. These take their defaults from the password data if
20037 &%check_local_user%& is set, so in the normal case of users' personal filter
20038 files, the filter is run as the relevant user. When &%allow_filter%& is set
20039 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20040
20041
20042
20043 .option allow_freeze redirect boolean false
20044 .cindex "freezing messages" "allowing in filter"
20045 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20046 This command is more normally encountered in system filters, and is disabled by
20047 default for redirection filters because it isn't something you usually want to
20048 let ordinary users do.
20049
20050
20051
20052 .option check_ancestor redirect boolean false
20053 This option is concerned with handling generated addresses that are the same
20054 as some address in the list of redirection ancestors of the current address.
20055 Although it is turned off by default in the code, it is set in the default
20056 configuration file for handling users' &_.forward_& files. It is recommended
20057 for this use of the &(redirect)& router.
20058
20059 When &%check_ancestor%& is set, if a generated address (including the domain)
20060 is the same as any ancestor of the current address, it is replaced by a copy of
20061 the current address. This helps in the case where local part A is aliased to B,
20062 and B has a &_.forward_& file pointing back to A. For example, within a single
20063 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20064 &_&~jb/.forward_& contains:
20065 .code
20066 \Joe.Bloggs, <other item(s)>
20067 .endd
20068 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20069 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20070 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20071 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20072 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20073 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20074 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20075 original address. See also the &%repeat_use%& option below.
20076
20077
20078 .option check_group redirect boolean "see below"
20079 When the &%file%& option is used, the group owner of the file is checked only
20080 when this option is set. The permitted groups are those listed in the
20081 &%owngroups%& option, together with the user's default group if
20082 &%check_local_user%& is set. If the file has the wrong group, routing is
20083 deferred. The default setting for this option is true if &%check_local_user%&
20084 is set and the &%modemask%& option permits the group write bit, or if the
20085 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20086
20087
20088
20089 .option check_owner redirect boolean "see below"
20090 When the &%file%& option is used, the owner of the file is checked only when
20091 this option is set. If &%check_local_user%& is set, the local user is
20092 permitted; otherwise the owner must be one of those listed in the &%owners%&
20093 option. The default value for this option is true if &%check_local_user%& or
20094 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20095
20096
20097 .option data redirect string&!! unset
20098 This option is mutually exclusive with &%file%&. One or other of them must be
20099 set, but not both. The contents of &%data%& are expanded, and then used as the
20100 list of forwarding items, or as a set of filtering instructions. If the
20101 expansion is forced to fail, or the result is an empty string or a string that
20102 has no effect (consists entirely of comments), the router declines.
20103
20104 When filtering instructions are used, the string must begin with &"#Exim
20105 filter"&, and all comments in the string, including this initial one, must be
20106 terminated with newline characters. For example:
20107 .code
20108 data = #Exim filter\n\
20109        if $h_to: contains Exim then save $home/mail/exim endif
20110 .endd
20111 If you are reading the data from a database where newlines cannot be included,
20112 you can use the &${sg}$& expansion item to turn the escape string of your
20113 choice into a newline.
20114
20115
20116 .option directory_transport redirect string&!! unset
20117 A &(redirect)& router sets up a direct delivery to a directory when a path name
20118 ending with a slash is specified as a new &"address"&. The transport used is
20119 specified by this option, which, after expansion, must be the name of a
20120 configured transport. This should normally be an &(appendfile)& transport.
20121
20122
20123 .option file redirect string&!! unset
20124 This option specifies the name of a file that contains the redirection data. It
20125 is mutually exclusive with the &%data%& option. The string is expanded before
20126 use; if the expansion is forced to fail, the router declines. Other expansion
20127 failures cause delivery to be deferred. The result of a successful expansion
20128 must be an absolute path. The entire file is read and used as the redirection
20129 data. If the data is an empty string or a string that has no effect (consists
20130 entirely of comments), the router declines.
20131
20132 .cindex "NFS" "checking for file existence"
20133 If the attempt to open the file fails with a &"does not exist"& error, Exim
20134 runs a check on the containing directory,
20135 unless &%ignore_enotdir%& is true (see below).
20136 If the directory does not appear to exist, delivery is deferred. This can
20137 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20138 is a mount problem. If the containing directory does exist, but the file does
20139 not, the router declines.
20140
20141
20142 .option file_transport redirect string&!! unset
20143 .vindex "&$address_file$&"
20144 A &(redirect)& router sets up a direct delivery to a file when a path name not
20145 ending in a slash is specified as a new &"address"&. The transport used is
20146 specified by this option, which, after expansion, must be the name of a
20147 configured transport. This should normally be an &(appendfile)& transport. When
20148 it is running, the file name is in &$address_file$&.
20149
20150
20151 .option filter_prepend_home redirect boolean true
20152 When this option is true, if a &(save)& command in an Exim filter specifies a
20153 relative path, and &$home$& is defined, it is automatically prepended to the
20154 relative path. If this option is set false, this action does not happen. The
20155 relative path is then passed to the transport unmodified.
20156
20157
20158 .option forbid_blackhole redirect boolean false
20159 If this option is true, the &':blackhole:'& item may not appear in a
20160 redirection list.
20161
20162
20163 .option forbid_exim_filter redirect boolean false
20164 If this option is set true, only Sieve filters are permitted when
20165 &%allow_filter%& is true.
20166
20167
20168
20169
20170 .option forbid_file redirect boolean false
20171 .cindex "delivery" "to file; forbidding"
20172 .cindex "Sieve filter" "forbidding delivery to a file"
20173 .cindex "Sieve filter" "&""keep""& facility; disabling"
20174 If this option is true, this router may not generate a new address that
20175 specifies delivery to a local file or directory, either from a filter or from a
20176 conventional forward file. This option is forced to be true if &%one_time%& is
20177 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20178 locks out the Sieve's &"keep"& facility.
20179
20180
20181 .option forbid_filter_dlfunc redirect boolean false
20182 .cindex "filter" "locking out certain features"
20183 If this option is true, string expansions in Exim filters are not allowed to
20184 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20185 functions.
20186
20187 .option forbid_filter_existstest redirect boolean false
20188 .cindex "expansion" "statting a file"
20189 If this option is true, string expansions in Exim filters are not allowed to
20190 make use of the &%exists%& condition or the &%stat%& expansion item.
20191
20192 .option forbid_filter_logwrite redirect boolean false
20193 If this option is true, use of the logging facility in Exim filters is not
20194 permitted. Logging is in any case available only if the filter is being run
20195 under some unprivileged uid (which is normally the case for ordinary users'
20196 &_.forward_& files).
20197
20198
20199 .option forbid_filter_lookup redirect boolean false
20200 If this option is true, string expansions in Exim filter files are not allowed
20201 to make use of &%lookup%& items.
20202
20203
20204 .option forbid_filter_perl redirect boolean false
20205 This option has an effect only if Exim is built with embedded Perl support. If
20206 it is true, string expansions in Exim filter files are not allowed to make use
20207 of the embedded Perl support.
20208
20209
20210 .option forbid_filter_readfile redirect boolean false
20211 If this option is true, string expansions in Exim filter files are not allowed
20212 to make use of &%readfile%& items.
20213
20214
20215 .option forbid_filter_readsocket redirect boolean false
20216 If this option is true, string expansions in Exim filter files are not allowed
20217 to make use of &%readsocket%& items.
20218
20219
20220 .option forbid_filter_reply redirect boolean false
20221 If this option is true, this router may not generate an automatic reply
20222 message. Automatic replies can be generated only from Exim or Sieve filter
20223 files, not from traditional forward files. This option is forced to be true if
20224 &%one_time%& is set.
20225
20226
20227 .option forbid_filter_run redirect boolean false
20228 If this option is true, string expansions in Exim filter files are not allowed
20229 to make use of &%run%& items.
20230
20231
20232 .option forbid_include redirect boolean false
20233 If this option is true, items of the form
20234 .code
20235 :include:<path name>
20236 .endd
20237 are not permitted in non-filter redirection lists.
20238
20239
20240 .option forbid_pipe redirect boolean false
20241 .cindex "delivery" "to pipe; forbidding"
20242 If this option is true, this router may not generate a new address which
20243 specifies delivery to a pipe, either from an Exim filter or from a conventional
20244 forward file. This option is forced to be true if &%one_time%& is set.
20245
20246
20247 .option forbid_sieve_filter redirect boolean false
20248 If this option is set true, only Exim filters are permitted when
20249 &%allow_filter%& is true.
20250
20251
20252 .cindex "SMTP" "error codes"
20253 .option forbid_smtp_code redirect boolean false
20254 If this option is set true, any SMTP error codes that are present at the start
20255 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20256 the default codes (451 and 550, respectively) are always used.
20257
20258
20259
20260
20261 .option hide_child_in_errmsg redirect boolean false
20262 .cindex "bounce message" "redirection details; suppressing"
20263 If this option is true, it prevents Exim from quoting a child address if it
20264 generates a bounce or delay message for it. Instead it says &"an address
20265 generated from <&'the top level address'&>"&. Of course, this applies only to
20266 bounces generated locally. If a message is forwarded to another host, &'its'&
20267 bounce may well quote the generated address.
20268
20269
20270 .option ignore_eacces redirect boolean false
20271 .cindex "EACCES"
20272 If this option is set and an attempt to open a redirection file yields the
20273 EACCES error (permission denied), the &(redirect)& router behaves as if the
20274 file did not exist.
20275
20276
20277 .option ignore_enotdir redirect boolean false
20278 .cindex "ENOTDIR"
20279 If this option is set and an attempt to open a redirection file yields the
20280 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20281 router behaves as if the file did not exist.
20282
20283 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20284 router that has the &%file%& option set discovers that the file does not exist
20285 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20286 against unmounted NFS directories. If the parent can not be statted, delivery
20287 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20288 is set, because that option tells Exim to ignore &"something on the path is not
20289 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20290 that some operating systems give ENOENT where others give ENOTDIR.
20291
20292
20293
20294 .option include_directory redirect string unset
20295 If this option is set, the path names of any &':include:'& items in a
20296 redirection list must start with this directory.
20297
20298
20299 .option modemask redirect "octal integer" 022
20300 This specifies mode bits which must not be set for a file specified by the
20301 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20302
20303
20304 .option one_time redirect boolean false
20305 .cindex "one-time aliasing/forwarding expansion"
20306 .cindex "alias file" "one-time expansion"
20307 .cindex "forward file" "one-time expansion"
20308 .cindex "mailing lists" "one-time expansion"
20309 .cindex "address redirection" "one-time expansion"
20310 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20311 files each time it tries to deliver a message causes a problem when one or more
20312 of the generated addresses fails be delivered at the first attempt. The problem
20313 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20314 but of what happens when the redirection list changes during the time that the
20315 message is on Exim's queue. This is particularly true in the case of mailing
20316 lists, where new subscribers might receive copies of messages that were posted
20317 before they subscribed.
20318
20319 If &%one_time%& is set and any addresses generated by the router fail to
20320 deliver at the first attempt, the failing addresses are added to the message as
20321 &"top level"& addresses, and the parent address that generated them is marked
20322 &"delivered"&. Thus, redirection does not happen again at the next delivery
20323 attempt.
20324
20325 &*Warning 1*&: Any header line addition or removal that is specified by this
20326 router would be lost if delivery did not succeed at the first attempt. For this
20327 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20328 permitted when &%one_time%& is set.
20329
20330 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20331 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20332 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20333
20334 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20335 &%one_time%&.
20336
20337 The original top-level address is remembered with each of the generated
20338 addresses, and is output in any log messages. However, any intermediate parent
20339 addresses are not recorded. This makes a difference to the log only if
20340 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20341 typically be used for mailing lists, where there is normally just one level of
20342 expansion.
20343
20344
20345 .option owners redirect "string list" unset
20346 .cindex "ownership" "alias file"
20347 .cindex "ownership" "forward file"
20348 .cindex "alias file" "ownership"
20349 .cindex "forward file" "ownership"
20350 This specifies a list of permitted owners for the file specified by &%file%&.
20351 This list is in addition to the local user when &%check_local_user%& is set.
20352 See &%check_owner%& above.
20353
20354
20355 .option owngroups redirect "string list" unset
20356 This specifies a list of permitted groups for the file specified by &%file%&.
20357 The list is in addition to the local user's primary group when
20358 &%check_local_user%& is set. See &%check_group%& above.
20359
20360
20361 .option pipe_transport redirect string&!! unset
20362 .vindex "&$address_pipe$&"
20363 A &(redirect)& router sets up a direct delivery to a pipe when a string
20364 starting with a vertical bar character is specified as a new &"address"&. The
20365 transport used is specified by this option, which, after expansion, must be the
20366 name of a configured transport. This should normally be a &(pipe)& transport.
20367 When the transport is run, the pipe command is in &$address_pipe$&.
20368
20369
20370 .option qualify_domain redirect string&!! unset
20371 .vindex "&$qualify_recipient$&"
20372 If this option is set, and an unqualified address (one without a domain) is
20373 generated, and that address would normally be qualified by the global setting
20374 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20375 expanding this string. If the expansion fails, the router declines. If you want
20376 to revert to the default, you can have the expansion generate
20377 &$qualify_recipient$&.
20378
20379 This option applies to all unqualified addresses generated by Exim filters,
20380 but for traditional &_.forward_& files, it applies only to addresses that are
20381 not preceded by a backslash. Sieve filters cannot generate unqualified
20382 addresses.
20383
20384 .option qualify_preserve_domain redirect boolean false
20385 .cindex "domain" "in redirection; preserving"
20386 .cindex "preserving domain in redirection"
20387 .cindex "address redirection" "domain; preserving"
20388 If this option is set, the router's local &%qualify_domain%& option must not be
20389 set (a configuration error occurs if it is). If an unqualified address (one
20390 without a domain) is generated, it is qualified with the domain of the parent
20391 address (the immediately preceding ancestor) instead of the global
20392 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20393 this applies whether or not the address is preceded by a backslash.
20394
20395
20396 .option repeat_use redirect boolean true
20397 If this option is set false, the router is skipped for a child address that has
20398 any ancestor that was routed by this router. This test happens before any of
20399 the other preconditions are tested. Exim's default anti-looping rules skip
20400 only when the ancestor is the same as the current address. See also
20401 &%check_ancestor%& above and the generic &%redirect_router%& option.
20402
20403
20404 .option reply_transport redirect string&!! unset
20405 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20406 &%vacation%& command is used in a filter file. The transport used is specified
20407 by this option, which, after expansion, must be the name of a configured
20408 transport. This should normally be an &(autoreply)& transport. Other transports
20409 are unlikely to do anything sensible or useful.
20410
20411
20412 .option rewrite redirect boolean true
20413 .cindex "address redirection" "disabling rewriting"
20414 If this option is set false, addresses generated by the router are not
20415 subject to address rewriting. Otherwise, they are treated like new addresses
20416 and are rewritten according to the global rewriting rules.
20417
20418
20419 .option sieve_subaddress redirect string&!! unset
20420 The value of this option is passed to a Sieve filter to specify the
20421 :subaddress part of an address.
20422
20423 .option sieve_useraddress redirect string&!! unset
20424 The value of this option is passed to a Sieve filter to specify the :user part
20425 of an address. However, if it is unset, the entire original local part
20426 (including any prefix or suffix) is used for :user.
20427
20428
20429 .option sieve_vacation_directory redirect string&!! unset
20430 .cindex "Sieve filter" "vacation directory"
20431 To enable the &"vacation"& extension for Sieve filters, you must set
20432 &%sieve_vacation_directory%& to the directory where vacation databases are held
20433 (do not put anything else in that directory), and ensure that the
20434 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20435 needs their own directory; Exim will create it if necessary.
20436
20437
20438
20439 .option skip_syntax_errors redirect boolean false
20440 .cindex "forward file" "broken"
20441 .cindex "address redirection" "broken files"
20442 .cindex "alias file" "broken"
20443 .cindex "broken alias or forward files"
20444 .cindex "ignoring faulty addresses"
20445 .cindex "skipping faulty addresses"
20446 .cindex "error" "skipping bad syntax"
20447 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20448 non-filter redirection data are skipped, and each failing address is logged. If
20449 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20450 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20451 are expanded and placed at the head of the error message generated by
20452 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20453 be the same address as the generic &%errors_to%& option. The
20454 &%skip_syntax_errors%& option is often used when handling mailing lists.
20455
20456 If all the addresses in a redirection list are skipped because of syntax
20457 errors, the router declines to handle the original address, and it is passed to
20458 the following routers.
20459
20460 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20461 error in the filter causes filtering to be abandoned without any action being
20462 taken. The incident is logged, and the router declines to handle the address,
20463 so it is passed to the following routers.
20464
20465 .cindex "Sieve filter" "syntax errors in"
20466 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20467 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20468 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20469
20470 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20471 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20472 option, used with an address that does not get redirected, can be used to
20473 notify users of these errors, by means of a router like this:
20474 .code
20475 userforward:
20476   driver = redirect
20477   allow_filter
20478   check_local_user
20479   file = $home/.forward
20480   file_transport = address_file
20481   pipe_transport = address_pipe
20482   reply_transport = address_reply
20483   no_verify
20484   skip_syntax_errors
20485   syntax_errors_to = real-$local_part@$domain
20486   syntax_errors_text = \
20487    This is an automatically generated message. An error has\n\
20488    been found in your .forward file. Details of the error are\n\
20489    reported below. While this error persists, you will receive\n\
20490    a copy of this message for every message that is addressed\n\
20491    to you. If your .forward file is a filter file, or if it is\n\
20492    a non-filter file containing no valid forwarding addresses,\n\
20493    a copy of each incoming message will be put in your normal\n\
20494    mailbox. If a non-filter file contains at least one valid\n\
20495    forwarding address, forwarding to the valid addresses will\n\
20496    happen, and those will be the only deliveries that occur.
20497 .endd
20498 You also need a router to ensure that local addresses that are prefixed by
20499 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20500 put this immediately before the &(userforward)& router:
20501 .code
20502 real_localuser:
20503   driver = accept
20504   check_local_user
20505   local_part_prefix = real-
20506   transport = local_delivery
20507 .endd
20508 For security, it would probably be a good idea to restrict the use of this
20509 router to locally-generated messages, using a condition such as this:
20510 .code
20511   condition = ${if match {$sender_host_address}\
20512                          {\N^(|127\.0\.0\.1)$\N}}
20513 .endd
20514
20515
20516 .option syntax_errors_text redirect string&!! unset
20517 See &%skip_syntax_errors%& above.
20518
20519
20520 .option syntax_errors_to redirect string unset
20521 See &%skip_syntax_errors%& above.
20522 .ecindex IIDredrou1
20523 .ecindex IIDredrou2
20524
20525
20526
20527
20528
20529
20530 . ////////////////////////////////////////////////////////////////////////////
20531 . ////////////////////////////////////////////////////////////////////////////
20532
20533 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20534          "Environment for local transports"
20535 .scindex IIDenvlotra1 "local transports" "environment for"
20536 .scindex IIDenvlotra2 "environment" "local transports"
20537 .scindex IIDenvlotra3 "transport" "local; environment for"
20538 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20539 transport can be thought of as similar to a pipe.) Exim always runs transports
20540 in subprocesses, under specified uids and gids. Typical deliveries to local
20541 mailboxes run under the uid and gid of the local user.
20542
20543 Exim also sets a specific current directory while running the transport; for
20544 some transports a home directory setting is also relevant. The &(pipe)&
20545 transport is the only one that sets up environment variables; see section
20546 &<<SECTpipeenv>>& for details.
20547
20548 The values used for the uid, gid, and the directories may come from several
20549 different places. In many cases, the router that handles the address associates
20550 settings with that address as a result of its &%check_local_user%&, &%group%&,
20551 or &%user%& options. However, values may also be given in the transport's own
20552 configuration, and these override anything that comes from the router.
20553
20554
20555
20556 .section "Concurrent deliveries" "SECID131"
20557 .cindex "concurrent deliveries"
20558 .cindex "simultaneous deliveries"
20559 If two different messages for the same local recipient arrive more or less
20560 simultaneously, the two delivery processes are likely to run concurrently. When
20561 the &(appendfile)& transport is used to write to a file, Exim applies locking
20562 rules to stop concurrent processes from writing to the same file at the same
20563 time.
20564
20565 However, when you use a &(pipe)& transport, it is up to you to arrange any
20566 locking that is needed. Here is a silly example:
20567 .code
20568 my_transport:
20569   driver = pipe
20570   command = /bin/sh -c 'cat >>/some/file'
20571 .endd
20572 This is supposed to write the message at the end of the file. However, if two
20573 messages arrive at the same time, the file will be scrambled. You can use the
20574 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20575 file using the same algorithm that Exim itself uses.
20576
20577
20578
20579
20580 .section "Uids and gids" "SECTenvuidgid"
20581 .cindex "local transports" "uid and gid"
20582 .cindex "transport" "local; uid and gid"
20583 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20584 overrides any group that the router set in the address, even if &%user%& is not
20585 set for the transport. This makes it possible, for example, to run local mail
20586 delivery under the uid of the recipient (set by the router), but in a special
20587 group (set by the transport). For example:
20588 .code
20589 # Routers ...
20590 # User/group are set by check_local_user in this router
20591 local_users:
20592   driver = accept
20593   check_local_user
20594   transport = group_delivery
20595
20596 # Transports ...
20597 # This transport overrides the group
20598 group_delivery:
20599   driver = appendfile
20600   file = /var/spool/mail/$local_part
20601   group = mail
20602 .endd
20603 If &%user%& is set for a transport, its value overrides what is set in the
20604 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20605 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20606 set.
20607
20608 .oindex "&%initgroups%&"
20609 When the uid is taken from the transport's configuration, the &[initgroups()]&
20610 function is called for the groups associated with that uid if the
20611 &%initgroups%& option is set for the transport. When the uid is not specified
20612 by the transport, but is associated with the address by a router, the option
20613 for calling &[initgroups()]& is taken from the router configuration.
20614
20615 .cindex "&(pipe)& transport" "uid for"
20616 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20617 is set and &%user%& is not set, the uid of the process that called Exim to
20618 receive the message is used, and if &%group%& is not set, the corresponding
20619 original gid is also used.
20620
20621 This is the detailed preference order for obtaining a gid; the first of the
20622 following that is set is used:
20623
20624 .ilist
20625 A &%group%& setting of the transport;
20626 .next
20627 A &%group%& setting of the router;
20628 .next
20629 A gid associated with a user setting of the router, either as a result of
20630 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20631 .next
20632 The group associated with a non-numeric &%user%& setting of the transport;
20633 .next
20634 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20635 the uid is the creator's uid;
20636 .next
20637 The Exim gid if the Exim uid is being used as a default.
20638 .endlist
20639
20640 If, for example, the user is specified numerically on the router and there are
20641 no group settings, no gid is available. In this situation, an error occurs.
20642 This is different for the uid, for which there always is an ultimate default.
20643 The first of the following that is set is used:
20644
20645 .ilist
20646 A &%user%& setting of the transport;
20647 .next
20648 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20649 .next
20650 A &%user%& setting of the router;
20651 .next
20652 A &%check_local_user%& setting of the router;
20653 .next
20654 The Exim uid.
20655 .endlist
20656
20657 Of course, an error will still occur if the uid that is chosen is on the
20658 &%never_users%& list.
20659
20660
20661
20662
20663
20664 .section "Current and home directories" "SECID132"
20665 .cindex "current directory for local transport"
20666 .cindex "home directory" "for local transport"
20667 .cindex "transport" "local; home directory for"
20668 .cindex "transport" "local; current directory for"
20669 Routers may set current and home directories for local transports by means of
20670 the &%transport_current_directory%& and &%transport_home_directory%& options.
20671 However, if the transport's &%current_directory%& or &%home_directory%& options
20672 are set, they override the router's values. In detail, the home directory
20673 for a local transport is taken from the first of these values that is set:
20674
20675 .ilist
20676 The &%home_directory%& option on the transport;
20677 .next
20678 The &%transport_home_directory%& option on the router;
20679 .next
20680 The password data if &%check_local_user%& is set on the router;
20681 .next
20682 The &%router_home_directory%& option on the router.
20683 .endlist
20684
20685 The current directory is taken from the first of these values that is set:
20686
20687 .ilist
20688 The &%current_directory%& option on the transport;
20689 .next
20690 The &%transport_current_directory%& option on the router.
20691 .endlist
20692
20693
20694 If neither the router nor the transport sets a current directory, Exim uses the
20695 value of the home directory, if it is set. Otherwise it sets the current
20696 directory to &_/_& before running a local transport.
20697
20698
20699
20700 .section "Expansion variables derived from the address" "SECID133"
20701 .vindex "&$domain$&"
20702 .vindex "&$local_part$&"
20703 .vindex "&$original_domain$&"
20704 Normally a local delivery is handling a single address, and in that case the
20705 variables such as &$domain$& and &$local_part$& are set during local
20706 deliveries. However, in some circumstances more than one address may be handled
20707 at once (for example, while writing batch SMTP for onward transmission by some
20708 other means). In this case, the variables associated with the local part are
20709 never set, &$domain$& is set only if all the addresses have the same domain,
20710 and &$original_domain$& is never set.
20711 .ecindex IIDenvlotra1
20712 .ecindex IIDenvlotra2
20713 .ecindex IIDenvlotra3
20714
20715
20716
20717
20718
20719
20720
20721 . ////////////////////////////////////////////////////////////////////////////
20722 . ////////////////////////////////////////////////////////////////////////////
20723
20724 .chapter "Generic options for transports" "CHAPtransportgeneric"
20725 .scindex IIDgenoptra1 "generic options" "transport"
20726 .scindex IIDgenoptra2 "options" "generic; for transports"
20727 .scindex IIDgenoptra3 "transport" "generic options for"
20728 The following generic options apply to all transports:
20729
20730
20731 .option body_only transports boolean false
20732 .cindex "transport" "body only"
20733 .cindex "message" "transporting body only"
20734 .cindex "body of message" "transporting"
20735 If this option is set, the message's headers are not transported. It is
20736 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20737 or &(pipe)& transports, the settings of &%message_prefix%& and
20738 &%message_suffix%& should be checked, because this option does not
20739 automatically suppress them.
20740
20741
20742 .option current_directory transports string&!! unset
20743 .cindex "transport" "current directory for"
20744 This specifies the current directory that is to be set while running the
20745 transport, overriding any value that may have been set by the router.
20746 If the expansion fails for any reason, including forced failure, an error is
20747 logged, and delivery is deferred.
20748
20749
20750 .option disable_logging transports boolean false
20751 If this option is set true, nothing is logged for any
20752 deliveries by the transport or for any
20753 transport errors. You should not set this option unless you really, really know
20754 what you are doing.
20755
20756
20757 .option debug_print transports string&!! unset
20758 .cindex "testing" "variables in drivers"
20759 If this option is set and debugging is enabled (see the &%-d%& command line
20760 option), the string is expanded and included in the debugging output when the
20761 transport is run.
20762 If expansion of the string fails, the error message is written to the debugging
20763 output, and Exim carries on processing.
20764 This facility is provided to help with checking out the values of variables and
20765 so on when debugging driver configurations. For example, if a &%headers_add%&
20766 option is not working properly, &%debug_print%& could be used to output the
20767 variables it references. A newline is added to the text if it does not end with
20768 one.
20769 The variables &$transport_name$& and &$router_name$& contain the name of the
20770 transport and the router that called it.
20771
20772 .option delivery_date_add transports boolean false
20773 .cindex "&'Delivery-date:'& header line"
20774 If this option is true, a &'Delivery-date:'& header is added to the message.
20775 This gives the actual time the delivery was made. As this is not a standard
20776 header, Exim has a configuration option (&%delivery_date_remove%&) which
20777 requests its removal from incoming messages, so that delivered messages can
20778 safely be resent to other recipients.
20779
20780
20781 .option driver transports string unset
20782 This specifies which of the available transport drivers is to be used.
20783 There is no default, and this option must be set for every transport.
20784
20785
20786 .option envelope_to_add transports boolean false
20787 .cindex "&'Envelope-to:'& header line"
20788 If this option is true, an &'Envelope-to:'& header is added to the message.
20789 This gives the original address(es) in the incoming envelope that caused this
20790 delivery to happen. More than one address may be present if the transport is
20791 configured to handle several addresses at once, or if more than one original
20792 address was redirected to the same final address. As this is not a standard
20793 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20794 its removal from incoming messages, so that delivered messages can safely be
20795 resent to other recipients.
20796
20797
20798 .option event_action transports string&!! unset
20799 .cindex events
20800 This option declares a string to be expanded for Exim's events mechanism.
20801 For details see &<<CHAPevents>>&.
20802
20803
20804 .option group transports string&!! "Exim group"
20805 .cindex "transport" "group; specifying"
20806 This option specifies a gid for running the transport process, overriding any
20807 value that the router supplies, and also overriding any value associated with
20808 &%user%& (see below).
20809
20810
20811 .option headers_add transports list&!! unset
20812 .cindex "header lines" "adding in transport"
20813 .cindex "transport" "header lines; adding"
20814 This option specifies a list of text headers,
20815 newline-separated (by default, changeable in the usual way),
20816 which are (separately) expanded and added to the header
20817 portion of a message as it is transported, as described in section
20818 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20819 routers. If the result of the expansion is an empty string, or if the expansion
20820 is forced to fail, no action is taken. Other expansion failures are treated as
20821 errors and cause the delivery to be deferred.
20822
20823 Unlike most options, &%headers_add%& can be specified multiple times
20824 for a transport; all listed headers are added.
20825
20826
20827 .option headers_only transports boolean false
20828 .cindex "transport" "header lines only"
20829 .cindex "message" "transporting headers only"
20830 .cindex "header lines" "transporting"
20831 If this option is set, the message's body is not transported. It is mutually
20832 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20833 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20834 checked, since this option does not automatically suppress them.
20835
20836
20837 .option headers_remove transports list&!! unset
20838 .cindex "header lines" "removing"
20839 .cindex "transport" "header lines; removing"
20840 This option specifies a list of header names,
20841 colon-separated (by default, changeable in the usual way);
20842 these headers are omitted from the message as it is transported, as described
20843 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20844 routers.
20845 Each list item is separately expanded.
20846 If the result of the expansion is an empty string, or if the expansion
20847 is forced to fail, no action is taken. Other expansion failures are treated as
20848 errors and cause the delivery to be deferred.
20849
20850 Unlike most options, &%headers_remove%& can be specified multiple times
20851 for a router; all listed headers are removed.
20852
20853 &*Warning*&: Because of the separate expansion of the list items,
20854 items that contain a list separator must have it doubled.
20855 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20856
20857
20858
20859 .option headers_rewrite transports string unset
20860 .cindex "transport" "header lines; rewriting"
20861 .cindex "rewriting" "at transport time"
20862 This option allows addresses in header lines to be rewritten at transport time,
20863 that is, as the message is being copied to its destination. The contents of the
20864 option are a colon-separated list of rewriting rules. Each rule is in exactly
20865 the same form as one of the general rewriting rules that are applied when a
20866 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20867 example,
20868 .code
20869 headers_rewrite = a@b c@d f : \
20870                   x@y w@z
20871 .endd
20872 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20873 &'w@z'& in all address-bearing header lines. The rules are applied to the
20874 header lines just before they are written out at transport time, so they affect
20875 only those copies of the message that pass through the transport. However, only
20876 the message's original header lines, and any that were added by a system
20877 filter, are rewritten. If a router or transport adds header lines, they are not
20878 affected by this option. These rewriting rules are &'not'& applied to the
20879 envelope. You can change the return path using &%return_path%&, but you cannot
20880 change envelope recipients at this time.
20881
20882
20883 .option home_directory transports string&!! unset
20884 .cindex "transport" "home directory for"
20885 .vindex "&$home$&"
20886 This option specifies a home directory setting for a local transport,
20887 overriding any value that may be set by the router. The home directory is
20888 placed in &$home$& while expanding the transport's private options. It is also
20889 used as the current directory if no current directory is set by the
20890 &%current_directory%& option on the transport or the
20891 &%transport_current_directory%& option on the router. If the expansion fails
20892 for any reason, including forced failure, an error is logged, and delivery is
20893 deferred.
20894
20895
20896 .option initgroups transports boolean false
20897 .cindex "additional groups"
20898 .cindex "groups" "additional"
20899 .cindex "transport" "group; additional"
20900 If this option is true and the uid for the delivery process is provided by the
20901 transport, the &[initgroups()]& function is called when running the transport
20902 to ensure that any additional groups associated with the uid are set up.
20903
20904
20905 .option max_parallel transports integer&!! unset
20906 .cindex limit "transport parallelism"
20907 .cindex transport "parallel processes"
20908 .cindex transport "concurrency limit"
20909 .cindex "delivery" "parallelism for transport"
20910 If this option is set and expands to an integer greater than zero
20911 it limits the number of concurrent runs of the transport.
20912 The control does not apply to shadow transports.
20913
20914 .cindex "hints database" "transport concurrency control"
20915 Exim implements this control by means of a hints database in which a record is
20916 incremented whenever a transport process is beaing created. The record
20917 is decremented and possibly removed when the process terminates.
20918 Obviously there is scope for
20919 records to get left lying around if there is a system or program crash. To
20920 guard against this, Exim ignores any records that are more than six hours old.
20921
20922 If you use this option, you should also arrange to delete the
20923 relevant hints database whenever your system reboots. The names of the files
20924 start with &_misc_& and they are kept in the &_spool/db_& directory. There
20925 may be one or two files, depending on the type of DBM in use. The same files
20926 are used for ETRN and smtp transport serialization.
20927
20928
20929 .option message_size_limit transports string&!! 0
20930 .cindex "limit" "message size per transport"
20931 .cindex "size" "of message, limit"
20932 .cindex "transport" "message size; limiting"
20933 This option controls the size of messages passed through the transport. It is
20934 expanded before use; the result of the expansion must be a sequence of decimal
20935 digits, optionally followed by K or M. If the expansion fails for any reason,
20936 including forced failure, or if the result is not of the required form,
20937 delivery is deferred. If the value is greater than zero and the size of a
20938 message exceeds this limit, the address is failed. If there is any chance that
20939 the resulting bounce message could be routed to the same transport, you should
20940 ensure that &%return_size_limit%& is less than the transport's
20941 &%message_size_limit%&, as otherwise the bounce message will fail to get
20942 delivered.
20943
20944
20945
20946 .option rcpt_include_affixes transports boolean false
20947 .cindex "prefix" "for local part, including in envelope"
20948 .cindex "suffix for local part" "including in envelope"
20949 .cindex "local part" "prefix"
20950 .cindex "local part" "suffix"
20951 When this option is false (the default), and an address that has had any
20952 affixes (prefixes or suffixes) removed from the local part is delivered by any
20953 form of SMTP or LMTP, the affixes are not included. For example, if a router
20954 that contains
20955 .code
20956 local_part_prefix = *-
20957 .endd
20958 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20959 is delivered with
20960 .code
20961 RCPT TO:<xyz@some.domain>
20962 .endd
20963 This is also the case when an ACL-time callout is being used to verify a
20964 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20965 whole local part is included in the RCPT command. This option applies to BSMTP
20966 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20967 &(lmtp)& and &(smtp)& transports.
20968
20969
20970 .option retry_use_local_part transports boolean "see below"
20971 .cindex "hints database" "retry keys"
20972 When a delivery suffers a temporary failure, a retry record is created
20973 in Exim's hints database. For remote deliveries, the key for the retry record
20974 is based on the name and/or IP address of the failing remote host. For local
20975 deliveries, the key is normally the entire address, including both the local
20976 part and the domain. This is suitable for most common cases of local delivery
20977 temporary failure &-- for example, exceeding a mailbox quota should delay only
20978 deliveries to that mailbox, not to the whole domain.
20979
20980 However, in some special cases you may want to treat a temporary local delivery
20981 as a failure associated with the domain, and not with a particular local part.
20982 (For example, if you are storing all mail for some domain in files.) You can do
20983 this by setting &%retry_use_local_part%& false.
20984
20985 For all the local transports, its default value is true. For remote transports,
20986 the default value is false for tidiness, but changing the value has no effect
20987 on a remote transport in the current implementation.
20988
20989
20990 .option return_path transports string&!! unset
20991 .cindex "envelope sender"
20992 .cindex "transport" "return path; changing"
20993 .cindex "return path" "changing in transport"
20994 If this option is set, the string is expanded at transport time and replaces
20995 the existing return path (envelope sender) value in the copy of the message
20996 that is being delivered. An empty return path is permitted. This feature is
20997 designed for remote deliveries, where the value of this option is used in the
20998 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20999 only effect is to change the address that is placed in the &'Return-path:'&
21000 header line, if one is added to the message (see the next option).
21001
21002 &*Note:*& A changed return path is not logged unless you add
21003 &%return_path_on_delivery%& to the log selector.
21004
21005 .vindex "&$return_path$&"
21006 The expansion can refer to the existing value via &$return_path$&. This is
21007 either the message's envelope sender, or an address set by the
21008 &%errors_to%& option on a router. If the expansion is forced to fail, no
21009 replacement occurs; if it fails for another reason, delivery is deferred. This
21010 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21011 section &<<SECTverp>>&.
21012
21013 &*Note*&: If a delivery error is detected locally, including the case when a
21014 remote server rejects a message at SMTP time, the bounce message is not sent to
21015 the value of this option. It is sent to the previously set errors address.
21016 This defaults to the incoming sender address, but can be changed by setting
21017 &%errors_to%& in a router.
21018
21019
21020
21021 .option return_path_add transports boolean false
21022 .cindex "&'Return-path:'& header line"
21023 If this option is true, a &'Return-path:'& header is added to the message.
21024 Although the return path is normally available in the prefix line of BSD
21025 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21026 have easy access to it.
21027
21028 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21029 the delivery SMTP server makes the final delivery"&. This implies that this
21030 header should not be present in incoming messages. Exim has a configuration
21031 option, &%return_path_remove%&, which requests removal of this header from
21032 incoming messages, so that delivered messages can safely be resent to other
21033 recipients.
21034
21035
21036 .option shadow_condition transports string&!! unset
21037 See &%shadow_transport%& below.
21038
21039
21040 .option shadow_transport transports string unset
21041 .cindex "shadow transport"
21042 .cindex "transport" "shadow"
21043 A local transport may set the &%shadow_transport%& option to the name of
21044 another local transport. Shadow remote transports are not supported.
21045
21046 Whenever a delivery to the main transport succeeds, and either
21047 &%shadow_condition%& is unset, or its expansion does not result in the empty
21048 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21049 passed to the shadow transport, with the same delivery address or addresses. If
21050 expansion fails, no action is taken except that non-forced expansion failures
21051 cause a log line to be written.
21052
21053 The result of the shadow transport is discarded and does not affect the
21054 subsequent processing of the message. Only a single level of shadowing is
21055 provided; the &%shadow_transport%& option is ignored on any transport when it
21056 is running as a shadow. Options concerned with output from pipes are also
21057 ignored. The log line for the successful delivery has an item added on the end,
21058 of the form
21059 .code
21060 ST=<shadow transport name>
21061 .endd
21062 If the shadow transport did not succeed, the error message is put in
21063 parentheses afterwards. Shadow transports can be used for a number of different
21064 purposes, including keeping more detailed log information than Exim normally
21065 provides, and implementing automatic acknowledgment policies based on message
21066 headers that some sites insist on.
21067
21068
21069 .option transport_filter transports string&!! unset
21070 .cindex "transport" "filter"
21071 .cindex "filter" "transport filter"
21072 This option sets up a filtering (in the Unix shell sense) process for messages
21073 at transport time. It should not be confused with mail filtering as set up by
21074 individual users or via a system filter.
21075 If unset, or expanding to an empty string, no filtering is done.
21076
21077 When the message is about to be written out, the command specified by
21078 &%transport_filter%& is started up in a separate, parallel process, and
21079 the entire message, including the header lines, is passed to it on its standard
21080 input (this in fact is done from a third process, to avoid deadlock). The
21081 command must be specified as an absolute path.
21082
21083 The lines of the message that are written to the transport filter are
21084 terminated by newline (&"\n"&). The message is passed to the filter before any
21085 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21086 lines beginning with a dot, and also before any processing implied by the
21087 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21088 &(pipe)& transports.
21089
21090 The standard error for the filter process is set to the same destination as its
21091 standard output; this is read and written to the message's ultimate
21092 destination. The process that writes the message to the filter, the
21093 filter itself, and the original process that reads the result and delivers it
21094 are all run in parallel, like a shell pipeline.
21095
21096 The filter can perform any transformations it likes, but of course should take
21097 care not to break RFC 2822 syntax. Exim does not check the result, except to
21098 test for a final newline when SMTP is in use. All messages transmitted over
21099 SMTP must end with a newline, so Exim supplies one if it is missing.
21100
21101 .cindex "content scanning" "per user"
21102 A transport filter can be used to provide content-scanning on a per-user basis
21103 at delivery time if the only required effect of the scan is to modify the
21104 message. For example, a content scan could insert a new header line containing
21105 a spam score. This could be interpreted by a filter in the user's MUA. It is
21106 not possible to discard a message at this stage.
21107
21108 .cindex "SMTP" "SIZE"
21109 A problem might arise if the filter increases the size of a message that is
21110 being sent down an SMTP connection. If the receiving SMTP server has indicated
21111 support for the SIZE parameter, Exim will have sent the size of the message
21112 at the start of the SMTP session. If what is actually sent is substantially
21113 more, the server might reject the message. This can be worked round by setting
21114 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21115 additions to the message, or to disable the use of SIZE altogether.
21116
21117 .vindex "&$pipe_addresses$&"
21118 The value of the &%transport_filter%& option is the command string for starting
21119 the filter, which is run directly from Exim, not under a shell. The string is
21120 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21121 Exim breaks it up into arguments and then expands each argument separately (see
21122 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21123 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21124 of arguments, one for each address that applies to this delivery. (This isn't
21125 an ideal name for this feature here, but as it was already implemented for the
21126 &(pipe)& transport, it seemed sensible not to change it.)
21127
21128 .vindex "&$host$&"
21129 .vindex "&$host_address$&"
21130 The expansion variables &$host$& and &$host_address$& are available when the
21131 transport is a remote one. They contain the name and IP address of the host to
21132 which the message is being sent. For example:
21133 .code
21134 transport_filter = /some/directory/transport-filter.pl \
21135   $host $host_address $sender_address $pipe_addresses
21136 .endd
21137
21138 Two problems arise if you want to use more complicated expansion items to
21139 generate transport filter commands, both of which due to the fact that the
21140 command is split up &'before'& expansion.
21141 .ilist
21142 If an expansion item contains white space, you must quote it, so that it is all
21143 part of the same command item. If the entire option setting is one such
21144 expansion item, you have to take care what kind of quoting you use. For
21145 example:
21146 .code
21147 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21148 .endd
21149 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21150 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21151 stripped by Exim when it read the option's value. When the value is used, if
21152 the single quotes were missing, the line would be split into two items,
21153 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21154 Exim tried to expand the first one.
21155 .next
21156 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21157 expansion cannot generate multiple arguments, or a command name followed by
21158 arguments. Consider this example:
21159 .code
21160 transport_filter = ${lookup{$host}lsearch{/a/file}\
21161                     {$value}{/bin/cat}}
21162 .endd
21163 The result of the lookup is interpreted as the name of the command, even
21164 if it contains white space. The simplest way round this is to use a shell:
21165 .code
21166 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21167                                {$value}{/bin/cat}}
21168 .endd
21169 .endlist
21170
21171 The filter process is run under the same uid and gid as the normal delivery.
21172 For remote deliveries this is the Exim uid/gid by default. The command should
21173 normally yield a zero return code. Transport filters are not supposed to fail.
21174 A non-zero code is taken to mean that the transport filter encountered some
21175 serious problem. Delivery of the message is deferred; the message remains on
21176 the queue and is tried again later. It is not possible to cause a message to be
21177 bounced from a transport filter.
21178
21179 If a transport filter is set on an autoreply transport, the original message is
21180 passed through the filter as it is being copied into the newly generated
21181 message, which happens if the &%return_message%& option is set.
21182
21183
21184 .option transport_filter_timeout transports time 5m
21185 .cindex "transport" "filter, timeout"
21186 When Exim is reading the output of a transport filter, it applies a timeout
21187 that can be set by this option. Exceeding the timeout is normally treated as a
21188 temporary delivery failure. However, if a transport filter is used with a
21189 &(pipe)& transport, a timeout in the transport filter is treated in the same
21190 way as a timeout in the pipe command itself. By default, a timeout is a hard
21191 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21192 becomes a temporary error.
21193
21194
21195 .option user transports string&!! "Exim user"
21196 .cindex "uid (user id)" "local delivery"
21197 .cindex "transport" "user, specifying"
21198 This option specifies the user under whose uid the delivery process is to be
21199 run, overriding any uid that may have been set by the router. If the user is
21200 given as a name, the uid is looked up from the password data, and the
21201 associated group is taken as the value of the gid to be used if the &%group%&
21202 option is not set.
21203
21204 For deliveries that use local transports, a user and group are normally
21205 specified explicitly or implicitly (for example, as a result of
21206 &%check_local_user%&) by the router or transport.
21207
21208 .cindex "hints database" "access by remote transport"
21209 For remote transports, you should leave this option unset unless you really are
21210 sure you know what you are doing. When a remote transport is running, it needs
21211 to be able to access Exim's hints databases, because each host may have its own
21212 retry data.
21213 .ecindex IIDgenoptra1
21214 .ecindex IIDgenoptra2
21215 .ecindex IIDgenoptra3
21216
21217
21218
21219
21220
21221
21222 . ////////////////////////////////////////////////////////////////////////////
21223 . ////////////////////////////////////////////////////////////////////////////
21224
21225 .chapter "Address batching in local transports" "CHAPbatching" &&&
21226          "Address batching"
21227 .cindex "transport" "local; address batching in"
21228 The only remote transport (&(smtp)&) is normally configured to handle more than
21229 one address at a time, so that when several addresses are routed to the same
21230 remote host, just one copy of the message is sent. Local transports, however,
21231 normally handle one address at a time. That is, a separate instance of the
21232 transport is run for each address that is routed to the transport. A separate
21233 copy of the message is delivered each time.
21234
21235 .cindex "batched local delivery"
21236 .oindex "&%batch_max%&"
21237 .oindex "&%batch_id%&"
21238 In special cases, it may be desirable to handle several addresses at once in a
21239 local transport, for example:
21240
21241 .ilist
21242 In an &(appendfile)& transport, when storing messages in files for later
21243 delivery by some other means, a single copy of the message with multiple
21244 recipients saves space.
21245 .next
21246 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21247 a single copy saves time, and is the normal way LMTP is expected to work.
21248 .next
21249 In a &(pipe)& transport, when passing the message
21250 to a scanner program or
21251 to some other delivery mechanism such as UUCP, multiple recipients may be
21252 acceptable.
21253 .endlist
21254
21255 These three local transports all have the same options for controlling multiple
21256 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21257 repeating the information for each transport, these options are described here.
21258
21259 The &%batch_max%& option specifies the maximum number of addresses that can be
21260 delivered together in a single run of the transport. Its default value is one
21261 (no batching). When more than one address is routed to a transport that has a
21262 &%batch_max%& value greater than one, the addresses are delivered in a batch
21263 (that is, in a single run of the transport with multiple recipients), subject
21264 to certain conditions:
21265
21266 .ilist
21267 .vindex "&$local_part$&"
21268 If any of the transport's options contain a reference to &$local_part$&, no
21269 batching is possible.
21270 .next
21271 .vindex "&$domain$&"
21272 If any of the transport's options contain a reference to &$domain$&, only
21273 addresses with the same domain are batched.
21274 .next
21275 .cindex "customizing" "batching condition"
21276 If &%batch_id%& is set, it is expanded for each address, and only those
21277 addresses with the same expanded value are batched. This allows you to specify
21278 customized batching conditions. Failure of the expansion for any reason,
21279 including forced failure, disables batching, but it does not stop the delivery
21280 from taking place.
21281 .next
21282 Batched addresses must also have the same errors address (where to send
21283 delivery errors), the same header additions and removals, the same user and
21284 group for the transport, and if a host list is present, the first host must
21285 be the same.
21286 .endlist
21287
21288 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21289 both when the file or pipe command is specified in the transport, and when it
21290 is specified by a &(redirect)& router, but all the batched addresses must of
21291 course be routed to the same file or pipe command. These two transports have an
21292 option called &%use_bsmtp%&, which causes them to deliver the message in
21293 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21294 &%check_string%& and &%escape_string%& options are forced to the values
21295 .code
21296 check_string = "."
21297 escape_string = ".."
21298 .endd
21299 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21300 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21301 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21302
21303 .cindex "&'Envelope-to:'& header line"
21304 If the generic &%envelope_to_add%& option is set for a batching transport, the
21305 &'Envelope-to:'& header that is added to the message contains all the addresses
21306 that are being processed together. If you are using a batching &(appendfile)&
21307 transport without &%use_bsmtp%&, the only way to preserve the recipient
21308 addresses is to set the &%envelope_to_add%& option.
21309
21310 .cindex "&(pipe)& transport" "with multiple addresses"
21311 .vindex "&$pipe_addresses$&"
21312 If you are using a &(pipe)& transport without BSMTP, and setting the
21313 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21314 the command. This is not a true variable; it is a bit of magic that causes each
21315 of the recipient addresses to be inserted into the command as a separate
21316 argument. This provides a way of accessing all the addresses that are being
21317 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21318 are specified by a &(redirect)& router.
21319
21320
21321
21322
21323 . ////////////////////////////////////////////////////////////////////////////
21324 . ////////////////////////////////////////////////////////////////////////////
21325
21326 .chapter "The appendfile transport" "CHAPappendfile"
21327 .scindex IIDapptra1 "&(appendfile)& transport"
21328 .scindex IIDapptra2 "transports" "&(appendfile)&"
21329 .cindex "directory creation"
21330 .cindex "creating directories"
21331 The &(appendfile)& transport delivers a message by appending it to an existing
21332 file, or by creating an entirely new file in a specified directory. Single
21333 files to which messages are appended can be in the traditional Unix mailbox
21334 format, or optionally in the MBX format supported by the Pine MUA and
21335 University of Washington IMAP daemon, &'inter alia'&. When each message is
21336 being delivered as a separate file, &"maildir"& format can optionally be used
21337 to give added protection against failures that happen part-way through the
21338 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21339 supported. For all file formats, Exim attempts to create as many levels of
21340 directory as necessary, provided that &%create_directory%& is set.
21341
21342 The code for the optional formats is not included in the Exim binary by
21343 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21344 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21345 included.
21346
21347 .cindex "quota" "system"
21348 Exim recognizes system quota errors, and generates an appropriate message. Exim
21349 also supports its own quota control within the transport, for use when the
21350 system facility is unavailable or cannot be used for some reason.
21351
21352 If there is an error while appending to a file (for example, quota exceeded or
21353 partition filled), Exim attempts to reset the file's length and last
21354 modification time back to what they were before. If there is an error while
21355 creating an entirely new file, the new file is removed.
21356
21357 Before appending to a file, a number of security checks are made, and the
21358 file is locked. A detailed description is given below, after the list of
21359 private options.
21360
21361 The &(appendfile)& transport is most commonly used for local deliveries to
21362 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21363 putting messages into files for remote delivery by some means other than Exim.
21364 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21365 option).
21366
21367
21368
21369 .section "The file and directory options" "SECTfildiropt"
21370 The &%file%& option specifies a single file, to which the message is appended;
21371 the &%directory%& option specifies a directory, in which a new file containing
21372 the message is created. Only one of these two options can be set, and for
21373 normal deliveries to mailboxes, one of them &'must'& be set.
21374
21375 .vindex "&$address_file$&"
21376 .vindex "&$local_part$&"
21377 However, &(appendfile)& is also used for delivering messages to files or
21378 directories whose names (or parts of names) are obtained from alias,
21379 forwarding, or filtering operations (for example, a &%save%& command in a
21380 user's Exim filter). When such a transport is running, &$local_part$& contains
21381 the local part that was aliased or forwarded, and &$address_file$& contains the
21382 name (or partial name) of the file or directory generated by the redirection
21383 operation. There are two cases:
21384
21385 .ilist
21386 If neither &%file%& nor &%directory%& is set, the redirection operation
21387 must specify an absolute path (one that begins with &`/`&). This is the most
21388 common case when users with local accounts use filtering to sort mail into
21389 different folders. See for example, the &(address_file)& transport in the
21390 default configuration. If the path ends with a slash, it is assumed to be the
21391 name of a directory. A delivery to a directory can also be forced by setting
21392 &%maildir_format%& or &%mailstore_format%&.
21393 .next
21394 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21395 used to determine the file or directory name for the delivery. Normally, the
21396 contents of &$address_file$& are used in some way in the string expansion.
21397 .endlist
21398
21399
21400 .cindex "Sieve filter" "configuring &(appendfile)&"
21401 .cindex "Sieve filter" "relative mailbox path handling"
21402 As an example of the second case, consider an environment where users do not
21403 have home directories. They may be permitted to use Exim filter commands of the
21404 form:
21405 .code
21406 save folder23
21407 .endd
21408 or Sieve filter commands of the form:
21409 .code
21410 require "fileinto";
21411 fileinto "folder23";
21412 .endd
21413 In this situation, the expansion of &%file%& or &%directory%& in the transport
21414 must transform the relative path into an appropriate absolute file name. In the
21415 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21416 is used as a result of a &"keep"& action in the filter. This example shows one
21417 way of handling this requirement:
21418 .code
21419 file = ${if eq{$address_file}{inbox} \
21420             {/var/mail/$local_part} \
21421             {${if eq{${substr_0_1:$address_file}}{/} \
21422                   {$address_file} \
21423                   {$home/mail/$address_file} \
21424             }} \
21425        }
21426 .endd
21427 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21428 location, absolute paths are used without change, and other folders are in the
21429 &_mail_& directory within the home directory.
21430
21431 &*Note 1*&: While processing an Exim filter, a relative path such as
21432 &_folder23_& is turned into an absolute path if a home directory is known to
21433 the router. In particular, this is the case if &%check_local_user%& is set. If
21434 you want to prevent this happening at routing time, you can set
21435 &%router_home_directory%& empty. This forces the router to pass the relative
21436 path to the transport.
21437
21438 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21439 the &%file%& or &%directory%& option is still used if it is set.
21440
21441
21442
21443
21444 .section "Private options for appendfile" "SECID134"
21445 .cindex "options" "&(appendfile)& transport"
21446
21447
21448
21449 .option allow_fifo appendfile boolean false
21450 .cindex "fifo (named pipe)"
21451 .cindex "named pipe (fifo)"
21452 .cindex "pipe" "named (fifo)"
21453 Setting this option permits delivery to named pipes (FIFOs) as well as to
21454 regular files. If no process is reading the named pipe at delivery time, the
21455 delivery is deferred.
21456
21457
21458 .option allow_symlink appendfile boolean false
21459 .cindex "symbolic link" "to mailbox"
21460 .cindex "mailbox" "symbolic link"
21461 By default, &(appendfile)& will not deliver if the path name for the file is
21462 that of a symbolic link. Setting this option relaxes that constraint, but there
21463 are security issues involved in the use of symbolic links. Be sure you know
21464 what you are doing if you set this. Details of exactly what this option affects
21465 are included in the discussion which follows this list of options.
21466
21467
21468 .option batch_id appendfile string&!! unset
21469 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21470 However, batching is automatically disabled for &(appendfile)& deliveries that
21471 happen as a result of forwarding or aliasing or other redirection directly to a
21472 file.
21473
21474
21475 .option batch_max appendfile integer 1
21476 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21477
21478
21479 .option check_group appendfile boolean false
21480 When this option is set, the group owner of the file defined by the &%file%&
21481 option is checked to see that it is the same as the group under which the
21482 delivery process is running. The default setting is false because the default
21483 file mode is 0600, which means that the group is irrelevant.
21484
21485
21486 .option check_owner appendfile boolean true
21487 When this option is set, the owner of the file defined by the &%file%& option
21488 is checked to ensure that it is the same as the user under which the delivery
21489 process is running.
21490
21491
21492 .option check_string appendfile string "see below"
21493 .cindex "&""From""& line"
21494 As &(appendfile)& writes the message, the start of each line is tested for
21495 matching &%check_string%&, and if it does, the initial matching characters are
21496 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21497 a literal string, not a regular expression, and the case of any letters it
21498 contains is significant.
21499
21500 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21501 are forced to &"."& and &".."& respectively, and any settings in the
21502 configuration are ignored. Otherwise, they default to &"From&~"& and
21503 &">From&~"& when the &%file%& option is set, and unset when any of the
21504 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21505
21506 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21507 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21508 &"From&~"& indicates the start of a new message. All four options need changing
21509 if another format is used. For example, to deliver to mailboxes in MMDF format:
21510 .cindex "MMDF format mailbox"
21511 .cindex "mailbox" "MMDF format"
21512 .code
21513 check_string = "\1\1\1\1\n"
21514 escape_string = "\1\1\1\1 \n"
21515 message_prefix = "\1\1\1\1\n"
21516 message_suffix = "\1\1\1\1\n"
21517 .endd
21518 .option create_directory appendfile boolean true
21519 .cindex "directory creation"
21520 When this option is true, Exim attempts to create any missing superior
21521 directories for the file that it is about to write. A created directory's mode
21522 is given by the &%directory_mode%& option.
21523
21524 The group ownership of a newly created directory is highly dependent on the
21525 operating system (and possibly the file system) that is being used. For
21526 example, in Solaris, if the parent directory has the setgid bit set, its group
21527 is propagated to the child; if not, the currently set group is used. However,
21528 in FreeBSD, the parent's group is always used.
21529
21530
21531
21532 .option create_file appendfile string anywhere
21533 This option constrains the location of files and directories that are created
21534 by this transport. It applies to files defined by the &%file%& option and
21535 directories defined by the &%directory%& option. In the case of maildir
21536 delivery, it applies to the top level directory, not the maildir directories
21537 beneath.
21538
21539 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21540 &"belowhome"&. In the second and third cases, a home directory must have been
21541 set for the transport. This option is not useful when an explicit file name is
21542 given for normal mailbox deliveries. It is intended for the case when file
21543 names are generated from users' &_.forward_& files. These are usually handled
21544 by an &(appendfile)& transport called &%address_file%&. See also
21545 &%file_must_exist%&.
21546
21547
21548 .option directory appendfile string&!! unset
21549 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21550 or &%directory%& must be set, unless the delivery is the direct result of a
21551 redirection (see section &<<SECTfildiropt>>&).
21552
21553 When &%directory%& is set, the string is expanded, and the message is delivered
21554 into a new file or files in or below the given directory, instead of being
21555 appended to a single mailbox file. A number of different formats are provided
21556 (see &%maildir_format%& and &%mailstore_format%&), and see section
21557 &<<SECTopdir>>& for further details of this form of delivery.
21558
21559
21560 .option directory_file appendfile string&!! "see below"
21561 .cindex "base62"
21562 .vindex "&$inode$&"
21563 When &%directory%& is set, but neither &%maildir_format%& nor
21564 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21565 whose name is obtained by expanding this string. The default value is:
21566 .code
21567 q${base62:$tod_epoch}-$inode
21568 .endd
21569 This generates a unique name from the current time, in base 62 form, and the
21570 inode of the file. The variable &$inode$& is available only when expanding this
21571 option.
21572
21573
21574 .option directory_mode appendfile "octal integer" 0700
21575 If &(appendfile)& creates any directories as a result of the
21576 &%create_directory%& option, their mode is specified by this option.
21577
21578
21579 .option escape_string appendfile string "see description"
21580 See &%check_string%& above.
21581
21582
21583 .option file appendfile string&!! unset
21584 This option is mutually exclusive with the &%directory%& option, but one of
21585 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21586 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21587 specifies a single file, to which the message is appended. One or more of
21588 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21589 &%file%&.
21590
21591 .cindex "NFS" "lock file"
21592 .cindex "locking files"
21593 .cindex "lock files"
21594 If you are using more than one host to deliver over NFS into the same
21595 mailboxes, you should always use lock files.
21596
21597 The string value is expanded for each delivery, and must yield an absolute
21598 path. The most common settings of this option are variations on one of these
21599 examples:
21600 .code
21601 file = /var/spool/mail/$local_part
21602 file = /home/$local_part/inbox
21603 file = $home/inbox
21604 .endd
21605 .cindex "&""sticky""& bit"
21606 In the first example, all deliveries are done into the same directory. If Exim
21607 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21608 create a file in the directory, so the &"sticky"& bit must be turned on for
21609 deliveries to be possible, or alternatively the &%group%& option can be used to
21610 run the delivery under a group id which has write access to the directory.
21611
21612
21613
21614 .option file_format appendfile string unset
21615 .cindex "file" "mailbox; checking existing format"
21616 This option requests the transport to check the format of an existing file
21617 before adding to it. The check consists of matching a specific string at the
21618 start of the file. The value of the option consists of an even number of
21619 colon-separated strings. The first of each pair is the test string, and the
21620 second is the name of a transport. If the transport associated with a matched
21621 string is not the current transport, control is passed over to the other
21622 transport. For example, suppose the standard &(local_delivery)& transport has
21623 this added to it:
21624 .code
21625 file_format = "From       : local_delivery :\
21626                \1\1\1\1\n : local_mmdf_delivery"
21627 .endd
21628 Mailboxes that begin with &"From"& are still handled by this transport, but if
21629 a mailbox begins with four binary ones followed by a newline, control is passed
21630 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21631 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21632 is assumed to match the current transport. If the start of a mailbox doesn't
21633 match any string, or if the transport named for a given string is not defined,
21634 delivery is deferred.
21635
21636
21637 .option file_must_exist appendfile boolean false
21638 If this option is true, the file specified by the &%file%& option must exist.
21639 A temporary error occurs if it does not, causing delivery to be deferred.
21640 If this option is false, the file is created if it does not exist.
21641
21642
21643 .option lock_fcntl_timeout appendfile time 0s
21644 .cindex "timeout" "mailbox locking"
21645 .cindex "mailbox" "locking, blocking and non-blocking"
21646 .cindex "locking files"
21647 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21648 when locking an open mailbox file. If the call fails, the delivery process
21649 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21650 Non-blocking calls are used so that the file is not kept open during the wait
21651 for the lock; the reason for this is to make it as safe as possible for
21652 deliveries over NFS in the case when processes might be accessing an NFS
21653 mailbox without using a lock file. This should not be done, but
21654 misunderstandings and hence misconfigurations are not unknown.
21655
21656 On a busy system, however, the performance of a non-blocking lock approach is
21657 not as good as using a blocking lock with a timeout. In this case, the waiting
21658 is done inside the system call, and Exim's delivery process acquires the lock
21659 and can proceed as soon as the previous lock holder releases it.
21660
21661 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21662 timeout, are used. There may still be some retrying: the maximum number of
21663 retries is
21664 .code
21665 (lock_retries * lock_interval) / lock_fcntl_timeout
21666 .endd
21667 rounded up to the next whole number. In other words, the total time during
21668 which &(appendfile)& is trying to get a lock is roughly the same, unless
21669 &%lock_fcntl_timeout%& is set very large.
21670
21671 You should consider setting this option if you are getting a lot of delayed
21672 local deliveries because of errors of the form
21673 .code
21674 failed to lock mailbox /some/file (fcntl)
21675 .endd
21676
21677 .option lock_flock_timeout appendfile time 0s
21678 This timeout applies to file locking when using &[flock()]& (see
21679 &%use_flock%&); the timeout operates in a similar manner to
21680 &%lock_fcntl_timeout%&.
21681
21682
21683 .option lock_interval appendfile time 3s
21684 This specifies the time to wait between attempts to lock the file. See below
21685 for details of locking.
21686
21687
21688 .option lock_retries appendfile integer 10
21689 This specifies the maximum number of attempts to lock the file. A value of zero
21690 is treated as 1. See below for details of locking.
21691
21692
21693 .option lockfile_mode appendfile "octal integer" 0600
21694 This specifies the mode of the created lock file, when a lock file is being
21695 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21696
21697
21698 .option lockfile_timeout appendfile time 30m
21699 .cindex "timeout" "mailbox locking"
21700 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21701 exists and is older than this value, it is assumed to have been left behind by
21702 accident, and Exim attempts to remove it.
21703
21704
21705 .option mailbox_filecount appendfile string&!! unset
21706 .cindex "mailbox" "specifying size of"
21707 .cindex "size" "of mailbox"
21708 If this option is set, it is expanded, and the result is taken as the current
21709 number of files in the mailbox. It must be a decimal number, optionally
21710 followed by K or M. This provides a way of obtaining this information from an
21711 external source that maintains the data.
21712
21713
21714 .option mailbox_size appendfile string&!! unset
21715 .cindex "mailbox" "specifying size of"
21716 .cindex "size" "of mailbox"
21717 If this option is set, it is expanded, and the result is taken as the current
21718 size the mailbox. It must be a decimal number, optionally followed by K or M.
21719 This provides a way of obtaining this information from an external source that
21720 maintains the data. This is likely to be helpful for maildir deliveries where
21721 it is computationally expensive to compute the size of a mailbox.
21722
21723
21724
21725 .option maildir_format appendfile boolean false
21726 .cindex "maildir format" "specifying"
21727 If this option is set with the &%directory%& option, the delivery is into a new
21728 file, in the &"maildir"& format that is used by other mail software. When the
21729 transport is activated directly from a &(redirect)& router (for example, the
21730 &(address_file)& transport in the default configuration), setting
21731 &%maildir_format%& causes the path received from the router to be treated as a
21732 directory, whether or not it ends with &`/`&. This option is available only if
21733 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21734 &<<SECTmaildirdelivery>>& below for further details.
21735
21736
21737 .option maildir_quota_directory_regex appendfile string "See below"
21738 .cindex "maildir format" "quota; directories included in"
21739 .cindex "quota" "maildir; directories included in"
21740 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21741 a regular expression for specifying directories, relative to the quota
21742 directory (see &%quota_directory%&), that should be included in the quota
21743 calculation. The default value is:
21744 .code
21745 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21746 .endd
21747 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21748 (directories whose names begin with a dot). If you want to exclude the
21749 &_Trash_&
21750 folder from the count (as some sites do), you need to change this setting to
21751 .code
21752 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21753 .endd
21754 This uses a negative lookahead in the regular expression to exclude the
21755 directory whose name is &_.Trash_&. When a directory is excluded from quota
21756 calculations, quota processing is bypassed for any messages that are delivered
21757 directly into that directory.
21758
21759
21760 .option maildir_retries appendfile integer 10
21761 This option specifies the number of times to retry when writing a file in
21762 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21763
21764
21765 .option maildir_tag appendfile string&!! unset
21766 This option applies only to deliveries in maildir format, and is described in
21767 section &<<SECTmaildirdelivery>>& below.
21768
21769
21770 .option maildir_use_size_file appendfile&!! boolean false
21771 .cindex "maildir format" "&_maildirsize_& file"
21772 The result of string expansion for this option must be a valid boolean value.
21773 If it is true, it enables support for &_maildirsize_& files. Exim
21774 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21775 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21776 value is zero. See &%maildir_quota_directory_regex%& above and section
21777 &<<SECTmaildirdelivery>>& below for further details.
21778
21779 .option maildirfolder_create_regex appendfile string unset
21780 .cindex "maildir format" "&_maildirfolder_& file"
21781 .cindex "&_maildirfolder_&, creating"
21782 The value of this option is a regular expression. If it is unset, it has no
21783 effect. Otherwise, before a maildir delivery takes place, the pattern is
21784 matched against the name of the maildir directory, that is, the directory
21785 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21786 delivery. If there is a match, Exim checks for the existence of a file called
21787 &_maildirfolder_& in the directory, and creates it if it does not exist.
21788 See section &<<SECTmaildirdelivery>>& for more details.
21789
21790
21791 .option mailstore_format appendfile boolean false
21792 .cindex "mailstore format" "specifying"
21793 If this option is set with the &%directory%& option, the delivery is into two
21794 new files in  &"mailstore"& format. The option is available only if
21795 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21796 below for further details.
21797
21798
21799 .option mailstore_prefix appendfile string&!! unset
21800 This option applies only to deliveries in mailstore format, and is described in
21801 section &<<SECTopdir>>& below.
21802
21803
21804 .option mailstore_suffix appendfile string&!! unset
21805 This option applies only to deliveries in mailstore format, and is described in
21806 section &<<SECTopdir>>& below.
21807
21808
21809 .option mbx_format appendfile boolean false
21810 .cindex "locking files"
21811 .cindex "file" "locking"
21812 .cindex "file" "MBX format"
21813 .cindex "MBX format, specifying"
21814 This option is available only if Exim has been compiled with SUPPORT_MBX
21815 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21816 the message is appended to the mailbox file in MBX format instead of
21817 traditional Unix format. This format is supported by Pine4 and its associated
21818 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21819
21820 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21821 automatically changed by the use of &%mbx_format%&. They should normally be set
21822 empty when using MBX format, so this option almost always appears in this
21823 combination:
21824 .code
21825 mbx_format = true
21826 message_prefix =
21827 message_suffix =
21828 .endd
21829 If none of the locking options are mentioned in the configuration,
21830 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21831 is possible to specify the other kinds of locking with &%mbx_format%&, but
21832 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21833 interworks with &'c-client'&, providing for shared access to the mailbox. It
21834 should not be used if any program that does not use this form of locking is
21835 going to access the mailbox, nor should it be used if the mailbox file is NFS
21836 mounted, because it works only when the mailbox is accessed from a single host.
21837
21838 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21839 the standard version of &'c-client'&, because as long as it has a mailbox open
21840 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21841 append messages to it.
21842
21843
21844 .option message_prefix appendfile string&!! "see below"
21845 .cindex "&""From""& line"
21846 The string specified here is expanded and output at the start of every message.
21847 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21848 in which case it is:
21849 .code
21850 message_prefix = "From ${if def:return_path{$return_path}\
21851   {MAILER-DAEMON}} $tod_bsdinbox\n"
21852 .endd
21853 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21854 &`\n`& to &`\r\n`& in &%message_prefix%&.
21855
21856 .option message_suffix appendfile string&!! "see below"
21857 The string specified here is expanded and output at the end of every message.
21858 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21859 in which case it is a single newline character. The suffix can be suppressed by
21860 setting
21861 .code
21862 message_suffix =
21863 .endd
21864 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21865 &`\n`& to &`\r\n`& in &%message_suffix%&.
21866
21867 .option mode appendfile "octal integer" 0600
21868 If the output file is created, it is given this mode. If it already exists and
21869 has wider permissions, they are reduced to this mode. If it has narrower
21870 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21871 if the delivery is the result of a &%save%& command in a filter file specifying
21872 a particular mode, the mode of the output file is always forced to take that
21873 value, and this option is ignored.
21874
21875
21876 .option mode_fail_narrower appendfile boolean true
21877 This option applies in the case when an existing mailbox file has a narrower
21878 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21879 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21880 continues with the delivery attempt, using the existing mode of the file.
21881
21882
21883 .option notify_comsat appendfile boolean false
21884 If this option is true, the &'comsat'& daemon is notified after every
21885 successful delivery to a user mailbox. This is the daemon that notifies logged
21886 on users about incoming mail.
21887
21888
21889 .option quota appendfile string&!! unset
21890 .cindex "quota" "imposed by Exim"
21891 This option imposes a limit on the size of the file to which Exim is appending,
21892 or to the total space used in the directory tree when the &%directory%& option
21893 is set. In the latter case, computation of the space used is expensive, because
21894 all the files in the directory (and any sub-directories) have to be
21895 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21896 &%maildir_use_size_file%& for ways to avoid this in environments where users
21897 have no shell access to their mailboxes).
21898
21899 As there is no interlock against two simultaneous deliveries into a
21900 multi-file mailbox, it is possible for the quota to be overrun in this case.
21901 For single-file mailboxes, of course, an interlock is a necessity.
21902
21903 A file's size is taken as its &'used'& value. Because of blocking effects, this
21904 may be a lot less than the actual amount of disk space allocated to the file.
21905 If the sizes of a number of files are being added up, the rounding effect can
21906 become quite noticeable, especially on systems that have large block sizes.
21907 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21908 the obvious value which users understand most easily.
21909
21910 The value of the option is expanded, and must then be a numerical value
21911 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21912 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21913 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21914 be handled.
21915
21916 &*Note*&: A value of zero is interpreted as &"no quota"&.
21917
21918 The expansion happens while Exim is running as root, before it changes uid for
21919 the delivery. This means that files that are inaccessible to the end user can
21920 be used to hold quota values that are looked up in the expansion. When delivery
21921 fails because this quota is exceeded, the handling of the error is as for
21922 system quota failures.
21923
21924 By default, Exim's quota checking mimics system quotas, and restricts the
21925 mailbox to the specified maximum size, though the value is not accurate to the
21926 last byte, owing to separator lines and additional headers that may get added
21927 during message delivery. When a mailbox is nearly full, large messages may get
21928 refused even though small ones are accepted, because the size of the current
21929 message is added to the quota when the check is made. This behaviour can be
21930 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21931 for exceeding the quota does not include the current message. Thus, deliveries
21932 continue until the quota has been exceeded; thereafter, no further messages are
21933 delivered. See also &%quota_warn_threshold%&.
21934
21935
21936 .option quota_directory appendfile string&!! unset
21937 This option defines the directory to check for quota purposes when delivering
21938 into individual files. The default is the delivery directory, or, if a file
21939 called &_maildirfolder_& exists in a maildir directory, the parent of the
21940 delivery directory.
21941
21942
21943 .option quota_filecount appendfile string&!! 0
21944 This option applies when the &%directory%& option is set. It limits the total
21945 number of files in the directory (compare the inode limit in system quotas). It
21946 can only be used if &%quota%& is also set. The value is expanded; an expansion
21947 failure causes delivery to be deferred. A value of zero is interpreted as
21948 &"no quota"&.
21949
21950
21951 .option quota_is_inclusive appendfile boolean true
21952 See &%quota%& above.
21953
21954
21955 .option quota_size_regex appendfile string unset
21956 This option applies when one of the delivery modes that writes a separate file
21957 for each message is being used. When Exim wants to find the size of one of
21958 these files in order to test the quota, it first checks &%quota_size_regex%&.
21959 If this is set to a regular expression that matches the file name, and it
21960 captures one string, that string is interpreted as a representation of the
21961 file's size. The value of &%quota_size_regex%& is not expanded.
21962
21963 This feature is useful only when users have no shell access to their mailboxes
21964 &-- otherwise they could defeat the quota simply by renaming the files. This
21965 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21966 the file length to the file name. For example:
21967 .code
21968 maildir_tag = ,S=$message_size
21969 quota_size_regex = ,S=(\d+)
21970 .endd
21971 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21972 number of lines in the message.
21973
21974 The regular expression should not assume that the length is at the end of the
21975 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21976 sometimes add other information onto the ends of message file names.
21977
21978 Section &<<SECID136>>& contains further information.
21979
21980
21981 .option quota_warn_message appendfile string&!! "see below"
21982 See below for the use of this option. If it is not set when
21983 &%quota_warn_threshold%& is set, it defaults to
21984 .code
21985 quota_warn_message = "\
21986   To: $local_part@$domain\n\
21987   Subject: Your mailbox\n\n\
21988   This message is automatically created \
21989   by mail delivery software.\n\n\
21990   The size of your mailbox has exceeded \
21991   a warning threshold that is\n\
21992   set by the system administrator.\n"
21993 .endd
21994
21995
21996 .option quota_warn_threshold appendfile string&!! 0
21997 .cindex "quota" "warning threshold"
21998 .cindex "mailbox" "size warning"
21999 .cindex "size" "of mailbox"
22000 This option is expanded in the same way as &%quota%& (see above). If the
22001 resulting value is greater than zero, and delivery of the message causes the
22002 size of the file or total space in the directory tree to cross the given
22003 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22004 may be specified as a percentage of it by following the value with a percent
22005 sign. For example:
22006 .code
22007 quota = 10M
22008 quota_warn_threshold = 75%
22009 .endd
22010 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22011 percent sign is ignored.
22012
22013 The warning message itself is specified by the &%quota_warn_message%& option,
22014 and it must start with a &'To:'& header line containing the recipient(s) of the
22015 warning message. These do not necessarily have to include the recipient(s) of
22016 the original message. A &'Subject:'& line should also normally be supplied. You
22017 can include any other header lines that you want. If you do not include a
22018 &'From:'& line, the default is:
22019 .code
22020 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22021 .endd
22022 .oindex &%errors_reply_to%&
22023 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22024 option.
22025
22026 The &%quota%& option does not have to be set in order to use this option; they
22027 are independent of one another except when the threshold is specified as a
22028 percentage.
22029
22030
22031 .option use_bsmtp appendfile boolean false
22032 .cindex "envelope sender"
22033 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22034 format, with the envelope sender and recipient(s) included as SMTP commands. If
22035 you want to include a leading HELO command with such messages, you can do
22036 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22037 for details of batch SMTP.
22038
22039
22040 .option use_crlf appendfile boolean false
22041 .cindex "carriage return"
22042 .cindex "linefeed"
22043 This option causes lines to be terminated with the two-character CRLF sequence
22044 (carriage return, linefeed) instead of just a linefeed character. In the case
22045 of batched SMTP, the byte sequence written to the file is then an exact image
22046 of what would be sent down a real SMTP connection.
22047
22048 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22049 (which are used to supply the traditional &"From&~"& and blank line separators
22050 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22051 carriage return characters if these are needed. In cases where these options
22052 have non-empty defaults, the values end with a single linefeed, so they must be
22053 changed to end with &`\r\n`& if &%use_crlf%& is set.
22054
22055
22056 .option use_fcntl_lock appendfile boolean "see below"
22057 This option controls the use of the &[fcntl()]& function to lock a file for
22058 exclusive use when a message is being appended. It is set by default unless
22059 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22060 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22061 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22062
22063
22064 .option use_flock_lock appendfile boolean false
22065 This option is provided to support the use of &[flock()]& for file locking, for
22066 the few situations where it is needed. Most modern operating systems support
22067 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22068 each other. Exim uses &[fcntl()]& locking by default.
22069
22070 This option is required only if you are using an operating system where
22071 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22072 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22073 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22074
22075 .cindex "Solaris" "&[flock()]& support"
22076 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22077 have it (and some, I think, provide a not quite right version built on top of
22078 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22079 the ability to use it, and any attempt to do so will cause a configuration
22080 error.
22081
22082 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22083 is just being mapped onto &[fcntl()]& by the OS).
22084
22085
22086 .option use_lockfile appendfile boolean "see below"
22087 If this option is turned off, Exim does not attempt to create a lock file when
22088 appending to a mailbox file. In this situation, the only locking is by
22089 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22090 sure that every MUA that is ever going to look at your users' mailboxes uses
22091 &[fcntl()]& rather than a lock file, and even then only when you are not
22092 delivering over NFS from more than one host.
22093
22094 .cindex "NFS" "lock file"
22095 In order to append to an NFS file safely from more than one host, it is
22096 necessary to take out a lock &'before'& opening the file, and the lock file
22097 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22098 file corruption.
22099
22100 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22101 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22102 except when &%mbx_format%& is set.
22103
22104
22105 .option use_mbx_lock appendfile boolean "see below"
22106 This option is available only if Exim has been compiled with SUPPORT_MBX
22107 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22108 locking rules be used. It is set by default if &%mbx_format%& is set and none
22109 of the locking options are mentioned in the configuration. The locking rules
22110 are the same as are used by the &'c-client'& library that underlies Pine and
22111 the IMAP4 and POP daemons that come with it (see the discussion below). The
22112 rules allow for shared access to the mailbox. However, this kind of locking
22113 does not work when the mailbox is NFS mounted.
22114
22115 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22116 &%use_flock_lock%& to control what kind of locking is used in implementing the
22117 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22118 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22119
22120
22121
22122
22123 .section "Operational details for appending" "SECTopappend"
22124 .cindex "appending to a file"
22125 .cindex "file" "appending"
22126 Before appending to a file, the following preparations are made:
22127
22128 .ilist
22129 If the name of the file is &_/dev/null_&, no action is taken, and a success
22130 return is given.
22131
22132 .next
22133 .cindex "directory creation"
22134 If any directories on the file's path are missing, Exim creates them if the
22135 &%create_directory%& option is set. A created directory's mode is given by the
22136 &%directory_mode%& option.
22137
22138 .next
22139 If &%file_format%& is set, the format of an existing file is checked. If this
22140 indicates that a different transport should be used, control is passed to that
22141 transport.
22142
22143 .next
22144 .cindex "file" "locking"
22145 .cindex "locking files"
22146 .cindex "NFS" "lock file"
22147 If &%use_lockfile%& is set, a lock file is built in a way that will work
22148 reliably over NFS, as follows:
22149
22150 .olist
22151 Create a &"hitching post"& file whose name is that of the lock file with the
22152 current time, primary host name, and process id added, by opening for writing
22153 as a new file. If this fails with an access error, delivery is deferred.
22154 .next
22155 Close the hitching post file, and hard link it to the lock file name.
22156 .next
22157 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22158 Unlink the hitching post name.
22159 .next
22160 Otherwise, use &[stat()]& to get information about the hitching post file, and
22161 then unlink hitching post name. If the number of links is exactly two, creation
22162 of the lock file succeeded but something (for example, an NFS server crash and
22163 restart) caused this fact not to be communicated to the &[link()]& call.
22164 .next
22165 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22166 up to &%lock_retries%& times. However, since any program that writes to a
22167 mailbox should complete its task very quickly, it is reasonable to time out old
22168 lock files that are normally the result of user agent and system crashes. If an
22169 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22170 it before trying again.
22171 .endlist olist
22172
22173 .next
22174 A call is made to &[lstat()]& to discover whether the main file exists, and if
22175 so, what its characteristics are. If &[lstat()]& fails for any reason other
22176 than non-existence, delivery is deferred.
22177
22178 .next
22179 .cindex "symbolic link" "to mailbox"
22180 .cindex "mailbox" "symbolic link"
22181 If the file does exist and is a symbolic link, delivery is deferred, unless the
22182 &%allow_symlink%& option is set, in which case the ownership of the link is
22183 checked, and then &[stat()]& is called to find out about the real file, which
22184 is then subjected to the checks below. The check on the top-level link
22185 ownership prevents one user creating a link for another's mailbox in a sticky
22186 directory, though allowing symbolic links in this case is definitely not a good
22187 idea. If there is a chain of symbolic links, the intermediate ones are not
22188 checked.
22189
22190 .next
22191 If the file already exists but is not a regular file, or if the file's owner
22192 and group (if the group is being checked &-- see &%check_group%& above) are
22193 different from the user and group under which the delivery is running,
22194 delivery is deferred.
22195
22196 .next
22197 If the file's permissions are more generous than specified, they are reduced.
22198 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22199 is set false, in which case the delivery is tried using the existing
22200 permissions.
22201
22202 .next
22203 The file's inode number is saved, and the file is then opened for appending.
22204 If this fails because the file has vanished, &(appendfile)& behaves as if it
22205 hadn't existed (see below). For any other failures, delivery is deferred.
22206
22207 .next
22208 If the file is opened successfully, check that the inode number hasn't
22209 changed, that it is still a regular file, and that the owner and permissions
22210 have not changed. If anything is wrong, defer delivery and freeze the message.
22211
22212 .next
22213 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22214 option is set. Otherwise, check that the file is being created in a permitted
22215 directory if the &%create_file%& option is set (deferring on failure), and then
22216 open for writing as a new file, with the O_EXCL and O_CREAT options,
22217 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22218 set). In this case, which can happen if the link points to a non-existent file,
22219 the file is opened for writing using O_CREAT but not O_EXCL, because
22220 that prevents link following.
22221
22222 .next
22223 .cindex "loop" "while file testing"
22224 If opening fails because the file exists, obey the tests given above for
22225 existing files. However, to avoid looping in a situation where the file is
22226 being continuously created and destroyed, the exists/not-exists loop is broken
22227 after 10 repetitions, and the message is then frozen.
22228
22229 .next
22230 If opening fails with any other error, defer delivery.
22231
22232 .next
22233 .cindex "file" "locking"
22234 .cindex "locking files"
22235 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22236 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22237 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22238 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22239 file, and an exclusive lock on the file whose name is
22240 .code
22241 /tmp/.<device-number>.<inode-number>
22242 .endd
22243 using the device and inode numbers of the open mailbox file, in accordance with
22244 the MBX locking rules. This file is created with a mode that is specified by
22245 the &%lockfile_mode%& option.
22246
22247 If Exim fails to lock the file, there are two possible courses of action,
22248 depending on the value of the locking timeout. This is obtained from
22249 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22250
22251 If the timeout value is zero, the file is closed, Exim waits for
22252 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22253 to lock it again. This happens up to &%lock_retries%& times, after which the
22254 delivery is deferred.
22255
22256 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22257 &[flock()]& are used (with the given timeout), so there has already been some
22258 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22259 immediately. It retries up to
22260 .code
22261 (lock_retries * lock_interval) / <timeout>
22262 .endd
22263 times (rounded up).
22264 .endlist
22265
22266 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22267 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22268
22269
22270 .section "Operational details for delivery to a new file" "SECTopdir"
22271 .cindex "delivery" "to single file"
22272 .cindex "&""From""& line"
22273 When the &%directory%& option is set instead of &%file%&, each message is
22274 delivered into a newly-created file or set of files. When &(appendfile)& is
22275 activated directly from a &(redirect)& router, neither &%file%& nor
22276 &%directory%& is normally set, because the path for delivery is supplied by the
22277 router. (See for example, the &(address_file)& transport in the default
22278 configuration.) In this case, delivery is to a new file if either the path name
22279 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22280
22281 No locking is required while writing the message to a new file, so the various
22282 locking options of the transport are ignored. The &"From"& line that by default
22283 separates messages in a single file is not normally needed, nor is the escaping
22284 of message lines that start with &"From"&, and there is no need to ensure a
22285 newline at the end of each message. Consequently, the default values for
22286 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22287 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22288
22289 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22290 the files in the delivery directory by default. However, you can specify a
22291 different directory by setting &%quota_directory%&. Also, for maildir
22292 deliveries (see below) the &_maildirfolder_& convention is honoured.
22293
22294
22295 .cindex "maildir format"
22296 .cindex "mailstore format"
22297 There are three different ways in which delivery to individual files can be
22298 done, controlled by the settings of the &%maildir_format%& and
22299 &%mailstore_format%& options. Note that code to support maildir or mailstore
22300 formats is not included in the binary unless SUPPORT_MAILDIR or
22301 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22302
22303 .cindex "directory creation"
22304 In all three cases an attempt is made to create the directory and any necessary
22305 sub-directories if they do not exist, provided that the &%create_directory%&
22306 option is set (the default). The location of a created directory can be
22307 constrained by setting &%create_file%&. A created directory's mode is given by
22308 the &%directory_mode%& option. If creation fails, or if the
22309 &%create_directory%& option is not set when creation is required, delivery is
22310 deferred.
22311
22312
22313
22314 .section "Maildir delivery" "SECTmaildirdelivery"
22315 .cindex "maildir format" "description of"
22316 If the &%maildir_format%& option is true, Exim delivers each message by writing
22317 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22318 directory that is defined by the &%directory%& option (the &"delivery
22319 directory"&). If the delivery is successful, the file is renamed into the
22320 &_new_& subdirectory.
22321
22322 In the file name, <&'stime'&> is the current time of day in seconds, and
22323 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22324 Exim checks that the time-of-day clock has moved on by at least one microsecond
22325 before terminating the delivery process. This guarantees uniqueness for the
22326 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22327 opening it. If any response other than ENOENT (does not exist) is given,
22328 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22329
22330 Before Exim carries out a maildir delivery, it ensures that subdirectories
22331 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22332 do not exist, Exim tries to create them and any superior directories in their
22333 path, subject to the &%create_directory%& and &%create_file%& options. If the
22334 &%maildirfolder_create_regex%& option is set, and the regular expression it
22335 contains matches the delivery directory, Exim also ensures that a file called
22336 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22337 &_maildirfolder_& file cannot be created, delivery is deferred.
22338
22339 These features make it possible to use Exim to create all the necessary files
22340 and directories in a maildir mailbox, including subdirectories for maildir++
22341 folders. Consider this example:
22342 .code
22343 maildir_format = true
22344 directory = /var/mail/$local_part\
22345            ${if eq{$local_part_suffix}{}{}\
22346            {/.${substr_1:$local_part_suffix}}}
22347 maildirfolder_create_regex = /\.[^/]+$
22348 .endd
22349 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22350 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22351 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22352 not match this name, so Exim will not look for or create the file
22353 &_/var/mail/pimbo/maildirfolder_&, though it will create
22354 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22355
22356 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22357 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22358 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22359 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22360 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22361
22362 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22363 not inadvertently match the toplevel maildir directory, because a
22364 &_maildirfolder_& file at top level would completely break quota calculations.
22365
22366 .cindex "quota" "in maildir delivery"
22367 .cindex "maildir++"
22368 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22369 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22370 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22371 Exim assumes the directory is a maildir++ folder directory, which is one level
22372 down from the user's top level mailbox directory. This causes it to start at
22373 the parent directory instead of the current directory when calculating the
22374 amount of space used.
22375
22376 One problem with delivering into a multi-file mailbox is that it is
22377 computationally expensive to compute the size of the mailbox for quota
22378 checking. Various approaches have been taken to reduce the amount of work
22379 needed. The next two sections describe two of them. A third alternative is to
22380 use some external process for maintaining the size data, and use the expansion
22381 of the &%mailbox_size%& option as a way of importing it into Exim.
22382
22383
22384
22385
22386 .section "Using tags to record message sizes" "SECID135"
22387 If &%maildir_tag%& is set, the string is expanded for each delivery.
22388 When the maildir file is renamed into the &_new_& sub-directory, the
22389 tag is added to its name. However, if adding the tag takes the length of the
22390 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22391 the tag is dropped and the maildir file is created with no tag.
22392
22393
22394 .vindex "&$message_size$&"
22395 Tags can be used to encode the size of files in their names; see
22396 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22397 happens after the message has been written. The value of the &$message_size$&
22398 variable is set to the number of bytes actually written. If the expansion is
22399 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22400 be deferred. The expanded tag may contain any printing characters except &"/"&.
22401 Non-printing characters in the string are ignored; if the resulting string is
22402 empty, it is ignored. If it starts with an alphanumeric character, a leading
22403 colon is inserted; this default has not proven to be the path that popular
22404 maildir implementations have chosen (but changing it in Exim would break
22405 backwards compatibility).
22406
22407 For one common implementation, you might set:
22408 .code
22409 maildir_tag = ,S=${message_size}
22410 .endd
22411 but you should check the documentation of the other software to be sure.
22412
22413 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22414 as this allows Exim to extract the size from your tag, instead of having to
22415 &[stat()]& each message file.
22416
22417
22418 .section "Using a maildirsize file" "SECID136"
22419 .cindex "quota" "in maildir delivery"
22420 .cindex "maildir format" "&_maildirsize_& file"
22421 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22422 storing quota and message size information in a file called &_maildirsize_&
22423 within the toplevel maildir directory. If this file does not exist, Exim
22424 creates it, setting the quota from the &%quota%& option of the transport. If
22425 the maildir directory itself does not exist, it is created before any attempt
22426 to write a &_maildirsize_& file.
22427
22428 The &_maildirsize_& file is used to hold information about the sizes of
22429 messages in the maildir, thus speeding up quota calculations. The quota value
22430 in the file is just a cache; if the quota is changed in the transport, the new
22431 value overrides the cached value when the next message is delivered. The cache
22432 is maintained for the benefit of other programs that access the maildir and
22433 need to know the quota.
22434
22435 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22436 file is maintained (with a zero quota setting), but no quota is imposed.
22437
22438 A regular expression is available for controlling which directories in the
22439 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22440 See the description of the &%maildir_quota_directory_regex%& option above for
22441 details.
22442
22443
22444 .section "Mailstore delivery" "SECID137"
22445 .cindex "mailstore format" "description of"
22446 If the &%mailstore_format%& option is true, each message is written as two
22447 files in the given directory. A unique base name is constructed from the
22448 message id and the current delivery process, and the files that are written use
22449 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22450 contains the message's envelope, and the &_.msg_& file contains the message
22451 itself. The base name is placed in the variable &$mailstore_basename$&.
22452
22453 During delivery, the envelope is first written to a file with the suffix
22454 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22455 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22456 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22457 file before accessing either of them. An alternative approach is to wait for
22458 the absence of a &_.tmp_& file.
22459
22460 The envelope file starts with any text defined by the &%mailstore_prefix%&
22461 option, expanded and terminated by a newline if there isn't one. Then follows
22462 the sender address on one line, then all the recipient addresses, one per line.
22463 There can be more than one recipient only if the &%batch_max%& option is set
22464 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22465 appended to the file, followed by a newline if it does not end with one.
22466
22467 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22468 failure, it is ignored. Other expansion errors are treated as serious
22469 configuration errors, and delivery is deferred. The variable
22470 &$mailstore_basename$& is available for use during these expansions.
22471
22472
22473 .section "Non-special new file delivery" "SECID138"
22474 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22475 file is created directly in the named directory. For example, when delivering
22476 messages into files in batched SMTP format for later delivery to some host (see
22477 section &<<SECTbatchSMTP>>&), a setting such as
22478 .code
22479 directory = /var/bsmtp/$host
22480 .endd
22481 might be used. A message is written to a file with a temporary name, which is
22482 then renamed when the delivery is complete. The final name is obtained by
22483 expanding the contents of the &%directory_file%& option.
22484 .ecindex IIDapptra1
22485 .ecindex IIDapptra2
22486
22487
22488
22489
22490
22491
22492 . ////////////////////////////////////////////////////////////////////////////
22493 . ////////////////////////////////////////////////////////////////////////////
22494
22495 .chapter "The autoreply transport" "CHID8"
22496 .scindex IIDauttra1 "transports" "&(autoreply)&"
22497 .scindex IIDauttra2 "&(autoreply)& transport"
22498 The &(autoreply)& transport is not a true transport in that it does not cause
22499 the message to be transmitted. Instead, it generates a new mail message as an
22500 automatic reply to the incoming message. &'References:'& and
22501 &'Auto-Submitted:'& header lines are included. These are constructed according
22502 to the rules in RFCs 2822 and 3834, respectively.
22503
22504 If the router that passes the message to this transport does not have the
22505 &%unseen%& option set, the original message (for the current recipient) is not
22506 delivered anywhere. However, when the &%unseen%& option is set on the router
22507 that passes the message to this transport, routing of the address continues, so
22508 another router can set up a normal message delivery.
22509
22510
22511 The &(autoreply)& transport is usually run as the result of mail filtering, a
22512 &"vacation"& message being the standard example. However, it can also be run
22513 directly from a router like any other transport. To reduce the possibility of
22514 message cascades, messages created by the &(autoreply)& transport always have
22515 empty envelope sender addresses, like bounce messages.
22516
22517 The parameters of the message to be sent can be specified in the configuration
22518 by options described below. However, these are used only when the address
22519 passed to the transport does not contain its own reply information. When the
22520 transport is run as a consequence of a
22521 &%mail%&
22522 or &%vacation%& command in a filter file, the parameters of the message are
22523 supplied by the filter, and passed with the address. The transport's options
22524 that define the message are then ignored (so they are not usually set in this
22525 case). The message is specified entirely by the filter or by the transport; it
22526 is never built from a mixture of options. However, the &%file_optional%&,
22527 &%mode%&, and &%return_message%& options apply in all cases.
22528
22529 &(Autoreply)& is implemented as a local transport. When used as a result of a
22530 command in a user's filter file, &(autoreply)& normally runs under the uid and
22531 gid of the user, and with appropriate current and home directories (see chapter
22532 &<<CHAPenvironment>>&).
22533
22534 There is a subtle difference between routing a message to a &(pipe)& transport
22535 that generates some text to be returned to the sender, and routing it to an
22536 &(autoreply)& transport. This difference is noticeable only if more than one
22537 address from the same message is so handled. In the case of a pipe, the
22538 separate outputs from the different addresses are gathered up and returned to
22539 the sender in a single message, whereas if &(autoreply)& is used, a separate
22540 message is generated for each address that is passed to it.
22541
22542 Non-printing characters are not permitted in the header lines generated for the
22543 message that &(autoreply)& creates, with the exception of newlines that are
22544 immediately followed by white space. If any non-printing characters are found,
22545 the transport defers.
22546 Whether characters with the top bit set count as printing characters or not is
22547 controlled by the &%print_topbitchars%& global option.
22548
22549 If any of the generic options for manipulating headers (for example,
22550 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22551 of the original message that is included in the generated message when
22552 &%return_message%& is set. They do not apply to the generated message itself.
22553
22554 .vindex "&$sender_address$&"
22555 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22556 the message, indicating that there were no recipients, it does not treat this
22557 as an error. This means that autoreplies sent to &$sender_address$& when this
22558 is empty (because the incoming message is a bounce message) do not cause
22559 problems. They are just discarded.
22560
22561
22562
22563 .section "Private options for autoreply" "SECID139"
22564 .cindex "options" "&(autoreply)& transport"
22565
22566 .option bcc autoreply string&!! unset
22567 This specifies the addresses that are to receive &"blind carbon copies"& of the
22568 message when the message is specified by the transport.
22569
22570
22571 .option cc autoreply string&!! unset
22572 This specifies recipients of the message and the contents of the &'Cc:'& header
22573 when the message is specified by the transport.
22574
22575
22576 .option file autoreply string&!! unset
22577 The contents of the file are sent as the body of the message when the message
22578 is specified by the transport. If both &%file%& and &%text%& are set, the text
22579 string comes first.
22580
22581
22582 .option file_expand autoreply boolean false
22583 If this is set, the contents of the file named by the &%file%& option are
22584 subjected to string expansion as they are added to the message.
22585
22586
22587 .option file_optional autoreply boolean false
22588 If this option is true, no error is generated if the file named by the &%file%&
22589 option or passed with the address does not exist or cannot be read.
22590
22591
22592 .option from autoreply string&!! unset
22593 This specifies the contents of the &'From:'& header when the message is
22594 specified by the transport.
22595
22596
22597 .option headers autoreply string&!! unset
22598 This specifies additional RFC 2822 headers that are to be added to the message
22599 when the message is specified by the transport. Several can be given by using
22600 &"\n"& to separate them. There is no check on the format.
22601
22602
22603 .option log autoreply string&!! unset
22604 This option names a file in which a record of every message sent is logged when
22605 the message is specified by the transport.
22606
22607
22608 .option mode autoreply "octal integer" 0600
22609 If either the log file or the &"once"& file has to be created, this mode is
22610 used.
22611
22612
22613 .option never_mail autoreply "address list&!!" unset
22614 If any run of the transport creates a message with a recipient that matches any
22615 item in the list, that recipient is quietly discarded. If all recipients are
22616 discarded, no message is created. This applies both when the recipients are
22617 generated by a filter and when they are specified in the transport.
22618
22619
22620
22621 .option once autoreply string&!! unset
22622 This option names a file or DBM database in which a record of each &'To:'&
22623 recipient is kept when the message is specified by the transport. &*Note*&:
22624 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22625
22626 If &%once%& is unset, or is set to an empty string, the message is always sent.
22627 By default, if &%once%& is set to a non-empty file name, the message
22628 is not sent if a potential recipient is already listed in the database.
22629 However, if the &%once_repeat%& option specifies a time greater than zero, the
22630 message is sent if that much time has elapsed since a message was last sent to
22631 this recipient. A setting of zero time for &%once_repeat%& (the default)
22632 prevents a message from being sent a second time &-- in this case, zero means
22633 infinity.
22634
22635 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22636 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22637 greater than zero, it changes the way Exim implements the &%once%& option.
22638 Instead of using a DBM file to record every recipient it sends to, it uses a
22639 regular file, whose size will never get larger than the given value.
22640
22641 In the file, Exim keeps a linear list of recipient addresses and the times at
22642 which they were sent messages. If the file is full when a new address needs to
22643 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22644 means that a given recipient may receive multiple messages, but at
22645 unpredictable intervals that depend on the rate of turnover of addresses in the
22646 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22647
22648
22649 .option once_file_size autoreply integer 0
22650 See &%once%& above.
22651
22652
22653 .option once_repeat autoreply time&!! 0s
22654 See &%once%& above.
22655 After expansion, the value of this option must be a valid time value.
22656
22657
22658 .option reply_to autoreply string&!! unset
22659 This specifies the contents of the &'Reply-To:'& header when the message is
22660 specified by the transport.
22661
22662
22663 .option return_message autoreply boolean false
22664 If this is set, a copy of the original message is returned with the new
22665 message, subject to the maximum size set in the &%return_size_limit%& global
22666 configuration option.
22667
22668
22669 .option subject autoreply string&!! unset
22670 This specifies the contents of the &'Subject:'& header when the message is
22671 specified by the transport. It is tempting to quote the original subject in
22672 automatic responses. For example:
22673 .code
22674 subject = Re: $h_subject:
22675 .endd
22676 There is a danger in doing this, however. It may allow a third party to
22677 subscribe your users to an opt-in mailing list, provided that the list accepts
22678 bounce messages as subscription confirmations. Well-managed lists require a
22679 non-bounce message to confirm a subscription, so the danger is relatively
22680 small.
22681
22682
22683
22684 .option text autoreply string&!! unset
22685 This specifies a single string to be used as the body of the message when the
22686 message is specified by the transport. If both &%text%& and &%file%& are set,
22687 the text comes first.
22688
22689
22690 .option to autoreply string&!! unset
22691 This specifies recipients of the message and the contents of the &'To:'& header
22692 when the message is specified by the transport.
22693 .ecindex IIDauttra1
22694 .ecindex IIDauttra2
22695
22696
22697
22698
22699 . ////////////////////////////////////////////////////////////////////////////
22700 . ////////////////////////////////////////////////////////////////////////////
22701
22702 .chapter "The lmtp transport" "CHAPLMTP"
22703 .cindex "transports" "&(lmtp)&"
22704 .cindex "&(lmtp)& transport"
22705 .cindex "LMTP" "over a pipe"
22706 .cindex "LMTP" "over a socket"
22707 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22708 specified command
22709 or by interacting with a Unix domain socket.
22710 This transport is something of a cross between the &(pipe)& and &(smtp)&
22711 transports. Exim also has support for using LMTP over TCP/IP; this is
22712 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22713 to be of minority interest, the default build-time configure in &_src/EDITME_&
22714 has it commented out. You need to ensure that
22715 .code
22716 TRANSPORT_LMTP=yes
22717 .endd
22718 .cindex "options" "&(lmtp)& transport"
22719 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22720 included in the Exim binary. The private options of the &(lmtp)& transport are
22721 as follows:
22722
22723 .option batch_id lmtp string&!! unset
22724 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22725
22726
22727 .option batch_max lmtp integer 1
22728 This limits the number of addresses that can be handled in a single delivery.
22729 Most LMTP servers can handle several addresses at once, so it is normally a
22730 good idea to increase this value. See the description of local delivery
22731 batching in chapter &<<CHAPbatching>>&.
22732
22733
22734 .option command lmtp string&!! unset
22735 This option must be set if &%socket%& is not set. The string is a command which
22736 is run in a separate process. It is split up into a command name and list of
22737 arguments, each of which is separately expanded (so expansion cannot change the
22738 number of arguments). The command is run directly, not via a shell. The message
22739 is passed to the new process using the standard input and output to operate the
22740 LMTP protocol.
22741
22742 .option ignore_quota lmtp boolean false
22743 .cindex "LMTP" "ignoring quota errors"
22744 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22745 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22746 in its response to the LHLO command.
22747
22748 .option socket lmtp string&!! unset
22749 This option must be set if &%command%& is not set. The result of expansion must
22750 be the name of a Unix domain socket. The transport connects to the socket and
22751 delivers the message to it using the LMTP protocol.
22752
22753
22754 .option timeout lmtp time 5m
22755 The transport is aborted if the created process or Unix domain socket does not
22756 respond to LMTP commands or message input within this timeout. Delivery
22757 is deferred, and will be tried again later. Here is an example of a typical
22758 LMTP transport:
22759 .code
22760 lmtp:
22761   driver = lmtp
22762   command = /some/local/lmtp/delivery/program
22763   batch_max = 20
22764   user = exim
22765 .endd
22766 This delivers up to 20 addresses at a time, in a mixture of domains if
22767 necessary, running as the user &'exim'&.
22768
22769
22770
22771 . ////////////////////////////////////////////////////////////////////////////
22772 . ////////////////////////////////////////////////////////////////////////////
22773
22774 .chapter "The pipe transport" "CHAPpipetransport"
22775 .scindex IIDpiptra1 "transports" "&(pipe)&"
22776 .scindex IIDpiptra2 "&(pipe)& transport"
22777 The &(pipe)& transport is used to deliver messages via a pipe to a command
22778 running in another process. One example is the use of &(pipe)& as a
22779 pseudo-remote transport for passing messages to some other delivery mechanism
22780 (such as UUCP). Another is the use by individual users to automatically process
22781 their incoming messages. The &(pipe)& transport can be used in one of the
22782 following ways:
22783
22784 .ilist
22785 .vindex "&$local_part$&"
22786 A router routes one address to a transport in the normal way, and the
22787 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22788 contains the local part of the address (as usual), and the command that is run
22789 is specified by the &%command%& option on the transport.
22790 .next
22791 .vindex "&$pipe_addresses$&"
22792 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22793 transport can handle more than one address in a single run. In this case, when
22794 more than one address is routed to the transport, &$local_part$& is not set
22795 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22796 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22797 that are routed to the transport.
22798 .next
22799 .vindex "&$address_pipe$&"
22800 A router redirects an address directly to a pipe command (for example, from an
22801 alias or forward file). In this case, &$address_pipe$& contains the text of the
22802 pipe command, and the &%command%& option on the transport is ignored unless
22803 &%force_command%& is set. If only one address is being transported
22804 (&%batch_max%& is not greater than one, or only one address was redirected to
22805 this pipe command), &$local_part$& contains the local part that was redirected.
22806 .endlist
22807
22808
22809 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22810 deliver messages over pipes using the LMTP interactive protocol. This is
22811 implemented by the &(lmtp)& transport.
22812
22813 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22814 &_.forward_& file, the command runs under the uid and gid of that user. In
22815 other cases, the uid and gid have to be specified explicitly, either on the
22816 transport or on the router that handles the address. Current and &"home"&
22817 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22818 details of the local delivery environment and chapter &<<CHAPbatching>>&
22819 for a discussion of local delivery batching.
22820
22821
22822 .section "Concurrent delivery" "SECID140"
22823 If two messages arrive at almost the same time, and both are routed to a pipe
22824 delivery, the two pipe transports may be run concurrently. You must ensure that
22825 any pipe commands you set up are robust against this happening. If the commands
22826 write to a file, the &%exim_lock%& utility might be of use.
22827 Alternatively the &%max_parallel%& option could be used with a value
22828 of "1" to enforce serialization.
22829
22830
22831
22832
22833 .section "Returned status and data" "SECID141"
22834 .cindex "&(pipe)& transport" "returned data"
22835 If the command exits with a non-zero return code, the delivery is deemed to
22836 have failed, unless either the &%ignore_status%& option is set (in which case
22837 the return code is treated as zero), or the return code is one of those listed
22838 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22839 later"&. In this case, delivery is deferred. Details of a permanent failure are
22840 logged, but are not included in the bounce message, which merely contains
22841 &"local delivery failed"&.
22842
22843 If the command exits on a signal and the &%freeze_signal%& option is set then
22844 the message will be frozen in the queue. If that option is not set, a bounce
22845 will be sent as normal.
22846
22847 If the return code is greater than 128 and the command being run is a shell
22848 script, it normally means that the script was terminated by a signal whose
22849 value is the return code minus 128. The &%freeze_signal%& option does not
22850 apply in this case.
22851
22852 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22853 return code is set to 127. This is the value that a shell returns if it is
22854 asked to run a non-existent command. The wording for the log line suggests that
22855 a non-existent command may be the problem.
22856
22857 The &%return_output%& option can affect the result of a pipe delivery. If it is
22858 set and the command produces any output on its standard output or standard
22859 error streams, the command is considered to have failed, even if it gave a zero
22860 return code or if &%ignore_status%& is set. The output from the command is
22861 included as part of the bounce message. The &%return_fail_output%& option is
22862 similar, except that output is returned only when the command exits with a
22863 failure return code, that is, a value other than zero or a code that matches
22864 &%temp_errors%&.
22865
22866
22867
22868 .section "How the command is run" "SECThowcommandrun"
22869 .cindex "&(pipe)& transport" "path for command"
22870 The command line is (by default) broken down into a command name and arguments
22871 by the &(pipe)& transport itself. The &%allow_commands%& and
22872 &%restrict_to_path%& options can be used to restrict the commands that may be
22873 run.
22874
22875 .cindex "quoting" "in pipe command"
22876 Unquoted arguments are delimited by white space. If an argument appears in
22877 double quotes, backslash is interpreted as an escape character in the usual
22878 way. If an argument appears in single quotes, no escaping is done.
22879
22880 String expansion is applied to the command line except when it comes from a
22881 traditional &_.forward_& file (commands from a filter file are expanded). The
22882 expansion is applied to each argument in turn rather than to the whole line.
22883 For this reason, any string expansion item that contains white space must be
22884 quoted so as to be contained within a single argument. A setting such as
22885 .code
22886 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22887 .endd
22888 will not work, because the expansion item gets split between several
22889 arguments. You have to write
22890 .code
22891 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22892 .endd
22893 to ensure that it is all in one argument. The expansion is done in this way,
22894 argument by argument, so that the number of arguments cannot be changed as a
22895 result of expansion, and quotes or backslashes in inserted variables do not
22896 interact with external quoting. However, this leads to problems if you want to
22897 generate multiple arguments (or the command name plus arguments) from a single
22898 expansion. In this situation, the simplest solution is to use a shell. For
22899 example:
22900 .code
22901 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22902 .endd
22903
22904 .cindex "transport" "filter"
22905 .cindex "filter" "transport filter"
22906 .vindex "&$pipe_addresses$&"
22907 Special handling takes place when an argument consists of precisely the text
22908 &`$pipe_addresses`&. This is not a general expansion variable; the only
22909 place this string is recognized is when it appears as an argument for a pipe or
22910 transport filter command. It causes each address that is being handled to be
22911 inserted in the argument list at that point &'as a separate argument'&. This
22912 avoids any problems with spaces or shell metacharacters, and is of use when a
22913 &(pipe)& transport is handling groups of addresses in a batch.
22914
22915 If &%force_command%& is enabled on the transport, Special handling takes place
22916 for an argument that consists of precisely the text &`$address_pipe`&.  It
22917 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22918 argument is inserted in the argument list at that point
22919 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22920 the only item in the argument; in fact, if it were then &%force_command%&
22921 should behave as a no-op.  Rather, it should be used to adjust the command
22922 run while preserving the argument vector separation.
22923
22924 After splitting up into arguments and expansion, the resulting command is run
22925 in a subprocess directly from the transport, &'not'& under a shell. The
22926 message that is being delivered is supplied on the standard input, and the
22927 standard output and standard error are both connected to a single pipe that is
22928 read by Exim. The &%max_output%& option controls how much output the command
22929 may produce, and the &%return_output%& and &%return_fail_output%& options
22930 control what is done with it.
22931
22932 Not running the command under a shell (by default) lessens the security risks
22933 in cases when a command from a user's filter file is built out of data that was
22934 taken from an incoming message. If a shell is required, it can of course be
22935 explicitly specified as the command to be run. However, there are circumstances
22936 where existing commands (for example, in &_.forward_& files) expect to be run
22937 under a shell and cannot easily be modified. To allow for these cases, there is
22938 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22939 works. Instead of breaking up the command line as just described, it expands it
22940 as a single string and passes the result to &_/bin/sh_&. The
22941 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22942 with &%use_shell%&, and the whole mechanism is inherently less secure.
22943
22944
22945
22946 .section "Environment variables" "SECTpipeenv"
22947 .cindex "&(pipe)& transport" "environment for command"
22948 .cindex "environment" "&(pipe)& transport"
22949 The environment variables listed below are set up when the command is invoked.
22950 This list is a compromise for maximum compatibility with other MTAs. Note that
22951 the &%environment%& option can be used to add additional variables to this
22952 environment. The environment for the &(pipe)& transport is not subject
22953 to the &%add_environment%& and &%keep_environment%& main config options.
22954 .display
22955 &`DOMAIN            `&   the domain of the address
22956 &`HOME              `&   the home directory, if set
22957 &`HOST              `&   the host name when called from a router (see below)
22958 &`LOCAL_PART        `&   see below
22959 &`LOCAL_PART_PREFIX `&   see below
22960 &`LOCAL_PART_SUFFIX `&   see below
22961 &`LOGNAME           `&   see below
22962 &`MESSAGE_ID        `&   Exim's local ID for the message
22963 &`PATH              `&   as specified by the &%path%& option below
22964 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22965 &`RECIPIENT         `&   the complete recipient address
22966 &`SENDER            `&   the sender of the message (empty if a bounce)
22967 &`SHELL             `&   &`/bin/sh`&
22968 &`TZ                `&   the value of the &%timezone%& option, if set
22969 &`USER              `&   see below
22970 .endd
22971 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22972 router, LOCAL_PART is set to the local part of the address. When it is
22973 called as a result of a forward or alias expansion, LOCAL_PART is set to
22974 the local part of the address that was expanded. In both cases, any affixes are
22975 removed from the local part, and made available in LOCAL_PART_PREFIX and
22976 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22977 same value as LOCAL_PART for compatibility with other MTAs.
22978
22979 .cindex "HOST"
22980 HOST is set only when a &(pipe)& transport is called from a router that
22981 associates hosts with an address, typically when using &(pipe)& as a
22982 pseudo-remote transport. HOST is set to the first host name specified by
22983 the router.
22984
22985 .cindex "HOME"
22986 If the transport's generic &%home_directory%& option is set, its value is used
22987 for the HOME environment variable. Otherwise, a home directory may be set
22988 by the router's &%transport_home_directory%& option, which defaults to the
22989 user's home directory if &%check_local_user%& is set.
22990
22991
22992 .section "Private options for pipe" "SECID142"
22993 .cindex "options" "&(pipe)& transport"
22994
22995
22996
22997 .option allow_commands pipe "string list&!!" unset
22998 .cindex "&(pipe)& transport" "permitted commands"
22999 The string is expanded, and is then interpreted as a colon-separated list of
23000 permitted commands. If &%restrict_to_path%& is not set, the only commands
23001 permitted are those in the &%allow_commands%& list. They need not be absolute
23002 paths; the &%path%& option is still used for relative paths. If
23003 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23004 in the &%allow_commands%& list, or a name without any slashes that is found on
23005 the path. In other words, if neither &%allow_commands%& nor
23006 &%restrict_to_path%& is set, there is no restriction on the command, but
23007 otherwise only commands that are permitted by one or the other are allowed. For
23008 example, if
23009 .code
23010 allow_commands = /usr/bin/vacation
23011 .endd
23012 and &%restrict_to_path%& is not set, the only permitted command is
23013 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23014 &%use_shell%& is set.
23015
23016
23017 .option batch_id pipe string&!! unset
23018 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23019
23020
23021 .option batch_max pipe integer 1
23022 This limits the number of addresses that can be handled in a single delivery.
23023 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23024
23025
23026 .option check_string pipe string unset
23027 As &(pipe)& writes the message, the start of each line is tested for matching
23028 &%check_string%&, and if it does, the initial matching characters are replaced
23029 by the contents of &%escape_string%&, provided both are set. The value of
23030 &%check_string%& is a literal string, not a regular expression, and the case of
23031 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23032 of &%check_string%& and &%escape_string%& are forced to values that implement
23033 the SMTP escaping protocol. Any settings made in the configuration file are
23034 ignored.
23035
23036
23037 .option command pipe string&!! unset
23038 This option need not be set when &(pipe)& is being used to deliver to pipes
23039 obtained directly from address redirections. In other cases, the option must be
23040 set, to provide a command to be run. It need not yield an absolute path (see
23041 the &%path%& option below). The command is split up into separate arguments by
23042 Exim, and each argument is separately expanded, as described in section
23043 &<<SECThowcommandrun>>& above.
23044
23045
23046 .option environment pipe string&!! unset
23047 .cindex "&(pipe)& transport" "environment for command"
23048 .cindex "environment" "&(pipe)& transport"
23049 This option is used to add additional variables to the environment in which the
23050 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23051 a string which is expanded, and then interpreted as a colon-separated list of
23052 environment settings of the form <&'name'&>=<&'value'&>.
23053
23054
23055 .option escape_string pipe string unset
23056 See &%check_string%& above.
23057
23058
23059 .option freeze_exec_fail pipe boolean false
23060 .cindex "exec failure"
23061 .cindex "failure of exec"
23062 .cindex "&(pipe)& transport" "failure of exec"
23063 Failure to exec the command in a pipe transport is by default treated like
23064 any other failure while running the command. However, if &%freeze_exec_fail%&
23065 is set, failure to exec is treated specially, and causes the message to be
23066 frozen, whatever the setting of &%ignore_status%&.
23067
23068
23069 .option freeze_signal pipe boolean false
23070 .cindex "signal exit"
23071 .cindex "&(pipe)& transport", "signal exit"
23072 Normally if the process run by a command in a pipe transport exits on a signal,
23073 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23074 frozen in Exim's queue instead.
23075
23076
23077 .option force_command pipe boolean false
23078 .cindex "force command"
23079 .cindex "&(pipe)& transport", "force command"
23080 Normally when a router redirects an address directly to a pipe command
23081 the &%command%& option on the transport is ignored.  If &%force_command%&
23082 is set, the &%command%& option will used. This is especially
23083 useful for forcing a wrapper or additional argument to be added to the
23084 command. For example:
23085 .code
23086 command = /usr/bin/remote_exec myhost -- $address_pipe
23087 force_command
23088 .endd
23089
23090 Note that &$address_pipe$& is handled specially in &%command%& when
23091 &%force_command%& is set, expanding out to the original argument vector as
23092 separate items, similarly to a Unix shell &`"$@"`& construct.
23093
23094
23095 .option ignore_status pipe boolean false
23096 If this option is true, the status returned by the subprocess that is set up to
23097 run the command is ignored, and Exim behaves as if zero had been returned.
23098 Otherwise, a non-zero status or termination by signal causes an error return
23099 from the transport unless the status value is one of those listed in
23100 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23101
23102 &*Note*&: This option does not apply to timeouts, which do not return a status.
23103 See the &%timeout_defer%& option for how timeouts are handled.
23104
23105
23106 .option log_defer_output pipe boolean false
23107 .cindex "&(pipe)& transport" "logging output"
23108 If this option is set, and the status returned by the command is
23109 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23110 and any output was produced on stdout or stderr, the first line of it is
23111 written to the main log.
23112
23113
23114 .option log_fail_output pipe boolean false
23115 If this option is set, and the command returns any output on stdout or
23116 stderr, and also ends with a return code that is neither zero nor one of
23117 the return codes listed in &%temp_errors%& (that is, the delivery
23118 failed), the first line of output is written to the main log. This
23119 option and &%log_output%& are mutually exclusive.  Only one of them may
23120 be set.
23121
23122
23123 .option log_output pipe boolean false
23124 If this option is set and the command returns any output on stdout or
23125 stderr, the first line of output is written to the main log, whatever
23126 the return code. This option and &%log_fail_output%& are mutually
23127 exclusive. Only one of them may be set.
23128
23129
23130 .option max_output pipe integer 20K
23131 This specifies the maximum amount of output that the command may produce on its
23132 standard output and standard error file combined. If the limit is exceeded, the
23133 process running the command is killed. This is intended as a safety measure to
23134 catch runaway processes. The limit is applied independently of the settings of
23135 the options that control what is done with such output (for example,
23136 &%return_output%&). Because of buffering effects, the amount of output may
23137 exceed the limit by a small amount before Exim notices.
23138
23139
23140 .option message_prefix pipe string&!! "see below"
23141 The string specified here is expanded and output at the start of every message.
23142 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23143 .code
23144 message_prefix = \
23145   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23146   ${tod_bsdinbox}\n
23147 .endd
23148 .cindex "Cyrus"
23149 .cindex "&%tmail%&"
23150 .cindex "&""From""& line"
23151 This is required by the commonly used &_/usr/bin/vacation_& program.
23152 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23153 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23154 setting
23155 .code
23156 message_prefix =
23157 .endd
23158 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23159 &`\n`& to &`\r\n`& in &%message_prefix%&.
23160
23161
23162 .option message_suffix pipe string&!! "see below"
23163 The string specified here is expanded and output at the end of every message.
23164 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23165 The suffix can be suppressed by setting
23166 .code
23167 message_suffix =
23168 .endd
23169 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23170 &`\n`& to &`\r\n`& in &%message_suffix%&.
23171
23172
23173 .option path pipe string "see below"
23174 This option specifies the string that is set up in the PATH environment
23175 variable of the subprocess. The default is:
23176 .code
23177 /bin:/usr/bin
23178 .endd
23179 If the &%command%& option does not yield an absolute path name, the command is
23180 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23181 apply to a command specified as a transport filter.
23182
23183
23184 .option permit_coredump pipe boolean false
23185 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23186 a core-dump of a pipe command, enable this command.  This enables core-dumps
23187 during delivery and affects both the Exim binary and the pipe command run.
23188 It is recommended that this option remain off unless and until you have a need
23189 for it and that this only be enabled when needed, as the risk of excessive
23190 resource consumption can be quite high.  Note also that Exim is typically
23191 installed as a setuid binary and most operating systems will inhibit coredumps
23192 of these by default, so further OS-specific action may be required.
23193
23194
23195 .option pipe_as_creator pipe boolean false
23196 .cindex "uid (user id)" "local delivery"
23197 If the generic &%user%& option is not set and this option is true, the delivery
23198 process is run under the uid that was in force when Exim was originally called
23199 to accept the message. If the group id is not otherwise set (via the generic
23200 &%group%& option), the gid that was in force when Exim was originally called to
23201 accept the message is used.
23202
23203
23204 .option restrict_to_path pipe boolean false
23205 When this option is set, any command name not listed in &%allow_commands%& must
23206 contain no slashes. The command is searched for only in the directories listed
23207 in the &%path%& option. This option is intended for use in the case when a pipe
23208 command has been generated from a user's &_.forward_& file. This is usually
23209 handled by a &(pipe)& transport called &%address_pipe%&.
23210
23211
23212 .option return_fail_output pipe boolean false
23213 If this option is true, and the command produced any output and ended with a
23214 return code other than zero or one of the codes listed in &%temp_errors%& (that
23215 is, the delivery failed), the output is returned in the bounce message.
23216 However, if the message has a null sender (that is, it is itself a bounce
23217 message), output from the command is discarded. This option and
23218 &%return_output%& are mutually exclusive. Only one of them may be set.
23219
23220
23221
23222 .option return_output pipe boolean false
23223 If this option is true, and the command produced any output, the delivery is
23224 deemed to have failed whatever the return code from the command, and the output
23225 is returned in the bounce message. Otherwise, the output is just discarded.
23226 However, if the message has a null sender (that is, it is a bounce message),
23227 output from the command is always discarded, whatever the setting of this
23228 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23229 of them may be set.
23230
23231
23232
23233 .option temp_errors pipe "string list" "see below"
23234 .cindex "&(pipe)& transport" "temporary failure"
23235 This option contains either a colon-separated list of numbers, or a single
23236 asterisk. If &%ignore_status%& is false
23237 and &%return_output%& is not set,
23238 and the command exits with a non-zero return code, the failure is treated as
23239 temporary and the delivery is deferred if the return code matches one of the
23240 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23241 codes are treated as permanent errors. The default setting contains the codes
23242 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23243 compiled on a system that does not define these macros, it assumes values of 75
23244 and 73, respectively.
23245
23246
23247 .option timeout pipe time 1h
23248 If the command fails to complete within this time, it is killed. This normally
23249 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23250 specifies no timeout. In order to ensure that any subprocesses created by the
23251 command are also killed, Exim makes the initial process a process group leader,
23252 and kills the whole process group on a timeout. However, this can be defeated
23253 if one of the processes starts a new process group.
23254
23255 .option timeout_defer pipe boolean false
23256 A timeout in a &(pipe)& transport, either in the command that the transport
23257 runs, or in a transport filter that is associated with it, is by default
23258 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23259 is set true, both kinds of timeout become temporary errors, causing the
23260 delivery to be deferred.
23261
23262 .option umask pipe "octal integer" 022
23263 This specifies the umask setting for the subprocess that runs the command.
23264
23265
23266 .option use_bsmtp pipe boolean false
23267 .cindex "envelope sender"
23268 If this option is set true, the &(pipe)& transport writes messages in &"batch
23269 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23270 commands. If you want to include a leading HELO command with such messages,
23271 you can do so by setting the &%message_prefix%& option. See section
23272 &<<SECTbatchSMTP>>& for details of batch SMTP.
23273
23274 .option use_classresources pipe boolean false
23275 .cindex "class resources (BSD)"
23276 This option is available only when Exim is running on FreeBSD, NetBSD, or
23277 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23278 resource limits when a &(pipe)& transport is run to perform a delivery. The
23279 limits for the uid under which the pipe is to run are obtained from the login
23280 class database.
23281
23282
23283 .option use_crlf pipe boolean false
23284 .cindex "carriage return"
23285 .cindex "linefeed"
23286 This option causes lines to be terminated with the two-character CRLF sequence
23287 (carriage return, linefeed) instead of just a linefeed character. In the case
23288 of batched SMTP, the byte sequence written to the pipe is then an exact image
23289 of what would be sent down a real SMTP connection.
23290
23291 The contents of the &%message_prefix%& and &%message_suffix%& options are
23292 written verbatim, so must contain their own carriage return characters if these
23293 are needed. When &%use_bsmtp%& is not set, the default values for both
23294 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23295 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23296
23297
23298 .option use_shell pipe boolean false
23299 .vindex "&$pipe_addresses$&"
23300 If this option is set, it causes the command to be passed to &_/bin/sh_&
23301 instead of being run directly from the transport, as described in section
23302 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23303 where the command is expected to be run under a shell and cannot easily be
23304 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23305 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23306 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23307 its &%-c%& option.
23308
23309
23310
23311 .section "Using an external local delivery agent" "SECID143"
23312 .cindex "local delivery" "using an external agent"
23313 .cindex "&'procmail'&"
23314 .cindex "external local delivery"
23315 .cindex "delivery" "&'procmail'&"
23316 .cindex "delivery" "by external agent"
23317 The &(pipe)& transport can be used to pass all messages that require local
23318 delivery to a separate local delivery agent such as &%procmail%&. When doing
23319 this, care must be taken to ensure that the pipe is run under an appropriate
23320 uid and gid. In some configurations one wants this to be a uid that is trusted
23321 by the delivery agent to supply the correct sender of the message. It may be
23322 necessary to recompile or reconfigure the delivery agent so that it trusts an
23323 appropriate user. The following is an example transport and router
23324 configuration for &%procmail%&:
23325 .code
23326 # transport
23327 procmail_pipe:
23328   driver = pipe
23329   command = /usr/local/bin/procmail -d $local_part
23330   return_path_add
23331   delivery_date_add
23332   envelope_to_add
23333   check_string = "From "
23334   escape_string = ">From "
23335   umask = 077
23336   user = $local_part
23337   group = mail
23338
23339 # router
23340 procmail:
23341   driver = accept
23342   check_local_user
23343   transport = procmail_pipe
23344 .endd
23345 In this example, the pipe is run as the local user, but with the group set to
23346 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23347 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23348 user to supply a correct sender address. If you do not specify either a
23349 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23350 home directory is the user's home directory by default.
23351
23352 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23353 .code
23354 IFS=" "
23355 .endd
23356 as shown in some &%procmail%& documentation, because Exim does not by default
23357 use a shell to run pipe commands.
23358
23359 .cindex "Cyrus"
23360 The next example shows a transport and a router for a system where local
23361 deliveries are handled by the Cyrus IMAP server.
23362 .code
23363 # transport
23364 local_delivery_cyrus:
23365   driver = pipe
23366   command = /usr/cyrus/bin/deliver \
23367             -m ${substr_1:$local_part_suffix} -- $local_part
23368   user = cyrus
23369   group = mail
23370   return_output
23371   log_output
23372   message_prefix =
23373   message_suffix =
23374
23375 # router
23376 local_user_cyrus:
23377   driver = accept
23378   check_local_user
23379   local_part_suffix = .*
23380   transport = local_delivery_cyrus
23381 .endd
23382 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23383 &%return_output%& to cause any text written by Cyrus to be returned to the
23384 sender.
23385 .ecindex IIDpiptra1
23386 .ecindex IIDpiptra2
23387
23388
23389 . ////////////////////////////////////////////////////////////////////////////
23390 . ////////////////////////////////////////////////////////////////////////////
23391
23392 .chapter "The smtp transport" "CHAPsmtptrans"
23393 .scindex IIDsmttra1 "transports" "&(smtp)&"
23394 .scindex IIDsmttra2 "&(smtp)& transport"
23395 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23396 or LMTP protocol. The list of hosts to try can either be taken from the address
23397 that is being processed (having been set up by the router), or specified
23398 explicitly for the transport. Timeout and retry processing (see chapter
23399 &<<CHAPretry>>&) is applied to each IP address independently.
23400
23401
23402 .section "Multiple messages on a single connection" "SECID144"
23403 The sending of multiple messages over a single TCP/IP connection can arise in
23404 two ways:
23405
23406 .ilist
23407 If a message contains more than &%max_rcpt%& (see below) addresses that are
23408 routed to the same host, more than one copy of the message has to be sent to
23409 that host. In this situation, multiple copies may be sent in a single run of
23410 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23411 does when it has too many addresses to send in one message also depends on the
23412 value of the global &%remote_max_parallel%& option. Details are given in
23413 section &<<SECToutSMTPTCP>>&.)
23414 .next
23415 .cindex "hints database" "remembering routing"
23416 When a message has been successfully delivered over a TCP/IP connection, Exim
23417 looks in its hints database to see if there are any other messages awaiting a
23418 connection to the same host. If there are, a new delivery process is started
23419 for one of them, and the current TCP/IP connection is passed on to it. The new
23420 process may in turn send multiple copies and possibly create yet another
23421 process.
23422 .endlist
23423
23424
23425 For each copy sent over the same TCP/IP connection, a sequence counter is
23426 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23427 no further messages are sent over that connection.
23428
23429
23430
23431 .section "Use of the $host and $host_address variables" "SECID145"
23432 .vindex "&$host$&"
23433 .vindex "&$host_address$&"
23434 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23435 &$host_address$& are the name and IP address of the first host on the host list
23436 passed by the router. However, when the transport is about to connect to a
23437 specific host, and while it is connected to that host, &$host$& and
23438 &$host_address$& are set to the values for that host. These are the values
23439 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23440 &%serialize_hosts%&, and the various TLS options are expanded.
23441
23442
23443 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23444 .vindex &$tls_bits$&
23445 .vindex &$tls_cipher$&
23446 .vindex &$tls_peerdn$&
23447 .vindex &$tls_sni$&
23448 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23449 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23450 are the values that were set when the message was received.
23451 These are the values that are used for options that are expanded before any
23452 SMTP connections are made. Just before each connection is made, these four
23453 variables are emptied. If TLS is subsequently started, they are set to the
23454 appropriate values for the outgoing connection, and these are the values that
23455 are in force when any authenticators are run and when the
23456 &%authenticated_sender%& option is expanded.
23457
23458 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23459 and will be removed in a future release.
23460
23461
23462 .section "Private options for smtp" "SECID146"
23463 .cindex "options" "&(smtp)& transport"
23464 The private options of the &(smtp)& transport are as follows:
23465
23466
23467 .option address_retry_include_sender smtp boolean true
23468 .cindex "4&'xx'& responses" "retrying after"
23469 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23470 is the combination of sender and recipient that is delayed in subsequent queue
23471 runs until the retry time is reached. You can delay the recipient without
23472 reference to the sender (which is what earlier versions of Exim did), by
23473 setting &%address_retry_include_sender%& false. However, this can lead to
23474 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23475
23476 .option allow_localhost smtp boolean false
23477 .cindex "local host" "sending to"
23478 .cindex "fallback" "hosts specified on transport"
23479 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23480 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23481 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23482 the delivery anyway. This should be used only in special cases when the
23483 configuration ensures that no looping will result (for example, a differently
23484 configured Exim is listening on the port to which the message is sent).
23485
23486
23487 .option authenticated_sender smtp string&!! unset
23488 .cindex "Cyrus"
23489 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23490 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23491 overriding any existing authenticated sender value. If the string expansion is
23492 forced to fail, the option is ignored. Other expansion failures cause delivery
23493 to be deferred. If the result of expansion is an empty string, that is also
23494 ignored.
23495
23496 The expansion happens after the outgoing connection has been made and TLS
23497 started, if required. This means that the &$host$&, &$host_address$&,
23498 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23499 particular connection.
23500
23501 If the SMTP session is not authenticated, the expansion of
23502 &%authenticated_sender%& still happens (and can cause the delivery to be
23503 deferred if it fails), but no AUTH= item is added to MAIL commands
23504 unless &%authenticated_sender_force%& is true.
23505
23506 This option allows you to use the &(smtp)& transport in LMTP mode to
23507 deliver mail to Cyrus IMAP and provide the proper local part as the
23508 &"authenticated sender"&, via a setting such as:
23509 .code
23510 authenticated_sender = $local_part
23511 .endd
23512 This removes the need for IMAP subfolders to be assigned special ACLs to
23513 allow direct delivery to those subfolders.
23514
23515 Because of expected uses such as that just described for Cyrus (when no
23516 domain is involved), there is no checking on the syntax of the provided
23517 value.
23518
23519
23520 .option authenticated_sender_force smtp boolean false
23521 If this option is set true, the &%authenticated_sender%& option's value
23522 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23523 authenticated as a client.
23524
23525
23526 .option command_timeout smtp time 5m
23527 This sets a timeout for receiving a response to an SMTP command that has been
23528 sent out. It is also used when waiting for the initial banner line from the
23529 remote host. Its value must not be zero.
23530
23531
23532 .option connect_timeout smtp time 5m
23533 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23534 to a remote host. A setting of zero allows the system timeout (typically
23535 several minutes) to act. To have any effect, the value of this option must be
23536 less than the system timeout. However, it has been observed that on some
23537 systems there is no system timeout, which is why the default value for this
23538 option is 5 minutes, a value recommended by RFC 1123.
23539
23540
23541 .option connection_max_messages smtp integer 500
23542 .cindex "SMTP" "passed connection"
23543 .cindex "SMTP" "multiple deliveries"
23544 .cindex "multiple SMTP deliveries"
23545 This controls the maximum number of separate message deliveries that are sent
23546 over a single TCP/IP connection. If the value is zero, there is no limit.
23547 For testing purposes, this value can be overridden by the &%-oB%& command line
23548 option.
23549
23550
23551 .option data_timeout smtp time 5m
23552 This sets a timeout for the transmission of each block in the data portion of
23553 the message. As a result, the overall timeout for a message depends on the size
23554 of the message. Its value must not be zero. See also &%final_timeout%&.
23555
23556
23557 .option dkim_domain smtp string&!! unset
23558 .option dkim_selector smtp string&!! unset
23559 .option dkim_private_key smtp string&!! unset
23560 .option dkim_canon smtp string&!! unset
23561 .option dkim_strict smtp string&!! unset
23562 .option dkim_sign_headers smtp string&!! unset
23563 DKIM signing options.  For details see &<<SECDKIMSIGN>>&.
23564
23565
23566 .option delay_after_cutoff smtp boolean true
23567 This option controls what happens when all remote IP addresses for a given
23568 domain have been inaccessible for so long that they have passed their retry
23569 cutoff times.
23570
23571 In the default state, if the next retry time has not been reached for any of
23572 them, the address is bounced without trying any deliveries. In other words,
23573 Exim delays retrying an IP address after the final cutoff time until a new
23574 retry time is reached, and can therefore bounce an address without ever trying
23575 a delivery, when machines have been down for a long time. Some people are
23576 unhappy at this prospect, so...
23577
23578 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23579 addresses are past their final cutoff time, Exim tries to deliver to those
23580 IP addresses that have not been tried since the message arrived. If there are
23581 none, of if they all fail, the address is bounced. In other words, it does not
23582 delay when a new message arrives, but immediately tries those expired IP
23583 addresses that haven't been tried since the message arrived. If there is a
23584 continuous stream of messages for the dead hosts, unsetting
23585 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23586 to them.
23587
23588
23589 .option dns_qualify_single smtp boolean true
23590 If the &%hosts%& or &%fallback_hosts%& option is being used,
23591 and the &%gethostbyname%& option is false,
23592 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23593 in chapter &<<CHAPdnslookup>>& for more details.
23594
23595
23596 .option dns_search_parents smtp boolean false
23597 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23598 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23599 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23600 details.
23601
23602
23603 .option dnssec_request_domains smtp "domain list&!!" unset
23604 .cindex "MX record" "security"
23605 .cindex "DNSSEC" "MX lookup"
23606 .cindex "security" "MX lookup"
23607 .cindex "DNS" "DNSSEC"
23608 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23609 the dnssec request bit set.
23610 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23611
23612
23613
23614 .option dnssec_require_domains smtp "domain list&!!" unset
23615 .cindex "MX record" "security"
23616 .cindex "DNSSEC" "MX lookup"
23617 .cindex "security" "MX lookup"
23618 .cindex "DNS" "DNSSEC"
23619 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
23620 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23621 (AD bit) set will be ignored and logged as a host-lookup failure.
23622 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23623
23624
23625
23626 .option dscp smtp string&!! unset
23627 .cindex "DCSP" "outbound"
23628 This option causes the DSCP value associated with a socket to be set to one
23629 of a number of fixed strings or to numeric value.
23630 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23631 Common values include &`throughput`&, &`mincost`&, and on newer systems
23632 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23633
23634 The outbound packets from Exim will be marked with this value in the header
23635 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23636 that these values will have any effect, not be stripped by networking
23637 equipment, or do much of anything without cooperation with your Network
23638 Engineer and those of all network operators between the source and destination.
23639
23640
23641 .option fallback_hosts smtp "string list" unset
23642 .cindex "fallback" "hosts specified on transport"
23643 String expansion is not applied to this option. The argument must be a
23644 colon-separated list of host names or IP addresses, optionally also including
23645 port numbers, though the separator can be changed, as described in section
23646 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23647 item in a &%route_list%& setting for the &(manualroute)& router, as described
23648 in section &<<SECTformatonehostitem>>&.
23649
23650 Fallback hosts can also be specified on routers, which associate them with the
23651 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23652 &%fallback_hosts%& specified on the transport is used only if the address does
23653 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23654 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23655 However, &%hosts_randomize%& does apply to fallback host lists.
23656
23657 If Exim is unable to deliver to any of the hosts for a particular address, and
23658 the errors are not permanent rejections, the address is put on a separate
23659 transport queue with its host list replaced by the fallback hosts, unless the
23660 address was routed via MX records and the current host was in the original MX
23661 list. In that situation, the fallback host list is not used.
23662
23663 Once normal deliveries are complete, the fallback queue is delivered by
23664 re-running the same transports with the new host lists. If several failing
23665 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23666 copy of the message is sent.
23667
23668 The resolution of the host names on the fallback list is controlled by the
23669 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23670 both to cases when the host list comes with the address and when it is taken
23671 from &%hosts%&. This option provides a &"use a smart host only if delivery
23672 fails"& facility.
23673
23674
23675 .option final_timeout smtp time 10m
23676 This is the timeout that applies while waiting for the response to the final
23677 line containing just &"."& that terminates a message. Its value must not be
23678 zero.
23679
23680 .option gethostbyname smtp boolean false
23681 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23682 being used, names are looked up using &[gethostbyname()]&
23683 (or &[getipnodebyname()]& when available)
23684 instead of using the DNS. Of course, that function may in fact use the DNS, but
23685 it may also consult other sources of information such as &_/etc/hosts_&.
23686
23687 .option gnutls_compat_mode smtp boolean unset
23688 This option controls whether GnuTLS is used in compatibility mode in an Exim
23689 server. This reduces security slightly, but improves interworking with older
23690 implementations of TLS.
23691
23692 .option helo_data smtp string&!! "see below"
23693 .cindex "HELO" "argument, setting"
23694 .cindex "EHLO" "argument, setting"
23695 .cindex "LHLO argument setting"
23696 The value of this option is expanded after a connection to a another host has
23697 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23698 command that starts the outgoing SMTP or LMTP session. The default value of the
23699 option is:
23700 .code
23701 $primary_hostname
23702 .endd
23703 During the expansion, the variables &$host$& and &$host_address$& are set to
23704 the identity of the remote host, and the variables &$sending_ip_address$& and
23705 &$sending_port$& are set to the local IP address and port number that are being
23706 used. These variables can be used to generate different values for different
23707 servers or different local IP addresses. For example, if you want the string
23708 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23709 interface address, you could use this:
23710 .code
23711 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23712   {$primary_hostname}}
23713 .endd
23714 The use of &%helo_data%& applies both to sending messages and when doing
23715 callouts.
23716
23717 .option hosts smtp "string list&!!" unset
23718 Hosts are associated with an address by a router such as &(dnslookup)&, which
23719 finds the hosts by looking up the address domain in the DNS, or by
23720 &(manualroute)&, which has lists of hosts in its configuration. However,
23721 email addresses can be passed to the &(smtp)& transport by any router, and not
23722 all of them can provide an associated list of hosts.
23723
23724 The &%hosts%& option specifies a list of hosts to be used if the address being
23725 processed does not have any hosts associated with it. The hosts specified by
23726 &%hosts%& are also used, whether or not the address has its own hosts, if
23727 &%hosts_override%& is set.
23728
23729 The string is first expanded, before being interpreted as a colon-separated
23730 list of host names or IP addresses, possibly including port numbers. The
23731 separator may be changed to something other than colon, as described in section
23732 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23733 item in a &%route_list%& setting for the &(manualroute)& router, as described
23734 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23735 of the &(manualroute)& router is not available here.
23736
23737 If the expansion fails, delivery is deferred. Unless the failure was caused by
23738 the inability to complete a lookup, the error is logged to the panic log as
23739 well as the main log. Host names are looked up either by searching directly for
23740 address records in the DNS or by calling &[gethostbyname()]& (or
23741 &[getipnodebyname()]& when available), depending on the setting of the
23742 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23743 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23744 address are used.
23745
23746 During delivery, the hosts are tried in order, subject to their retry status,
23747 unless &%hosts_randomize%& is set.
23748
23749
23750 .option hosts_avoid_esmtp smtp "host list&!!" unset
23751 .cindex "ESMTP, avoiding use of"
23752 .cindex "HELO" "forcing use of"
23753 .cindex "EHLO" "avoiding use of"
23754 .cindex "PIPELINING" "avoiding the use of"
23755 This option is for use with broken hosts that announce ESMTP facilities (for
23756 example, PIPELINING) and then fail to implement them properly. When a host
23757 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23758 start of the SMTP session. This means that it cannot use any of the ESMTP
23759 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23760
23761
23762 .option hosts_avoid_pipelining smtp "host list&!!" unset
23763 .cindex "PIPELINING" "avoiding the use of"
23764 Exim will not use the SMTP PIPELINING extension when delivering to any host
23765 that matches this list, even if the server host advertises PIPELINING support.
23766
23767
23768 .option hosts_avoid_tls smtp "host list&!!" unset
23769 .cindex "TLS" "avoiding for certain hosts"
23770 Exim will not try to start a TLS session when delivering to any host that
23771 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23772
23773 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23774 .cindex "TLS" "avoiding for certain hosts"
23775 Exim will not try to start a TLS session for a verify callout,
23776 or when delivering in cutthrough mode,
23777 to any host that matches this list.
23778
23779
23780 .option hosts_max_try smtp integer 5
23781 .cindex "host" "maximum number to try"
23782 .cindex "limit" "number of hosts tried"
23783 .cindex "limit" "number of MX tried"
23784 .cindex "MX record" "maximum tried"
23785 This option limits the number of IP addresses that are tried for any one
23786 delivery in cases where there are temporary delivery errors. Section
23787 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23788
23789
23790 .option hosts_max_try_hardlimit smtp integer 50
23791 This is an additional check on the maximum number of IP addresses that Exim
23792 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23793 why it exists.
23794
23795
23796
23797 .option hosts_nopass_tls smtp "host list&!!" unset
23798 .cindex "TLS" "passing connection"
23799 .cindex "multiple SMTP deliveries"
23800 .cindex "TLS" "multiple message deliveries"
23801 For any host that matches this list, a connection on which a TLS session has
23802 been started will not be passed to a new delivery process for sending another
23803 message on the same connection. See section &<<SECTmulmessam>>& for an
23804 explanation of when this might be needed.
23805
23806
23807 .option hosts_override smtp boolean false
23808 If this option is set and the &%hosts%& option is also set, any hosts that are
23809 attached to the address are ignored, and instead the hosts specified by the
23810 &%hosts%& option are always used. This option does not apply to
23811 &%fallback_hosts%&.
23812
23813
23814 .option hosts_randomize smtp boolean false
23815 .cindex "randomized host list"
23816 .cindex "host" "list of; randomized"
23817 .cindex "fallback" "randomized hosts"
23818 If this option is set, and either the list of hosts is taken from the
23819 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23820 were not obtained from MX records (this includes fallback hosts from the
23821 router), and were not randomized by the router, the order of trying the hosts
23822 is randomized each time the transport runs. Randomizing the order of a host
23823 list can be used to do crude load sharing.
23824
23825 When &%hosts_randomize%& is true, a host list may be split into groups whose
23826 order is separately randomized. This makes it possible to set up MX-like
23827 behaviour. The boundaries between groups are indicated by an item that is just
23828 &`+`& in the host list. For example:
23829 .code
23830 hosts = host1:host2:host3:+:host4:host5
23831 .endd
23832 The order of the first three hosts and the order of the last two hosts is
23833 randomized for each use, but the first three always end up before the last two.
23834 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23835
23836 .option hosts_require_auth smtp "host list&!!" unset
23837 .cindex "authentication" "required by client"
23838 This option provides a list of servers for which authentication must succeed
23839 before Exim will try to transfer a message. If authentication fails for
23840 servers which are not in this list, Exim tries to send unauthenticated. If
23841 authentication fails for one of these servers, delivery is deferred. This
23842 temporary error is detectable in the retry rules, so it can be turned into a
23843 hard failure if required. See also &%hosts_try_auth%&, and chapter
23844 &<<CHAPSMTPAUTH>>& for details of authentication.
23845
23846
23847 .option hosts_request_ocsp smtp "host list&!!" *
23848 .cindex "TLS" "requiring for certain servers"
23849 Exim will request a Certificate Status on a
23850 TLS session for any host that matches this list.
23851 &%tls_verify_certificates%& should also be set for the transport.
23852
23853 .option hosts_require_ocsp smtp "host list&!!" unset
23854 .cindex "TLS" "requiring for certain servers"
23855 Exim will request, and check for a valid Certificate Status being given, on a
23856 TLS session for any host that matches this list.
23857 &%tls_verify_certificates%& should also be set for the transport.
23858
23859 .option hosts_require_tls smtp "host list&!!" unset
23860 .cindex "TLS" "requiring for certain servers"
23861 Exim will insist on using a TLS session when delivering to any host that
23862 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23863 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23864 incoming messages, use an appropriate ACL.
23865
23866 .option hosts_try_auth smtp "host list&!!" unset
23867 .cindex "authentication" "optional in client"
23868 This option provides a list of servers to which, provided they announce
23869 authentication support, Exim will attempt to authenticate as a client when it
23870 connects. If authentication fails, Exim will try to transfer the message
23871 unauthenticated. See also &%hosts_require_auth%&, and chapter
23872 &<<CHAPSMTPAUTH>>& for details of authentication.
23873
23874 .option hosts_try_prdr smtp "host list&!!" *
23875 .cindex "PRDR" "enabling, optional in client"
23876 This option provides a list of servers to which, provided they announce
23877 PRDR support, Exim will attempt to negotiate PRDR
23878 for multi-recipient messages.
23879 The option can usually be left as default.
23880
23881 .option interface smtp "string list&!!" unset
23882 .cindex "bind IP address"
23883 .cindex "IP address" "binding"
23884 .vindex "&$host$&"
23885 .vindex "&$host_address$&"
23886 This option specifies which interface to bind to when making an outgoing SMTP
23887 call. The value is an IP address, not an interface name such as
23888 &`eth0`&. Do not confuse this with the interface address that was used when a
23889 message was received, which is in &$received_ip_address$&, formerly known as
23890 &$interface_address$&. The name was changed to minimize confusion with the
23891 outgoing interface address. There is no variable that contains an outgoing
23892 interface address because, unless it is set by this option, its value is
23893 unknown.
23894
23895 During the expansion of the &%interface%& option the variables &$host$& and
23896 &$host_address$& refer to the host to which a connection is about to be made
23897 during the expansion of the string. Forced expansion failure, or an empty
23898 string result causes the option to be ignored. Otherwise, after expansion, the
23899 string must be a list of IP addresses, colon-separated by default, but the
23900 separator can be changed in the usual way. For example:
23901 .code
23902 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23903 .endd
23904 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23905 connection. If none of them are the correct type, the option is ignored. If
23906 &%interface%& is not set, or is ignored, the system's IP functions choose which
23907 interface to use if the host has more than one.
23908
23909
23910 .option keepalive smtp boolean true
23911 .cindex "keepalive" "on outgoing connection"
23912 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23913 connections. When set, it causes the kernel to probe idle connections
23914 periodically, by sending packets with &"old"& sequence numbers. The other end
23915 of the connection should send a acknowledgment if the connection is still okay
23916 or a reset if the connection has been aborted. The reason for doing this is
23917 that it has the beneficial effect of freeing up certain types of connection
23918 that can get stuck when the remote host is disconnected without tidying up the
23919 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23920 unreachable hosts.
23921
23922
23923 .option lmtp_ignore_quota smtp boolean false
23924 .cindex "LMTP" "ignoring quota errors"
23925 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23926 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23927 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23928
23929 .option max_rcpt smtp integer 100
23930 .cindex "RCPT" "maximum number of outgoing"
23931 This option limits the number of RCPT commands that are sent in a single
23932 SMTP message transaction. Each set of addresses is treated independently, and
23933 so can cause parallel connections to the same host if &%remote_max_parallel%&
23934 permits this.
23935
23936
23937 .option multi_domain smtp boolean&!! true
23938 .vindex "&$domain$&"
23939 When this option is set, the &(smtp)& transport can handle a number of
23940 addresses containing a mixture of different domains provided they all resolve
23941 to the same list of hosts. Turning the option off restricts the transport to
23942 handling only one domain at a time. This is useful if you want to use
23943 &$domain$& in an expansion for the transport, because it is set only when there
23944 is a single domain involved in a remote delivery.
23945
23946 It is expanded per-address and can depend on any of
23947 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23948 &$host$&, &$host_address$& and &$host_port$&.
23949
23950 .option port smtp string&!! "see below"
23951 .cindex "port" "sending TCP/IP"
23952 .cindex "TCP/IP" "setting outgoing port"
23953 This option specifies the TCP/IP port on the server to which Exim connects.
23954 &*Note:*& Do not confuse this with the port that was used when a message was
23955 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23956 The name was changed to minimize confusion with the outgoing port. There is no
23957 variable that contains an outgoing port.
23958
23959 If the value of this option begins with a digit it is taken as a port number;
23960 otherwise it is looked up using &[getservbyname()]&. The default value is
23961 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23962 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23963 is deferred.
23964
23965
23966
23967 .option protocol smtp string smtp
23968 .cindex "LMTP" "over TCP/IP"
23969 .cindex "ssmtp protocol" "outbound"
23970 .cindex "TLS" "SSL-on-connect outbound"
23971 .vindex "&$port$&"
23972 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23973 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23974 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23975 deliveries into closed message stores. Exim also has support for running LMTP
23976 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23977
23978 If this option is set to &"smtps"&, the default value for the &%port%& option
23979 changes to &"smtps"&, and the transport initiates TLS immediately after
23980 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23981 The Internet standards bodies strongly discourage use of this mode.
23982
23983
23984 .option retry_include_ip_address smtp boolean&!! true
23985 Exim normally includes both the host name and the IP address in the key it
23986 constructs for indexing retry data after a temporary delivery failure. This
23987 means that when one of several IP addresses for a host is failing, it gets
23988 tried periodically (controlled by the retry rules), but use of the other IP
23989 addresses is not affected.
23990
23991 However, in some dialup environments hosts are assigned a different IP address
23992 each time they connect. In this situation the use of the IP address as part of
23993 the retry key leads to undesirable behaviour. Setting this option false causes
23994 Exim to use only the host name.
23995 Since it is expanded it can be made to depend on the host or domain.
23996
23997
23998 .option serialize_hosts smtp "host list&!!" unset
23999 .cindex "serializing connections"
24000 .cindex "host" "serializing connections"
24001 Because Exim operates in a distributed manner, if several messages for the same
24002 host arrive at around the same time, more than one simultaneous connection to
24003 the remote host can occur. This is not usually a problem except when there is a
24004 slow link between the hosts. In that situation it may be helpful to restrict
24005 Exim to one connection at a time. This can be done by setting
24006 &%serialize_hosts%& to match the relevant hosts.
24007
24008 .cindex "hints database" "serializing deliveries to a host"
24009 Exim implements serialization by means of a hints database in which a record is
24010 written whenever a process connects to one of the restricted hosts. The record
24011 is deleted when the connection is completed. Obviously there is scope for
24012 records to get left lying around if there is a system or program crash. To
24013 guard against this, Exim ignores any records that are more than six hours old.
24014
24015 If you set up this kind of serialization, you should also arrange to delete the
24016 relevant hints database whenever your system reboots. The names of the files
24017 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24018 may be one or two files, depending on the type of DBM in use. The same files
24019 are used for ETRN serialization.
24020
24021 See also the &%max_parallel%& generic transport option.
24022
24023
24024 .option size_addition smtp integer 1024
24025 .cindex "SMTP" "SIZE"
24026 .cindex "message" "size issue for transport filter"
24027 .cindex "size" "of message"
24028 .cindex "transport" "filter"
24029 .cindex "filter" "transport filter"
24030 If a remote SMTP server indicates that it supports the SIZE option of the
24031 MAIL command, Exim uses this to pass over the message size at the start of
24032 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24033 sends, to allow for headers and other text that may be added during delivery by
24034 configuration options or in a transport filter. It may be necessary to increase
24035 this if a lot of text is added to messages.
24036
24037 Alternatively, if the value of &%size_addition%& is set negative, it disables
24038 the use of the SIZE option altogether.
24039
24040
24041 .option socks_proxy smtp string&!! unset
24042 .cindex proxy SOCKS
24043 This option enables use of SOCKS proxies for connections made by the
24044 transport.  For details see &<<SECTproxySOCKS>>&.
24045
24046
24047 .option tls_certificate smtp string&!! unset
24048 .cindex "TLS" "client certificate, location of"
24049 .cindex "certificate" "client, location of"
24050 .vindex "&$host$&"
24051 .vindex "&$host_address$&"
24052 The value of this option must be the absolute path to a file which contains the
24053 client's certificate, for possible use when sending a message over an encrypted
24054 connection. The values of &$host$& and &$host_address$& are set to the name and
24055 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24056 details of TLS.
24057
24058 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24059 certificate when sending messages as a client. The global option of the same
24060 name specifies the certificate for Exim as a server; it is not automatically
24061 assumed that the same certificate should be used when Exim is operating as a
24062 client.
24063
24064
24065 .option tls_crl smtp string&!! unset
24066 .cindex "TLS" "client certificate revocation list"
24067 .cindex "certificate" "revocation list for client"
24068 This option specifies a certificate revocation list. The expanded value must
24069 be the name of a file that contains a CRL in PEM format.
24070
24071
24072 .option tls_dh_min_bits smtp integer 1024
24073 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24074 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24075 key agreement is negotiated, the server will provide a large prime number
24076 for use.  This option establishes the minimum acceptable size of that number.
24077 If the parameter offered by the server is too small, then the TLS handshake
24078 will fail.
24079
24080 Only supported when using GnuTLS.
24081
24082
24083 .option tls_privatekey smtp string&!! unset
24084 .cindex "TLS" "client private key, location of"
24085 .vindex "&$host$&"
24086 .vindex "&$host_address$&"
24087 The value of this option must be the absolute path to a file which contains the
24088 client's private key. This is used when sending a message over an encrypted
24089 connection using a client certificate. The values of &$host$& and
24090 &$host_address$& are set to the name and address of the server during the
24091 expansion. If this option is unset, or the expansion is forced to fail, or the
24092 result is an empty string, the private key is assumed to be in the same file as
24093 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24094
24095
24096 .option tls_require_ciphers smtp string&!! unset
24097 .cindex "TLS" "requiring specific ciphers"
24098 .cindex "cipher" "requiring specific"
24099 .vindex "&$host$&"
24100 .vindex "&$host_address$&"
24101 The value of this option must be a list of permitted cipher suites, for use
24102 when setting up an outgoing encrypted connection. (There is a global option of
24103 the same name for controlling incoming connections.) The values of &$host$& and
24104 &$host_address$& are set to the name and address of the server during the
24105 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24106 is used in different ways by OpenSSL and GnuTLS (see sections
24107 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24108 ciphers is a preference order.
24109
24110
24111
24112 .option tls_sni smtp string&!! unset
24113 .cindex "TLS" "Server Name Indication"
24114 .vindex "&$tls_sni$&"
24115 If this option is set then it sets the $tls_out_sni variable and causes any
24116 TLS session to pass this value as the Server Name Indication extension to
24117 the remote side, which can be used by the remote side to select an appropriate
24118 certificate and private key for the session.
24119
24120 See &<<SECTtlssni>>& for more information.
24121
24122 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24123 TLS extensions.
24124
24125
24126
24127
24128 .option tls_tempfail_tryclear smtp boolean true
24129 .cindex "4&'xx'& responses" "to STARTTLS"
24130 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24131 setting up a TLS session, this option determines whether or not Exim should try
24132 to deliver the message unencrypted. If it is set false, delivery to the
24133 current host is deferred; if there are other hosts, they are tried. If this
24134 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24135 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24136 TLS negotiation fails, Exim closes the current connection (because it is in an
24137 unknown state), opens a new one to the same host, and then tries the delivery
24138 in clear.
24139
24140
24141 .option tls_try_verify_hosts smtp "host list&!!" *
24142 .cindex "TLS" "server certificate verification"
24143 .cindex "certificate" "verification of server"
24144 This option gives a list of hosts for which, on encrypted connections,
24145 certificate verification will be tried but need not succeed.
24146 The &%tls_verify_certificates%& option must also be set.
24147 Note that unless the host is in this list
24148 TLS connections will be denied to hosts using self-signed certificates
24149 when &%tls_verify_certificates%& is matched.
24150 The &$tls_out_certificate_verified$& variable is set when
24151 certificate verification succeeds.
24152
24153
24154 .option tls_verify_cert_hostnames smtp "host list&!!" *
24155 .cindex "TLS" "server certificate hostname verification"
24156 .cindex "certificate" "verification of server"
24157 This option give a list of hosts for which,
24158 while verifying the server certificate,
24159 checks will be included on the host name
24160 (note that this will generally be the result of a DNS MX lookup)
24161 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24162 limited to being the initial component of a 3-or-more component FQDN.
24163
24164 There is no equivalent checking on client certificates.
24165
24166
24167 .option tls_verify_certificates smtp string&!! system
24168 .cindex "TLS" "server certificate verification"
24169 .cindex "certificate" "verification of server"
24170 .vindex "&$host$&"
24171 .vindex "&$host_address$&"
24172 The value of this option must be either the
24173 word "system"
24174 or the absolute path to
24175 a file or directory containing permitted certificates for servers,
24176 for use when setting up an encrypted connection.
24177
24178 The "system" value for the option will use a location compiled into the SSL library.
24179 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24180 is taken as empty and an explicit location
24181 must be specified.
24182
24183 The use of a directory for the option value is not available for GnuTLS versions
24184 preceding 3.3.6 and a single file must be used.
24185
24186 With OpenSSL the certificates specified
24187 explicitly
24188 either by file or directory
24189 are added to those given by the system default location.
24190
24191 The values of &$host$& and
24192 &$host_address$& are set to the name and address of the server during the
24193 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24194
24195 For back-compatibility,
24196 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24197 (a single-colon empty list counts as being set)
24198 and certificate verification fails the TLS connection is closed.
24199
24200
24201 .option tls_verify_hosts smtp "host list&!!" unset
24202 .cindex "TLS" "server certificate verification"
24203 .cindex "certificate" "verification of server"
24204 This option gives a list of hosts for which, on encrypted connections,
24205 certificate verification must succeed.
24206 The &%tls_verify_certificates%& option must also be set.
24207 If both this option and &%tls_try_verify_hosts%& are unset
24208 operation is as if this option selected all hosts.
24209
24210
24211
24212
24213 .section "How the limits for the number of hosts to try are used" &&&
24214          "SECTvalhosmax"
24215 .cindex "host" "maximum number to try"
24216 .cindex "limit" "hosts; maximum number tried"
24217 There are two options that are concerned with the number of hosts that are
24218 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24219 &%hosts_max_try_hardlimit%&.
24220
24221
24222 The &%hosts_max_try%& option limits the number of hosts that are tried
24223 for a single delivery. However, despite the term &"host"& in its name, the
24224 option actually applies to each IP address independently. In other words, a
24225 multihomed host is treated as several independent hosts, just as it is for
24226 retrying.
24227
24228 Many of the larger ISPs have multiple MX records which often point to
24229 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24230 created as a result of routing one of these domains.
24231
24232 Trying every single IP address on such a long list does not seem sensible; if
24233 several at the top of the list fail, it is reasonable to assume there is some
24234 problem that is likely to affect all of them. Roughly speaking, the value of
24235 &%hosts_max_try%& is the maximum number that are tried before deferring the
24236 delivery. However, the logic cannot be quite that simple.
24237
24238 Firstly, IP addresses that are skipped because their retry times have not
24239 arrived do not count, and in addition, addresses that are past their retry
24240 limits are also not counted, even when they are tried. This means that when
24241 some IP addresses are past their retry limits, more than the value of
24242 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24243 that all IP addresses are considered before timing out an email address (but
24244 see below for an exception).
24245
24246 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24247 list to see if there is a subsequent host with a different (higher valued) MX.
24248 If there is, that host is considered next, and the current IP address is used
24249 but not counted. This behaviour helps in the case of a domain with a retry rule
24250 that hardly ever delays any hosts, as is now explained:
24251
24252 Consider the case of a long list of hosts with one MX value, and a few with a
24253 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24254 hosts at the top of the list are tried at first. With the default retry rule,
24255 which specifies increasing retry times, the higher MX hosts are eventually
24256 tried when those at the top of the list are skipped because they have not
24257 reached their retry times.
24258
24259 However, it is common practice to put a fixed short retry time on domains for
24260 large ISPs, on the grounds that their servers are rarely down for very long.
24261 Unfortunately, these are exactly the domains that tend to resolve to long lists
24262 of hosts. The short retry time means that the lowest MX hosts are tried every
24263 time. The attempts may be in a different order because of random sorting, but
24264 without the special MX check, the higher MX hosts would never be tried until
24265 all the lower MX hosts had timed out (which might be several days), because
24266 there are always some lower MX hosts that have reached their retry times. With
24267 the special check, Exim considers at least one IP address from each MX value at
24268 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24269 reached.
24270
24271 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24272 particular, Exim normally eventually tries all the IP addresses before timing
24273 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24274 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24275 been set up with hundreds of IP addresses for some domains. It can
24276 take a very long time indeed for an address to time out in these cases.
24277
24278 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24279 Exim never tries more than this number of IP addresses; if it hits this limit
24280 and they are all timed out, the email address is bounced, even though not all
24281 possible IP addresses have been tried.
24282 .ecindex IIDsmttra1
24283 .ecindex IIDsmttra2
24284
24285
24286
24287
24288
24289 . ////////////////////////////////////////////////////////////////////////////
24290 . ////////////////////////////////////////////////////////////////////////////
24291
24292 .chapter "Address rewriting" "CHAPrewrite"
24293 .scindex IIDaddrew "rewriting" "addresses"
24294 There are some circumstances in which Exim automatically rewrites domains in
24295 addresses. The two most common are when an address is given without a domain
24296 (referred to as an &"unqualified address"&) or when an address contains an
24297 abbreviated domain that is expanded by DNS lookup.
24298
24299 Unqualified envelope addresses are accepted only for locally submitted
24300 messages, or for messages that are received from hosts matching
24301 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24302 appropriate. Unqualified addresses in header lines are qualified if they are in
24303 locally submitted messages, or messages from hosts that are permitted to send
24304 unqualified envelope addresses. Otherwise, unqualified addresses in header
24305 lines are neither qualified nor rewritten.
24306
24307 One situation in which Exim does &'not'& automatically rewrite a domain is
24308 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24309 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24310 do this. The new RFCs do not contain this suggestion.
24311
24312
24313 .section "Explicitly configured address rewriting" "SECID147"
24314 This chapter describes the rewriting rules that can be used in the
24315 main rewrite section of the configuration file, and also in the generic
24316 &%headers_rewrite%& option that can be set on any transport.
24317
24318 Some people believe that configured address rewriting is a Mortal Sin.
24319 Others believe that life is not possible without it. Exim provides the
24320 facility; you do not have to use it.
24321
24322 The main rewriting rules that appear in the &"rewrite"& section of the
24323 configuration file are applied to addresses in incoming messages, both envelope
24324 addresses and addresses in header lines. Each rule specifies the types of
24325 address to which it applies.
24326
24327 Whether or not addresses in header lines are rewritten depends on the origin of
24328 the headers and the type of rewriting. Global rewriting, that is, rewriting
24329 rules from the rewrite section of the configuration file, is applied only to
24330 those headers that were received with the message. Header lines that are added
24331 by ACLs or by a system filter or by individual routers or transports (which
24332 are specific to individual recipient addresses) are not rewritten by the global
24333 rules.
24334
24335 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24336 applies all headers except those added by routers and transports. That is, as
24337 well as the headers that were received with the message, it also applies to
24338 headers that were added by an ACL or a system filter.
24339
24340
24341 In general, rewriting addresses from your own system or domain has some
24342 legitimacy. Rewriting other addresses should be done only with great care and
24343 in special circumstances. The author of Exim believes that rewriting should be
24344 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24345 Although it can sometimes be used as a routing tool, this is very strongly
24346 discouraged.
24347
24348 There are two commonly encountered circumstances where rewriting is used, as
24349 illustrated by these examples:
24350
24351 .ilist
24352 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24353 exchange mail with each other behind a firewall, but there is only a single
24354 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24355 &'hitch.fict.example'& when sending mail off-site.
24356 .next
24357 A host rewrites the local parts of its own users so that, for example,
24358 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24359 .endlist
24360
24361
24362
24363 .section "When does rewriting happen?" "SECID148"
24364 .cindex "rewriting" "timing of"
24365 .cindex "&ACL;" "rewriting addresses in"
24366 Configured address rewriting can take place at several different stages of a
24367 message's processing.
24368
24369 .vindex "&$sender_address$&"
24370 At the start of an ACL for MAIL, the sender address may have been rewritten
24371 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24372 ordinary rewrite rules have yet been applied. If, however, the sender address
24373 is verified in the ACL, it is rewritten before verification, and remains
24374 rewritten thereafter. The subsequent value of &$sender_address$& is the
24375 rewritten address. This also applies if sender verification happens in a
24376 RCPT ACL. Otherwise, when the sender address is not verified, it is
24377 rewritten as soon as a message's header lines have been received.
24378
24379 .vindex "&$domain$&"
24380 .vindex "&$local_part$&"
24381 Similarly, at the start of an ACL for RCPT, the current recipient's address
24382 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24383 rewrite rules have yet been applied to it. However, the behaviour is different
24384 from the sender address when a recipient is verified. The address is rewritten
24385 for the verification, but the rewriting is not remembered at this stage. The
24386 value of &$local_part$& and &$domain$& after verification are always the same
24387 as they were before (that is, they contain the unrewritten &-- except for
24388 SMTP-time rewriting &-- address).
24389
24390 As soon as a message's header lines have been received, all the envelope
24391 recipient addresses are permanently rewritten, and rewriting is also applied to
24392 the addresses in the header lines (if configured). This happens before adding
24393 any header lines that were specified in MAIL or RCPT ACLs, and
24394 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24395 before the DATA ACL and &[local_scan()]& functions are run.
24396
24397 When an address is being routed, either for delivery or for verification,
24398 rewriting is applied immediately to child addresses that are generated by
24399 redirection, unless &%no_rewrite%& is set on the router.
24400
24401 .cindex "envelope sender" "rewriting at transport time"
24402 .cindex "rewriting" "at transport time"
24403 .cindex "header lines" "rewriting at transport time"
24404 At transport time, additional rewriting of addresses in header lines can be
24405 specified by setting the generic &%headers_rewrite%& option on a transport.
24406 This option contains rules that are identical in form to those in the rewrite
24407 section of the configuration file. They are applied to the original message
24408 header lines and any that were added by ACLs or a system filter. They are not
24409 applied to header lines that are added by routers or the transport.
24410
24411 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24412 transport option. However, it is not possible to rewrite envelope recipients at
24413 transport time.
24414
24415
24416
24417
24418 .section "Testing the rewriting rules that apply on input" "SECID149"
24419 .cindex "rewriting" "testing"
24420 .cindex "testing" "rewriting"
24421 Exim's input rewriting configuration appears in a part of the run time
24422 configuration file headed by &"begin rewrite"&. It can be tested by the
24423 &%-brw%& command line option. This takes an address (which can be a full RFC
24424 2822 address) as its argument. The output is a list of how the address would be
24425 transformed by the rewriting rules for each of the different places it might
24426 appear in an incoming message, that is, for each different header and for the
24427 envelope sender and recipient fields. For example,
24428 .code
24429 exim -brw ph10@exim.workshop.example
24430 .endd
24431 might produce the output
24432 .code
24433 sender: Philip.Hazel@exim.workshop.example
24434 from: Philip.Hazel@exim.workshop.example
24435 to: ph10@exim.workshop.example
24436 cc: ph10@exim.workshop.example
24437 bcc: ph10@exim.workshop.example
24438 reply-to: Philip.Hazel@exim.workshop.example
24439 env-from: Philip.Hazel@exim.workshop.example
24440 env-to: ph10@exim.workshop.example
24441 .endd
24442 which shows that rewriting has been set up for that address when used in any of
24443 the source fields, but not when it appears as a recipient address. At the
24444 present time, there is no equivalent way of testing rewriting rules that are
24445 set for a particular transport.
24446
24447
24448 .section "Rewriting rules" "SECID150"
24449 .cindex "rewriting" "rules"
24450 The rewrite section of the configuration file consists of lines of rewriting
24451 rules in the form
24452 .display
24453 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24454 .endd
24455 Rewriting rules that are specified for the &%headers_rewrite%& generic
24456 transport option are given as a colon-separated list. Each item in the list
24457 takes the same form as a line in the main rewriting configuration (except that
24458 any colons must be doubled, of course).
24459
24460 The formats of source patterns and replacement strings are described below.
24461 Each is terminated by white space, unless enclosed in double quotes, in which
24462 case normal quoting conventions apply inside the quotes. The flags are single
24463 characters which may appear in any order. Spaces and tabs between them are
24464 ignored.
24465
24466 For each address that could potentially be rewritten, the rules are scanned in
24467 order, and replacements for the address from earlier rules can themselves be
24468 replaced by later rules (but see the &"q"& and &"R"& flags).
24469
24470 The order in which addresses are rewritten is undefined, may change between
24471 releases, and must not be relied on, with one exception: when a message is
24472 received, the envelope sender is always rewritten first, before any header
24473 lines are rewritten. For example, the replacement string for a rewrite of an
24474 address in &'To:'& must not assume that the message's address in &'From:'& has
24475 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24476 that the envelope sender has already been rewritten.
24477
24478 .vindex "&$domain$&"
24479 .vindex "&$local_part$&"
24480 The variables &$local_part$& and &$domain$& can be used in the replacement
24481 string to refer to the address that is being rewritten. Note that lookup-driven
24482 rewriting can be done by a rule of the form
24483 .code
24484 *@*   ${lookup ...
24485 .endd
24486 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24487 refer to the address that is being rewritten.
24488
24489
24490 .section "Rewriting patterns" "SECID151"
24491 .cindex "rewriting" "patterns"
24492 .cindex "address list" "in a rewriting pattern"
24493 The source pattern in a rewriting rule is any item which may appear in an
24494 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24495 single-item address list, which means that it is expanded before being tested
24496 against the address. As always, if you use a regular expression as a pattern,
24497 you must take care to escape dollar and backslash characters, or use the &`\N`&
24498 facility to suppress string expansion within the regular expression.
24499
24500 Domains in patterns should be given in lower case. Local parts in patterns are
24501 case-sensitive. If you want to do case-insensitive matching of local parts, you
24502 can use a regular expression that starts with &`^(?i)`&.
24503
24504 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24505 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24506 depending on the type of match which occurred. These can be used in the
24507 replacement string to insert portions of the incoming address. &$0$& always
24508 refers to the complete incoming address. When a regular expression is used, the
24509 numerical variables are set from its capturing subexpressions. For other types
24510 of pattern they are set as follows:
24511
24512 .ilist
24513 If a local part or domain starts with an asterisk, the numerical variables
24514 refer to the character strings matched by asterisks, with &$1$& associated with
24515 the first asterisk, and &$2$& with the second, if present. For example, if the
24516 pattern
24517 .code
24518 *queen@*.fict.example
24519 .endd
24520 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24521 .code
24522 $0 = hearts-queen@wonderland.fict.example
24523 $1 = hearts-
24524 $2 = wonderland
24525 .endd
24526 Note that if the local part does not start with an asterisk, but the domain
24527 does, it is &$1$& that contains the wild part of the domain.
24528
24529 .next
24530 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24531 of the domain are placed in the next available numerical variables. Suppose,
24532 for example, that the address &'foo@bar.baz.example'& is processed by a
24533 rewriting rule of the form
24534 .display
24535 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24536 .endd
24537 and the key in the file that matches the domain is &`*.baz.example`&. Then
24538 .code
24539 $1 = foo
24540 $2 = bar
24541 $3 = baz.example
24542 .endd
24543 If the address &'foo@baz.example'& is looked up, this matches the same
24544 wildcard file entry, and in this case &$2$& is set to the empty string, but
24545 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24546 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24547 whole domain. For non-partial domain lookups, no numerical variables are set.
24548 .endlist
24549
24550
24551 .section "Rewriting replacements" "SECID152"
24552 .cindex "rewriting" "replacements"
24553 If the replacement string for a rule is a single asterisk, addresses that
24554 match the pattern and the flags are &'not'& rewritten, and no subsequent
24555 rewriting rules are scanned. For example,
24556 .code
24557 hatta@lookingglass.fict.example  *  f
24558 .endd
24559 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24560 &'From:'& headers.
24561
24562 .vindex "&$domain$&"
24563 .vindex "&$local_part$&"
24564 If the replacement string is not a single asterisk, it is expanded, and must
24565 yield a fully qualified address. Within the expansion, the variables
24566 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24567 Any letters they contain retain their original case &-- they are not lower
24568 cased. The numerical variables are set up according to the type of pattern that
24569 matched the address, as described above. If the expansion is forced to fail by
24570 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24571 current rule is abandoned, but subsequent rules may take effect. Any other
24572 expansion failure causes the entire rewriting operation to be abandoned, and an
24573 entry written to the panic log.
24574
24575
24576
24577 .section "Rewriting flags" "SECID153"
24578 There are three different kinds of flag that may appear on rewriting rules:
24579
24580 .ilist
24581 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24582 c, f, h, r, s, t.
24583 .next
24584 A flag that specifies rewriting at SMTP time: S.
24585 .next
24586 Flags that control the rewriting process: Q, q, R, w.
24587 .endlist
24588
24589 For rules that are part of the &%headers_rewrite%& generic transport option,
24590 E, F, T, and S are not permitted.
24591
24592
24593
24594 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24595          "SECID154"
24596 .cindex "rewriting" "flags"
24597 If none of the following flag letters, nor the &"S"& flag (see section
24598 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24599 and to both the sender and recipient fields of the envelope, whereas a
24600 transport-time rewriting rule just applies to all headers. Otherwise, the
24601 rewriting rule is skipped unless the relevant addresses are being processed.
24602 .display
24603 &`E`&       rewrite all envelope fields
24604 &`F`&       rewrite the envelope From field
24605 &`T`&       rewrite the envelope To field
24606 &`b`&       rewrite the &'Bcc:'& header
24607 &`c`&       rewrite the &'Cc:'& header
24608 &`f`&       rewrite the &'From:'& header
24609 &`h`&       rewrite all headers
24610 &`r`&       rewrite the &'Reply-To:'& header
24611 &`s`&       rewrite the &'Sender:'& header
24612 &`t`&       rewrite the &'To:'& header
24613 .endd
24614 "All headers" means all of the headers listed above that can be selected
24615 individually, plus their &'Resent-'& versions. It does not include
24616 other headers such as &'Subject:'& etc.
24617
24618 You should be particularly careful about rewriting &'Sender:'& headers, and
24619 restrict this to special known cases in your own domains.
24620
24621
24622 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24623 .cindex "SMTP" "rewriting malformed addresses"
24624 .cindex "RCPT" "rewriting argument of"
24625 .cindex "MAIL" "rewriting argument of"
24626 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24627 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24628 before any other processing; even before syntax checking. The pattern is
24629 required to be a regular expression, and it is matched against the whole of the
24630 data for the command, including any surrounding angle brackets.
24631
24632 .vindex "&$domain$&"
24633 .vindex "&$local_part$&"
24634 This form of rewrite rule allows for the handling of addresses that are not
24635 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24636 input). Because the input is not required to be a syntactically valid address,
24637 the variables &$local_part$& and &$domain$& are not available during the
24638 expansion of the replacement string. The result of rewriting replaces the
24639 original address in the MAIL or RCPT command.
24640
24641
24642 .section "Flags controlling the rewriting process" "SECID155"
24643 There are four flags which control the way the rewriting process works. These
24644 take effect only when a rule is invoked, that is, when the address is of the
24645 correct type (matches the flags) and matches the pattern:
24646
24647 .ilist
24648 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24649 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24650 absence of &"Q"& the rewritten address must always include a domain.
24651 .next
24652 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24653 even if no rewriting actually takes place because of a &"fail"& in the
24654 expansion. The &"q"& flag is not effective if the address is of the wrong type
24655 (does not match the flags) or does not match the pattern.
24656 .next
24657 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24658 address, up to ten times. It can be combined with the &"q"& flag, to stop
24659 rewriting once it fails to match (after at least one successful rewrite).
24660 .next
24661 .cindex "rewriting" "whole addresses"
24662 When an address in a header is rewritten, the rewriting normally applies only
24663 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24664 left unchanged. For example, rewriting might change
24665 .code
24666 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24667 .endd
24668 into
24669 .code
24670 From: Ford Prefect <prefectf@hitch.fict.example>
24671 .endd
24672 .cindex "RFC 2047"
24673 Sometimes there is a need to replace the whole address item, and this can be
24674 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24675 causes an address in a header line to be rewritten, the entire address is
24676 replaced, not just the working part. The replacement must be a complete RFC
24677 2822 address, including the angle brackets if necessary. If text outside angle
24678 brackets contains a character whose value is greater than 126 or less than 32
24679 (except for tab), the text is encoded according to RFC 2047. The character set
24680 is taken from &%headers_charset%&, which gets its default at build time.
24681
24682 When the &"w"& flag is set on a rule that causes an envelope address to be
24683 rewritten, all but the working part of the replacement address is discarded.
24684 .endlist
24685
24686
24687 .section "Rewriting examples" "SECID156"
24688 Here is an example of the two common rewriting paradigms:
24689 .code
24690 *@*.hitch.fict.example  $1@hitch.fict.example
24691 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24692                      {$value}fail}@hitch.fict.example bctfrF
24693 .endd
24694 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24695 the string expansion to fail if the lookup does not succeed. In this context it
24696 has the effect of leaving the original address unchanged, but Exim goes on to
24697 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24698 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24699 explicitly, which would cause the rewritten address to be the same as before,
24700 at the cost of a small bit of processing. Not supplying either of these is an
24701 error, since the rewritten address would then contain no local part.
24702
24703 The first example above replaces the domain with a superior, more general
24704 domain. This may not be desirable for certain local parts. If the rule
24705 .code
24706 root@*.hitch.fict.example  *
24707 .endd
24708 were inserted before the first rule, rewriting would be suppressed for the
24709 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24710
24711 Rewriting can be made conditional on a number of tests, by making use of
24712 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24713 messages that originate outside the local host:
24714 .code
24715 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24716                          {$1@hitch.fict.example}fail}"
24717 .endd
24718 The replacement string is quoted in this example because it contains white
24719 space.
24720
24721 .cindex "rewriting" "bang paths"
24722 .cindex "bang paths" "rewriting"
24723 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24724 an address it treats it as an unqualified local part which it qualifies with
24725 the local qualification domain (if the source of the message is local or if the
24726 remote host is permitted to send unqualified addresses). Rewriting can
24727 sometimes be used to handle simple bang paths with a fixed number of
24728 components. For example, the rule
24729 .code
24730 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24731 .endd
24732 rewrites a two-component bang path &'host.name!user'& as the domain address
24733 &'user@host.name'&. However, there is a security implication in using this as
24734 a global rewriting rule for envelope addresses. It can provide a backdoor
24735 method for using your system as a relay, because the incoming addresses appear
24736 to be local. If the bang path addresses are received via SMTP, it is safer to
24737 use the &"S"& flag to rewrite them as they are received, so that relay checking
24738 can be done on the rewritten addresses.
24739 .ecindex IIDaddrew
24740
24741
24742
24743
24744
24745 . ////////////////////////////////////////////////////////////////////////////
24746 . ////////////////////////////////////////////////////////////////////////////
24747
24748 .chapter "Retry configuration" "CHAPretry"
24749 .scindex IIDretconf1 "retry" "configuration, description of"
24750 .scindex IIDregconf2 "configuration file" "retry section"
24751 The &"retry"& section of the runtime configuration file contains a list of
24752 retry rules that control how often Exim tries to deliver messages that cannot
24753 be delivered at the first attempt. If there are no retry rules (the section is
24754 empty or not present), there are no retries. In this situation, temporary
24755 errors are treated as permanent. The default configuration contains a single,
24756 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24757 line option can be used to test which retry rule will be used for a given
24758 address, domain and error.
24759
24760 The most common cause of retries is temporary failure to deliver to a remote
24761 host because the host is down, or inaccessible because of a network problem.
24762 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24763 address) basis, not on a per-message basis. Thus, if one message has recently
24764 been delayed, delivery of a new message to the same host is not immediately
24765 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24766 log selector is set, the message
24767 .cindex "retry" "time not reached"
24768 &"retry time not reached"& is written to the main log whenever a delivery is
24769 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24770 the handling of errors during remote deliveries.
24771
24772 Retry processing applies to routing as well as to delivering, except as covered
24773 in the next paragraph. The retry rules do not distinguish between these
24774 actions. It is not possible, for example, to specify different behaviour for
24775 failures to route the domain &'snark.fict.example'& and failures to deliver to
24776 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24777 added complication, so did not implement it. However, although they share the
24778 same retry rule, the actual retry times for routing and transporting a given
24779 domain are maintained independently.
24780
24781 When a delivery is not part of a queue run (typically an immediate delivery on
24782 receipt of a message), the routers are always run, and local deliveries are
24783 always attempted, even if retry times are set for them. This makes for better
24784 behaviour if one particular message is causing problems (for example, causing
24785 quota overflow, or provoking an error in a filter file). If such a delivery
24786 suffers a temporary failure, the retry data is updated as normal, and
24787 subsequent delivery attempts from queue runs occur only when the retry time for
24788 the local address is reached.
24789
24790 .section "Changing retry rules" "SECID157"
24791 If you change the retry rules in your configuration, you should consider
24792 whether or not to delete the retry data that is stored in Exim's spool area in
24793 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24794 always safe; that is why they are called &"hints"&.
24795
24796 The hints retry data contains suggested retry times based on the previous
24797 rules. In the case of a long-running problem with a remote host, it might
24798 record the fact that the host has timed out. If your new rules increase the
24799 timeout time for such a host, you should definitely remove the old retry data
24800 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24801 messages that it should now be retaining.
24802
24803
24804
24805 .section "Format of retry rules" "SECID158"
24806 .cindex "retry" "rules"
24807 Each retry rule occupies one line and consists of three or four parts,
24808 separated by white space: a pattern, an error name, an optional list of sender
24809 addresses, and a list of retry parameters. The pattern and sender lists must be
24810 enclosed in double quotes if they contain white space. The rules are searched
24811 in order until one is found where the pattern, error name, and sender list (if
24812 present) match the failing host or address, the error that occurred, and the
24813 message's sender, respectively.
24814
24815
24816 The pattern is any single item that may appear in an address list (see section
24817 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24818 which means that it is expanded before being tested against the address that
24819 has been delayed. A negated address list item is permitted. Address
24820 list processing treats a plain domain name as if it were preceded by &"*@"&,
24821 which makes it possible for many retry rules to start with just a domain. For
24822 example,
24823 .code
24824 lookingglass.fict.example        *  F,24h,30m;
24825 .endd
24826 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24827 whereas
24828 .code
24829 alice@lookingglass.fict.example  *  F,24h,30m;
24830 .endd
24831 applies only to temporary failures involving the local part &%alice%&.
24832 In practice, almost all rules start with a domain name pattern without a local
24833 part.
24834
24835 .cindex "regular expressions" "in retry rules"
24836 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24837 must match a complete address, not just a domain, because that is how regular
24838 expressions work in address lists.
24839 .display
24840 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24841 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24842 .endd
24843
24844
24845 .section "Choosing which retry rule to use for address errors" "SECID159"
24846 When Exim is looking for a retry rule after a routing attempt has failed (for
24847 example, after a DNS timeout), each line in the retry configuration is tested
24848 against the complete address only if &%retry_use_local_part%& is set for the
24849 router. Otherwise, only the domain is used, except when matching against a
24850 regular expression, when the local part of the address is replaced with &"*"&.
24851 A domain on its own can match a domain pattern, or a pattern that starts with
24852 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24853 &%check_local_user%& is true, and false for other routers.
24854
24855 Similarly, when Exim is looking for a retry rule after a local delivery has
24856 failed (for example, after a mailbox full error), each line in the retry
24857 configuration is tested against the complete address only if
24858 &%retry_use_local_part%& is set for the transport (it defaults true for all
24859 local transports).
24860
24861 .cindex "4&'xx'& responses" "retry rules for"
24862 However, when Exim is looking for a retry rule after a remote delivery attempt
24863 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24864 whole address is always used as the key when searching the retry rules. The
24865 rule that is found is used to create a retry time for the combination of the
24866 failing address and the message's sender. It is the combination of sender and
24867 recipient that is delayed in subsequent queue runs until its retry time is
24868 reached. You can delay the recipient without regard to the sender by setting
24869 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24870 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24871 commands.
24872
24873
24874
24875 .section "Choosing which retry rule to use for host and message errors" &&&
24876          "SECID160"
24877 For a temporary error that is not related to an individual address (for
24878 example, a connection timeout), each line in the retry configuration is checked
24879 twice. First, the name of the remote host is used as a domain name (preceded by
24880 &"*@"& when matching a regular expression). If this does not match the line,
24881 the domain from the email address is tried in a similar fashion. For example,
24882 suppose the MX records for &'a.b.c.example'& are
24883 .code
24884 a.b.c.example  MX  5  x.y.z.example
24885                MX  6  p.q.r.example
24886                MX  7  m.n.o.example
24887 .endd
24888 and the retry rules are
24889 .code
24890 p.q.r.example    *      F,24h,30m;
24891 a.b.c.example    *      F,4d,45m;
24892 .endd
24893 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24894 first rule matches neither the host nor the domain, so Exim looks at the second
24895 rule. This does not match the host, but it does match the domain, so it is used
24896 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24897 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24898 first retry rule is used, because it matches the host.
24899
24900 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24901 first rule to determine retry times, but for all the other hosts for the domain
24902 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24903 routing to &'a.b.c.example'& suffers a temporary failure.
24904
24905 &*Note*&: The host name is used when matching the patterns, not its IP address.
24906 However, if a message is routed directly to an IP address without the use of a
24907 host name, for example, if a &(manualroute)& router contains a setting such as:
24908 .code
24909 route_list = *.a.example  192.168.34.23
24910 .endd
24911 then the &"host name"& that is used when searching for a retry rule is the
24912 textual form of the IP address.
24913
24914 .section "Retry rules for specific errors" "SECID161"
24915 .cindex "retry" "specific errors; specifying"
24916 The second field in a retry rule is the name of a particular error, or an
24917 asterisk, which matches any error. The errors that can be tested for are:
24918
24919 .vlist
24920 .vitem &%auth_failed%&
24921 Authentication failed when trying to send to a host in the
24922 &%hosts_require_auth%& list in an &(smtp)& transport.
24923
24924 .vitem &%data_4xx%&
24925 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24926 after the command, or after sending the message's data.
24927
24928 .vitem &%mail_4xx%&
24929 A 4&'xx'& error was received for an outgoing MAIL command.
24930
24931 .vitem &%rcpt_4xx%&
24932 A 4&'xx'& error was received for an outgoing RCPT command.
24933 .endlist
24934
24935 For the three 4&'xx'& errors, either the first or both of the x's can be given
24936 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24937 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24938 and have retries every ten minutes with a one-hour timeout, you could set up a
24939 retry rule of this form:
24940 .code
24941 the.domain.name  rcpt_452   F,1h,10m
24942 .endd
24943 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24944 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24945
24946 .vlist
24947 .vitem &%lost_connection%&
24948 A server unexpectedly closed the SMTP connection. There may, of course,
24949 legitimate reasons for this (host died, network died), but if it repeats a lot
24950 for the same host, it indicates something odd.
24951
24952 .vitem &%lookup%&
24953 A DNS lookup for a host failed.
24954 Note that a &%dnslookup%& router will need to have matched
24955 its &%fail_defer_domains%& option for this retry type to be usable.
24956 Also note that a &%manualroute%& router will probably need
24957 its &%host_find_failed%& option set to &%defer%&.
24958
24959 .vitem &%refused_MX%&
24960 A connection to a host obtained from an MX record was refused.
24961
24962 .vitem &%refused_A%&
24963 A connection to a host not obtained from an MX record was refused.
24964
24965 .vitem &%refused%&
24966 A connection was refused.
24967
24968 .vitem &%timeout_connect_MX%&
24969 A connection attempt to a host obtained from an MX record timed out.
24970
24971 .vitem &%timeout_connect_A%&
24972 A connection attempt to a host not obtained from an MX record timed out.
24973
24974 .vitem &%timeout_connect%&
24975 A connection attempt timed out.
24976
24977 .vitem &%timeout_MX%&
24978 There was a timeout while connecting or during an SMTP session with a host
24979 obtained from an MX record.
24980
24981 .vitem &%timeout_A%&
24982 There was a timeout while connecting or during an SMTP session with a host not
24983 obtained from an MX record.
24984
24985 .vitem &%timeout%&
24986 There was a timeout while connecting or during an SMTP session.
24987
24988 .vitem &%tls_required%&
24989 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24990 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24991 to STARTTLS, or there was a problem setting up the TLS connection.
24992
24993 .vitem &%quota%&
24994 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24995 transport.
24996
24997 .vitem &%quota_%&<&'time'&>
24998 .cindex "quota" "error testing in retry rule"
24999 .cindex "retry" "quota error testing"
25000 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25001 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25002 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25003 for four days.
25004 .endlist
25005
25006 .cindex "mailbox" "time of last read"
25007 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25008 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25009 it should be based on the last time that the user accessed the mailbox.
25010 However, it is not always possible to determine this. Exim uses the following
25011 heuristic rules:
25012
25013 .ilist
25014 If the mailbox is a single file, the time of last access (the &"atime"&) is
25015 used. As no new messages are being delivered (because the mailbox is over
25016 quota), Exim does not access the file, so this is the time of last user access.
25017 .next
25018 .cindex "maildir format" "time of last read"
25019 For a maildir delivery, the time of last modification of the &_new_&
25020 subdirectory is used. As the mailbox is over quota, no new files are created in
25021 the &_new_& subdirectory, because no new messages are being delivered. Any
25022 change to the &_new_& subdirectory is therefore assumed to be the result of an
25023 MUA moving a new message to the &_cur_& directory when it is first read. The
25024 time that is used is therefore the last time that the user read a new message.
25025 .next
25026 For other kinds of multi-file mailbox, the time of last access cannot be
25027 obtained, so a retry rule that uses this type of error field is never matched.
25028 .endlist
25029
25030 The quota errors apply both to system-enforced quotas and to Exim's own quota
25031 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25032 when a local delivery is deferred because a partition is full (the ENOSPC
25033 error).
25034
25035
25036
25037 .section "Retry rules for specified senders" "SECID162"
25038 .cindex "retry" "rules; sender-specific"
25039 You can specify retry rules that apply only when the failing message has a
25040 specific sender. In particular, this can be used to define retry rules that
25041 apply only to bounce messages. The third item in a retry rule can be of this
25042 form:
25043 .display
25044 &`senders=`&<&'address list'&>
25045 .endd
25046 The retry timings themselves are then the fourth item. For example:
25047 .code
25048 *   rcpt_4xx   senders=:   F,1h,30m
25049 .endd
25050 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25051 host. If the address list contains white space, it must be enclosed in quotes.
25052 For example:
25053 .code
25054 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25055 .endd
25056 &*Warning*&: This facility can be unhelpful if it is used for host errors
25057 (which do not depend on the recipient). The reason is that the sender is used
25058 only to match the retry rule. Once the rule has been found for a host error,
25059 its contents are used to set a retry time for the host, and this will apply to
25060 all messages, not just those with specific senders.
25061
25062 When testing retry rules using &%-brt%&, you can supply a sender using the
25063 &%-f%& command line option, like this:
25064 .code
25065 exim -f "" -brt user@dom.ain
25066 .endd
25067 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25068 list is never matched.
25069
25070
25071
25072
25073
25074 .section "Retry parameters" "SECID163"
25075 .cindex "retry" "parameters in rules"
25076 The third (or fourth, if a senders list is present) field in a retry rule is a
25077 sequence of retry parameter sets, separated by semicolons. Each set consists of
25078 .display
25079 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25080 .endd
25081 The letter identifies the algorithm for computing a new retry time; the cutoff
25082 time is the time beyond which this algorithm no longer applies, and the
25083 arguments vary the algorithm's action. The cutoff time is measured from the
25084 time that the first failure for the domain (combined with the local part if
25085 relevant) was detected, not from the time the message was received.
25086
25087 .cindex "retry" "algorithms"
25088 .cindex "retry" "fixed intervals"
25089 .cindex "retry" "increasing intervals"
25090 .cindex "retry" "random intervals"
25091 The available algorithms are:
25092
25093 .ilist
25094 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25095 the interval.
25096 .next
25097 &'G'&: retry at geometrically increasing intervals. The first argument
25098 specifies a starting value for the interval, and the second a multiplier, which
25099 is used to increase the size of the interval at each retry.
25100 .next
25101 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25102 retry, the previous interval is multiplied by the factor in order to get a
25103 maximum for the next interval. The minimum interval is the first argument of
25104 the parameter, and an actual interval is chosen randomly between them. Such a
25105 rule has been found to be helpful in cluster configurations when all the
25106 members of the cluster restart at once, and may therefore synchronize their
25107 queue processing times.
25108 .endlist
25109
25110 When computing the next retry time, the algorithm definitions are scanned in
25111 order until one whose cutoff time has not yet passed is reached. This is then
25112 used to compute a new retry time that is later than the current time. In the
25113 case of fixed interval retries, this simply means adding the interval to the
25114 current time. For geometrically increasing intervals, retry intervals are
25115 computed from the rule's parameters until one that is greater than the previous
25116 interval is found. The main configuration variable
25117 .cindex "limit" "retry interval"
25118 .cindex "retry" "interval, maximum"
25119 .oindex "&%retry_interval_max%&"
25120 &%retry_interval_max%& limits the maximum interval between retries. It
25121 cannot be set greater than &`24h`&, which is its default value.
25122
25123 A single remote domain may have a number of hosts associated with it, and each
25124 host may have more than one IP address. Retry algorithms are selected on the
25125 basis of the domain name, but are applied to each IP address independently. If,
25126 for example, a host has two IP addresses and one is unusable, Exim will
25127 generate retry times for it and will not try to use it until its next retry
25128 time comes. Thus the good IP address is likely to be tried first most of the
25129 time.
25130
25131 .cindex "hints database" "use for retrying"
25132 Retry times are hints rather than promises. Exim does not make any attempt to
25133 run deliveries exactly at the computed times. Instead, a queue runner process
25134 starts delivery processes for delayed messages periodically, and these attempt
25135 new deliveries only for those addresses that have passed their next retry time.
25136 If a new message arrives for a deferred address, an immediate delivery attempt
25137 occurs only if the address has passed its retry time. In the absence of new
25138 messages, the minimum time between retries is the interval between queue runner
25139 processes. There is not much point in setting retry times of five minutes if
25140 your queue runners happen only once an hour, unless there are a significant
25141 number of incoming messages (which might be the case on a system that is
25142 sending everything to a smart host, for example).
25143
25144 The data in the retry hints database can be inspected by using the
25145 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25146 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25147 &'exinext'& utility script can be used to find out what the next retry times
25148 are for the hosts associated with a particular mail domain, and also for local
25149 deliveries that have been deferred.
25150
25151
25152 .section "Retry rule examples" "SECID164"
25153 Here are some example retry rules:
25154 .code
25155 alice@wonderland.fict.example quota_5d  F,7d,3h
25156 wonderland.fict.example       quota_5d
25157 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25158 lookingglass.fict.example     *         F,24h,30m;
25159 *                 refused_A   F,2h,20m;
25160 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25161 .endd
25162 The first rule sets up special handling for mail to
25163 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25164 mailbox has not been read for at least 5 days. Retries continue every three
25165 hours for 7 days. The second rule handles over-quota errors for all other local
25166 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25167 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25168 fail are bounced immediately if the mailbox has not been read for at least 5
25169 days.
25170
25171 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25172 happen every 15 minutes for an hour, then with geometrically increasing
25173 intervals until two days have passed since a delivery first failed. After the
25174 first hour there is a delay of one hour, then two hours, then four hours, and
25175 so on (this is a rather extreme example).
25176
25177 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25178 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25179 all other domains, with special action for connection refusal from hosts that
25180 were not obtained from an MX record.
25181
25182 The final rule in a retry configuration should always have asterisks in the
25183 first two fields so as to provide a general catch-all for any addresses that do
25184 not have their own special handling. This example tries every 15 minutes for 2
25185 hours, then with intervals starting at one hour and increasing by a factor of
25186 1.5 up to 16 hours, then every 8 hours up to 5 days.
25187
25188
25189
25190 .section "Timeout of retry data" "SECID165"
25191 .cindex "timeout" "of retry data"
25192 .oindex "&%retry_data_expire%&"
25193 .cindex "hints database" "data expiry"
25194 .cindex "retry" "timeout of data"
25195 Exim timestamps the data that it writes to its retry hints database. When it
25196 consults the data during a delivery it ignores any that is older than the value
25197 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25198 been tried for 7 days, Exim will try to deliver to it immediately a message
25199 arrives, and if that fails, it will calculate a retry time as if it were
25200 failing for the first time.
25201
25202 This improves the behaviour for messages routed to rarely-used hosts such as MX
25203 backups. If such a host was down at one time, and happens to be down again when
25204 Exim tries a month later, using the old retry data would imply that it had been
25205 down all the time, which is not a justified assumption.
25206
25207 If a host really is permanently dead, this behaviour causes a burst of retries
25208 every now and again, but only if messages routed to it are rare. If there is a
25209 message at least once every 7 days the retry data never expires.
25210
25211
25212
25213
25214 .section "Long-term failures" "SECID166"
25215 .cindex "delivery failure, long-term"
25216 .cindex "retry" "after long-term failure"
25217 Special processing happens when an email address has been failing for so long
25218 that the cutoff time for the last algorithm is reached. For example, using the
25219 default retry rule:
25220 .code
25221 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25222 .endd
25223 the cutoff time is four days. Reaching the retry cutoff is independent of how
25224 long any specific message has been failing; it is the length of continuous
25225 failure for the recipient address that counts.
25226
25227 When the cutoff time is reached for a local delivery, or for all the IP
25228 addresses associated with a remote delivery, a subsequent delivery failure
25229 causes Exim to give up on the address, and a bounce message is generated.
25230 In order to cater for new messages that use the failing address, a next retry
25231 time is still computed from the final algorithm, and is used as follows:
25232
25233 For local deliveries, one delivery attempt is always made for any subsequent
25234 messages. If this delivery fails, the address fails immediately. The
25235 post-cutoff retry time is not used.
25236
25237 If the delivery is remote, there are two possibilities, controlled by the
25238 .oindex "&%delay_after_cutoff%&"
25239 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25240 default. Until the post-cutoff retry time for one of the IP addresses is
25241 reached, the failing email address is bounced immediately, without a delivery
25242 attempt taking place. After that time, one new delivery attempt is made to
25243 those IP addresses that are past their retry times, and if that still fails,
25244 the address is bounced and new retry times are computed.
25245
25246 In other words, when all the hosts for a given email address have been failing
25247 for a long time, Exim bounces rather then defers until one of the hosts' retry
25248 times is reached. Then it tries once, and bounces if that attempt fails. This
25249 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25250 to a broken destination, but if the host does recover, Exim will eventually
25251 notice.
25252
25253 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25254 addresses are past their final cutoff time, Exim tries to deliver to those IP
25255 addresses that have not been tried since the message arrived. If there are
25256 no suitable IP addresses, or if they all fail, the address is bounced. In other
25257 words, it does not delay when a new message arrives, but tries the expired
25258 addresses immediately, unless they have been tried since the message arrived.
25259 If there is a continuous stream of messages for the failing domains, setting
25260 &%delay_after_cutoff%& false means that there will be many more attempts to
25261 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25262 true.
25263
25264 .section "Deliveries that work intermittently" "SECID167"
25265 .cindex "retry" "intermittently working deliveries"
25266 Some additional logic is needed to cope with cases where a host is
25267 intermittently available, or when a message has some attribute that prevents
25268 its delivery when others to the same address get through. In this situation,
25269 because some messages are successfully delivered, the &"retry clock"& for the
25270 host or address keeps getting reset by the successful deliveries, and so
25271 failing messages remain on the queue for ever because the cutoff time is never
25272 reached.
25273
25274 Two exceptional actions are applied to prevent this happening. The first
25275 applies to errors that are related to a message rather than a remote host.
25276 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25277 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25278 commands, and quota failures. For this type of error, if a message's arrival
25279 time is earlier than the &"first failed"& time for the error, the earlier time
25280 is used when scanning the retry rules to decide when to try next and when to
25281 time out the address.
25282
25283 The exceptional second action applies in all cases. If a message has been on
25284 the queue for longer than the cutoff time of any applicable retry rule for a
25285 given address, a delivery is attempted for that address, even if it is not yet
25286 time, and if this delivery fails, the address is timed out. A new retry time is
25287 not computed in this case, so that other messages for the same address are
25288 considered immediately.
25289 .ecindex IIDretconf1
25290 .ecindex IIDregconf2
25291
25292
25293
25294
25295
25296
25297 . ////////////////////////////////////////////////////////////////////////////
25298 . ////////////////////////////////////////////////////////////////////////////
25299
25300 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25301 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25302 .scindex IIDauthconf2 "authentication"
25303 The &"authenticators"& section of Exim's run time configuration is concerned
25304 with SMTP authentication. This facility is an extension to the SMTP protocol,
25305 described in RFC 2554, which allows a client SMTP host to authenticate itself
25306 to a server. This is a common way for a server to recognize clients that are
25307 permitted to use it as a relay. SMTP authentication is not of relevance to the
25308 transfer of mail between servers that have no managerial connection with each
25309 other.
25310
25311 .cindex "AUTH" "description of"
25312 Very briefly, the way SMTP authentication works is as follows:
25313
25314 .ilist
25315 The server advertises a number of authentication &'mechanisms'& in response to
25316 the client's EHLO command.
25317 .next
25318 The client issues an AUTH command, naming a specific mechanism. The command
25319 may, optionally, contain some authentication data.
25320 .next
25321 The server may issue one or more &'challenges'&, to which the client must send
25322 appropriate responses. In simple authentication mechanisms, the challenges are
25323 just prompts for user names and passwords. The server does not have to issue
25324 any challenges &-- in some mechanisms the relevant data may all be transmitted
25325 with the AUTH command.
25326 .next
25327 The server either accepts or denies authentication.
25328 .next
25329 If authentication succeeds, the client may optionally make use of the AUTH
25330 option on the MAIL command to pass an authenticated sender in subsequent
25331 mail transactions. Authentication lasts for the remainder of the SMTP
25332 connection.
25333 .next
25334 If authentication fails, the client may give up, or it may try a different
25335 authentication mechanism, or it may try transferring mail over the
25336 unauthenticated connection.
25337 .endlist
25338
25339 If you are setting up a client, and want to know which authentication
25340 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25341 SMTP port) on the server, and issue an EHLO command. The response to this
25342 includes the list of supported mechanisms. For example:
25343 .display
25344 &`$ `&&*&`telnet server.example 25`&*&
25345 &`Trying 192.168.34.25...`&
25346 &`Connected to server.example.`&
25347 &`Escape character is &#x0027;^]&#x0027;.`&
25348 &`220 server.example ESMTP Exim 4.20 ...`&
25349 &*&`ehlo client.example`&*&
25350 &`250-server.example Hello client.example [10.8.4.5]`&
25351 &`250-SIZE 52428800`&
25352 &`250-PIPELINING`&
25353 &`250-AUTH PLAIN`&
25354 &`250 HELP`&
25355 .endd
25356 The second-last line of this example output shows that the server supports
25357 authentication using the PLAIN mechanism. In Exim, the different authentication
25358 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25359 routers and transports, which authenticators are included in the binary is
25360 controlled by build-time definitions. The following are currently available,
25361 included by setting
25362 .code
25363 AUTH_CRAM_MD5=yes
25364 AUTH_CYRUS_SASL=yes
25365 AUTH_DOVECOT=yes
25366 AUTH_GSASL=yes
25367 AUTH_HEIMDAL_GSSAPI=yes
25368 AUTH_PLAINTEXT=yes
25369 AUTH_SPA=yes
25370 AUTH_TLS=yes
25371 .endd
25372 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25373 authentication mechanism (RFC 2195), and the second provides an interface to
25374 the Cyrus SASL authentication library.
25375 The third is an interface to Dovecot's authentication system, delegating the
25376 work via a socket interface.
25377 The fourth provides an interface to the GNU SASL authentication library, which
25378 provides mechanisms but typically not data sources.
25379 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25380 supporting setting a server keytab.
25381 The sixth can be configured to support
25382 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25383 not formally documented, but used by several MUAs. The seventh authenticator
25384 supports Microsoft's &'Secure Password Authentication'& mechanism.
25385 The eighth is an Exim authenticator but not an SMTP one;
25386 instead it can use information from a TLS negotiation.
25387
25388 The authenticators are configured using the same syntax as other drivers (see
25389 section &<<SECTfordricon>>&). If no authenticators are required, no
25390 authentication section need be present in the configuration file. Each
25391 authenticator can in principle have both server and client functions. When Exim
25392 is receiving SMTP mail, it is acting as a server; when it is sending out
25393 messages over SMTP, it is acting as a client. Authenticator configuration
25394 options are provided for use in both these circumstances.
25395
25396 To make it clear which options apply to which situation, the prefixes
25397 &%server_%& and &%client_%& are used on option names that are specific to
25398 either the server or the client function, respectively. Server and client
25399 functions are disabled if none of their options are set. If an authenticator is
25400 to be used for both server and client functions, a single definition, using
25401 both sets of options, is required. For example:
25402 .code
25403 cram:
25404   driver = cram_md5
25405   public_name = CRAM-MD5
25406   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25407   client_name = ph10
25408   client_secret = secret2
25409 .endd
25410 The &%server_%& option is used when Exim is acting as a server, and the
25411 &%client_%& options when it is acting as a client.
25412
25413 Descriptions of the individual authenticators are given in subsequent chapters.
25414 The remainder of this chapter covers the generic options for the
25415 authenticators, followed by general discussion of the way authentication works
25416 in Exim.
25417
25418 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25419 per-mechanism basis.  Please read carefully to determine which variables hold
25420 account labels such as usercodes and which hold passwords or other
25421 authenticating data.
25422
25423 Note that some mechanisms support two different identifiers for accounts: the
25424 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25425 and &'authz'& are commonly encountered.  The American spelling is standard here.
25426 Conceptually, authentication data such as passwords are tied to the identifier
25427 used to authenticate; servers may have rules to permit one user to act as a
25428 second user, so that after login the session is treated as though that second
25429 user had logged in.  That second user is the &'authorization id'&.  A robust
25430 configuration might confirm that the &'authz'& field is empty or matches the
25431 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25432 as verified data, the &'authz'& as an unverified request which the server might
25433 choose to honour.
25434
25435 A &'realm'& is a text string, typically a domain name, presented by a server
25436 to a client to help it select an account and credentials to use.  In some
25437 mechanisms, the client and server provably agree on the realm, but clients
25438 typically can not treat the realm as secure data to be blindly trusted.
25439
25440
25441
25442 .section "Generic options for authenticators" "SECID168"
25443 .cindex "authentication" "generic options"
25444 .cindex "options" "generic; for authenticators"
25445
25446 .option client_condition authenticators string&!! unset
25447 When Exim is authenticating as a client, it skips any authenticator whose
25448 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25449 used, for example, to skip plain text authenticators when the connection is not
25450 encrypted by a setting such as:
25451 .code
25452 client_condition = ${if !eq{$tls_out_cipher}{}}
25453 .endd
25454
25455
25456 .option client_set_id authenticators string&!! unset
25457 When client authentication succeeds, this condition is expanded; the
25458 result is used in the log lines for outbound messages.
25459 Typically it will be the user name used for authentication.
25460
25461
25462 .option driver authenticators string unset
25463 This option must always be set. It specifies which of the available
25464 authenticators is to be used.
25465
25466
25467 .option public_name authenticators string unset
25468 This option specifies the name of the authentication mechanism that the driver
25469 implements, and by which it is known to the outside world. These names should
25470 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25471 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25472 defaults to the driver's instance name.
25473
25474
25475 .option server_advertise_condition authenticators string&!! unset
25476 When a server is about to advertise an authentication mechanism, the condition
25477 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25478 mechanism is not advertised.
25479 If the expansion fails, the mechanism is not advertised. If the failure was not
25480 forced, and was not caused by a lookup defer, the incident is logged.
25481 See section &<<SECTauthexiser>>& below for further discussion.
25482
25483
25484 .option server_condition authenticators string&!! unset
25485 This option must be set for a &%plaintext%& server authenticator, where it
25486 is used directly to control authentication. See section &<<SECTplainserver>>&
25487 for details.
25488
25489 For the &(gsasl)& authenticator, this option is required for various
25490 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25491
25492 For the other authenticators, &%server_condition%& can be used as an additional
25493 authentication or authorization mechanism that is applied after the other
25494 authenticator conditions succeed. If it is set, it is expanded when the
25495 authenticator would otherwise return a success code. If the expansion is forced
25496 to fail, authentication fails. Any other expansion failure causes a temporary
25497 error code to be returned. If the result of a successful expansion is an empty
25498 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25499 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25500 other result, a temporary error code is returned, with the expanded string as
25501 the error text.
25502
25503
25504 .option server_debug_print authenticators string&!! unset
25505 If this option is set and authentication debugging is enabled (see the &%-d%&
25506 command line option), the string is expanded and included in the debugging
25507 output when the authenticator is run as a server. This can help with checking
25508 out the values of variables.
25509 If expansion of the string fails, the error message is written to the debugging
25510 output, and Exim carries on processing.
25511
25512
25513 .option server_set_id authenticators string&!! unset
25514 .vindex "&$authenticated_id$&"
25515 When an Exim server successfully authenticates a client, this string is
25516 expanded using data from the authentication, and preserved for any incoming
25517 messages in the variable &$authenticated_id$&. It is also included in the log
25518 lines for incoming messages. For example, a user/password authenticator
25519 configuration might preserve the user name that was used to authenticate, and
25520 refer to it subsequently during delivery of the message.
25521 If expansion fails, the option is ignored.
25522
25523
25524 .option server_mail_auth_condition authenticators string&!! unset
25525 This option allows a server to discard authenticated sender addresses supplied
25526 as part of MAIL commands in SMTP connections that are authenticated by the
25527 driver on which &%server_mail_auth_condition%& is set. The option is not used
25528 as part of the authentication process; instead its (unexpanded) value is
25529 remembered for later use.
25530 How it is used is described in the following section.
25531
25532
25533
25534
25535
25536 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25537 .cindex "authentication" "sender; authenticated"
25538 .cindex "AUTH" "on MAIL command"
25539 When a client supplied an AUTH= item on a MAIL command, Exim applies
25540 the following checks before accepting it as the authenticated sender of the
25541 message:
25542
25543 .ilist
25544 If the connection is not using extended SMTP (that is, HELO was used rather
25545 than EHLO), the use of AUTH= is a syntax error.
25546 .next
25547 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25548 .next
25549 .vindex "&$authenticated_sender$&"
25550 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25551 running, the value of &$authenticated_sender$& is set to the value obtained
25552 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25553 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25554 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25555 given for the MAIL command.
25556 .next
25557 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25558 is accepted and placed in &$authenticated_sender$& only if the client has
25559 authenticated.
25560 .next
25561 If the AUTH= value was accepted by either of the two previous rules, and
25562 the client has authenticated, and the authenticator has a setting for the
25563 &%server_mail_auth_condition%&, the condition is checked at this point. The
25564 valued that was saved from the authenticator is expanded. If the expansion
25565 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25566 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25567 the value of &$authenticated_sender$& is retained and passed on with the
25568 message.
25569 .endlist
25570
25571
25572 When &$authenticated_sender$& is set for a message, it is passed on to other
25573 hosts to which Exim authenticates as a client. Do not confuse this value with
25574 &$authenticated_id$&, which is a string obtained from the authentication
25575 process, and which is not usually a complete email address.
25576
25577 .vindex "&$sender_address$&"
25578 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25579 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25580 therefore make use of &$authenticated_sender$&. The converse is not true: the
25581 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25582 ACL is run.
25583
25584
25585
25586 .section "Authentication on an Exim server" "SECTauthexiser"
25587 .cindex "authentication" "on an Exim server"
25588 When Exim receives an EHLO command, it advertises the public names of those
25589 authenticators that are configured as servers, subject to the following
25590 conditions:
25591
25592 .ilist
25593 The client host must match &%auth_advertise_hosts%& (default *).
25594 .next
25595 It the &%server_advertise_condition%& option is set, its expansion must not
25596 yield the empty string, &"0"&, &"no"&, or &"false"&.
25597 .endlist
25598
25599 The order in which the authenticators are defined controls the order in which
25600 the mechanisms are advertised.
25601
25602 Some mail clients (for example, some versions of Netscape) require the user to
25603 provide a name and password for authentication whenever AUTH is advertised,
25604 even though authentication may not in fact be needed (for example, Exim may be
25605 set up to allow unconditional relaying from the client by an IP address check).
25606 You can make such clients more friendly by not advertising AUTH to them.
25607 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25608 that runs for RCPT) to relay without authentication, you should set
25609 .code
25610 auth_advertise_hosts = ! 10.9.8.0/24
25611 .endd
25612 so that no authentication mechanisms are advertised to them.
25613
25614 The &%server_advertise_condition%& controls the advertisement of individual
25615 authentication mechanisms. For example, it can be used to restrict the
25616 advertisement of a particular mechanism to encrypted connections, by a setting
25617 such as:
25618 .code
25619 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25620 .endd
25621 .vindex "&$tls_in_cipher$&"
25622 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25623 yields &"yes"&, which allows the advertisement to happen.
25624
25625 When an Exim server receives an AUTH command from a client, it rejects it
25626 immediately if AUTH was not advertised in response to an earlier EHLO
25627 command. This is the case if
25628
25629 .ilist
25630 The client host does not match &%auth_advertise_hosts%&; or
25631 .next
25632 No authenticators are configured with server options; or
25633 .next
25634 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25635 server authenticators.
25636 .endlist
25637
25638
25639 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25640 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25641 AUTH is accepted from any client host.
25642
25643 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25644 server authentication mechanism that was advertised in response to EHLO and
25645 that matches the one named in the AUTH command. If it finds one, it runs
25646 the appropriate authentication protocol, and authentication either succeeds or
25647 fails. If there is no matching advertised mechanism, the AUTH command is
25648 rejected with a 504 error.
25649
25650 .vindex "&$received_protocol$&"
25651 .vindex "&$sender_host_authenticated$&"
25652 When a message is received from an authenticated host, the value of
25653 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25654 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25655 public name) of the authenticator driver that successfully authenticated the
25656 client from which the message was received. This variable is empty if there was
25657 no successful authentication.
25658
25659
25660
25661
25662 .section "Testing server authentication" "SECID169"
25663 .cindex "authentication" "testing a server"
25664 .cindex "AUTH" "testing a server"
25665 .cindex "base64 encoding" "creating authentication test data"
25666 Exim's &%-bh%& option can be useful for testing server authentication
25667 configurations. The data for the AUTH command has to be sent using base64
25668 encoding. A quick way to produce such data for testing is the following Perl
25669 script:
25670 .code
25671 use MIME::Base64;
25672 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25673 .endd
25674 .cindex "binary zero" "in authentication data"
25675 This interprets its argument as a Perl string, and then encodes it. The
25676 interpretation as a Perl string allows binary zeros, which are required for
25677 some kinds of authentication, to be included in the data. For example, a
25678 command line to run this script on such data might be
25679 .code
25680 encode '\0user\0password'
25681 .endd
25682 Note the use of single quotes to prevent the shell interpreting the
25683 backslashes, so that they can be interpreted by Perl to specify characters
25684 whose code value is zero.
25685
25686 &*Warning 1*&: If either of the user or password strings starts with an octal
25687 digit, you must use three zeros instead of one after the leading backslash. If
25688 you do not, the octal digit that starts your string will be incorrectly
25689 interpreted as part of the code for the first character.
25690
25691 &*Warning 2*&: If there are characters in the strings that Perl interprets
25692 specially, you must use a Perl escape to prevent them being misinterpreted. For
25693 example, a command such as
25694 .code
25695 encode '\0user@domain.com\0pas$$word'
25696 .endd
25697 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25698
25699 If you have the &%mimencode%& command installed, another way to do produce
25700 base64-encoded strings is to run the command
25701 .code
25702 echo -e -n `\0user\0password' | mimencode
25703 .endd
25704 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25705 in the argument, and the &%-n%& option specifies no newline at the end of its
25706 output. However, not all versions of &%echo%& recognize these options, so you
25707 should check your version before relying on this suggestion.
25708
25709
25710
25711 .section "Authentication by an Exim client" "SECID170"
25712 .cindex "authentication" "on an Exim client"
25713 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25714 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25715 announces support for authentication, and the host matches an entry in either
25716 of these options, Exim (as a client) tries to authenticate as follows:
25717
25718 .ilist
25719 For each authenticator that is configured as a client, in the order in which
25720 they are defined in the configuration, it searches the authentication
25721 mechanisms announced by the server for one whose name matches the public name
25722 of the authenticator.
25723 .next
25724 .vindex "&$host$&"
25725 .vindex "&$host_address$&"
25726 When it finds one that matches, it runs the authenticator's client code. The
25727 variables &$host$& and &$host_address$& are available for any string expansions
25728 that the client might do. They are set to the server's name and IP address. If
25729 any expansion is forced to fail, the authentication attempt is abandoned, and
25730 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25731 delivery to be deferred.
25732 .next
25733 If the result of the authentication attempt is a temporary error or a timeout,
25734 Exim abandons trying to send the message to the host for the moment. It will
25735 try again later. If there are any backup hosts available, they are tried in the
25736 usual way.
25737 .next
25738 If the response to authentication is a permanent error (5&'xx'& code), Exim
25739 carries on searching the list of authenticators and tries another one if
25740 possible. If all authentication attempts give permanent errors, or if there are
25741 no attempts because no mechanisms match (or option expansions force failure),
25742 what happens depends on whether the host matches &%hosts_require_auth%& or
25743 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25744 delivery is deferred. The error can be detected in the retry rules, and thereby
25745 turned into a permanent error if you wish. In the second case, Exim tries to
25746 deliver the message unauthenticated.
25747 .endlist
25748
25749 .cindex "AUTH" "on MAIL command"
25750 When Exim has authenticated itself to a remote server, it adds the AUTH
25751 parameter to the MAIL commands it sends, if it has an authenticated sender for
25752 the message. If the message came from a remote host, the authenticated sender
25753 is the one that was receiving on an incoming MAIL command, provided that the
25754 incoming connection was authenticated and the &%server_mail_auth%& condition
25755 allowed the authenticated sender to be retained. If a local process calls Exim
25756 to send a message, the sender address that is built from the login name and
25757 &%qualify_domain%& is treated as authenticated. However, if the
25758 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25759 the authenticated sender that was received with the message.
25760 .ecindex IIDauthconf1
25761 .ecindex IIDauthconf2
25762
25763
25764
25765
25766
25767
25768 . ////////////////////////////////////////////////////////////////////////////
25769 . ////////////////////////////////////////////////////////////////////////////
25770
25771 .chapter "The plaintext authenticator" "CHAPplaintext"
25772 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25773 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25774 The &(plaintext)& authenticator can be configured to support the PLAIN and
25775 LOGIN authentication mechanisms, both of which transfer authentication data as
25776 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25777 security risk; you are strongly advised to insist on the use of SMTP encryption
25778 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25779 use unencrypted plain text, you should not use the same passwords for SMTP
25780 connections as you do for login accounts.
25781
25782 .section "Plaintext options" "SECID171"
25783 .cindex "options" "&(plaintext)& authenticator (server)"
25784 When configured as a server, &(plaintext)& uses the following options:
25785
25786 .option server_condition authenticators string&!! unset
25787 This is actually a global authentication option, but it must be set in order to
25788 configure the &(plaintext)& driver as a server. Its use is described below.
25789
25790 .option server_prompts plaintext string&!! unset
25791 The contents of this option, after expansion, must be a colon-separated list of
25792 prompt strings. If expansion fails, a temporary authentication rejection is
25793 given.
25794
25795 .section "Using plaintext in a server" "SECTplainserver"
25796 .cindex "AUTH" "in &(plaintext)& authenticator"
25797 .cindex "binary zero" "in &(plaintext)& authenticator"
25798 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25799         "in &(plaintext)& authenticator"
25800 .vindex "&$auth1$&, &$auth2$&, etc"
25801 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25802
25803 When running as a server, &(plaintext)& performs the authentication test by
25804 expanding a string. The data sent by the client with the AUTH command, or in
25805 response to subsequent prompts, is base64 encoded, and so may contain any byte
25806 values when decoded. If any data is supplied with the command, it is treated as
25807 a list of strings, separated by NULs (binary zeros), the first three of which
25808 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25809 (neither LOGIN nor PLAIN uses more than three strings).
25810
25811 For compatibility with previous releases of Exim, the values are also placed in
25812 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25813 variables for this purpose is now deprecated, as it can lead to confusion in
25814 string expansions that also use them for other things.
25815
25816 If there are more strings in &%server_prompts%& than the number of strings
25817 supplied with the AUTH command, the remaining prompts are used to obtain more
25818 data. Each response from the client may be a list of NUL-separated strings.
25819
25820 .vindex "&$authenticated_id$&"
25821 Once a sufficient number of data strings have been received,
25822 &%server_condition%& is expanded. If the expansion is forced to fail,
25823 authentication fails. Any other expansion failure causes a temporary error code
25824 to be returned. If the result of a successful expansion is an empty string,
25825 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25826 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25827 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25828 For any other result, a temporary error code is returned, with the expanded
25829 string as the error text
25830
25831 &*Warning*&: If you use a lookup in the expansion to find the user's
25832 password, be sure to make the authentication fail if the user is unknown.
25833 There are good and bad examples at the end of the next section.
25834
25835
25836
25837 .section "The PLAIN authentication mechanism" "SECID172"
25838 .cindex "PLAIN authentication mechanism"
25839 .cindex "authentication" "PLAIN mechanism"
25840 .cindex "binary zero" "in &(plaintext)& authenticator"
25841 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25842 sent as one item of data (that is, one combined string containing two NUL
25843 separators). The data is sent either as part of the AUTH command, or
25844 subsequently in response to an empty prompt from the server.
25845
25846 The second and third strings are a user name and a corresponding password.
25847 Using a single fixed user name and password as an example, this could be
25848 configured as follows:
25849 .code
25850 fixed_plain:
25851   driver = plaintext
25852   public_name = PLAIN
25853   server_prompts = :
25854   server_condition = \
25855     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25856   server_set_id = $auth2
25857 .endd
25858 Note that the default result strings from &%if%& (&"true"& or an empty string)
25859 are exactly what we want here, so they need not be specified. Obviously, if the
25860 password contains expansion-significant characters such as dollar, backslash,
25861 or closing brace, they have to be escaped.
25862
25863 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25864 the end of a string list are ignored). If all the data comes as part of the
25865 AUTH command, as is commonly the case, the prompt is not used. This
25866 authenticator is advertised in the response to EHLO as
25867 .code
25868 250-AUTH PLAIN
25869 .endd
25870 and a client host can authenticate itself by sending the command
25871 .code
25872 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25873 .endd
25874 As this contains three strings (more than the number of prompts), no further
25875 data is required from the client. Alternatively, the client may just send
25876 .code
25877 AUTH PLAIN
25878 .endd
25879 to initiate authentication, in which case the server replies with an empty
25880 prompt. The client must respond with the combined data string.
25881
25882 The data string is base64 encoded, as required by the RFC. This example,
25883 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25884 represents a zero byte. This is split up into three strings, the first of which
25885 is empty. The &%server_condition%& option in the authenticator checks that the
25886 second two are &`username`& and &`mysecret`& respectively.
25887
25888 Having just one fixed user name and password, as in this example, is not very
25889 realistic, though for a small organization with only a handful of
25890 authenticating clients it could make sense.
25891
25892 A more sophisticated instance of this authenticator could use the user name in
25893 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25894 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25895 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25896 This is an incorrect example:
25897 .code
25898 server_condition = \
25899   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25900 .endd
25901 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25902 which it then compares to the supplied password (&$auth3$&). Why is this example
25903 incorrect? It works fine for existing users, but consider what happens if a
25904 non-existent user name is given. The lookup fails, but as no success/failure
25905 strings are given for the lookup, it yields an empty string. Thus, to defeat
25906 the authentication, all a client has to do is to supply a non-existent user
25907 name and an empty password. The correct way of writing this test is:
25908 .code
25909 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25910   {${if eq{$value}{$auth3}}} {false}}
25911 .endd
25912 In this case, if the lookup succeeds, the result is checked; if the lookup
25913 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25914 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25915 always fails if its second argument is empty. However, the second way of
25916 writing the test makes the logic clearer.
25917
25918
25919 .section "The LOGIN authentication mechanism" "SECID173"
25920 .cindex "LOGIN authentication mechanism"
25921 .cindex "authentication" "LOGIN mechanism"
25922 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25923 in a number of programs. No data is sent with the AUTH command. Instead, a
25924 user name and password are supplied separately, in response to prompts. The
25925 plaintext authenticator can be configured to support this as in this example:
25926 .code
25927 fixed_login:
25928   driver = plaintext
25929   public_name = LOGIN
25930   server_prompts = User Name : Password
25931   server_condition = \
25932     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25933   server_set_id = $auth1
25934 .endd
25935 Because of the way plaintext operates, this authenticator accepts data supplied
25936 with the AUTH command (in contravention of the specification of LOGIN), but
25937 if the client does not supply it (as is the case for LOGIN clients), the prompt
25938 strings are used to obtain two data items.
25939
25940 Some clients are very particular about the precise text of the prompts. For
25941 example, Outlook Express is reported to recognize only &"Username:"& and
25942 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25943 strings. It uses the &%ldapauth%& expansion condition to check the user
25944 name and password by binding to an LDAP server:
25945 .code
25946 login:
25947   driver = plaintext
25948   public_name = LOGIN
25949   server_prompts = Username:: : Password::
25950   server_condition = ${if and{{ \
25951     !eq{}{$auth1} }{ \
25952     ldapauth{\
25953       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25954       pass=${quote:$auth2} \
25955       ldap://ldap.example.org/} }} }
25956   server_set_id = uid=$auth1,ou=people,o=example.org
25957 .endd
25958 We have to check that the username is not empty before using it, because LDAP
25959 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25960 operator to correctly quote the DN for authentication. However, the basic
25961 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25962 correct one to use for the password, because quoting is needed only to make
25963 the password conform to the Exim syntax. At the LDAP level, the password is an
25964 uninterpreted string.
25965
25966
25967 .section "Support for different kinds of authentication" "SECID174"
25968 A number of string expansion features are provided for the purpose of
25969 interfacing to different ways of user authentication. These include checking
25970 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25971 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25972 &<<SECTexpcond>>&.
25973
25974
25975
25976
25977 .section "Using plaintext in a client" "SECID175"
25978 .cindex "options" "&(plaintext)& authenticator (client)"
25979 The &(plaintext)& authenticator has two client options:
25980
25981 .option client_ignore_invalid_base64 plaintext boolean false
25982 If the client receives a server prompt that is not a valid base64 string,
25983 authentication is abandoned by default. However, if this option is set true,
25984 the error in the challenge is ignored and the client sends the response as
25985 usual.
25986
25987 .option client_send plaintext string&!! unset
25988 The string is a colon-separated list of authentication data strings. Each
25989 string is independently expanded before being sent to the server. The first
25990 string is sent with the AUTH command; any more strings are sent in response
25991 to prompts from the server. Before each string is expanded, the value of the
25992 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25993 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25994 way. Thus, the prompt that is received in response to sending the first string
25995 (with the AUTH command) can be used in the expansion of the second string, and
25996 so on. If an invalid base64 string is received when
25997 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25998 &$auth$&<&'n'&> variable.
25999
26000 &*Note*&: You cannot use expansion to create multiple strings, because
26001 splitting takes priority and happens first.
26002
26003 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26004 the data, further processing is applied to each string before it is sent. If
26005 there are any single circumflex characters in the string, they are converted to
26006 NULs. Should an actual circumflex be required as data, it must be doubled in
26007 the string.
26008
26009 This is an example of a client configuration that implements the PLAIN
26010 authentication mechanism with a fixed user name and password:
26011 .code
26012 fixed_plain:
26013   driver = plaintext
26014   public_name = PLAIN
26015   client_send = ^username^mysecret
26016 .endd
26017 The lack of colons means that the entire text is sent with the AUTH
26018 command, with the circumflex characters converted to NULs. A similar example
26019 that uses the LOGIN mechanism is:
26020 .code
26021 fixed_login:
26022   driver = plaintext
26023   public_name = LOGIN
26024   client_send = : username : mysecret
26025 .endd
26026 The initial colon means that the first string is empty, so no data is sent with
26027 the AUTH command itself. The remaining strings are sent in response to
26028 prompts.
26029 .ecindex IIDplaiauth1
26030 .ecindex IIDplaiauth2
26031
26032
26033
26034
26035 . ////////////////////////////////////////////////////////////////////////////
26036 . ////////////////////////////////////////////////////////////////////////////
26037
26038 .chapter "The cram_md5 authenticator" "CHID9"
26039 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26040 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26041 .cindex "CRAM-MD5 authentication mechanism"
26042 .cindex "authentication" "CRAM-MD5 mechanism"
26043 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26044 sends a challenge string to the client, and the response consists of a user
26045 name and the CRAM-MD5 digest of the challenge string combined with a secret
26046 string (password) which is known to both server and client. Thus, the secret
26047 is not sent over the network as plain text, which makes this authenticator more
26048 secure than &(plaintext)&. However, the downside is that the secret has to be
26049 available in plain text at either end.
26050
26051
26052 .section "Using cram_md5 as a server" "SECID176"
26053 .cindex "options" "&(cram_md5)& authenticator (server)"
26054 This authenticator has one server option, which must be set to configure the
26055 authenticator as a server:
26056
26057 .option server_secret cram_md5 string&!! unset
26058 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26059 When the server receives the client's response, the user name is placed in
26060 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26061 obtain the password for that user. The server then computes the CRAM-MD5 digest
26062 that the client should have sent, and checks that it received the correct
26063 string. If the expansion of &%server_secret%& is forced to fail, authentication
26064 fails. If the expansion fails for some other reason, a temporary error code is
26065 returned to the client.
26066
26067 For compatibility with previous releases of Exim, the user name is also placed
26068 in &$1$&. However, the use of this variables for this purpose is now
26069 deprecated, as it can lead to confusion in string expansions that also use
26070 numeric variables for other things.
26071
26072 For example, the following authenticator checks that the user name given by the
26073 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26074 user name, authentication fails.
26075 .code
26076 fixed_cram:
26077   driver = cram_md5
26078   public_name = CRAM-MD5
26079   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26080   server_set_id = $auth1
26081 .endd
26082 .vindex "&$authenticated_id$&"
26083 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26084 name in &$authenticated_id$&. A more typical configuration might look up the
26085 secret string in a file, using the user name as the key. For example:
26086 .code
26087 lookup_cram:
26088   driver = cram_md5
26089   public_name = CRAM-MD5
26090   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26091                   {$value}fail}
26092   server_set_id = $auth1
26093 .endd
26094 Note that this expansion explicitly forces failure if the lookup fails
26095 because &$auth1$& contains an unknown user name.
26096
26097 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26098 using the relevant libraries, you need to know the realm to specify in the
26099 lookup and then ask for the &"userPassword"& attribute for that user in that
26100 realm, with:
26101 .code
26102 cyrusless_crammd5:
26103   driver = cram_md5
26104   public_name = CRAM-MD5
26105   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26106                   dbmjz{/etc/sasldb2}{$value}fail}
26107   server_set_id = $auth1
26108 .endd
26109
26110 .section "Using cram_md5 as a client" "SECID177"
26111 .cindex "options" "&(cram_md5)& authenticator (client)"
26112 When used as a client, the &(cram_md5)& authenticator has two options:
26113
26114
26115
26116 .option client_name cram_md5 string&!! "the primary host name"
26117 This string is expanded, and the result used as the user name data when
26118 computing the response to the server's challenge.
26119
26120
26121 .option client_secret cram_md5 string&!! unset
26122 This option must be set for the authenticator to work as a client. Its value is
26123 expanded and the result used as the secret string when computing the response.
26124
26125
26126 .vindex "&$host$&"
26127 .vindex "&$host_address$&"
26128 Different user names and secrets can be used for different servers by referring
26129 to &$host$& or &$host_address$& in the options. Forced failure of either
26130 expansion string is treated as an indication that this authenticator is not
26131 prepared to handle this case. Exim moves on to the next configured client
26132 authenticator. Any other expansion failure causes Exim to give up trying to
26133 send the message to the current server.
26134
26135 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26136 strings, is:
26137 .code
26138 fixed_cram:
26139   driver = cram_md5
26140   public_name = CRAM-MD5
26141   client_name = ph10
26142   client_secret = secret
26143 .endd
26144 .ecindex IIDcramauth1
26145 .ecindex IIDcramauth2
26146
26147
26148
26149 . ////////////////////////////////////////////////////////////////////////////
26150 . ////////////////////////////////////////////////////////////////////////////
26151
26152 .chapter "The cyrus_sasl authenticator" "CHID10"
26153 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26154 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26155 .cindex "Cyrus" "SASL library"
26156 .cindex "Kerberos"
26157 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26158 Digital Ltd (&url(http://www.aldigital.co.uk)).
26159
26160 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26161 library implementation of the RFC 2222 (&"Simple Authentication and Security
26162 Layer"&). This library supports a number of authentication mechanisms,
26163 including PLAIN and LOGIN, but also several others that Exim does not support
26164 directly. In particular, there is support for Kerberos authentication.
26165
26166 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26167 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26168 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26169 name of the driver to determine which mechanism to support.
26170
26171 Where access to some kind of secret file is required, for example in GSSAPI
26172 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26173 user, and that the Cyrus SASL library has no way of escalating privileges
26174 by default. You may also find you need to set environment variables,
26175 depending on the driver you are using.
26176
26177 The application name provided by Exim is &"exim"&, so various SASL options may
26178 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26179 Kerberos, note that because of limitations in the GSSAPI interface,
26180 changing the server keytab might need to be communicated down to the Kerberos
26181 layer independently. The mechanism for doing so is dependent upon the Kerberos
26182 implementation.
26183
26184 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26185 may be set to point to an alternative keytab file. Exim will pass this
26186 variable through from its own inherited environment when started as root or the
26187 Exim user. The keytab file needs to be readable by the Exim user.
26188 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26189 environment variable.  In practice, for those releases, the Cyrus authenticator
26190 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26191 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26192
26193
26194 .section "Using cyrus_sasl as a server" "SECID178"
26195 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26196 (on a successful authentication) into &$auth1$&. For compatibility with
26197 previous releases of Exim, the username is also placed in &$1$&. However, the
26198 use of this variable for this purpose is now deprecated, as it can lead to
26199 confusion in string expansions that also use numeric variables for other
26200 things.
26201
26202
26203 .option server_hostname cyrus_sasl string&!! "see below"
26204 This option selects the hostname that is used when communicating with the
26205 library. The default value is &`$primary_hostname`&. It is up to the underlying
26206 SASL plug-in what it does with this data.
26207
26208
26209 .option server_mech cyrus_sasl string "see below"
26210 This option selects the authentication mechanism this driver should use. The
26211 default is the value of the generic &%public_name%& option. This option allows
26212 you to use a different underlying mechanism from the advertised name. For
26213 example:
26214 .code
26215 sasl:
26216   driver = cyrus_sasl
26217   public_name = X-ANYTHING
26218   server_mech = CRAM-MD5
26219   server_set_id = $auth1
26220 .endd
26221
26222 .option server_realm cyrus_sasl string&!! unset
26223 This specifies the SASL realm that the server claims to be in.
26224
26225
26226 .option server_service cyrus_sasl string &`smtp`&
26227 This is the SASL service that the server claims to implement.
26228
26229
26230 For straightforward cases, you do not need to set any of the authenticator's
26231 private options. All you need to do is to specify an appropriate mechanism as
26232 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26233 PLAIN, you could have two authenticators as follows:
26234 .code
26235 sasl_cram_md5:
26236   driver = cyrus_sasl
26237   public_name = CRAM-MD5
26238   server_set_id = $auth1
26239
26240 sasl_plain:
26241   driver = cyrus_sasl
26242   public_name = PLAIN
26243   server_set_id = $auth2
26244 .endd
26245 Cyrus SASL does implement the LOGIN authentication method, even though it is
26246 not a standard method. It is disabled by default in the source distribution,
26247 but it is present in many binary distributions.
26248 .ecindex IIDcyrauth1
26249 .ecindex IIDcyrauth2
26250
26251
26252
26253
26254 . ////////////////////////////////////////////////////////////////////////////
26255 . ////////////////////////////////////////////////////////////////////////////
26256 .chapter "The dovecot authenticator" "CHAPdovecot"
26257 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26258 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26259 This authenticator is an interface to the authentication facility of the
26260 Dovecot POP/IMAP server, which can support a number of authentication methods.
26261 Note that Dovecot must be configured to use auth-client not auth-userdb.
26262 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26263 to use the same mechanisms for SMTP authentication. This is a server
26264 authenticator only. There is only one option:
26265
26266 .option server_socket dovecot string unset
26267
26268 This option must specify the socket that is the interface to Dovecot
26269 authentication. The &%public_name%& option must specify an authentication
26270 mechanism that Dovecot is configured to support. You can have several
26271 authenticators for different mechanisms. For example:
26272 .code
26273 dovecot_plain:
26274   driver = dovecot
26275   public_name = PLAIN
26276   server_socket = /var/run/dovecot/auth-client
26277   server_set_id = $auth1
26278
26279 dovecot_ntlm:
26280   driver = dovecot
26281   public_name = NTLM
26282   server_socket = /var/run/dovecot/auth-client
26283   server_set_id = $auth1
26284 .endd
26285 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26286 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26287 option is passed in the Dovecot authentication command. If, for a TLS
26288 connection, a client certificate has been verified, the &"valid-client-cert"&
26289 option is passed. When authentication succeeds, the identity of the user
26290 who authenticated is placed in &$auth1$&.
26291 .ecindex IIDdcotauth1
26292 .ecindex IIDdcotauth2
26293
26294
26295 . ////////////////////////////////////////////////////////////////////////////
26296 . ////////////////////////////////////////////////////////////////////////////
26297 .chapter "The gsasl authenticator" "CHAPgsasl"
26298 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26299 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26300 .cindex "authentication" "GNU SASL"
26301 .cindex "authentication" "SASL"
26302 .cindex "authentication" "EXTERNAL"
26303 .cindex "authentication" "ANONYMOUS"
26304 .cindex "authentication" "PLAIN"
26305 .cindex "authentication" "LOGIN"
26306 .cindex "authentication" "DIGEST-MD5"
26307 .cindex "authentication" "CRAM-MD5"
26308 .cindex "authentication" "SCRAM-SHA-1"
26309 The &(gsasl)& authenticator provides server integration for the GNU SASL
26310 library and the mechanisms it provides.  This is new as of the 4.80 release
26311 and there are a few areas where the library does not let Exim smoothly
26312 scale to handle future authentication mechanisms, so no guarantee can be
26313 made that any particular new authentication mechanism will be supported
26314 without code changes in Exim.
26315
26316
26317 .option server_channelbinding gsasl boolean false
26318 Some authentication mechanisms are able to use external context at both ends
26319 of the session to bind the authentication to that context, and fail the
26320 authentication process if that context differs.  Specifically, some TLS
26321 ciphersuites can provide identifying information about the cryptographic
26322 context.
26323
26324 This means that certificate identity and verification becomes a non-issue,
26325 as a man-in-the-middle attack will cause the correct client and server to
26326 see different identifiers and authentication will fail.
26327
26328 This is currently only supported when using the GnuTLS library.  This is
26329 only usable by mechanisms which support "channel binding"; at time of
26330 writing, that's the SCRAM family.
26331
26332 This defaults off to ensure smooth upgrade across Exim releases, in case
26333 this option causes some clients to start failing.  Some future release
26334 of Exim may switch the default to be true.
26335
26336
26337 .option server_hostname gsasl string&!! "see below"
26338 This option selects the hostname that is used when communicating with the
26339 library. The default value is &`$primary_hostname`&.
26340 Some mechanisms will use this data.
26341
26342
26343 .option server_mech gsasl string "see below"
26344 This option selects the authentication mechanism this driver should use. The
26345 default is the value of the generic &%public_name%& option. This option allows
26346 you to use a different underlying mechanism from the advertised name. For
26347 example:
26348 .code
26349 sasl:
26350   driver = gsasl
26351   public_name = X-ANYTHING
26352   server_mech = CRAM-MD5
26353   server_set_id = $auth1
26354 .endd
26355
26356
26357 .option server_password gsasl string&!! unset
26358 Various mechanisms need access to the cleartext password on the server, so
26359 that proof-of-possession can be demonstrated on the wire, without sending
26360 the password itself.
26361
26362 The data available for lookup varies per mechanism.
26363 In all cases, &$auth1$& is set to the &'authentication id'&.
26364 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26365 if available, else the empty string.
26366 The &$auth3$& variable will always be the &'realm'& if available,
26367 else the empty string.
26368
26369 A forced failure will cause authentication to defer.
26370
26371 If using this option, it may make sense to set the &%server_condition%&
26372 option to be simply "true".
26373
26374
26375 .option server_realm gsasl string&!! unset
26376 This specifies the SASL realm that the server claims to be in.
26377 Some mechanisms will use this data.
26378
26379
26380 .option server_scram_iter gsasl string&!! unset
26381 This option provides data for the SCRAM family of mechanisms.
26382 &$auth1$& is not available at evaluation time.
26383 (This may change, as we receive feedback on use)
26384
26385
26386 .option server_scram_salt gsasl string&!! unset
26387 This option provides data for the SCRAM family of mechanisms.
26388 &$auth1$& is not available at evaluation time.
26389 (This may change, as we receive feedback on use)
26390
26391
26392 .option server_service gsasl string &`smtp`&
26393 This is the SASL service that the server claims to implement.
26394 Some mechanisms will use this data.
26395
26396
26397 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26398 .vindex "&$auth1$&, &$auth2$&, etc"
26399 These may be set when evaluating specific options, as detailed above.
26400 They will also be set when evaluating &%server_condition%&.
26401
26402 Unless otherwise stated below, the &(gsasl)& integration will use the following
26403 meanings for these variables:
26404
26405 .ilist
26406 .vindex "&$auth1$&"
26407 &$auth1$&: the &'authentication id'&
26408 .next
26409 .vindex "&$auth2$&"
26410 &$auth2$&: the &'authorization id'&
26411 .next
26412 .vindex "&$auth3$&"
26413 &$auth3$&: the &'realm'&
26414 .endlist
26415
26416 On a per-mechanism basis:
26417
26418 .ilist
26419 .cindex "authentication" "EXTERNAL"
26420 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26421 the &%server_condition%& option must be present.
26422 .next
26423 .cindex "authentication" "ANONYMOUS"
26424 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26425 the &%server_condition%& option must be present.
26426 .next
26427 .cindex "authentication" "GSSAPI"
26428 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26429 &$auth2$& will be set to the &'authorization id'&,
26430 the &%server_condition%& option must be present.
26431 .endlist
26432
26433 An &'anonymous token'& is something passed along as an unauthenticated
26434 identifier; this is analogous to FTP anonymous authentication passing an
26435 email address, or software-identifier@, as the "password".
26436
26437
26438 An example showing the password having the realm specified in the callback
26439 and demonstrating a Cyrus SASL to GSASL migration approach is:
26440 .code
26441 gsasl_cyrusless_crammd5:
26442   driver = gsasl
26443   public_name = CRAM-MD5
26444   server_realm = imap.example.org
26445   server_password = ${lookup{$auth1:$auth3:userPassword}\
26446                     dbmjz{/etc/sasldb2}{$value}fail}
26447   server_set_id = ${quote:$auth1}
26448   server_condition = yes
26449 .endd
26450
26451
26452 . ////////////////////////////////////////////////////////////////////////////
26453 . ////////////////////////////////////////////////////////////////////////////
26454
26455 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26456 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26457 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26458 .cindex "authentication" "GSSAPI"
26459 .cindex "authentication" "Kerberos"
26460 The &(heimdal_gssapi)& authenticator provides server integration for the
26461 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26462 reliably.
26463
26464 .option server_hostname heimdal_gssapi string&!! "see below"
26465 This option selects the hostname that is used, with &%server_service%&,
26466 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26467 identifier.  The default value is &`$primary_hostname`&.
26468
26469 .option server_keytab heimdal_gssapi string&!! unset
26470 If set, then Heimdal will not use the system default keytab (typically
26471 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26472 The value should be a pathname, with no &"file:"& prefix.
26473
26474 .option server_service heimdal_gssapi string&!! "smtp"
26475 This option specifies the service identifier used, in conjunction with
26476 &%server_hostname%&, for building the identifier for finding credentials
26477 from the keytab.
26478
26479
26480 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26481 Beware that these variables will typically include a realm, thus will appear
26482 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26483 not verified, so a malicious client can set it to anything.
26484
26485 The &$auth1$& field should be safely trustable as a value from the Key
26486 Distribution Center.  Note that these are not quite email addresses.
26487 Each identifier is for a role, and so the left-hand-side may include a
26488 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26489
26490 .vindex "&$auth1$&, &$auth2$&, etc"
26491 .ilist
26492 .vindex "&$auth1$&"
26493 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26494 .next
26495 .vindex "&$auth2$&"
26496 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26497 authentication.  If that was empty, this will also be set to the
26498 GSS Display Name.
26499 .endlist
26500
26501
26502 . ////////////////////////////////////////////////////////////////////////////
26503 . ////////////////////////////////////////////////////////////////////////////
26504
26505 .chapter "The spa authenticator" "CHAPspa"
26506 .scindex IIDspaauth1 "&(spa)& authenticator"
26507 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26508 .cindex "authentication" "Microsoft Secure Password"
26509 .cindex "authentication" "NTLM"
26510 .cindex "Microsoft Secure Password Authentication"
26511 .cindex "NTLM authentication"
26512 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26513 Password Authentication'& mechanism,
26514 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26515 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26516 taken from the Samba project (&url(http://www.samba.org)). The code for the
26517 server side was subsequently contributed by Tom Kistner. The mechanism works as
26518 follows:
26519
26520 .ilist
26521 After the AUTH command has been accepted, the client sends an SPA
26522 authentication request based on the user name and optional domain.
26523 .next
26524 The server sends back a challenge.
26525 .next
26526 The client builds a challenge response which makes use of the user's password
26527 and sends it to the server, which then accepts or rejects it.
26528 .endlist
26529
26530 Encryption is used to protect the password in transit.
26531
26532
26533
26534 .section "Using spa as a server" "SECID179"
26535 .cindex "options" "&(spa)& authenticator (server)"
26536 The &(spa)& authenticator has just one server option:
26537
26538 .option server_password spa string&!! unset
26539 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26540 This option is expanded, and the result must be the cleartext password for the
26541 authenticating user, whose name is at this point in &$auth1$&. For
26542 compatibility with previous releases of Exim, the user name is also placed in
26543 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26544 it can lead to confusion in string expansions that also use numeric variables
26545 for other things. For example:
26546 .code
26547 spa:
26548   driver = spa
26549   public_name = NTLM
26550   server_password = \
26551     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26552 .endd
26553 If the expansion is forced to fail, authentication fails. Any other expansion
26554 failure causes a temporary error code to be returned.
26555
26556
26557
26558
26559
26560 .section "Using spa as a client" "SECID180"
26561 .cindex "options" "&(spa)& authenticator (client)"
26562 The &(spa)& authenticator has the following client options:
26563
26564
26565
26566 .option client_domain spa string&!! unset
26567 This option specifies an optional domain for the authentication.
26568
26569
26570 .option client_password spa string&!! unset
26571 This option specifies the user's password, and must be set.
26572
26573
26574 .option client_username spa string&!! unset
26575 This option specifies the user name, and must be set. Here is an example of a
26576 configuration of this authenticator for use with the mail servers at
26577 &'msn.com'&:
26578 .code
26579 msn:
26580   driver = spa
26581   public_name = MSN
26582   client_username = msn/msn_username
26583   client_password = msn_plaintext_password
26584   client_domain = DOMAIN_OR_UNSET
26585 .endd
26586 .ecindex IIDspaauth1
26587 .ecindex IIDspaauth2
26588
26589
26590
26591
26592
26593 . ////////////////////////////////////////////////////////////////////////////
26594 . ////////////////////////////////////////////////////////////////////////////
26595
26596 .chapter "The tls authenticator" "CHAPtlsauth"
26597 .scindex IIDtlsauth1 "&(tls)& authenticator"
26598 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26599 .cindex "authentication" "Client Certificate"
26600 .cindex "authentication" "X509"
26601 .cindex "Certificate-based authentication"
26602 The &(tls)& authenticator provides server support for
26603 authentication based on client certificates.
26604
26605 It is not an SMTP authentication mechanism and is not
26606 advertised by the server as part of the SMTP EHLO response.
26607 It is an Exim authenticator in the sense that it affects
26608 the protocol element of the log line, can be tested for
26609 by the &%authenticated%& ACL condition, and can set
26610 the &$authenticated_id$& variable.
26611
26612 The client must present a verifiable certificate,
26613 for which it must have been requested via the
26614 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26615 (see &<<CHAPTLS>>&).
26616
26617 If an authenticator of this type is configured it is
26618 run before any SMTP-level communication is done,
26619 and can authenticate the connection.
26620 If it does, SMTP authentication is not offered.
26621
26622 A maximum of one authenticator of this type may be present.
26623
26624
26625 .cindex "options" "&(tls)& authenticator (server)"
26626 The &(tls)& authenticator has three server options:
26627
26628 .option server_param1 tls string&!! unset
26629 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26630 This option is expanded after the TLS negotiation and
26631 the result is placed in &$auth1$&.
26632 If the expansion is forced to fail, authentication fails. Any other expansion
26633 failure causes a temporary error code to be returned.
26634
26635 .option server_param2 tls string&!! unset
26636 .option server_param3 tls string&!! unset
26637 As above, for &$auth2$& and &$auth3$&.
26638
26639 &%server_param1%& may also be spelled &%server_param%&.
26640
26641
26642 Example:
26643 .code
26644 tls:
26645   driver = tls
26646   server_param1 =     ${certextract {subj_altname,mail,>:} \
26647                                     {$tls_in_peercert}}
26648   server_condition =  ${if forany {$auth1} \
26649                             {!= {0} \
26650                                 {${lookup ldap{ldap:///\
26651                          mailname=${quote_ldap_dn:${lc:$item}},\
26652                          ou=users,LDAP_DC?mailid} {$value}{0} \
26653                        }    }   } }
26654   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26655 .endd
26656 This accepts a client certificate that is verifiable against any
26657 of your configured trust-anchors
26658 which usually means the full set of public CAs)
26659 and which has a SAN with a good account name.
26660 Note that the client cert is on the wire in-clear, including the SAN,
26661 whereas a plaintext SMTP AUTH done inside TLS is not.
26662
26663 . An alternative might use
26664 . .code
26665 .   server_param1 = ${sha256:$tls_in_peercert}
26666 . .endd
26667 . to require one of a set of specific certs that define a given account
26668 . (the verification is still required, but mostly irrelevant).
26669 . This would help for per-device use.
26670 .
26671 . However, for the future we really need support for checking a
26672 . user cert in LDAP - which probably wants a base-64 DER.
26673
26674 .ecindex IIDtlsauth1
26675 .ecindex IIDtlsauth2
26676
26677
26678 Note that because authentication is traditionally an SMTP operation,
26679 the &%authenticated%& ACL condition cannot be used in
26680 a connect- or helo-ACL.
26681
26682
26683
26684 . ////////////////////////////////////////////////////////////////////////////
26685 . ////////////////////////////////////////////////////////////////////////////
26686
26687 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26688          "Encrypted SMTP connections"
26689 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26690 .scindex IIDencsmtp2 "SMTP" "encryption"
26691 .cindex "TLS" "on SMTP connection"
26692 .cindex "OpenSSL"
26693 .cindex "GnuTLS"
26694 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26695 Sockets Layer), is implemented by making use of the OpenSSL library or the
26696 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26697 cryptographic code in the Exim distribution itself for implementing TLS. In
26698 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26699 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26700 You also need to understand the basic concepts of encryption at a managerial
26701 level, and in particular, the way that public keys, private keys, and
26702 certificates are used.
26703
26704 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26705 connection is established, the client issues a STARTTLS command. If the
26706 server accepts this, the client and the server negotiate an encryption
26707 mechanism. If the negotiation succeeds, the data that subsequently passes
26708 between them is encrypted.
26709
26710 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26711 and if so, what cipher suite is in use, whether the client supplied a
26712 certificate, and whether or not that certificate was verified. This makes it
26713 possible for an Exim server to deny or accept certain commands based on the
26714 encryption state.
26715
26716 &*Warning*&: Certain types of firewall and certain anti-virus products can
26717 disrupt TLS connections. You need to turn off SMTP scanning for these products
26718 in order to get TLS to work.
26719
26720
26721
26722 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26723          "SECID284"
26724 .cindex "ssmtp protocol"
26725 .cindex "smtps protocol"
26726 .cindex "SMTP" "ssmtp protocol"
26727 .cindex "SMTP" "smtps protocol"
26728 Early implementations of encrypted SMTP used a different TCP port from normal
26729 SMTP, and expected an encryption negotiation to start immediately, instead of
26730 waiting for a STARTTLS command from the client using the standard SMTP
26731 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26732 allocated for this purpose.
26733
26734 This approach was abandoned when encrypted SMTP was standardized, but there are
26735 still some legacy clients that use it. Exim supports these clients by means of
26736 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26737 numbers; the most common use is expected to be:
26738 .code
26739 tls_on_connect_ports = 465
26740 .endd
26741 The port numbers specified by this option apply to all SMTP connections, both
26742 via the daemon and via &'inetd'&. You still need to specify all the ports that
26743 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26744 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26745 an extra port &-- rather, it specifies different behaviour on a port that is
26746 defined elsewhere.
26747
26748 There is also a &%-tls-on-connect%& command line option. This overrides
26749 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26750
26751
26752
26753
26754
26755
26756 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26757 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26758 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26759 followed later, when the first versions of GnuTLS were released. To build Exim
26760 to use GnuTLS, you need to set
26761 .code
26762 USE_GNUTLS=yes
26763 .endd
26764 in Local/Makefile, in addition to
26765 .code
26766 SUPPORT_TLS=yes
26767 .endd
26768 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26769 include files and libraries for GnuTLS can be found.
26770
26771 There are some differences in usage when using GnuTLS instead of OpenSSL:
26772
26773 .ilist
26774 The &%tls_verify_certificates%& option
26775 cannot be the path of a directory
26776 for GnuTLS versions before 3.3.6
26777 (for later versions, or OpenSSL, it can be either).
26778 .next
26779 The default value for &%tls_dhparam%& differs for historical reasons.
26780 .next
26781 .vindex "&$tls_in_peerdn$&"
26782 .vindex "&$tls_out_peerdn$&"
26783 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26784 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26785 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26786 .next
26787 OpenSSL identifies cipher suites using hyphens as separators, for example:
26788 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26789 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26790 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26791 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26792 to handle its own older variants) when processing lists of cipher suites in the
26793 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26794 option).
26795 .next
26796 The &%tls_require_ciphers%& options operate differently, as described in the
26797 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26798 .next
26799 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26800 When using OpenSSL, this option is ignored.
26801 (If an API is found to let OpenSSL be configured in this way,
26802 let the Exim Maintainers know and we'll likely use it).
26803 .next
26804 Some other recently added features may only be available in one or the other.
26805 This should be documented with the feature.  If the documentation does not
26806 explicitly state that the feature is infeasible in the other TLS
26807 implementation, then patches are welcome.
26808 .endlist
26809
26810
26811 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26812 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26813 an explicit path; if the latter, then the text about generation still applies,
26814 but not the chosen filename.
26815 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26816 See the documentation of &%tls_dhparam%& for more information.
26817
26818 GnuTLS uses D-H parameters that may take a substantial amount of time
26819 to compute. It is unreasonable to re-compute them for every TLS session.
26820 Therefore, Exim keeps this data in a file in its spool directory, called
26821 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26822 of bits requested.
26823 The file is owned by the Exim user and is readable only by
26824 its owner. Every Exim process that start up GnuTLS reads the D-H
26825 parameters from this file. If the file does not exist, the first Exim process
26826 that needs it computes the data and writes it to a temporary file which is
26827 renamed once it is complete. It does not matter if several Exim processes do
26828 this simultaneously (apart from wasting a few resources). Once a file is in
26829 place, new Exim processes immediately start using it.
26830
26831 For maximum security, the parameters that are stored in this file should be
26832 recalculated periodically, the frequency depending on your paranoia level.
26833 If you are avoiding using the fixed D-H primes published in RFCs, then you
26834 are concerned about some advanced attacks and will wish to do this; if you do
26835 not regenerate then you might as well stick to the standard primes.
26836
26837 Arranging this is easy in principle; just delete the file when you want new
26838 values to be computed. However, there may be a problem. The calculation of new
26839 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26840 If the system is not very active, &_/dev/random_& may delay returning data
26841 until enough randomness (entropy) is available. This may cause Exim to hang for
26842 a substantial amount of time, causing timeouts on incoming connections.
26843
26844 The solution is to generate the parameters externally to Exim. They are stored
26845 in &_gnutls-params-N_& in PEM format, which means that they can be
26846 generated externally using the &(certtool)& command that is part of GnuTLS.
26847
26848 To replace the parameters with new ones, instead of deleting the file
26849 and letting Exim re-create it, you can generate new parameters using
26850 &(certtool)& and, when this has been done, replace Exim's cache file by
26851 renaming. The relevant commands are something like this:
26852 .code
26853 # ls
26854 [ look for file; assume gnutls-params-2236 is the most recent ]
26855 # rm -f new-params
26856 # touch new-params
26857 # chown exim:exim new-params
26858 # chmod 0600 new-params
26859 # certtool --generate-dh-params --bits 2236 >>new-params
26860 # openssl dhparam -noout -text -in new-params | head
26861 [ check the first line, make sure it's not more than 2236;
26862   if it is, then go back to the start ("rm") and repeat
26863   until the size generated is at most the size requested ]
26864 # chmod 0400 new-params
26865 # mv new-params gnutls-params-2236
26866 .endd
26867 If Exim never has to generate the parameters itself, the possibility of
26868 stalling is removed.
26869
26870 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26871 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26872 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26873 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26874 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26875 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26876 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26877 which applies to all D-H usage, client or server.  If the value returned by
26878 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26879 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26880 limit, which is still much higher than Exim historically used.
26881
26882 The filename and bits used will change as the GnuTLS maintainers change the
26883 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26884 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26885 2432 bits, while NSS is limited to 2236 bits.
26886
26887 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26888 increase the chance of the generated prime actually being within acceptable
26889 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26890 procedure above.  There is no sane procedure available to Exim to double-check
26891 the size of the generated prime, so it might still be too large.
26892
26893
26894 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26895 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26896 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26897 There is a function in the OpenSSL library that can be passed a list of cipher
26898 suites before the cipher negotiation takes place. This specifies which ciphers
26899 are acceptable. The list is colon separated and may contain names like
26900 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26901 directly to this function call.
26902 Many systems will install the OpenSSL manual-pages, so you may have
26903 &'ciphers(1)'& available to you.
26904 The following quotation from the OpenSSL
26905 documentation specifies what forms of item are allowed in the cipher string:
26906
26907 .ilist
26908 It can consist of a single cipher suite such as RC4-SHA.
26909 .next
26910 It can represent a list of cipher suites containing a certain algorithm,
26911 or cipher suites of a certain type. For example SHA1 represents all
26912 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26913 SSL v3 algorithms.
26914 .next
26915 Lists of cipher suites can be combined in a single cipher string using
26916 the + character. This is used as a logical and operation. For example
26917 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26918 algorithms.
26919 .endlist
26920
26921 Each cipher string can be optionally preceded by one of the characters &`!`&,
26922 &`-`& or &`+`&.
26923 .ilist
26924 If &`!`& is used, the ciphers are permanently deleted from the list. The
26925 ciphers deleted can never reappear in the list even if they are explicitly
26926 stated.
26927 .next
26928 If &`-`& is used, the ciphers are deleted from the list, but some or all
26929 of the ciphers can be added again by later options.
26930 .next
26931 If &`+`& is used, the ciphers are moved to the end of the list. This
26932 option does not add any new ciphers; it just moves matching existing ones.
26933 .endlist
26934
26935 If none of these characters is present, the string is interpreted as
26936 a list of ciphers to be appended to the current preference list. If the list
26937 includes any ciphers already present they will be ignored: that is, they will
26938 not be moved to the end of the list.
26939 .endlist
26940
26941 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26942 string:
26943 .code
26944 # note single-quotes to get ! past any shell history expansion
26945 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26946 .endd
26947
26948 This example will let the library defaults be permitted on the MX port, where
26949 there's probably no identity verification anyway, but ups the ante on the
26950 submission ports where the administrator might have some influence on the
26951 choice of clients used:
26952 .code
26953 # OpenSSL variant; see man ciphers(1)
26954 tls_require_ciphers = ${if =={$received_port}{25}\
26955                            {DEFAULT}\
26956                            {HIGH:!MD5:!SHA1}}
26957 .endd
26958
26959
26960
26961 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26962          "SECTreqciphgnu"
26963 .cindex "GnuTLS" "specifying parameters for"
26964 .cindex "TLS" "specifying ciphers (GnuTLS)"
26965 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26966 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26967 .cindex "TLS" "specifying protocols (GnuTLS)"
26968 .cindex "TLS" "specifying priority string (GnuTLS)"
26969 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26970 The GnuTLS library allows the caller to provide a "priority string", documented
26971 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26972 ciphersuite specification in OpenSSL.
26973
26974 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26975 and controls both protocols and ciphers.
26976
26977 The &%tls_require_ciphers%& option is available both as an global option,
26978 controlling how Exim behaves as a server, and also as an option of the
26979 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26980 the value is string expanded.  The resulting string is not an Exim list and
26981 the string is given to the GnuTLS library, so that Exim does not need to be
26982 aware of future feature enhancements of GnuTLS.
26983
26984 Documentation of the strings accepted may be found in the GnuTLS manual, under
26985 "Priority strings".  This is online as
26986 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26987 but beware that this relates to GnuTLS 3, which may be newer than the version
26988 installed on your system.  If you are using GnuTLS 3,
26989 then the example code
26990 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
26991 on that site can be used to test a given string.
26992
26993 For example:
26994 .code
26995 # Disable older versions of protocols
26996 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26997 .endd
26998
26999 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27000 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27001 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27002
27003 This example will let the library defaults be permitted on the MX port, where
27004 there's probably no identity verification anyway, and lowers security further
27005 by increasing compatibility; but this ups the ante on the submission ports
27006 where the administrator might have some influence on the choice of clients
27007 used:
27008 .code
27009 # GnuTLS variant
27010 tls_require_ciphers = ${if =={$received_port}{25}\
27011                            {NORMAL:%COMPAT}\
27012                            {SECURE128}}
27013 .endd
27014
27015
27016 .section "Configuring an Exim server to use TLS" "SECID182"
27017 .cindex "TLS" "configuring an Exim server"
27018 When Exim has been built with TLS support, it advertises the availability of
27019 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27020 but not to any others. The default value of this option is unset, which means
27021 that STARTTLS is not advertised at all. This default is chosen because you
27022 need to set some other options in order to make TLS available, and also it is
27023 sensible for systems that want to use TLS only as a client.
27024
27025 If a client issues a STARTTLS command and there is some configuration
27026 problem in the server, the command is rejected with a 454 error. If the client
27027 persists in trying to issue SMTP commands, all except QUIT are rejected
27028 with the error
27029 .code
27030 554 Security failure
27031 .endd
27032 If a STARTTLS command is issued within an existing TLS session, it is
27033 rejected with a 554 error code.
27034
27035 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27036 must be set to match some hosts. The default is * which matches all hosts.
27037
27038 .new
27039 If this is all you do, TLS encryption will be enabled but not authentication -
27040 meaning that the peer has no assurance it is actually you he is talking to.
27041 You gain protection from a passive sniffer listening on the wire but not
27042 from someone able to intercept the communication.
27043 .wen
27044
27045 Further protection requires some further configuration at the server end.
27046
27047 It is rumoured that all existing clients that support TLS/SSL use RSA
27048 encryption. To make this work you need to set, in the server,
27049 .code
27050 tls_certificate = /some/file/name
27051 tls_privatekey = /some/file/name
27052 .endd
27053 These options are, in fact, expanded strings, so you can make them depend on
27054 the identity of the client that is connected if you wish. The first file
27055 contains the server's X509 certificate, and the second contains the private key
27056 that goes with it. These files need to be
27057 PEM format and readable by the Exim user, and must
27058 always be given as full path names.
27059 The key must not be password-protected.
27060 They can be the same file if both the
27061 certificate and the key are contained within it. If &%tls_privatekey%& is not
27062 set, or if its expansion is forced to fail or results in an empty string, this
27063 is assumed to be the case. The certificate file may also contain intermediate
27064 certificates that need to be sent to the client to enable it to authenticate
27065 the server's certificate.
27066
27067 If you do not understand about certificates and keys, please try to find a
27068 source of this background information, which is not Exim-specific. (There are a
27069 few comments below in section &<<SECTcerandall>>&.)
27070
27071 &*Note*&: These options do not apply when Exim is operating as a client &--
27072 they apply only in the case of a server. If you need to use a certificate in an
27073 Exim client, you must set the options of the same names in an &(smtp)&
27074 transport.
27075
27076 With just these options, an Exim server will be able to use TLS. It does not
27077 require the client to have a certificate (but see below for how to insist on
27078 this). There is one other option that may be needed in other situations. If
27079 .code
27080 tls_dhparam = /some/file/name
27081 .endd
27082 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27083 with the parameters contained in the file.
27084 Set this to &`none`& to disable use of DH entirely, by making no prime
27085 available:
27086 .code
27087 tls_dhparam = none
27088 .endd
27089 This may also be set to a string identifying a standard prime to be used for
27090 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27091 used is &`ike23`&.  There are a few standard primes available, see the
27092 documentation for &%tls_dhparam%& for the complete list.
27093
27094 See the command
27095 .code
27096 openssl dhparam
27097 .endd
27098 for a way of generating file data.
27099
27100 The strings supplied for these three options are expanded every time a client
27101 host connects. It is therefore possible to use different certificates and keys
27102 for different hosts, if you so wish, by making use of the client's IP address
27103 in &$sender_host_address$& to control the expansion. If a string expansion is
27104 forced to fail, Exim behaves as if the option is not set.
27105
27106 .cindex "cipher" "logging"
27107 .cindex "log" "TLS cipher"
27108 .vindex "&$tls_in_cipher$&"
27109 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27110 an incoming TLS connection. It is included in the &'Received:'& header of an
27111 incoming message (by default &-- you can, of course, change this), and it is
27112 also included in the log line that records a message's arrival, keyed by
27113 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27114 condition can be used to test for specific cipher suites in ACLs.
27115
27116 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27117 can check the name of the cipher suite and vary their actions accordingly. The
27118 cipher suite names vary, depending on which TLS library is being used. For
27119 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27120 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27121 documentation for more details.
27122
27123 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27124 (again depending on the &%tls_cipher%& log selector).
27125
27126
27127 .section "Requesting and verifying client certificates" "SECID183"
27128 .cindex "certificate" "verification of client"
27129 .cindex "TLS" "client certificate verification"
27130 If you want an Exim server to request a certificate when negotiating a TLS
27131 session with a client, you must set either &%tls_verify_hosts%& or
27132 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27133 apply to all TLS connections. For any host that matches one of these options,
27134 Exim requests a certificate as part of the setup of the TLS session. The
27135 contents of the certificate are verified by comparing it with a list of
27136 expected certificates.
27137 These may be the system default set (depending on library version),
27138 an explicit file or,
27139 depending on library version, a directory, identified by
27140 &%tls_verify_certificates%&.
27141
27142 A file can contain multiple certificates, concatenated end to end. If a
27143 directory is used
27144 (OpenSSL only),
27145 each certificate must be in a separate file, with a name (or a symbolic link)
27146 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27147 certificate. You can compute the relevant hash by running the command
27148 .code
27149 openssl x509 -hash -noout -in /cert/file
27150 .endd
27151 where &_/cert/file_& contains a single certificate.
27152
27153 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27154 what happens if the client does not supply a certificate, or if the certificate
27155 does not match any of the certificates in the collection named by
27156 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27157 attempt to set up a TLS session is aborted, and the incoming connection is
27158 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27159 session continues. ACLs that run for subsequent SMTP commands can detect the
27160 fact that no certificate was verified, and vary their actions accordingly. For
27161 example, you can insist on a certificate before accepting a message for
27162 relaying, but not when the message is destined for local delivery.
27163
27164 .vindex "&$tls_in_peerdn$&"
27165 When a client supplies a certificate (whether it verifies or not), the value of
27166 the Distinguished Name of the certificate is made available in the variable
27167 &$tls_in_peerdn$& during subsequent processing of the message.
27168
27169 .cindex "log" "distinguished name"
27170 Because it is often a long text string, it is not included in the log line or
27171 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27172 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27173 &%received_header_text%& to change the &'Received:'& header. When no
27174 certificate is supplied, &$tls_in_peerdn$& is empty.
27175
27176
27177 .section "Revoked certificates" "SECID184"
27178 .cindex "TLS" "revoked certificates"
27179 .cindex "revocation list"
27180 .cindex "certificate" "revocation list"
27181 .cindex "OCSP" "stapling"
27182 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27183 certificates are revoked. If you have such a list, you can pass it to an Exim
27184 server using the global option called &%tls_crl%& and to an Exim client using
27185 an identically named option for the &(smtp)& transport. In each case, the value
27186 of the option is expanded and must then be the name of a file that contains a
27187 CRL in PEM format.
27188 The downside is that clients have to periodically re-download a potentially huge
27189 file from every certificate authority they know of.
27190
27191 The way with most moving parts at query time is Online Certificate
27192 Status Protocol (OCSP), where the client verifies the certificate
27193 against an OCSP server run by the CA.  This lets the CA track all
27194 usage of the certs.  It requires running software with access to the
27195 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27196 is based on HTTP and can be proxied accordingly.
27197
27198 The only widespread OCSP server implementation (known to this writer)
27199 comes as part of OpenSSL and aborts on an invalid request, such as
27200 connecting to the port and then disconnecting.  This requires
27201 re-entering the passphrase each time some random client does this.
27202
27203 The third way is OCSP Stapling; in this, the server using a certificate
27204 issued by the CA periodically requests an OCSP proof of validity from
27205 the OCSP server, then serves it up inline as part of the TLS
27206 negotiation.   This approach adds no extra round trips, does not let the
27207 CA track users, scales well with number of certs issued by the CA and is
27208 resilient to temporary OCSP server failures, as long as the server
27209 starts retrying to fetch an OCSP proof some time before its current
27210 proof expires.  The downside is that it requires server support.
27211
27212 Unless Exim is built with the support disabled,
27213 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27214 support for OCSP stapling is included.
27215
27216 There is a global option called &%tls_ocsp_file%&.
27217 The file specified therein is expected to be in DER format, and contain
27218 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27219 option will be re-expanded for SNI, if the &%tls_certificate%& option
27220 contains &`tls_in_sni`&, as per other TLS options.
27221
27222 Exim does not at this time implement any support for fetching a new OCSP
27223 proof.  The burden is on the administrator to handle this, outside of
27224 Exim.  The file specified should be replaced atomically, so that the
27225 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27226 on each connection, so a new file will be handled transparently on the
27227 next connection.
27228
27229 When built with OpenSSL Exim will check for a valid next update timestamp
27230 in the OCSP proof; if not present, or if the proof has expired, it will be
27231 ignored.
27232
27233 For the client to be able to verify the stapled OCSP the server must
27234 also supply, in its stapled information, any intermediate
27235 certificates for the chain leading to the OCSP proof from the signer
27236 of the server certificate.  There may be zero or one such. These
27237 intermediate certificates should be added to the server OCSP stapling
27238 file named by &%tls_ocsp_file%&.
27239
27240 Note that the proof only covers the terminal server certificate,
27241 not any of the chain from CA to it.
27242
27243 There is no current way to staple a proof for a client certificate.
27244
27245 .code
27246   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27247   OCSP server is supplied.  The server URL may be included in the
27248   server certificate, if the CA is helpful.
27249
27250   One failure mode seen was the OCSP Signer cert expiring before the end
27251   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27252   noted this as invalid overall, but the re-fetch script did not.
27253 .endd
27254
27255
27256
27257
27258 .section "Configuring an Exim client to use TLS" "SECID185"
27259 .cindex "cipher" "logging"
27260 .cindex "log" "TLS cipher"
27261 .cindex "log" "distinguished name"
27262 .cindex "TLS" "configuring an Exim client"
27263 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27264 deliveries as well as to incoming, the latter one causing logging of the
27265 server certificate's DN. The remaining client configuration for TLS is all
27266 within the &(smtp)& transport.
27267
27268 It is not necessary to set any options to have TLS work in the &(smtp)&
27269 transport. If Exim is built with TLS support, and TLS is advertised by a
27270 server, the &(smtp)& transport always tries to start a TLS session. However,
27271 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27272 transport) to a list of server hosts for which TLS should not be used.
27273
27274 If you do not want Exim to attempt to send messages unencrypted when an attempt
27275 to set up an encrypted connection fails in any way, you can set
27276 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27277 those hosts, delivery is always deferred if an encrypted connection cannot be
27278 set up. If there are any other hosts for the address, they are tried in the
27279 usual way.
27280
27281 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27282 the message unencrypted. It always does this if the response to STARTTLS is
27283 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27284 session after a success response code, what happens is controlled by the
27285 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27286 delivery to this host is deferred, and other hosts (if available) are tried. If
27287 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27288 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27289 negotiation fails, Exim closes the current connection (because it is in an
27290 unknown state), opens a new one to the same host, and then tries the delivery
27291 unencrypted.
27292
27293 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27294 transport provide the client with a certificate, which is passed to the server
27295 if it requests it. If the server is Exim, it will request a certificate only if
27296 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27297
27298 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27299 specifies a collection of expected server certificates.
27300 These may be the system default set (depending on library version),
27301 a file or,
27302 depending on library version, a directory,
27303 must name a file or,
27304 for OpenSSL only (not GnuTLS), a directory.
27305 The client verifies the server's certificate
27306 against this collection, taking into account any revoked certificates that are
27307 in the list defined by &%tls_crl%&.
27308 Failure to verify fails the TLS connection unless either of the
27309 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27310
27311 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27312 certificate verification to the listed servers.  Verification either must
27313 or need not succeed respectively.
27314
27315 The &(smtp)& transport has two OCSP-related options:
27316 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27317 is requested and required for the connection to proceed.  The default
27318 value is empty.
27319 &%hosts_request_ocsp%&; a host-list for which (additionally)
27320 a Certificate Status is requested (but not necessarily verified).  The default
27321 value is "*" meaning that requests are made unless configured
27322 otherwise.
27323
27324 The host(s) should also be in &%hosts_require_tls%&, and
27325 &%tls_verify_certificates%& configured for the transport,
27326 for OCSP to be relevant.
27327
27328 If
27329 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27330 list of permitted cipher suites. If either of these checks fails, delivery to
27331 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27332 alternative hosts, if any.
27333
27334  &*Note*&:
27335 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27336 is operating as a client. Exim does not assume that a server certificate (set
27337 by the global options of the same name) should also be used when operating as a
27338 client.
27339
27340 .vindex "&$host$&"
27341 .vindex "&$host_address$&"
27342 All the TLS options in the &(smtp)& transport are expanded before use, with
27343 &$host$& and &$host_address$& containing the name and address of the server to
27344 which the client is connected. Forced failure of an expansion causes Exim to
27345 behave as if the relevant option were unset.
27346
27347 .vindex &$tls_out_bits$&
27348 .vindex &$tls_out_cipher$&
27349 .vindex &$tls_out_peerdn$&
27350 .vindex &$tls_out_sni$&
27351 Before an SMTP connection is established, the
27352 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27353 variables are emptied. (Until the first connection, they contain the values
27354 that were set when the message was received.) If STARTTLS is subsequently
27355 successfully obeyed, these variables are set to the relevant values for the
27356 outgoing connection.
27357
27358
27359
27360 .section "Use of TLS Server Name Indication" "SECTtlssni"
27361 .cindex "TLS" "Server Name Indication"
27362 .vindex "&$tls_in_sni$&"
27363 .oindex "&%tls_in_sni%&"
27364 With TLS1.0 or above, there is an extension mechanism by which extra
27365 information can be included at various points in the protocol.  One of these
27366 extensions, documented in RFC 6066 (and before that RFC 4366) is
27367 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27368 client in the initial handshake, so that the server can examine the servername
27369 within and possibly choose to use different certificates and keys (and more)
27370 for this session.
27371
27372 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27373 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27374 address.
27375
27376 With SMTP to MX, there are the same problems here as in choosing the identity
27377 against which to validate a certificate: you can't rely on insecure DNS to
27378 provide the identity which you then cryptographically verify.  So this will
27379 be of limited use in that environment.
27380
27381 With SMTP to Submission, there is a well-defined hostname which clients are
27382 connecting to and can validate certificates against.  Thus clients &*can*&
27383 choose to include this information in the TLS negotiation.  If this becomes
27384 wide-spread, then hosters can choose to present different certificates to
27385 different clients.  Or even negotiate different cipher suites.
27386
27387 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27388 if not empty, will be sent on a TLS session as part of the handshake.  There's
27389 nothing more to it.  Choosing a sensible value not derived insecurely is the
27390 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27391 for the lifetime of the client connection (including during authentication).
27392
27393 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27394 received from a client.
27395 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27396
27397 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27398 option (prior to expansion) then the following options will be re-expanded
27399 during TLS session handshake, to permit alternative values to be chosen:
27400
27401 .ilist
27402 .vindex "&%tls_certificate%&"
27403 &%tls_certificate%&
27404 .next
27405 .vindex "&%tls_crl%&"
27406 &%tls_crl%&
27407 .next
27408 .vindex "&%tls_privatekey%&"
27409 &%tls_privatekey%&
27410 .next
27411 .vindex "&%tls_verify_certificates%&"
27412 &%tls_verify_certificates%&
27413 .next
27414 .vindex "&%tls_ocsp_file%&"
27415 &%tls_ocsp_file%&
27416 .endlist
27417
27418 Great care should be taken to deal with matters of case, various injection
27419 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27420 can always be referenced; it is important to remember that &$tls_sni$& is
27421 arbitrary unverified data provided prior to authentication.
27422
27423 The Exim developers are proceeding cautiously and so far no other TLS options
27424 are re-expanded.
27425
27426 When Exim is built against OpenSSL, OpenSSL must have been built with support
27427 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27428 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27429 see &`-servername`& in the output, then OpenSSL has support.
27430
27431 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27432 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27433 built, then you have SNI support).
27434
27435
27436
27437 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27438          "SECTmulmessam"
27439 .cindex "multiple SMTP deliveries with TLS"
27440 .cindex "TLS" "multiple message deliveries"
27441 Exim sends multiple messages down the same TCP/IP connection by starting up
27442 an entirely new delivery process for each message, passing the socket from
27443 one process to the next. This implementation does not fit well with the use
27444 of TLS, because there is quite a lot of state information associated with a TLS
27445 connection, not just a socket identification. Passing all the state information
27446 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27447 session before passing the socket to a new process. The new process may then
27448 try to start a new TLS session, and if successful, may try to re-authenticate
27449 if AUTH is in use, before sending the next message.
27450
27451 The RFC is not clear as to whether or not an SMTP session continues in clear
27452 after TLS has been shut down, or whether TLS may be restarted again later, as
27453 just described. However, if the server is Exim, this shutdown and
27454 reinitialization works. It is not known which (if any) other servers operate
27455 successfully if the client closes a TLS session and continues with unencrypted
27456 SMTP, but there are certainly some that do not work. For such servers, Exim
27457 should not pass the socket to another process, because the failure of the
27458 subsequent attempt to use it would cause Exim to record a temporary host error,
27459 and delay other deliveries to that host.
27460
27461 To test for this case, Exim sends an EHLO command to the server after
27462 closing down the TLS session. If this fails in any way, the connection is
27463 closed instead of being passed to a new delivery process, but no retry
27464 information is recorded.
27465
27466 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27467 &(smtp)& transport to match those hosts for which Exim should not pass
27468 connections to new processes if TLS has been used.
27469
27470
27471
27472
27473 .section "Certificates and all that" "SECTcerandall"
27474 .cindex "certificate" "references to discussion"
27475 In order to understand fully how TLS works, you need to know about
27476 certificates, certificate signing, and certificate authorities. This is not the
27477 place to give a tutorial, especially as I do not know very much about it
27478 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27479 to Apache, currently at
27480 .display
27481 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27482 .endd
27483 Other parts of the &'modssl'& documentation are also helpful, and have
27484 links to further files.
27485 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27486 0-201-61598-3), contains both introductory and more in-depth descriptions.
27487 Some sample programs taken from the book are available from
27488 .display
27489 &url(http://www.rtfm.com/openssl-examples/)
27490 .endd
27491
27492
27493 .section "Certificate chains" "SECID186"
27494 The file named by &%tls_certificate%& may contain more than one
27495 certificate. This is useful in the case where the certificate that is being
27496 sent is validated by an intermediate certificate which the other end does
27497 not have. Multiple certificates must be in the correct order in the file.
27498 First the host's certificate itself, then the first intermediate
27499 certificate to validate the issuer of the host certificate, then the next
27500 intermediate certificate to validate the issuer of the first intermediate
27501 certificate, and so on, until finally (optionally) the root certificate.
27502 The root certificate must already be trusted by the recipient for
27503 validation to succeed, of course, but if it's not preinstalled, sending the
27504 root certificate along with the rest makes it available for the user to
27505 install if the receiving end is a client MUA that can interact with a user.
27506
27507 Note that certificates using MD5 are unlikely to work on today's Internet;
27508 even if your libraries allow loading them for use in Exim when acting as a
27509 server, increasingly clients will not accept such certificates.  The error
27510 diagnostics in such a case can be frustratingly vague.
27511
27512
27513
27514 .section "Self-signed certificates" "SECID187"
27515 .cindex "certificate" "self-signed"
27516 You can create a self-signed certificate using the &'req'& command provided
27517 with OpenSSL, like this:
27518 . ==== Do not shorten the duration here without reading and considering
27519 . ==== the text below.  Please leave it at 9999 days.
27520 .code
27521 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27522             -days 9999 -nodes
27523 .endd
27524 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27525 delimited and so can be identified independently. The &%-days%& option
27526 specifies a period for which the certificate is valid. The &%-nodes%& option is
27527 important: if you do not set it, the key is encrypted with a passphrase
27528 that you are prompted for, and any use that is made of the key causes more
27529 prompting for the passphrase. This is not helpful if you are going to use
27530 this certificate and key in an MTA, where prompting is not possible.
27531
27532 . ==== I expect to still be working 26 years from now.  The less technical
27533 . ==== debt I create, in terms of storing up trouble for my later years, the
27534 . ==== happier I will be then.  We really have reached the point where we
27535 . ==== should start, at the very least, provoking thought and making folks
27536 . ==== pause before proceeding, instead of leaving all the fixes until two
27537 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27538 . ==== -pdp, 2012
27539 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27540 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27541 the above command might produce a date in the past.  Think carefully about
27542 the lifetime of the systems you're deploying, and either reduce the duration
27543 of the certificate or reconsider your platform deployment.  (At time of
27544 writing, reducing the duration is the most likely choice, but the inexorable
27545 progression of time takes us steadily towards an era where this will not
27546 be a sensible resolution).
27547
27548 A self-signed certificate made in this way is sufficient for testing, and
27549 may be adequate for all your requirements if you are mainly interested in
27550 encrypting transfers, and not in secure identification.
27551
27552 However, many clients require that the certificate presented by the server be a
27553 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27554 certificate. In this situation, the self-signed certificate described above
27555 must be installed on the client host as a trusted root &'certification
27556 authority'& (CA), and the certificate used by Exim must be a user certificate
27557 signed with that self-signed certificate.
27558
27559 For information on creating self-signed CA certificates and using them to sign
27560 user certificates, see the &'General implementation overview'& chapter of the
27561 Open-source PKI book, available online at
27562 &url(http://ospkibook.sourceforge.net/).
27563 .ecindex IIDencsmtp1
27564 .ecindex IIDencsmtp2
27565
27566
27567
27568 . ////////////////////////////////////////////////////////////////////////////
27569 . ////////////////////////////////////////////////////////////////////////////
27570
27571 .chapter "Access control lists" "CHAPACL"
27572 .scindex IIDacl "&ACL;" "description"
27573 .cindex "control of incoming mail"
27574 .cindex "message" "controlling incoming"
27575 .cindex "policy control" "access control lists"
27576 Access Control Lists (ACLs) are defined in a separate section of the run time
27577 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27578 name, terminated by a colon. Here is a complete ACL section that contains just
27579 one very small ACL:
27580 .code
27581 begin acl
27582 small_acl:
27583   accept   hosts = one.host.only
27584 .endd
27585 You can have as many lists as you like in the ACL section, and the order in
27586 which they appear does not matter. The lists are self-terminating.
27587
27588 The majority of ACLs are used to control Exim's behaviour when it receives
27589 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27590 when a local process submits a message using SMTP by specifying the &%-bs%&
27591 option. The most common use is for controlling which recipients are accepted
27592 in incoming messages. In addition, you can define an ACL that is used to check
27593 local non-SMTP messages. The default configuration file contains an example of
27594 a realistic ACL for checking RCPT commands. This is discussed in chapter
27595 &<<CHAPdefconfil>>&.
27596
27597
27598 .section "Testing ACLs" "SECID188"
27599 The &%-bh%& command line option provides a way of testing your ACL
27600 configuration locally by running a fake SMTP session with which you interact.
27601
27602
27603 .section "Specifying when ACLs are used" "SECID189"
27604 .cindex "&ACL;" "options for specifying"
27605 In order to cause an ACL to be used, you have to name it in one of the relevant
27606 options in the main part of the configuration. These options are:
27607 .cindex "AUTH" "ACL for"
27608 .cindex "DATA" "ACLs for"
27609 .cindex "ETRN" "ACL for"
27610 .cindex "EXPN" "ACL for"
27611 .cindex "HELO" "ACL for"
27612 .cindex "EHLO" "ACL for"
27613 .cindex "DKIM" "ACL for"
27614 .cindex "MAIL" "ACL for"
27615 .cindex "QUIT, ACL for"
27616 .cindex "RCPT" "ACL for"
27617 .cindex "STARTTLS, ACL for"
27618 .cindex "VRFY" "ACL for"
27619 .cindex "SMTP" "connection, ACL for"
27620 .cindex "non-SMTP messages" "ACLs for"
27621 .cindex "MIME content scanning" "ACL for"
27622 .cindex "PRDR" "ACL for"
27623
27624 .table2 140pt
27625 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27626 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27627 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27628 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27629 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27630 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27631 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27632 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27633 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27634 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27635 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27636 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27637 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27638 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27639 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27640 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27641 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27642 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27643 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27644 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27645 .endtable
27646
27647 For example, if you set
27648 .code
27649 acl_smtp_rcpt = small_acl
27650 .endd
27651 the little ACL defined above is used whenever Exim receives a RCPT command
27652 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27653 done when RCPT commands arrive. A rejection of RCPT should cause the
27654 sending MTA to give up on the recipient address contained in the RCPT
27655 command, whereas rejection at other times may cause the client MTA to keep on
27656 trying to deliver the message. It is therefore recommended that you do as much
27657 testing as possible at RCPT time.
27658
27659
27660 .section "The non-SMTP ACLs" "SECID190"
27661 .cindex "non-SMTP messages" "ACLs for"
27662 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27663 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27664 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27665 the state of the SMTP connection such as encryption and authentication) are not
27666 relevant and are forbidden in these ACLs. However, the sender and recipients
27667 are known, so the &%senders%& and &%sender_domains%& conditions and the
27668 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27669 &$authenticated_sender$& are also available. You can specify added header lines
27670 in any of these ACLs.
27671
27672 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27673 non-SMTP message, before any of the message has been read. (This is the
27674 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27675 batched SMTP input, it runs after the DATA command has been reached. The
27676 result of this ACL is ignored; it cannot be used to reject a message. If you
27677 really need to, you could set a value in an ACL variable here and reject based
27678 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27679 controls, and in particular, it can be used to set
27680 .code
27681 control = suppress_local_fixups
27682 .endd
27683 This cannot be used in the other non-SMTP ACLs because by the time they are
27684 run, it is too late.
27685
27686 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27687 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27688
27689 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27690 kind of rejection is treated as permanent, because there is no way of sending a
27691 temporary error for these kinds of message.
27692
27693
27694 .section "The SMTP connect ACL" "SECID191"
27695 .cindex "SMTP" "connection, ACL for"
27696 .oindex &%smtp_banner%&
27697 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27698 session, after the test specified by &%host_reject_connection%& (which is now
27699 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27700 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27701 the message override the banner message that is otherwise specified by the
27702 &%smtp_banner%& option.
27703
27704
27705 .section "The EHLO/HELO ACL" "SECID192"
27706 .cindex "EHLO" "ACL for"
27707 .cindex "HELO" "ACL for"
27708 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27709 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27710 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27711 Note that a client may issue more than one EHLO or HELO command in an SMTP
27712 session, and indeed is required to issue a new EHLO or HELO after successfully
27713 setting up encryption following a STARTTLS command.
27714
27715 Note also that a deny neither forces the client to go away nor means that
27716 mail will be refused on the connection.  Consider checking for
27717 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27718
27719 If the command is accepted by an &%accept%& verb that has a &%message%&
27720 modifier, the message may not contain more than one line (it will be truncated
27721 at the first newline and a panic logged if it does). Such a message cannot
27722 affect the EHLO options that are listed on the second and subsequent lines of
27723 an EHLO response.
27724
27725
27726 .section "The DATA ACLs" "SECID193"
27727 .cindex "DATA" "ACLs for"
27728 Two ACLs are associated with the DATA command, because it is two-stage
27729 command, with two responses being sent to the client.
27730 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27731 is obeyed. This gives you control after all the RCPT commands, but before
27732 the message itself is received. It offers the opportunity to give a negative
27733 response to the DATA command before the data is transmitted. Header lines
27734 added by MAIL or RCPT ACLs are not visible at this time, but any that
27735 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27736
27737 You cannot test the contents of the message, for example, to verify addresses
27738 in the headers, at RCPT time or when the DATA command is received. Such
27739 tests have to appear in the ACL that is run after the message itself has been
27740 received, before the final response to the DATA command is sent. This is
27741 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27742 associated with the DATA command.
27743
27744 For both of these ACLs, it is not possible to reject individual recipients. An
27745 error response rejects the entire message. Unfortunately, it is known that some
27746 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27747 before or after the data) correctly &-- they keep the message on their queues
27748 and try again later, but that is their problem, though it does waste some of
27749 your resources.
27750
27751 The &%acl_smtp_data%& ACL is run after
27752 the &%acl_smtp_data_prdr%&,
27753 the &%acl_smtp_dkim%&
27754 and the &%acl_smtp_mime%& ACLs.
27755
27756 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27757 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27758 enabled (which is the default).
27759
27760 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27761 received, and is executed for each DKIM signature found in a message.  If not
27762 otherwise specified, the default action is to accept.
27763
27764 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27765
27766 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27767
27768
27769 .section "The SMTP MIME ACL" "SECID194"
27770 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27771 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27772
27773 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27774
27775
27776 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27777 .cindex "PRDR" "ACL for"
27778 .oindex "&%prdr_enable%&"
27779 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27780 with PRDR support enabled (which is the default).
27781 It becomes active only when the PRDR feature is negotiated between
27782 client and server for a message, and more than one recipient
27783 has been accepted.
27784
27785 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27786 has been received, and is executed once for each recipient of the message
27787 with &$local_part$& and &$domain$& valid.
27788 The test may accept, defer or deny for individual recipients.
27789 The &%acl_smtp_data%& will still be called after this ACL and
27790 can reject the message overall, even if this ACL has accepted it
27791 for some or all recipients.
27792
27793 PRDR may be used to support per-user content filtering.  Without it
27794 one must defer any recipient after the first that has a different
27795 content-filter configuration.  With PRDR, the RCPT-time check
27796 .cindex "PRDR" "variable for"
27797 for this can be disabled when the variable &$prdr_requested$&
27798 is &"yes"&.
27799 Any required difference in behaviour of the main DATA-time
27800 ACL should however depend on the PRDR-time ACL having run, as Exim
27801 will avoid doing so in some situations (e.g.  single-recipient mails).
27802
27803 See also the &%prdr_enable%& global option
27804 and the &%hosts_try_prdr%& smtp transport option.
27805
27806 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27807 If the ACL is not defined, processing completes as if
27808 the feature was not requested by the client.
27809
27810 .section "The QUIT ACL" "SECTQUITACL"
27811 .cindex "QUIT, ACL for"
27812 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27813 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27814 does not in fact control any access.
27815 For this reason, it may only accept
27816 or warn as its final result.
27817
27818 This ACL can be used for tasks such as custom logging at the end of an SMTP
27819 session. For example, you can use ACL variables in other ACLs to count
27820 messages, recipients, etc., and log the totals at QUIT time using one or
27821 more &%logwrite%& modifiers on a &%warn%& verb.
27822
27823 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27824 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27825
27826 You do not need to have a final &%accept%&, but if you do, you can use a
27827 &%message%& modifier to specify custom text that is sent as part of the 221
27828 response to QUIT.
27829
27830 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27831 failure (for example, failure to open a log file, or when Exim is bombing out
27832 because it has detected an unrecoverable error), all SMTP commands from the
27833 client are given temporary error responses until QUIT is received or the
27834 connection is closed. In these special cases, the QUIT ACL does not run.
27835
27836
27837 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27838 .vindex &$acl_smtp_notquit$&
27839 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27840 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27841 trouble, such as being unable to write to its log files, this ACL is not run,
27842 because it might try to do things (such as write to log files) that make the
27843 situation even worse.
27844
27845 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27846 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27847 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27848 and &%warn%&.
27849
27850 .vindex &$smtp_notquit_reason$&
27851 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27852 to a string that indicates the reason for the termination of the SMTP
27853 connection. The possible values are:
27854 .table2
27855 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27856 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27857 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27858 .irow &`connection-lost`&          "The SMTP connection has been lost"
27859 .irow &`data-timeout`&             "Timeout while reading message data"
27860 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27861 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27862 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27863 .irow &`synchronization-error`&    "SMTP synchronization error"
27864 .irow &`tls-failed`&               "TLS failed to start"
27865 .endtable
27866 In most cases when an SMTP connection is closed without having received QUIT,
27867 Exim sends an SMTP response message before actually closing the connection.
27868 With the exception of the &`acl-drop`& case, the default message can be
27869 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27870 &%drop%& verb in another ACL, it is the message from the other ACL that is
27871 used.
27872
27873
27874 .section "Finding an ACL to use" "SECID195"
27875 .cindex "&ACL;" "finding which to use"
27876 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27877 you can use different ACLs in different circumstances. For example,
27878 .code
27879 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27880                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27881 .endd
27882 In the default configuration file there are some example settings for
27883 providing an RFC 4409 message submission service on port 587 and a
27884 non-standard &"smtps"& service on port 465. You can use a string
27885 expansion like this to choose an ACL for MUAs on these ports which is
27886 more appropriate for this purpose than the default ACL on port 25.
27887
27888 The expanded string does not have to be the name of an ACL in the
27889 configuration file; there are other possibilities. Having expanded the
27890 string, Exim searches for an ACL as follows:
27891
27892 .ilist
27893 If the string begins with a slash, Exim uses it as a file name, and reads its
27894 contents as an ACL. The lines are processed in the same way as lines in the
27895 Exim configuration file. In particular, continuation lines are supported, blank
27896 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27897 If the file does not exist or cannot be read, an error occurs (typically
27898 causing a temporary failure of whatever caused the ACL to be run). For example:
27899 .code
27900 acl_smtp_data = /etc/acls/\
27901   ${lookup{$sender_host_address}lsearch\
27902   {/etc/acllist}{$value}{default}}
27903 .endd
27904 This looks up an ACL file to use on the basis of the host's IP address, falling
27905 back to a default if the lookup fails. If an ACL is successfully read from a
27906 file, it is retained in memory for the duration of the Exim process, so that it
27907 can be re-used without having to re-read the file.
27908 .next
27909 If the string does not start with a slash, and does not contain any spaces,
27910 Exim searches the ACL section of the configuration for an ACL whose name
27911 matches the string.
27912 .next
27913 If no named ACL is found, or if the string contains spaces, Exim parses
27914 the string as an inline ACL. This can save typing in cases where you just
27915 want to have something like
27916 .code
27917 acl_smtp_vrfy = accept
27918 .endd
27919 in order to allow free use of the VRFY command. Such a string may contain
27920 newlines; it is processed in the same way as an ACL that is read from a file.
27921 .endlist
27922
27923
27924
27925
27926 .section "ACL return codes" "SECID196"
27927 .cindex "&ACL;" "return codes"
27928 Except for the QUIT ACL, which does not affect the SMTP return code (see
27929 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27930 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27931 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27932 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27933 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27934 This also causes a 4&'xx'& return code.
27935
27936 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27937 &"deny"&, because there is no mechanism for passing temporary errors to the
27938 submitters of non-SMTP messages.
27939
27940
27941 ACLs that are relevant to message reception may also return &"discard"&. This
27942 has the effect of &"accept"&, but causes either the entire message or an
27943 individual recipient address to be discarded. In other words, it is a
27944 blackholing facility. Use it with care.
27945
27946 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27947 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27948 RCPT ACL is to discard just the one recipient address. If there are no
27949 recipients left when the message's data is received, the DATA ACL is not
27950 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27951 remaining recipients. The &"discard"& return is not permitted for the
27952 &%acl_smtp_predata%& ACL.
27953
27954
27955 .cindex "&[local_scan()]& function" "when all recipients discarded"
27956 The &[local_scan()]& function is always run, even if there are no remaining
27957 recipients; it may create new recipients.
27958
27959
27960
27961 .section "Unset ACL options" "SECID197"
27962 .cindex "&ACL;" "unset options"
27963 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27964 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27965 not defined at all. For any defined ACL, the default action when control
27966 reaches the end of the ACL statements is &"deny"&.
27967
27968 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27969 these two are ACLs that are used only for their side effects. They cannot be
27970 used to accept or reject anything.
27971
27972 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27973 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27974 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27975 when the ACL is not defined is &"accept"&.
27976
27977 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27978 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27979 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27980 messages over an SMTP connection. For an example, see the ACL in the default
27981 configuration file.
27982
27983
27984
27985
27986 .section "Data for message ACLs" "SECID198"
27987 .cindex "&ACL;" "data for message ACL"
27988 .vindex &$domain$&
27989 .vindex &$local_part$&
27990 .vindex &$sender_address$&
27991 .vindex &$sender_host_address$&
27992 .vindex &$smtp_command$&
27993 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27994 that contain information about the host and the message's sender (for example,
27995 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27996 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27997 &$local_part$& are set from the argument address. The entire SMTP command
27998 is available in &$smtp_command$&.
27999
28000 When an ACL for the AUTH parameter of MAIL is running, the variables that
28001 contain information about the host are set, but &$sender_address$& is not yet
28002 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28003 how it is used.
28004
28005 .vindex "&$message_size$&"
28006 The &$message_size$& variable is set to the value of the SIZE parameter on
28007 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28008 that parameter is not given. The value is updated to the true message size by
28009 the time the final DATA ACL is run (after the message data has been
28010 received).
28011
28012 .vindex "&$rcpt_count$&"
28013 .vindex "&$recipients_count$&"
28014 The &$rcpt_count$& variable increases by one for each RCPT command received.
28015 The &$recipients_count$& variable increases by one each time a RCPT command is
28016 accepted, so while an ACL for RCPT is being processed, it contains the number
28017 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28018 &$rcpt_count$& contains the total number of RCPT commands, and
28019 &$recipients_count$& contains the total number of accepted recipients.
28020
28021
28022
28023
28024
28025 .section "Data for non-message ACLs" "SECTdatfornon"
28026 .cindex "&ACL;" "data for non-message ACL"
28027 .vindex &$smtp_command_argument$&
28028 .vindex &$smtp_command$&
28029 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28030 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28031 and the entire SMTP command is available in &$smtp_command$&.
28032 These variables can be tested using a &%condition%& condition. For example,
28033 here is an ACL for use with AUTH, which insists that either the session is
28034 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28035 does not permit authentication methods that use cleartext passwords on
28036 unencrypted connections.
28037 .code
28038 acl_check_auth:
28039   accept encrypted = *
28040   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28041                      {CRAM-MD5}}
28042   deny   message   = TLS encryption or CRAM-MD5 required
28043 .endd
28044 (Another way of applying this restriction is to arrange for the authenticators
28045 that use cleartext passwords not to be advertised when the connection is not
28046 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28047 option to do this.)
28048
28049
28050
28051 .section "Format of an ACL" "SECID199"
28052 .cindex "&ACL;" "format of"
28053 .cindex "&ACL;" "verbs, definition of"
28054 An individual ACL consists of a number of statements. Each statement starts
28055 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28056 Modifiers can change the way the verb operates, define error and log messages,
28057 set variables, insert delays, and vary the processing of accepted messages.
28058
28059 If all the conditions are met, the verb is obeyed. The same condition may be
28060 used (with different arguments) more than once in the same statement. This
28061 provides a means of specifying an &"and"& conjunction between conditions. For
28062 example:
28063 .code
28064 deny  dnslists = list1.example
28065 dnslists = list2.example
28066 .endd
28067 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28068 the conditions and modifiers when it reaches a condition that fails. What
28069 happens then depends on the verb (and in one case, on a special modifier). Not
28070 all the conditions make sense at every testing point. For example, you cannot
28071 test a sender address in the ACL that is run for a VRFY command.
28072
28073
28074 .section "ACL verbs" "SECID200"
28075 The ACL verbs are as follows:
28076
28077 .ilist
28078 .cindex "&%accept%& ACL verb"
28079 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28080 of the conditions are not met, what happens depends on whether &%endpass%&
28081 appears among the conditions (for syntax see below). If the failing condition
28082 is before &%endpass%&, control is passed to the next ACL statement; if it is
28083 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28084 check a RCPT command:
28085 .code
28086 accept domains = +local_domains
28087 endpass
28088 verify = recipient
28089 .endd
28090 If the recipient domain does not match the &%domains%& condition, control
28091 passes to the next statement. If it does match, the recipient is verified, and
28092 the command is accepted if verification succeeds. However, if verification
28093 fails, the ACL yields &"deny"&, because the failing condition is after
28094 &%endpass%&.
28095
28096 The &%endpass%& feature has turned out to be confusing to many people, so its
28097 use is not recommended nowadays. It is always possible to rewrite an ACL so
28098 that &%endpass%& is not needed, and it is no longer used in the default
28099 configuration.
28100
28101 .cindex "&%message%& ACL modifier" "with &%accept%&"
28102 If a &%message%& modifier appears on an &%accept%& statement, its action
28103 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28104 (when an &%accept%& verb either accepts or passes control to the next
28105 statement), &%message%& can be used to vary the message that is sent when an
28106 SMTP command is accepted. For example, in a RCPT ACL you could have:
28107 .display
28108 &`accept  `&<&'some conditions'&>
28109 &`        message = OK, I will allow you through today`&
28110 .endd
28111 You can specify an SMTP response code, optionally followed by an &"extended
28112 response code"& at the start of the message, but the first digit must be the
28113 same as would be sent by default, which is 2 for an &%accept%& verb.
28114
28115 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28116 an error message that is used when access is denied. This behaviour is retained
28117 for backward compatibility, but current &"best practice"& is to avoid the use
28118 of &%endpass%&.
28119
28120
28121 .next
28122 .cindex "&%defer%& ACL verb"
28123 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28124 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28125 &%defer%& is the same as &%deny%&, because there is no way of sending a
28126 temporary error. For a RCPT command, &%defer%& is much the same as using a
28127 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28128 be used in any ACL, and even for a recipient it might be a simpler approach.
28129
28130
28131 .next
28132 .cindex "&%deny%& ACL verb"
28133 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28134 the conditions are not met, control is passed to the next ACL statement. For
28135 example,
28136 .code
28137 deny dnslists = blackholes.mail-abuse.org
28138 .endd
28139 rejects commands from hosts that are on a DNS black list.
28140
28141
28142 .next
28143 .cindex "&%discard%& ACL verb"
28144 &%discard%&: This verb behaves like &%accept%&, except that it returns
28145 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28146 that are concerned with receiving messages. When all the conditions are true,
28147 the sending entity receives a &"success"& response. However, &%discard%& causes
28148 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28149 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28150 message's recipients are discarded. Recipients that are discarded before DATA
28151 do not appear in the log line when the &%received_recipients%& log selector is set.
28152
28153 If the &%log_message%& modifier is set when &%discard%& operates,
28154 its contents are added to the line that is automatically written to the log.
28155 The &%message%& modifier operates exactly as it does for &%accept%&.
28156
28157
28158 .next
28159 .cindex "&%drop%& ACL verb"
28160 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28161 forcibly closed after the 5&'xx'& error message has been sent. For example:
28162 .code
28163 drop   message   = I don't take more than 20 RCPTs
28164        condition = ${if > {$rcpt_count}{20}}
28165 .endd
28166 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28167 The connection is always dropped after sending a 550 response.
28168
28169 .next
28170 .cindex "&%require%& ACL verb"
28171 &%require%&: If all the conditions are met, control is passed to the next ACL
28172 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28173 example, when checking a RCPT command,
28174 .code
28175 require message = Sender did not verify
28176         verify  = sender
28177 .endd
28178 passes control to subsequent statements only if the message's sender can be
28179 verified. Otherwise, it rejects the command. Note the positioning of the
28180 &%message%& modifier, before the &%verify%& condition. The reason for this is
28181 discussed in section &<<SECTcondmodproc>>&.
28182
28183 .next
28184 .cindex "&%warn%& ACL verb"
28185 &%warn%&: If all the conditions are true, a line specified by the
28186 &%log_message%& modifier is written to Exim's main log. Control always passes
28187 to the next ACL statement. If any condition is false, the log line is not
28188 written. If an identical log line is requested several times in the same
28189 message, only one copy is actually written to the log. If you want to force
28190 duplicates to be written, use the &%logwrite%& modifier instead.
28191
28192 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28193 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28194 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28195 first failing condition. There is more about adding header lines in section
28196 &<<SECTaddheadacl>>&.
28197
28198 If any condition on a &%warn%& statement cannot be completed (that is, there is
28199 some sort of defer), the log line specified by &%log_message%& is not written.
28200 This does not include the case of a forced failure from a lookup, which
28201 is considered to be a successful completion. After a defer, no further
28202 conditions or modifiers in the &%warn%& statement are processed. The incident
28203 is logged, and the ACL continues to be processed, from the next statement
28204 onwards.
28205
28206
28207 .vindex "&$acl_verify_message$&"
28208 When one of the &%warn%& conditions is an address verification that fails, the
28209 text of the verification failure message is in &$acl_verify_message$&. If you
28210 want this logged, you must set it up explicitly. For example:
28211 .code
28212 warn   !verify = sender
28213        log_message = sender verify failed: $acl_verify_message
28214 .endd
28215 .endlist
28216
28217 At the end of each ACL there is an implicit unconditional &%deny%&.
28218
28219 As you can see from the examples above, the conditions and modifiers are
28220 written one to a line, with the first one on the same line as the verb, and
28221 subsequent ones on following lines. If you have a very long condition, you can
28222 continue it onto several physical lines by the usual backslash continuation
28223 mechanism. It is conventional to align the conditions vertically.
28224
28225
28226
28227 .section "ACL variables" "SECTaclvariables"
28228 .cindex "&ACL;" "variables"
28229 There are some special variables that can be set during ACL processing. They
28230 can be used to pass information between different ACLs, different invocations
28231 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28232 transports, and filters that are used to deliver a message. The names of these
28233 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28234 an underscore, but the remainder of the name can be any sequence of
28235 alphanumeric characters and underscores that you choose. There is no limit on
28236 the number of ACL variables. The two sets act as follows:
28237 .ilist
28238 The values of those variables whose names begin with &$acl_c$& persist
28239 throughout an SMTP connection. They are never reset. Thus, a value that is set
28240 while receiving one message is still available when receiving the next message
28241 on the same SMTP connection.
28242 .next
28243 The values of those variables whose names begin with &$acl_m$& persist only
28244 while a message is being received. They are reset afterwards. They are also
28245 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28246 .endlist
28247
28248 When a message is accepted, the current values of all the ACL variables are
28249 preserved with the message and are subsequently made available at delivery
28250 time. The ACL variables are set by a modifier called &%set%&. For example:
28251 .code
28252 accept hosts = whatever
28253        set acl_m4 = some value
28254 accept authenticated = *
28255        set acl_c_auth = yes
28256 .endd
28257 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28258 be set. If you want to set a variable without taking any action, you can use a
28259 &%warn%& verb without any other modifiers or conditions.
28260
28261 .oindex &%strict_acl_vars%&
28262 What happens if a syntactically valid but undefined ACL variable is
28263 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28264 false (the default), an empty string is substituted; if it is true, an
28265 error is generated.
28266
28267 Versions of Exim before 4.64 have a limited set of numbered variables, but
28268 their names are compatible, so there is no problem with upgrading.
28269
28270
28271 .section "Condition and modifier processing" "SECTcondmodproc"
28272 .cindex "&ACL;" "conditions; processing"
28273 .cindex "&ACL;" "modifiers; processing"
28274 An exclamation mark preceding a condition negates its result. For example:
28275 .code
28276 deny   domains = *.dom.example
28277       !verify  = recipient
28278 .endd
28279 causes the ACL to return &"deny"& if the recipient domain ends in
28280 &'dom.example'& and the recipient address cannot be verified. Sometimes
28281 negation can be used on the right-hand side of a condition. For example, these
28282 two statements are equivalent:
28283 .code
28284 deny  hosts = !192.168.3.4
28285 deny !hosts =  192.168.3.4
28286 .endd
28287 However, for many conditions (&%verify%& being a good example), only left-hand
28288 side negation of the whole condition is possible.
28289
28290 The arguments of conditions and modifiers are expanded. A forced failure
28291 of an expansion causes a condition to be ignored, that is, it behaves as if the
28292 condition is true. Consider these two statements:
28293 .code
28294 accept  senders = ${lookup{$host_name}lsearch\
28295                   {/some/file}{$value}fail}
28296 accept  senders = ${lookup{$host_name}lsearch\
28297                   {/some/file}{$value}{}}
28298 .endd
28299 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28300 the returned list is searched, but if the lookup fails the behaviour is
28301 different in the two cases. The &%fail%& in the first statement causes the
28302 condition to be ignored, leaving no further conditions. The &%accept%& verb
28303 therefore succeeds. The second statement, however, generates an empty list when
28304 the lookup fails. No sender can match an empty list, so the condition fails,
28305 and therefore the &%accept%& also fails.
28306
28307 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28308 specify actions that are taken as the conditions for a statement are checked;
28309 others specify text for messages that are used when access is denied or a
28310 warning is generated. The &%control%& modifier affects the way an incoming
28311 message is handled.
28312
28313 The positioning of the modifiers in an ACL statement is important, because the
28314 processing of a verb ceases as soon as its outcome is known. Only those
28315 modifiers that have already been encountered will take effect. For example,
28316 consider this use of the &%message%& modifier:
28317 .code
28318 require message = Can't verify sender
28319         verify  = sender
28320         message = Can't verify recipient
28321         verify  = recipient
28322         message = This message cannot be used
28323 .endd
28324 If sender verification fails, Exim knows that the result of the statement is
28325 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28326 so its text is used as the error message. If sender verification succeeds, but
28327 recipient verification fails, the second message is used. If recipient
28328 verification succeeds, the third message becomes &"current"&, but is never used
28329 because there are no more conditions to cause failure.
28330
28331 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28332 modifier that is used, because all the conditions must be true for rejection to
28333 happen. Specifying more than one &%message%& modifier does not make sense, and
28334 the message can even be specified after all the conditions. For example:
28335 .code
28336 deny   hosts = ...
28337       !senders = *@my.domain.example
28338        message = Invalid sender from client host
28339 .endd
28340 The &"deny"& result does not happen until the end of the statement is reached,
28341 by which time Exim has set up the message.
28342
28343
28344
28345 .section "ACL modifiers" "SECTACLmodi"
28346 .cindex "&ACL;" "modifiers; list of"
28347 The ACL modifiers are as follows:
28348
28349 .vlist
28350 .vitem &*add_header*&&~=&~<&'text'&>
28351 This modifier specifies one or more header lines that are to be added to an
28352 incoming message, assuming, of course, that the message is ultimately
28353 accepted. For details, see section &<<SECTaddheadacl>>&.
28354
28355 .vitem &*continue*&&~=&~<&'text'&>
28356 .cindex "&%continue%& ACL modifier"
28357 .cindex "database" "updating in ACL"
28358 This modifier does nothing of itself, and processing of the ACL always
28359 continues with the next condition or modifier. The value of &%continue%& is in
28360 the side effects of expanding its argument. Typically this could be used to
28361 update a database. It is really just a syntactic tidiness, to avoid having to
28362 write rather ugly lines like this:
28363 .display
28364 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28365 .endd
28366 Instead, all you need is
28367 .display
28368 &`continue = `&<&'some expansion'&>
28369 .endd
28370
28371 .vitem &*control*&&~=&~<&'text'&>
28372 .cindex "&%control%& ACL modifier"
28373 This modifier affects the subsequent processing of the SMTP connection or of an
28374 incoming message that is accepted. The effect of the first type of control
28375 lasts for the duration of the connection, whereas the effect of the second type
28376 lasts only until the current message has been received. The message-specific
28377 controls always apply to the whole message, not to individual recipients,
28378 even if the &%control%& modifier appears in a RCPT ACL.
28379
28380 As there are now quite a few controls that can be applied, they are described
28381 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28382 in several different ways. For example:
28383
28384 . ==== As this is a nested list, any displays it contains must be indented
28385 . ==== as otherwise they are too far to the left. That comment applies only
28386 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28387 . ==== way.
28388
28389 .ilist
28390 It can be at the end of an &%accept%& statement:
28391 .code
28392     accept  ...some conditions
28393             control = queue_only
28394 .endd
28395 In this case, the control is applied when this statement yields &"accept"&, in
28396 other words, when the conditions are all true.
28397
28398 .next
28399 It can be in the middle of an &%accept%& statement:
28400 .code
28401     accept  ...some conditions...
28402             control = queue_only
28403             ...some more conditions...
28404 .endd
28405 If the first set of conditions are true, the control is applied, even if the
28406 statement does not accept because one of the second set of conditions is false.
28407 In this case, some subsequent statement must yield &"accept"& for the control
28408 to be relevant.
28409
28410 .next
28411 It can be used with &%warn%& to apply the control, leaving the
28412 decision about accepting or denying to a subsequent verb. For
28413 example:
28414 .code
28415     warn    ...some conditions...
28416             control = freeze
28417     accept  ...
28418 .endd
28419 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28420 &%logwrite%&, so it does not add anything to the message and does not write a
28421 log entry.
28422
28423 .next
28424 If you want to apply a control unconditionally, you can use it with a
28425 &%require%& verb. For example:
28426 .code
28427     require  control = no_multiline_responses
28428 .endd
28429 .endlist
28430
28431 .vitem &*delay*&&~=&~<&'time'&>
28432 .cindex "&%delay%& ACL modifier"
28433 .oindex "&%-bh%&"
28434 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28435 the time interval before proceeding. However, when testing Exim using the
28436 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28437 output instead). The time is given in the usual Exim notation, and the delay
28438 happens as soon as the modifier is processed. In an SMTP session, pending
28439 output is flushed before the delay is imposed.
28440
28441 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28442 example:
28443 .code
28444 deny    ...some conditions...
28445         delay = 30s
28446 .endd
28447 The delay happens if all the conditions are true, before the statement returns
28448 &"deny"&. Compare this with:
28449 .code
28450 deny    delay = 30s
28451         ...some conditions...
28452 .endd
28453 which waits for 30s before processing the conditions. The &%delay%& modifier
28454 can also be used with &%warn%& and together with &%control%&:
28455 .code
28456 warn    ...some conditions...
28457         delay = 2m
28458         control = freeze
28459 accept  ...
28460 .endd
28461
28462 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28463 responses to several commands are no longer buffered and sent in one packet (as
28464 they would normally be) because all output is flushed before imposing the
28465 delay. This optimization is disabled so that a number of small delays do not
28466 appear to the client as one large aggregated delay that might provoke an
28467 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28468 using a &%control%& modifier to set &%no_delay_flush%&.
28469
28470
28471 .vitem &*endpass*&
28472 .cindex "&%endpass%& ACL modifier"
28473 This modifier, which has no argument, is recognized only in &%accept%& and
28474 &%discard%& statements. It marks the boundary between the conditions whose
28475 failure causes control to pass to the next statement, and the conditions whose
28476 failure causes the ACL to return &"deny"&. This concept has proved to be
28477 confusing to some people, so the use of &%endpass%& is no longer recommended as
28478 &"best practice"&. See the description of &%accept%& above for more details.
28479
28480
28481 .vitem &*log_message*&&~=&~<&'text'&>
28482 .cindex "&%log_message%& ACL modifier"
28483 This modifier sets up a message that is used as part of the log message if the
28484 ACL denies access or a &%warn%& statement's conditions are true. For example:
28485 .code
28486 require log_message = wrong cipher suite $tls_in_cipher
28487         encrypted   = DES-CBC3-SHA
28488 .endd
28489 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28490 example:
28491 .display
28492 &`discard `&<&'some conditions'&>
28493 &`        log_message = Discarded $local_part@$domain because...`&
28494 .endd
28495 When access is denied, &%log_message%& adds to any underlying error message
28496 that may exist because of a condition failure. For example, while verifying a
28497 recipient address, a &':fail:'& redirection might have already set up a
28498 message.
28499
28500 The message may be defined before the conditions to which it applies, because
28501 the string expansion does not happen until Exim decides that access is to be
28502 denied. This means that any variables that are set by the condition are
28503 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28504 variables are set after a DNS black list lookup succeeds. If the expansion of
28505 &%log_message%& fails, or if the result is an empty string, the modifier is
28506 ignored.
28507
28508 .vindex "&$acl_verify_message$&"
28509 If you want to use a &%warn%& statement to log the result of an address
28510 verification, you can use &$acl_verify_message$& to include the verification
28511 error message.
28512
28513 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28514 the start of the logged message. If the same warning log message is requested
28515 more than once while receiving  a single email message, only one copy is
28516 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28517 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28518 is logged for a successful &%warn%& statement.
28519
28520 If &%log_message%& is not present and there is no underlying error message (for
28521 example, from the failure of address verification), but &%message%& is present,
28522 the &%message%& text is used for logging rejections. However, if any text for
28523 logging contains newlines, only the first line is logged. In the absence of
28524 both &%log_message%& and &%message%&, a default built-in message is used for
28525 logging rejections.
28526
28527
28528 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28529 .cindex "&%log_reject_target%& ACL modifier"
28530 .cindex "logging in ACL" "specifying which log"
28531 This modifier makes it possible to specify which logs are used for messages
28532 about ACL rejections. Its argument is a colon-separated list of words that can
28533 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28534 may be empty, in which case a rejection is not logged at all. For example, this
28535 ACL fragment writes no logging information when access is denied:
28536 .display
28537 &`deny `&<&'some conditions'&>
28538 &`     log_reject_target =`&
28539 .endd
28540 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28541 permanent and temporary rejections. Its effect lasts for the rest of the
28542 current ACL.
28543
28544
28545 .vitem &*logwrite*&&~=&~<&'text'&>
28546 .cindex "&%logwrite%& ACL modifier"
28547 .cindex "logging in ACL" "immediate"
28548 This modifier writes a message to a log file as soon as it is encountered when
28549 processing an ACL. (Compare &%log_message%&, which, except in the case of
28550 &%warn%& and &%discard%&, is used only if the ACL statement denies
28551 access.) The &%logwrite%& modifier can be used to log special incidents in
28552 ACLs. For example:
28553 .display
28554 &`accept `&<&'some special conditions'&>
28555 &`       control  = freeze`&
28556 &`       logwrite = froze message because ...`&
28557 .endd
28558 By default, the message is written to the main log. However, it may begin
28559 with a colon, followed by a comma-separated list of log names, and then
28560 another colon, to specify exactly which logs are to be written. For
28561 example:
28562 .code
28563 logwrite = :main,reject: text for main and reject logs
28564 logwrite = :panic: text for panic log only
28565 .endd
28566
28567
28568 .vitem &*message*&&~=&~<&'text'&>
28569 .cindex "&%message%& ACL modifier"
28570 This modifier sets up a text string that is expanded and used as a response
28571 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28572 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28573 there is some complication if &%endpass%& is involved; see the description of
28574 &%accept%& for details.)
28575
28576 The expansion of the message happens at the time Exim decides that the ACL is
28577 to end, not at the time it processes &%message%&. If the expansion fails, or
28578 generates an empty string, the modifier is ignored. Here is an example where
28579 &%message%& must be specified first, because the ACL ends with a rejection if
28580 the &%hosts%& condition fails:
28581 .code
28582 require  message = Host not recognized
28583          hosts = 10.0.0.0/8
28584 .endd
28585 (Once a condition has failed, no further conditions or modifiers are
28586 processed.)
28587
28588 .cindex "SMTP" "error codes"
28589 .oindex "&%smtp_banner%&
28590 For ACLs that are triggered by SMTP commands, the message is returned as part
28591 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28592 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28593 is accepted. In the case of the connect ACL, accepting with a message modifier
28594 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28595 accept message may not contain more than one line (otherwise it will be
28596 truncated at the first newline and a panic logged), and it cannot affect the
28597 EHLO options.
28598
28599 When SMTP is involved, the message may begin with an overriding response code,
28600 consisting of three digits optionally followed by an &"extended response code"&
28601 of the form &'n.n.n'&, each code being followed by a space. For example:
28602 .code
28603 deny  message = 599 1.2.3 Host not welcome
28604       hosts = 192.168.34.0/24
28605 .endd
28606 The first digit of the supplied response code must be the same as would be sent
28607 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28608 access, but for the predata ACL, note that the default success code is 354, not
28609 2&'xx'&.
28610
28611 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28612 the message modifier cannot override the 221 response code.
28613
28614 The text in a &%message%& modifier is literal; any quotes are taken as
28615 literals, but because the string is expanded, backslash escapes are processed
28616 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28617 response.
28618
28619 .vindex "&$acl_verify_message$&"
28620 For ACLs that are called by an &%acl =%& ACL condition, the message is
28621 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28622
28623 If &%message%& is used on a statement that verifies an address, the message
28624 specified overrides any message that is generated by the verification process.
28625 However, the original message is available in the variable
28626 &$acl_verify_message$&, so you can incorporate it into your message if you
28627 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28628 routers to be passed back as part of the SMTP response, you should either not
28629 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28630
28631 For compatibility with previous releases of Exim, a &%message%& modifier that
28632 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28633 modifier, but this usage is now deprecated. However, &%message%& acts only when
28634 all the conditions are true, wherever it appears in an ACL command, whereas
28635 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28636 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28637 effect.
28638
28639
28640 .new
28641 .vitem &*queue*&&~=&~<&'text'&>
28642 This modifier specifies the use of a named queue for spool files
28643 for the message.
28644 It can only be used before the message is received (i.e. not in
28645 the DATA ACL).
28646 This could be used, for example, for known high-volume burst sources
28647 of traffic, or for quarantine of messages.
28648 Separate queue-runner processes will be needed for named queues.
28649 If the text after expansion is empty, the default queue is used.
28650 .wen
28651
28652
28653 .vitem &*remove_header*&&~=&~<&'text'&>
28654 This modifier specifies one or more header names in a colon-separated list
28655  that are to be removed from an incoming message, assuming, of course, that
28656 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28657
28658
28659 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28660 .cindex "&%set%& ACL modifier"
28661 This modifier puts a value into one of the ACL variables (see section
28662 &<<SECTaclvariables>>&).
28663
28664
28665 .vitem &*udpsend*&&~=&~<&'parameters'&>
28666 This modifier sends a UDP packet, for purposes such as statistics
28667 collection or behaviour monitoring. The parameters are expanded, and
28668 the result of the expansion must be a colon-separated list consisting
28669 of a destination server, port number, and the packet contents. The
28670 server can be specified as a host name or IPv4 or IPv6 address. The
28671 separator can be changed with the usual angle bracket syntax. For
28672 example, you might want to collect information on which hosts connect
28673 when:
28674 .code
28675 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28676              $tod_zulu $sender_host_address
28677 .endd
28678 .endlist
28679
28680
28681
28682
28683 .section "Use of the control modifier" "SECTcontrols"
28684 .cindex "&%control%& ACL modifier"
28685 The &%control%& modifier supports the following settings:
28686
28687 .vlist
28688 .vitem &*control&~=&~allow_auth_unadvertised*&
28689 This modifier allows a client host to use the SMTP AUTH command even when it
28690 has not been advertised in response to EHLO. Furthermore, because there are
28691 apparently some really broken clients that do this, Exim will accept AUTH after
28692 HELO (rather than EHLO) when this control is set. It should be used only if you
28693 really need it, and you should limit its use to those broken clients that do
28694 not work without it. For example:
28695 .code
28696 warn hosts   = 192.168.34.25
28697      control = allow_auth_unadvertised
28698 .endd
28699 Normally, when an Exim server receives an AUTH command, it checks the name of
28700 the authentication mechanism that is given in the command to ensure that it
28701 matches an advertised mechanism. When this control is set, the check that a
28702 mechanism has been advertised is bypassed. Any configured mechanism can be used
28703 by the client. This control is permitted only in the connection and HELO ACLs.
28704
28705
28706 .vitem &*control&~=&~caseful_local_part*& &&&
28707        &*control&~=&~caselower_local_part*&
28708 .cindex "&ACL;" "case of local part in"
28709 .cindex "case of local parts"
28710 .vindex "&$local_part$&"
28711 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28712 (that is, during RCPT processing). By default, the contents of &$local_part$&
28713 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28714 any uppercase letters in the original local part are restored in &$local_part$&
28715 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28716 is encountered.
28717
28718 These controls affect only the current recipient. Moreover, they apply only to
28719 local part handling that takes place directly in the ACL (for example, as a key
28720 in lookups). If a test to verify the recipient is obeyed, the case-related
28721 handling of the local part during the verification is controlled by the router
28722 configuration (see the &%caseful_local_part%& generic router option).
28723
28724 This facility could be used, for example, to add a spam score to local parts
28725 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28726 spam score:
28727 .code
28728 warn  control = caseful_local_part
28729       set acl_m4 = ${eval:\
28730                      $acl_m4 + \
28731                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28732                     }
28733       control = caselower_local_part
28734 .endd
28735 Notice that we put back the lower cased version afterwards, assuming that
28736 is what is wanted for subsequent tests.
28737
28738
28739 .vitem &*control&~=&~cutthrough_delivery*&
28740 .cindex "&ACL;" "cutthrough routing"
28741 .cindex "cutthrough" "requesting"
28742 This option requests delivery be attempted while the item is being received.
28743
28744 The option is usable in the RCPT ACL.
28745 If enabled for a message received via smtp and routed to an smtp transport,
28746 and only one transport, interface, destination host and port combination
28747 is used for all recipients of the message,
28748 then the delivery connection is made while the receiving connection is open
28749 and data is copied from one to the other.
28750
28751 An attempt to set this option for any recipient but the first
28752 for a mail will be quietly ignored.
28753 If a recipient-verify callout
28754 (with use_sender)
28755 connection is subsequently
28756 requested in the same ACL it is held open and used for
28757 any subsequent recipients and the data,
28758 otherwise one is made after the initial RCPT ACL completes.
28759
28760 Note that routers are used in verify mode,
28761 and cannot depend on content of received headers.
28762 Note also that headers cannot be
28763 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28764 Headers may be modified by routers (subject to the above) and transports.
28765
28766 All the usual ACLs are called; if one results in the message being
28767 rejected, all effort spent in delivery (including the costs on
28768 the ultimate destination) will be wasted.
28769 Note that in the case of data-time ACLs this includes the entire
28770 message body.
28771
28772 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28773 of outgoing messages is done, because it sends data to the ultimate destination
28774 before the entire message has been received from the source.
28775 It is not supported for messages received with the SMTP PRDR option in use.
28776
28777 Should the ultimate destination system positively accept or reject the mail,
28778 a corresponding indication is given to the source system and nothing is queued.
28779 If there is a temporary error the item is queued for later delivery in the
28780 usual fashion. If the item is successfully delivered in cutthrough mode
28781 the delivery log lines are tagged with ">>" rather than "=>" and appear
28782 before the acceptance "<=" line.
28783
28784 Delivery in this mode avoids the generation of a bounce mail to a
28785 (possibly faked)
28786 sender when the destination system is doing content-scan based rejection.
28787
28788
28789 .vitem &*control&~=&~debug/*&<&'options'&>
28790 .cindex "&ACL;" "enabling debug logging"
28791 .cindex "debugging" "enabling from an ACL"
28792 This control turns on debug logging, almost as though Exim had been invoked
28793 with &`-d`&, with the output going to a new logfile, by default called
28794 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28795 may access any variables already defined.  The logging may be adjusted with
28796 the &'opts'& option, which takes the same values as the &`-d`& command-line
28797 option.
28798 .new
28799 Logging may be stopped, and the file removed, with the &'kill'& option.
28800 .wen
28801 Some examples (which depend on variables that don't exist in all
28802 contexts):
28803 .code
28804       control = debug
28805       control = debug/tag=.$sender_host_address
28806       control = debug/opts=+expand+acl
28807       control = debug/tag=.$message_exim_id/opts=+expand
28808       control = debug/kill
28809 .endd
28810
28811
28812 .vitem &*control&~=&~dkim_disable_verify*&
28813 .cindex "disable DKIM verify"
28814 .cindex "DKIM" "disable verify"
28815 This control turns off DKIM verification processing entirely.  For details on
28816 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28817
28818
28819 .vitem &*control&~=&~dscp/*&<&'value'&>
28820 .cindex "&ACL;" "setting DSCP value"
28821 .cindex "DSCP" "inbound"
28822 This option causes the DSCP value associated with the socket for the inbound
28823 connection to be adjusted to a given value, given as one of a number of fixed
28824 strings or to numeric value.
28825 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28826 Common values include &`throughput`&, &`mincost`&, and on newer systems
28827 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28828
28829 The outbound packets from Exim will be marked with this value in the header
28830 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28831 that these values will have any effect, not be stripped by networking
28832 equipment, or do much of anything without cooperation with your Network
28833 Engineer and those of all network operators between the source and destination.
28834
28835
28836 .vitem &*control&~=&~enforce_sync*& &&&
28837        &*control&~=&~no_enforce_sync*&
28838 .cindex "SMTP" "synchronization checking"
28839 .cindex "synchronization checking in SMTP"
28840 These controls make it possible to be selective about when SMTP synchronization
28841 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28842 state of the switch (it is true by default). See the description of this option
28843 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28844
28845 The effect of these two controls lasts for the remainder of the SMTP
28846 connection. They can appear in any ACL except the one for the non-SMTP
28847 messages. The most straightforward place to put them is in the ACL defined by
28848 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28849 before the first synchronization check. The expected use is to turn off the
28850 synchronization checks for badly-behaved hosts that you nevertheless need to
28851 work with.
28852
28853
28854 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28855 .cindex "fake defer"
28856 .cindex "defer, fake"
28857 This control works in exactly the same way as &%fakereject%& (described below)
28858 except that it causes an SMTP 450 response after the message data instead of a
28859 550 response. You must take care when using &%fakedefer%& because it causes the
28860 messages to be duplicated when the sender retries. Therefore, you should not
28861 use &%fakedefer%& if the message is to be delivered normally.
28862
28863 .vitem &*control&~=&~fakereject/*&<&'message'&>
28864 .cindex "fake rejection"
28865 .cindex "rejection, fake"
28866 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28867 words, only when an SMTP message is being received. If Exim accepts the
28868 message, instead the final 250 response, a 550 rejection message is sent.
28869 However, Exim proceeds to deliver the message as normal. The control applies
28870 only to the current message, not to any subsequent ones that may be received in
28871 the same SMTP connection.
28872
28873 The text for the 550 response is taken from the &%control%& modifier. If no
28874 message is supplied, the following is used:
28875 .code
28876 550-Your message has been rejected but is being
28877 550-kept for evaluation.
28878 550-If it was a legitimate message, it may still be
28879 550 delivered to the target recipient(s).
28880 .endd
28881 This facility should be used with extreme caution.
28882
28883 .vitem &*control&~=&~freeze*&
28884 .cindex "frozen messages" "forcing in ACL"
28885 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28886 other words, only when a message is being received. If the message is accepted,
28887 it is placed on Exim's queue and frozen. The control applies only to the
28888 current message, not to any subsequent ones that may be received in the same
28889 SMTP connection.
28890
28891 This modifier can optionally be followed by &`/no_tell`&. If the global option
28892 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28893 is told about the freezing), provided all the &*control=freeze*& modifiers that
28894 are obeyed for the current message have the &`/no_tell`& option.
28895
28896 .vitem &*control&~=&~no_delay_flush*&
28897 .cindex "SMTP" "output flushing, disabling for delay"
28898 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28899 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28900 use. This control, as long as it is encountered before the &%delay%& modifier,
28901 disables such output flushing.
28902
28903 .vitem &*control&~=&~no_callout_flush*&
28904 .cindex "SMTP" "output flushing, disabling for callout"
28905 Exim normally flushes SMTP output before performing a callout in an ACL, to
28906 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28907 use. This control, as long as it is encountered before the &%verify%& condition
28908 that causes the callout, disables such output flushing.
28909
28910 .vitem &*control&~=&~no_mbox_unspool*&
28911 This control is available when Exim is compiled with the content scanning
28912 extension. Content scanning may require a copy of the current message, or parts
28913 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28914 or spam scanner. Normally, such copies are deleted when they are no longer
28915 needed. If this control is set, the copies are not deleted. The control applies
28916 only to the current message, not to any subsequent ones that may be received in
28917 the same SMTP connection. It is provided for debugging purposes and is unlikely
28918 to be useful in production.
28919
28920 .vitem &*control&~=&~no_multiline_responses*&
28921 .cindex "multiline responses, suppressing"
28922 This control is permitted for any ACL except the one for non-SMTP messages.
28923 It seems that there are broken clients in use that cannot handle multiline
28924 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28925
28926 If this control is set, multiline SMTP responses from ACL rejections are
28927 suppressed. One way of doing this would have been to put out these responses as
28928 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28929 (&"use multiline responses for more"& it says &-- ha!), and some of the
28930 responses might get close to that. So this facility, which is after all only a
28931 sop to broken clients, is implemented by doing two very easy things:
28932
28933 .ilist
28934 Extra information that is normally output as part of a rejection caused by
28935 sender verification failure is omitted. Only the final line (typically &"sender
28936 verification failed"&) is sent.
28937 .next
28938 If a &%message%& modifier supplies a multiline response, only the first
28939 line is output.
28940 .endlist
28941
28942 The setting of the switch can, of course, be made conditional on the
28943 calling host. Its effect lasts until the end of the SMTP connection.
28944
28945 .vitem &*control&~=&~no_pipelining*&
28946 .cindex "PIPELINING" "suppressing advertising"
28947 This control turns off the advertising of the PIPELINING extension to SMTP in
28948 the current session. To be useful, it must be obeyed before Exim sends its
28949 response to an EHLO command. Therefore, it should normally appear in an ACL
28950 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28951 &%pipelining_advertise_hosts%&.
28952
28953 .vitem &*control&~=&~queue_only*&
28954 .oindex "&%queue_only%&"
28955 .cindex "queueing incoming messages"
28956 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28957 other words, only when a message is being received. If the message is accepted,
28958 it is placed on Exim's queue and left there for delivery by a subsequent queue
28959 runner. No immediate delivery process is started. In other words, it has the
28960 effect as the &%queue_only%& global option. However, the control applies only
28961 to the current message, not to any subsequent ones that may be received in the
28962 same SMTP connection.
28963
28964 .vitem &*control&~=&~submission/*&<&'options'&>
28965 .cindex "message" "submission"
28966 .cindex "submission mode"
28967 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28968 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28969 the current message is a submission from a local MUA. In this case, Exim
28970 operates in &"submission mode"&, and applies certain fixups to the message if
28971 necessary. For example, it adds a &'Date:'& header line if one is not present.
28972 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28973 late (the message has already been created).
28974
28975 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28976 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28977 submission mode; the available options for this control are described there.
28978 The control applies only to the current message, not to any subsequent ones
28979 that may be received in the same SMTP connection.
28980
28981 .vitem &*control&~=&~suppress_local_fixups*&
28982 .cindex "submission fixups, suppressing"
28983 This control applies to locally submitted (non TCP/IP) messages, and is the
28984 complement of &`control = submission`&. It disables the fixups that are
28985 normally applied to locally-submitted messages. Specifically:
28986
28987 .ilist
28988 Any &'Sender:'& header line is left alone (in this respect, it is a
28989 dynamic version of &%local_sender_retain%&).
28990 .next
28991 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28992 .next
28993 There is no check that &'From:'& corresponds to the actual sender.
28994 .endlist ilist
28995
28996 This control may be useful when a remotely-originated message is accepted,
28997 passed to some scanning program, and then re-submitted for delivery. It can be
28998 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28999 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29000 data is read.
29001
29002 &*Note:*& This control applies only to the current message, not to any others
29003 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29004
29005 .vitem &*control&~=&~utf8_downconvert*&
29006 This control enables conversion of UTF-8 in message addresses
29007 to a-label form.
29008 For details see &<<SECTi18nMTA>>&.
29009 .endlist vlist
29010
29011
29012 .section "Summary of message fixup control" "SECTsummesfix"
29013 All four possibilities for message fixups can be specified:
29014
29015 .ilist
29016 Locally submitted, fixups applied: the default.
29017 .next
29018 Locally submitted, no fixups applied: use
29019 &`control = suppress_local_fixups`&.
29020 .next
29021 Remotely submitted, no fixups applied: the default.
29022 .next
29023 Remotely submitted, fixups applied: use &`control = submission`&.
29024 .endlist
29025
29026
29027
29028 .section "Adding header lines in ACLs" "SECTaddheadacl"
29029 .cindex "header lines" "adding in an ACL"
29030 .cindex "header lines" "position of added lines"
29031 .cindex "&%add_header%& ACL modifier"
29032 The &%add_header%& modifier can be used to add one or more extra header lines
29033 to an incoming message, as in this example:
29034 .code
29035 warn dnslists = sbl.spamhaus.org : \
29036                 dialup.mail-abuse.org
29037      add_header = X-blacklisted-at: $dnslist_domain
29038 .endd
29039 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29040 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29041 receiving a message). The message must ultimately be accepted for
29042 &%add_header%& to have any significant effect. You can use &%add_header%& with
29043 any ACL verb, including &%deny%& (though this is potentially useful only in a
29044 RCPT ACL).
29045
29046 Headers will not be added to the message if the modifier is used in
29047 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
29048
29049 Leading and trailing newlines are removed from
29050 the data for the &%add_header%& modifier; if it then
29051 contains one or more newlines that
29052 are not followed by a space or a tab, it is assumed to contain multiple header
29053 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29054 front of any line that is not a valid header line.
29055
29056 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29057 They are added to the message before processing the DATA and MIME ACLs.
29058 However, if an identical header line is requested more than once, only one copy
29059 is actually added to the message. Further header lines may be accumulated
29060 during the DATA and MIME ACLs, after which they are added to the message, again
29061 with duplicates suppressed. Thus, it is possible to add two identical header
29062 lines to an SMTP message, but only if one is added before DATA and one after.
29063 In the case of non-SMTP messages, new headers are accumulated during the
29064 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29065 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29066 are included in the entry that is written to the reject log.
29067
29068 .cindex "header lines" "added; visibility of"
29069 Header lines are not visible in string expansions
29070 of message headers
29071 until they are added to the
29072 message. It follows that header lines defined in the MAIL, RCPT, and predata
29073 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29074 header lines that are added by the DATA or MIME ACLs are not visible in those
29075 ACLs. Because of this restriction, you cannot use header lines as a way of
29076 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29077 this, you can use ACL variables, as described in section
29078 &<<SECTaclvariables>>&.
29079
29080 The list of headers yet to be added is given by the &%$headers_added%& variable.
29081
29082 The &%add_header%& modifier acts immediately as it is encountered during the
29083 processing of an ACL. Notice the difference between these two cases:
29084 .display
29085 &`accept add_header = ADDED: some text`&
29086 &`       `&<&'some condition'&>
29087
29088 &`accept `&<&'some condition'&>
29089 &`       add_header = ADDED: some text`&
29090 .endd
29091 In the first case, the header line is always added, whether or not the
29092 condition is true. In the second case, the header line is added only if the
29093 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29094 ACL statement. All those that are encountered before a condition fails are
29095 honoured.
29096
29097 .cindex "&%warn%& ACL verb"
29098 For compatibility with previous versions of Exim, a &%message%& modifier for a
29099 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29100 effect only if all the conditions are true, even if it appears before some of
29101 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29102 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29103 are present on a &%warn%& verb, both are processed according to their
29104 specifications.
29105
29106 By default, new header lines are added to a message at the end of the existing
29107 header lines. However, you can specify that any particular header line should
29108 be added right at the start (before all the &'Received:'& lines), immediately
29109 after the first block of &'Received:'& lines, or immediately before any line
29110 that is not a &'Received:'& or &'Resent-something:'& header.
29111
29112 This is done by specifying &":at_start:"&, &":after_received:"&, or
29113 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29114 header line, respectively. (Header text cannot start with a colon, as there has
29115 to be a header name first.) For example:
29116 .code
29117 warn add_header = \
29118        :after_received:X-My-Header: something or other...
29119 .endd
29120 If more than one header line is supplied in a single &%add_header%& modifier,
29121 each one is treated independently and can therefore be placed differently. If
29122 you add more than one line at the start, or after the Received: block, they end
29123 up in reverse order.
29124
29125 &*Warning*&: This facility currently applies only to header lines that are
29126 added in an ACL. It does NOT work for header lines that are added in a
29127 system filter or in a router or transport.
29128
29129
29130
29131 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29132 .cindex "header lines" "removing in an ACL"
29133 .cindex "header lines" "position of removed lines"
29134 .cindex "&%remove_header%& ACL modifier"
29135 The &%remove_header%& modifier can be used to remove one or more header lines
29136 from an incoming message, as in this example:
29137 .code
29138 warn   message        = Remove internal headers
29139        remove_header  = x-route-mail1 : x-route-mail2
29140 .endd
29141 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29142 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29143 receiving a message). The message must ultimately be accepted for
29144 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29145 with any ACL verb, including &%deny%&, though this is really not useful for
29146 any verb that doesn't result in a delivered message.
29147
29148 Headers will not be removed to the message if the modifier is used in
29149 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
29150
29151 More than one header can be removed at the same time by using a colon separated
29152 list of header names. The header matching is case insensitive. Wildcards are
29153 not permitted, nor is list expansion performed, so you cannot use hostlists to
29154 create a list of headers, however both connection and message variable expansion
29155 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29156 .code
29157 warn   hosts           = +internal_hosts
29158        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29159 warn   message         = Remove internal headers
29160        remove_header   = $acl_c_ihdrs
29161 .endd
29162 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29163 They are removed from the message before processing the DATA and MIME ACLs.
29164 There is no harm in attempting to remove the same header twice nor is removing
29165 a non-existent header. Further header lines to be removed may be accumulated
29166 during the DATA and MIME ACLs, after which they are removed from the message,
29167 if present. In the case of non-SMTP messages, headers to be removed are
29168 accumulated during the non-SMTP ACLs, and are removed from the message after
29169 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29170 ACL, there really is no effect because there is no logging of what headers
29171 would have been removed.
29172
29173 .cindex "header lines" "removed; visibility of"
29174 Header lines are not visible in string expansions until the DATA phase when it
29175 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29176 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29177 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29178 this restriction, you cannot use header lines as a way of controlling data
29179 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29180 you should instead use ACL variables, as described in section
29181 &<<SECTaclvariables>>&.
29182
29183 The &%remove_header%& modifier acts immediately as it is encountered during the
29184 processing of an ACL. Notice the difference between these two cases:
29185 .display
29186 &`accept remove_header = X-Internal`&
29187 &`       `&<&'some condition'&>
29188
29189 &`accept `&<&'some condition'&>
29190 &`       remove_header = X-Internal`&
29191 .endd
29192 In the first case, the header line is always removed, whether or not the
29193 condition is true. In the second case, the header line is removed only if the
29194 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29195 same ACL statement. All those that are encountered before a condition fails
29196 are honoured.
29197
29198 &*Warning*&: This facility currently applies only to header lines that are
29199 present during ACL processing. It does NOT remove header lines that are added
29200 in a system filter or in a router or transport.
29201
29202
29203
29204
29205 .section "ACL conditions" "SECTaclconditions"
29206 .cindex "&ACL;" "conditions; list of"
29207 Some of the conditions listed in this section are available only when Exim is
29208 compiled with the content-scanning extension. They are included here briefly
29209 for completeness. More detailed descriptions can be found in the discussion on
29210 content scanning in chapter &<<CHAPexiscan>>&.
29211
29212 Not all conditions are relevant in all circumstances. For example, testing
29213 senders and recipients does not make sense in an ACL that is being run as the
29214 result of the arrival of an ETRN command, and checks on message headers can be
29215 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29216 can use the same condition (with different parameters) more than once in the
29217 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29218 The conditions are as follows:
29219
29220
29221 .vlist
29222 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29223 .cindex "&ACL;" "nested"
29224 .cindex "&ACL;" "indirect"
29225 .cindex "&ACL;" "arguments"
29226 .cindex "&%acl%& ACL condition"
29227 The possible values of the argument are the same as for the
29228 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29229 &"accept"& the condition is true; if it returns &"deny"& the condition is
29230 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29231 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29232 condition false. This means that further processing of the &%warn%& verb
29233 ceases, but processing of the ACL continues.
29234
29235 If the argument is a named ACL, up to nine space-separated optional values
29236 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29237 and $acl_narg is set to the count of values.
29238 Previous values of these variables are restored after the call returns.
29239 The name and values are expanded separately.
29240 Note that spaces in complex expansions which are used as arguments
29241 will act as argument separators.
29242
29243 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29244 the connection is dropped. If it returns &"discard"&, the verb must be
29245 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29246 conditions are tested.
29247
29248 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29249 loops. This condition allows you to use different ACLs in different
29250 circumstances. For example, different ACLs can be used to handle RCPT commands
29251 for different local users or different local domains.
29252
29253 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29254 .cindex "&%authenticated%& ACL condition"
29255 .cindex "authentication" "ACL checking"
29256 .cindex "&ACL;" "testing for authentication"
29257 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29258 the name of the authenticator is tested against the list. To test for
29259 authentication by any authenticator, you can set
29260 .code
29261 authenticated = *
29262 .endd
29263
29264 .vitem &*condition&~=&~*&<&'string'&>
29265 .cindex "&%condition%& ACL condition"
29266 .cindex "customizing" "ACL condition"
29267 .cindex "&ACL;" "customized test"
29268 .cindex "&ACL;" "testing, customized"
29269 This feature allows you to make up custom conditions. If the result of
29270 expanding the string is an empty string, the number zero, or one of the strings
29271 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29272 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29273 any other value, some error is assumed to have occurred, and the ACL returns
29274 &"defer"&. However, if the expansion is forced to fail, the condition is
29275 ignored. The effect is to treat it as true, whether it is positive or
29276 negative.
29277
29278 .vitem &*decode&~=&~*&<&'location'&>
29279 .cindex "&%decode%& ACL condition"
29280 This condition is available only when Exim is compiled with the
29281 content-scanning extension, and it is allowed only in the ACL defined by
29282 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29283 If all goes well, the condition is true. It is false only if there are
29284 problems such as a syntax error or a memory shortage. For more details, see
29285 chapter &<<CHAPexiscan>>&.
29286
29287 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29288 .cindex "&%dnslists%& ACL condition"
29289 .cindex "DNS list" "in ACL"
29290 .cindex "black list (DNS)"
29291 .cindex "&ACL;" "testing a DNS list"
29292 This condition checks for entries in DNS black lists. These are also known as
29293 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29294 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29295 different variants of this condition to describe briefly here. See sections
29296 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29297
29298 .vitem &*domains&~=&~*&<&'domain&~list'&>
29299 .cindex "&%domains%& ACL condition"
29300 .cindex "domain" "ACL checking"
29301 .cindex "&ACL;" "testing a recipient domain"
29302 .vindex "&$domain_data$&"
29303 This condition is relevant only after a RCPT command. It checks that the domain
29304 of the recipient address is in the domain list. If percent-hack processing is
29305 enabled, it is done before this test is done. If the check succeeds with a
29306 lookup, the result of the lookup is placed in &$domain_data$& until the next
29307 &%domains%& test.
29308
29309 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29310 use &%domains%& in a DATA ACL.
29311
29312
29313 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29314 .cindex "&%encrypted%& ACL condition"
29315 .cindex "encryption" "checking in an ACL"
29316 .cindex "&ACL;" "testing for encryption"
29317 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29318 name of the cipher suite in use is tested against the list. To test for
29319 encryption without testing for any specific cipher suite(s), set
29320 .code
29321 encrypted = *
29322 .endd
29323
29324
29325 .vitem &*hosts&~=&~*&<&'host&~list'&>
29326 .cindex "&%hosts%& ACL condition"
29327 .cindex "host" "ACL checking"
29328 .cindex "&ACL;" "testing the client host"
29329 This condition tests that the calling host matches the host list. If you have
29330 name lookups or wildcarded host names and IP addresses in the same host list,
29331 you should normally put the IP addresses first. For example, you could have:
29332 .code
29333 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29334 .endd
29335 The lookup in this example uses the host name for its key. This is implied by
29336 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29337 and it wouldn't matter which way round you had these two items.)
29338
29339 The reason for the problem with host names lies in the left-to-right way that
29340 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29341 but when it reaches an item that requires a host name, it fails if it cannot
29342 find a host name to compare with the pattern. If the above list is given in the
29343 opposite order, the &%accept%& statement fails for a host whose name cannot be
29344 found, even if its IP address is 10.9.8.7.
29345
29346 If you really do want to do the name check first, and still recognize the IP
29347 address even if the name lookup fails, you can rewrite the ACL like this:
29348 .code
29349 accept hosts = dbm;/etc/friendly/hosts
29350 accept hosts = 10.9.8.7
29351 .endd
29352 The default action on failing to find the host name is to assume that the host
29353 is not in the list, so the first &%accept%& statement fails. The second
29354 statement can then check the IP address.
29355
29356 .vindex "&$host_data$&"
29357 If a &%hosts%& condition is satisfied by means of a lookup, the result
29358 of the lookup is made available in the &$host_data$& variable. This
29359 allows you, for example, to set up a statement like this:
29360 .code
29361 deny  hosts = net-lsearch;/some/file
29362 message = $host_data
29363 .endd
29364 which gives a custom error message for each denied host.
29365
29366 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29367 .cindex "&%local_parts%& ACL condition"
29368 .cindex "local part" "ACL checking"
29369 .cindex "&ACL;" "testing a local part"
29370 .vindex "&$local_part_data$&"
29371 This condition is relevant only after a RCPT command. It checks that the local
29372 part of the recipient address is in the list. If percent-hack processing is
29373 enabled, it is done before this test. If the check succeeds with a lookup, the
29374 result of the lookup is placed in &$local_part_data$&, which remains set until
29375 the next &%local_parts%& test.
29376
29377 .vitem &*malware&~=&~*&<&'option'&>
29378 .cindex "&%malware%& ACL condition"
29379 .cindex "&ACL;" "virus scanning"
29380 .cindex "&ACL;" "scanning for viruses"
29381 This condition is available only when Exim is compiled with the
29382 content-scanning extension. It causes the incoming message to be scanned for
29383 viruses. For details, see chapter &<<CHAPexiscan>>&.
29384
29385 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29386 .cindex "&%mime_regex%& ACL condition"
29387 .cindex "&ACL;" "testing by regex matching"
29388 This condition is available only when Exim is compiled with the
29389 content-scanning extension, and it is allowed only in the ACL defined by
29390 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29391 with any of the regular expressions. For details, see chapter
29392 &<<CHAPexiscan>>&.
29393
29394 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29395 .cindex "rate limiting"
29396 This condition can be used to limit the rate at which a user or host submits
29397 messages. Details are given in section &<<SECTratelimiting>>&.
29398
29399 .vitem &*recipients&~=&~*&<&'address&~list'&>
29400 .cindex "&%recipients%& ACL condition"
29401 .cindex "recipient" "ACL checking"
29402 .cindex "&ACL;" "testing a recipient"
29403 This condition is relevant only after a RCPT command. It checks the entire
29404 recipient address against a list of recipients.
29405
29406 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29407 .cindex "&%regex%& ACL condition"
29408 .cindex "&ACL;" "testing by regex matching"
29409 This condition is available only when Exim is compiled with the
29410 content-scanning extension, and is available only in the DATA, MIME, and
29411 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29412 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29413
29414 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29415 .cindex "&%sender_domains%& ACL condition"
29416 .cindex "sender" "ACL checking"
29417 .cindex "&ACL;" "testing a sender domain"
29418 .vindex "&$domain$&"
29419 .vindex "&$sender_address_domain$&"
29420 This condition tests the domain of the sender of the message against the given
29421 domain list. &*Note*&: The domain of the sender address is in
29422 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29423 of this condition. This is an exception to the general rule for testing domain
29424 lists. It is done this way so that, if this condition is used in an ACL for a
29425 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29426 influence the sender checking.
29427
29428 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29429 relaying, because sender addresses are easily, and commonly, forged.
29430
29431 .vitem &*senders&~=&~*&<&'address&~list'&>
29432 .cindex "&%senders%& ACL condition"
29433 .cindex "sender" "ACL checking"
29434 .cindex "&ACL;" "testing a sender"
29435 This condition tests the sender of the message against the given list. To test
29436 for a bounce message, which has an empty sender, set
29437 .code
29438 senders = :
29439 .endd
29440 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29441 relaying, because sender addresses are easily, and commonly, forged.
29442
29443 .vitem &*spam&~=&~*&<&'username'&>
29444 .cindex "&%spam%& ACL condition"
29445 .cindex "&ACL;" "scanning for spam"
29446 This condition is available only when Exim is compiled with the
29447 content-scanning extension. It causes the incoming message to be scanned by
29448 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29449
29450 .vitem &*verify&~=&~certificate*&
29451 .cindex "&%verify%& ACL condition"
29452 .cindex "TLS" "client certificate verification"
29453 .cindex "certificate" "verification of client"
29454 .cindex "&ACL;" "certificate verification"
29455 .cindex "&ACL;" "testing a TLS certificate"
29456 This condition is true in an SMTP session if the session is encrypted, and a
29457 certificate was received from the client, and the certificate was verified. The
29458 server requests a certificate only if the client matches &%tls_verify_hosts%&
29459 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29460
29461 .vitem &*verify&~=&~csa*&
29462 .cindex "CSA verification"
29463 This condition checks whether the sending host (the client) is authorized to
29464 send email. Details of how this works are given in section
29465 &<<SECTverifyCSA>>&.
29466
29467 .vitem &*verify&~=&~header_names_ascii*&
29468 .cindex "&%verify%& ACL condition"
29469 .cindex "&ACL;" "verifying header names only ASCII"
29470 .cindex "header lines" "verifying header names only ASCII"
29471 .cindex "verifying" "header names only ASCII"
29472 This condition is relevant only in an ACL that is run after a message has been
29473 received, that is, in an ACL specified by &%acl_smtp_data%& or
29474 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29475 there are no non-ASCII characters, also excluding control characters.  The
29476 allowable characters are decimal ASCII values 33 through 126.
29477
29478 Exim itself will handle headers with non-ASCII characters, but it can cause
29479 problems for downstream applications, so this option will allow their
29480 detection and rejection in the DATA ACL's.
29481
29482 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29483 .cindex "&%verify%& ACL condition"
29484 .cindex "&ACL;" "verifying sender in the header"
29485 .cindex "header lines" "verifying the sender in"
29486 .cindex "sender" "verifying in header"
29487 .cindex "verifying" "sender in header"
29488 This condition is relevant only in an ACL that is run after a message has been
29489 received, that is, in an ACL specified by &%acl_smtp_data%& or
29490 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29491 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29492 is loosely thought of as a &"sender"& address (hence the name of the test).
29493 However, an address that appears in one of these headers need not be an address
29494 that accepts bounce messages; only sender addresses in envelopes are required
29495 to accept bounces. Therefore, if you use the callout option on this check, you
29496 might want to arrange for a non-empty address in the MAIL command.
29497
29498 Details of address verification and the options are given later, starting at
29499 section &<<SECTaddressverification>>& (callouts are described in section
29500 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29501 condition to restrict it to bounce messages only:
29502 .code
29503 deny    senders = :
29504         message = A valid sender header is required for bounces
29505        !verify  = header_sender
29506 .endd
29507
29508 .vitem &*verify&~=&~header_syntax*&
29509 .cindex "&%verify%& ACL condition"
29510 .cindex "&ACL;" "verifying header syntax"
29511 .cindex "header lines" "verifying syntax"
29512 .cindex "verifying" "header syntax"
29513 This condition is relevant only in an ACL that is run after a message has been
29514 received, that is, in an ACL specified by &%acl_smtp_data%& or
29515 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29516 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29517 and &'Bcc:'&), returning true if there are no problems.
29518 Unqualified addresses (local parts without domains) are
29519 permitted only in locally generated messages and from hosts that match
29520 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29521 appropriate.
29522
29523 Note that this condition is a syntax check only. However, a common spamming
29524 ploy used to be to send syntactically invalid headers such as
29525 .code
29526 To: @
29527 .endd
29528 and this condition can be used to reject such messages, though they are not as
29529 common as they used to be.
29530
29531 .vitem &*verify&~=&~helo*&
29532 .cindex "&%verify%& ACL condition"
29533 .cindex "&ACL;" "verifying HELO/EHLO"
29534 .cindex "HELO" "verifying"
29535 .cindex "EHLO" "verifying"
29536 .cindex "verifying" "EHLO"
29537 .cindex "verifying" "HELO"
29538 This condition is true if a HELO or EHLO command has been received from the
29539 client host, and its contents have been verified. If there has been no previous
29540 attempt to verify the HELO/EHLO contents, it is carried out when this
29541 condition is encountered. See the description of the &%helo_verify_hosts%& and
29542 &%helo_try_verify_hosts%& options for details of how to request verification
29543 independently of this condition.
29544
29545 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29546 option), this condition is always true.
29547
29548
29549 .vitem &*verify&~=&~not_blind*&
29550 .cindex "verifying" "not blind"
29551 .cindex "bcc recipients, verifying none"
29552 This condition checks that there are no blind (bcc) recipients in the message.
29553 Every envelope recipient must appear either in a &'To:'& header line or in a
29554 &'Cc:'& header line for this condition to be true. Local parts are checked
29555 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29556 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29557 used only in a DATA or non-SMTP ACL.
29558
29559 There are, of course, many legitimate messages that make use of blind (bcc)
29560 recipients. This check should not be used on its own for blocking messages.
29561
29562
29563 .vitem &*verify&~=&~recipient/*&<&'options'&>
29564 .cindex "&%verify%& ACL condition"
29565 .cindex "&ACL;" "verifying recipient"
29566 .cindex "recipient" "verifying"
29567 .cindex "verifying" "recipient"
29568 .vindex "&$address_data$&"
29569 This condition is relevant only after a RCPT command. It verifies the current
29570 recipient. Details of address verification are given later, starting at section
29571 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29572 of &$address_data$& is the last value that was set while routing the address.
29573 This applies even if the verification fails. When an address that is being
29574 verified is redirected to a single address, verification continues with the new
29575 address, and in that case, the subsequent value of &$address_data$& is the
29576 value for the child address.
29577
29578 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29579 .cindex "&%verify%& ACL condition"
29580 .cindex "&ACL;" "verifying host reverse lookup"
29581 .cindex "host" "verifying reverse lookup"
29582 This condition ensures that a verified host name has been looked up from the IP
29583 address of the client host. (This may have happened already if the host name
29584 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29585 Verification ensures that the host name obtained from a reverse DNS lookup, or
29586 one of its aliases, does, when it is itself looked up in the DNS, yield the
29587 original IP address.
29588
29589 There is one possible option, &`defer_ok`&.  If this is present and a
29590 DNS operation returns a temporary error, the verify condition succeeds.
29591
29592 If this condition is used for a locally generated message (that is, when there
29593 is no client host involved), it always succeeds.
29594
29595 .vitem &*verify&~=&~sender/*&<&'options'&>
29596 .cindex "&%verify%& ACL condition"
29597 .cindex "&ACL;" "verifying sender"
29598 .cindex "sender" "verifying"
29599 .cindex "verifying" "sender"
29600 This condition is relevant only after a MAIL or RCPT command, or after a
29601 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29602 the message's sender is empty (that is, this is a bounce message), the
29603 condition is true. Otherwise, the sender address is verified.
29604
29605 .vindex "&$address_data$&"
29606 .vindex "&$sender_address_data$&"
29607 If there is data in the &$address_data$& variable at the end of routing, its
29608 value is placed in &$sender_address_data$& at the end of verification. This
29609 value can be used in subsequent conditions and modifiers in the same ACL
29610 statement. It does not persist after the end of the current statement. If you
29611 want to preserve the value for longer, you can save it in an ACL variable.
29612
29613 Details of verification are given later, starting at section
29614 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29615 to avoid doing it more than once per message.
29616
29617 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29618 .cindex "&%verify%& ACL condition"
29619 This is a variation of the previous option, in which a modified address is
29620 verified as a sender.
29621 .endlist
29622
29623
29624
29625 .section "Using DNS lists" "SECTmorednslists"
29626 .cindex "DNS list" "in ACL"
29627 .cindex "black list (DNS)"
29628 .cindex "&ACL;" "testing a DNS list"
29629 In its simplest form, the &%dnslists%& condition tests whether the calling host
29630 is on at least one of a number of DNS lists by looking up the inverted IP
29631 address in one or more DNS domains. (Note that DNS list domains are not mail
29632 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29633 special options instead.) For example, if the calling host's IP
29634 address is 192.168.62.43, and the ACL statement is
29635 .code
29636 deny dnslists = blackholes.mail-abuse.org : \
29637                 dialups.mail-abuse.org
29638 .endd
29639 the following records are looked up:
29640 .code
29641 43.62.168.192.blackholes.mail-abuse.org
29642 43.62.168.192.dialups.mail-abuse.org
29643 .endd
29644 As soon as Exim finds an existing DNS record, processing of the list stops.
29645 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29646 to test that a host is on more than one list (an &"and"& conjunction), you can
29647 use two separate conditions:
29648 .code
29649 deny dnslists = blackholes.mail-abuse.org
29650      dnslists = dialups.mail-abuse.org
29651 .endd
29652 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29653 behaves as if the host does not match the list item, that is, as if the DNS
29654 record does not exist. If there are further items in the DNS list, they are
29655 processed.
29656
29657 This is usually the required action when &%dnslists%& is used with &%deny%&
29658 (which is the most common usage), because it prevents a DNS failure from
29659 blocking mail. However, you can change this behaviour by putting one of the
29660 following special items in the list:
29661 .display
29662 &`+include_unknown `&   behave as if the item is on the list
29663 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29664 &`+defer_unknown   `&   give a temporary error
29665 .endd
29666 .cindex "&`+include_unknown`&"
29667 .cindex "&`+exclude_unknown`&"
29668 .cindex "&`+defer_unknown`&"
29669 Each of these applies to any subsequent items on the list. For example:
29670 .code
29671 deny dnslists = +defer_unknown : foo.bar.example
29672 .endd
29673 Testing the list of domains stops as soon as a match is found. If you want to
29674 warn for one list and block for another, you can use two different statements:
29675 .code
29676 deny  dnslists = blackholes.mail-abuse.org
29677 warn  message  = X-Warn: sending host is on dialups list
29678       dnslists = dialups.mail-abuse.org
29679 .endd
29680 .cindex cacheing "of dns lookup"
29681 .cindex DNS TTL
29682 DNS list lookups are cached by Exim for the duration of the SMTP session
29683 (but limited by the DNS return TTL value),
29684 so a lookup based on the IP address is done at most once for any incoming
29685 connection (assuming long-enough TTL).
29686 Exim does not share information between multiple incoming
29687 connections (but your local name server cache should be active).
29688
29689
29690
29691 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29692 .cindex "DNS list" "keyed by explicit IP address"
29693 By default, the IP address that is used in a DNS list lookup is the IP address
29694 of the calling host. However, you can specify another IP address by listing it
29695 after the domain name, introduced by a slash. For example:
29696 .code
29697 deny dnslists = black.list.tld/192.168.1.2
29698 .endd
29699 This feature is not very helpful with explicit IP addresses; it is intended for
29700 use with IP addresses that are looked up, for example, the IP addresses of the
29701 MX hosts or nameservers of an email sender address. For an example, see section
29702 &<<SECTmulkeyfor>>& below.
29703
29704
29705
29706
29707 .section "DNS lists keyed on domain names" "SECID202"
29708 .cindex "DNS list" "keyed by domain name"
29709 There are some lists that are keyed on domain names rather than inverted IP
29710 addresses (see for example the &'domain based zones'& link at
29711 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29712 with these lists. You can change the name that is looked up in a DNS list by
29713 listing it after the domain name, introduced by a slash. For example,
29714 .code
29715 deny  message  = Sender's domain is listed at $dnslist_domain
29716       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29717 .endd
29718 This particular example is useful only in ACLs that are obeyed after the
29719 RCPT or DATA commands, when a sender address is available. If (for
29720 example) the message's sender is &'user@tld.example'& the name that is looked
29721 up by this example is
29722 .code
29723 tld.example.dsn.rfc-ignorant.org
29724 .endd
29725 A single &%dnslists%& condition can contain entries for both names and IP
29726 addresses. For example:
29727 .code
29728 deny dnslists = sbl.spamhaus.org : \
29729                 dsn.rfc-ignorant.org/$sender_address_domain
29730 .endd
29731 The first item checks the sending host's IP address; the second checks a domain
29732 name. The whole condition is true if either of the DNS lookups succeeds.
29733
29734
29735
29736
29737 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29738 .cindex "DNS list" "multiple keys for"
29739 The syntax described above for looking up explicitly-defined values (either
29740 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29741 name for the DNS list, what follows the slash can in fact be a list of items.
29742 As with all lists in Exim, the default separator is a colon. However, because
29743 this is a sublist within the list of DNS blacklist domains, it is necessary
29744 either to double the separators like this:
29745 .code
29746 dnslists = black.list.tld/name.1::name.2
29747 .endd
29748 or to change the separator character, like this:
29749 .code
29750 dnslists = black.list.tld/<;name.1;name.2
29751 .endd
29752 If an item in the list is an IP address, it is inverted before the DNS
29753 blacklist domain is appended. If it is not an IP address, no inversion
29754 occurs. Consider this condition:
29755 .code
29756 dnslists = black.list.tld/<;192.168.1.2;a.domain
29757 .endd
29758 The DNS lookups that occur are:
29759 .code
29760 2.1.168.192.black.list.tld
29761 a.domain.black.list.tld
29762 .endd
29763 Once a DNS record has been found (that matches a specific IP return
29764 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29765 are done. If there is a temporary DNS error, the rest of the sublist of domains
29766 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29767 only if no other DNS lookup in this sublist succeeds. In other words, a
29768 successful lookup for any of the items in the sublist overrides a temporary
29769 error for a previous item.
29770
29771 The ability to supply a list of items after the slash is in some sense just a
29772 syntactic convenience. These two examples have the same effect:
29773 .code
29774 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29775 dnslists = black.list.tld/a.domain::b.domain
29776 .endd
29777 However, when the data for the list is obtained from a lookup, the second form
29778 is usually much more convenient. Consider this example:
29779 .code
29780 deny message  = The mail servers for the domain \
29781                 $sender_address_domain \
29782                 are listed at $dnslist_domain ($dnslist_value); \
29783                 see $dnslist_text.
29784      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29785                                    ${lookup dnsdb {>|mxh=\
29786                                    $sender_address_domain} }} }
29787 .endd
29788 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29789 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29790 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29791 of expanding the condition might be something like this:
29792 .code
29793 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29794 .endd
29795 Thus, this example checks whether or not the IP addresses of the sender
29796 domain's mail servers are on the Spamhaus black list.
29797
29798 The key that was used for a successful DNS list lookup is put into the variable
29799 &$dnslist_matched$& (see section &<<SECID204>>&).
29800
29801
29802
29803
29804 .section "Data returned by DNS lists" "SECID203"
29805 .cindex "DNS list" "data returned from"
29806 DNS lists are constructed using address records in the DNS. The original RBL
29807 just used the address 127.0.0.1 on the right hand side of each record, but the
29808 RBL+ list and some other lists use a number of values with different meanings.
29809 The values used on the RBL+ list are:
29810 .display
29811 127.1.0.1  RBL
29812 127.1.0.2  DUL
29813 127.1.0.3  DUL and RBL
29814 127.1.0.4  RSS
29815 127.1.0.5  RSS and RBL
29816 127.1.0.6  RSS and DUL
29817 127.1.0.7  RSS and DUL and RBL
29818 .endd
29819 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29820 different values. Some DNS lists may return more than one address record;
29821 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29822
29823
29824 .section "Variables set from DNS lists" "SECID204"
29825 .cindex "expansion" "variables, set from DNS list"
29826 .cindex "DNS list" "variables set from"
29827 .vindex "&$dnslist_domain$&"
29828 .vindex "&$dnslist_matched$&"
29829 .vindex "&$dnslist_text$&"
29830 .vindex "&$dnslist_value$&"
29831 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29832 the name of the overall domain that matched (for example,
29833 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29834 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29835 the DNS record. When the key is an IP address, it is not reversed in
29836 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29837 cases, for example:
29838 .code
29839 deny dnslists = spamhaus.example
29840 .endd
29841 the key is also available in another variable (in this case,
29842 &$sender_host_address$&). In more complicated cases, however, this is not true.
29843 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29844 might generate a dnslists lookup like this:
29845 .code
29846 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29847 .endd
29848 If this condition succeeds, the value in &$dnslist_matched$& might be
29849 &`192.168.6.7`& (for example).
29850
29851 If more than one address record is returned by the DNS lookup, all the IP
29852 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29853 The variable &$dnslist_text$& contains the contents of any associated TXT
29854 record. For lists such as RBL+ the TXT record for a merged entry is often not
29855 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29856 information.
29857
29858 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29859 &-- although these appear before the condition in the ACL, they are not
29860 expanded until after it has failed. For example:
29861 .code
29862 deny    hosts = !+local_networks
29863         message = $sender_host_address is listed \
29864                   at $dnslist_domain
29865         dnslists = rbl-plus.mail-abuse.example
29866 .endd
29867
29868
29869
29870 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29871 .cindex "DNS list" "matching specific returned data"
29872 You can add an equals sign and an IP address after a &%dnslists%& domain name
29873 in order to restrict its action to DNS records with a matching right hand side.
29874 For example,
29875 .code
29876 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29877 .endd
29878 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29879 any address record is considered to be a match. For the moment, we assume
29880 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29881 describes how multiple records are handled.
29882
29883 More than one IP address may be given for checking, using a comma as a
29884 separator. These are alternatives &-- if any one of them matches, the
29885 &%dnslists%& condition is true. For example:
29886 .code
29887 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29888 .endd
29889 If you want to specify a constraining address list and also specify names or IP
29890 addresses to be looked up, the constraining address list must be specified
29891 first. For example:
29892 .code
29893 deny dnslists = dsn.rfc-ignorant.org\
29894                 =127.0.0.2/$sender_address_domain
29895 .endd
29896
29897 If the character &`&&`& is used instead of &`=`&, the comparison for each
29898 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29899 In other words, the listed addresses are used as bit masks. The comparison is
29900 true if all the bits in the mask are present in the address that is being
29901 tested. For example:
29902 .code
29903 dnslists = a.b.c&0.0.0.3
29904 .endd
29905 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29906 want to test whether one bit or another bit is present (as opposed to both
29907 being present), you must use multiple values. For example:
29908 .code
29909 dnslists = a.b.c&0.0.0.1,0.0.0.2
29910 .endd
29911 matches if the final component of the address is an odd number or two times
29912 an odd number.
29913
29914
29915
29916 .section "Negated DNS matching conditions" "SECID205"
29917 You can supply a negative list of IP addresses as part of a &%dnslists%&
29918 condition. Whereas
29919 .code
29920 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29921 .endd
29922 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29923 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29924 .code
29925 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29926 .endd
29927 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29928 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29929 words, the result of the test is inverted if an exclamation mark appears before
29930 the &`=`& (or the &`&&`&) sign.
29931
29932 &*Note*&: This kind of negation is not the same as negation in a domain,
29933 host, or address list (which is why the syntax is different).
29934
29935 If you are using just one list, the negation syntax does not gain you much. The
29936 previous example is precisely equivalent to
29937 .code
29938 deny  dnslists = a.b.c
29939      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29940 .endd
29941 However, if you are using multiple lists, the negation syntax is clearer.
29942 Consider this example:
29943 .code
29944 deny  dnslists = sbl.spamhaus.org : \
29945                  list.dsbl.org : \
29946                  dnsbl.njabl.org!=127.0.0.3 : \
29947                  relays.ordb.org
29948 .endd
29949 Using only positive lists, this would have to be:
29950 .code
29951 deny  dnslists = sbl.spamhaus.org : \
29952                  list.dsbl.org
29953 deny  dnslists = dnsbl.njabl.org
29954      !dnslists = dnsbl.njabl.org=127.0.0.3
29955 deny  dnslists = relays.ordb.org
29956 .endd
29957 which is less clear, and harder to maintain.
29958
29959
29960
29961
29962 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29963 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29964 thereby providing more than one IP address. When an item in a &%dnslists%& list
29965 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29966 the match to specific results from the DNS lookup, there are two ways in which
29967 the checking can be handled. For example, consider the condition:
29968 .code
29969 dnslists = a.b.c=127.0.0.1
29970 .endd
29971 What happens if the DNS lookup for the incoming IP address yields both
29972 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29973 condition true because at least one given value was found, or is it false
29974 because at least one of the found values was not listed? And how does this
29975 affect negated conditions? Both possibilities are provided for with the help of
29976 additional separators &`==`& and &`=&&`&.
29977
29978 .ilist
29979 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29980 IP addresses matches one of the listed addresses. For the example above, the
29981 condition is true because 127.0.0.1 matches.
29982 .next
29983 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29984 looked up IP addresses matches one of the listed addresses. If the condition is
29985 changed to:
29986 .code
29987 dnslists = a.b.c==127.0.0.1
29988 .endd
29989 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29990 false because 127.0.0.2 is not listed. You would need to have:
29991 .code
29992 dnslists = a.b.c==127.0.0.1,127.0.0.2
29993 .endd
29994 for the condition to be true.
29995 .endlist
29996
29997 When &`!`& is used to negate IP address matching, it inverts the result, giving
29998 the precise opposite of the behaviour above. Thus:
29999 .ilist
30000 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30001 addresses matches one of the listed addresses. Consider:
30002 .code
30003 dnslists = a.b.c!&0.0.0.1
30004 .endd
30005 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30006 false because 127.0.0.1 matches.
30007 .next
30008 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30009 looked up IP address that does not match. Consider:
30010 .code
30011 dnslists = a.b.c!=&0.0.0.1
30012 .endd
30013 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30014 true, because 127.0.0.2 does not match. You would need to have:
30015 .code
30016 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30017 .endd
30018 for the condition to be false.
30019 .endlist
30020 When the DNS lookup yields only a single IP address, there is no difference
30021 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30022
30023
30024
30025
30026 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30027 .cindex "DNS list" "information from merged"
30028 When the facility for restricting the matching IP values in a DNS list is used,
30029 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30030 the true reason for rejection. This happens when lists are merged and the IP
30031 address in the A record is used to distinguish them; unfortunately there is
30032 only one TXT record. One way round this is not to use merged lists, but that
30033 can be inefficient because it requires multiple DNS lookups where one would do
30034 in the vast majority of cases when the host of interest is not on any of the
30035 lists.
30036
30037 A less inefficient way of solving this problem is available. If
30038 two domain names, comma-separated, are given, the second is used first to
30039 do an initial check, making use of any IP value restrictions that are set.
30040 If there is a match, the first domain is used, without any IP value
30041 restrictions, to get the TXT record. As a byproduct of this, there is also
30042 a check that the IP being tested is indeed on the first list. The first
30043 domain is the one that is put in &$dnslist_domain$&. For example:
30044 .code
30045 reject message  = \
30046          rejected because $sender_host_address is blacklisted \
30047          at $dnslist_domain\n$dnslist_text
30048        dnslists = \
30049          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30050          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30051 .endd
30052 For the first blacklist item, this starts by doing a lookup in
30053 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30054 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30055 value, and as long as something is found, it looks for the corresponding TXT
30056 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30057 The second blacklist item is processed similarly.
30058
30059 If you are interested in more than one merged list, the same list must be
30060 given several times, but because the results of the DNS lookups are cached,
30061 the DNS calls themselves are not repeated. For example:
30062 .code
30063 reject dnslists = \
30064          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30065          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30066          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30067          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30068 .endd
30069 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30070 values matches (or if no record is found), this is the only lookup that is
30071 done. Only if there is a match is one of the more specific lists consulted.
30072
30073
30074
30075 .section "DNS lists and IPv6" "SECTmorednslistslast"
30076 .cindex "IPv6" "DNS black lists"
30077 .cindex "DNS list" "IPv6 usage"
30078 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30079 nibble by nibble. For example, if the calling host's IP address is
30080 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30081 .code
30082 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30083   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30084 .endd
30085 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30086 lists contain wildcard records, intended for IPv4, that interact badly with
30087 IPv6. For example, the DNS entry
30088 .code
30089 *.3.some.list.example.    A    127.0.0.1
30090 .endd
30091 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30092 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30093
30094 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30095 &%condition%& condition, as in this example:
30096 .code
30097 deny   condition = ${if isip4{$sender_host_address}}
30098        dnslists  = some.list.example
30099 .endd
30100
30101 If an explicit key is being used for a DNS lookup and it may be an IPv6
30102 address you should specify alternate list separators for both the outer
30103 (DNS list name) list and inner (lookup keys) list:
30104 .code
30105        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30106 .endd
30107
30108 .section "Rate limiting incoming messages" "SECTratelimiting"
30109 .cindex "rate limiting" "client sending"
30110 .cindex "limiting client sending rates"
30111 .oindex "&%smtp_ratelimit_*%&"
30112 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30113 which clients can send email. This is more powerful than the
30114 &%smtp_ratelimit_*%& options, because those options control the rate of
30115 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30116 works across all connections (concurrent and sequential) from the same client
30117 host. The syntax of the &%ratelimit%& condition is:
30118 .display
30119 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30120 .endd
30121 If the average client sending rate is less than &'m'& messages per time
30122 period &'p'& then the condition is false; otherwise it is true.
30123
30124 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30125 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30126 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30127 of &'p'&.
30128
30129 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30130 time interval, for example, &`8h`& for eight hours. A larger time constant
30131 means that it takes Exim longer to forget a client's past behaviour. The
30132 parameter &'m'& is the maximum number of messages that a client is permitted to
30133 send in each time interval. It also specifies the number of messages permitted
30134 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30135 constant, you can allow a client to send more messages in a burst without
30136 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30137 both small, messages must be sent at an even rate.
30138
30139 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30140 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30141 when deploying the &%ratelimit%& ACL condition. The script prints usage
30142 instructions when it is run with no arguments.
30143
30144 The key is used to look up the data for calculating the client's average
30145 sending rate. This data is stored in Exim's spool directory, alongside the
30146 retry and other hints databases. The default key is &$sender_host_address$&,
30147 which means Exim computes the sending rate of each client host IP address.
30148 By changing the key you can change how Exim identifies clients for the purpose
30149 of ratelimiting. For example, to limit the sending rate of each authenticated
30150 user, independent of the computer they are sending from, set the key to
30151 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30152 example, &$authenticated_id$& is only meaningful if the client has
30153 authenticated (which you can check with the &%authenticated%& ACL condition).
30154
30155 The lookup key does not have to identify clients: If you want to limit the
30156 rate at which a recipient receives messages, you can use the key
30157 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30158 ACL.
30159
30160 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30161 specifies what Exim measures the rate of, for example messages or recipients
30162 or bytes. You can adjust the measurement using the &%unique=%& and/or
30163 &%count=%& options. You can also control when Exim updates the recorded rate
30164 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30165 separated by a slash, like the other parameters. They may appear in any order.
30166
30167 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30168 any options that alter the meaning of the stored data. The limit &'m'& is not
30169 stored, so you can alter the configured maximum rate and Exim will still
30170 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30171 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30172 behaviour. The lookup key is not affected by changes to the update mode and
30173 the &%count=%& option.
30174
30175
30176 .section "Ratelimit options for what is being measured" "ratoptmea"
30177 .cindex "rate limiting" "per_* options"
30178 The &%per_conn%& option limits the client's connection rate. It is not
30179 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30180 &%acl_not_smtp_start%& ACLs.
30181
30182 The &%per_mail%& option limits the client's rate of sending messages. This is
30183 the default if none of the &%per_*%& options is specified. It can be used in
30184 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30185 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30186
30187 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30188 the same ACLs as the &%per_mail%& option, though it is best to use this option
30189 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30190 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30191 in its MAIL command, which may be inaccurate or completely missing. You can
30192 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30193 in kilobytes, megabytes, or gigabytes, respectively.
30194
30195 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30196 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30197 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30198 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30199 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30200 in either case the rate limiting engine will see a message with many
30201 recipients as a large high-speed burst.
30202
30203 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30204 number of different recipients that the client has sent messages to in the
30205 last time period. That is, if the client repeatedly sends messages to the same
30206 recipient, its measured rate is not increased. This option can only be used in
30207 &%acl_smtp_rcpt%&.
30208
30209 The &%per_cmd%& option causes Exim to recompute the rate every time the
30210 condition is processed. This can be used to limit the rate of any SMTP
30211 command. If it is used in multiple ACLs it can limit the aggregate rate of
30212 multiple different commands.
30213
30214 The &%count=%& option can be used to alter how much Exim adds to the client's
30215 measured rate. For example, the &%per_byte%& option is equivalent to
30216 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30217 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30218 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30219
30220 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30221
30222
30223 .section "Ratelimit update modes" "ratoptupd"
30224 .cindex "rate limiting" "reading data without updating"
30225 You can specify one of three options with the &%ratelimit%& condition to
30226 control when its database is updated. This section describes the &%readonly%&
30227 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30228
30229 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30230 previously-computed rate to check against the limit.
30231
30232 For example, you can test the client's sending rate and deny it access (when
30233 it is too fast) in the connect ACL. If the client passes this check then it
30234 can go on to send a message, in which case its recorded rate will be updated
30235 in the MAIL ACL. Subsequent connections from the same client will check this
30236 new rate.
30237 .code
30238 acl_check_connect:
30239  deny ratelimit = 100 / 5m / readonly
30240     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30241                   (max $sender_rate_limit)
30242 # ...
30243 acl_check_mail:
30244  warn ratelimit = 100 / 5m / strict
30245     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30246                   (max $sender_rate_limit)
30247 .endd
30248
30249 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30250 processing a message then it may increase the client's measured rate more than
30251 it should. For example, this will happen if you check the &%per_rcpt%& option
30252 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30253 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30254 multiple update problems by using the &%readonly%& option on later ratelimit
30255 checks.
30256
30257 The &%per_*%& options described above do not make sense in some ACLs. If you
30258 use a &%per_*%& option in an ACL where it is not normally permitted then the
30259 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30260 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30261 next section) so you must specify the &%readonly%& option explicitly.
30262
30263
30264 .section "Ratelimit options for handling fast clients" "ratoptfast"
30265 .cindex "rate limiting" "strict and leaky modes"
30266 If a client's average rate is greater than the maximum, the rate limiting
30267 engine can react in two possible ways, depending on the presence of the
30268 &%strict%& or &%leaky%& update modes. This is independent of the other
30269 counter-measures (such as rejecting the message) that may be specified by the
30270 rest of the ACL.
30271
30272 The &%leaky%& (default) option means that the client's recorded rate is not
30273 updated if it is above the limit. The effect of this is that Exim measures the
30274 client's average rate of successfully sent email, which cannot be greater than
30275 the maximum allowed. If the client is over the limit it may suffer some
30276 counter-measures (as specified in the ACL), but it will still be able to send
30277 email at the configured maximum rate, whatever the rate of its attempts. This
30278 is generally the better choice if you have clients that retry automatically.
30279 For example, it does not prevent a sender with an over-aggressive retry rate
30280 from getting any email through.
30281
30282 The &%strict%& option means that the client's recorded rate is always
30283 updated. The effect of this is that Exim measures the client's average rate
30284 of attempts to send email, which can be much higher than the maximum it is
30285 actually allowed. If the client is over the limit it may be subjected to
30286 counter-measures by the ACL. It must slow down and allow sufficient time to
30287 pass that its computed rate falls below the maximum before it can send email
30288 again. The time (the number of smoothing periods) it must wait and not
30289 attempt to send mail can be calculated with this formula:
30290 .code
30291         ln(peakrate/maxrate)
30292 .endd
30293
30294
30295 .section "Limiting the rate of different events" "ratoptuniq"
30296 .cindex "rate limiting" "counting unique events"
30297 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30298 rate of different events. For example, the &%per_addr%& option uses this
30299 mechanism to count the number of different recipients that the client has
30300 sent messages to in the last time period; it is equivalent to
30301 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30302 measure the rate that a client uses different sender addresses with the
30303 options &`per_mail/unique=$sender_address`&.
30304
30305 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30306 has seen for that key. The whole set is thrown away when it is older than the
30307 rate smoothing period &'p'&, so each different event is counted at most once
30308 per period. In the &%leaky%& update mode, an event that causes the client to
30309 go over the limit is not added to the set, in the same way that the client's
30310 recorded rate is not updated in the same situation.
30311
30312 When you combine the &%unique=%& and &%readonly%& options, the specific
30313 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30314 rate.
30315
30316 The &%unique=%& mechanism needs more space in the ratelimit database than the
30317 other &%ratelimit%& options in order to store the event set. The number of
30318 unique values is potentially as large as the rate limit, so the extra space
30319 required increases with larger limits.
30320
30321 The uniqueification is not perfect: there is a small probability that Exim
30322 will think a new event has happened before. If the sender's rate is less than
30323 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30324 the measured rate can go above the limit, in which case Exim may under-count
30325 events by a significant margin. Fortunately, if the rate is high enough (2.7
30326 times the limit) that the false positive rate goes above 9%, then Exim will
30327 throw away the over-full event set before the measured rate falls below the
30328 limit. Therefore the only harm should be that exceptionally high sending rates
30329 are logged incorrectly; any countermeasures you configure will be as effective
30330 as intended.
30331
30332
30333 .section "Using rate limiting" "useratlim"
30334 Exim's other ACL facilities are used to define what counter-measures are taken
30335 when the rate limit is exceeded. This might be anything from logging a warning
30336 (for example, while measuring existing sending rates in order to define
30337 policy), through time delays to slow down fast senders, up to rejecting the
30338 message. For example:
30339 .code
30340 # Log all senders' rates
30341 warn ratelimit = 0 / 1h / strict
30342      log_message = Sender rate $sender_rate / $sender_rate_period
30343
30344 # Slow down fast senders; note the need to truncate $sender_rate
30345 # at the decimal point.
30346 warn ratelimit = 100 / 1h / per_rcpt / strict
30347      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30348                    $sender_rate_limit }s
30349
30350 # Keep authenticated users under control
30351 deny authenticated = *
30352      ratelimit = 100 / 1d / strict / $authenticated_id
30353
30354 # System-wide rate limit
30355 defer message = Sorry, too busy. Try again later.
30356      ratelimit = 10 / 1s / $primary_hostname
30357
30358 # Restrict incoming rate from each host, with a default
30359 # set using a macro and special cases looked up in a table.
30360 defer message = Sender rate exceeds $sender_rate_limit \
30361                messages per $sender_rate_period
30362      ratelimit = ${lookup {$sender_host_address} \
30363                    cdb {DB/ratelimits.cdb} \
30364                    {$value} {RATELIMIT} }
30365 .endd
30366 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30367 especially with the &%per_rcpt%& option, you may suffer from a performance
30368 bottleneck caused by locking on the ratelimit hints database. Apart from
30369 making your ACLs less complicated, you can reduce the problem by using a
30370 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30371 this means that Exim will lose its hints data after a reboot (including retry
30372 hints, the callout cache, and ratelimit data).
30373
30374
30375
30376 .section "Address verification" "SECTaddressverification"
30377 .cindex "verifying address" "options for"
30378 .cindex "policy control" "address verification"
30379 Several of the &%verify%& conditions described in section
30380 &<<SECTaclconditions>>& cause addresses to be verified. Section
30381 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30382 The verification conditions can be followed by options that modify the
30383 verification process. The options are separated from the keyword and from each
30384 other by slashes, and some of them contain parameters. For example:
30385 .code
30386 verify = sender/callout
30387 verify = recipient/defer_ok/callout=10s,defer_ok
30388 .endd
30389 The first stage of address verification, which always happens, is to run the
30390 address through the routers, in &"verify mode"&. Routers can detect the
30391 difference between verification and routing for delivery, and their actions can
30392 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30393 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30394 The available options are as follows:
30395
30396 .ilist
30397 If the &%callout%& option is specified, successful routing to one or more
30398 remote hosts is followed by a &"callout"& to those hosts as an additional
30399 check. Callouts and their sub-options are discussed in the next section.
30400 .next
30401 If there is a defer error while doing verification routing, the ACL
30402 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30403 options, the condition is forced to be true instead. Note that this is a main
30404 verification option as well as a suboption for callouts.
30405 .next
30406 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30407 discusses the reporting of sender address verification failures.
30408 .next
30409 The &%success_on_redirect%& option causes verification always to succeed
30410 immediately after a successful redirection. By default, if a redirection
30411 generates just one address, that address is also verified. See further
30412 discussion in section &<<SECTredirwhilveri>>&.
30413 .endlist
30414
30415 .cindex "verifying address" "differentiating failures"
30416 .vindex "&$recipient_verify_failure$&"
30417 .vindex "&$sender_verify_failure$&"
30418 .vindex "&$acl_verify_message$&"
30419 After an address verification failure, &$acl_verify_message$& contains the
30420 error message that is associated with the failure. It can be preserved by
30421 coding like this:
30422 .code
30423 warn  !verify = sender
30424        set acl_m0 = $acl_verify_message
30425 .endd
30426 If you are writing your own custom rejection message or log message when
30427 denying access, you can use this variable to include information about the
30428 verification failure.
30429
30430 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30431 appropriate) contains one of the following words:
30432
30433 .ilist
30434 &%qualify%&: The address was unqualified (no domain), and the message
30435 was neither local nor came from an exempted host.
30436 .next
30437 &%route%&: Routing failed.
30438 .next
30439 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30440 occurred at or before the MAIL command (that is, on initial
30441 connection, HELO, or MAIL).
30442 .next
30443 &%recipient%&: The RCPT command in a callout was rejected.
30444 .next
30445 &%postmaster%&: The postmaster check in a callout was rejected.
30446 .endlist
30447
30448 The main use of these variables is expected to be to distinguish between
30449 rejections of MAIL and rejections of RCPT in callouts.
30450
30451
30452
30453
30454 .section "Callout verification" "SECTcallver"
30455 .cindex "verifying address" "by callout"
30456 .cindex "callout" "verification"
30457 .cindex "SMTP" "callout verification"
30458 For non-local addresses, routing verifies the domain, but is unable to do any
30459 checking of the local part. There are situations where some means of verifying
30460 the local part is desirable. One way this can be done is to make an SMTP
30461 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30462 a subsequent host for a recipient address, to see if the host accepts the
30463 address. We use the term &'callout'& to cover both cases. Note that for a
30464 sender address, the callback is not to the client host that is trying to
30465 deliver the message, but to one of the hosts that accepts incoming mail for the
30466 sender's domain.
30467
30468 Exim does not do callouts by default. If you want them to happen, you must
30469 request them by setting appropriate options on the &%verify%& condition, as
30470 described below. This facility should be used with care, because it can add a
30471 lot of resource usage to the cost of verifying an address. However, Exim does
30472 cache the results of callouts, which helps to reduce the cost. Details of
30473 caching are in section &<<SECTcallvercache>>&.
30474
30475 Recipient callouts are usually used only between hosts that are controlled by
30476 the same administration. For example, a corporate gateway host could use
30477 callouts to check for valid recipients on an internal mailserver. A successful
30478 callout does not guarantee that a real delivery to the address would succeed;
30479 on the other hand, a failing callout does guarantee that a delivery would fail.
30480
30481 If the &%callout%& option is present on a condition that verifies an address, a
30482 second stage of verification occurs if the address is successfully routed to
30483 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30484 &(manualroute)& router, where the router specifies the hosts. However, if a
30485 router that does not set up hosts routes to an &(smtp)& transport with a
30486 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30487 &%hosts_override%& set, its hosts are always used, whether or not the router
30488 supplies a host list.
30489 Callouts are only supported on &(smtp)& transports.
30490
30491 The port that is used is taken from the transport, if it is specified and is a
30492 remote transport. (For routers that do verification only, no transport need be
30493 specified.) Otherwise, the default SMTP port is used. If a remote transport
30494 specifies an outgoing interface, this is used; otherwise the interface is not
30495 specified. Likewise, the text that is used for the HELO command is taken from
30496 the transport's &%helo_data%& option; if there is no transport, the value of
30497 &$smtp_active_hostname$& is used.
30498
30499 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30500 test whether a bounce message could be delivered to the sender address. The
30501 following SMTP commands are sent:
30502 .display
30503 &`HELO `&<&'local host name'&>
30504 &`MAIL FROM:<>`&
30505 &`RCPT TO:`&<&'the address to be tested'&>
30506 &`QUIT`&
30507 .endd
30508 LHLO is used instead of HELO if the transport's &%protocol%& option is
30509 set to &"lmtp"&.
30510
30511 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30512 settings.
30513
30514 A recipient callout check is similar. By default, it also uses an empty address
30515 for the sender. This default is chosen because most hosts do not make use of
30516 the sender address when verifying a recipient. Using the same address means
30517 that a single cache entry can be used for each recipient. Some sites, however,
30518 do make use of the sender address when verifying. These are catered for by the
30519 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30520
30521 If the response to the RCPT command is a 2&'xx'& code, the verification
30522 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30523 Exim tries the next host, if any. If there is a problem with all the remote
30524 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30525 &%callout%& option is given, in which case the condition is forced to succeed.
30526
30527 .cindex "SMTP" "output flushing, disabling for callout"
30528 A callout may take a little time. For this reason, Exim normally flushes SMTP
30529 output before performing a callout in an ACL, to avoid unexpected timeouts in
30530 clients when the SMTP PIPELINING extension is in use. The flushing can be
30531 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30532
30533
30534
30535
30536 .section "Additional parameters for callouts" "CALLaddparcall"
30537 .cindex "callout" "additional parameters for"
30538 The &%callout%& option can be followed by an equals sign and a number of
30539 optional parameters, separated by commas. For example:
30540 .code
30541 verify = recipient/callout=10s,defer_ok
30542 .endd
30543 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30544 separate verify options, is retained for backwards compatibility, but is now
30545 deprecated. The additional parameters for &%callout%& are as follows:
30546
30547
30548 .vlist
30549 .vitem <&'a&~time&~interval'&>
30550 .cindex "callout" "timeout, specifying"
30551 This specifies the timeout that applies for the callout attempt to each host.
30552 For example:
30553 .code
30554 verify = sender/callout=5s
30555 .endd
30556 The default is 30 seconds. The timeout is used for each response from the
30557 remote host. It is also used for the initial connection, unless overridden by
30558 the &%connect%& parameter.
30559
30560
30561 .vitem &*connect&~=&~*&<&'time&~interval'&>
30562 .cindex "callout" "connection timeout, specifying"
30563 This parameter makes it possible to set a different (usually smaller) timeout
30564 for making the SMTP connection. For example:
30565 .code
30566 verify = sender/callout=5s,connect=1s
30567 .endd
30568 If not specified, this timeout defaults to the general timeout value.
30569
30570 .vitem &*defer_ok*&
30571 .cindex "callout" "defer, action on"
30572 When this parameter is present, failure to contact any host, or any other kind
30573 of temporary error, is treated as success by the ACL. However, the cache is not
30574 updated in this circumstance.
30575
30576 .vitem &*fullpostmaster*&
30577 .cindex "callout" "full postmaster check"
30578 This operates like the &%postmaster%& option (see below), but if the check for
30579 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30580 accordance with the specification in RFC 2821. The RFC states that the
30581 unqualified address &'postmaster'& should be accepted.
30582
30583
30584 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30585 .cindex "callout" "sender when verifying header"
30586 When verifying addresses in header lines using the &%header_sender%&
30587 verification option, Exim behaves by default as if the addresses are envelope
30588 sender addresses from a message. Callout verification therefore tests to see
30589 whether a bounce message could be delivered, by using an empty address in the
30590 MAIL command. However, it is arguable that these addresses might never be used
30591 as envelope senders, and could therefore justifiably reject bounce messages
30592 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30593 address to use in the MAIL command. For example:
30594 .code
30595 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30596 .endd
30597 This parameter is available only for the &%header_sender%& verification option.
30598
30599
30600 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30601 .cindex "callout" "overall timeout, specifying"
30602 This parameter sets an overall timeout for performing a callout verification.
30603 For example:
30604 .code
30605 verify = sender/callout=5s,maxwait=30s
30606 .endd
30607 This timeout defaults to four times the callout timeout for individual SMTP
30608 commands. The overall timeout applies when there is more than one host that can
30609 be tried. The timeout is checked before trying the next host. This prevents
30610 very long delays if there are a large number of hosts and all are timing out
30611 (for example, when network connections are timing out).
30612
30613
30614 .vitem &*no_cache*&
30615 .cindex "callout" "cache, suppressing"
30616 .cindex "caching callout, suppressing"
30617 When this parameter is given, the callout cache is neither read nor updated.
30618
30619 .vitem &*postmaster*&
30620 .cindex "callout" "postmaster; checking"
30621 When this parameter is set, a successful callout check is followed by a similar
30622 check for the local part &'postmaster'& at the same domain. If this address is
30623 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30624 the postmaster check is recorded in a cache record; if it is a failure, this is
30625 used to fail subsequent callouts for the domain without a connection being
30626 made, until the cache record expires.
30627
30628 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30629 The postmaster check uses an empty sender in the MAIL command by default.
30630 You can use this parameter to do a postmaster check using a different address.
30631 For example:
30632 .code
30633 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30634 .endd
30635 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30636 one overrides. The &%postmaster%& parameter is equivalent to this example:
30637 .code
30638 require  verify = sender/callout=postmaster_mailfrom=
30639 .endd
30640 &*Warning*&: The caching arrangements for postmaster checking do not take
30641 account of the sender address. It is assumed that either the empty address or
30642 a fixed non-empty address will be used. All that Exim remembers is that the
30643 postmaster check for the domain succeeded or failed.
30644
30645
30646 .vitem &*random*&
30647 .cindex "callout" "&""random""& check"
30648 When this parameter is set, before doing the normal callout check, Exim does a
30649 check for a &"random"& local part at the same domain. The local part is not
30650 really random &-- it is defined by the expansion of the option
30651 &%callout_random_local_part%&, which defaults to
30652 .code
30653 $primary_hostname-$tod_epoch-testing
30654 .endd
30655 The idea here is to try to determine whether the remote host accepts all local
30656 parts without checking. If it does, there is no point in doing callouts for
30657 specific local parts. If the &"random"& check succeeds, the result is saved in
30658 a cache record, and used to force the current and subsequent callout checks to
30659 succeed without a connection being made, until the cache record expires.
30660
30661 .vitem &*use_postmaster*&
30662 .cindex "callout" "sender for recipient check"
30663 This parameter applies to recipient callouts only. For example:
30664 .code
30665 deny  !verify = recipient/callout=use_postmaster
30666 .endd
30667 .vindex "&$qualify_domain$&"
30668 It causes a non-empty postmaster address to be used in the MAIL command when
30669 performing the callout for the recipient, and also for a &"random"& check if
30670 that is configured. The local part of the address is &`postmaster`& and the
30671 domain is the contents of &$qualify_domain$&.
30672
30673 .vitem &*use_sender*&
30674 This option applies to recipient callouts only. For example:
30675 .code
30676 require  verify = recipient/callout=use_sender
30677 .endd
30678 It causes the message's actual sender address to be used in the MAIL
30679 command when performing the callout, instead of an empty address. There is no
30680 need to use this option unless you know that the called hosts make use of the
30681 sender when checking recipients. If used indiscriminately, it reduces the
30682 usefulness of callout caching.
30683 .endlist
30684
30685 If you use any of the parameters that set a non-empty sender for the MAIL
30686 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30687 &%use_sender%&), you should think about possible loops. Recipient checking is
30688 usually done between two hosts that are under the same management, and the host
30689 that receives the callouts is not normally configured to do callouts itself.
30690 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30691 these circumstances.
30692
30693 However, if you use a non-empty sender address for a callout to an arbitrary
30694 host, there is the likelihood that the remote host will itself initiate a
30695 callout check back to your host. As it is checking what appears to be a message
30696 sender, it is likely to use an empty address in MAIL, thus avoiding a
30697 callout loop. However, to be on the safe side it would be best to set up your
30698 own ACLs so that they do not do sender verification checks when the recipient
30699 is the address you use for header sender or postmaster callout checking.
30700
30701 Another issue to think about when using non-empty senders for callouts is
30702 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30703 by the sender/recipient combination; thus, for any given recipient, many more
30704 actual callouts are performed than when an empty sender or postmaster is used.
30705
30706
30707
30708
30709 .section "Callout caching" "SECTcallvercache"
30710 .cindex "hints database" "callout cache"
30711 .cindex "callout" "cache, description of"
30712 .cindex "caching" "callout"
30713 Exim caches the results of callouts in order to reduce the amount of resources
30714 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30715 option. A hints database called &"callout"& is used for the cache. Two
30716 different record types are used: one records the result of a callout check for
30717 a specific address, and the other records information that applies to the
30718 entire domain (for example, that it accepts the local part &'postmaster'&).
30719
30720 When an original callout fails, a detailed SMTP error message is given about
30721 the failure. However, for subsequent failures use the cache data, this message
30722 is not available.
30723
30724 The expiry times for negative and positive address cache records are
30725 independent, and can be set by the global options &%callout_negative_expire%&
30726 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30727
30728 If a host gives a negative response to an SMTP connection, or rejects any
30729 commands up to and including
30730 .code
30731 MAIL FROM:<>
30732 .endd
30733 (but not including the MAIL command with a non-empty address),
30734 any callout attempt is bound to fail. Exim remembers such failures in a
30735 domain cache record, which it uses to fail callouts for the domain without
30736 making new connections, until the domain record times out. There are two
30737 separate expiry times for domain cache records:
30738 &%callout_domain_negative_expire%& (default 3h) and
30739 &%callout_domain_positive_expire%& (default 7d).
30740
30741 Domain records expire when the negative expiry time is reached if callouts
30742 cannot be made for the domain, or if the postmaster check failed.
30743 Otherwise, they expire when the positive expiry time is reached. This
30744 ensures that, for example, a host that stops accepting &"random"& local parts
30745 will eventually be noticed.
30746
30747 The callout caching mechanism is based on the domain of the address that is
30748 being tested. If the domain routes to several hosts, it is assumed that their
30749 behaviour will be the same.
30750
30751
30752
30753 .section "Sender address verification reporting" "SECTsenaddver"
30754 .cindex "verifying" "suppressing error details"
30755 See section &<<SECTaddressverification>>& for a general discussion of
30756 verification. When sender verification fails in an ACL, the details of the
30757 failure are given as additional output lines before the 550 response to the
30758 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30759 you might see:
30760 .code
30761 MAIL FROM:<xyz@abc.example>
30762 250 OK
30763 RCPT TO:<pqr@def.example>
30764 550-Verification failed for <xyz@abc.example>
30765 550-Called:   192.168.34.43
30766 550-Sent:     RCPT TO:<xyz@abc.example>
30767 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30768 550 Sender verification failed
30769 .endd
30770 If more than one RCPT command fails in the same way, the details are given
30771 only for the first of them. However, some administrators do not want to send
30772 out this much information. You can suppress the details by adding
30773 &`/no_details`& to the ACL statement that requests sender verification. For
30774 example:
30775 .code
30776 verify = sender/no_details
30777 .endd
30778
30779 .section "Redirection while verifying" "SECTredirwhilveri"
30780 .cindex "verifying" "redirection while"
30781 .cindex "address redirection" "while verifying"
30782 A dilemma arises when a local address is redirected by aliasing or forwarding
30783 during verification: should the generated addresses themselves be verified,
30784 or should the successful expansion of the original address be enough to verify
30785 it? By default, Exim takes the following pragmatic approach:
30786
30787 .ilist
30788 When an incoming address is redirected to just one child address, verification
30789 continues with the child address, and if that fails to verify, the original
30790 verification also fails.
30791 .next
30792 When an incoming address is redirected to more than one child address,
30793 verification does not continue. A success result is returned.
30794 .endlist
30795
30796 This seems the most reasonable behaviour for the common use of aliasing as a
30797 way of redirecting different local parts to the same mailbox. It means, for
30798 example, that a pair of alias entries of the form
30799 .code
30800 A.Wol:   aw123
30801 aw123:   :fail: Gone away, no forwarding address
30802 .endd
30803 work as expected, with both local parts causing verification failure. When a
30804 redirection generates more than one address, the behaviour is more like a
30805 mailing list, where the existence of the alias itself is sufficient for
30806 verification to succeed.
30807
30808 It is possible, however, to change the default behaviour so that all successful
30809 redirections count as successful verifications, however many new addresses are
30810 generated. This is specified by the &%success_on_redirect%& verification
30811 option. For example:
30812 .code
30813 require verify = recipient/success_on_redirect/callout=10s
30814 .endd
30815 In this example, verification succeeds if a router generates a new address, and
30816 the callout does not occur, because no address was routed to a remote host.
30817
30818 When verification is being tested via the &%-bv%& option, the treatment of
30819 redirections is as just described, unless the &%-v%& or any debugging option is
30820 also specified. In that case, full verification is done for every generated
30821 address and a report is output for each of them.
30822
30823
30824
30825 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30826 .cindex "CSA" "verifying"
30827 Client SMTP Authorization is a system that allows a site to advertise
30828 which machines are and are not permitted to send email. This is done by placing
30829 special SRV records in the DNS; these are looked up using the client's HELO
30830 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30831 Authorization checks in Exim are performed by the ACL condition:
30832 .code
30833 verify = csa
30834 .endd
30835 This fails if the client is not authorized. If there is a DNS problem, or if no
30836 valid CSA SRV record is found, or if the client is authorized, the condition
30837 succeeds. These three cases can be distinguished using the expansion variable
30838 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30839 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30840 be likely to cause problems for legitimate email.
30841
30842 The error messages produced by the CSA code include slightly more
30843 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30844 looking up the CSA SRV record, or problems looking up the CSA target
30845 address record. There are four reasons for &$csa_status$& being &"fail"&:
30846
30847 .ilist
30848 The client's host name is explicitly not authorized.
30849 .next
30850 The client's IP address does not match any of the CSA target IP addresses.
30851 .next
30852 The client's host name is authorized but it has no valid target IP addresses
30853 (for example, the target's addresses are IPv6 and the client is using IPv4).
30854 .next
30855 The client's host name has no CSA SRV record but a parent domain has asserted
30856 that all subdomains must be explicitly authorized.
30857 .endlist
30858
30859 The &%csa%& verification condition can take an argument which is the domain to
30860 use for the DNS query. The default is:
30861 .code
30862 verify = csa/$sender_helo_name
30863 .endd
30864 This implementation includes an extension to CSA. If the query domain
30865 is an address literal such as [192.0.2.95], or if it is a bare IP
30866 address, Exim searches for CSA SRV records in the reverse DNS as if
30867 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30868 meaningful to say:
30869 .code
30870 verify = csa/$sender_host_address
30871 .endd
30872 In fact, this is the check that Exim performs if the client does not say HELO.
30873 This extension can be turned off by setting the main configuration option
30874 &%dns_csa_use_reverse%& to be false.
30875
30876 If a CSA SRV record is not found for the domain itself, a search
30877 is performed through its parent domains for a record which might be
30878 making assertions about subdomains. The maximum depth of this search is limited
30879 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30880 default. Exim does not look for CSA SRV records in a top level domain, so the
30881 default settings handle HELO domains as long as seven
30882 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30883 of legitimate HELO domains.
30884
30885 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30886 direct SRV lookups, this is not sufficient because of the extra parent domain
30887 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30888 addresses into lookups in the reverse DNS space. The result of a successful
30889 lookup such as:
30890 .code
30891 ${lookup dnsdb {csa=$sender_helo_name}}
30892 .endd
30893 has two space-separated fields: an authorization code and a target host name.
30894 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30895 authorization required but absent, or &"?"& for unknown.
30896
30897
30898
30899
30900 .section "Bounce address tag validation" "SECTverifyPRVS"
30901 .cindex "BATV, verifying"
30902 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30903 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30904 Genuine incoming bounce messages should therefore always be addressed to
30905 recipients that have a valid tag. This scheme is a way of detecting unwanted
30906 bounce messages caused by sender address forgeries (often called &"collateral
30907 spam"&), because the recipients of such messages do not include valid tags.
30908
30909 There are two expansion items to help with the implementation of the BATV
30910 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30911 the original envelope sender address by using a simple key to add a hash of the
30912 address and some time-based randomizing information. The &%prvs%& expansion
30913 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30914 The syntax of these expansion items is described in section
30915 &<<SECTexpansionitems>>&.
30916
30917 As an example, suppose the secret per-address keys are stored in an MySQL
30918 database. A query to look up the key for an address could be defined as a macro
30919 like this:
30920 .code
30921 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30922                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30923                 }{$value}}
30924 .endd
30925 Suppose also that the senders who make use of BATV are defined by an address
30926 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30927 use this:
30928 .code
30929 # Bounces: drop unsigned addresses for BATV senders
30930 deny message = This address does not send an unsigned reverse path
30931      senders = :
30932      recipients = +batv_senders
30933
30934 # Bounces: In case of prvs-signed address, check signature.
30935 deny message = Invalid reverse path signature.
30936      senders = :
30937      condition  = ${prvscheck {$local_part@$domain}\
30938                   {PRVSCHECK_SQL}{1}}
30939      !condition = $prvscheck_result
30940 .endd
30941 The first statement rejects recipients for bounce messages that are addressed
30942 to plain BATV sender addresses, because it is known that BATV senders do not
30943 send out messages with plain sender addresses. The second statement rejects
30944 recipients that are prvs-signed, but with invalid signatures (either because
30945 the key is wrong, or the signature has timed out).
30946
30947 A non-prvs-signed address is not rejected by the second statement, because the
30948 &%prvscheck%& expansion yields an empty string if its first argument is not a
30949 prvs-signed address, thus causing the &%condition%& condition to be false. If
30950 the first argument is a syntactically valid prvs-signed address, the yield is
30951 the third string (in this case &"1"&), whether or not the cryptographic and
30952 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30953 of the checks (empty for failure, &"1"& for success).
30954
30955 There is one more issue you must consider when implementing prvs-signing:
30956 you have to ensure that the routers accept prvs-signed addresses and
30957 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30958 router to remove the signature with a configuration along these lines:
30959 .code
30960 batv_redirect:
30961   driver = redirect
30962   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30963 .endd
30964 This works because, if the third argument of &%prvscheck%& is empty, the result
30965 of the expansion of a prvs-signed address is the decoded value of the original
30966 address. This router should probably be the first of your routers that handles
30967 local addresses.
30968
30969 To create BATV-signed addresses in the first place, a transport of this form
30970 can be used:
30971 .code
30972 external_smtp_batv:
30973   driver = smtp
30974   return_path = ${prvs {$return_path} \
30975                        {${lookup mysql{SELECT \
30976                        secret FROM batv_prvs WHERE \
30977                        sender='${quote_mysql:$sender_address}'} \
30978                        {$value}fail}}}
30979 .endd
30980 If no key can be found for the existing return path, no signing takes place.
30981
30982
30983
30984 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30985 .cindex "&ACL;" "relay control"
30986 .cindex "relaying" "control by ACL"
30987 .cindex "policy control" "relay control"
30988 An MTA is said to &'relay'& a message if it receives it from some host and
30989 delivers it directly to another host as a result of a remote address contained
30990 within it. Redirecting a local address via an alias or forward file and then
30991 passing the message on to another host is not relaying,
30992 .cindex "&""percent hack""&"
30993 but a redirection as a result of the &"percent hack"& is.
30994
30995 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30996 A host which is acting as a gateway or an MX backup is concerned with incoming
30997 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30998 a host which is acting as a smart host for a number of clients is concerned
30999 with outgoing relaying from those clients to the Internet at large. Often the
31000 same host is fulfilling both functions,
31001 . ///
31002 . as illustrated in the diagram below,
31003 . ///
31004 but in principle these two kinds of relaying are entirely independent. What is
31005 not wanted is the transmission of mail from arbitrary remote hosts through your
31006 system to arbitrary domains.
31007
31008
31009 You can implement relay control by means of suitable statements in the ACL that
31010 runs for each RCPT command. For convenience, it is often easiest to use
31011 Exim's named list facility to define the domains and hosts involved. For
31012 example, suppose you want to do the following:
31013
31014 .ilist
31015 Deliver a number of domains to mailboxes on the local host (or process them
31016 locally in some other way). Let's say these are &'my.dom1.example'& and
31017 &'my.dom2.example'&.
31018 .next
31019 Relay mail for a number of other domains for which you are the secondary MX.
31020 These might be &'friend1.example'& and &'friend2.example'&.
31021 .next
31022 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31023 Suppose your LAN is 192.168.45.0/24.
31024 .endlist
31025
31026
31027 In the main part of the configuration, you put the following definitions:
31028 .code
31029 domainlist local_domains    = my.dom1.example : my.dom2.example
31030 domainlist relay_to_domains = friend1.example : friend2.example
31031 hostlist   relay_from_hosts = 192.168.45.0/24
31032 .endd
31033 Now you can use these definitions in the ACL that is run for every RCPT
31034 command:
31035 .code
31036 acl_check_rcpt:
31037   accept domains = +local_domains : +relay_to_domains
31038   accept hosts   = +relay_from_hosts
31039 .endd
31040 The first statement accepts any RCPT command that contains an address in
31041 the local or relay domains. For any other domain, control passes to the second
31042 statement, which accepts the command only if it comes from one of the relay
31043 hosts. In practice, you will probably want to make your ACL more sophisticated
31044 than this, for example, by including sender and recipient verification. The
31045 default configuration includes a more comprehensive example, which is described
31046 in chapter &<<CHAPdefconfil>>&.
31047
31048
31049
31050 .section "Checking a relay configuration" "SECTcheralcon"
31051 .cindex "relaying" "checking control of"
31052 You can check the relay characteristics of your configuration in the same way
31053 that you can test any ACL behaviour for an incoming SMTP connection, by using
31054 the &%-bh%& option to run a fake SMTP session with which you interact.
31055 .ecindex IIDacl
31056
31057
31058
31059 . ////////////////////////////////////////////////////////////////////////////
31060 . ////////////////////////////////////////////////////////////////////////////
31061
31062 .chapter "Content scanning at ACL time" "CHAPexiscan"
31063 .scindex IIDcosca "content scanning" "at ACL time"
31064 The extension of Exim to include content scanning at ACL time, formerly known
31065 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31066 was integrated into the main source for Exim release 4.50, and Tom continues to
31067 maintain it. Most of the wording of this chapter is taken from Tom's
31068 specification.
31069
31070 It is also possible to scan the content of messages at other times. The
31071 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31072 scanning after all the ACLs have run. A transport filter can be used to scan
31073 messages at delivery time (see the &%transport_filter%& option, described in
31074 chapter &<<CHAPtransportgeneric>>&).
31075
31076 If you want to include the ACL-time content-scanning features when you compile
31077 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31078 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31079
31080 .ilist
31081 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31082 for all MIME parts for SMTP and non-SMTP messages, respectively.
31083 .next
31084 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31085 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31086 run at the end of message reception (the &%acl_smtp_data%& ACL).
31087 .next
31088 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31089 of messages, or parts of messages, for debugging purposes.
31090 .next
31091 Additional expansion variables that are set in the new ACL and by the new
31092 conditions.
31093 .next
31094 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31095 .endlist
31096
31097 Content-scanning is continually evolving, and new features are still being
31098 added. While such features are still unstable and liable to incompatible
31099 changes, they are made available in Exim by setting options whose names begin
31100 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31101 this manual. You can find out about them by reading the file called
31102 &_doc/experimental.txt_&.
31103
31104 All the content-scanning facilities work on a MBOX copy of the message that is
31105 temporarily created in a file called:
31106 .display
31107 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31108 .endd
31109 The &_.eml_& extension is a friendly hint to virus scanners that they can
31110 expect an MBOX-like structure inside that file. The file is created when the
31111 first content scanning facility is called. Subsequent calls to content
31112 scanning conditions open the same file again. The directory is recursively
31113 removed when the &%acl_smtp_data%& ACL has finished running, unless
31114 .code
31115 control = no_mbox_unspool
31116 .endd
31117 has been encountered. When the MIME ACL decodes files, they are put into the
31118 same directory by default.
31119
31120
31121
31122 .section "Scanning for viruses" "SECTscanvirus"
31123 .cindex "virus scanning"
31124 .cindex "content scanning" "for viruses"
31125 .cindex "content scanning" "the &%malware%& condition"
31126 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31127 It supports a &"generic"& interface to scanners called via the shell, and
31128 specialized interfaces for &"daemon"& type virus scanners, which are resident
31129 in memory and thus are much faster.
31130
31131 A timeout of 2 minutes is applied to a scanner call (by default);
31132 if it expires then a defer action is taken.
31133
31134 .oindex "&%av_scanner%&"
31135 You can set the &%av_scanner%& option in the main part of the configuration
31136 to specify which scanner to use, together with any additional options that
31137 are needed. The basic syntax is as follows:
31138 .display
31139 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31140 .endd
31141 If you do not set &%av_scanner%&, it defaults to
31142 .code
31143 av_scanner = sophie:/var/run/sophie
31144 .endd
31145 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31146 before use.
31147 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31148 The following scanner types are supported in this release:
31149
31150 .vlist
31151 .vitem &%avast%&
31152 .cindex "virus scanners" "avast"
31153 This is the scanner daemon of Avast. It has been tested with Avast Core
31154 Security (currently at version 1.1.7).
31155 You can get a trial version at &url(http://www.avast.com) or for Linux
31156 at &url(http://www.avast.com/linux-server-antivirus).
31157 This scanner type takes one option,
31158 which can be either a full path to a UNIX socket,
31159 or host and port specifiers separated by white space.
31160 The host may be a name or an IP address; the port is either a
31161 single number or a pair of numbers with a dash between.
31162 Any further options are given, on separate lines,
31163 to the daemon as options before the main scan command.
31164 For example:
31165 .code
31166 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31167 av_scanner = avast:192.168.2.22 5036
31168 .endd
31169 If you omit the argument, the default path
31170 &_/var/run/avast/scan.sock_&
31171 is used.
31172 If you use a remote host,
31173 you need to make Exim's spool directory available to it,
31174 as the scanner is passed a file path, not file contents.
31175 For information about available commands and their options you may use
31176 .code
31177 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31178     FLAGS
31179     SENSITIVITY
31180     PACK
31181 .endd
31182
31183
31184 .vitem &%aveserver%&
31185 .cindex "virus scanners" "Kaspersky"
31186 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31187 at &url(http://www.kaspersky.com). This scanner type takes one option,
31188 which is the path to the daemon's UNIX socket. The default is shown in this
31189 example:
31190 .code
31191 av_scanner = aveserver:/var/run/aveserver
31192 .endd
31193
31194
31195 .vitem &%clamd%&
31196 .cindex "virus scanners" "clamd"
31197 This daemon-type scanner is GPL and free. You can get it at
31198 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31199 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31200 in the MIME ACL. This is no longer believed to be necessary.
31201
31202 The options are a list of server specifiers, which may be
31203 a UNIX socket specification,
31204 a TCP socket specification,
31205 or a (global) option.
31206
31207 A socket specification consists of a space-separated list.
31208 For a Unix socket the first element is a full path for the socket,
31209 for a TCP socket the first element is the IP address
31210 and the second a port number,
31211 Any further elements are per-server (non-global) options.
31212 These per-server options are supported:
31213 .code
31214 retry=<timespec>        Retry on connect fail
31215 .endd
31216
31217 The &`retry`& option specifies a time after which a single retry for
31218 a failed connect is made.  The default is to not retry.
31219
31220 If a Unix socket file is specified, only one server is supported.
31221
31222 Examples:
31223 .code
31224 av_scanner = clamd:/opt/clamd/socket
31225 av_scanner = clamd:192.0.2.3 1234
31226 av_scanner = clamd:192.0.2.3 1234:local
31227 av_scanner = clamd:192.0.2.3 1234 retry=10s
31228 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31229 .endd
31230 If the value of av_scanner points to a UNIX socket file or contains the
31231 &`local`&
31232 option, then the ClamAV interface will pass a filename containing the data
31233 to be scanned, which will should normally result in less I/O happening and be
31234 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31235 Exim does not assume that there is a common filesystem with the remote host.
31236 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31237 you be running a version of ClamAV prior to 0.95.
31238
31239 The final example shows that multiple TCP targets can be specified.  Exim will
31240 randomly use one for each incoming email (i.e. it load balances them).  Note
31241 that only TCP targets may be used if specifying a list of scanners; a UNIX
31242 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31243 unavailable, Exim will try the remaining one(s) until it finds one that works.
31244 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31245 not keep track of scanner state between multiple messages, and the scanner
31246 selection is random, so the message will get logged in the mainlog for each
31247 email that the down scanner gets chosen first (message wrapped to be readable):
31248 .code
31249 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31250    clamd: connection to localhost, port 3310 failed
31251    (Connection refused)
31252 .endd
31253
31254 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31255 contributing the code for this scanner.
31256
31257 .vitem &%cmdline%&
31258 .cindex "virus scanners" "command line interface"
31259 This is the keyword for the generic command line scanner interface. It can be
31260 used to attach virus scanners that are invoked from the shell. This scanner
31261 type takes 3 mandatory options:
31262
31263 .olist
31264 The full path and name of the scanner binary, with all command line options,
31265 and a placeholder (&`%s`&) for the directory to scan.
31266
31267 .next
31268 A regular expression to match against the STDOUT and STDERR output of the
31269 virus scanner. If the expression matches, a virus was found. You must make
31270 absolutely sure that this expression matches on &"virus found"&. This is called
31271 the &"trigger"& expression.
31272
31273 .next
31274 Another regular expression, containing exactly one pair of parentheses, to
31275 match the name of the virus found in the scanners output. This is called the
31276 &"name"& expression.
31277 .endlist olist
31278
31279 For example, Sophos Sweep reports a virus on a line like this:
31280 .code
31281 Virus 'W32/Magistr-B' found in file ./those.bat
31282 .endd
31283 For the trigger expression, we can match the phrase &"found in file"&. For the
31284 name expression, we want to extract the W32/Magistr-B string, so we can match
31285 for the single quotes left and right of it. Altogether, this makes the
31286 configuration setting:
31287 .code
31288 av_scanner = cmdline:\
31289              /path/to/sweep -ss -all -rec -archive %s:\
31290              found in file:'(.+)'
31291 .endd
31292 .vitem &%drweb%&
31293 .cindex "virus scanners" "DrWeb"
31294 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31295 takes one option,
31296 either a full path to a UNIX socket,
31297 or host and port specifiers separated by white space.
31298 The host may be a name or an IP address; the port is either a
31299 single number or a pair of numbers with a dash between.
31300 For example:
31301 .code
31302 av_scanner = drweb:/var/run/drwebd.sock
31303 av_scanner = drweb:192.168.2.20 31337
31304 .endd
31305 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31306 is used. Thanks to Alex Miller for contributing the code for this scanner.
31307
31308 .vitem &%f-protd%&
31309 .cindex "virus scanners" "f-protd"
31310 The f-protd scanner is accessed via HTTP over TCP.
31311 One argument is taken, being a space-separated hostname and port number
31312 (or port-range).
31313 For example:
31314 .code
31315 av_scanner = f-protd:localhost 10200-10204
31316 .endd
31317 If you omit the argument, the default values show above are used.
31318
31319 .vitem &%fsecure%&
31320 .cindex "virus scanners" "F-Secure"
31321 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31322 argument which is the path to a UNIX socket. For example:
31323 .code
31324 av_scanner = fsecure:/path/to/.fsav
31325 .endd
31326 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31327 Thelmen for contributing the code for this scanner.
31328
31329 .vitem &%kavdaemon%&
31330 .cindex "virus scanners" "Kaspersky"
31331 This is the scanner daemon of Kaspersky Version 4. This version of the
31332 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31333 scanner type takes one option, which is the path to the daemon's UNIX socket.
31334 For example:
31335 .code
31336 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31337 .endd
31338 The default path is &_/var/run/AvpCtl_&.
31339
31340 .vitem &%mksd%&
31341 .cindex "virus scanners" "mksd"
31342 This is a daemon type scanner that is aimed mainly at Polish users, though some
31343 parts of documentation are now available in English. You can get it at
31344 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31345 the maximum number of processes used simultaneously to scan the attachments,
31346 provided that mksd has
31347 been run with at least the same number of child processes. For example:
31348 .code
31349 av_scanner = mksd:2
31350 .endd
31351 You can safely omit this option (the default value is 1).
31352
31353 .vitem &%sock%&
31354 .cindex "virus scanners" "simple socket-connected"
31355 This is a general-purpose way of talking to simple scanner daemons
31356 running on the local machine.
31357 There are four options:
31358 an address (which may be an IP address and port, or the path of a Unix socket),
31359 a commandline to send (may include a single %s which will be replaced with
31360 the path to the mail file to be scanned),
31361 an RE to trigger on from the returned data,
31362 an RE to extract malware_name from the returned data.
31363 For example:
31364 .code
31365 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31366 .endd
31367 Default for the socket specifier is &_/tmp/malware.sock_&.
31368 Default for the commandline is &_%s\n_&.
31369 Both regular-expressions are required.
31370
31371 .vitem &%sophie%&
31372 .cindex "virus scanners" "Sophos and Sophie"
31373 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31374 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31375 for this scanner type is the path to the UNIX socket that Sophie uses for
31376 client communication. For example:
31377 .code
31378 av_scanner = sophie:/tmp/sophie
31379 .endd
31380 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31381 the option.
31382 .endlist
31383
31384 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31385 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31386 ACL.
31387
31388 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31389 makes it possible to use different scanners. See further below for an example.
31390 The &%malware%& condition caches its results, so when you use it multiple times
31391 for the same message, the actual scanning process is only carried out once.
31392 However, using expandable items in &%av_scanner%& disables this caching, in
31393 which case each use of the &%malware%& condition causes a new scan of the
31394 message.
31395
31396 The &%malware%& condition takes a right-hand argument that is expanded before
31397 use and taken as a list, slash-separated by default.
31398 The first element can then be one of
31399
31400 .ilist
31401 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31402 The condition succeeds if a virus was found, and fail otherwise. This is the
31403 recommended usage.
31404 .next
31405 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31406 the condition fails immediately.
31407 .next
31408 A regular expression, in which case the message is scanned for viruses. The
31409 condition succeeds if a virus is found and its name matches the regular
31410 expression. This allows you to take special actions on certain types of virus.
31411 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31412 unless the separator is changed (in the usual way).
31413 .endlist
31414
31415 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31416 messages even if there is a problem with the virus scanner.
31417 Otherwise, such a problem causes the ACL to defer.
31418
31419 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31420 specify a non-default timeout.  The default is two minutes.
31421 For example:
31422 .code
31423 malware = * / defer_ok / tmo=10s
31424 .endd
31425 A timeout causes the ACL to defer.
31426
31427 .vindex "&$callout_address$&"
31428 When a connection is made to the scanner the expansion variable &$callout_address$&
31429 is set to record the actual address used.
31430
31431 .vindex "&$malware_name$&"
31432 When a virus is found, the condition sets up an expansion variable called
31433 &$malware_name$& that contains the name of the virus. You can use it in a
31434 &%message%& modifier that specifies the error returned to the sender, and/or in
31435 logging data.
31436
31437 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31438 imposed by your anti-virus scanner.
31439
31440 Here is a very simple scanning example:
31441 .code
31442 deny message = This message contains malware ($malware_name)
31443      malware = *
31444 .endd
31445 The next example accepts messages when there is a problem with the scanner:
31446 .code
31447 deny message = This message contains malware ($malware_name)
31448      malware = */defer_ok
31449 .endd
31450 The next example shows how to use an ACL variable to scan with both sophie and
31451 aveserver. It assumes you have set:
31452 .code
31453 av_scanner = $acl_m0
31454 .endd
31455 in the main Exim configuration.
31456 .code
31457 deny message = This message contains malware ($malware_name)
31458      set acl_m0 = sophie
31459      malware = *
31460
31461 deny message = This message contains malware ($malware_name)
31462      set acl_m0 = aveserver
31463      malware = *
31464 .endd
31465
31466
31467 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31468 .cindex "content scanning" "for spam"
31469 .cindex "spam scanning"
31470 .cindex "SpamAssassin"
31471 .cindex "Rspamd"
31472 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31473 score and a report for the message.
31474 Support is also provided for Rspamd.
31475
31476 For more information about installation and configuration of SpamAssassin or
31477 Rspamd refer to their respective websites at
31478 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31479
31480 SpamAssassin can be installed with CPAN by running:
31481 .code
31482 perl -MCPAN -e 'install Mail::SpamAssassin'
31483 .endd
31484 SpamAssassin has its own set of configuration files. Please review its
31485 documentation to see how you can tweak it. The default installation should work
31486 nicely, however.
31487
31488 .oindex "&%spamd_address%&"
31489 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31490 intend to use an instance running on the local host you do not need to set
31491 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31492 you must set the &%spamd_address%& option in the global part of the Exim
31493 configuration as follows (example):
31494 .code
31495 spamd_address = 192.168.99.45 387
31496 .endd
31497
31498 To use Rspamd (which by default listens on all local addresses
31499 on TCP port 11333)
31500 you should add &%variant=rspamd%& after the address/port pair, for example:
31501 .code
31502 spamd_address = 127.0.0.1 11333 variant=rspamd
31503 .endd
31504
31505 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31506 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31507 file name instead of an address/port pair:
31508 .code
31509 spamd_address = /var/run/spamd_socket
31510 .endd
31511 You can have multiple &%spamd%& servers to improve scalability. These can
31512 reside on other hardware reachable over the network. To specify multiple
31513 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31514 option, separated with colons (the separator can be changed in the usual way):
31515 .code
31516 spamd_address = 192.168.2.10 783 : \
31517                 192.168.2.11 783 : \
31518                 192.168.2.12 783
31519 .endd
31520 Up to 32 &%spamd%& servers are supported.
31521 When a server fails to respond to the connection attempt, all other
31522 servers are tried until one succeeds. If no server responds, the &%spam%&
31523 condition defers.
31524
31525 Unix and TCP socket specifications may be mixed in any order.
31526 Each element of the list is a list itself, space-separated by default
31527 and changeable in the usual way.
31528
31529 For TCP socket specifications a host name or IP (v4 or v6, but
31530 subject to list-separator quoting rules) address can be used,
31531 and the port can be one or a dash-separated pair.
31532 In the latter case, the range is tried in strict order.
31533
31534 Elements after the first for Unix sockets, or second for TCP socket,
31535 are options.
31536 The supported options are:
31537 .code
31538 pri=<priority>      Selection priority
31539 weight=<value>      Selection bias
31540 time=<start>-<end>  Use only between these times of day
31541 retry=<timespec>    Retry on connect fail
31542 tmo=<timespec>      Connection time limit
31543 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31544 .endd
31545
31546 The &`pri`& option specifies a priority for the server within the list,
31547 higher values being tried first.
31548 The default priority is 1.
31549
31550 The &`weight`& option specifies a selection bias.
31551 Within a priority set
31552 servers are queried in a random fashion, weighted by this value.
31553 The default value for selection bias is 1.
31554
31555 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31556 in the local time zone; each element being one or more digits.
31557 Either the seconds or both minutes and seconds, plus the leading &`.`&
31558 characters, may be omitted and will be taken as zero.
31559
31560 Timeout specifications for the &`retry`& and &`tmo`& options
31561 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31562
31563 The &`tmo`& option specifies an overall timeout for communication.
31564 The default value is two minutes.
31565
31566 The &`retry`& option specifies a time after which a single retry for
31567 a failed connect is made.
31568 The default is to not retry.
31569
31570 The &%spamd_address%& variable is expanded before use if it starts with
31571 a dollar sign. In this case, the expansion may return a string that is
31572 used as the list so that multiple spamd servers can be the result of an
31573 expansion.
31574
31575 .vindex "&$callout_address$&"
31576 When a connection is made to the server the expansion variable &$callout_address$&
31577 is set to record the actual address used.
31578
31579 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31580 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31581 .code
31582 deny message = This message was classified as SPAM
31583      spam = joe
31584 .endd
31585 The right-hand side of the &%spam%& condition specifies a name. This is
31586 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31587 to scan using a specific profile, but rather use the SpamAssassin system-wide
31588 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31589 Rspamd does not use this setting. However, you must put something on the
31590 right-hand side.
31591
31592 The name allows you to use per-domain or per-user antispam profiles in
31593 principle, but this is not straightforward in practice, because a message may
31594 have multiple recipients, not necessarily all in the same domain. Because the
31595 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31596 read the contents of the message, the variables &$local_part$& and &$domain$&
31597 are not set.
31598 Careful enforcement of single-recipient messages
31599 (e.g. by responding with defer in the recipient ACL for all recipients
31600 after the first),
31601 or the use of PRDR,
31602 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31603 are needed to use this feature.
31604
31605 The right-hand side of the &%spam%& condition is expanded before being used, so
31606 you can put lookups or conditions there. When the right-hand side evaluates to
31607 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31608
31609
31610 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31611 large ones may cause significant performance degradation. As most spam messages
31612 are quite small, it is recommended that you do not scan the big ones. For
31613 example:
31614 .code
31615 deny message = This message was classified as SPAM
31616      condition = ${if < {$message_size}{10K}}
31617      spam = nobody
31618 .endd
31619
31620 The &%spam%& condition returns true if the threshold specified in the user's
31621 SpamAssassin profile has been matched or exceeded. If you want to use the
31622 &%spam%& condition for its side effects (see the variables below), you can make
31623 it always return &"true"& by appending &`:true`& to the username.
31624
31625 .cindex "spam scanning" "returned variables"
31626 When the &%spam%& condition is run, it sets up a number of expansion
31627 variables.
31628 Except for &$spam_report$&,
31629 these variables are saved with the received message so are
31630 available for use at delivery time.
31631
31632 .vlist
31633 .vitem &$spam_score$&
31634 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31635 for inclusion in log or reject messages.
31636
31637 .vitem &$spam_score_int$&
31638 The spam score of the message, multiplied by ten, as an integer value. For
31639 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31640 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31641 The integer value is useful for numeric comparisons in conditions.
31642
31643 .vitem &$spam_bar$&
31644 A string consisting of a number of &"+"& or &"-"& characters, representing the
31645 integer part of the spam score value. A spam score of 4.4 would have a
31646 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31647 headers, since MUAs can match on such strings. The maximum length of the
31648 spam bar is 50 characters.
31649
31650 .vitem &$spam_report$&
31651 A multiline text table, containing the full SpamAssassin report for the
31652 message. Useful for inclusion in headers or reject messages.
31653 This variable is only usable in a DATA-time ACL.
31654
31655 .vitem &$spam_action$&
31656 For SpamAssassin either 'reject' or 'no action' depending on the
31657 spam score versus threshold.
31658 For Rspamd, the recommended action.
31659
31660 .endlist
31661
31662 The &%spam%& condition caches its results unless expansion in
31663 spamd_address was used. If you call it again with the same user name, it
31664 does not scan again, but rather returns the same values as before.
31665
31666 The &%spam%& condition returns DEFER if there is any error while running
31667 the message through SpamAssassin or if the expansion of spamd_address
31668 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31669 statement block), append &`/defer_ok`& to the right-hand side of the
31670 spam condition, like this:
31671 .code
31672 deny message = This message was classified as SPAM
31673      spam    = joe/defer_ok
31674 .endd
31675 This causes messages to be accepted even if there is a problem with &%spamd%&.
31676
31677 Here is a longer, commented example of the use of the &%spam%&
31678 condition:
31679 .code
31680 # put headers in all messages (no matter if spam or not)
31681 warn  spam = nobody:true
31682       add_header = X-Spam-Score: $spam_score ($spam_bar)
31683       add_header = X-Spam-Report: $spam_report
31684
31685 # add second subject line with *SPAM* marker when message
31686 # is over threshold
31687 warn  spam = nobody
31688       add_header = Subject: *SPAM* $h_Subject:
31689
31690 # reject spam at high scores (> 12)
31691 deny  message = This message scored $spam_score spam points.
31692       spam = nobody:true
31693       condition = ${if >{$spam_score_int}{120}{1}{0}}
31694 .endd
31695
31696
31697
31698 .section "Scanning MIME parts" "SECTscanmimepart"
31699 .cindex "content scanning" "MIME parts"
31700 .cindex "MIME content scanning"
31701 .oindex "&%acl_smtp_mime%&"
31702 .oindex "&%acl_not_smtp_mime%&"
31703 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31704 each MIME part of an SMTP message, including multipart types, in the sequence
31705 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31706 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31707 options may both refer to the same ACL if you want the same processing in both
31708 cases.
31709
31710 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31711 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31712 the case of a non-SMTP message. However, a MIME ACL is called only if the
31713 message contains a &'Content-Type:'& header line. When a call to a MIME
31714 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31715 result code is sent to the client. In the case of an SMTP message, the
31716 &%acl_smtp_data%& ACL is not called when this happens.
31717
31718 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31719 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31720 condition to match against the raw MIME part. You can also use the
31721 &%mime_regex%& condition to match against the decoded MIME part (see section
31722 &<<SECTscanregex>>&).
31723
31724 At the start of a MIME ACL, a number of variables are set from the header
31725 information for the relevant MIME part. These are described below. The contents
31726 of the MIME part are not by default decoded into a disk file except for MIME
31727 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31728 part into a disk file, you can use the &%decode%& condition. The general
31729 syntax is:
31730 .display
31731 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31732 .endd
31733 The right hand side is expanded before use. After expansion,
31734 the value can be:
31735
31736 .olist
31737 &"0"& or &"false"&, in which case no decoding is done.
31738 .next
31739 The string &"default"&. In that case, the file is put in the temporary
31740 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31741 a sequential file name consisting of the message id and a sequence number. The
31742 full path and name is available in &$mime_decoded_filename$& after decoding.
31743 .next
31744 A full path name starting with a slash. If the full name is an existing
31745 directory, it is used as a replacement for the default directory. The filename
31746 is then sequentially assigned. If the path does not exist, it is used as
31747 the full path and file name.
31748 .next
31749 If the string does not start with a slash, it is used as the
31750 filename, and the default path is then used.
31751 .endlist
31752 The &%decode%& condition normally succeeds. It is only false for syntax
31753 errors or unusual circumstances such as memory shortages. You can easily decode
31754 a file with its original, proposed filename using
31755 .code
31756 decode = $mime_filename
31757 .endd
31758 However, you should keep in mind that &$mime_filename$& might contain
31759 anything. If you place files outside of the default path, they are not
31760 automatically unlinked.
31761
31762 For RFC822 attachments (these are messages attached to messages, with a
31763 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31764 as for the primary message, only that the &$mime_is_rfc822$& expansion
31765 variable is set (see below). Attached messages are always decoded to disk
31766 before being checked, and the files are unlinked once the check is done.
31767
31768 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31769 used to match regular expressions against raw and decoded MIME parts,
31770 respectively. They are described in section &<<SECTscanregex>>&.
31771
31772 .cindex "MIME content scanning" "returned variables"
31773 The following list describes all expansion variables that are
31774 available in the MIME ACL:
31775
31776 .vlist
31777 .vitem &$mime_boundary$&
31778 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31779 have a boundary string, which is stored in this variable. If the current part
31780 has no boundary parameter in the &'Content-Type:'& header, this variable
31781 contains the empty string.
31782
31783 .vitem &$mime_charset$&
31784 This variable contains the character set identifier, if one was found in the
31785 &'Content-Type:'& header. Examples for charset identifiers are:
31786 .code
31787 us-ascii
31788 gb2312 (Chinese)
31789 iso-8859-1
31790 .endd
31791 Please note that this value is not normalized, so you should do matches
31792 case-insensitively.
31793
31794 .vitem &$mime_content_description$&
31795 This variable contains the normalized content of the &'Content-Description:'&
31796 header. It can contain a human-readable description of the parts content. Some
31797 implementations repeat the filename for attachments here, but they are usually
31798 only used for display purposes.
31799
31800 .vitem &$mime_content_disposition$&
31801 This variable contains the normalized content of the &'Content-Disposition:'&
31802 header. You can expect strings like &"attachment"& or &"inline"& here.
31803
31804 .vitem &$mime_content_id$&
31805 This variable contains the normalized content of the &'Content-ID:'& header.
31806 This is a unique ID that can be used to reference a part from another part.
31807
31808 .vitem &$mime_content_size$&
31809 This variable is set only after the &%decode%& modifier (see above) has been
31810 successfully run. It contains the size of the decoded part in kilobytes. The
31811 size is always rounded up to full kilobytes, so only a completely empty part
31812 has a &$mime_content_size$& of zero.
31813
31814 .vitem &$mime_content_transfer_encoding$&
31815 This variable contains the normalized content of the
31816 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31817 type. Typical values are &"base64"& and &"quoted-printable"&.
31818
31819 .vitem &$mime_content_type$&
31820 If the MIME part has a &'Content-Type:'& header, this variable contains its
31821 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31822 are some examples of popular MIME types, as they may appear in this variable:
31823 .code
31824 text/plain
31825 text/html
31826 application/octet-stream
31827 image/jpeg
31828 audio/midi
31829 .endd
31830 If the MIME part has no &'Content-Type:'& header, this variable contains the
31831 empty string.
31832
31833 .vitem &$mime_decoded_filename$&
31834 This variable is set only after the &%decode%& modifier (see above) has been
31835 successfully run. It contains the full path and file name of the file
31836 containing the decoded data.
31837 .endlist
31838
31839 .cindex "RFC 2047"
31840 .vlist
31841 .vitem &$mime_filename$&
31842 This is perhaps the most important of the MIME variables. It contains a
31843 proposed filename for an attachment, if one was found in either the
31844 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31845 RFC2047
31846 or RFC2231
31847 decoded, but no additional sanity checks are done.
31848  If no filename was
31849 found, this variable contains the empty string.
31850
31851 .vitem &$mime_is_coverletter$&
31852 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31853 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31854 content in the cover letter, while not restricting attachments at all.
31855
31856 The variable contains 1 (true) for a MIME part believed to be part of the
31857 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31858 follows:
31859
31860 .olist
31861 The outermost MIME part of a message is always a cover letter.
31862
31863 .next
31864 If a multipart/alternative or multipart/related MIME part is a cover letter,
31865 so are all MIME subparts within that multipart.
31866
31867 .next
31868 If any other multipart is a cover letter, the first subpart is a cover letter,
31869 and the rest are attachments.
31870
31871 .next
31872 All parts contained within an attachment multipart are attachments.
31873 .endlist olist
31874
31875 As an example, the following will ban &"HTML mail"& (including that sent with
31876 alternative plain text), while allowing HTML files to be attached. HTML
31877 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31878 .code
31879 deny message = HTML mail is not accepted here
31880 !condition = $mime_is_rfc822
31881 condition = $mime_is_coverletter
31882 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31883 .endd
31884 .vitem &$mime_is_multipart$&
31885 This variable has the value 1 (true) when the current part has the main type
31886 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31887 Since multipart entities only serve as containers for other parts, you may not
31888 want to carry out specific actions on them.
31889
31890 .vitem &$mime_is_rfc822$&
31891 This variable has the value 1 (true) if the current part is not a part of the
31892 checked message itself, but part of an attached message. Attached message
31893 decoding is fully recursive.
31894
31895 .vitem &$mime_part_count$&
31896 This variable is a counter that is raised for each processed MIME part. It
31897 starts at zero for the very first part (which is usually a multipart). The
31898 counter is per-message, so it is reset when processing RFC822 attachments (see
31899 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31900 complete, so you can use it in the DATA ACL to determine the number of MIME
31901 parts of a message. For non-MIME messages, this variable contains the value -1.
31902 .endlist
31903
31904
31905
31906 .section "Scanning with regular expressions" "SECTscanregex"
31907 .cindex "content scanning" "with regular expressions"
31908 .cindex "regular expressions" "content scanning with"
31909 You can specify your own custom regular expression matches on the full body of
31910 the message, or on individual MIME parts.
31911
31912 The &%regex%& condition takes one or more regular expressions as arguments and
31913 matches them against the full message (when called in the DATA ACL) or a raw
31914 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31915 linewise, with a maximum line length of 32K characters. That means you cannot
31916 have multiline matches with the &%regex%& condition.
31917
31918 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31919 to 32K of decoded content (the whole content at once, not linewise). If the
31920 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31921 is decoded automatically when &%mime_regex%& is executed (using default path
31922 and filename values). If the decoded data is larger than  32K, only the first
31923 32K characters are checked.
31924
31925 The regular expressions are passed as a colon-separated list. To include a
31926 literal colon, you must double it. Since the whole right-hand side string is
31927 expanded before being used, you must also escape dollar signs and backslashes
31928 with more backslashes, or use the &`\N`& facility to disable expansion.
31929 Here is a simple example that contains two regular expressions:
31930 .code
31931 deny message = contains blacklisted regex ($regex_match_string)
31932      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31933 .endd
31934 The conditions returns true if any one of the regular expressions matches. The
31935 &$regex_match_string$& expansion variable is then set up and contains the
31936 matching regular expression.
31937 The expansion variables &$regex1$& &$regex2$& etc
31938 are set to any substrings captured by the regular expression.
31939
31940 &*Warning*&: With large messages, these conditions can be fairly
31941 CPU-intensive.
31942
31943 .ecindex IIDcosca
31944
31945
31946
31947
31948 . ////////////////////////////////////////////////////////////////////////////
31949 . ////////////////////////////////////////////////////////////////////////////
31950
31951 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31952          "Local scan function"
31953 .scindex IIDlosca "&[local_scan()]& function" "description of"
31954 .cindex "customizing" "input scan using C function"
31955 .cindex "policy control" "by local scan function"
31956 In these days of email worms, viruses, and ever-increasing spam, some sites
31957 want to apply a lot of checking to messages before accepting them.
31958
31959 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31960 passing messages to external virus and spam scanning software. You can also do
31961 a certain amount in Exim itself through string expansions and the &%condition%&
31962 condition in the ACL that runs after the SMTP DATA command or the ACL for
31963 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31964
31965 To allow for further customization to a site's own requirements, there is the
31966 possibility of linking Exim with a private message scanning function, written
31967 in C. If you want to run code that is written in something other than C, you
31968 can of course use a little C stub to call it.
31969
31970 The local scan function is run once for every incoming message, at the point
31971 when Exim is just about to accept the message.
31972 It can therefore be used to control non-SMTP messages from local processes as
31973 well as messages arriving via SMTP.
31974
31975 Exim applies a timeout to calls of the local scan function, and there is an
31976 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31977 Zero means &"no timeout"&.
31978 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31979 before calling the local scan function, so that the most common types of crash
31980 are caught. If the timeout is exceeded or one of those signals is caught, the
31981 incoming message is rejected with a temporary error if it is an SMTP message.
31982 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31983 code. The incident is logged on the main and reject logs.
31984
31985
31986
31987 .section "Building Exim to use a local scan function" "SECID207"
31988 .cindex "&[local_scan()]& function" "building Exim to use"
31989 To make use of the local scan function feature, you must tell Exim where your
31990 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31991 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31992 directory, so you might set
31993 .code
31994 LOCAL_SCAN_SOURCE=Local/local_scan.c
31995 .endd
31996 for example. The function must be called &[local_scan()]&. It is called by
31997 Exim after it has received a message, when the success return code is about to
31998 be sent. This is after all the ACLs have been run. The return code from your
31999 function controls whether the message is actually accepted or not. There is a
32000 commented template function (that just accepts the message) in the file
32001 _src/local_scan.c_.
32002
32003 If you want to make use of Exim's run time configuration file to set options
32004 for your &[local_scan()]& function, you must also set
32005 .code
32006 LOCAL_SCAN_HAS_OPTIONS=yes
32007 .endd
32008 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32009
32010
32011
32012
32013 .section "API for local_scan()" "SECTapiforloc"
32014 .cindex "&[local_scan()]& function" "API description"
32015 You must include this line near the start of your code:
32016 .code
32017 #include "local_scan.h"
32018 .endd
32019 This header file defines a number of variables and other values, and the
32020 prototype for the function itself. Exim is coded to use unsigned char values
32021 almost exclusively, and one of the things this header defines is a shorthand
32022 for &`unsigned char`& called &`uschar`&.
32023 It also contains the following macro definitions, to simplify casting character
32024 strings and pointers to character strings:
32025 .code
32026 #define CS   (char *)
32027 #define CCS  (const char *)
32028 #define CSS  (char **)
32029 #define US   (unsigned char *)
32030 #define CUS  (const unsigned char *)
32031 #define USS  (unsigned char **)
32032 .endd
32033 The function prototype for &[local_scan()]& is:
32034 .code
32035 extern int local_scan(int fd, uschar **return_text);
32036 .endd
32037 The arguments are as follows:
32038
32039 .ilist
32040 &%fd%& is a file descriptor for the file that contains the body of the message
32041 (the -D file). The file is open for reading and writing, but updating it is not
32042 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32043
32044 The descriptor is positioned at character 19 of the file, which is the first
32045 character of the body itself, because the first 19 characters are the message
32046 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32047 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32048 case this changes in some future version.
32049 .next
32050 &%return_text%& is an address which you can use to return a pointer to a text
32051 string at the end of the function. The value it points to on entry is NULL.
32052 .endlist
32053
32054 The function must return an &%int%& value which is one of the following macros:
32055
32056 .vlist
32057 .vitem &`LOCAL_SCAN_ACCEPT`&
32058 .vindex "&$local_scan_data$&"
32059 The message is accepted. If you pass back a string of text, it is saved with
32060 the message, and made available in the variable &$local_scan_data$&. No
32061 newlines are permitted (if there are any, they are turned into spaces) and the
32062 maximum length of text is 1000 characters.
32063
32064 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32065 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32066 queued without immediate delivery, and is frozen.
32067
32068 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32069 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32070 queued without immediate delivery.
32071
32072 .vitem &`LOCAL_SCAN_REJECT`&
32073 The message is rejected; the returned text is used as an error message which is
32074 passed back to the sender and which is also logged. Newlines are permitted &--
32075 they cause a multiline response for SMTP rejections, but are converted to
32076 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32077 used.
32078
32079 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32080 The message is temporarily rejected; the returned text is used as an error
32081 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32082 problem"& is used.
32083
32084 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32085 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32086 message is not written to the reject log. It has the effect of unsetting the
32087 &%rejected_header%& log selector for just this rejection. If
32088 &%rejected_header%& is already unset (see the discussion of the
32089 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32090 same as LOCAL_SCAN_REJECT.
32091
32092 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32093 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32094 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32095 .endlist
32096
32097 If the message is not being received by interactive SMTP, rejections are
32098 reported by writing to &%stderr%& or by sending an email, as configured by the
32099 &%-oe%& command line options.
32100
32101
32102
32103 .section "Configuration options for local_scan()" "SECTconoptloc"
32104 .cindex "&[local_scan()]& function" "configuration options"
32105 It is possible to have option settings in the main configuration file
32106 that set values in static variables in the &[local_scan()]& module. If you
32107 want to do this, you must have the line
32108 .code
32109 LOCAL_SCAN_HAS_OPTIONS=yes
32110 .endd
32111 in your &_Local/Makefile_& when you build Exim. (This line is in
32112 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32113 file, you must define static variables to hold the option values, and a table
32114 to define them.
32115
32116 The table must be a vector called &%local_scan_options%&, of type
32117 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32118 and a pointer to the variable that holds the value. The entries must appear in
32119 alphabetical order. Following &%local_scan_options%& you must also define a
32120 variable called &%local_scan_options_count%& that contains the number of
32121 entries in the table. Here is a short example, showing two kinds of option:
32122 .code
32123 static int my_integer_option = 42;
32124 static uschar *my_string_option = US"a default string";
32125
32126 optionlist local_scan_options[] = {
32127   { "my_integer", opt_int,       &my_integer_option },
32128   { "my_string",  opt_stringptr, &my_string_option }
32129 };
32130
32131 int local_scan_options_count =
32132   sizeof(local_scan_options)/sizeof(optionlist);
32133 .endd
32134 The values of the variables can now be changed from Exim's runtime
32135 configuration file by including a local scan section as in this example:
32136 .code
32137 begin local_scan
32138 my_integer = 99
32139 my_string = some string of text...
32140 .endd
32141 The available types of option data are as follows:
32142
32143 .vlist
32144 .vitem &*opt_bool*&
32145 This specifies a boolean (true/false) option. The address should point to a
32146 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32147 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32148 whether such a variable has been set at all, you can initialize it to
32149 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32150 values.)
32151
32152 .vitem &*opt_fixed*&
32153 This specifies a fixed point number, such as is used for load averages.
32154 The address should point to a variable of type &`int`&. The value is stored
32155 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32156
32157 .vitem &*opt_int*&
32158 This specifies an integer; the address should point to a variable of type
32159 &`int`&. The value may be specified in any of the integer formats accepted by
32160 Exim.
32161
32162 .vitem &*opt_mkint*&
32163 This is the same as &%opt_int%&, except that when such a value is output in a
32164 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32165 printed with the suffix K or M.
32166
32167 .vitem &*opt_octint*&
32168 This also specifies an integer, but the value is always interpreted as an
32169 octal integer, whether or not it starts with the digit zero, and it is
32170 always output in octal.
32171
32172 .vitem &*opt_stringptr*&
32173 This specifies a string value; the address must be a pointer to a
32174 variable that points to a string (for example, of type &`uschar *`&).
32175
32176 .vitem &*opt_time*&
32177 This specifies a time interval value. The address must point to a variable of
32178 type &`int`&. The value that is placed there is a number of seconds.
32179 .endlist
32180
32181 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32182 out the values of all the &[local_scan()]& options.
32183
32184
32185
32186 .section "Available Exim variables" "SECID208"
32187 .cindex "&[local_scan()]& function" "available Exim variables"
32188 The header &_local_scan.h_& gives you access to a number of C variables. These
32189 are the only ones that are guaranteed to be maintained from release to release.
32190 Note, however, that you can obtain the value of any Exim expansion variable,
32191 including &$recipients$&, by calling &'expand_string()'&. The exported
32192 C variables are as follows:
32193
32194 .vlist
32195 .vitem &*int&~body_linecount*&
32196 This variable contains the number of lines in the message's body.
32197
32198 .vitem &*int&~body_zerocount*&
32199 This variable contains the number of binary zero bytes in the message's body.
32200
32201 .vitem &*unsigned&~int&~debug_selector*&
32202 This variable is set to zero when no debugging is taking place. Otherwise, it
32203 is a bitmap of debugging selectors. Two bits are identified for use in
32204 &[local_scan()]&; they are defined as macros:
32205
32206 .ilist
32207 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32208 testing option that is not privileged &-- any caller may set it. All the
32209 other selector bits can be set only by admin users.
32210
32211 .next
32212 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32213 by the &`+local_scan`& debug selector. It is not included in the default set
32214 of debugging bits.
32215 .endlist ilist
32216
32217 Thus, to write to the debugging output only when &`+local_scan`& has been
32218 selected, you should use code like this:
32219 .code
32220 if ((debug_selector & D_local_scan) != 0)
32221   debug_printf("xxx", ...);
32222 .endd
32223 .vitem &*uschar&~*expand_string_message*&
32224 After a failing call to &'expand_string()'& (returned value NULL), the
32225 variable &%expand_string_message%& contains the error message, zero-terminated.
32226
32227 .vitem &*header_line&~*header_list*&
32228 A pointer to a chain of header lines. The &%header_line%& structure is
32229 discussed below.
32230
32231 .vitem &*header_line&~*header_last*&
32232 A pointer to the last of the header lines.
32233
32234 .vitem &*uschar&~*headers_charset*&
32235 The value of the &%headers_charset%& configuration option.
32236
32237 .vitem &*BOOL&~host_checking*&
32238 This variable is TRUE during a host checking session that is initiated by the
32239 &%-bh%& command line option.
32240
32241 .vitem &*uschar&~*interface_address*&
32242 The IP address of the interface that received the message, as a string. This
32243 is NULL for locally submitted messages.
32244
32245 .vitem &*int&~interface_port*&
32246 The port on which this message was received. When testing with the &%-bh%&
32247 command line option, the value of this variable is -1 unless a port has been
32248 specified via the &%-oMi%& option.
32249
32250 .vitem &*uschar&~*message_id*&
32251 This variable contains Exim's message id for the incoming message (the value of
32252 &$message_exim_id$&) as a zero-terminated string.
32253
32254 .vitem &*uschar&~*received_protocol*&
32255 The name of the protocol by which the message was received.
32256
32257 .vitem &*int&~recipients_count*&
32258 The number of accepted recipients.
32259
32260 .vitem &*recipient_item&~*recipients_list*&
32261 .cindex "recipient" "adding in local scan"
32262 .cindex "recipient" "removing in local scan"
32263 The list of accepted recipients, held in a vector of length
32264 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32265 can add additional recipients by calling &'receive_add_recipient()'& (see
32266 below). You can delete recipients by removing them from the vector and
32267 adjusting the value in &%recipients_count%&. In particular, by setting
32268 &%recipients_count%& to zero you remove all recipients. If you then return the
32269 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32270 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32271 and then call &'receive_add_recipient()'& as often as needed.
32272
32273 .vitem &*uschar&~*sender_address*&
32274 The envelope sender address. For bounce messages this is the empty string.
32275
32276 .vitem &*uschar&~*sender_host_address*&
32277 The IP address of the sending host, as a string. This is NULL for
32278 locally-submitted messages.
32279
32280 .vitem &*uschar&~*sender_host_authenticated*&
32281 The name of the authentication mechanism that was used, or NULL if the message
32282 was not received over an authenticated SMTP connection.
32283
32284 .vitem &*uschar&~*sender_host_name*&
32285 The name of the sending host, if known.
32286
32287 .vitem &*int&~sender_host_port*&
32288 The port on the sending host.
32289
32290 .vitem &*BOOL&~smtp_input*&
32291 This variable is TRUE for all SMTP input, including BSMTP.
32292
32293 .vitem &*BOOL&~smtp_batched_input*&
32294 This variable is TRUE for BSMTP input.
32295
32296 .vitem &*int&~store_pool*&
32297 The contents of this variable control which pool of memory is used for new
32298 requests. See section &<<SECTmemhanloc>>& for details.
32299 .endlist
32300
32301
32302 .section "Structure of header lines" "SECID209"
32303 The &%header_line%& structure contains the members listed below.
32304 You can add additional header lines by calling the &'header_add()'& function
32305 (see below). You can cause header lines to be ignored (deleted) by setting
32306 their type to *.
32307
32308
32309 .vlist
32310 .vitem &*struct&~header_line&~*next*&
32311 A pointer to the next header line, or NULL for the last line.
32312
32313 .vitem &*int&~type*&
32314 A code identifying certain headers that Exim recognizes. The codes are printing
32315 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32316 Notice in particular that any header line whose type is * is not transmitted
32317 with the message. This flagging is used for header lines that have been
32318 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32319 lines.) Effectively, * means &"deleted"&.
32320
32321 .vitem &*int&~slen*&
32322 The number of characters in the header line, including the terminating and any
32323 internal newlines.
32324
32325 .vitem &*uschar&~*text*&
32326 A pointer to the text of the header. It always ends with a newline, followed by
32327 a zero byte. Internal newlines are preserved.
32328 .endlist
32329
32330
32331
32332 .section "Structure of recipient items" "SECID210"
32333 The &%recipient_item%& structure contains these members:
32334
32335 .vlist
32336 .vitem &*uschar&~*address*&
32337 This is a pointer to the recipient address as it was received.
32338
32339 .vitem &*int&~pno*&
32340 This is used in later Exim processing when top level addresses are created by
32341 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32342 and must always contain -1 at this stage.
32343
32344 .vitem &*uschar&~*errors_to*&
32345 If this value is not NULL, bounce messages caused by failing to deliver to the
32346 recipient are sent to the address it contains. In other words, it overrides the
32347 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32348 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32349 an unqualified address, Exim qualifies it using the domain from
32350 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32351 is NULL for all recipients.
32352 .endlist
32353
32354
32355
32356 .section "Available Exim functions" "SECID211"
32357 .cindex "&[local_scan()]& function" "available Exim functions"
32358 The header &_local_scan.h_& gives you access to a number of Exim functions.
32359 These are the only ones that are guaranteed to be maintained from release to
32360 release:
32361
32362 .vlist
32363 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32364        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32365
32366 This function creates a child process that runs the command specified by
32367 &%argv%&. The environment for the process is specified by &%envp%&, which can
32368 be NULL if no environment variables are to be passed. A new umask is supplied
32369 for the process in &%newumask%&.
32370
32371 Pipes to the standard input and output of the new process are set up
32372 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32373 standard error is cloned to the standard output. If there are any file
32374 descriptors &"in the way"& in the new process, they are closed. If the final
32375 argument is TRUE, the new process is made into a process group leader.
32376
32377 The function returns the pid of the new process, or -1 if things go wrong.
32378
32379 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32380 This function waits for a child process to terminate, or for a timeout (in
32381 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32382 return value is as follows:
32383
32384 .ilist
32385 >= 0
32386
32387 The process terminated by a normal exit and the value is the process
32388 ending status.
32389
32390 .next
32391 < 0 and > &--256
32392
32393 The process was terminated by a signal and the value is the negation of the
32394 signal number.
32395
32396 .next
32397 &--256
32398
32399 The process timed out.
32400 .next
32401 &--257
32402
32403 The was some other error in wait(); &%errno%& is still set.
32404 .endlist
32405
32406 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32407 This function provide you with a means of submitting a new message to
32408 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32409 want, but this packages it all up for you.) The function creates a pipe,
32410 forks a subprocess that is running
32411 .code
32412 exim -t -oem -oi -f <>
32413 .endd
32414 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32415 that is connected to the standard input. The yield of the function is the PID
32416 of the subprocess. You can then write a message to the file descriptor, with
32417 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32418
32419 When you have finished, call &'child_close()'& to wait for the process to
32420 finish and to collect its ending status. A timeout value of zero is usually
32421 fine in this circumstance. Unless you have made a mistake with the recipient
32422 addresses, you should get a return code of zero.
32423
32424
32425 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32426        *sender_authentication)*&
32427 This function is a more sophisticated version of &'child_open()'&. The command
32428 that it runs is:
32429 .display
32430 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32431 .endd
32432 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32433
32434
32435 .vitem &*void&~debug_printf(char&~*,&~...)*&
32436 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32437 output is written to the standard error stream. If no debugging is selected,
32438 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32439 conditional on the &`local_scan`& debug selector by coding like this:
32440 .code
32441 if ((debug_selector & D_local_scan) != 0)
32442   debug_printf("xxx", ...);
32443 .endd
32444
32445 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32446 This is an interface to Exim's string expansion code. The return value is the
32447 expanded string, or NULL if there was an expansion failure.
32448 The C variable &%expand_string_message%& contains an error message after an
32449 expansion failure. If expansion does not change the string, the return value is
32450 the pointer to the input string. Otherwise, the return value points to a new
32451 block of memory that was obtained by a call to &'store_get()'&. See section
32452 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32453
32454 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32455 This function allows you to an add additional header line at the end of the
32456 existing ones. The first argument is the type, and should normally be a space
32457 character. The second argument is a format string and any number of
32458 substitution arguments as for &[sprintf()]&. You may include internal newlines
32459 if you want, and you must ensure that the string ends with a newline.
32460
32461 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32462         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32463 This function adds a new header line at a specified point in the header
32464 chain. The header itself is specified as for &'header_add()'&.
32465
32466 If &%name%& is NULL, the new header is added at the end of the chain if
32467 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32468 NULL, the header lines are searched for the first non-deleted header that
32469 matches the name. If one is found, the new header is added before it if
32470 &%after%& is false. If &%after%& is true, the new header is added after the
32471 found header and any adjacent subsequent ones with the same name (even if
32472 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32473 option controls where the header is added. If it is true, addition is at the
32474 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32475 headers, or at the top if there are no &'Received:'& headers, you could use
32476 .code
32477 header_add_at_position(TRUE, US"Received", TRUE,
32478   ' ', "X-xxx: ...");
32479 .endd
32480 Normally, there is always at least one non-deleted &'Received:'& header, but
32481 there may not be if &%received_header_text%& expands to an empty string.
32482
32483
32484 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32485 This function removes header lines. If &%occurrence%& is zero or negative, all
32486 occurrences of the header are removed. If occurrence is greater than zero, that
32487 particular instance of the header is removed. If no header(s) can be found that
32488 match the specification, the function does nothing.
32489
32490
32491 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32492         int&~length,&~BOOL&~notdel)*&"
32493 This function tests whether the given header has the given name. It is not just
32494 a string comparison, because white space is permitted between the name and the
32495 colon. If the &%notdel%& argument is true, a false return is forced for all
32496 &"deleted"& headers; otherwise they are not treated specially. For example:
32497 .code
32498 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32499 .endd
32500 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32501 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32502 This function base64-encodes a string, which is passed by address and length.
32503 The text may contain bytes of any value, including zero. The result is passed
32504 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32505 zero-terminated.
32506
32507 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32508 This function decodes a base64-encoded string. Its arguments are a
32509 zero-terminated base64-encoded string and the address of a variable that is set
32510 to point to the result, which is in dynamic memory. The length of the decoded
32511 string is the yield of the function. If the input is invalid base64 data, the
32512 yield is -1. A zero byte is added to the end of the output string to make it
32513 easy to interpret as a C string (assuming it contains no zeros of its own). The
32514 added zero byte is not included in the returned count.
32515
32516 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32517 This function checks for a match in a domain list. Domains are always
32518 matched caselessly. The return value is one of the following:
32519 .display
32520 &`OK     `& match succeeded
32521 &`FAIL   `& match failed
32522 &`DEFER  `& match deferred
32523 .endd
32524 DEFER is usually caused by some kind of lookup defer, such as the
32525 inability to contact a database.
32526
32527 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32528         BOOL&~caseless)*&"
32529 This function checks for a match in a local part list. The third argument
32530 controls case-sensitivity. The return values are as for
32531 &'lss_match_domain()'&.
32532
32533 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32534         BOOL&~caseless)*&"
32535 This function checks for a match in an address list. The third argument
32536 controls the case-sensitivity of the local part match. The domain is always
32537 matched caselessly. The return values are as for &'lss_match_domain()'&.
32538
32539 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32540         uschar&~*list)*&"
32541 This function checks for a match in a host list. The most common usage is
32542 expected to be
32543 .code
32544 lss_match_host(sender_host_name, sender_host_address, ...)
32545 .endd
32546 .vindex "&$sender_host_address$&"
32547 An empty address field matches an empty item in the host list. If the host name
32548 is NULL, the name corresponding to &$sender_host_address$& is automatically
32549 looked up if a host name is required to match an item in the list. The return
32550 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32551 returns ERROR in the case when it had to look up a host name, but the lookup
32552 failed.
32553
32554 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32555         *format,&~...)*&"
32556 This function writes to Exim's log files. The first argument should be zero (it
32557 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32558 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32559 them. It specifies to which log or logs the message is written. The remaining
32560 arguments are a format and relevant insertion arguments. The string should not
32561 contain any newlines, not even at the end.
32562
32563
32564 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32565 This function adds an additional recipient to the message. The first argument
32566 is the recipient address. If it is unqualified (has no domain), it is qualified
32567 with the &%qualify_recipient%& domain. The second argument must always be -1.
32568
32569 This function does not allow you to specify a private &%errors_to%& address (as
32570 described with the structure of &%recipient_item%& above), because it pre-dates
32571 the addition of that field to the structure. However, it is easy to add such a
32572 value afterwards. For example:
32573 .code
32574  receive_add_recipient(US"monitor@mydom.example", -1);
32575  recipients_list[recipients_count-1].errors_to =
32576    US"postmaster@mydom.example";
32577 .endd
32578
32579 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32580 This is a convenience function to remove a named recipient from the list of
32581 recipients. It returns true if a recipient was removed, and false if no
32582 matching recipient could be found. The argument must be a complete email
32583 address.
32584 .endlist
32585
32586
32587 .cindex "RFC 2047"
32588 .vlist
32589 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32590   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32591 This function decodes strings that are encoded according to RFC 2047. Typically
32592 these are the contents of header lines. First, each &"encoded word"& is decoded
32593 from the Q or B encoding into a byte-string. Then, if provided with the name of
32594 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32595 made  to translate the result to the named character set. If this fails, the
32596 binary string is returned with an error message.
32597
32598 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32599 maximum MIME word length is enforced. The third argument is the target
32600 encoding, or NULL if no translation is wanted.
32601
32602 .cindex "binary zero" "in RFC 2047 decoding"
32603 .cindex "RFC 2047" "binary zero in"
32604 If a binary zero is encountered in the decoded string, it is replaced by the
32605 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32606 not be 0 because header lines are handled as zero-terminated strings.
32607
32608 The function returns the result of processing the string, zero-terminated; if
32609 &%lenptr%& is not NULL, the length of the result is set in the variable to
32610 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32611
32612 If an error is encountered, the function returns NULL and uses the &%error%&
32613 argument to return an error message. The variable pointed to by &%error%& is
32614 set to NULL if there is no error; it may be set non-NULL even when the function
32615 returns a non-NULL value if decoding was successful, but there was a problem
32616 with translation.
32617
32618
32619 .vitem &*int&~smtp_fflush(void)*&
32620 This function is used in conjunction with &'smtp_printf()'&, as described
32621 below.
32622
32623 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32624 The arguments of this function are like &[printf()]&; it writes to the SMTP
32625 output stream. You should use this function only when there is an SMTP output
32626 stream, that is, when the incoming message is being received via interactive
32627 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32628 is FALSE. If you want to test for an incoming message from another host (as
32629 opposed to a local process that used the &%-bs%& command line option), you can
32630 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32631 is involved.
32632
32633 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32634 output function, so it can be used for all forms of SMTP connection.
32635
32636 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32637 must start with an appropriate response code: 550 if you are going to return
32638 LOCAL_SCAN_REJECT, 451 if you are going to return
32639 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32640 initial lines of a multi-line response, the code must be followed by a hyphen
32641 to indicate that the line is not the final response line. You must also ensure
32642 that the lines you write terminate with CRLF. For example:
32643 .code
32644 smtp_printf("550-this is some extra info\r\n");
32645 return LOCAL_SCAN_REJECT;
32646 .endd
32647 Note that you can also create multi-line responses by including newlines in
32648 the data returned via the &%return_text%& argument. The added value of using
32649 &'smtp_printf()'& is that, for instance, you could introduce delays between
32650 multiple output lines.
32651
32652 The &'smtp_printf()'& function does not return any error indication, because it
32653 does not automatically flush pending output, and therefore does not test
32654 the state of the stream. (In the main code of Exim, flushing and error
32655 detection is done when Exim is ready for the next SMTP input command.) If
32656 you want to flush the output and check for an error (for example, the
32657 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32658 arguments. It flushes the output stream, and returns a non-zero value if there
32659 is an error.
32660
32661 .vitem &*void&~*store_get(int)*&
32662 This function accesses Exim's internal store (memory) manager. It gets a new
32663 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32664 runs out of memory. See the next section for a discussion of memory handling.
32665
32666 .vitem &*void&~*store_get_perm(int)*&
32667 This function is like &'store_get()'&, but it always gets memory from the
32668 permanent pool. See the next section for a discussion of memory handling.
32669
32670 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32671 See below.
32672
32673 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32674 See below.
32675
32676 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32677 These three functions create strings using Exim's dynamic memory facilities.
32678 The first makes a copy of an entire string. The second copies up to a maximum
32679 number of characters, indicated by the second argument. The third uses a format
32680 and insertion arguments to create a new string. In each case, the result is a
32681 pointer to a new string in the current memory pool. See the next section for
32682 more discussion.
32683 .endlist
32684
32685
32686
32687 .section "More about Exim's memory handling" "SECTmemhanloc"
32688 .cindex "&[local_scan()]& function" "memory handling"
32689 No function is provided for freeing memory, because that is never needed.
32690 The dynamic memory that Exim uses when receiving a message is automatically
32691 recycled if another message is received by the same process (this applies only
32692 to incoming SMTP connections &-- other input methods can supply only one
32693 message at a time). After receiving the last message, a reception process
32694 terminates.
32695
32696 Because it is recycled, the normal dynamic memory cannot be used for holding
32697 data that must be preserved over a number of incoming messages on the same SMTP
32698 connection. However, Exim in fact uses two pools of dynamic memory; the second
32699 one is not recycled, and can be used for this purpose.
32700
32701 If you want to allocate memory that remains available for subsequent messages
32702 in the same SMTP connection, you should set
32703 .code
32704 store_pool = POOL_PERM
32705 .endd
32706 before calling the function that does the allocation. There is no need to
32707 restore the value if you do not need to; however, if you do want to revert to
32708 the normal pool, you can either restore the previous value of &%store_pool%& or
32709 set it explicitly to POOL_MAIN.
32710
32711 The pool setting applies to all functions that get dynamic memory, including
32712 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32713 There is also a convenience function called &'store_get_perm()'& that gets a
32714 block of memory from the permanent pool while preserving the value of
32715 &%store_pool%&.
32716 .ecindex IIDlosca
32717
32718
32719
32720
32721 . ////////////////////////////////////////////////////////////////////////////
32722 . ////////////////////////////////////////////////////////////////////////////
32723
32724 .chapter "System-wide message filtering" "CHAPsystemfilter"
32725 .scindex IIDsysfil1 "filter" "system filter"
32726 .scindex IIDsysfil2 "filtering all mail"
32727 .scindex IIDsysfil3 "system filter"
32728 The previous chapters (on ACLs and the local scan function) describe checks
32729 that can be applied to messages before they are accepted by a host. There is
32730 also a mechanism for checking messages once they have been received, but before
32731 they are delivered. This is called the &'system filter'&.
32732
32733 The system filter operates in a similar manner to users' filter files, but it
32734 is run just once per message (however many recipients the message has).
32735 It should not normally be used as a substitute for routing, because &%deliver%&
32736 commands in a system router provide new envelope recipient addresses.
32737 The system filter must be an Exim filter. It cannot be a Sieve filter.
32738
32739 The system filter is run at the start of a delivery attempt, before any routing
32740 is done. If a message fails to be completely delivered at the first attempt,
32741 the system filter is run again at the start of every retry.
32742 If you want your filter to do something only once per message, you can make use
32743 of the &%first_delivery%& condition in an &%if%& command in the filter to
32744 prevent it happening on retries.
32745
32746 .vindex "&$domain$&"
32747 .vindex "&$local_part$&"
32748 &*Warning*&: Because the system filter runs just once, variables that are
32749 specific to individual recipient addresses, such as &$local_part$& and
32750 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32751 you want to run a centrally-specified filter for each recipient address
32752 independently, you can do so by setting up a suitable &(redirect)& router, as
32753 described in section &<<SECTperaddfil>>& below.
32754
32755
32756 .section "Specifying a system filter" "SECID212"
32757 .cindex "uid (user id)" "system filter"
32758 .cindex "gid (group id)" "system filter"
32759 The name of the file that contains the system filter must be specified by
32760 setting &%system_filter%&. If you want the filter to run under a uid and gid
32761 other than root, you must also set &%system_filter_user%& and
32762 &%system_filter_group%& as appropriate. For example:
32763 .code
32764 system_filter = /etc/mail/exim.filter
32765 system_filter_user = exim
32766 .endd
32767 If a system filter generates any deliveries directly to files or pipes (via the
32768 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32769 specified by setting &%system_filter_file_transport%& and
32770 &%system_filter_pipe_transport%&, respectively. Similarly,
32771 &%system_filter_reply_transport%& must be set to handle any messages generated
32772 by the &%reply%& command.
32773
32774
32775 .section "Testing a system filter" "SECID213"
32776 You can run simple tests of a system filter in the same way as for a user
32777 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32778 are permitted only in system filters are recognized.
32779
32780 If you want to test the combined effect of a system filter and a user filter,
32781 you can use both &%-bF%& and &%-bf%& on the same command line.
32782
32783
32784
32785 .section "Contents of a system filter" "SECID214"
32786 The language used to specify system filters is the same as for users' filter
32787 files. It is described in the separate end-user document &'Exim's interface to
32788 mail filtering'&. However, there are some additional features that are
32789 available only in system filters; these are described in subsequent sections.
32790 If they are encountered in a user's filter file or when testing with &%-bf%&,
32791 they cause errors.
32792
32793 .cindex "frozen messages" "manual thaw; testing in filter"
32794 There are two special conditions which, though available in users' filter
32795 files, are designed for use in system filters. The condition &%first_delivery%&
32796 is true only for the first attempt at delivering a message, and
32797 &%manually_thawed%& is true only if the message has been frozen, and
32798 subsequently thawed by an admin user. An explicit forced delivery counts as a
32799 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32800
32801 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32802 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32803 succeed, it will not be tried again.
32804 If you want Exim to retry an unseen delivery until it succeeds, you should
32805 arrange to set it up every time the filter runs.
32806
32807 When a system filter finishes running, the values of the variables &$n0$& &--
32808 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32809 users' filter files. Thus a system filter can, for example, set up &"scores"&
32810 to which users' filter files can refer.
32811
32812
32813
32814 .section "Additional variable for system filters" "SECID215"
32815 .vindex "&$recipients$&"
32816 The expansion variable &$recipients$&, containing a list of all the recipients
32817 of the message (separated by commas and white space), is available in system
32818 filters. It is not available in users' filters for privacy reasons.
32819
32820
32821
32822 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32823 .cindex "freezing messages"
32824 .cindex "message" "freezing"
32825 .cindex "message" "forced failure"
32826 .cindex "&%fail%&" "in system filter"
32827 .cindex "&%freeze%& in system filter"
32828 .cindex "&%defer%& in system filter"
32829 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32830 always available in system filters, but are not normally enabled in users'
32831 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32832 for the &(redirect)& router.) These commands can optionally be followed by the
32833 word &%text%& and a string containing an error message, for example:
32834 .code
32835 fail text "this message looks like spam to me"
32836 .endd
32837 The keyword &%text%& is optional if the next character is a double quote.
32838
32839 The &%defer%& command defers delivery of the original recipients of the
32840 message. The &%fail%& command causes all the original recipients to be failed,
32841 and a bounce message to be created. The &%freeze%& command suspends all
32842 delivery attempts for the original recipients. In all cases, any new deliveries
32843 that are specified by the filter are attempted as normal after the filter has
32844 run.
32845
32846 The &%freeze%& command is ignored if the message has been manually unfrozen and
32847 not manually frozen since. This means that automatic freezing by a system
32848 filter can be used as a way of checking out suspicious messages. If a message
32849 is found to be all right, manually unfreezing it allows it to be delivered.
32850
32851 .cindex "log" "&%fail%& command log line"
32852 .cindex "&%fail%&" "log line; reducing"
32853 The text given with a fail command is used as part of the bounce message as
32854 well as being written to the log. If the message is quite long, this can fill
32855 up a lot of log space when such failures are common. To reduce the size of the
32856 log message, Exim interprets the text in a special way if it starts with the
32857 two characters &`<<`& and contains &`>>`& later. The text between these two
32858 strings is written to the log, and the rest of the text is used in the bounce
32859 message. For example:
32860 .code
32861 fail "<<filter test 1>>Your message is rejected \
32862      because it contains attachments that we are \
32863      not prepared to receive."
32864 .endd
32865
32866 .cindex "loop" "caused by &%fail%&"
32867 Take great care with the &%fail%& command when basing the decision to fail on
32868 the contents of the message, because the bounce message will of course include
32869 the contents of the original message and will therefore trigger the &%fail%&
32870 command again (causing a mail loop) unless steps are taken to prevent this.
32871 Testing the &%error_message%& condition is one way to prevent this. You could
32872 use, for example
32873 .code
32874 if $message_body contains "this is spam" and not error_message
32875 then fail text "spam is not wanted here" endif
32876 .endd
32877 though of course that might let through unwanted bounce messages. The
32878 alternative is clever checking of the body and/or headers to detect bounces
32879 generated by the filter.
32880
32881 The interpretation of a system filter file ceases after a
32882 &%defer%&,
32883 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32884 set up earlier in the filter file are honoured, so you can use a sequence such
32885 as
32886 .code
32887 mail ...
32888 freeze
32889 .endd
32890 to send a specified message when the system filter is freezing (or deferring or
32891 failing) a message. The normal deliveries for the message do not, of course,
32892 take place.
32893
32894
32895
32896 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32897 .cindex "header lines" "adding; in system filter"
32898 .cindex "header lines" "removing; in system filter"
32899 .cindex "filter" "header lines; adding/removing"
32900 Two filter commands that are available only in system filters are:
32901 .code
32902 headers add <string>
32903 headers remove <string>
32904 .endd
32905 The argument for the &%headers add%& is a string that is expanded and then
32906 added to the end of the message's headers. It is the responsibility of the
32907 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32908 space is ignored, and if the string is otherwise empty, or if the expansion is
32909 forced to fail, the command has no effect.
32910
32911 You can use &"\n"& within the string, followed by white space, to specify
32912 continued header lines. More than one header may be added in one command by
32913 including &"\n"& within the string without any following white space. For
32914 example:
32915 .code
32916 headers add "X-header-1: ....\n  \
32917              continuation of X-header-1 ...\n\
32918              X-header-2: ...."
32919 .endd
32920 Note that the header line continuation white space after the first newline must
32921 be placed before the backslash that continues the input string, because white
32922 space after input continuations is ignored.
32923
32924 The argument for &%headers remove%& is a colon-separated list of header names.
32925 This command applies only to those headers that are stored with the message;
32926 those that are added at delivery time (such as &'Envelope-To:'& and
32927 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32928 header with the same name, they are all removed.
32929
32930 The &%headers%& command in a system filter makes an immediate change to the set
32931 of header lines that was received with the message (with possible additions
32932 from ACL processing). Subsequent commands in the system filter operate on the
32933 modified set, which also forms the basis for subsequent message delivery.
32934 Unless further modified during routing or transporting, this set of headers is
32935 used for all recipients of the message.
32936
32937 During routing and transporting, the variables that refer to the contents of
32938 header lines refer only to those lines that are in this set. Thus, header lines
32939 that are added by a system filter are visible to users' filter files and to all
32940 routers and transports. This contrasts with the manipulation of header lines by
32941 routers and transports, which is not immediate, but which instead is saved up
32942 until the message is actually being written (see section
32943 &<<SECTheadersaddrem>>&).
32944
32945 If the message is not delivered at the first attempt, header lines that were
32946 added by the system filter are stored with the message, and so are still
32947 present at the next delivery attempt. Header lines that were removed are still
32948 present, but marked &"deleted"& so that they are not transported with the
32949 message. For this reason, it is usual to make the &%headers%& command
32950 conditional on &%first_delivery%& so that the set of header lines is not
32951 modified more than once.
32952
32953 Because header modification in a system filter acts immediately, you have to
32954 use an indirect approach if you want to modify the contents of a header line.
32955 For example:
32956 .code
32957 headers add "Old-Subject: $h_subject:"
32958 headers remove "Subject"
32959 headers add "Subject: new subject (was: $h_old-subject:)"
32960 headers remove "Old-Subject"
32961 .endd
32962
32963
32964
32965 .section "Setting an errors address in a system filter" "SECID217"
32966 .cindex "envelope sender"
32967 In a system filter, if a &%deliver%& command is followed by
32968 .code
32969 errors_to <some address>
32970 .endd
32971 in order to change the envelope sender (and hence the error reporting) for that
32972 delivery, any address may be specified. (In a user filter, only the current
32973 user's address can be set.) For example, if some mail is being monitored, you
32974 might use
32975 .code
32976 unseen deliver monitor@spying.example errors_to root@local.example
32977 .endd
32978 to take a copy which would not be sent back to the normal error reporting
32979 address if its delivery failed.
32980
32981
32982
32983 .section "Per-address filtering" "SECTperaddfil"
32984 .vindex "&$domain$&"
32985 .vindex "&$local_part$&"
32986 In contrast to the system filter, which is run just once per message for each
32987 delivery attempt, it is also possible to set up a system-wide filtering
32988 operation that runs once for each recipient address. In this case, variables
32989 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32990 filter file could be made dependent on them. This is an example of a router
32991 which implements such a filter:
32992 .code
32993 central_filter:
32994   check_local_user
32995   driver = redirect
32996   domains = +local_domains
32997   file = /central/filters/$local_part
32998   no_verify
32999   allow_filter
33000   allow_freeze
33001 .endd
33002 The filter is run in a separate process under its own uid. Therefore, either
33003 &%check_local_user%& must be set (as above), in which case the filter is run as
33004 the local user, or the &%user%& option must be used to specify which user to
33005 use. If both are set, &%user%& overrides.
33006
33007 Care should be taken to ensure that none of the commands in the filter file
33008 specify a significant delivery if the message is to go on to be delivered to
33009 its intended recipient. The router will not then claim to have dealt with the
33010 address, so it will be passed on to subsequent routers to be delivered in the
33011 normal way.
33012 .ecindex IIDsysfil1
33013 .ecindex IIDsysfil2
33014 .ecindex IIDsysfil3
33015
33016
33017
33018
33019
33020
33021 . ////////////////////////////////////////////////////////////////////////////
33022 . ////////////////////////////////////////////////////////////////////////////
33023
33024 .chapter "Message processing" "CHAPmsgproc"
33025 .scindex IIDmesproc "message" "general processing"
33026 Exim performs various transformations on the sender and recipient addresses of
33027 all messages that it handles, and also on the messages' header lines. Some of
33028 these are optional and configurable, while others always take place. All of
33029 this processing, except rewriting as a result of routing, and the addition or
33030 removal of header lines while delivering, happens when a message is received,
33031 before it is placed on Exim's queue.
33032
33033 Some of the automatic processing takes place by default only for
33034 &"locally-originated"& messages. This adjective is used to describe messages
33035 that are not received over TCP/IP, but instead are passed to an Exim process on
33036 its standard input. This includes the interactive &"local SMTP"& case that is
33037 set up by the &%-bs%& command line option.
33038
33039 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33040 or ::1) are not considered to be locally-originated. Exim does not treat the
33041 loopback interface specially in any way.
33042
33043 If you want the loopback interface to be treated specially, you must ensure
33044 that there are appropriate entries in your ACLs.
33045
33046
33047
33048
33049 .section "Submission mode for non-local messages" "SECTsubmodnon"
33050 .cindex "message" "submission"
33051 .cindex "submission mode"
33052 Processing that happens automatically for locally-originated messages (unless
33053 &%suppress_local_fixups%& is set) can also be requested for messages that are
33054 received over TCP/IP. The term &"submission mode"& is used to describe this
33055 state. Submission mode is set by the modifier
33056 .code
33057 control = submission
33058 .endd
33059 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33060 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33061 a local submission, and is normally used when the source of the message is
33062 known to be an MUA running on a client host (as opposed to an MTA). For
33063 example, to set submission mode for messages originating on the IPv4 loopback
33064 interface, you could include the following in the MAIL ACL:
33065 .code
33066 warn  hosts = 127.0.0.1
33067       control = submission
33068 .endd
33069 .cindex "&%sender_retain%& submission option"
33070 There are some options that can be used when setting submission mode. A slash
33071 is used to separate options. For example:
33072 .code
33073 control = submission/sender_retain
33074 .endd
33075 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33076 true and &%local_from_check%& false for the current incoming message. The first
33077 of these allows an existing &'Sender:'& header in the message to remain, and
33078 the second suppresses the check to ensure that &'From:'& matches the
33079 authenticated sender. With this setting, Exim still fixes up messages by adding
33080 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33081 attempt to check sender authenticity in header lines.
33082
33083 When &%sender_retain%& is not set, a submission mode setting may specify a
33084 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33085 example:
33086 .code
33087 control = submission/domain=some.domain
33088 .endd
33089 The domain may be empty. How this value is used is described in sections
33090 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33091 that allows you to specify the user's full name for inclusion in a created
33092 &'Sender:'& or &'From:'& header line. For example:
33093 .code
33094 accept authenticated = *
33095        control = submission/domain=wonderland.example/\
33096                             name=${lookup {$authenticated_id} \
33097                                    lsearch {/etc/exim/namelist}}
33098 .endd
33099 Because the name may contain any characters, including slashes, the &%name%&
33100 option must be given last. The remainder of the string is used as the name. For
33101 the example above, if &_/etc/exim/namelist_& contains:
33102 .code
33103 bigegg:  Humpty Dumpty
33104 .endd
33105 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33106 line would be:
33107 .code
33108 Sender: Humpty Dumpty <bigegg@wonderland.example>
33109 .endd
33110 .cindex "return path" "in submission mode"
33111 By default, submission mode forces the return path to the same address as is
33112 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33113 specified, the return path is also left unchanged.
33114
33115 &*Note*&: The changes caused by submission mode take effect after the predata
33116 ACL. This means that any sender checks performed before the fix-ups use the
33117 untrusted sender address specified by the user, not the trusted sender address
33118 specified by submission mode. Although this might be slightly unexpected, it
33119 does mean that you can configure ACL checks to spot that a user is trying to
33120 spoof another's address.
33121
33122 .section "Line endings" "SECTlineendings"
33123 .cindex "line endings"
33124 .cindex "carriage return"
33125 .cindex "linefeed"
33126 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33127 linefeed) is the line ending for messages transmitted over the Internet using
33128 SMTP over TCP/IP. However, within individual operating systems, different
33129 conventions are used. For example, Unix-like systems use just LF, but others
33130 use CRLF or just CR.
33131
33132 Exim was designed for Unix-like systems, and internally, it stores messages
33133 using the system's convention of a single LF as a line terminator. When
33134 receiving a message, all line endings are translated to this standard format.
33135 Originally, it was thought that programs that passed messages directly to an
33136 MTA within an operating system would use that system's convention. Experience
33137 has shown that this is not the case; for example, there are Unix applications
33138 that use CRLF in this circumstance. For this reason, and for compatibility with
33139 other MTAs, the way Exim handles line endings for all messages is now as
33140 follows:
33141
33142 .ilist
33143 LF not preceded by CR is treated as a line ending.
33144 .next
33145 CR is treated as a line ending; if it is immediately followed by LF, the LF
33146 is ignored.
33147 .next
33148 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33149 nor a local message in the state where a line containing only a dot is a
33150 terminator.
33151 .next
33152 If a bare CR is encountered within a header line, an extra space is added after
33153 the line terminator so as not to end the header line. The reasoning behind this
33154 is that bare CRs in header lines are most likely either to be mistakes, or
33155 people trying to play silly games.
33156 .next
33157 If the first header line received in a message ends with CRLF, a subsequent
33158 bare LF in a header line is treated in the same way as a bare CR in a header
33159 line.
33160 .endlist
33161
33162
33163
33164
33165
33166 .section "Unqualified addresses" "SECID218"
33167 .cindex "unqualified addresses"
33168 .cindex "address" "qualification"
33169 By default, Exim expects every envelope address it receives from an external
33170 host to be fully qualified. Unqualified addresses cause negative responses to
33171 SMTP commands. However, because SMTP is used as a means of transporting
33172 messages from MUAs running on personal workstations, there is sometimes a
33173 requirement to accept unqualified addresses from specific hosts or IP networks.
33174
33175 Exim has two options that separately control which hosts may send unqualified
33176 sender or recipient addresses in SMTP commands, namely
33177 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33178 cases, if an unqualified address is accepted, it is qualified by adding the
33179 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33180
33181 .oindex "&%qualify_domain%&"
33182 .oindex "&%qualify_recipient%&"
33183 Unqualified addresses in header lines are automatically qualified for messages
33184 that are locally originated, unless the &%-bnq%& option is given on the command
33185 line. For messages received over SMTP, unqualified addresses in header lines
33186 are qualified only if unqualified addresses are permitted in SMTP commands. In
33187 other words, such qualification is also controlled by
33188 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33189
33190
33191
33192
33193 .section "The UUCP From line" "SECID219"
33194 .cindex "&""From""& line"
33195 .cindex "UUCP" "&""From""& line"
33196 .cindex "sender" "address"
33197 .oindex "&%uucp_from_pattern%&"
33198 .oindex "&%uucp_from_sender%&"
33199 .cindex "envelope sender"
33200 .cindex "Sendmail compatibility" "&""From""& line"
33201 Messages that have come from UUCP (and some other applications) often begin
33202 with a line containing the envelope sender and a timestamp, following the word
33203 &"From"&. Examples of two common formats are:
33204 .code
33205 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33206 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33207 .endd
33208 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33209 Exim recognizes such lines at the start of messages that are submitted to it
33210 via the command line (that is, on the standard input). It does not recognize
33211 such lines in incoming SMTP messages, unless the sending host matches
33212 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33213 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33214 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33215 default value matches the two common cases shown above and puts the address
33216 that follows &"From"& into &$1$&.
33217
33218 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33219 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33220 a trusted user, the message's sender address is constructed by expanding the
33221 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33222 then parsed as an RFC 2822 address. If there is no domain, the local part is
33223 qualified with &%qualify_domain%& unless it is the empty string. However, if
33224 the command line &%-f%& option is used, it overrides the &"From"& line.
33225
33226 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33227 sender address is not changed. This is also the case for incoming SMTP messages
33228 that are permitted to contain &"From"& lines.
33229
33230 Only one &"From"& line is recognized. If there is more than one, the second is
33231 treated as a data line that starts the body of the message, as it is not valid
33232 as a header line. This also happens if a &"From"& line is present in an
33233 incoming SMTP message from a source that is not permitted to send them.
33234
33235
33236
33237 .section "Resent- header lines" "SECID220"
33238 .cindex "&%Resent-%& header lines"
33239 RFC 2822 makes provision for sets of header lines starting with the string
33240 &`Resent-`& to be added to a message when it is resent by the original
33241 recipient to somebody else. These headers are &'Resent-Date:'&,
33242 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33243 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33244
33245 .blockquote
33246 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33247 processing of replies or other such automatic actions on messages.'&
33248 .endblockquote
33249
33250 This leaves things a bit vague as far as other processing actions such as
33251 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33252 follows:
33253
33254 .ilist
33255 A &'Resent-From:'& line that just contains the login id of the submitting user
33256 is automatically rewritten in the same way as &'From:'& (see below).
33257 .next
33258 If there's a rewriting rule for a particular header line, it is also applied to
33259 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33260 &'From:'& also rewrites &'Resent-From:'&.
33261 .next
33262 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33263 also removed.
33264 .next
33265 For a locally-submitted message,
33266 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33267 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33268 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33269 included in log lines in this case.
33270 .next
33271 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33272 &%Resent-%& header lines are present.
33273 .endlist
33274
33275
33276
33277
33278 .section "The Auto-Submitted: header line" "SECID221"
33279 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33280 includes the header line:
33281 .code
33282 Auto-Submitted: auto-replied
33283 .endd
33284
33285 .section "The Bcc: header line" "SECID222"
33286 .cindex "&'Bcc:'& header line"
33287 If Exim is called with the &%-t%& option, to take recipient addresses from a
33288 message's header, it removes any &'Bcc:'& header line that may exist (after
33289 extracting its addresses). If &%-t%& is not present on the command line, any
33290 existing &'Bcc:'& is not removed.
33291
33292
33293 .section "The Date: header line" "SECID223"
33294 .cindex "&'Date:'& header line"
33295 If a locally-generated or submission-mode message has no &'Date:'& header line,
33296 Exim adds one, using the current date and time, unless the
33297 &%suppress_local_fixups%& control has been specified.
33298
33299 .section "The Delivery-date: header line" "SECID224"
33300 .cindex "&'Delivery-date:'& header line"
33301 .oindex "&%delivery_date_remove%&"
33302 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33303 set. Exim can be configured to add them to the final delivery of messages. (See
33304 the generic &%delivery_date_add%& transport option.) They should not be present
33305 in messages in transit. If the &%delivery_date_remove%& configuration option is
33306 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33307 messages.
33308
33309
33310 .section "The Envelope-to: header line" "SECID225"
33311 .cindex "&'Envelope-to:'& header line"
33312 .oindex "&%envelope_to_remove%&"
33313 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33314 Exim can be configured to add them to the final delivery of messages. (See the
33315 generic &%envelope_to_add%& transport option.) They should not be present in
33316 messages in transit. If the &%envelope_to_remove%& configuration option is set
33317 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33318 messages.
33319
33320
33321 .section "The From: header line" "SECTthefrohea"
33322 .cindex "&'From:'& header line"
33323 .cindex "Sendmail compatibility" "&""From""& line"
33324 .cindex "message" "submission"
33325 .cindex "submission mode"
33326 If a submission-mode message does not contain a &'From:'& header line, Exim
33327 adds one if either of the following conditions is true:
33328
33329 .ilist
33330 The envelope sender address is not empty (that is, this is not a bounce
33331 message). The added header line copies the envelope sender address.
33332 .next
33333 .vindex "&$authenticated_id$&"
33334 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33335 .olist
33336 .vindex "&$qualify_domain$&"
33337 If no domain is specified by the submission control, the local part is
33338 &$authenticated_id$& and the domain is &$qualify_domain$&.
33339 .next
33340 If a non-empty domain is specified by the submission control, the local
33341 part is &$authenticated_id$&, and the domain is the specified domain.
33342 .next
33343 If an empty domain is specified by the submission control,
33344 &$authenticated_id$& is assumed to be the complete address.
33345 .endlist
33346 .endlist
33347
33348 A non-empty envelope sender takes precedence.
33349
33350 If a locally-generated incoming message does not contain a &'From:'& header
33351 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33352 containing the sender's address. The calling user's login name and full name
33353 are used to construct the address, as described in section &<<SECTconstr>>&.
33354 They are obtained from the password data by calling &[getpwuid()]& (but see the
33355 &%unknown_login%& configuration option). The address is qualified with
33356 &%qualify_domain%&.
33357
33358 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33359 &'From:'& header line containing just the unqualified login name of the calling
33360 user, this is replaced by an address containing the user's login name and full
33361 name as described in section &<<SECTconstr>>&.
33362
33363
33364 .section "The Message-ID: header line" "SECID226"
33365 .cindex "&'Message-ID:'& header line"
33366 .cindex "message" "submission"
33367 .oindex "&%message_id_header_text%&"
33368 If a locally-generated or submission-mode incoming message does not contain a
33369 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33370 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33371 to the message. If there are any &'Resent-:'& headers in the message, it
33372 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33373 message id, preceded by the letter E to ensure it starts with a letter, and
33374 followed by @ and the primary host name. Additional information can be included
33375 in this header line by setting the &%message_id_header_text%& and/or
33376 &%message_id_header_domain%& options.
33377
33378
33379 .section "The Received: header line" "SECID227"
33380 .cindex "&'Received:'& header line"
33381 A &'Received:'& header line is added at the start of every message. The
33382 contents are defined by the &%received_header_text%& configuration option, and
33383 Exim automatically adds a semicolon and a timestamp to the configured string.
33384
33385 The &'Received:'& header is generated as soon as the message's header lines
33386 have been received. At this stage, the timestamp in the &'Received:'& header
33387 line is the time that the message started to be received. This is the value
33388 that is seen by the DATA ACL and by the &[local_scan()]& function.
33389
33390 Once a message is accepted, the timestamp in the &'Received:'& header line is
33391 changed to the time of acceptance, which is (apart from a small delay while the
33392 -H spool file is written) the earliest time at which delivery could start.
33393
33394
33395 .section "The References: header line" "SECID228"
33396 .cindex "&'References:'& header line"
33397 Messages created by the &(autoreply)& transport include a &'References:'&
33398 header line. This is constructed according to the rules that are described in
33399 section 3.64 of RFC 2822 (which states that replies should contain such a
33400 header line), and section 3.14 of RFC 3834 (which states that automatic
33401 responses are not different in this respect). However, because some mail
33402 processing software does not cope well with very long header lines, no more
33403 than 12 message IDs are copied from the &'References:'& header line in the
33404 incoming message. If there are more than 12, the first one and then the final
33405 11 are copied, before adding the message ID of the incoming message.
33406
33407
33408
33409 .section "The Return-path: header line" "SECID229"
33410 .cindex "&'Return-path:'& header line"
33411 .oindex "&%return_path_remove%&"
33412 &'Return-path:'& header lines are defined as something an MTA may insert when
33413 it does the final delivery of messages. (See the generic &%return_path_add%&
33414 transport option.) Therefore, they should not be present in messages in
33415 transit. If the &%return_path_remove%& configuration option is set (the
33416 default), Exim removes &'Return-path:'& header lines from incoming messages.
33417
33418
33419
33420 .section "The Sender: header line" "SECTthesenhea"
33421 .cindex "&'Sender:'& header line"
33422 .cindex "message" "submission"
33423 For a locally-originated message from an untrusted user, Exim may remove an
33424 existing &'Sender:'& header line, and it may add a new one. You can modify
33425 these actions by setting the &%local_sender_retain%& option true, the
33426 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33427 control setting.
33428
33429 When a local message is received from an untrusted user and
33430 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33431 control has not been set, a check is made to see if the address given in the
33432 &'From:'& header line is the correct (local) sender of the message. The address
33433 that is expected has the login name as the local part and the value of
33434 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33435 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33436 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33437 line is added to the message.
33438
33439 If you set &%local_from_check%& false, this checking does not occur. However,
33440 the removal of an existing &'Sender:'& line still happens, unless you also set
33441 &%local_sender_retain%& to be true. It is not possible to set both of these
33442 options true at the same time.
33443
33444 .cindex "submission mode"
33445 By default, no processing of &'Sender:'& header lines is done for messages
33446 received over TCP/IP or for messages submitted by trusted users. However, when
33447 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33448 not specified on the submission control, the following processing takes place:
33449
33450 .vindex "&$authenticated_id$&"
33451 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33452 authenticated, and &$authenticated_id$& is not empty, a sender address is
33453 created as follows:
33454
33455 .ilist
33456 .vindex "&$qualify_domain$&"
33457 If no domain is specified by the submission control, the local part is
33458 &$authenticated_id$& and the domain is &$qualify_domain$&.
33459 .next
33460 If a non-empty domain is specified by the submission control, the local part
33461 is &$authenticated_id$&, and the domain is the specified domain.
33462 .next
33463 If an empty domain is specified by the submission control,
33464 &$authenticated_id$& is assumed to be the complete address.
33465 .endlist
33466
33467 This address is compared with the address in the &'From:'& header line. If they
33468 are different, a &'Sender:'& header line containing the created address is
33469 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33470 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33471
33472 .cindex "return path" "created from &'Sender:'&"
33473 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33474 the message (the envelope sender address) is changed to be the same address,
33475 except in the case of submission mode when &%sender_retain%& is specified.
33476
33477
33478
33479 .section "Adding and removing header lines in routers and transports" &&&
33480          "SECTheadersaddrem"
33481 .cindex "header lines" "adding; in router or transport"
33482 .cindex "header lines" "removing; in router or transport"
33483 When a message is delivered, the addition and removal of header lines can be
33484 specified in a system filter, or on any of the routers and transports that
33485 process the message. Section &<<SECTaddremheasys>>& contains details about
33486 modifying headers in a system filter. Header lines can also be added in an ACL
33487 as a message is received (see section &<<SECTaddheadacl>>&).
33488
33489 In contrast to what happens in a system filter, header modifications that are
33490 specified on routers and transports apply only to the particular recipient
33491 addresses that are being processed by those routers and transports. These
33492 changes do not actually take place until a copy of the message is being
33493 transported. Therefore, they do not affect the basic set of header lines, and
33494 they do not affect the values of the variables that refer to header lines.
33495
33496 &*Note*&: In particular, this means that any expansions in the configuration of
33497 the transport cannot refer to the modified header lines, because such
33498 expansions all occur before the message is actually transported.
33499
33500 For both routers and transports, the argument of a &%headers_add%&
33501 option must be in the form of one or more RFC 2822 header lines, separated by
33502 newlines (coded as &"\n"&). For example:
33503 .code
33504 headers_add = X-added-header: added by $primary_hostname\n\
33505               X-added-second: another added header line
33506 .endd
33507 Exim does not check the syntax of these added header lines.
33508
33509 Multiple &%headers_add%& options for a single router or transport can be
33510 specified; the values will append to a single list of header lines.
33511 Each header-line is separately expanded.
33512
33513 The argument of a &%headers_remove%& option must consist of a colon-separated
33514 list of header names. This is confusing, because header names themselves are
33515 often terminated by colons. In this case, the colons are the list separators,
33516 not part of the names. For example:
33517 .code
33518 headers_remove = return-receipt-to:acknowledge-to
33519 .endd
33520
33521 Multiple &%headers_remove%& options for a single router or transport can be
33522 specified; the arguments will append to a single header-names list.
33523 Each item is separately expanded.
33524 Note that colons in complex expansions which are used to
33525 form all or part of a &%headers_remove%& list
33526 will act as list separators.
33527
33528 When &%headers_add%& or &%headers_remove%& is specified on a router,
33529 items are expanded at routing time,
33530 and then associated with all addresses that are
33531 accepted by that router, and also with any new addresses that it generates. If
33532 an address passes through several routers as a result of aliasing or
33533 forwarding, the changes are cumulative.
33534
33535 .oindex "&%unseen%&"
33536 However, this does not apply to multiple routers that result from the use of
33537 the &%unseen%& option. Any header modifications that were specified by the
33538 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33539
33540 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33541 settings cannot be delivered together in a batch, so a transport is always
33542 dealing with a set of addresses that have the same header-processing
33543 requirements.
33544
33545 The transport starts by writing the original set of header lines that arrived
33546 with the message, possibly modified by the system filter. As it writes out
33547 these lines, it consults the list of header names that were attached to the
33548 recipient address(es) by &%headers_remove%& options in routers, and it also
33549 consults the transport's own &%headers_remove%& option. Header lines whose
33550 names are on either of these lists are not written out. If there are multiple
33551 instances of any listed header, they are all skipped.
33552
33553 After the remaining original header lines have been written, new header
33554 lines that were specified by routers' &%headers_add%& options are written, in
33555 the order in which they were attached to the address. These are followed by any
33556 header lines specified by the transport's &%headers_add%& option.
33557
33558 This way of handling header line modifications in routers and transports has
33559 the following consequences:
33560
33561 .ilist
33562 The original set of header lines, possibly modified by the system filter,
33563 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33564 to it, at all times.
33565 .next
33566 Header lines that are added by a router's
33567 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33568 expansion syntax in subsequent routers or the transport.
33569 .next
33570 Conversely, header lines that are specified for removal by &%headers_remove%&
33571 in a router remain visible to subsequent routers and the transport.
33572 .next
33573 Headers added to an address by &%headers_add%& in a router cannot be removed by
33574 a later router or by a transport.
33575 .next
33576 An added header can refer to the contents of an original header that is to be
33577 removed, even it has the same name as the added header. For example:
33578 .code
33579 headers_remove = subject
33580 headers_add = Subject: new subject (was: $h_subject:)
33581 .endd
33582 .endlist
33583
33584 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33585 for a &(redirect)& router that has the &%one_time%& option set.
33586
33587
33588
33589
33590
33591 .section "Constructed addresses" "SECTconstr"
33592 .cindex "address" "constructed"
33593 .cindex "constructed address"
33594 When Exim constructs a sender address for a locally-generated message, it uses
33595 the form
33596 .display
33597 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33598 .endd
33599 For example:
33600 .code
33601 Zaphod Beeblebrox <zaphod@end.univ.example>
33602 .endd
33603 The user name is obtained from the &%-F%& command line option if set, or
33604 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33605 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33606 ampersand character, this is replaced by the login name with the first letter
33607 upper cased, as is conventional in a number of operating systems. See the
33608 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33609 The &%unknown_username%& option can be used to specify user names in cases when
33610 there is no password file entry.
33611
33612 .cindex "RFC 2047"
33613 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33614 parts of it if necessary. In addition, if it contains any non-printing
33615 characters, it is encoded as described in RFC 2047, which defines a way of
33616 including non-ASCII characters in header lines. The value of the
33617 &%headers_charset%& option specifies the name of the encoding that is used (the
33618 characters are assumed to be in this encoding). The setting of
33619 &%print_topbitchars%& controls whether characters with the top bit set (that
33620 is, with codes greater than 127) count as printing characters or not.
33621
33622
33623
33624 .section "Case of local parts" "SECID230"
33625 .cindex "case of local parts"
33626 .cindex "local part" "case of"
33627 RFC 2822 states that the case of letters in the local parts of addresses cannot
33628 be assumed to be non-significant. Exim preserves the case of local parts of
33629 addresses, but by default it uses a lower-cased form when it is routing,
33630 because on most Unix systems, usernames are in lower case and case-insensitive
33631 routing is required. However, any particular router can be made to use the
33632 original case for local parts by setting the &%caseful_local_part%& generic
33633 router option.
33634
33635 .cindex "mixed-case login names"
33636 If you must have mixed-case user names on your system, the best way to proceed,
33637 assuming you want case-independent handling of incoming email, is to set up
33638 your first router to convert incoming local parts in your domains to the
33639 correct case by means of a file lookup. For example:
33640 .code
33641 correct_case:
33642   driver = redirect
33643   domains = +local_domains
33644   data = ${lookup{$local_part}cdb\
33645               {/etc/usercased.cdb}{$value}fail}\
33646               @$domain
33647 .endd
33648 For this router, the local part is forced to lower case by the default action
33649 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33650 up a new local part in the correct case. If you then set &%caseful_local_part%&
33651 on any subsequent routers which process your domains, they will operate on
33652 local parts with the correct case in a case-sensitive manner.
33653
33654
33655
33656 .section "Dots in local parts" "SECID231"
33657 .cindex "dot" "in local part"
33658 .cindex "local part" "dots in"
33659 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33660 part may not begin or end with a dot, nor have two consecutive dots in the
33661 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33662 empty components for compatibility.
33663
33664
33665
33666 .section "Rewriting addresses" "SECID232"
33667 .cindex "rewriting" "addresses"
33668 Rewriting of sender and recipient addresses, and addresses in headers, can
33669 happen automatically, or as the result of configuration options, as described
33670 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33671 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33672
33673 Automatic rewriting includes qualification, as mentioned above. The other case
33674 in which it can happen is when an incomplete non-local domain is given. The
33675 routing process may cause this to be expanded into the full domain name. For
33676 example, a header such as
33677 .code
33678 To: hare@teaparty
33679 .endd
33680 might get rewritten as
33681 .code
33682 To: hare@teaparty.wonderland.fict.example
33683 .endd
33684 Rewriting as a result of routing is the one kind of message processing that
33685 does not happen at input time, as it cannot be done until the address has
33686 been routed.
33687
33688 Strictly, one should not do &'any'& deliveries of a message until all its
33689 addresses have been routed, in case any of the headers get changed as a
33690 result of routing. However, doing this in practice would hold up many
33691 deliveries for unreasonable amounts of time, just because one address could not
33692 immediately be routed. Exim therefore does not delay other deliveries when
33693 routing of one or more addresses is deferred.
33694 .ecindex IIDmesproc
33695
33696
33697
33698 . ////////////////////////////////////////////////////////////////////////////
33699 . ////////////////////////////////////////////////////////////////////////////
33700
33701 .chapter "SMTP processing" "CHAPSMTP"
33702 .scindex IIDsmtpproc1 "SMTP" "processing details"
33703 .scindex IIDsmtpproc2 "LMTP" "processing details"
33704 Exim supports a number of different ways of using the SMTP protocol, and its
33705 LMTP variant, which is an interactive protocol for transferring messages into a
33706 closed mail store application. This chapter contains details of how SMTP is
33707 processed. For incoming mail, the following are available:
33708
33709 .ilist
33710 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33711 .next
33712 SMTP over the standard input and output (the &%-bs%& option);
33713 .next
33714 Batched SMTP on the standard input (the &%-bS%& option).
33715 .endlist
33716
33717 For mail delivery, the following are available:
33718
33719 .ilist
33720 SMTP over TCP/IP (the &(smtp)& transport);
33721 .next
33722 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33723 &"lmtp"&);
33724 .next
33725 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33726 transport);
33727 .next
33728 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33729 the &%use_bsmtp%& option set).
33730 .endlist
33731
33732 &'Batched SMTP'& is the name for a process in which batches of messages are
33733 stored in or read from files (or pipes), in a format in which SMTP commands are
33734 used to contain the envelope information.
33735
33736
33737
33738 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33739 .cindex "SMTP" "outgoing over TCP/IP"
33740 .cindex "outgoing SMTP over TCP/IP"
33741 .cindex "LMTP" "over TCP/IP"
33742 .cindex "outgoing LMTP over TCP/IP"
33743 .cindex "EHLO"
33744 .cindex "HELO"
33745 .cindex "SIZE option on MAIL command"
33746 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33747 The &%protocol%& option selects which protocol is to be used, but the actual
33748 processing is the same in both cases.
33749
33750 If, in response to its EHLO command, Exim is told that the SIZE
33751 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33752 command. The value of <&'n'&> is the message size plus the value of the
33753 &%size_addition%& option (default 1024) to allow for additions to the message
33754 such as per-transport header lines, or changes made in a
33755 .cindex "transport" "filter"
33756 .cindex "filter" "transport filter"
33757 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33758 suppressed.
33759
33760 If the remote server advertises support for PIPELINING, Exim uses the
33761 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33762 required for the transaction.
33763
33764 If the remote server advertises support for the STARTTLS command, and Exim
33765 was built to support TLS encryption, it tries to start a TLS session unless the
33766 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33767 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33768 is called for verification.
33769
33770 If the remote server advertises support for the AUTH command, Exim scans
33771 the authenticators configuration for any suitable client settings, as described
33772 in chapter &<<CHAPSMTPAUTH>>&.
33773
33774 .cindex "carriage return"
33775 .cindex "linefeed"
33776 Responses from the remote host are supposed to be terminated by CR followed by
33777 LF. However, there are known to be hosts that do not send CR characters, so in
33778 order to be able to interwork with such hosts, Exim treats LF on its own as a
33779 line terminator.
33780
33781 If a message contains a number of different addresses, all those with the same
33782 characteristics (for example, the same envelope sender) that resolve to the
33783 same set of hosts, in the same order, are sent in a single SMTP transaction,
33784 even if they are for different domains, unless there are more than the setting
33785 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33786 they are split into groups containing no more than &%max_rcpt%&s addresses
33787 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33788 in parallel sessions. The order of hosts with identical MX values is not
33789 significant when checking whether addresses can be batched in this way.
33790
33791 When the &(smtp)& transport suffers a temporary failure that is not
33792 message-related, Exim updates its transport-specific database, which contains
33793 records indexed by host name that remember which messages are waiting for each
33794 particular host. It also updates the retry database with new retry times.
33795
33796 .cindex "hints database" "retry keys"
33797 Exim's retry hints are based on host name plus IP address, so if one address of
33798 a multi-homed host is broken, it will soon be skipped most of the time.
33799 See the next section for more detail about error handling.
33800
33801 .cindex "SMTP" "passed connection"
33802 .cindex "SMTP" "batching over TCP/IP"
33803 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33804 looks in the hints database for the transport to see if there are any queued
33805 messages waiting for the host to which it is connected. If it finds one, it
33806 creates a new Exim process using the &%-MC%& option (which can only be used by
33807 a process running as root or the Exim user) and passes the TCP/IP socket to it
33808 so that it can deliver another message using the same socket. The new process
33809 does only those deliveries that are routed to the connected host, and may in
33810 turn pass the socket on to a third process, and so on.
33811
33812 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33813 limit the number of messages sent down a single TCP/IP connection.
33814
33815 .cindex "asterisk" "after IP address"
33816 The second and subsequent messages delivered down an existing connection are
33817 identified in the main log by the addition of an asterisk after the closing
33818 square bracket of the IP address.
33819
33820
33821
33822
33823 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33824 .cindex "error" "in outgoing SMTP"
33825 .cindex "SMTP" "errors in outgoing"
33826 .cindex "host" "error"
33827 Three different kinds of error are recognized for outgoing SMTP: host errors,
33828 message errors, and recipient errors.
33829
33830 .vlist
33831 .vitem "&*Host errors*&"
33832 A host error is not associated with a particular message or with a
33833 particular recipient of a message. The host errors are:
33834
33835 .ilist
33836 Connection refused or timed out,
33837 .next
33838 Any error response code on connection,
33839 .next
33840 Any error response code to EHLO or HELO,
33841 .next
33842 Loss of connection at any time, except after &"."&,
33843 .next
33844 I/O errors at any time,
33845 .next
33846 Timeouts during the session, other than in response to MAIL, RCPT or
33847 the &"."& at the end of the data.
33848 .endlist ilist
33849
33850 For a host error, a permanent error response on connection, or in response to
33851 EHLO, causes all addresses routed to the host to be failed. Any other host
33852 error causes all addresses to be deferred, and retry data to be created for the
33853 host. It is not tried again, for any message, until its retry time arrives. If
33854 the current set of addresses are not all delivered in this run (to some
33855 alternative host), the message is added to the list of those waiting for this
33856 host, so if it is still undelivered when a subsequent successful delivery is
33857 made to the host, it will be sent down the same SMTP connection.
33858
33859 .vitem "&*Message errors*&"
33860 .cindex "message" "error"
33861 A message error is associated with a particular message when sent to a
33862 particular host, but not with a particular recipient of the message. The
33863 message errors are:
33864
33865 .ilist
33866 Any error response code to MAIL, DATA, or the &"."& that terminates
33867 the data,
33868 .next
33869 Timeout after MAIL,
33870 .next
33871 Timeout or loss of connection after the &"."& that terminates the data. A
33872 timeout after the DATA command itself is treated as a host error, as is loss of
33873 connection at any other time.
33874 .endlist ilist
33875
33876 For a message error, a permanent error response (5&'xx'&) causes all addresses
33877 to be failed, and a delivery error report to be returned to the sender. A
33878 temporary error response (4&'xx'&), or one of the timeouts, causes all
33879 addresses to be deferred. Retry data is not created for the host, but instead,
33880 a retry record for the combination of host plus message id is created. The
33881 message is not added to the list of those waiting for this host. This ensures
33882 that the failing message will not be sent to this host again until the retry
33883 time arrives. However, other messages that are routed to the host are not
33884 affected, so if it is some property of the message that is causing the error,
33885 it will not stop the delivery of other mail.
33886
33887 If the remote host specified support for the SIZE parameter in its response
33888 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33889 over-large message will cause a message error because the error arrives as a
33890 response to MAIL.
33891
33892 .vitem "&*Recipient errors*&"
33893 .cindex "recipient" "error"
33894 A recipient error is associated with a particular recipient of a message. The
33895 recipient errors are:
33896
33897 .ilist
33898 Any error response to RCPT,
33899 .next
33900 Timeout after RCPT.
33901 .endlist
33902
33903 For a recipient error, a permanent error response (5&'xx'&) causes the
33904 recipient address to be failed, and a bounce message to be returned to the
33905 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33906 address to be deferred, and routing retry data to be created for it. This is
33907 used to delay processing of the address in subsequent queue runs, until its
33908 routing retry time arrives. This applies to all messages, but because it
33909 operates only in queue runs, one attempt will be made to deliver a new message
33910 to the failing address before the delay starts to operate. This ensures that,
33911 if the failure is really related to the message rather than the recipient
33912 (&"message too big for this recipient"& is a possible example), other messages
33913 have a chance of getting delivered. If a delivery to the address does succeed,
33914 the retry information gets cleared, so all stuck messages get tried again, and
33915 the retry clock is reset.
33916
33917 The message is not added to the list of those waiting for this host. Use of the
33918 host for other messages is unaffected, and except in the case of a timeout,
33919 other recipients are processed independently, and may be successfully delivered
33920 in the current SMTP session. After a timeout it is of course impossible to
33921 proceed with the session, so all addresses get deferred. However, those other
33922 than the one that failed do not suffer any subsequent retry delays. Therefore,
33923 if one recipient is causing trouble, the others have a chance of getting
33924 through when a subsequent delivery attempt occurs before the failing
33925 recipient's retry time.
33926 .endlist
33927
33928 In all cases, if there are other hosts (or IP addresses) available for the
33929 current set of addresses (for example, from multiple MX records), they are
33930 tried in this run for any undelivered addresses, subject of course to their
33931 own retry data. In other words, recipient error retry data does not take effect
33932 until the next delivery attempt.
33933
33934 Some hosts have been observed to give temporary error responses to every
33935 MAIL command at certain times (&"insufficient space"& has been seen). It
33936 would be nice if such circumstances could be recognized, and defer data for the
33937 host itself created, but this is not possible within the current Exim design.
33938 What actually happens is that retry data for every (host, message) combination
33939 is created.
33940
33941 The reason that timeouts after MAIL and RCPT are treated specially is that
33942 these can sometimes arise as a result of the remote host's verification
33943 procedures. Exim makes this assumption, and treats them as if a temporary error
33944 response had been received. A timeout after &"."& is treated specially because
33945 it is known that some broken implementations fail to recognize the end of the
33946 message if the last character of the last line is a binary zero. Thus, it is
33947 helpful to treat this case as a message error.
33948
33949 Timeouts at other times are treated as host errors, assuming a problem with the
33950 host, or the connection to it. If a timeout after MAIL, RCPT,
33951 or &"."& is really a connection problem, the assumption is that at the next try
33952 the timeout is likely to occur at some other point in the dialogue, causing it
33953 then to be treated as a host error.
33954
33955 There is experimental evidence that some MTAs drop the connection after the
33956 terminating &"."& if they do not like the contents of the message for some
33957 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33958 should be given. That is why Exim treats this case as a message rather than a
33959 host error, in order not to delay other messages to the same host.
33960
33961
33962
33963
33964 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33965 .cindex "SMTP" "incoming over TCP/IP"
33966 .cindex "incoming SMTP over TCP/IP"
33967 .cindex "inetd"
33968 .cindex "daemon"
33969 Incoming SMTP messages can be accepted in one of two ways: by running a
33970 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33971 &_/etc/inetd.conf_& should be like this:
33972 .code
33973 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33974 .endd
33975 Exim distinguishes between this case and the case of a locally running user
33976 agent using the &%-bs%& option by checking whether or not the standard input is
33977 a socket. When it is, either the port must be privileged (less than 1024), or
33978 the caller must be root or the Exim user. If any other user passes a socket
33979 with an unprivileged port number, Exim prints a message on the standard error
33980 stream and exits with an error code.
33981
33982 By default, Exim does not make a log entry when a remote host connects or
33983 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33984 unexpected. It can be made to write such log entries by setting the
33985 &%smtp_connection%& log selector.
33986
33987 .cindex "carriage return"
33988 .cindex "linefeed"
33989 Commands from the remote host are supposed to be terminated by CR followed by
33990 LF. However, there are known to be hosts that do not send CR characters. In
33991 order to be able to interwork with such hosts, Exim treats LF on its own as a
33992 line terminator.
33993 Furthermore, because common code is used for receiving messages from all
33994 sources, a CR on its own is also interpreted as a line terminator. However, the
33995 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33996
33997 .cindex "EHLO" "invalid data"
33998 .cindex "HELO" "invalid data"
33999 One area that sometimes gives rise to problems concerns the EHLO or
34000 HELO commands. Some clients send syntactically invalid versions of these
34001 commands, which Exim rejects by default. (This is nothing to do with verifying
34002 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34003 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34004 match the broken hosts that send invalid commands.
34005
34006 .cindex "SIZE option on MAIL command"
34007 .cindex "MAIL" "SIZE option"
34008 The amount of disk space available is checked whenever SIZE is received on
34009 a MAIL command, independently of whether &%message_size_limit%& or
34010 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34011 false. A temporary error is given if there is not enough space. If
34012 &%check_spool_space%& is set, the check is for that amount of space plus the
34013 value given with SIZE, that is, it checks that the addition of the incoming
34014 message will not reduce the space below the threshold.
34015
34016 When a message is successfully received, Exim includes the local message id in
34017 its response to the final &"."& that terminates the data. If the remote host
34018 logs this text it can help with tracing what has happened to a message.
34019
34020 The Exim daemon can limit the number of simultaneous incoming connections it is
34021 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34022 number of simultaneous incoming connections from a single remote host (see the
34023 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34024 rejected using the SMTP temporary error code 421.
34025
34026 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34027 subprocess has finished, as this can get lost at busy times. Instead, it looks
34028 for completed subprocesses every time it wakes up. Provided there are other
34029 things happening (new incoming calls, starts of queue runs), completed
34030 processes will be noticed and tidied away. On very quiet systems you may
34031 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34032 it will be noticed when the daemon next wakes up.
34033
34034 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34035 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34036 high system load &-- for details see the &%smtp_accept_reserve%&,
34037 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34038 applies in both the daemon and &'inetd'& cases.
34039
34040 Exim normally starts a delivery process for each message received, though this
34041 can be varied by means of the &%-odq%& command line option and the
34042 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34043 number of simultaneously running delivery processes started in this way from
34044 SMTP input can be limited by the &%smtp_accept_queue%& and
34045 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34046 subsequently received messages are just put on the input queue without starting
34047 a delivery process.
34048
34049 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34050 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34051 started up from the &'inetd'& daemon, because in that case each connection is
34052 handled by an entirely independent Exim process. Control by load average is,
34053 however, available with &'inetd'&.
34054
34055 Exim can be configured to verify addresses in incoming SMTP commands as they
34056 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34057 to rewrite addresses at this time &-- before any syntax checking is done. See
34058 section &<<SECTrewriteS>>&.
34059
34060 Exim can also be configured to limit the rate at which a client host submits
34061 MAIL and RCPT commands in a single SMTP session. See the
34062 &%smtp_ratelimit_hosts%& option.
34063
34064
34065
34066 .section "Unrecognized SMTP commands" "SECID234"
34067 .cindex "SMTP" "unrecognized commands"
34068 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34069 commands during a single SMTP connection, it drops the connection after sending
34070 the error response to the last command. The default value for
34071 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34072 abuse that subvert web servers into making connections to SMTP ports; in these
34073 circumstances, a number of non-SMTP lines are sent first.
34074
34075
34076 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34077 .cindex "SMTP" "syntax errors"
34078 .cindex "SMTP" "protocol errors"
34079 A syntax error is detected if an SMTP command is recognized, but there is
34080 something syntactically wrong with its data, for example, a malformed email
34081 address in a RCPT command. Protocol errors include invalid command
34082 sequencing such as RCPT before MAIL. If Exim receives more than
34083 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34084 drops the connection after sending the error response to the last command. The
34085 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34086 broken clients that loop sending bad commands (yes, it has been seen).
34087
34088
34089
34090 .section "Use of non-mail SMTP commands" "SECID236"
34091 .cindex "SMTP" "non-mail commands"
34092 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34093 DATA. Exim counts such commands, and drops the connection if there are too
34094 many of them in a single SMTP session. This action catches some
34095 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34096 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34097 defines what &"too many"& means. Its default value is 10.
34098
34099 When a new message is expected, one occurrence of RSET is not counted. This
34100 allows a client to send one RSET between messages (this is not necessary,
34101 but some clients do it). Exim also allows one uncounted occurrence of HELO
34102 or EHLO, and one occurrence of STARTTLS between messages. After
34103 starting up a TLS session, another EHLO is expected, and so it too is not
34104 counted.
34105
34106 The first occurrence of AUTH in a connection, or immediately following
34107 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34108 RCPT, DATA, and QUIT are counted.
34109
34110 You can control which hosts are subject to the limit set by
34111 &%smtp_accept_max_nonmail%& by setting
34112 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34113 the limit apply to all hosts. This option means that you can exclude any
34114 specific badly-behaved hosts that you have to live with.
34115
34116
34117
34118
34119 .section "The VRFY and EXPN commands" "SECID237"
34120 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34121 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34122 appropriate) in order to decide whether the command should be accepted or not.
34123
34124 .cindex "VRFY" "processing"
34125 When no ACL is defined for VRFY, or if it rejects without
34126 setting an explicit response code, the command is accepted
34127 (with a 252 SMTP response code)
34128 in order to support awkward clients that do a VRFY before every RCPT.
34129 When VRFY is accepted, it runs exactly the same code as when Exim is
34130 called with the &%-bv%& option, and returns 250/451/550
34131 SMTP response codes.
34132
34133 .cindex "EXPN" "processing"
34134 If no ACL for EXPN is defined, the command is rejected.
34135 When EXPN is accepted, a single-level expansion of the address is done.
34136 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34137 than a verification (the &%-bv%& option). If an unqualified local part is given
34138 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34139 of VRFY and EXPN commands are logged on the main and reject logs, and
34140 VRFY verification failures are logged on the main log for consistency with
34141 RCPT failures.
34142
34143
34144
34145 .section "The ETRN command" "SECTETRN"
34146 .cindex "ETRN" "processing"
34147 RFC 1985 describes an SMTP command called ETRN that is designed to
34148 overcome the security problems of the TURN command (which has fallen into
34149 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34150 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34151 should be accepted or not. If no ACL is defined, the command is rejected.
34152
34153 The ETRN command is concerned with &"releasing"& messages that are awaiting
34154 delivery to certain hosts. As Exim does not organize its message queue by host,
34155 the only form of ETRN that is supported by default is the one where the
34156 text starts with the &"#"& prefix, in which case the remainder of the text is
34157 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34158 the &%-R%& option to happen, with the remainder of the ETRN text as its
34159 argument. For example,
34160 .code
34161 ETRN #brigadoon
34162 .endd
34163 runs the command
34164 .code
34165 exim -R brigadoon
34166 .endd
34167 which causes a delivery attempt on all messages with undelivered addresses
34168 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34169 default), Exim prevents the simultaneous execution of more than one queue run
34170 for the same argument string as a result of an ETRN command. This stops
34171 a misbehaving client from starting more than one queue runner at once.
34172
34173 .cindex "hints database" "ETRN serialization"
34174 Exim implements the serialization by means of a hints database in which a
34175 record is written whenever a process is started by ETRN, and deleted when
34176 the process completes. However, Exim does not keep the SMTP session waiting for
34177 the ETRN process to complete. Once ETRN is accepted, the client is sent
34178 a &"success"& return code. Obviously there is scope for hints records to get
34179 left lying around if there is a system or program crash. To guard against this,
34180 Exim ignores any records that are more than six hours old.
34181
34182 .oindex "&%smtp_etrn_command%&"
34183 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34184 used. This specifies a command that is run whenever ETRN is received,
34185 whatever the form of its argument. For
34186 example:
34187 .code
34188 smtp_etrn_command = /etc/etrn_command $domain \
34189                     $sender_host_address
34190 .endd
34191 .vindex "&$domain$&"
34192 The string is split up into arguments which are independently expanded. The
34193 expansion variable &$domain$& is set to the argument of the ETRN command,
34194 and no syntax checking is done on the contents of this argument. Exim does not
34195 wait for the command to complete, so its status code is not checked. Exim runs
34196 under its own uid and gid when receiving incoming SMTP, so it is not possible
34197 for it to change them before running the command.
34198
34199
34200
34201 .section "Incoming local SMTP" "SECID238"
34202 .cindex "SMTP" "local incoming"
34203 Some user agents use SMTP to pass messages to their local MTA using the
34204 standard input and output, as opposed to passing the envelope on the command
34205 line and writing the message to the standard input. This is supported by the
34206 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34207 messages over TCP/IP (including the use of ACLs), except that the envelope
34208 sender given in a MAIL command is ignored unless the caller is trusted. In
34209 an ACL you can detect this form of SMTP input by testing for an empty host
34210 identification. It is common to have this as the first line in the ACL that
34211 runs for RCPT commands:
34212 .code
34213 accept hosts = :
34214 .endd
34215 This accepts SMTP messages from local processes without doing any other tests.
34216
34217
34218
34219 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34220 .cindex "SMTP" "batched outgoing"
34221 .cindex "batched SMTP output"
34222 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34223 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34224 be output in BSMTP format. No SMTP responses are possible for this form of
34225 delivery. All it is doing is using SMTP commands as a way of transmitting the
34226 envelope along with the message.
34227
34228 The message is written to the file or pipe preceded by the SMTP commands
34229 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34230 the message that start with a dot have an extra dot added. The SMTP command
34231 HELO is not normally used. If it is required, the &%message_prefix%& option
34232 can be used to specify it.
34233
34234 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34235 one recipient address at a time by default. However, you can arrange for them
34236 to handle several addresses at once by setting the &%batch_max%& option. When
34237 this is done for BSMTP, messages may contain multiple RCPT commands. See
34238 chapter &<<CHAPbatching>>& for more details.
34239
34240 .vindex "&$host$&"
34241 When one or more addresses are routed to a BSMTP transport by a router that
34242 sets up a host list, the name of the first host on the list is available to the
34243 transport in the variable &$host$&. Here is an example of such a transport and
34244 router:
34245 .code
34246 begin routers
34247 route_append:
34248   driver = manualroute
34249   transport = smtp_appendfile
34250   route_list = domain.example  batch.host.example
34251
34252 begin transports
34253 smtp_appendfile:
34254   driver = appendfile
34255   directory = /var/bsmtp/$host
34256   batch_max = 1000
34257   use_bsmtp
34258   user = exim
34259 .endd
34260 This causes messages addressed to &'domain.example'& to be written in BSMTP
34261 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34262 message (unless there are more than 1000 recipients).
34263
34264
34265
34266 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34267 .cindex "SMTP" "batched incoming"
34268 .cindex "batched SMTP input"
34269 The &%-bS%& command line option causes Exim to accept one or more messages by
34270 reading SMTP on the standard input, but to generate no responses. If the caller
34271 is trusted, the senders in the MAIL commands are believed; otherwise the
34272 sender is always the caller of Exim. Unqualified senders and receivers are not
34273 rejected (there seems little point) but instead just get qualified. HELO
34274 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34275 as NOOP; QUIT quits.
34276
34277 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34278 ACL is run in the same way as for non-SMTP local input.
34279
34280 If an error is detected while reading a message, including a missing &"."& at
34281 the end, Exim gives up immediately. It writes details of the error to the
34282 standard output in a stylized way that the calling program should be able to
34283 make some use of automatically, for example:
34284 .code
34285 554 Unexpected end of file
34286 Transaction started in line 10
34287 Error detected in line 14
34288 .endd
34289 It writes a more verbose version, for human consumption, to the standard error
34290 file, for example:
34291 .code
34292 An error was detected while processing a file of BSMTP input.
34293 The error message was:
34294
34295 501 '>' missing at end of address
34296
34297 The SMTP transaction started in line 10.
34298 The error was detected in line 12.
34299 The SMTP command at fault was:
34300
34301 rcpt to:<malformed@in.com.plete
34302
34303 1 previous message was successfully processed.
34304 The rest of the batch was abandoned.
34305 .endd
34306 The return code from Exim is zero only if there were no errors. It is 1 if some
34307 messages were accepted before an error was detected, and 2 if no messages were
34308 accepted.
34309 .ecindex IIDsmtpproc1
34310 .ecindex IIDsmtpproc2
34311
34312
34313
34314 . ////////////////////////////////////////////////////////////////////////////
34315 . ////////////////////////////////////////////////////////////////////////////
34316
34317 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34318          "Customizing messages"
34319 When a message fails to be delivered, or remains on the queue for more than a
34320 configured amount of time, Exim sends a message to the original sender, or
34321 to an alternative configured address. The text of these messages is built into
34322 the code of Exim, but it is possible to change it, either by adding a single
34323 string, or by replacing each of the paragraphs by text supplied in a file.
34324
34325 The &'From:'& and &'To:'& header lines are automatically generated; you can
34326 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34327 option. Exim also adds the line
34328 .code
34329 Auto-Submitted: auto-generated
34330 .endd
34331 to all warning and bounce messages,
34332
34333
34334 .section "Customizing bounce messages" "SECID239"
34335 .cindex "customizing" "bounce message"
34336 .cindex "bounce message" "customizing"
34337 If &%bounce_message_text%& is set, its contents are included in the default
34338 message immediately after &"This message was created automatically by mail
34339 delivery software."& The string is not expanded. It is not used if
34340 &%bounce_message_file%& is set.
34341
34342 When &%bounce_message_file%& is set, it must point to a template file for
34343 constructing error messages. The file consists of a series of text items,
34344 separated by lines consisting of exactly four asterisks. If the file cannot be
34345 opened, default text is used and a message is written to the main and panic
34346 logs. If any text item in the file is empty, default text is used for that
34347 item.
34348
34349 .vindex "&$bounce_recipient$&"
34350 .vindex "&$bounce_return_size_limit$&"
34351 Each item of text that is read from the file is expanded, and there are two
34352 expansion variables which can be of use here: &$bounce_recipient$& is set to
34353 the recipient of an error message while it is being created, and
34354 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34355 option, rounded to a whole number.
34356
34357 The items must appear in the file in the following order:
34358
34359 .ilist
34360 The first item is included in the headers, and should include at least a
34361 &'Subject:'& header. Exim does not check the syntax of these headers.
34362 .next
34363 The second item forms the start of the error message. After it, Exim lists the
34364 failing addresses with their error messages.
34365 .next
34366 The third item is used to introduce any text from pipe transports that is to be
34367 returned to the sender. It is omitted if there is no such text.
34368 .next
34369 The fourth, fifth and sixth items will be ignored and may be empty.
34370 The fields exist for back-compatibility
34371 .endlist
34372
34373 The default state (&%bounce_message_file%& unset) is equivalent to the
34374 following file, in which the sixth item is empty. The &'Subject:'& and some
34375 other lines have been split in order to fit them on the page:
34376 .code
34377 Subject: Mail delivery failed
34378   ${if eq{$sender_address}{$bounce_recipient}
34379   {: returning message to sender}}
34380 ****
34381 This message was created automatically by mail delivery software.
34382
34383 A message ${if eq{$sender_address}{$bounce_recipient}
34384   {that you sent }{sent by
34385
34386 <$sender_address>
34387
34388 }}could not be delivered to all of its recipients.
34389 This is a permanent error. The following address(es) failed:
34390 ****
34391 The following text was generated during the delivery attempt(s):
34392 ****
34393 ------ This is a copy of the message, including all the headers.
34394   ------
34395 ****
34396 ------ The body of the message is $message_size characters long;
34397   only the first
34398 ------ $bounce_return_size_limit or so are included here.
34399 ****
34400 .endd
34401 .section "Customizing warning messages" "SECTcustwarn"
34402 .cindex "customizing" "warning message"
34403 .cindex "warning of delay" "customizing the message"
34404 The option &%warn_message_file%& can be pointed at a template file for use when
34405 warnings about message delays are created. In this case there are only three
34406 text sections:
34407
34408 .ilist
34409 The first item is included in the headers, and should include at least a
34410 &'Subject:'& header. Exim does not check the syntax of these headers.
34411 .next
34412 The second item forms the start of the warning message. After it, Exim lists
34413 the delayed addresses.
34414 .next
34415 The third item then ends the message.
34416 .endlist
34417
34418 The default state is equivalent to the following file, except that some lines
34419 have been split here, in order to fit them on the page:
34420 .code
34421 Subject: Warning: message $message_exim_id delayed
34422   $warn_message_delay
34423 ****
34424 This message was created automatically by mail delivery software.
34425
34426 A message ${if eq{$sender_address}{$warn_message_recipients}
34427 {that you sent }{sent by
34428
34429 <$sender_address>
34430
34431 }}has not been delivered to all of its recipients after
34432 more than $warn_message_delay on the queue on $primary_hostname.
34433
34434 The message identifier is:     $message_exim_id
34435 The subject of the message is: $h_subject
34436 The date of the message is:    $h_date
34437
34438 The following address(es) have not yet been delivered:
34439 ****
34440 No action is required on your part. Delivery attempts will
34441 continue for some time, and this warning may be repeated at
34442 intervals if the message remains undelivered. Eventually the
34443 mail delivery software will give up, and when that happens,
34444 the message will be returned to you.
34445 .endd
34446 .vindex "&$warn_message_delay$&"
34447 .vindex "&$warn_message_recipients$&"
34448 However, in the default state the subject and date lines are omitted if no
34449 appropriate headers exist. During the expansion of this file,
34450 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34451 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34452 of recipients for the warning message. There may be more than one if there are
34453 multiple addresses with different &%errors_to%& settings on the routers that
34454 handled them.
34455
34456
34457
34458
34459 . ////////////////////////////////////////////////////////////////////////////
34460 . ////////////////////////////////////////////////////////////////////////////
34461
34462 .chapter "Some common configuration settings" "CHAPcomconreq"
34463 This chapter discusses some configuration settings that seem to be fairly
34464 common. More examples and discussion can be found in the Exim book.
34465
34466
34467
34468 .section "Sending mail to a smart host" "SECID240"
34469 .cindex "smart host" "example router"
34470 If you want to send all mail for non-local domains to a &"smart host"&, you
34471 should replace the default &(dnslookup)& router with a router which does the
34472 routing explicitly:
34473 .code
34474 send_to_smart_host:
34475   driver = manualroute
34476   route_list = !+local_domains smart.host.name
34477   transport = remote_smtp
34478 .endd
34479 You can use the smart host's IP address instead of the name if you wish.
34480 If you are using Exim only to submit messages to a smart host, and not for
34481 receiving incoming messages, you can arrange for it to do the submission
34482 synchronously by setting the &%mua_wrapper%& option (see chapter
34483 &<<CHAPnonqueueing>>&).
34484
34485
34486
34487
34488 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34489 .cindex "mailing lists"
34490 Exim can be used to run simple mailing lists, but for large and/or complicated
34491 requirements, the use of additional specialized mailing list software such as
34492 Majordomo or Mailman is recommended.
34493
34494 The &(redirect)& router can be used to handle mailing lists where each list
34495 is maintained in a separate file, which can therefore be managed by an
34496 independent manager. The &%domains%& router option can be used to run these
34497 lists in a separate domain from normal mail. For example:
34498 .code
34499 lists:
34500   driver = redirect
34501   domains = lists.example
34502   file = /usr/lists/$local_part
34503   forbid_pipe
34504   forbid_file
34505   errors_to = $local_part-request@lists.example
34506   no_more
34507 .endd
34508 This router is skipped for domains other than &'lists.example'&. For addresses
34509 in that domain, it looks for a file that matches the local part. If there is no
34510 such file, the router declines, but because &%no_more%& is set, no subsequent
34511 routers are tried, and so the whole delivery fails.
34512
34513 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34514 expanded into a file name or a pipe delivery, which is usually inappropriate in
34515 a mailing list.
34516
34517 .oindex "&%errors_to%&"
34518 The &%errors_to%& option specifies that any delivery errors caused by addresses
34519 taken from a mailing list are to be sent to the given address rather than the
34520 original sender of the message. However, before acting on this, Exim verifies
34521 the error address, and ignores it if verification fails.
34522
34523 For example, using the configuration above, mail sent to
34524 &'dicts@lists.example'& is passed on to those addresses contained in
34525 &_/usr/lists/dicts_&, with error reports directed to
34526 &'dicts-request@lists.example'&, provided that this address can be verified.
34527 There could be a file called &_/usr/lists/dicts-request_& containing
34528 the address(es) of this particular list's manager(s), but other approaches,
34529 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34530 or &%local_part_suffix%& options) to handle addresses of the form
34531 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34532
34533
34534
34535 .section "Syntax errors in mailing lists" "SECID241"
34536 .cindex "mailing lists" "syntax errors in"
34537 If an entry in redirection data contains a syntax error, Exim normally defers
34538 delivery of the original address. That means that a syntax error in a mailing
34539 list holds up all deliveries to the list. This may not be appropriate when a
34540 list is being maintained automatically from data supplied by users, and the
34541 addresses are not rigorously checked.
34542
34543 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34544 entries that fail to parse, noting the incident in the log. If in addition
34545 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34546 whenever a broken address is skipped. It is usually appropriate to set
34547 &%syntax_errors_to%& to the same address as &%errors_to%&.
34548
34549
34550
34551 .section "Re-expansion of mailing lists" "SECID242"
34552 .cindex "mailing lists" "re-expansion of"
34553 Exim remembers every individual address to which a message has been delivered,
34554 in order to avoid duplication, but it normally stores only the original
34555 recipient addresses with a message. If all the deliveries to a mailing list
34556 cannot be done at the first attempt, the mailing list is re-expanded when the
34557 delivery is next tried. This means that alterations to the list are taken into
34558 account at each delivery attempt, so addresses that have been added to
34559 the list since the message arrived will therefore receive a copy of the
34560 message, even though it pre-dates their subscription.
34561
34562 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34563 on the &(redirect)& router. If this is done, any addresses generated by the
34564 router that fail to deliver at the first attempt are added to the message as
34565 &"top level"& addresses, and the parent address that generated them is marked
34566 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34567 subsequent delivery attempts. The disadvantage of this is that if any of the
34568 failing addresses are incorrect, correcting them in the file has no effect on
34569 pre-existing messages.
34570
34571 The original top-level address is remembered with each of the generated
34572 addresses, and is output in any log messages. However, any intermediate parent
34573 addresses are not recorded. This makes a difference to the log only if the
34574 &%all_parents%& selector is set, but for mailing lists there is normally only
34575 one level of expansion anyway.
34576
34577
34578
34579 .section "Closed mailing lists" "SECID243"
34580 .cindex "mailing lists" "closed"
34581 The examples so far have assumed open mailing lists, to which anybody may
34582 send mail. It is also possible to set up closed lists, where mail is accepted
34583 from specified senders only. This is done by making use of the generic
34584 &%senders%& option to restrict the router that handles the list.
34585
34586 The following example uses the same file as a list of recipients and as a list
34587 of permitted senders. It requires three routers:
34588 .code
34589 lists_request:
34590   driver = redirect
34591   domains = lists.example
34592   local_part_suffix = -request
34593   file = /usr/lists/$local_part$local_part_suffix
34594   no_more
34595
34596 lists_post:
34597   driver = redirect
34598   domains = lists.example
34599   senders = ${if exists {/usr/lists/$local_part}\
34600              {lsearch;/usr/lists/$local_part}{*}}
34601   file = /usr/lists/$local_part
34602   forbid_pipe
34603   forbid_file
34604   errors_to = $local_part-request@lists.example
34605   no_more
34606
34607 lists_closed:
34608   driver = redirect
34609   domains = lists.example
34610   allow_fail
34611   data = :fail: $local_part@lists.example is a closed mailing list
34612 .endd
34613 All three routers have the same &%domains%& setting, so for any other domains,
34614 they are all skipped. The first router runs only if the local part ends in
34615 &%-request%&. It handles messages to the list manager(s) by means of an open
34616 mailing list.
34617
34618 The second router runs only if the &%senders%& precondition is satisfied. It
34619 checks for the existence of a list that corresponds to the local part, and then
34620 checks that the sender is on the list by means of a linear search. It is
34621 necessary to check for the existence of the file before trying to search it,
34622 because otherwise Exim thinks there is a configuration error. If the file does
34623 not exist, the expansion of &%senders%& is *, which matches all senders. This
34624 means that the router runs, but because there is no list, declines, and
34625 &%no_more%& ensures that no further routers are run. The address fails with an
34626 &"unrouteable address"& error.
34627
34628 The third router runs only if the second router is skipped, which happens when
34629 a mailing list exists, but the sender is not on it. This router forcibly fails
34630 the address, giving a suitable error message.
34631
34632
34633
34634
34635 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34636 .cindex "VERP"
34637 .cindex "Variable Envelope Return Paths"
34638 .cindex "envelope sender"
34639 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34640 are a way of helping mailing list administrators discover which subscription
34641 address is the cause of a particular delivery failure. The idea is to encode
34642 the original recipient address in the outgoing envelope sender address, so that
34643 if the message is forwarded by another host and then subsequently bounces, the
34644 original recipient can be extracted from the recipient address of the bounce.
34645
34646 .oindex &%errors_to%&
34647 .oindex &%return_path%&
34648 Envelope sender addresses can be modified by Exim using two different
34649 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34650 list examples), or the &%return_path%& option on a transport. The second of
34651 these is effective only if the message is successfully delivered to another
34652 host; it is not used for errors detected on the local host (see the description
34653 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34654 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34655 .code
34656 verp_smtp:
34657   driver = smtp
34658   max_rcpt = 1
34659   return_path = \
34660     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34661       {$1-request+$local_part=$domain@your.dom.example}fail}
34662 .endd
34663 This has the effect of rewriting the return path (envelope sender) on outgoing
34664 SMTP messages, if the local part of the original return path ends in
34665 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34666 local part and domain of the recipient into the return path. Suppose, for
34667 example, that a message whose return path has been set to
34668 &'somelist-request@your.dom.example'& is sent to
34669 &'subscriber@other.dom.example'&. In the transport, the return path is
34670 rewritten as
34671 .code
34672 somelist-request+subscriber=other.dom.example@your.dom.example
34673 .endd
34674 .vindex "&$local_part$&"
34675 For this to work, you must tell Exim to send multiple copies of messages that
34676 have more than one recipient, so that each copy has just one recipient. This is
34677 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34678 might be sent to several different recipients in the same domain, in which case
34679 &$local_part$& is not available in the transport, because it is not unique.
34680
34681 Unless your host is doing nothing but mailing list deliveries, you should
34682 probably use a separate transport for the VERP deliveries, so as not to use
34683 extra resources in making one-per-recipient copies for other deliveries. This
34684 can easily be done by expanding the &%transport%& option in the router:
34685 .code
34686 dnslookup:
34687   driver = dnslookup
34688   domains = ! +local_domains
34689   transport = \
34690     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34691       {verp_smtp}{remote_smtp}}
34692   no_more
34693 .endd
34694 If you want to change the return path using &%errors_to%& in a router instead
34695 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34696 routers that handle mailing list addresses. This will ensure that all delivery
34697 errors, including those detected on the local host, are sent to the VERP
34698 address.
34699
34700 On a host that does no local deliveries and has no manual routing, only the
34701 &(dnslookup)& router needs to be changed. A special transport is not needed for
34702 SMTP deliveries. Every mailing list recipient has its own return path value,
34703 and so Exim must hand them to the transport one at a time. Here is an example
34704 of a &(dnslookup)& router that implements VERP:
34705 .code
34706 verp_dnslookup:
34707   driver = dnslookup
34708   domains = ! +local_domains
34709   transport = remote_smtp
34710   errors_to = \
34711     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34712      {$1-request+$local_part=$domain@your.dom.example}fail}
34713   no_more
34714 .endd
34715 Before you start sending out messages with VERPed return paths, you must also
34716 configure Exim to accept the bounce messages that come back to those paths.
34717 Typically this is done by setting a &%local_part_suffix%& option for a
34718 router, and using this to route the messages to wherever you want to handle
34719 them.
34720
34721 The overhead incurred in using VERP depends very much on the size of the
34722 message, the number of recipient addresses that resolve to the same remote
34723 host, and the speed of the connection over which the message is being sent. If
34724 a lot of addresses resolve to the same host and the connection is slow, sending
34725 a separate copy of the message for each address may take substantially longer
34726 than sending a single copy with many recipients (for which VERP cannot be
34727 used).
34728
34729
34730
34731
34732
34733
34734 .section "Virtual domains" "SECTvirtualdomains"
34735 .cindex "virtual domains"
34736 .cindex "domain" "virtual"
34737 The phrase &'virtual domain'& is unfortunately used with two rather different
34738 meanings:
34739
34740 .ilist
34741 A domain for which there are no real mailboxes; all valid local parts are
34742 aliases for other email addresses. Common examples are organizational
34743 top-level domains and &"vanity"& domains.
34744 .next
34745 One of a number of independent domains that are all handled by the same host,
34746 with mailboxes on that host, but where the mailbox owners do not necessarily
34747 have login accounts on that host.
34748 .endlist
34749
34750 The first usage is probably more common, and does seem more &"virtual"& than
34751 the second. This kind of domain can be handled in Exim with a straightforward
34752 aliasing router. One approach is to create a separate alias file for each
34753 virtual domain. Exim can test for the existence of the alias file to determine
34754 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34755 to a router of this form:
34756 .code
34757 virtual:
34758   driver = redirect
34759   domains = dsearch;/etc/mail/virtual
34760   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34761   no_more
34762 .endd
34763 The &%domains%& option specifies that the router is to be skipped, unless there
34764 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34765 domain that is being processed. When the router runs, it looks up the local
34766 part in the file to find a new address (or list of addresses). The &%no_more%&
34767 setting ensures that if the lookup fails (leading to &%data%& being an empty
34768 string), Exim gives up on the address without trying any subsequent routers.
34769
34770 This one router can handle all the virtual domains because the alias file names
34771 follow a fixed pattern. Permissions can be arranged so that appropriate people
34772 can edit the different alias files. A successful aliasing operation results in
34773 a new envelope recipient address, which is then routed from scratch.
34774
34775 The other kind of &"virtual"& domain can also be handled in a straightforward
34776 way. One approach is to create a file for each domain containing a list of
34777 valid local parts, and use it in a router like this:
34778 .code
34779 my_domains:
34780   driver = accept
34781   domains = dsearch;/etc/mail/domains
34782   local_parts = lsearch;/etc/mail/domains/$domain
34783   transport = my_mailboxes
34784 .endd
34785 The address is accepted if there is a file for the domain, and the local part
34786 can be found in the file. The &%domains%& option is used to check for the
34787 file's existence because &%domains%& is tested before the &%local_parts%&
34788 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34789 because that option is tested after &%local_parts%&. The transport is as
34790 follows:
34791 .code
34792 my_mailboxes:
34793   driver = appendfile
34794   file = /var/mail/$domain/$local_part
34795   user = mail
34796 .endd
34797 This uses a directory of mailboxes for each domain. The &%user%& setting is
34798 required, to specify which uid is to be used for writing to the mailboxes.
34799
34800 The configuration shown here is just one example of how you might support this
34801 requirement. There are many other ways this kind of configuration can be set
34802 up, for example, by using a database instead of separate files to hold all the
34803 information about the domains.
34804
34805
34806
34807 .section "Multiple user mailboxes" "SECTmulbox"
34808 .cindex "multiple mailboxes"
34809 .cindex "mailbox" "multiple"
34810 .cindex "local part" "prefix"
34811 .cindex "local part" "suffix"
34812 Heavy email users often want to operate with multiple mailboxes, into which
34813 incoming mail is automatically sorted. A popular way of handling this is to
34814 allow users to use multiple sender addresses, so that replies can easily be
34815 identified. Users are permitted to add prefixes or suffixes to their local
34816 parts for this purpose. The wildcard facility of the generic router options
34817 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34818 example, consider this router:
34819 .code
34820 userforward:
34821   driver = redirect
34822   check_local_user
34823   file = $home/.forward
34824   local_part_suffix = -*
34825   local_part_suffix_optional
34826   allow_filter
34827 .endd
34828 .vindex "&$local_part_suffix$&"
34829 It runs a user's &_.forward_& file for all local parts of the form
34830 &'username-*'&. Within the filter file the user can distinguish different
34831 cases by testing the variable &$local_part_suffix$&. For example:
34832 .code
34833 if $local_part_suffix contains -special then
34834 save /home/$local_part/Mail/special
34835 endif
34836 .endd
34837 If the filter file does not exist, or does not deal with such addresses, they
34838 fall through to subsequent routers, and, assuming no subsequent use of the
34839 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34840 control over which suffixes are valid.
34841
34842 Alternatively, a suffix can be used to trigger the use of a different
34843 &_.forward_& file &-- which is the way a similar facility is implemented in
34844 another MTA:
34845 .code
34846 userforward:
34847   driver = redirect
34848   check_local_user
34849   file = $home/.forward$local_part_suffix
34850   local_part_suffix = -*
34851   local_part_suffix_optional
34852   allow_filter
34853 .endd
34854 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34855 example, &_.forward-special_& is used. Once again, if the appropriate file
34856 does not exist, or does not deal with the address, it is passed on to
34857 subsequent routers, which could, if required, look for an unqualified
34858 &_.forward_& file to use as a default.
34859
34860
34861
34862 .section "Simplified vacation processing" "SECID244"
34863 .cindex "vacation processing"
34864 The traditional way of running the &'vacation'& program is for a user to set up
34865 a pipe command in a &_.forward_& file
34866 (see section &<<SECTspecitredli>>& for syntax details).
34867 This is prone to error by inexperienced users. There are two features of Exim
34868 that can be used to make this process simpler for users:
34869
34870 .ilist
34871 A local part prefix such as &"vacation-"& can be specified on a router which
34872 can cause the message to be delivered directly to the &'vacation'& program, or
34873 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34874 &_.forward_& file are then much simpler. For example:
34875 .code
34876 spqr, vacation-spqr
34877 .endd
34878 .next
34879 The &%require_files%& generic router option can be used to trigger a
34880 vacation delivery by checking for the existence of a certain file in the
34881 user's home directory. The &%unseen%& generic option should also be used, to
34882 ensure that the original delivery also proceeds. In this case, all the user has
34883 to do is to create a file called, say, &_.vacation_&, containing a vacation
34884 message.
34885 .endlist
34886
34887 Another advantage of both these methods is that they both work even when the
34888 use of arbitrary pipes by users is locked out.
34889
34890
34891
34892 .section "Taking copies of mail" "SECID245"
34893 .cindex "message" "copying every"
34894 Some installations have policies that require archive copies of all messages to
34895 be made. A single copy of each message can easily be taken by an appropriate
34896 command in a system filter, which could, for example, use a different file for
34897 each day's messages.
34898
34899 There is also a shadow transport mechanism that can be used to take copies of
34900 messages that are successfully delivered by local transports, one copy per
34901 delivery. This could be used, &'inter alia'&, to implement automatic
34902 notification of delivery by sites that insist on doing such things.
34903
34904
34905
34906 .section "Intermittently connected hosts" "SECID246"
34907 .cindex "intermittently connected hosts"
34908 It has become quite common (because it is cheaper) for hosts to connect to the
34909 Internet periodically rather than remain connected all the time. The normal
34910 arrangement is that mail for such hosts accumulates on a system that is
34911 permanently connected.
34912
34913 Exim was designed for use on permanently connected hosts, and so it is not
34914 particularly well-suited to use in an intermittently connected environment.
34915 Nevertheless there are some features that can be used.
34916
34917
34918 .section "Exim on the upstream server host" "SECID247"
34919 It is tempting to arrange for incoming mail for the intermittently connected
34920 host to remain on Exim's queue until the client connects. However, this
34921 approach does not scale very well. Two different kinds of waiting message are
34922 being mixed up in the same queue &-- those that cannot be delivered because of
34923 some temporary problem, and those that are waiting for their destination host
34924 to connect. This makes it hard to manage the queue, as well as wasting
34925 resources, because each queue runner scans the entire queue.
34926
34927 A better approach is to separate off those messages that are waiting for an
34928 intermittently connected host. This can be done by delivering these messages
34929 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34930 format, from where they are transmitted by other software when their
34931 destination connects. This makes it easy to collect all the mail for one host
34932 in a single directory, and to apply local timeout rules on a per-message basis
34933 if required.
34934
34935 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34936 you are doing this, you should configure Exim with a long retry period for the
34937 intermittent host. For example:
34938 .code
34939 cheshire.wonderland.fict.example    *   F,5d,24h
34940 .endd
34941 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34942 which messages it has queued up for that host. Once the intermittent host comes
34943 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34944 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34945 causes all the queued up messages to be delivered, often down a single SMTP
34946 connection. While the host remains connected, any new messages get delivered
34947 immediately.
34948
34949 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34950 issued with a different IP address each time it connects, Exim's retry
34951 mechanisms on the holding host get confused, because the IP address is normally
34952 used as part of the key string for holding retry information. This can be
34953 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34954 Since this has disadvantages for permanently connected hosts, it is best to
34955 arrange a separate transport for the intermittently connected ones.
34956
34957
34958
34959 .section "Exim on the intermittently connected client host" "SECID248"
34960 The value of &%smtp_accept_queue_per_connection%& should probably be
34961 increased, or even set to zero (that is, disabled) on the intermittently
34962 connected host, so that all incoming messages down a single connection get
34963 delivered immediately.
34964
34965 .cindex "SMTP" "passed connection"
34966 .cindex "SMTP" "multiple deliveries"
34967 .cindex "multiple SMTP deliveries"
34968 Mail waiting to be sent from an intermittently connected host will probably
34969 not have been routed, because without a connection DNS lookups are not
34970 possible. This means that if a normal queue run is done at connection time,
34971 each message is likely to be sent in a separate SMTP session. This can be
34972 avoided by starting the queue run with a command line option beginning with
34973 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34974 first pass, routing is done but no deliveries take place. The second pass is a
34975 normal queue run; since all the messages have been previously routed, those
34976 destined for the same host are likely to get sent as multiple deliveries in a
34977 single SMTP connection.
34978
34979
34980
34981 . ////////////////////////////////////////////////////////////////////////////
34982 . ////////////////////////////////////////////////////////////////////////////
34983
34984 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34985          "Exim as a non-queueing client"
34986 .cindex "client, non-queueing"
34987 .cindex "smart host" "suppressing queueing"
34988 On a personal computer, it is a common requirement for all
34989 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34990 configured to operate that way, for all the popular operating systems.
34991 However, there are some MUAs for Unix-like systems that cannot be so
34992 configured: they submit messages using the command line interface of
34993 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34994 messages this way.
34995
34996 If the personal computer runs continuously, there is no problem, because it can
34997 run a conventional MTA that handles delivery to the smart host, and deal with
34998 any delays via its queueing mechanism. However, if the computer does not run
34999 continuously or runs different operating systems at different times, queueing
35000 email is not desirable.
35001
35002 There is therefore a requirement for something that can provide the
35003 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35004 any queueing or retrying facilities. Furthermore, the delivery to the smart
35005 host should be synchronous, so that if it fails, the sending MUA is immediately
35006 informed. In other words, we want something that extends an MUA that submits
35007 to a local MTA via the command line so that it behaves like one that submits
35008 to a remote smart host using TCP/SMTP.
35009
35010 There are a number of applications (for example, there is one called &'ssmtp'&)
35011 that do this job. However, people have found them to be lacking in various
35012 ways. For instance, you might want to allow aliasing and forwarding to be done
35013 before sending a message to the smart host.
35014
35015 Exim already had the necessary infrastructure for doing this job. Just a few
35016 tweaks were needed to make it behave as required, though it is somewhat of an
35017 overkill to use a fully-featured MTA for this purpose.
35018
35019 .oindex "&%mua_wrapper%&"
35020 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35021 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35022 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35023 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35024 compatible router and transport configuration. Typically there will be just one
35025 router and one transport, sending everything to a smart host.
35026
35027 When run in MUA wrapping mode, the behaviour of Exim changes in the
35028 following ways:
35029
35030 .ilist
35031 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35032 In other words, the only way to submit messages is via the command line.
35033 .next
35034 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35035 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35036 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35037 does not finish until the delivery attempt is complete. If the delivery is
35038 successful, a zero return code is given.
35039 .next
35040 Address redirection is permitted, but the final routing for all addresses must
35041 be to the same remote transport, and to the same list of hosts. Furthermore,
35042 the return address (envelope sender) must be the same for all recipients, as
35043 must any added or deleted header lines. In other words, it must be possible to
35044 deliver the message in a single SMTP transaction, however many recipients there
35045 are.
35046 .next
35047 If these conditions are not met, or if routing any address results in a
35048 failure or defer status, or if Exim is unable to deliver all the recipients
35049 successfully to one of the smart hosts, delivery of the entire message fails.
35050 .next
35051 Because no queueing is allowed, all failures are treated as permanent; there
35052 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35053 smart host. Furthermore, because only a single yes/no response can be given to
35054 the caller, it is not possible to deliver to some recipients and not others. If
35055 there is an error (temporary or permanent) for any recipient, all are failed.
35056 .next
35057 If more than one smart host is listed, Exim will try another host after a
35058 connection failure or a timeout, in the normal way. However, if this kind of
35059 failure happens for all the hosts, the delivery fails.
35060 .next
35061 When delivery fails, an error message is written to the standard error stream
35062 (as well as to Exim's log), and Exim exits to the caller with a return code
35063 value 1. The message is expunged from Exim's spool files. No bounce messages
35064 are ever generated.
35065 .next
35066 No retry data is maintained, and any retry rules are ignored.
35067 .next
35068 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35069 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35070 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35071 .endlist
35072
35073 The overall effect is that Exim makes a single synchronous attempt to deliver
35074 the message, failing if there is any kind of problem. Because no local
35075 deliveries are done and no daemon can be run, Exim does not need root
35076 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35077 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35078 the advantages and disadvantages of running without root privilege.
35079
35080
35081
35082
35083 . ////////////////////////////////////////////////////////////////////////////
35084 . ////////////////////////////////////////////////////////////////////////////
35085
35086 .chapter "Log files" "CHAPlog"
35087 .scindex IIDloggen "log" "general description"
35088 .cindex "log" "types of"
35089 Exim writes three different logs, referred to as the main log, the reject log,
35090 and the panic log:
35091
35092 .ilist
35093 .cindex "main log"
35094 The main log records the arrival of each message and each delivery in a single
35095 line in each case. The format is as compact as possible, in an attempt to keep
35096 down the size of log files. Two-character flag sequences make it easy to pick
35097 out these lines. A number of other events are recorded in the main log. Some of
35098 them are optional, in which case the &%log_selector%& option controls whether
35099 they are included or not. A Perl script called &'eximstats'&, which does simple
35100 analysis of main log files, is provided in the Exim distribution (see section
35101 &<<SECTmailstat>>&).
35102 .next
35103 .cindex "reject log"
35104 The reject log records information from messages that are rejected as a result
35105 of a configuration option (that is, for policy reasons).
35106 The first line of each rejection is a copy of the line that is also written to
35107 the main log. Then, if the message's header has been read at the time the log
35108 is written, its contents are written to this log. Only the original header
35109 lines are available; header lines added by ACLs are not logged. You can use the
35110 reject log to check that your policy controls are working correctly; on a busy
35111 host this may be easier than scanning the main log for rejection messages. You
35112 can suppress the writing of the reject log by setting &%write_rejectlog%&
35113 false.
35114 .next
35115 .cindex "panic log"
35116 .cindex "system log"
35117 When certain serious errors occur, Exim writes entries to its panic log. If the
35118 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35119 are usually written to the main log as well, but can get lost amid the mass of
35120 other entries. The panic log should be empty under normal circumstances. It is
35121 therefore a good idea to check it (or to have a &'cron'& script check it)
35122 regularly, in order to become aware of any problems. When Exim cannot open its
35123 panic log, it tries as a last resort to write to the system log (syslog). This
35124 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35125 message itself is written at priority LOG_CRIT.
35126 .endlist
35127
35128 Every log line starts with a timestamp, in the format shown in the following
35129 example. Note that many of the examples shown in this chapter are line-wrapped.
35130 In the log file, this would be all on one line:
35131 .code
35132 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35133   by QUIT
35134 .endd
35135 By default, the timestamps are in the local timezone. There are two
35136 ways of changing this:
35137
35138 .ilist
35139 You can set the &%timezone%& option to a different time zone; in particular, if
35140 you set
35141 .code
35142 timezone = UTC
35143 .endd
35144 the timestamps will be in UTC (aka GMT).
35145 .next
35146 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35147 example:
35148 .code
35149 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35150 .endd
35151 .endlist
35152
35153 .cindex "log" "process ids in"
35154 .cindex "pid (process id)" "in log lines"
35155 Exim does not include its process id in log lines by default, but you can
35156 request that it does so by specifying the &`pid`& log selector (see section
35157 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35158 brackets, immediately after the time and date.
35159
35160
35161
35162
35163 .section "Where the logs are written" "SECTwhelogwri"
35164 .cindex "log" "destination"
35165 .cindex "log" "to file"
35166 .cindex "log" "to syslog"
35167 .cindex "syslog"
35168 The logs may be written to local files, or to syslog, or both. However, it
35169 should be noted that many syslog implementations use UDP as a transport, and
35170 are therefore unreliable in the sense that messages are not guaranteed to
35171 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35172 It has also been reported that on large log files (tens of megabytes) you may
35173 need to tweak syslog to prevent it syncing the file with each write &-- on
35174 Linux this has been seen to make syslog take 90% plus of CPU time.
35175
35176 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35177 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35178 configuration. This latter string is expanded, so it can contain, for example,
35179 references to the host name:
35180 .code
35181 log_file_path = /var/log/$primary_hostname/exim_%slog
35182 .endd
35183 It is generally advisable, however, to set the string in &_Local/Makefile_&
35184 rather than at run time, because then the setting is available right from the
35185 start of Exim's execution. Otherwise, if there's something it wants to log
35186 before it has read the configuration file (for example, an error in the
35187 configuration file) it will not use the path you want, and may not be able to
35188 log at all.
35189
35190 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35191 list, currently limited to at most two items. This is one option where the
35192 facility for changing a list separator may not be used. The list must always be
35193 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35194 otherwise the item must either be an absolute path, containing &`%s`& at the
35195 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35196 implying the use of a default path.
35197
35198 When Exim encounters an empty item in the list, it searches the list defined by
35199 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35200 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35201 mean &"use the path specified at build time"&. It no such item exists, log
35202 files are written in the &_log_& subdirectory of the spool directory. This is
35203 equivalent to the setting:
35204 .code
35205 log_file_path = $spool_directory/log/%slog
35206 .endd
35207 If you do not specify anything at build time or run time,
35208 or if you unset the option at run time (i.e. &`log_file_path = `&),
35209 that is where the logs are written.
35210
35211 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35212 are in use &-- see section &<<SECTdatlogfil>>& below.
35213
35214 Here are some examples of possible settings:
35215 .display
35216 &`LOG_FILE_PATH=syslog                    `& syslog only
35217 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35218 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35219 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35220 .endd
35221 If there are more than two paths in the list, the first is used and a panic
35222 error is logged.
35223
35224
35225
35226 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35227 .cindex "log" "cycling local files"
35228 .cindex "cycling logs"
35229 .cindex "&'exicyclog'&"
35230 .cindex "log" "local files; writing to"
35231 Some operating systems provide centralized and standardized methods for cycling
35232 log files. For those that do not, a utility script called &'exicyclog'& is
35233 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35234 main and reject logs each time it is called. The maximum number of old logs to
35235 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35236
35237 An Exim delivery process opens the main log when it first needs to write to it,
35238 and it keeps the file open in case subsequent entries are required &-- for
35239 example, if a number of different deliveries are being done for the same
35240 message. However, remote SMTP deliveries can take a long time, and this means
35241 that the file may be kept open long after it is renamed if &'exicyclog'& or
35242 something similar is being used to rename log files on a regular basis. To
35243 ensure that a switch of log files is noticed as soon as possible, Exim calls
35244 &[stat()]& on the main log's name before reusing an open file, and if the file
35245 does not exist, or its inode has changed, the old file is closed and Exim
35246 tries to open the main log from scratch. Thus, an old log file may remain open
35247 for quite some time, but no Exim processes should write to it once it has been
35248 renamed.
35249
35250
35251
35252 .section "Datestamped log files" "SECTdatlogfil"
35253 .cindex "log" "datestamped files"
35254 Instead of cycling the main and reject log files by renaming them
35255 periodically, some sites like to use files whose names contain a datestamp,
35256 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35257 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35258 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35259 point where the datestamp is required. For example:
35260 .code
35261 log_file_path = /var/spool/exim/log/%slog-%D
35262 log_file_path = /var/log/exim-%s-%D.log
35263 log_file_path = /var/spool/exim/log/%D-%slog
35264 log_file_path = /var/log/exim/%s.%M
35265 .endd
35266 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35267 examples of names generated by the above examples:
35268 .code
35269 /var/spool/exim/log/mainlog-20021225
35270 /var/log/exim-reject-20021225.log
35271 /var/spool/exim/log/20021225-mainlog
35272 /var/log/exim/main.200212
35273 .endd
35274 When this form of log file is specified, Exim automatically switches to new
35275 files at midnight. It does not make any attempt to compress old logs; you
35276 will need to write your own script if you require this. You should not
35277 run &'exicyclog'& with this form of logging.
35278
35279 The location of the panic log is also determined by &%log_file_path%&, but it
35280 is not datestamped, because rotation of the panic log does not make sense.
35281 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35282 the string. In addition, if it immediately follows a slash, a following
35283 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35284 character is removed. Thus, the four examples above would give these panic
35285 log names:
35286 .code
35287 /var/spool/exim/log/paniclog
35288 /var/log/exim-panic.log
35289 /var/spool/exim/log/paniclog
35290 /var/log/exim/panic
35291 .endd
35292
35293
35294 .section "Logging to syslog" "SECID249"
35295 .cindex "log" "syslog; writing to"
35296 The use of syslog does not change what Exim logs or the format of its messages,
35297 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35298 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35299 that, the same strings are written to syslog as to log files. The syslog
35300 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35301 by default, but you can change these by setting the &%syslog_facility%& and
35302 &%syslog_processname%& options, respectively. If Exim was compiled with
35303 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35304 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35305 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35306 the time and host name to each line.
35307 The three log streams are mapped onto syslog priorities as follows:
35308
35309 .ilist
35310 &'mainlog'& is mapped to LOG_INFO
35311 .next
35312 &'rejectlog'& is mapped to LOG_NOTICE
35313 .next
35314 &'paniclog'& is mapped to LOG_ALERT
35315 .endlist
35316
35317 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35318 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35319 these are routed by syslog to the same place. You can suppress this duplication
35320 by setting &%syslog_duplication%& false.
35321
35322 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35323 entries contain multiple lines when headers are included. To cope with both
35324 these cases, entries written to syslog are split into separate &[syslog()]&
35325 calls at each internal newline, and also after a maximum of
35326 870 data characters. (This allows for a total syslog line length of 1024, when
35327 additions such as timestamps are added.) If you are running a syslog
35328 replacement that can handle lines longer than the 1024 characters allowed by
35329 RFC 3164, you should set
35330 .code
35331 SYSLOG_LONG_LINES=yes
35332 .endd
35333 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35334 lines, but it still splits at internal newlines in &'reject'& log entries.
35335
35336 To make it easy to re-assemble split lines later, each component of a split
35337 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35338 where <&'n'&> is the component number and <&'m'&> is the total number of
35339 components in the entry. The / delimiter is used when the line was split
35340 because it was too long; if it was split because of an internal newline, the \
35341 delimiter is used. For example, supposing the length limit to be 50 instead of
35342 870, the following would be the result of a typical rejection message to
35343 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35344 name, and pid as added by syslog:
35345 .code
35346 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35347 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35348 [3/5]  when scanning for sender: missing or malformed lo
35349 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35350 [5/5] mple>)
35351 .endd
35352 The same error might cause the following lines to be written to &"rejectlog"&
35353 (LOG_NOTICE):
35354 .code
35355 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35356 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35357 [3/18] er when scanning for sender: missing or malformed
35358 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35359 [5\18] .example>)
35360 [6\18] Recipients: ph10@some.domain.cam.example
35361 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35362 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35363 [9\18]        id 16RdAL-0006pc-00
35364 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35365 [11\18] 09:43 +0100
35366 [12\18] F From: <>
35367 [13\18]   Subject: this is a test header
35368 [18\18]   X-something: this is another header
35369 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35370 [16\18] le>
35371 [17\18] B Bcc:
35372 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35373 .endd
35374 Log lines that are neither too long nor contain newlines are written to syslog
35375 without modification.
35376
35377 If only syslog is being used, the Exim monitor is unable to provide a log tail
35378 display, unless syslog is routing &'mainlog'& to a file on the local host and
35379 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35380 where it is.
35381
35382
35383
35384 .section "Log line flags" "SECID250"
35385 One line is written to the main log for each message received, and for each
35386 successful, unsuccessful, and delayed delivery. These lines can readily be
35387 picked out by the distinctive two-character flags that immediately follow the
35388 timestamp. The flags are:
35389 .display
35390 &`<=`&     message arrival
35391 &`=>`&     normal message delivery
35392 &`->`&     additional address in same delivery
35393 &`>>`&     cutthrough message delivery
35394 &`*>`&     delivery suppressed by &%-N%&
35395 &`**`&     delivery failed; address bounced
35396 &`==`&     delivery deferred; temporary problem
35397 .endd
35398
35399
35400 .section "Logging message reception" "SECID251"
35401 .cindex "log" "reception line"
35402 The format of the single-line entry in the main log that is written for every
35403 message received is shown in the basic example below, which is split over
35404 several lines in order to fit it on the page:
35405 .code
35406 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35407   H=mailer.fict.example [192.168.123.123] U=exim
35408   P=smtp S=5678 id=<incoming message id>
35409 .endd
35410 The address immediately following &"<="& is the envelope sender address. A
35411 bounce message is shown with the sender address &"<>"&, and if it is locally
35412 generated, this is followed by an item of the form
35413 .code
35414 R=<message id>
35415 .endd
35416 which is a reference to the message that caused the bounce to be sent.
35417
35418 .cindex "HELO"
35419 .cindex "EHLO"
35420 For messages from other hosts, the H and U fields identify the remote host and
35421 record the RFC 1413 identity of the user that sent the message, if one was
35422 received. The number given in square brackets is the IP address of the sending
35423 host. If there is a single, unparenthesized  host name in the H field, as
35424 above, it has been verified to correspond to the IP address (see the
35425 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35426 by the remote host in the SMTP HELO or EHLO command, and has not been
35427 verified. If verification yields a different name to that given for HELO or
35428 EHLO, the verified name appears first, followed by the HELO or EHLO
35429 name in parentheses.
35430
35431 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35432 without brackets, in the HELO or EHLO command, leading to entries in
35433 the log containing text like these examples:
35434 .code
35435 H=(10.21.32.43) [192.168.8.34]
35436 H=([10.21.32.43]) [192.168.8.34]
35437 .endd
35438 This can be confusing. Only the final address in square brackets can be relied
35439 on.
35440
35441 For locally generated messages (that is, messages not received over TCP/IP),
35442 the H field is omitted, and the U field contains the login name of the caller
35443 of Exim.
35444
35445 .cindex "authentication" "logging"
35446 .cindex "AUTH" "logging"
35447 For all messages, the P field specifies the protocol used to receive the
35448 message. This is the value that is stored in &$received_protocol$&. In the case
35449 of incoming SMTP messages, the value indicates whether or not any SMTP
35450 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35451 session was encrypted, there is an additional X field that records the cipher
35452 suite that was used.
35453
35454 .cindex log protocol
35455 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35456 hosts that have authenticated themselves using the SMTP AUTH command. The first
35457 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35458 there is an additional item A= followed by the name of the authenticator that
35459 was used. If an authenticated identification was set up by the authenticator's
35460 &%server_set_id%& option, this is logged too, separated by a colon from the
35461 authenticator name.
35462
35463 .cindex "size" "of message"
35464 The id field records the existing message id, if present. The size of the
35465 received message is given by the S field. When the message is delivered,
35466 headers may be removed or added, so that the size of delivered copies of the
35467 message may not correspond with this value (and indeed may be different to each
35468 other).
35469
35470 The &%log_selector%& option can be used to request the logging of additional
35471 data when a message is received. See section &<<SECTlogselector>>& below.
35472
35473
35474
35475 .section "Logging deliveries" "SECID252"
35476 .cindex "log" "delivery line"
35477 The format of the single-line entry in the main log that is written for every
35478 delivery is shown in one of the examples below, for local and remote
35479 deliveries, respectively. Each example has been split into multiple lines in order
35480 to fit it on the page:
35481 .code
35482 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35483   <marv@hitch.fict.example> R=localuser T=local_delivery
35484 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35485   monk@holistic.fict.example R=dnslookup T=remote_smtp
35486   H=holistic.fict.example [192.168.234.234]
35487 .endd
35488 For ordinary local deliveries, the original address is given in angle brackets
35489 after the final delivery address, which might be a pipe or a file. If
35490 intermediate address(es) exist between the original and the final address, the
35491 last of these is given in parentheses after the final address. The R and T
35492 fields record the router and transport that were used to process the address.
35493
35494 If SMTP AUTH was used for the delivery there is an additional item A=
35495 followed by the name of the authenticator that was used.
35496 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35497 option, this is logged too, separated by a colon from the authenticator name.
35498
35499 If a shadow transport was run after a successful local delivery, the log line
35500 for the successful delivery has an item added on the end, of the form
35501 .display
35502 &`ST=<`&&'shadow transport name'&&`>`&
35503 .endd
35504 If the shadow transport did not succeed, the error message is put in
35505 parentheses afterwards.
35506
35507 .cindex "asterisk" "after IP address"
35508 When more than one address is included in a single delivery (for example, two
35509 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35510 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35511 down a single SMTP connection, an asterisk follows the IP address in the log
35512 lines for the second and subsequent messages.
35513
35514 .cindex "delivery" "cutthrough; logging"
35515 .cindex "cutthrough" "logging"
35516 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35517 line precedes the reception line, since cutthrough waits for a possible
35518 rejection from the destination in case it can reject the sourced item.
35519
35520 The generation of a reply message by a filter file gets logged as a
35521 &"delivery"& to the addressee, preceded by &">"&.
35522
35523 The &%log_selector%& option can be used to request the logging of additional
35524 data when a message is delivered. See section &<<SECTlogselector>>& below.
35525
35526
35527 .section "Discarded deliveries" "SECID253"
35528 .cindex "discarded messages"
35529 .cindex "message" "discarded"
35530 .cindex "delivery" "discarded; logging"
35531 When a message is discarded as a result of the command &"seen finish"& being
35532 obeyed in a filter file which generates no deliveries, a log entry of the form
35533 .code
35534 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35535   <low.club@bridge.example> R=userforward
35536 .endd
35537 is written, to record why no deliveries are logged. When a message is discarded
35538 because it is aliased to &":blackhole:"& the log line is like this:
35539 .code
35540 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35541   <hole@nowhere.example> R=blackhole_router
35542 .endd
35543
35544
35545 .section "Deferred deliveries" "SECID254"
35546 When a delivery is deferred, a line of the following form is logged:
35547 .code
35548 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35549   R=dnslookup T=smtp defer (146): Connection refused
35550 .endd
35551 In the case of remote deliveries, the error is the one that was given for the
35552 last IP address that was tried. Details of individual SMTP failures are also
35553 written to the log, so the above line would be preceded by something like
35554 .code
35555 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35556   mail1.endrest.example [192.168.239.239]: Connection refused
35557 .endd
35558 When a deferred address is skipped because its retry time has not been reached,
35559 a message is written to the log, but this can be suppressed by setting an
35560 appropriate value in &%log_selector%&.
35561
35562
35563
35564 .section "Delivery failures" "SECID255"
35565 .cindex "delivery" "failure; logging"
35566 If a delivery fails because an address cannot be routed, a line of the
35567 following form is logged:
35568 .code
35569 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35570   <jim@trek99.example>: unknown mail domain
35571 .endd
35572 If a delivery fails at transport time, the router and transport are shown, and
35573 the response from the remote host is included, as in this example:
35574 .code
35575 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35576   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35577   after pipelined RCPT TO:<ace400@pb.example>: host
35578   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35579   <ace400@pb.example>...Addressee unknown
35580 .endd
35581 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35582 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35583 disabling PIPELINING. The log lines for all forms of delivery failure are
35584 flagged with &`**`&.
35585
35586
35587
35588 .section "Fake deliveries" "SECID256"
35589 .cindex "delivery" "fake; logging"
35590 If a delivery does not actually take place because the &%-N%& option has been
35591 used to suppress it, a normal delivery line is written to the log, except that
35592 &"=>"& is replaced by &"*>"&.
35593
35594
35595
35596 .section "Completion" "SECID257"
35597 A line of the form
35598 .code
35599 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35600 .endd
35601 is written to the main log when a message is about to be removed from the spool
35602 at the end of its processing.
35603
35604
35605
35606
35607 .section "Summary of Fields in Log Lines" "SECID258"
35608 .cindex "log" "summary of fields"
35609 A summary of the field identifiers that are used in log lines is shown in
35610 the following table:
35611 .display
35612 &`A   `&        authenticator name (and optional id and sender)
35613 &`C   `&        SMTP confirmation on delivery
35614 &`    `&        command list for &"no mail in SMTP session"&
35615 &`CV  `&        certificate verification status
35616 &`D   `&        duration of &"no mail in SMTP session"&
35617 &`DN  `&        distinguished name from peer certificate
35618 &`DS  `&        DNSSEC secured lookups
35619 &`DT  `&        on &`=>`& lines: time taken for a delivery
35620 &`F   `&        sender address (on delivery lines)
35621 &`H   `&        host name and IP address
35622 &`I   `&        local interface used
35623 &`id  `&        message id for incoming message
35624 &`P   `&        on &`<=`& lines: protocol used
35625 &`    `&        on &`=>`& and &`**`& lines: return path
35626 &`PRX `&        on &'<='& and&`=>`& lines: proxy address
35627 &`Q   `&        alternate queue name
35628 &`QT  `&        on &`=>`& lines: time spent on queue so far
35629 &`    `&        on &"Completed"& lines: time spent on queue
35630 &`R   `&        on &`<=`& lines: reference for local bounce
35631 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
35632 &`S   `&        size of message in bytes
35633 &`SNI `&        server name indication from TLS client hello
35634 &`ST  `&        shadow transport name
35635 &`T   `&        on &`<=`& lines: message subject (topic)
35636 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35637 &`U   `&        local user or RFC 1413 identity
35638 &`X   `&        TLS cipher suite
35639 .endd
35640
35641
35642 .section "Other log entries" "SECID259"
35643 Various other types of log entry are written from time to time. Most should be
35644 self-explanatory. Among the more common are:
35645
35646 .ilist
35647 .cindex "retry" "time not reached"
35648 &'retry time not reached'&&~&~An address previously suffered a temporary error
35649 during routing or local delivery, and the time to retry has not yet arrived.
35650 This message is not written to an individual message log file unless it happens
35651 during the first delivery attempt.
35652 .next
35653 &'retry time not reached for any host'&&~&~An address previously suffered
35654 temporary errors during remote delivery, and the retry time has not yet arrived
35655 for any of the hosts to which it is routed.
35656 .next
35657 .cindex "spool directory" "file locked"
35658 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35659 some other Exim process is already working on the message. This can be quite
35660 common if queue running processes are started at frequent intervals. The
35661 &'exiwhat'& utility script can be used to find out what Exim processes are
35662 doing.
35663 .next
35664 .cindex "error" "ignored"
35665 &'error ignored'&&~&~There are several circumstances that give rise to this
35666 message:
35667 .olist
35668 Exim failed to deliver a bounce message whose age was greater than
35669 &%ignore_bounce_errors_after%&. The bounce was discarded.
35670 .next
35671 A filter file set up a delivery using the &"noerror"& option, and the delivery
35672 failed. The delivery was discarded.
35673 .next
35674 A delivery set up by a router configured with
35675 . ==== As this is a nested list, any displays it contains must be indented
35676 . ==== as otherwise they are too far to the left.
35677 .code
35678     errors_to = <>
35679 .endd
35680 failed. The delivery was discarded.
35681 .endlist olist
35682 .endlist ilist
35683
35684
35685
35686
35687
35688 .section "Reducing or increasing what is logged" "SECTlogselector"
35689 .cindex "log" "selectors"
35690 By setting the &%log_selector%& global option, you can disable some of Exim's
35691 default logging, or you can request additional logging. The value of
35692 &%log_selector%& is made up of names preceded by plus or minus characters. For
35693 example:
35694 .code
35695 log_selector = +arguments -retry_defer
35696 .endd
35697 The list of optional log items is in the following table, with the default
35698 selection marked by asterisks:
35699 .display
35700 &` 8bitmime                   `&  received 8BITMIME status
35701 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35702 &` address_rewrite            `&  address rewriting
35703 &` all_parents                `&  all parents in => lines
35704 &` arguments                  `&  command line arguments
35705 &`*connection_reject          `&  connection rejections
35706 &`*delay_delivery             `&  immediate delivery delayed
35707 &` deliver_time               `&  time taken to perform delivery
35708 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35709 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35710 &` dnssec                     `&  DNSSEC secured lookups
35711 &`*etrn                       `&  ETRN commands
35712 &`*host_lookup_failed         `&  as it says
35713 &` ident_timeout              `&  timeout for ident connection
35714 &` incoming_interface         `&  local interface on <= and => lines
35715 &` incoming_port              `&  remote port on <= lines
35716 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35717 &` outgoing_interface         `&  local interface on => lines
35718 &` outgoing_port              `&  add remote port to => lines
35719 &`*queue_run                  `&  start and end queue runs
35720 &` queue_time                 `&  time on queue for one recipient
35721 &` queue_time_overall         `&  time on queue for whole message
35722 &` pid                        `&  Exim process id
35723 &` proxy                      `&  proxy address on <= and => lines
35724 &` received_recipients        `&  recipients on <= lines
35725 &` received_sender            `&  sender on <= lines
35726 &`*rejected_header            `&  header contents on reject log
35727 &`*retry_defer                `&  &"retry time not reached"&
35728 &` return_path_on_delivery    `&  put return path on => and ** lines
35729 &` sender_on_delivery         `&  add sender to => lines
35730 &`*sender_verify_fail         `&  sender verification failures
35731 &`*size_reject                `&  rejection because too big
35732 &`*skip_delivery              `&  delivery skipped in a queue run
35733 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35734 &` smtp_connection            `&  incoming SMTP connections
35735 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35736 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35737 &` smtp_no_mail               `&  session with no MAIL commands
35738 &` smtp_protocol_error        `&  SMTP protocol errors
35739 &` smtp_syntax_error          `&  SMTP syntax errors
35740 &` subject                    `&  contents of &'Subject:'& on <= lines
35741 &`*tls_certificate_verified   `&  certificate verification status
35742 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35743 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35744 &` tls_sni                    `&  TLS SNI on <= lines
35745 &` unknown_in_list            `&  DNS lookup failed in list match
35746
35747 &` all                        `&  all of the above
35748 .endd
35749 See also the &%slow_lookup_log%& main configuration option,
35750 section &<<SECID99>>&
35751
35752 More details on each of these items follows:
35753
35754 .ilist
35755 .cindex "8BITMIME"
35756 .cindex "log" "8BITMIME"
35757 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35758 which may help in tracking down interoperability issues with ancient MTAs
35759 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35760 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35761 &`7BIT`& and &`8BITMIME`& respectively.
35762 .next
35763 .cindex "&%warn%& ACL verb" "log when skipping"
35764 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35765 its conditions cannot be evaluated, a log line to this effect is written if
35766 this log selector is set.
35767 .next
35768 .cindex "log" "rewriting"
35769 .cindex "rewriting" "logging"
35770 &%address_rewrite%&: This applies both to global rewrites and per-transport
35771 rewrites, but not to rewrites in filters run as an unprivileged user (because
35772 such users cannot access the log).
35773 .next
35774 .cindex "log" "full parentage"
35775 &%all_parents%&: Normally only the original and final addresses are logged on
35776 delivery lines; with this selector, intermediate parents are given in
35777 parentheses between them.
35778 .next
35779 .cindex "log" "Exim arguments"
35780 .cindex "Exim arguments, logging"
35781 &%arguments%&: This causes Exim to write the arguments with which it was called
35782 to the main log, preceded by the current working directory. This is a debugging
35783 feature, added to make it easier to find out how certain MUAs call
35784 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35785 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35786 that are empty or that contain white space are quoted. Non-printing characters
35787 are shown as escape sequences. This facility cannot log unrecognized arguments,
35788 because the arguments are checked before the configuration file is read. The
35789 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35790 between the caller and Exim.
35791 .next
35792 .cindex "log" "connection rejections"
35793 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35794 connection is rejected, for whatever reason.
35795 .next
35796 .cindex "log" "delayed delivery"
35797 .cindex "delayed delivery, logging"
35798 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35799 started for an incoming message because the load is too high or too many
35800 messages were received on one connection. Logging does not occur if no delivery
35801 process is started because &%queue_only%& is set or &%-odq%& was used.
35802 .next
35803 .cindex "log" "delivery duration"
35804 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35805 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35806 .next
35807 .cindex "log" "message size on delivery"
35808 .cindex "size" "of message"
35809 &%delivery_size%&: For each delivery, the size of message delivered is added to
35810 the &"=>"& line, tagged with S=.
35811 .next
35812 .cindex "log" "dnslist defer"
35813 .cindex "DNS list" "logging defer"
35814 .cindex "black list (DNS)"
35815 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35816 DNS black list suffers a temporary error.
35817 .next
35818 .cindex log dnssec
35819 .cindex dnssec logging
35820 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
35821 dns lookups gave secure results a tag of DS is added.
35822 For acceptance this covers the reverse and forward lookups for host name verification.
35823 It does not cover helo-name verification.
35824 For delivery this covers the SRV, MX, A and/or AAAA lookups.
35825 .next
35826 .cindex "log" "ETRN commands"
35827 .cindex "ETRN" "logging"
35828 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35829 is run to determine whether or not it is actually accepted. An invalid ETRN
35830 command, or one received within a message transaction is not logged by this
35831 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35832 .next
35833 .cindex "log" "host lookup failure"
35834 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35835 any addresses, or when a lookup of an IP address fails to find a host name, a
35836 log line is written. This logging does not apply to direct DNS lookups when
35837 routing email addresses, but it does apply to &"byname"& lookups.
35838 .next
35839 .cindex "log" "ident timeout"
35840 .cindex "RFC 1413" "logging timeout"
35841 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35842 client's ident port times out.
35843 .next
35844 .cindex "log" "incoming interface"
35845 .cindex "log" "local interface"
35846 .cindex "log" "local address and port"
35847 .cindex "TCP/IP" "logging local address and port"
35848 .cindex "interface" "logging"
35849 &%incoming_interface%&: The interface on which a message was received is added
35850 to the &"<="& line as an IP address in square brackets, tagged by I= and
35851 followed by a colon and the port number. The local interface and port are also
35852 added to other SMTP log lines, for example &"SMTP connection from"&, to
35853 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
35854 The latter can be disabled by turning off the &%outgoing_interface%& option.
35855 .next
35856 .cindex log "incoming proxy address"
35857 .cindex proxy "logging proxy address"
35858 .cindex "TCP/IP" "logging proxy address"
35859 &%proxy%&: The internal (closest to the system running Exim) IP address
35860 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
35861 on a proxied connection
35862 or the &"=>"& line for a message delivered on a proxied connection..
35863 See &<<SECTproxyInbound>>& for more information.
35864 .next
35865 .cindex "log" "incoming remote port"
35866 .cindex "port" "logging remote"
35867 .cindex "TCP/IP" "logging incoming remote port"
35868 .vindex "&$sender_fullhost$&"
35869 .vindex "&$sender_rcvhost$&"
35870 &%incoming_port%&: The remote port number from which a message was received is
35871 added to log entries and &'Received:'& header lines, following the IP address
35872 in square brackets, and separated from it by a colon. This is implemented by
35873 changing the value that is put in the &$sender_fullhost$& and
35874 &$sender_rcvhost$& variables. Recording the remote port number has become more
35875 important with the widening use of NAT (see RFC 2505).
35876 .next
35877 .cindex "log" "dropped connection"
35878 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35879 connection is unexpectedly dropped.
35880 .next
35881 .cindex "log" "outgoing interface"
35882 .cindex "log" "local interface"
35883 .cindex "log" "local address and port"
35884 .cindex "TCP/IP" "logging local address and port"
35885 .cindex "interface" "logging"
35886 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
35887 interface on which a message was sent is added to delivery lines as an I= tag
35888 followed by IP address in square brackets. You can disable this by turning
35889 off the &%outgoing_interface%& option.
35890 .next
35891 .cindex "log" "outgoing remote port"
35892 .cindex "port" "logging outgoint remote"
35893 .cindex "TCP/IP" "logging ougtoing remote port"
35894 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35895 containing => tags) following the IP address.
35896 The local port is also added if &%incoming_interface%& and
35897 &%outgoing_interface%& are both enabled.
35898 This option is not included in the default setting, because for most ordinary
35899 configurations, the remote port number is always 25 (the SMTP port), and the
35900 local port is a random ephemeral port.
35901 .next
35902 .cindex "log" "process ids in"
35903 .cindex "pid (process id)" "in log lines"
35904 &%pid%&: The current process id is added to every log line, in square brackets,
35905 immediately after the time and date.
35906 .next
35907 .cindex "log" "queue run"
35908 .cindex "queue runner" "logging"
35909 &%queue_run%&: The start and end of every queue run are logged.
35910 .next
35911 .cindex "log" "queue time"
35912 &%queue_time%&: The amount of time the message has been in the queue on the
35913 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35914 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35915 includes reception time as well as the delivery time for the current address.
35916 This means that it may be longer than the difference between the arrival and
35917 delivery log line times, because the arrival log line is not written until the
35918 message has been successfully received.
35919 .next
35920 &%queue_time_overall%&: The amount of time the message has been in the queue on
35921 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35922 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35923 message, so it includes reception time as well as the total delivery time.
35924 .next
35925 .cindex "log" "recipients"
35926 &%received_recipients%&: The recipients of a message are listed in the main log
35927 as soon as the message is received. The list appears at the end of the log line
35928 that is written when a message is received, preceded by the word &"for"&. The
35929 addresses are listed after they have been qualified, but before any rewriting
35930 has taken place.
35931 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35932 in the list.
35933 .next
35934 .cindex "log" "sender reception"
35935 &%received_sender%&: The unrewritten original sender of a message is added to
35936 the end of the log line that records the message's arrival, after the word
35937 &"from"& (before the recipients if &%received_recipients%& is also set).
35938 .next
35939 .cindex "log" "header lines for rejection"
35940 &%rejected_header%&: If a message's header has been received at the time a
35941 rejection is written to the reject log, the complete header is added to the
35942 log. Header logging can be turned off individually for messages that are
35943 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35944 .next
35945 .cindex "log" "retry defer"
35946 &%retry_defer%&: A log line is written if a delivery is deferred because a
35947 retry time has not yet been reached. However, this &"retry time not reached"&
35948 message is always omitted from individual message logs after the first delivery
35949 attempt.
35950 .next
35951 .cindex "log" "return path"
35952 &%return_path_on_delivery%&: The return path that is being transmitted with
35953 the message is included in delivery and bounce lines, using the tag P=.
35954 This is omitted if no delivery actually happens, for example, if routing fails,
35955 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35956 .next
35957 .cindex "log" "sender on delivery"
35958 &%sender_on_delivery%&: The message's sender address is added to every delivery
35959 and bounce line, tagged by F= (for &"from"&).
35960 This is the original sender that was received with the message; it is not
35961 necessarily the same as the outgoing return path.
35962 .next
35963 .cindex "log" "sender verify failure"
35964 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35965 gives details of a sender verification failure is not written. Log lines for
35966 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35967 detail is lost.
35968 .next
35969 .cindex "log" "size rejection"
35970 &%size_reject%&: A log line is written whenever a message is rejected because
35971 it is too big.
35972 .next
35973 .cindex "log" "frozen messages; skipped"
35974 .cindex "frozen messages" "logging skipping"
35975 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35976 queue run because it is frozen or because another process is already delivering
35977 it.
35978 .cindex "&""spool file is locked""&"
35979 The message that is written is &"spool file is locked"&.
35980 .next
35981 .cindex "log" "smtp confirmation"
35982 .cindex "SMTP" "logging confirmation"
35983 .cindex "LMTP" "logging confirmation"
35984 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35985 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35986 A number of MTAs (including Exim) return an identifying string in this
35987 response.
35988 .next
35989 .cindex "log" "SMTP connections"
35990 .cindex "SMTP" "logging connections"
35991 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
35992 established or closed, unless the connection is from a host that matches
35993 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35994 only when the closure is unexpected.) This applies to connections from local
35995 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35996 dropped in the middle of a message, a log line is always written, whether or
35997 not this selector is set, but otherwise nothing is written at the start and end
35998 of connections unless this selector is enabled.
35999
36000 For TCP/IP connections to an Exim daemon, the current number of connections is
36001 included in the log message for each new connection, but note that the count is
36002 reset if the daemon is restarted.
36003 Also, because connections are closed (and the closure is logged) in
36004 subprocesses, the count may not include connections that have been closed but
36005 whose termination the daemon has not yet noticed. Thus, while it is possible to
36006 match up the opening and closing of connections in the log, the value of the
36007 logged counts may not be entirely accurate.
36008 .next
36009 .cindex "log" "SMTP transaction; incomplete"
36010 .cindex "SMTP" "logging incomplete transactions"
36011 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36012 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36013 and the message sender plus any accepted recipients are included in the log
36014 line. This can provide evidence of dictionary attacks.
36015 .next
36016 .cindex "log" "non-MAIL SMTP sessions"
36017 .cindex "MAIL" "logging session without"
36018 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36019 connection terminates without having issued a MAIL command. This includes both
36020 the case when the connection is dropped, and the case when QUIT is used. It
36021 does not include cases where the connection is rejected right at the start (by
36022 an ACL, or because there are too many connections, or whatever). These cases
36023 already have their own log lines.
36024
36025 The log line that is written contains the identity of the client in the usual
36026 way, followed by D= and a time, which records the duration of the connection.
36027 If the connection was authenticated, this fact is logged exactly as it is for
36028 an incoming message, with an A= item. If the connection was encrypted, CV=,
36029 DN=, and X= items may appear as they do for an incoming message, controlled by
36030 the same logging options.
36031
36032 Finally, if any SMTP commands were issued during the connection, a C= item
36033 is added to the line, listing the commands that were used. For example,
36034 .code
36035 C=EHLO,QUIT
36036 .endd
36037 shows that the client issued QUIT straight after EHLO. If there were fewer
36038 than 20 commands, they are all listed. If there were more than 20 commands,
36039 the last 20 are listed, preceded by &"..."&. However, with the default
36040 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36041 have been aborted before 20 non-mail commands are processed.
36042 .next
36043 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36044 colon-separated, is appended to the A= item for a message arrival or delivery
36045 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36046 was accepted or used.
36047 .next
36048 .cindex "log" "SMTP protocol error"
36049 .cindex "SMTP" "logging protocol error"
36050 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36051 encountered. Exim does not have perfect detection of all protocol errors
36052 because of transmission delays and the use of pipelining. If PIPELINING has
36053 been advertised to a client, an Exim server assumes that the client will use
36054 it, and therefore it does not count &"expected"& errors (for example, RCPT
36055 received after rejecting MAIL) as protocol errors.
36056 .next
36057 .cindex "SMTP" "logging syntax errors"
36058 .cindex "SMTP" "syntax errors; logging"
36059 .cindex "SMTP" "unknown command; logging"
36060 .cindex "log" "unknown SMTP command"
36061 .cindex "log" "SMTP syntax error"
36062 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36063 encountered. An unrecognized command is treated as a syntax error. For an
36064 external connection, the host identity is given; for an internal connection
36065 using &%-bs%& the sender identification (normally the calling user) is given.
36066 .next
36067 .cindex "log" "subject"
36068 .cindex "subject, logging"
36069 &%subject%&: The subject of the message is added to the arrival log line,
36070 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36071 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36072 specifies whether characters with values greater than 127 should be logged
36073 unchanged, or whether they should be rendered as escape sequences.
36074 .next
36075 .cindex "log" "certificate verification"
36076 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36077 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36078 verified, and &`CV=no`& if not.
36079 .next
36080 .cindex "log" "TLS cipher"
36081 .cindex "TLS" "logging cipher"
36082 &%tls_cipher%&: When a message is sent or received over an encrypted
36083 connection, the cipher suite used is added to the log line, preceded by X=.
36084 .next
36085 .cindex "log" "TLS peer DN"
36086 .cindex "TLS" "logging peer DN"
36087 &%tls_peerdn%&: When a message is sent or received over an encrypted
36088 connection, and a certificate is supplied by the remote host, the peer DN is
36089 added to the log line, preceded by DN=.
36090 .next
36091 .cindex "log" "TLS SNI"
36092 .cindex "TLS" "logging SNI"
36093 &%tls_sni%&: When a message is received over an encrypted connection, and
36094 the remote host provided the Server Name Indication extension, the SNI is
36095 added to the log line, preceded by SNI=.
36096 .next
36097 .cindex "log" "DNS failure in list"
36098 &%unknown_in_list%&: This setting causes a log entry to be written when the
36099 result of a list match is failure because a DNS lookup failed.
36100 .endlist
36101
36102
36103 .section "Message log" "SECID260"
36104 .cindex "message" "log file for"
36105 .cindex "log" "message log; description of"
36106 .cindex "&_msglog_& directory"
36107 .oindex "&%preserve_message_logs%&"
36108 In addition to the general log files, Exim writes a log file for each message
36109 that it handles. The names of these per-message logs are the message ids, and
36110 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36111 message log contains copies of the log lines that apply to the message. This
36112 makes it easier to inspect the status of an individual message without having
36113 to search the main log. A message log is deleted when processing of the message
36114 is complete, unless &%preserve_message_logs%& is set, but this should be used
36115 only with great care because they can fill up your disk very quickly.
36116
36117 On a heavily loaded system, it may be desirable to disable the use of
36118 per-message logs, in order to reduce disk I/O. This can be done by setting the
36119 &%message_logs%& option false.
36120 .ecindex IIDloggen
36121
36122
36123
36124
36125 . ////////////////////////////////////////////////////////////////////////////
36126 . ////////////////////////////////////////////////////////////////////////////
36127
36128 .chapter "Exim utilities" "CHAPutils"
36129 .scindex IIDutils "utilities"
36130 A number of utility scripts and programs are supplied with Exim and are
36131 described in this chapter. There is also the Exim Monitor, which is covered in
36132 the next chapter. The utilities described here are:
36133
36134 .itable none 0 0 3  7* left  15* left  40* left
36135 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36136   "list what Exim processes are doing"
36137 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36138 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36139 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36140 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36141                                                 various criteria"
36142 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36143 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36144   "extract statistics from the log"
36145 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36146   "check address acceptance from given IP"
36147 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36148 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36149 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36150 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36151 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36152 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36153 .endtable
36154
36155 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36156 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36157 &url(http://duncanthrax.net/exilog/) for details.
36158
36159
36160
36161
36162 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36163 .cindex "&'exiwhat'&"
36164 .cindex "process, querying"
36165 .cindex "SIGUSR1"
36166 On operating systems that can restart a system call after receiving a signal
36167 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36168 a line describing what it is doing to the file &_exim-process.info_& in the
36169 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36170 processes it can find, having first emptied the file. It then waits for one
36171 second to allow the Exim processes to react before displaying the results. In
36172 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36173 send the signal to the Exim processes, so it is normally run as root.
36174
36175 &*Warning*&: This is not an efficient process. It is intended for occasional
36176 use by system administrators. It is not sensible, for example, to set up a
36177 script that sends SIGUSR1 signals to Exim processes at short intervals.
36178
36179
36180 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36181 varies in different operating systems. Not only are different options used,
36182 but the format of the output is different. For this reason, there are some
36183 system configuration options that configure exactly how &'exiwhat'& works. If
36184 it doesn't seem to be working for you, check the following compile-time
36185 options:
36186 .display
36187 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36188 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36189 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36190 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36191 .endd
36192 An example of typical output from &'exiwhat'& is
36193 .code
36194 164 daemon: -q1h, listening on port 25
36195 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36196 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36197   [10.19.42.42] (editor@ref.example)
36198 10592 handling incoming call from [192.168.243.242]
36199 10628 accepting a local non-SMTP message
36200 .endd
36201 The first number in the output line is the process number. The third line has
36202 been split here, in order to fit it on the page.
36203
36204
36205
36206 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36207 .cindex "&'exiqgrep'&"
36208 .cindex "queue" "grepping"
36209 This utility is a Perl script contributed by Matt Hubbard. It runs
36210 .code
36211 exim -bpu
36212 .endd
36213 or (in case &*-a*& switch is specified)
36214 .code
36215 exim -bp
36216 .endd
36217 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36218 contain alternate exim configuration the queue management might be using.
36219
36220 to obtain a queue listing, and then greps the output to select messages
36221 that match given criteria. The following selection options are available:
36222
36223 .vlist
36224 .vitem &*-f*&&~<&'regex'&>
36225 Match the sender address using a case-insensitive search. The field that is
36226 tested is enclosed in angle brackets, so you can test for bounce messages with
36227 .code
36228 exiqgrep -f '^<>$'
36229 .endd
36230 .vitem &*-r*&&~<&'regex'&>
36231 Match a recipient address using a case-insensitive search. The field that is
36232 tested is not enclosed in angle brackets.
36233
36234 .vitem &*-s*&&~<&'regex'&>
36235 Match against the size field.
36236
36237 .vitem &*-y*&&~<&'seconds'&>
36238 Match messages that are younger than the given time.
36239
36240 .vitem &*-o*&&~<&'seconds'&>
36241 Match messages that are older than the given time.
36242
36243 .vitem &*-z*&
36244 Match only frozen messages.
36245
36246 .vitem &*-x*&
36247 Match only non-frozen messages.
36248 .endlist
36249
36250 The following options control the format of the output:
36251
36252 .vlist
36253 .vitem &*-c*&
36254 Display only the count of matching messages.
36255
36256 .vitem &*-l*&
36257 Long format &-- display the full message information as output by Exim. This is
36258 the default.
36259
36260 .vitem &*-i*&
36261 Display message ids only.
36262
36263 .vitem &*-b*&
36264 Brief format &-- one line per message.
36265
36266 .vitem &*-R*&
36267 Display messages in reverse order.
36268
36269 .vitem &*-a*&
36270 Include delivered recipients in queue listing.
36271 .endlist
36272
36273 There is one more option, &%-h%&, which outputs a list of options.
36274
36275
36276
36277 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36278 .cindex "&'exiqsumm'&"
36279 .cindex "queue" "summary"
36280 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36281 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36282 running a command such as
36283 .code
36284 exim -bp | exiqsumm
36285 .endd
36286 The output consists of one line for each domain that has messages waiting for
36287 it, as in the following example:
36288 .code
36289 3   2322   74m   66m  msn.com.example
36290 .endd
36291 Each line lists the number of pending deliveries for a domain, their total
36292 volume, and the length of time that the oldest and the newest messages have
36293 been waiting. Note that the number of pending deliveries is greater than the
36294 number of messages when messages have more than one recipient.
36295
36296 A summary line is output at the end. By default the output is sorted on the
36297 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36298 the output to be sorted by oldest message and by count of messages,
36299 respectively. There are also three options that split the messages for each
36300 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36301 separates frozen messages, and &%-s%& separates messages according to their
36302 sender.
36303
36304 The output of &'exim -bp'& contains the original addresses in the message, so
36305 this also applies to the output from &'exiqsumm'&. No domains from addresses
36306 generated by aliasing or forwarding are included (unless the &%one_time%&
36307 option of the &(redirect)& router has been used to convert them into &"top
36308 level"& addresses).
36309
36310
36311
36312
36313 .section "Extracting specific information from the log (exigrep)" &&&
36314          "SECTextspeinf"
36315 .cindex "&'exigrep'&"
36316 .cindex "log" "extracts; grepping for"
36317 The &'exigrep'& utility is a Perl script that searches one or more main log
36318 files for entries that match a given pattern. When it finds a match, it
36319 extracts all the log entries for the relevant message, not just those that
36320 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36321 given message, or all mail for a given user, or for a given host, for example.
36322 The input files can be in Exim log format or syslog format.
36323 If a matching log line is not associated with a specific message, it is
36324 included in &'exigrep'&'s output without any additional lines. The usage is:
36325 .display
36326 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36327 .endd
36328 If no log file names are given on the command line, the standard input is read.
36329
36330 The &%-t%& argument specifies a number of seconds. It adds an additional
36331 condition for message selection. Messages that are complete are shown only if
36332 they spent more than <&'n'&> seconds on the queue.
36333
36334 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36335 makes it case-sensitive. This may give a performance improvement when searching
36336 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36337 option; with &%-I%& they do not. In both cases it is possible to change the
36338 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36339
36340 The &%-l%& option means &"literal"&, that is, treat all characters in the
36341 pattern as standing for themselves. Otherwise the pattern must be a Perl
36342 regular expression.
36343
36344 The &%-v%& option inverts the matching condition. That is, a line is selected
36345 if it does &'not'& match the pattern.
36346
36347 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36348 that are generated as a result/response to a message that &'exigrep'& matched
36349 normally.
36350
36351 Example of &%-M%&:
36352 user_a sends a message to user_b, which generates a bounce back to user_b. If
36353 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36354 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36355 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36356 when searching for &"user_a"& will show both messages since the bounce is
36357 &"related"& to or a &"result"& of the first message that was found by the
36358 search term.
36359
36360 If the location of a &'zcat'& command is known from the definition of
36361 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36362 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36363 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36364 autodetection of some well known compression extensions.
36365
36366
36367 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36368 .cindex "&'exipick'&"
36369 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36370 lists messages from the queue according to a variety of criteria. For details
36371 of &'exipick'&'s facilities, visit the web page at
36372 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36373 the &%--help%& option.
36374
36375
36376 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36377 .cindex "log" "cycling local files"
36378 .cindex "cycling logs"
36379 .cindex "&'exicyclog'&"
36380 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36381 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36382 you are using log files with datestamps in their names (see section
36383 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36384 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36385 There are two command line options for &'exicyclog'&:
36386 .ilist
36387 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36388 default that is set when Exim is built. The default default is 10.
36389 .next
36390 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36391 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36392 overriding the script's default, which is to find the setting from Exim's
36393 configuration.
36394 .endlist
36395
36396 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36397 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36398 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36399 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36400 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36401 logs are handled similarly.
36402
36403 If the limit is greater than 99, the script uses 3-digit numbers such as
36404 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36405 to one that is greater, or &'vice versa'&, you will have to fix the names of
36406 any existing log files.
36407
36408 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36409 the end are deleted. All files with numbers greater than 01 are compressed,
36410 using a compression command which is configured by the COMPRESS_COMMAND
36411 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36412 root &%crontab%& entry of the form
36413 .code
36414 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36415 .endd
36416 assuming you have used the name &"exim"& for the Exim user. You can run
36417 &'exicyclog'& as root if you wish, but there is no need.
36418
36419
36420
36421 .section "Mail statistics (eximstats)" "SECTmailstat"
36422 .cindex "statistics"
36423 .cindex "&'eximstats'&"
36424 A Perl script called &'eximstats'& is provided for extracting statistical
36425 information from log files. The output is either plain text, or HTML.
36426 Exim log files are also supported by the &'Lire'& system produced by the
36427 LogReport Foundation &url(http://www.logreport.org).
36428
36429 The &'eximstats'& script has been hacked about quite a bit over time. The
36430 latest version is the result of some extensive revision by Steve Campbell. A
36431 lot of information is given by default, but there are options for suppressing
36432 various parts of it. Following any options, the arguments to the script are a
36433 list of files, which should be main log files. For example:
36434 .code
36435 eximstats -nr /var/spool/exim/log/mainlog.01
36436 .endd
36437 By default, &'eximstats'& extracts information about the number and volume of
36438 messages received from or delivered to various hosts. The information is sorted
36439 both by message count and by volume, and the top fifty hosts in each category
36440 are listed on the standard output. Similar information, based on email
36441 addresses or domains instead of hosts can be requested by means of various
36442 options. For messages delivered and received locally, similar statistics are
36443 also produced per user.
36444
36445 The output also includes total counts and statistics about delivery errors, and
36446 histograms showing the number of messages received and deliveries made in each
36447 hour of the day. A delivery with more than one address in its envelope (for
36448 example, an SMTP transaction with more than one RCPT command) is counted
36449 as a single delivery by &'eximstats'&.
36450
36451 Though normally more deliveries than receipts are reported (as messages may
36452 have multiple recipients), it is possible for &'eximstats'& to report more
36453 messages received than delivered, even though the queue is empty at the start
36454 and end of the period in question. If an incoming message contains no valid
36455 recipients, no deliveries are recorded for it. A bounce message is handled as
36456 an entirely separate message.
36457
36458 &'eximstats'& always outputs a grand total summary giving the volume and number
36459 of messages received and deliveries made, and the number of hosts involved in
36460 each case. It also outputs the number of messages that were delayed (that is,
36461 not completely delivered at the first attempt), and the number that had at
36462 least one address that failed.
36463
36464 The remainder of the output is in sections that can be independently disabled
36465 or modified by various options. It consists of a summary of deliveries by
36466 transport, histograms of messages received and delivered per time interval
36467 (default per hour), information about the time messages spent on the queue,
36468 a list of relayed messages, lists of the top fifty sending hosts, local
36469 senders, destination hosts, and destination local users by count and by volume,
36470 and a list of delivery errors that occurred.
36471
36472 The relay information lists messages that were actually relayed, that is, they
36473 came from a remote host and were directly delivered to some other remote host,
36474 without being processed (for example, for aliasing or forwarding) locally.
36475
36476 There are quite a few options for &'eximstats'& to control exactly what it
36477 outputs. These are documented in the Perl script itself, and can be extracted
36478 by running the command &(perldoc)& on the script. For example:
36479 .code
36480 perldoc /usr/exim/bin/eximstats
36481 .endd
36482
36483 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36484 .cindex "&'exim_checkaccess'&"
36485 .cindex "policy control" "checking access"
36486 .cindex "checking access"
36487 The &%-bh%& command line argument allows you to run a fake SMTP session with
36488 debugging output, in order to check what Exim is doing when it is applying
36489 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36490 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36491 sometimes you just want to answer the question &"Does this address have
36492 access?"& without bothering with any further details.
36493
36494 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36495 two arguments, an IP address and an email address:
36496 .code
36497 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36498 .endd
36499 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36500 given email address would be accepted in a RCPT command in a TCP/IP
36501 connection from the host with the given IP address. The output of the utility
36502 is either the word &"accepted"&, or the SMTP error response, for example:
36503 .code
36504 Rejected:
36505 550 Relay not permitted
36506 .endd
36507 When running this test, the utility uses &`<>`& as the envelope sender address
36508 for the MAIL command, but you can change this by providing additional
36509 options. These are passed directly to the Exim command. For example, to specify
36510 that the test is to be run with the sender address &'himself@there.example'&
36511 you can use:
36512 .code
36513 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36514                  -f himself@there.example
36515 .endd
36516 Note that these additional Exim command line items must be given after the two
36517 mandatory arguments.
36518
36519 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36520 while running its checks. You can run checks that include callouts by using
36521 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36522
36523
36524
36525 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36526 .cindex "DBM" "building dbm files"
36527 .cindex "building DBM files"
36528 .cindex "&'exim_dbmbuild'&"
36529 .cindex "lower casing"
36530 .cindex "binary zero" "in lookup key"
36531 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36532 the format used by the &(lsearch)& lookup (see section
36533 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36534 names as keys and the remainder of the information as data. The lower-casing
36535 can be prevented by calling the program with the &%-nolc%& option.
36536
36537 A terminating zero is included as part of the key string. This is expected by
36538 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36539 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36540 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36541 files.
36542
36543 The program requires two arguments: the name of the input file (which can be a
36544 single hyphen to indicate the standard input), and the name of the output file.
36545 It creates the output under a temporary name, and then renames it if all went
36546 well.
36547
36548 .cindex "USE_DB"
36549 If the native DB interface is in use (USE_DB is set in a compile-time
36550 configuration file &-- this is common in free versions of Unix) the two file
36551 names must be different, because in this mode the Berkeley DB functions create
36552 a single output file using exactly the name given. For example,
36553 .code
36554 exim_dbmbuild /etc/aliases /etc/aliases.db
36555 .endd
36556 reads the system alias file and creates a DBM version of it in
36557 &_/etc/aliases.db_&.
36558
36559 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36560 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36561 environment, the suffixes are added to the second argument of
36562 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36563 when the Berkeley functions are used in compatibility mode (though this is not
36564 recommended), because in that case it adds a &_.db_& suffix to the file name.
36565
36566 If a duplicate key is encountered, the program outputs a warning, and when it
36567 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36568 option is used. By default, only the first of a set of duplicates is used &--
36569 this makes it compatible with &(lsearch)& lookups. There is an option
36570 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36571 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36572 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36573 return code is 2.
36574
36575
36576
36577
36578 .section "Finding individual retry times (exinext)" "SECTfinindret"
36579 .cindex "retry" "times"
36580 .cindex "&'exinext'&"
36581 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36582 fish specific information out of the retry database. Given a mail domain (or a
36583 complete address), it looks up the hosts for that domain, and outputs any retry
36584 information for the hosts or for the domain. At present, the retry information
36585 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36586 output. For example:
36587 .code
36588 $ exinext piglet@milne.fict.example
36589 kanga.milne.example:192.168.8.1 error 146: Connection refused
36590   first failed: 21-Feb-1996 14:57:34
36591   last tried:   21-Feb-1996 14:57:34
36592   next try at:  21-Feb-1996 15:02:34
36593 roo.milne.example:192.168.8.3 error 146: Connection refused
36594   first failed: 20-Jan-1996 13:12:08
36595   last tried:   21-Feb-1996 11:42:03
36596   next try at:  21-Feb-1996 19:42:03
36597   past final cutoff time
36598 .endd
36599 You can also give &'exinext'& a local part, without a domain, and it
36600 will give any retry information for that local part in your default domain.
36601 A message id can be used to obtain retry information pertaining to a specific
36602 message. This exists only when an attempt to deliver a message to a remote host
36603 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36604 &'exinext'& is not particularly efficient, but then it is not expected to be
36605 run very often.
36606
36607 The &'exinext'& utility calls Exim to find out information such as the location
36608 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36609 passed on to the &'exim'& commands. The first specifies an alternate Exim
36610 configuration file, and the second sets macros for use within the configuration
36611 file. These features are mainly to help in testing, but might also be useful in
36612 environments where more than one configuration file is in use.
36613
36614
36615
36616 .section "Hints database maintenance" "SECThindatmai"
36617 .cindex "hints database" "maintenance"
36618 .cindex "maintaining Exim's hints database"
36619 Three utility programs are provided for maintaining the DBM files that Exim
36620 uses to contain its delivery hint information. Each program requires two
36621 arguments. The first specifies the name of Exim's spool directory, and the
36622 second is the name of the database it is to operate on. These are as follows:
36623
36624 .ilist
36625 &'retry'&: the database of retry information
36626 .next
36627 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36628 for remote hosts
36629 .next
36630 &'callout'&: the callout cache
36631 .next
36632 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36633 .next
36634 &'misc'&: other hints data
36635 .endlist
36636
36637 The &'misc'& database is used for
36638
36639 .ilist
36640 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36641 .next
36642 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36643 &(smtp)& transport)
36644 .next
36645 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36646 in a transport)
36647 .endlist
36648
36649
36650
36651 .section "exim_dumpdb" "SECID261"
36652 .cindex "&'exim_dumpdb'&"
36653 The entire contents of a database are written to the standard output by the
36654 &'exim_dumpdb'& program, which has no options or arguments other than the
36655 spool and database names. For example, to dump the retry database:
36656 .code
36657 exim_dumpdb /var/spool/exim retry
36658 .endd
36659 Two lines of output are produced for each entry:
36660 .code
36661 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36662 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36663 .endd
36664 The first item on the first line is the key of the record. It starts with one
36665 of the letters R, or T, depending on whether it refers to a routing or
36666 transport retry. For a local delivery, the next part is the local address; for
36667 a remote delivery it is the name of the remote host, followed by its failing IP
36668 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36669 transport). If the remote port is not the standard one (port 25), it is added
36670 to the IP address. Then there follows an error code, an additional error code,
36671 and a textual description of the error.
36672
36673 The three times on the second line are the time of first failure, the time of
36674 the last delivery attempt, and the computed time for the next attempt. The line
36675 ends with an asterisk if the cutoff time for the last retry rule has been
36676 exceeded.
36677
36678 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36679 consists of a host name followed by a list of ids for messages that are or were
36680 waiting to be delivered to that host. If there are a very large number for any
36681 one host, continuation records, with a sequence number added to the host name,
36682 may be seen. The data in these records is often out of date, because a message
36683 may be routed to several alternative hosts, and Exim makes no effort to keep
36684 cross-references.
36685
36686
36687
36688 .section "exim_tidydb" "SECID262"
36689 .cindex "&'exim_tidydb'&"
36690 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36691 database. If run with no options, it removes all records that are more than 30
36692 days old. The age is calculated from the date and time that the record was last
36693 updated. Note that, in the case of the retry database, it is &'not'& the time
36694 since the first delivery failure. Information about a host that has been down
36695 for more than 30 days will remain in the database, provided that the record is
36696 updated sufficiently often.
36697
36698 The cutoff date can be altered by means of the &%-t%& option, which must be
36699 followed by a time. For example, to remove all records older than a week from
36700 the retry database:
36701 .code
36702 exim_tidydb -t 7d /var/spool/exim retry
36703 .endd
36704 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36705 message ids. In the former these appear as data in records keyed by host &--
36706 they were messages that were waiting for that host &-- and in the latter they
36707 are the keys for retry information for messages that have suffered certain
36708 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36709 message ids in database records are those of messages that are still on the
36710 queue. Message ids for messages that no longer exist are removed from
36711 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36712 For the &'retry'& database, records whose keys are non-existent message ids are
36713 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36714 whenever it removes information from the database.
36715
36716 Certain records are automatically removed by Exim when they are no longer
36717 needed, but others are not. For example, if all the MX hosts for a domain are
36718 down, a retry record is created for each one. If the primary MX host comes back
36719 first, its record is removed when Exim successfully delivers to it, but the
36720 records for the others remain because Exim has not tried to use those hosts.
36721
36722 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36723 hints databases. You should do this at a quiet time of day, because it requires
36724 a database to be locked (and therefore inaccessible to Exim) while it does its
36725 work. Removing records from a DBM file does not normally make the file smaller,
36726 but all the common DBM libraries are able to re-use the space that is released.
36727 After an initial phase of increasing in size, the databases normally reach a
36728 point at which they no longer get any bigger, as long as they are regularly
36729 tidied.
36730
36731 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36732 databases is likely to keep on increasing.
36733
36734
36735
36736
36737 .section "exim_fixdb" "SECID263"
36738 .cindex "&'exim_fixdb'&"
36739 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36740 Its main use is for testing Exim, but it might also be occasionally useful for
36741 getting round problems in a live system. It has no options, and its interface
36742 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36743 key of a database record can then be entered, and the data for that record is
36744 displayed.
36745
36746 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36747 except the &'retry'& database, that is the only operation that can be carried
36748 out. For the &'retry'& database, each field is output preceded by a number, and
36749 data for individual fields can be changed by typing the field number followed
36750 by new data, for example:
36751 .code
36752 > 4 951102:1000
36753 .endd
36754 resets the time of the next delivery attempt. Time values are given as a
36755 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36756 used as optional separators.
36757
36758
36759
36760
36761 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36762 .cindex "mailbox" "maintenance"
36763 .cindex "&'exim_lock'&"
36764 .cindex "locking mailboxes"
36765 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36766 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36767 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36768 a user agent while investigating a problem. The utility requires the name of
36769 the file as its first argument. If the locking is successful, the second
36770 argument is run as a command (using C's &[system()]& function); if there is no
36771 second argument, the value of the SHELL environment variable is used; if this
36772 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36773 is unlocked and the utility ends. The following options are available:
36774
36775 .vlist
36776 .vitem &%-fcntl%&
36777 Use &[fcntl()]& locking on the open mailbox.
36778
36779 .vitem &%-flock%&
36780 Use &[flock()]& locking on the open mailbox, provided the operating system
36781 supports it.
36782
36783 .vitem &%-interval%&
36784 This must be followed by a number, which is a number of seconds; it sets the
36785 interval to sleep between retries (default 3).
36786
36787 .vitem &%-lockfile%&
36788 Create a lock file before opening the mailbox.
36789
36790 .vitem &%-mbx%&
36791 Lock the mailbox using MBX rules.
36792
36793 .vitem &%-q%&
36794 Suppress verification output.
36795
36796 .vitem &%-retries%&
36797 This must be followed by a number; it sets the number of times to try to get
36798 the lock (default 10).
36799
36800 .vitem &%-restore_time%&
36801 This option causes &%exim_lock%& to restore the modified and read times to the
36802 locked file before exiting. This allows you to access a locked mailbox (for
36803 example, to take a backup copy) without disturbing the times that the user
36804 subsequently sees.
36805
36806 .vitem &%-timeout%&
36807 This must be followed by a number, which is a number of seconds; it sets a
36808 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36809 default), a non-blocking call is used.
36810
36811 .vitem &%-v%&
36812 Generate verbose output.
36813 .endlist
36814
36815 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36816 default is to create a lock file and also to use &[fcntl()]& locking on the
36817 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36818 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36819 requires that the directory containing the file be writeable. Locking by lock
36820 file does not last for ever; Exim assumes that a lock file is expired if it is
36821 more than 30 minutes old.
36822
36823 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36824 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36825 to be taken out on the open mailbox, and an exclusive lock on the file
36826 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36827 number of the mailbox file. When the locking is released, if an exclusive lock
36828 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36829
36830 The default output contains verification of the locking that takes place. The
36831 &%-v%& option causes some additional information to be given. The &%-q%& option
36832 suppresses all output except error messages.
36833
36834 A command such as
36835 .code
36836 exim_lock /var/spool/mail/spqr
36837 .endd
36838 runs an interactive shell while the file is locked, whereas
36839 .display
36840 &`exim_lock -q /var/spool/mail/spqr <<End`&
36841 <&'some commands'&>
36842 &`End`&
36843 .endd
36844 runs a specific non-interactive sequence of commands while the file is locked,
36845 suppressing all verification output. A single command can be run by a command
36846 such as
36847 .code
36848 exim_lock -q /var/spool/mail/spqr \
36849   "cp /var/spool/mail/spqr /some/where"
36850 .endd
36851 Note that if a command is supplied, it must be entirely contained within the
36852 second argument &-- hence the quotes.
36853 .ecindex IIDutils
36854
36855
36856 . ////////////////////////////////////////////////////////////////////////////
36857 . ////////////////////////////////////////////////////////////////////////////
36858
36859 .chapter "The Exim monitor" "CHAPeximon"
36860 .scindex IIDeximon "Exim monitor" "description"
36861 .cindex "X-windows"
36862 .cindex "&'eximon'&"
36863 .cindex "Local/eximon.conf"
36864 .cindex "&_exim_monitor/EDITME_&"
36865 The Exim monitor is an application which displays in an X window information
36866 about the state of Exim's queue and what Exim is doing. An admin user can
36867 perform certain operations on messages from this GUI interface; however all
36868 such facilities are also available from the command line, and indeed, the
36869 monitor itself makes use of the command line to perform any actions requested.
36870
36871
36872
36873 .section "Running the monitor" "SECID264"
36874 The monitor is started by running the script called &'eximon'&. This is a shell
36875 script that sets up a number of environment variables, and then runs the
36876 binary called &_eximon.bin_&. The default appearance of the monitor window can
36877 be changed by editing the &_Local/eximon.conf_& file created by editing
36878 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36879 parameters are for.
36880
36881 The parameters that get built into the &'eximon'& script can be overridden for
36882 a particular invocation by setting up environment variables of the same names,
36883 preceded by &`EXIMON_`&. For example, a shell command such as
36884 .code
36885 EXIMON_LOG_DEPTH=400 eximon
36886 .endd
36887 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36888 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36889 overrides the Exim log file configuration. This makes it possible to have
36890 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36891 syslog messages are routed to a file on the local host.
36892
36893 X resources can be used to change the appearance of the window in the normal
36894 way. For example, a resource setting of the form
36895 .code
36896 Eximon*background: gray94
36897 .endd
36898 changes the colour of the background to light grey rather than white. The
36899 stripcharts are drawn with both the data lines and the reference lines in
36900 black. This means that the reference lines are not visible when on top of the
36901 data. However, their colour can be changed by setting a resource called
36902 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36903 For example, if your X server is running Unix, you could set up lighter
36904 reference lines in the stripcharts by obeying
36905 .code
36906 xrdb -merge <<End
36907 Eximon*highlight: gray
36908 End
36909 .endd
36910 .cindex "admin user"
36911 In order to see the contents of messages on the queue, and to operate on them,
36912 &'eximon'& must either be run as root or by an admin user.
36913
36914 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36915 contain X11 resource parameters interpreted by the X11 library.  In addition,
36916 if the first parameter starts with the string "gdb" then it is removed and the
36917 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36918 versioned variants of gdb can be invoked).
36919
36920 The monitor's window is divided into three parts. The first contains one or
36921 more stripcharts and two action buttons, the second contains a &"tail"& of the
36922 main log file, and the third is a display of the queue of messages awaiting
36923 delivery, with two more action buttons. The following sections describe these
36924 different parts of the display.
36925
36926
36927
36928
36929 .section "The stripcharts" "SECID265"
36930 .cindex "stripchart"
36931 The first stripchart is always a count of messages on the queue. Its name can
36932 be configured by setting QUEUE_STRIPCHART_NAME in the
36933 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36934 configuration script by regular expression matches on log file entries, making
36935 it possible to display, for example, counts of messages delivered to certain
36936 hosts or using certain transports. The supplied defaults display counts of
36937 received and delivered messages, and of local and SMTP deliveries. The default
36938 period between stripchart updates is one minute; this can be adjusted by a
36939 parameter in the &_Local/eximon.conf_& file.
36940
36941 The stripchart displays rescale themselves automatically as the value they are
36942 displaying changes. There are always 10 horizontal lines in each chart; the
36943 title string indicates the value of each division when it is greater than one.
36944 For example, &"x2"& means that each division represents a value of 2.
36945
36946 It is also possible to have a stripchart which shows the percentage fullness of
36947 a particular disk partition, which is useful when local deliveries are confined
36948 to a single partition.
36949
36950 .cindex "&%statvfs%& function"
36951 This relies on the availability of the &[statvfs()]& function or equivalent in
36952 the operating system. Most, but not all versions of Unix that support Exim have
36953 this. For this particular stripchart, the top of the chart always represents
36954 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36955 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36956 &_Local/eximon.conf_& file.
36957
36958
36959
36960
36961 .section "Main action buttons" "SECID266"
36962 .cindex "size" "of monitor window"
36963 .cindex "Exim monitor" "window size"
36964 .cindex "window size"
36965 Below the stripcharts there is an action button for quitting the monitor. Next
36966 to this is another button marked &"Size"&. They are placed here so that
36967 shrinking the window to its default minimum size leaves just the queue count
36968 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36969 the window to expand to its maximum size, unless it is already at the maximum,
36970 in which case it is reduced to its minimum.
36971
36972 When expanding to the maximum, if the window cannot be fully seen where it
36973 currently is, it is moved back to where it was the last time it was at full
36974 size. When it is expanding from its minimum size, the old position is
36975 remembered, and next time it is reduced to the minimum it is moved back there.
36976
36977 The idea is that you can keep a reduced window just showing one or two
36978 stripcharts at a convenient place on your screen, easily expand it to show
36979 the full window when required, and just as easily put it back to what it was.
36980 The idea is copied from what the &'twm'& window manager does for its
36981 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36982 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36983
36984 Normally, the monitor starts up with the window at its full size, but it can be
36985 built so that it starts up with the window at its smallest size, by setting
36986 START_SMALL=yes in &_Local/eximon.conf_&.
36987
36988
36989
36990 .section "The log display" "SECID267"
36991 .cindex "log" "tail of; in monitor"
36992 The second section of the window is an area in which a display of the tail of
36993 the main log is maintained.
36994 To save space on the screen, the timestamp on each log line is shortened by
36995 removing the date and, if &%log_timezone%& is set, the timezone.
36996 The log tail is not available when the only destination for logging data is
36997 syslog, unless the syslog lines are routed to a local file whose name is passed
36998 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36999
37000 The log sub-window has a scroll bar at its lefthand side which can be used to
37001 move back to look at earlier text, and the up and down arrow keys also have a
37002 scrolling effect. The amount of log that is kept depends on the setting of
37003 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37004 to use. When this is full, the earlier 50% of data is discarded &-- this is
37005 much more efficient than throwing it away line by line. The sub-window also has
37006 a horizontal scroll bar for accessing the ends of long log lines. This is the
37007 only means of horizontal scrolling; the right and left arrow keys are not
37008 available. Text can be cut from this part of the window using the mouse in the
37009 normal way. The size of this subwindow is controlled by parameters in the
37010 configuration file &_Local/eximon.conf_&.
37011
37012 Searches of the text in the log window can be carried out by means of the ^R
37013 and ^S keystrokes, which default to a reverse and a forward search,
37014 respectively. The search covers only the text that is displayed in the window.
37015 It cannot go further back up the log.
37016
37017 The point from which the search starts is indicated by a caret marker. This is
37018 normally at the end of the text in the window, but can be positioned explicitly
37019 by pointing and clicking with the left mouse button, and is moved automatically
37020 by a successful search. If new text arrives in the window when it is scrolled
37021 back, the caret remains where it is, but if the window is not scrolled back,
37022 the caret is moved to the end of the new text.
37023
37024 Pressing ^R or ^S pops up a window into which the search text can be typed.
37025 There are buttons for selecting forward or reverse searching, for carrying out
37026 the search, and for cancelling. If the &"Search"& button is pressed, the search
37027 happens and the window remains so that further searches can be done. If the
37028 &"Return"& key is pressed, a single search is done and the window is closed. If
37029 ^C is typed the search is cancelled.
37030
37031 The searching facility is implemented using the facilities of the Athena text
37032 widget. By default this pops up a window containing both &"search"& and
37033 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37034 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37035 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37036 provided version of &%TextPop%& when the remaining parts of the text widget
37037 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37038 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37039 on these systems, at the expense of having unwanted items in the search popup
37040 window.
37041
37042
37043
37044 .section "The queue display" "SECID268"
37045 .cindex "queue" "display in monitor"
37046 The bottom section of the monitor window contains a list of all messages that
37047 are on the queue, which includes those currently being received or delivered,
37048 as well as those awaiting delivery. The size of this subwindow is controlled by
37049 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37050 at which it is updated is controlled by another parameter in the same file &--
37051 the default is 5 minutes, since queue scans can be quite expensive. However,
37052 there is an &"Update"& action button just above the display which can be used
37053 to force an update of the queue display at any time.
37054
37055 When a host is down for some time, a lot of pending mail can build up for it,
37056 and this can make it hard to deal with other messages on the queue. To help
37057 with this situation there is a button next to &"Update"& called &"Hide"&. If
37058 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37059 type anything in here and press &"Return"&, the text is added to a chain of
37060 such texts, and if every undelivered address in a message matches at least one
37061 of the texts, the message is not displayed.
37062
37063 If there is an address that does not match any of the texts, all the addresses
37064 are displayed as normal. The matching happens on the ends of addresses so, for
37065 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37066 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37067 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37068 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37069 a hide request is automatically cancelled after one hour.
37070
37071 While the dialogue box is displayed, you can't press any buttons or do anything
37072 else to the monitor window. For this reason, if you want to cut text from the
37073 queue display to use in the dialogue box, you have to do the cutting before
37074 pressing the &"Hide"& button.
37075
37076 The queue display contains, for each unhidden queued message, the length of
37077 time it has been on the queue, the size of the message, the message id, the
37078 message sender, and the first undelivered recipient, all on one line. If it is
37079 a bounce message, the sender is shown as &"<>"&. If there is more than one
37080 recipient to which the message has not yet been delivered, subsequent ones are
37081 listed on additional lines, up to a maximum configured number, following which
37082 an ellipsis is displayed. Recipients that have already received the message are
37083 not shown.
37084
37085 .cindex "frozen messages" "display"
37086 If a message is frozen, an asterisk is displayed at the left-hand side.
37087
37088 The queue display has a vertical scroll bar, and can also be scrolled by means
37089 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37090 The text searching facilities, as described above for the log window, are also
37091 available, but the caret is always moved to the end of the text when the queue
37092 display is updated.
37093
37094
37095
37096 .section "The queue menu" "SECID269"
37097 .cindex "queue" "menu in monitor"
37098 If the &%shift%& key is held down and the left button is clicked when the mouse
37099 pointer is over the text for any message, an action menu pops up, and the first
37100 line of the queue display for the message is highlighted. This does not affect
37101 any selected text.
37102
37103 If you want to use some other event for popping up the menu, you can set the
37104 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37105 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37106 value set in this parameter is a standard X event description. For example, to
37107 run eximon using &%ctrl%& rather than &%shift%& you could use
37108 .code
37109 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37110 .endd
37111 The title of the menu is the message id, and it contains entries which act as
37112 follows:
37113
37114 .ilist
37115 &'message log'&: The contents of the message log for the message are displayed
37116 in a new text window.
37117 .next
37118 &'headers'&: Information from the spool file that contains the envelope
37119 information and headers is displayed in a new text window. See chapter
37120 &<<CHAPspool>>& for a description of the format of spool files.
37121 .next
37122 &'body'&: The contents of the spool file containing the body of the message are
37123 displayed in a new text window. There is a default limit of 20,000 bytes to the
37124 amount of data displayed. This can be changed by setting the BODY_MAX
37125 option at compile time, or the EXIMON_BODY_MAX option at run time.
37126 .next
37127 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37128 delivery of the message. This causes an automatic thaw if the message is
37129 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37130 a new text window. The delivery is run in a separate process, to avoid holding
37131 up the monitor while the delivery proceeds.
37132 .next
37133 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37134 that the message be frozen.
37135 .next
37136 .cindex "thawing messages"
37137 .cindex "unfreezing messages"
37138 .cindex "frozen messages" "thawing"
37139 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37140 that the message be thawed.
37141 .next
37142 .cindex "delivery" "forcing failure"
37143 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37144 that Exim gives up trying to deliver the message. A bounce message is generated
37145 for any remaining undelivered addresses.
37146 .next
37147 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37148 that the message be deleted from the system without generating a bounce
37149 message.
37150 .next
37151 &'add recipient'&: A dialog box is displayed into which a recipient address can
37152 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37153 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37154 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37155 causes a call to Exim to be made using the &%-Mar%& option to request that an
37156 additional recipient be added to the message, unless the entry box is empty, in
37157 which case no action is taken.
37158 .next
37159 &'mark delivered'&: A dialog box is displayed into which a recipient address
37160 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37161 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37162 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37163 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37164 recipient address as already delivered, unless the entry box is empty, in which
37165 case no action is taken.
37166 .next
37167 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37168 mark all recipient addresses as already delivered.
37169 .next
37170 &'edit sender'&: A dialog box is displayed initialized with the current
37171 sender's address. Pressing RETURN causes a call to Exim to be made using the
37172 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37173 in which case no action is taken. If you want to set an empty sender (as in
37174 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37175 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37176 the address is qualified with that domain.
37177 .endlist
37178
37179 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37180 other cases when a call to Exim is made, if there is any output from Exim (in
37181 particular, if the command fails) a window containing the command and the
37182 output is displayed. Otherwise, the results of the action are normally apparent
37183 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37184 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37185 if no output is generated.
37186
37187 The queue display is automatically updated for actions such as freezing and
37188 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37189 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37190 force an update of the display after one of these actions.
37191
37192 In any text window that is displayed as result of a menu action, the normal
37193 cut-and-paste facility is available, and searching can be carried out using ^R
37194 and ^S, as described above for the log tail window.
37195 .ecindex IIDeximon
37196
37197
37198
37199
37200
37201 . ////////////////////////////////////////////////////////////////////////////
37202 . ////////////////////////////////////////////////////////////////////////////
37203
37204 .chapter "Security considerations" "CHAPsecurity"
37205 .scindex IIDsecurcon "security" "discussion of"
37206 This chapter discusses a number of issues concerned with security, some of
37207 which are also covered in other parts of this manual.
37208
37209 For reasons that this author does not understand, some people have promoted
37210 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37211 existence of this chapter in the documentation. However, the intent of the
37212 chapter is simply to describe the way Exim works in relation to certain
37213 security concerns, not to make any specific claims about the effectiveness of
37214 its security as compared with other MTAs.
37215
37216 What follows is a description of the way Exim is supposed to be. Best efforts
37217 have been made to try to ensure that the code agrees with the theory, but an
37218 absence of bugs can never be guaranteed. Any that are reported will get fixed
37219 as soon as possible.
37220
37221
37222 .section "Building a more &""hardened""& Exim" "SECID286"
37223 .cindex "security" "build-time features"
37224 There are a number of build-time options that can be set in &_Local/Makefile_&
37225 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37226 Exim administrator who does not have the root password, or by someone who has
37227 penetrated the Exim (but not the root) account. These options are as follows:
37228
37229 .ilist
37230 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37231 start of any file names used with the &%-C%& option. When it is set, these file
37232 names are also not allowed to contain the sequence &"/../"&. (However, if the
37233 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37234 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37235 default setting for &%ALT_CONFIG_PREFIX%&.
37236
37237 If the permitted configuration files are confined to a directory to
37238 which only root has access, this guards against someone who has broken
37239 into the Exim account from running a privileged Exim with an arbitrary
37240 configuration file, and using it to break into other accounts.
37241 .next
37242
37243 If a non-trusted configuration file (i.e. not the default configuration file
37244 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37245 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37246 the next item), then root privilege is retained only if the caller of Exim is
37247 root. This locks out the possibility of testing a configuration using &%-C%&
37248 right through message reception and delivery, even if the caller is root. The
37249 reception works, but by that time, Exim is running as the Exim user, so when
37250 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37251 privilege to be lost. However, root can test reception and delivery using two
37252 separate commands.
37253
37254 .next
37255 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37256 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37257 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37258 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37259 the restrictive side.  Requiring build-time selection of safe macros is onerous
37260 but this option is intended solely as a transition mechanism to permit
37261 previously-working configurations to continue to work after release 4.73.
37262 .next
37263 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37264 is disabled.
37265 .next
37266 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37267 never to be used for any deliveries. This is like the &%never_users%& runtime
37268 option, but it cannot be overridden; the runtime option adds additional users
37269 to the list. The default setting is &"root"&; this prevents a non-root user who
37270 is permitted to modify the runtime file from using Exim as a way to get root.
37271 .endlist
37272
37273
37274
37275 .section "Root privilege" "SECID270"
37276 .cindex "setuid"
37277 .cindex "root privilege"
37278 The Exim binary is normally setuid to root, which means that it gains root
37279 privilege (runs as root) when it starts execution. In some special cases (for
37280 example, when the daemon is not in use and there are no local deliveries), it
37281 may be possible to run Exim setuid to some user other than root. This is
37282 discussed in the next section. However, in most installations, root privilege
37283 is required for two things:
37284
37285 .ilist
37286 To set up a socket connected to the standard SMTP port (25) when initialising
37287 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37288 not required.
37289 .next
37290 To be able to change uid and gid in order to read users' &_.forward_& files and
37291 perform local deliveries as the receiving user or as specified in the
37292 configuration.
37293 .endlist
37294
37295 It is not necessary to be root to do any of the other things Exim does, such as
37296 receiving messages and delivering them externally over SMTP, and it is
37297 obviously more secure if Exim does not run as root except when necessary.
37298 For this reason, a user and group for Exim to use must be defined in
37299 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37300 group"&. Their values can be changed by the run time configuration, though this
37301 is not recommended. Often a user called &'exim'& is used, but some sites use
37302 &'mail'& or another user name altogether.
37303
37304 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37305 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37306 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37307
37308 After a new Exim process has interpreted its command line options, it changes
37309 uid and gid in the following cases:
37310
37311 .ilist
37312 .oindex "&%-C%&"
37313 .oindex "&%-D%&"
37314 If the &%-C%& option is used to specify an alternate configuration file, or if
37315 the &%-D%& option is used to define macro values for the configuration, and the
37316 calling process is not running as root, the uid and gid are changed to those of
37317 the calling process.
37318 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37319 option may not be used at all.
37320 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37321 can be supplied if the calling process is running as root, the Exim run-time
37322 user or CONFIGURE_OWNER, if defined.
37323 .next
37324 .oindex "&%-be%&"
37325 .oindex "&%-bf%&"
37326 .oindex "&%-bF%&"
37327 If the expansion test option (&%-be%&) or one of the filter testing options
37328 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37329 calling process.
37330 .next
37331 If the process is not a daemon process or a queue runner process or a delivery
37332 process or a process for testing address routing (started with &%-bt%&), the
37333 uid and gid are changed to the Exim user and group. This means that Exim always
37334 runs under its own uid and gid when receiving messages. This also applies when
37335 testing address verification
37336 .oindex "&%-bv%&"
37337 .oindex "&%-bh%&"
37338 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37339 option).
37340 .next
37341 For a daemon, queue runner, delivery, or address testing process, the uid
37342 remains as root at this stage, but the gid is changed to the Exim group.
37343 .endlist
37344
37345 The processes that initially retain root privilege behave as follows:
37346
37347 .ilist
37348 A daemon process changes the gid to the Exim group and the uid to the Exim
37349 user after setting up one or more listening sockets. The &[initgroups()]&
37350 function is called, so that if the Exim user is in any additional groups, they
37351 will be used during message reception.
37352 .next
37353 A queue runner process retains root privilege throughout its execution. Its
37354 job is to fork a controlled sequence of delivery processes.
37355 .next
37356 A delivery process retains root privilege throughout most of its execution,
37357 but any actual deliveries (that is, the transports themselves) are run in
37358 subprocesses which always change to a non-root uid and gid. For local
37359 deliveries this is typically the uid and gid of the owner of the mailbox; for
37360 remote deliveries, the Exim uid and gid are used. Once all the delivery
37361 subprocesses have been run, a delivery process changes to the Exim uid and gid
37362 while doing post-delivery tidying up such as updating the retry database and
37363 generating bounce and warning messages.
37364
37365 While the recipient addresses in a message are being routed, the delivery
37366 process runs as root. However, if a user's filter file has to be processed,
37367 this is done in a subprocess that runs under the individual user's uid and
37368 gid. A system filter is run as root unless &%system_filter_user%& is set.
37369 .next
37370 A process that is testing addresses (the &%-bt%& option) runs as root so that
37371 the routing is done in the same environment as a message delivery.
37372 .endlist
37373
37374
37375
37376
37377 .section "Running Exim without privilege" "SECTrunexiwitpri"
37378 .cindex "privilege, running without"
37379 .cindex "unprivileged running"
37380 .cindex "root privilege" "running without"
37381 Some installations like to run Exim in an unprivileged state for more of its
37382 operation, for added security. Support for this mode of operation is provided
37383 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37384 gid are changed to the Exim user and group at the start of a delivery process
37385 (and also queue runner and address testing processes). This means that address
37386 routing is no longer run as root, and the deliveries themselves cannot change
37387 to any other uid.
37388
37389 .cindex SIGHUP
37390 .cindex "daemon" "restarting"
37391 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37392 that the daemon can still be started in the usual way, and it can respond
37393 correctly to SIGHUP because the re-invocation regains root privilege.
37394
37395 An alternative approach is to make Exim setuid to the Exim user and also setgid
37396 to the Exim group. If you do this, the daemon must be started from a root
37397 process. (Calling Exim from a root process makes it behave in the way it does
37398 when it is setuid root.) However, the daemon cannot restart itself after a
37399 SIGHUP signal because it cannot regain privilege.
37400
37401 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37402 stops Exim from trying to re-invoke itself to do a delivery after a message has
37403 been received. Such a re-invocation is a waste of resources because it has no
37404 effect.
37405
37406 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37407 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37408 to the Exim user seems a clean approach, but there is one complication:
37409
37410 In this style of operation, Exim is running with the real uid and gid set to
37411 those of the calling process, and the effective uid/gid set to Exim's values.
37412 Ideally, any association with the calling process' uid/gid should be dropped,
37413 that is, the real uid/gid should be reset to the effective values so as to
37414 discard any privileges that the caller may have. While some operating systems
37415 have a function that permits this action for a non-root effective uid, quite a
37416 number of them do not. Because of this lack of standardization, Exim does not
37417 address this problem at this time.
37418
37419 For this reason, the recommended approach for &"mostly unprivileged"& running
37420 is to keep the Exim binary setuid to root, and to set
37421 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37422 be used in the most straightforward way.
37423
37424 If you configure Exim not to run delivery processes as root, there are a
37425 number of restrictions on what you can do:
37426
37427 .ilist
37428 You can deliver only as the Exim user/group. You should  explicitly use the
37429 &%user%& and &%group%& options to override routers or local transports that
37430 normally deliver as the recipient. This makes sure that configurations that
37431 work in this mode function the same way in normal mode. Any implicit or
37432 explicit specification of another user causes an error.
37433 .next
37434 Use of &_.forward_& files is severely restricted, such that it is usually
37435 not worthwhile to include them in the configuration.
37436 .next
37437 Users who wish to use &_.forward_& would have to make their home directory and
37438 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37439 and their equivalents in Exim filters, cannot be used. While they could be
37440 enabled in the Exim user's name, that would be insecure and not very useful.
37441 .next
37442 Unless the local user mailboxes are all owned by the Exim user (possible in
37443 some POP3 or IMAP-only environments):
37444
37445 .olist
37446 They must be owned by the Exim group and be writeable by that group. This
37447 implies you must set &%mode%& in the appendfile configuration, as well as the
37448 mode of the mailbox files themselves.
37449 .next
37450 You must set &%no_check_owner%&, since most or all of the files will not be
37451 owned by the Exim user.
37452 .next
37453 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37454 on a newly created mailbox when unprivileged. This also implies that new
37455 mailboxes need to be created manually.
37456 .endlist olist
37457 .endlist ilist
37458
37459
37460 These restrictions severely restrict what can be done in local deliveries.
37461 However, there are no restrictions on remote deliveries. If you are running a
37462 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37463 gives more security at essentially no cost.
37464
37465 If you are using the &%mua_wrapper%& facility (see chapter
37466 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37467
37468
37469
37470
37471 .section "Delivering to local files" "SECID271"
37472 Full details of the checks applied by &(appendfile)& before it writes to a file
37473 are given in chapter &<<CHAPappendfile>>&.
37474
37475
37476
37477 .section "Running local commands" "SECTsecconslocalcmds"
37478 .cindex "security" "local commands"
37479 .cindex "security" "command injection attacks"
37480 There are a number of ways in which an administrator can configure Exim to run
37481 commands based upon received, untrustworthy, data. Further, in some
37482 configurations a user who can control a &_.forward_& file can also arrange to
37483 run commands. Configuration to check includes, but is not limited to:
37484
37485 .ilist
37486 Use of &%use_shell%& in the pipe transport: various forms of shell command
37487 injection may be possible with this option present. It is dangerous and should
37488 be used only with considerable caution. Consider constraints which whitelist
37489 allowed characters in a variable which is to be used in a pipe transport that
37490 has &%use_shell%& enabled.
37491 .next
37492 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37493 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37494 &_.forward_& files in a redirect router. If Exim is running on a central mail
37495 hub to which ordinary users do not have shell access, but home directories are
37496 NFS mounted (for instance) then administrators should review the list of these
37497 forbid options available, and should bear in mind that the options that may
37498 need forbidding can change as new features are added between releases.
37499 .next
37500 The &%${run...}%& expansion item does not use a shell by default, but
37501 administrators can configure use of &_/bin/sh_& as part of the command.
37502 Such invocations should be viewed with prejudicial suspicion.
37503 .next
37504 Administrators who use embedded Perl are advised to explore how Perl's
37505 taint checking might apply to their usage.
37506 .next
37507 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37508 administrators are well advised to view its use with suspicion, in case (for
37509 instance) it allows a local-part to contain embedded Exim directives.
37510 .next
37511 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37512 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37513 each can reference arbitrary lists and files, rather than just being a list
37514 of opaque strings.
37515 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37516 real-world security vulnerabilities caused by its use with untrustworthy data
37517 injected in, for SQL injection attacks.
37518 Consider the use of the &%inlisti%& expansion condition instead.
37519 .endlist
37520
37521
37522
37523
37524 .section "Trust in configuration data" "SECTsecconfdata"
37525 .cindex "security" "data sources"
37526 .cindex "security" "regular expressions"
37527 .cindex "regular expressions" "security"
37528 .cindex "PCRE" "security"
37529 If configuration data for Exim can come from untrustworthy sources, there
37530 are some issues to be aware of:
37531
37532 .ilist
37533 Use of &%${expand...}%& may provide a path for shell injection attacks.
37534 .next
37535 Letting untrusted data provide a regular expression is unwise.
37536 .next
37537 Using &%${match...}%& to apply a fixed regular expression against untrusted
37538 data may result in pathological behaviour within PCRE.  Be aware of what
37539 "backtracking" means and consider options for being more strict with a regular
37540 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37541 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37542 possessive quantifiers or just not using regular expressions against untrusted
37543 data.
37544 .next
37545 It can be important to correctly use &%${quote:...}%&,
37546 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37547 items to ensure that data is correctly constructed.
37548 .next
37549 Some lookups might return multiple results, even though normal usage is only
37550 expected to yield one result.
37551 .endlist
37552
37553
37554
37555
37556 .section "IPv4 source routing" "SECID272"
37557 .cindex "source routing" "in IP packets"
37558 .cindex "IP source routing"
37559 Many operating systems suppress IP source-routed packets in the kernel, but
37560 some cannot be made to do this, so Exim does its own check. It logs incoming
37561 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37562 IPv6. No special checking is currently done.
37563
37564
37565
37566 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37567 Support for these SMTP commands is disabled by default. If required, they can
37568 be enabled by defining suitable ACLs.
37569
37570
37571
37572
37573 .section "Privileged users" "SECID274"
37574 .cindex "trusted users"
37575 .cindex "admin user"
37576 .cindex "privileged user"
37577 .cindex "user" "trusted"
37578 .cindex "user" "admin"
37579 Exim recognizes two sets of users with special privileges. Trusted users are
37580 able to submit new messages to Exim locally, but supply their own sender
37581 addresses and information about a sending host. For other users submitting
37582 local messages, Exim sets up the sender address from the uid, and doesn't
37583 permit a remote host to be specified.
37584
37585 .oindex "&%-f%&"
37586 However, an untrusted user is permitted to use the &%-f%& command line option
37587 in the special form &%-f <>%& to indicate that a delivery failure for the
37588 message should not cause an error report. This affects the message's envelope,
37589 but it does not affect the &'Sender:'& header. Untrusted users may also be
37590 permitted to use specific forms of address with the &%-f%& option by setting
37591 the &%untrusted_set_sender%& option.
37592
37593 Trusted users are used to run processes that receive mail messages from some
37594 other mail domain and pass them on to Exim for delivery either locally, or over
37595 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37596 as any user listed in the &%trusted_users%& configuration option, or under any
37597 group listed in the &%trusted_groups%& option.
37598
37599 Admin users are permitted to do things to the messages on Exim's queue. They
37600 can freeze or thaw messages, cause them to be returned to their senders, remove
37601 them entirely, or modify them in various ways. In addition, admin users can run
37602 the Exim monitor and see all the information it is capable of providing, which
37603 includes the contents of files on the spool.
37604
37605 .oindex "&%-M%&"
37606 .oindex "&%-q%&"
37607 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37608 delivery of messages on its queue is restricted to admin users. This
37609 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37610 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37611 queue is also restricted to admin users. This restriction can be relaxed by
37612 setting &%no_queue_list_requires_admin%&.
37613
37614 Exim recognizes an admin user if the calling process is running as root or as
37615 the Exim user or if any of the groups associated with the calling process is
37616 the Exim group. It is not necessary actually to be running under the Exim
37617 group. However, if admin users who are not root or the Exim user are to access
37618 the contents of files on the spool via the Exim monitor (which runs
37619 unprivileged), Exim must be built to allow group read access to its spool
37620 files.
37621
37622
37623
37624 .section "Spool files" "SECID275"
37625 .cindex "spool directory" "files"
37626 Exim's spool directory and everything it contains is owned by the Exim user and
37627 set to the Exim group. The mode for spool files is defined in the
37628 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37629 any user who is a member of the Exim group can access these files.
37630
37631
37632
37633 .section "Use of argv[0]" "SECID276"
37634 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37635 of specific strings, Exim assumes certain options. For example, calling Exim
37636 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37637 to calling it with the option &%-bS%&. There are no security implications in
37638 this.
37639
37640
37641
37642 .section "Use of %f formatting" "SECID277"
37643 The only use made of &"%f"& by Exim is in formatting load average values. These
37644 are actually stored in integer variables as 1000 times the load average.
37645 Consequently, their range is limited and so therefore is the length of the
37646 converted output.
37647
37648
37649
37650 .section "Embedded Exim path" "SECID278"
37651 Exim uses its own path name, which is embedded in the code, only when it needs
37652 to re-exec in order to regain root privilege. Therefore, it is not root when it
37653 does so. If some bug allowed the path to get overwritten, it would lead to an
37654 arbitrary program's being run as exim, not as root.
37655
37656
37657
37658 .section "Dynamic module directory" "SECTdynmoddir"
37659 Any dynamically loadable modules must be installed into the directory
37660 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37661 loading it.
37662
37663
37664 .section "Use of sprintf()" "SECID279"
37665 .cindex "&[sprintf()]&"
37666 A large number of occurrences of &"sprintf"& in the code are actually calls to
37667 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37668 The intermediate formatting is done into a large fixed buffer by a function
37669 that runs through the format string itself, and checks the length of each
37670 conversion before performing it, thus preventing buffer overruns.
37671
37672 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37673 the output buffer is known to be sufficiently long to contain the converted
37674 string.
37675
37676
37677
37678 .section "Use of debug_printf() and log_write()" "SECID280"
37679 Arbitrary strings are passed to both these functions, but they do their
37680 formatting by calling the function &'string_vformat()'&, which runs through
37681 the format string itself, and checks the length of each conversion.
37682
37683
37684
37685 .section "Use of strcat() and strcpy()" "SECID281"
37686 These are used only in cases where the output buffer is known to be large
37687 enough to hold the result.
37688 .ecindex IIDsecurcon
37689
37690
37691
37692
37693 . ////////////////////////////////////////////////////////////////////////////
37694 . ////////////////////////////////////////////////////////////////////////////
37695
37696 .chapter "Format of spool files" "CHAPspool"
37697 .scindex IIDforspo1 "format" "spool files"
37698 .scindex IIDforspo2 "spool directory" "format of files"
37699 .scindex IIDforspo3 "spool files" "format of"
37700 .cindex "spool files" "editing"
37701 A message on Exim's queue consists of two files, whose names are the message id
37702 followed by -D and -H, respectively. The data portion of the message is kept in
37703 the -D file on its own. The message's envelope, status, and headers are all
37704 kept in the -H file, whose format is described in this chapter. Each of these
37705 two files contains the final component of its own name as its first line. This
37706 is insurance against disk crashes where the directory is lost but the files
37707 themselves are recoverable.
37708
37709 Some people are tempted into editing -D files in order to modify messages. You
37710 need to be extremely careful if you do this; it is not recommended and you are
37711 on your own if you do it. Here are some of the pitfalls:
37712
37713 .ilist
37714 You must ensure that Exim does not try to deliver the message while you are
37715 fiddling with it. The safest way is to take out a write lock on the -D file,
37716 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37717 place, the lock will be retained. If you write a new file and rename it, the
37718 lock will be lost at the instant of rename.
37719 .next
37720 .vindex "&$body_linecount$&"
37721 If you change the number of lines in the file, the value of
37722 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37723 present, this value is not used by Exim, but there is no guarantee that this
37724 will always be the case.
37725 .next
37726 If the message is in MIME format, you must take care not to break it.
37727 .next
37728 If the message is cryptographically signed, any change will invalidate the
37729 signature.
37730 .endlist
37731 All in all, modifying -D files is fraught with danger.
37732
37733 Files whose names end with -J may also be seen in the &_input_& directory (or
37734 its subdirectories when &%split_spool_directory%& is set). These are journal
37735 files, used to record addresses to which the message has been delivered during
37736 the course of a delivery attempt. If there are still undelivered recipients at
37737 the end, the -H file is updated, and the -J file is deleted. If, however, there
37738 is some kind of crash (for example, a power outage) before this happens, the -J
37739 file remains in existence. When Exim next processes the message, it notices the
37740 -J file and uses it to update the -H file before starting the next delivery
37741 attempt.
37742
37743 .section "Format of the -H file" "SECID282"
37744 .cindex "uid (user id)" "in spool file"
37745 .cindex "gid (group id)" "in spool file"
37746 The second line of the -H file contains the login name for the uid of the
37747 process that called Exim to read the message, followed by the numerical uid and
37748 gid. For a locally generated message, this is normally the user who sent the
37749 message. For a message received over TCP/IP via the daemon, it is
37750 normally the Exim user.
37751
37752 The third line of the file contains the address of the message's sender as
37753 transmitted in the envelope, contained in angle brackets. The sender address is
37754 empty for bounce messages. For incoming SMTP mail, the sender address is given
37755 in the MAIL command. For locally generated mail, the sender address is
37756 created by Exim from the login name of the current user and the configured
37757 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37758 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37759 &"<>"& or an address that matches &%untrusted_set_senders%&.
37760
37761 The fourth line contains two numbers. The first is the time that the message
37762 was received, in the conventional Unix form &-- the number of seconds since the
37763 start of the epoch. The second number is a count of the number of messages
37764 warning of delayed delivery that have been sent to the sender.
37765
37766 There follow a number of lines starting with a hyphen. These can appear in any
37767 order, and are omitted when not relevant:
37768
37769 .vlist
37770 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37771 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37772 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37773 recognized, to provide backward compatibility. In the old format, a line of
37774 this form is present for every ACL variable that is not empty. The number
37775 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37776 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37777 the data string for the variable. The string itself starts at the beginning of
37778 the next line, and is followed by a newline character. It may contain internal
37779 newlines.
37780
37781 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37782 A line of this form is present for every ACL connection variable that is
37783 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37784 The length is the length of the data string for the variable. The string itself
37785 starts at the beginning of the next line, and is followed by a newline
37786 character. It may contain internal newlines.
37787
37788 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37789 A line of this form is present for every ACL message variable that is defined.
37790 Note that there is a space between &%-aclm%& and the rest of the name. The
37791 length is the length of the data string for the variable. The string itself
37792 starts at the beginning of the next line, and is followed by a newline
37793 character. It may contain internal newlines.
37794
37795 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37796 This is present if, when the message was received over SMTP, the value of
37797 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37798
37799 .vitem &%-allow_unqualified_recipient%&
37800 This is present if unqualified recipient addresses are permitted in header
37801 lines (to stop such addresses from being qualified if rewriting occurs at
37802 transport time). Local messages that were input using &%-bnq%& and remote
37803 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37804
37805 .vitem &%-allow_unqualified_sender%&
37806 This is present if unqualified sender addresses are permitted in header lines
37807 (to stop such addresses from being qualified if rewriting occurs at transport
37808 time). Local messages that were input using &%-bnq%& and remote messages from
37809 hosts that match &%sender_unqualified_hosts%& set this flag.
37810
37811 .vitem "&%-auth_id%&&~<&'text'&>"
37812 The id information for a message received on an authenticated SMTP connection
37813 &-- the value of the &$authenticated_id$& variable.
37814
37815 .vitem "&%-auth_sender%&&~<&'address'&>"
37816 The address of an authenticated sender &-- the value of the
37817 &$authenticated_sender$& variable.
37818
37819 .vitem "&%-body_linecount%&&~<&'number'&>"
37820 This records the number of lines in the body of the message, and is always
37821 present.
37822
37823 .vitem "&%-body_zerocount%&&~<&'number'&>"
37824 This records the number of binary zero bytes in the body of the message, and is
37825 present if the number is greater than zero.
37826
37827 .vitem &%-deliver_firsttime%&
37828 This is written when a new message is first added to the spool. When the spool
37829 file is updated after a deferral, it is omitted.
37830
37831 .vitem "&%-frozen%&&~<&'time'&>"
37832 .cindex "frozen messages" "spool data"
37833 The message is frozen, and the freezing happened at <&'time'&>.
37834
37835 .vitem "&%-helo_name%&&~<&'text'&>"
37836 This records the host name as specified by a remote host in a HELO or EHLO
37837 command.
37838
37839 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37840 This records the IP address of the host from which the message was received and
37841 the remote port number that was used. It is omitted for locally generated
37842 messages.
37843
37844 .vitem "&%-host_auth%&&~<&'text'&>"
37845 If the message was received on an authenticated SMTP connection, this records
37846 the name of the authenticator &-- the value of the
37847 &$sender_host_authenticated$& variable.
37848
37849 .vitem &%-host_lookup_failed%&
37850 This is present if an attempt to look up the sending host's name from its IP
37851 address failed. It corresponds to the &$host_lookup_failed$& variable.
37852
37853 .vitem "&%-host_name%&&~<&'text'&>"
37854 .cindex "reverse DNS lookup"
37855 .cindex "DNS" "reverse lookup"
37856 This records the name of the remote host from which the message was received,
37857 if the host name was looked up from the IP address when the message was being
37858 received. It is not present if no reverse lookup was done.
37859
37860 .vitem "&%-ident%&&~<&'text'&>"
37861 For locally submitted messages, this records the login of the originating user,
37862 unless it was a trusted user and the &%-oMt%& option was used to specify an
37863 ident value. For messages received over TCP/IP, this records the ident string
37864 supplied by the remote host, if any.
37865
37866 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37867 This records the IP address of the local interface and the port number through
37868 which a message was received from a remote host. It is omitted for locally
37869 generated messages.
37870
37871 .vitem &%-local%&
37872 The message is from a local sender.
37873
37874 .vitem &%-localerror%&
37875 The message is a locally-generated bounce message.
37876
37877 .vitem "&%-local_scan%&&~<&'string'&>"
37878 This records the data string that was returned by the &[local_scan()]& function
37879 when the message was received &-- the value of the &$local_scan_data$&
37880 variable. It is omitted if no data was returned.
37881
37882 .vitem &%-manual_thaw%&
37883 The message was frozen but has been thawed manually, that is, by an explicit
37884 Exim command rather than via the auto-thaw process.
37885
37886 .vitem &%-N%&
37887 A testing delivery process was started using the &%-N%& option to suppress any
37888 actual deliveries, but delivery was deferred. At any further delivery attempts,
37889 &%-N%& is assumed.
37890
37891 .vitem &%-received_protocol%&
37892 This records the value of the &$received_protocol$& variable, which contains
37893 the name of the protocol by which the message was received.
37894
37895 .vitem &%-sender_set_untrusted%&
37896 The envelope sender of this message was set by an untrusted local caller (used
37897 to ensure that the caller is displayed in queue listings).
37898
37899 .vitem "&%-spam_score_int%&&~<&'number'&>"
37900 If a message was scanned by SpamAssassin, this is present. It records the value
37901 of &$spam_score_int$&.
37902
37903 .vitem &%-tls_certificate_verified%&
37904 A TLS certificate was received from the client that sent this message, and the
37905 certificate was verified by the server.
37906
37907 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37908 When the message was received over an encrypted connection, this records the
37909 name of the cipher suite that was used.
37910
37911 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37912 When the message was received over an encrypted connection, and a certificate
37913 was received from the client, this records the Distinguished Name from that
37914 certificate.
37915 .endlist
37916
37917 Following the options there is a list of those addresses to which the message
37918 is not to be delivered. This set of addresses is initialized from the command
37919 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37920 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37921 the address is added to this set. The addresses are kept internally as a
37922 balanced binary tree, and it is a representation of that tree which is written
37923 to the spool file. If an address is expanded via an alias or forward file, the
37924 original address is added to the tree when deliveries to all its child
37925 addresses are complete.
37926
37927 If the tree is empty, there is a single line in the spool file containing just
37928 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37929 Y or N, followed by an address. The address is the value for the node of the
37930 tree, and the letters indicate whether the node has a left branch and/or a
37931 right branch attached to it, respectively. If branches exist, they immediately
37932 follow. Here is an example of a three-node tree:
37933 .code
37934 YY darcy@austen.fict.example
37935 NN alice@wonderland.fict.example
37936 NN editor@thesaurus.ref.example
37937 .endd
37938 After the non-recipients tree, there is a list of the message's recipients.
37939 This is a simple list, preceded by a count. It includes all the original
37940 recipients of the message, including those to whom the message has already been
37941 delivered. In the simplest case, the list contains one address per line. For
37942 example:
37943 .code
37944 4
37945 editor@thesaurus.ref.example
37946 darcy@austen.fict.example
37947 rdo@foundation
37948 alice@wonderland.fict.example
37949 .endd
37950 However, when a child address has been added to the top-level addresses as a
37951 result of the use of the &%one_time%& option on a &(redirect)& router, each
37952 line is of the following form:
37953 .display
37954 <&'top-level address'&> <&'errors_to address'&> &&&
37955   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37956 .endd
37957 The 01 flag bit indicates the presence of the three other fields that follow
37958 the top-level address. Other bits may be used in future to support additional
37959 fields. The <&'parent number'&> is the offset in the recipients list of the
37960 original parent of the &"one time"& address. The first two fields are the
37961 envelope sender that is associated with this address and its length. If the
37962 length is zero, there is no special envelope sender (there are then two space
37963 characters in the line). A non-empty field can arise from a &(redirect)& router
37964 that has an &%errors_to%& setting.
37965
37966
37967 A blank line separates the envelope and status information from the headers
37968 which follow. A header may occupy several lines of the file, and to save effort
37969 when reading it in, each header is preceded by a number and an identifying
37970 character. The number is the number of characters in the header, including any
37971 embedded newlines and the terminating newline. The character is one of the
37972 following:
37973
37974 .table2 50pt
37975 .row <&'blank'&>         "header in which Exim has no special interest"
37976 .row &`B`&               "&'Bcc:'& header"
37977 .row &`C`&               "&'Cc:'& header"
37978 .row &`F`&               "&'From:'& header"
37979 .row &`I`&               "&'Message-id:'& header"
37980 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37981 .row &`R`&               "&'Reply-To:'& header"
37982 .row &`S`&               "&'Sender:'& header"
37983 .row &`T`&               "&'To:'& header"
37984 .row &`*`&               "replaced or deleted header"
37985 .endtable
37986
37987 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37988 purposes. They are not transmitted when the message is delivered. Here is a
37989 typical set of headers:
37990 .code
37991 111P Received: by hobbit.fict.example with local (Exim 4.00)
37992 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37993 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37994 038* X-rewrote-sender: bb@hobbit.fict.example
37995 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37996 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37997 099* To: alice@wonderland.fict.example, rdo@foundation,
37998 darcy@austen.fict.example, editor@thesaurus.ref.example
37999 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38000 darcy@austen.fict.example, editor@thesaurus.ref.example
38001 038  Date: Fri, 11 May 2001 10:28:59 +0100
38002 .endd
38003 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38004 &'To:'& header have been rewritten, the last one because routing expanded the
38005 unqualified domain &'foundation'&.
38006 .ecindex IIDforspo1
38007 .ecindex IIDforspo2
38008 .ecindex IIDforspo3
38009
38010 . ////////////////////////////////////////////////////////////////////////////
38011 . ////////////////////////////////////////////////////////////////////////////
38012
38013 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38014          "DKIM Support"
38015 .cindex "DKIM"
38016
38017 DKIM is a mechanism by which messages sent by some entity can be provably
38018 linked to a domain which that entity controls.  It permits reputation to
38019 be tracked on a per-domain basis, rather than merely upon source IP address.
38020 DKIM is documented in RFC 4871.
38021
38022 DKIM support is compiled into Exim by default if TLS support is present.
38023 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38024
38025 Exim's DKIM implementation allows to
38026 .olist
38027 Sign outgoing messages: This function is implemented in the SMTP transport.
38028 It can co-exist with all other Exim features
38029 (including transport filters)
38030 except cutthrough delivery.
38031 .next
38032 Verify signatures in incoming messages: This is implemented by an additional
38033 ACL (acl_smtp_dkim), which can be called several times per message, with
38034 different signature contexts.
38035 .endlist
38036
38037 In typical Exim style, the verification implementation does not include any
38038 default "policy". Instead it enables you to build your own policy using
38039 Exim's standard controls.
38040
38041 Please note that verification of DKIM signatures in incoming mail is turned
38042 on by default for logging purposes. For each signature in incoming email,
38043 exim will log a line displaying the most important signature details, and the
38044 signature status. Here is an example (with line-breaks added for clarity):
38045 .code
38046 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38047     d=facebookmail.com s=q1-2009b
38048     c=relaxed/relaxed a=rsa-sha1
38049     i=@facebookmail.com t=1252484542 [verification succeeded]
38050 .endd
38051 You might want to turn off DKIM verification processing entirely for internal
38052 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38053 control modifier. This should typically be done in the RCPT ACL, at points
38054 where you accept mail from relay sources (internal hosts or authenticated
38055 senders).
38056
38057
38058 .section "Signing outgoing messages" "SECDKIMSIGN"
38059 .cindex "DKIM" "signing"
38060
38061 Signing is implemented by setting private options on the SMTP transport.
38062 These options take (expandable) strings as arguments.
38063
38064 .option dkim_domain smtp string&!! unset
38065 MANDATORY:
38066 The domain you want to sign with. The result of this expanded
38067 option is put into the &%$dkim_domain%& expansion variable.
38068
38069 .option dkim_selector smtp string&!! unset
38070 MANDATORY:
38071 This sets the key selector string. You can use the &%$dkim_domain%& expansion
38072 variable to look up a matching selector. The result is put in the expansion
38073 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38074 option along with &%$dkim_domain%&.
38075
38076 .option dkim_private_key smtp string&!! unset
38077 MANDATORY:
38078 This sets the private key to use. You can use the &%$dkim_domain%& and
38079 &%$dkim_selector%& expansion variables to determine the private key to use.
38080 The result can either
38081 .ilist
38082 be a valid RSA private key in ASCII armor, including line breaks.
38083 .next
38084 start with a slash, in which case it is treated as a file that contains
38085 the private key.
38086 .next
38087 be "0", "false" or the empty string, in which case the message will not
38088 be signed. This case will not result in an error, even if &%dkim_strict%&
38089 is set.
38090 .endlist
38091
38092 .option dkim_canon smtp string&!! unset
38093 OPTIONAL:
38094 This option sets the canonicalization method used when signing a message.
38095 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38096 The option defaults to "relaxed" when unset. Note: the current implementation
38097 only supports using the same canonicalization method for both headers and body.
38098
38099 .option dkim_strict smtp string&!! unset
38100 OPTIONAL:
38101 This  option  defines  how  Exim  behaves  when  signing a message that
38102 should be signed fails for some reason.  When the expansion evaluates to
38103 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38104 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38105 variables here.
38106
38107 .option dkim_sign_headers smtp string&!! unset
38108 OPTIONAL:
38109 When set, this option must expand to (or be specified as) a colon-separated
38110 list of header names. Headers with these names will be included in the message
38111 signature. When unspecified, the header names recommended in RFC4871 will be
38112 used.
38113
38114
38115 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38116 .cindex "DKIM" "verification"
38117
38118 Verification of DKIM signatures in incoming email is implemented via the
38119 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38120 syntactically(!) correct signature in the incoming message.
38121 A missing ACL definition defaults to accept.
38122 If any ACL call does not accept, the message is not accepted.
38123 If a cutthrough delivery was in progress for the message it is
38124 summarily dropped (having wasted the transmission effort).
38125
38126 To evaluate the signature in the ACL a large number of expansion variables
38127 containing the signature status and its details are set up during the
38128 runtime of the ACL.
38129
38130 Calling the ACL only for existing signatures is not sufficient to build
38131 more advanced policies. For that reason, the global option
38132 &%dkim_verify_signers%&, and a global expansion variable
38133 &%$dkim_signers%& exist.
38134
38135 The global option &%dkim_verify_signers%& can be set to a colon-separated
38136 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38137 called. It is expanded when the message has been received. At this point,
38138 the expansion variable &%$dkim_signers%& already contains a colon-separated
38139 list of signer domains and identities for the message. When
38140 &%dkim_verify_signers%& is not specified in the main configuration,
38141 it defaults as:
38142 .code
38143 dkim_verify_signers = $dkim_signers
38144 .endd
38145 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38146 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38147 call the ACL for known domains or identities. This would be achieved as follows:
38148 .code
38149 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38150 .endd
38151 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38152 and "ebay.com", plus all domains and identities that have signatures in the message.
38153 You can also be more creative in constructing your policy. For example:
38154 .code
38155 dkim_verify_signers = $sender_address_domain:$dkim_signers
38156 .endd
38157
38158 If a domain or identity is listed several times in the (expanded) value of
38159 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38160
38161
38162 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38163 available (from most to least important):
38164
38165
38166 .vlist
38167 .vitem &%$dkim_cur_signer%&
38168 The signer that is being evaluated in this ACL run. This can be a domain or
38169 an identity. This is one of the list items from the expanded main option
38170 &%dkim_verify_signers%& (see above).
38171 .vitem &%$dkim_verify_status%&
38172 A string describing the general status of the signature. One of
38173 .ilist
38174 &%none%&: There is no signature in the message for the current domain or
38175 identity (as reflected by &%$dkim_cur_signer%&).
38176 .next
38177 &%invalid%&: The signature could not be verified due to a processing error.
38178 More detail is available in &%$dkim_verify_reason%&.
38179 .next
38180 &%fail%&: Verification of the signature failed.  More detail is
38181 available in &%$dkim_verify_reason%&.
38182 .next
38183 &%pass%&: The signature passed verification. It is valid.
38184 .endlist
38185 .vitem &%$dkim_verify_reason%&
38186 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38187 "fail" or "invalid". One of
38188 .ilist
38189 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38190 key for the domain could not be retrieved. This may be a temporary problem.
38191 .next
38192 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38193 record for the domain is syntactically invalid.
38194 .next
38195 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38196 body hash does not match the one specified in the signature header. This
38197 means that the message body was modified in transit.
38198 .next
38199 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38200 could not be verified. This may mean that headers were modified,
38201 re-written or otherwise changed in a way which is incompatible with
38202 DKIM verification. It may of course also mean that the signature is forged.
38203 .endlist
38204 .vitem &%$dkim_domain%&
38205 The signing domain. IMPORTANT: This variable is only populated if there is
38206 an actual signature in the message for the current domain or identity (as
38207 reflected by &%$dkim_cur_signer%&).
38208 .vitem &%$dkim_identity%&
38209 The signing identity, if present. IMPORTANT: This variable is only populated
38210 if there is an actual signature in the message for the current domain or
38211 identity (as reflected by &%$dkim_cur_signer%&).
38212 .vitem &%$dkim_selector%&
38213 The key record selector string.
38214 .vitem &%$dkim_algo%&
38215 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38216 .vitem &%$dkim_canon_body%&
38217 The body canonicalization method. One of 'relaxed' or 'simple'.
38218 .vitem &%dkim_canon_headers%&
38219 The header canonicalization method. One of 'relaxed' or 'simple'.
38220 .vitem &%$dkim_copiedheaders%&
38221 A transcript of headers and their values which are included in the signature
38222 (copied from the 'z=' tag of the signature).
38223 .vitem &%$dkim_bodylength%&
38224 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38225 limit was set by the signer, "9999999999999" is returned. This makes sure
38226 that this variable always expands to an integer value.
38227 .vitem &%$dkim_created%&
38228 UNIX timestamp reflecting the date and time when the signature was created.
38229 When this was not specified by the signer, "0" is returned.
38230 .vitem &%$dkim_expires%&
38231 UNIX timestamp reflecting the date and time when the signer wants the
38232 signature to be treated as "expired". When this was not specified by the
38233 signer, "9999999999999" is returned. This makes it possible to do useful
38234 integer size comparisons against this value.
38235 .vitem &%$dkim_headernames%&
38236 A colon-separated list of names of headers included in the signature.
38237 .vitem &%$dkim_key_testing%&
38238 "1" if the key record has the "testing" flag set, "0" if not.
38239 .vitem &%$dkim_key_nosubdomains%&
38240 "1" if the key record forbids subdomaining, "0" otherwise.
38241 .vitem &%$dkim_key_srvtype%&
38242 Service type (tag s=) from the key record. Defaults to "*" if not specified
38243 in the key record.
38244 .vitem &%$dkim_key_granularity%&
38245 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38246 in the key record.
38247 .vitem &%$dkim_key_notes%&
38248 Notes from the key record (tag n=).
38249 .vitem &%$dkim_key_length%&
38250 Number of bits in the key.
38251 .endlist
38252
38253 In addition, two ACL conditions are provided:
38254
38255 .vlist
38256 .vitem &%dkim_signers%&
38257 ACL condition that checks a colon-separated list of domains or identities
38258 for a match against the domain or identity that the ACL is currently verifying
38259 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38260 verb to a group of domains or identities. For example:
38261
38262 .code
38263 # Warn when Mail purportedly from GMail has no signature at all
38264 warn log_message = GMail sender without DKIM signature
38265      sender_domains = gmail.com
38266      dkim_signers = gmail.com
38267      dkim_status = none
38268 .endd
38269
38270 .vitem &%dkim_status%&
38271 ACL condition that checks a colon-separated list of possible DKIM verification
38272 results against the actual result of verification. This is typically used
38273 to restrict an ACL verb to a list of verification outcomes, for example:
38274
38275 .code
38276 deny message = Mail from Paypal with invalid/missing signature
38277      sender_domains = paypal.com:paypal.de
38278      dkim_signers = paypal.com:paypal.de
38279      dkim_status = none:invalid:fail
38280 .endd
38281
38282 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38283 see the documentation of the &%$dkim_verify_status%& expansion variable above
38284 for more information of what they mean.
38285 .endlist
38286
38287 . ////////////////////////////////////////////////////////////////////////////
38288 . ////////////////////////////////////////////////////////////////////////////
38289
38290 .chapter "Proxies" "CHAPproxies" &&&
38291          "Proxy support"
38292 .cindex "proxy support"
38293 .cindex "proxy" "access via"
38294
38295 A proxy is an intermediate system through which communication is passed.
38296 Proxies may provide a security, availability or load-distribution function.
38297
38298
38299 .section "Inbound proxies" SECTproxyInbound
38300 .cindex proxy inbound
38301 .cindex proxy "server side"
38302 .cindex proxy "Proxy protocol"
38303 .cindex "Proxy protocol" proxy
38304
38305 Exim has support for receiving inbound SMTP connections via a proxy
38306 that uses &"Proxy Protocol"& to speak to it.
38307 To include this support, include &"SUPPORT_PROXY=yes"&
38308 in Local/Makefile.
38309
38310 It was built on specifications from:
38311 http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
38312 That URL was revised in May 2014 to version 2 spec:
38313 http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e
38314
38315 The purpose of this facility is so that an application load balancer,
38316 such as HAProxy, can sit in front of several Exim servers
38317 to distribute load.
38318 Exim uses the local protocol communication with the proxy to obtain
38319 the remote SMTP system IP address and port information.
38320 There is no logging if a host passes or
38321 fails Proxy Protocol negotiation, but it can easily be determined and
38322 recorded in an ACL (example is below).
38323
38324 Use of a proxy is enabled by setting the &%hosts_proxy%&
38325 main configuration option to a hostlist; connections from these
38326 hosts will use Proxy Protocol.
38327
38328 .new
38329 The following expansion variables are usable
38330 (&"internal"& and &"external"& here refer to the interfaces
38331 of the proxy):
38332 .display
38333 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38334 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38335 &'proxy_local_address '& IP of proxy server inbound or IP of local interface of proxy
38336 &'proxy_local_port    '& Port of proxy server inbound or Port on local interface of proxy
38337 &'proxy_session        '& boolean: SMTP connection via proxy
38338 .endd
38339 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38340 there was a protocol error.
38341 .wen
38342
38343 Since the real connections are all coming from the proxy, and the
38344 per host connection tracking is done before Proxy Protocol is
38345 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38346 handle all of the parallel volume you expect per inbound proxy.
38347 With the option set so high, you lose the ability
38348 to protect your server from many connections from one IP.
38349 In order to prevent your server from overload, you
38350 need to add a per connection ratelimit to your connect ACL.
38351 A possible solution is:
38352 .display
38353   # Set max number of connections per host
38354   LIMIT   = 5
38355   # Or do some kind of IP lookup in a flat file or database
38356   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38357
38358   defer   message        = Too many connections from this IP right now
38359           ratelimit      = LIMIT / 5s / per_conn / strict
38360 .endd
38361
38362
38363
38364 .section "Outbound proxies" SECTproxySOCKS
38365 .cindex proxy outbound
38366 .cindex proxy "client side"
38367 .cindex proxy SOCKS
38368 .cindex SOCKS proxy
38369 Exim has support for sending outbound SMTP via a proxy
38370 using a protocol called SOCKS5 (defined by RFC1928).
38371 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38372 Local/Makefile.
38373
38374 Use of a proxy is enabled by setting the &%socks_proxy%& option
38375 on an smtp transport.
38376 The option value is expanded and should then be a list
38377 (colon-separated by default) of proxy specifiers.
38378 Each proxy specifier is a list
38379 (space-separated by default) where the initial element
38380 is an IP address and any subsequent elements are options.
38381
38382 Options are a string <name>=<value>.
38383 The list of options is in the following table:
38384 .display
38385 &'auth   '& authentication method
38386 &'name   '& authentication username
38387 &'pass   '& authentication password
38388 &'port   '& tcp port
38389 &'tmo    '& connection timeout
38390 &'pri    '& priority
38391 &'weight '& selection bias
38392 .endd
38393
38394 More details on each of these options follows:
38395
38396 .ilist
38397 .cindex authentication "to proxy"
38398 .cindex proxy authentication
38399 &%auth%&: Either &"none"& (default) or &"name"&.
38400 Using &"name"& selects username/password authentication per RFC 1929
38401 for access to the proxy.
38402 Default is &"none"&.
38403 .next
38404 &%name%&: sets the username for the &"name"& authentication method.
38405 Default is empty.
38406 .next
38407 &%pass%&: sets the password for the &"name"& authentication method.
38408 Default is empty.
38409 .next
38410 &%port%&: the TCP port number to use for the connection to the proxy.
38411 Default is 1080.
38412 .next
38413 &%tmo%&: sets a connection timeout in seconds for this proxy.
38414 Default is 5.
38415 .next
38416 &%pri%&: specifies a priority for the proxy within the list,
38417 higher values being tried first.
38418 The default priority is 1.
38419 .next
38420 &%weight%&: specifies a selection bias.
38421 Within a priority set servers are queried in a random fashion,
38422 weighted by this value.
38423 The default value for selection bias is 1.
38424 .endlist
38425
38426 Proxies from the list are tried according to their priority
38427 and weight settings until one responds.  The timeout for the
38428 overall connection applies to the set of proxied attempts.
38429
38430 .section Logging SECTproxyLog
38431 To log the (local) IP of a proxy in the incoming or delivery logline,
38432 add &"+proxy"& to the &%log_selector%& option.
38433 This will add a component tagged with &"PRX="& to the line.
38434
38435 . ////////////////////////////////////////////////////////////////////////////
38436 . ////////////////////////////////////////////////////////////////////////////
38437
38438 .chapter "Internationalisation" "CHAPi18n" &&&
38439          "Internationalisation""
38440 .cindex internationalisation "email address"
38441 .cindex EAI
38442 .cindex i18n
38443 .cindex UTF-8 "mail name handling"
38444
38445 Exim has support for Internationalised mail names.
38446 To include this it must be built with SUPPORT_I18N and the libidn library.
38447 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38448
38449 .section "MTA operations" SECTi18nMTA
38450 .cindex SMTPUTF8 "ESMTP option"
38451 The main configuration option &%smtputf8_advertise_hosts%& specifies
38452 a host list.  If this matches the sending host and
38453 accept_8bitmime is true (the default) then the ESMTP option
38454 SMTPUTF8 will be advertised.
38455
38456 If the sender specifies the SMTPUTF8 option on a MAIL command
38457 international handling for the message is enabled and
38458 the expansion variable &$message_smtputf8$& will have value TRUE.
38459
38460 The option &%allow_utf8_domains%& is set to true for this
38461 message. All DNS lookups are converted to a-label form
38462 whatever the setting of &%allow_utf8_domains%&
38463 when Exim is built with SUPPORT_I18N.
38464
38465 Both localparts and domain are maintained as the original
38466 UTF-8 form internally; any comparison or regular-expression use will
38467 require appropriate care.  Filenames created, eg. by
38468 the appendfile transport, will have UTF-8 names.
38469
38470 HELO names sent by the smtp transport will have any UTF-8
38471 components expanded to a-label form,
38472 and any certificate name checks will be done using the a-label
38473 form of the name.
38474
38475 .cindex log protocol
38476 .cindex SMTPUTF8 logging
38477 Log lines and Received-by: header lines will acquire a "utf8"
38478 prefix on the protocol element, eg. utf8esmtp.
38479
38480 The following expansion operators can be used:
38481 .code
38482 ${utf8_domain_to_alabel:str}
38483 ${utf8_domain_from_alabel:str}
38484 ${utf8_localpart_to_alabel:str}
38485 ${utf8_localpart_from_alabel:str}
38486 .endd
38487
38488 ACLs may use the following modifier:
38489 .display
38490 control = utf8_downconvert
38491 control = utf8_downconvert/<value>
38492 .endd
38493 This sets a flag requiring that addresses are converted to
38494 a-label form before smtp delivery, for use in a
38495 Message Submission Agent context.
38496 If a value is appended it may be:
38497 .display
38498 &`1  `& (default) mandatory downconversion
38499 &`0  `& no downconversion
38500 &`-1 `& if SMTPUTF8 not supported by destination host
38501 .endd
38502
38503 If mua_wrapper is set, the utf8_downconvert control
38504 is initially set to -1.
38505
38506
38507 There is no explicit support for VRFY and EXPN.
38508 Configurations supporting these should inspect
38509 &$smtp_command_argument$& for an SMTPUTF8 argument.
38510
38511 There is no support for LMTP on Unix sockets.
38512 Using the "lmtp" protocol option on an smtp transport,
38513 for LMTP over TCP, should work as expected.
38514
38515 There is no support for DSN unitext handling,
38516 and no provision for converting logging from or to UTF-8.
38517
38518
38519
38520 .section "MDA operations" SECTi18nMDA
38521 To aid in constructing names suitable for IMAP folders
38522 the following expansion operator can be used:
38523 .code
38524 ${imapfolder {<string>} {<sep>} {<specials>}}
38525 .endd
38526
38527 The string is converted from the charset specified by
38528 the "headers charset" command (in a filter file)
38529 or &%headers_charset%& main configuration option (otherwise),
38530 to the
38531 modified UTF-7 encoding specified by RFC 2060,
38532 with the following exception: All occurences of <sep>
38533 (which has to be a single character)
38534 are replaced with periods ("."), and all periods and slashes that are not
38535 <sep> and are not in the <specials> string are BASE64 encoded.
38536
38537 The third argument can be omitted, defaulting to an empty string.
38538 The second argument can be omitted, defaulting to "/".
38539
38540 This is the encoding used by Courier for Maildir names on disk, and followed
38541 by many other IMAP servers.
38542
38543 Examples:
38544 .display
38545 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38546 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38547 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38548 .endd
38549
38550 Note that the source charset setting is vital, and also that characters
38551 must be representable in UTF-16.
38552
38553
38554 . ////////////////////////////////////////////////////////////////////////////
38555 . ////////////////////////////////////////////////////////////////////////////
38556
38557 .chapter "Events" "CHAPevents" &&&
38558          "Events"
38559 .cindex events
38560
38561 The events mechanism in Exim can be used to intercept processing at a number
38562 of points.  It was originally invented to giave a way to do customised logging
38563 actions (for example, to a database) but can also be used to modify some
38564 processing actions.
38565
38566 Most installations will never need to use Events.
38567 The support can be left out of a build by defining DISABLE_EVENT=yes
38568 in &_Local/Makefile_&.
38569
38570 There are two major classes of events: main and transport.
38571 The main configuration option &%event_action%& controls reception events;
38572 a transport option &%event_action%& controls delivery events.
38573
38574 Both options are a string which is expanded when the event fires.
38575 An example might look like:
38576 .cindex logging custom
38577 .code
38578 event_action = ${if eq {msg:delivery}{$event_name} \
38579 {${lookup pgsql {SELECT * FROM record_Delivery( \
38580     '${quote_pgsql:$sender_address_domain}',\
38581     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38582     '${quote_pgsql:$domain}', \
38583     '${quote_pgsql:${lc:$local_part}}', \
38584     '${quote_pgsql:$host_address}', \
38585     '${quote_pgsql:${lc:$host}}', \
38586     '${quote_pgsql:$message_exim_id}')}} \
38587 } {}}
38588 .endd
38589
38590 Events have names which correspond to the point in process at which they fire.
38591 The name is placed in the variable &$event_name$& and the event action
38592 expansion must check this, as it will be called for every possible event type.
38593
38594 The current list of events is:
38595 .display
38596 &`msg:complete           after    main       `& per message
38597 &`msg:delivery           after    transport  `& per recipient
38598 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38599 &`msg:rcpt:defer         after    transport  `& per recipient
38600 &`msg:host:defer         after    transport  `& per attempt
38601 &`msg:fail:delivery      after    main       `& per recipient
38602 &`msg:fail:internal      after    main       `& per recipient
38603 &`tcp:connect            before   transport  `& per connection
38604 &`tcp:close              after    transport  `& per connection
38605 &`tls:cert               before   both       `& per certificate in verification chain
38606 &`smtp:connect           after    transport  `& per connection
38607 .endd
38608 New event types may be added in future.
38609
38610 The event name is a colon-separated list, defining the type of
38611 event in a tree of possibilities.  It may be used as a list
38612 or just matched on as a whole.  There will be no spaces in the name.
38613
38614 The second column in the table above describes whether the event fires
38615 before or after the action is associates with.  Those which fire before
38616 can be used to affect that action (more on this below).
38617
38618 An additional variable, &$event_data$&, is filled with information varying
38619 with the event type:
38620 .display
38621 &`msg:delivery         `& smtp confirmation mssage
38622 &`msg:rcpt:host:defer  `& error string
38623 &`msg:rcpt:defer       `& error string
38624 &`msg:host:defer       `& error string
38625 &`tls:cert             `& verification chain depth
38626 &`smtp:connect         `& smtp banner
38627 .endd
38628
38629 The :defer events populate one extra variable: &$event_defer_errno$&.
38630
38631 For complex operations an ACL expansion can be used in &%event_action%&
38632 however due to the multiple contextx that Exim operates in during
38633 the course of its processing:
38634 .ilist
38635 variables set in transport events will not be visible outside that
38636 transport call
38637 .next
38638 acl_m variables in a server context are lost on a new connection,
38639 and after smtp helo/ehlo/mail/starttls/rset commands
38640 .endlist
38641 Using an ACL expansion with the logwrite modifier can be
38642 a useful way of writing to the main log.
38643
38644 The expansion of the event_action option should normally
38645 return an empty string.  Should it return anything else the
38646 following will be forced:
38647 .display
38648 &`msg:delivery     `&  (ignored)
38649 &`msg:host:defer   `&  (ignored)
38650 &`msg:fail:delivery`&  (ignored)
38651 &`tcp:connect      `&  do not connect
38652 &`tcp:close        `&  (ignored)
38653 &`tls:cert         `&  refuse verification
38654 &`smtp:connect     `&  close connection
38655 .endd
38656 No other use is made of the result string.
38657
38658 For a tcp:connect event, if the connection is being made to a proxy
38659 then the address and port variables will be that of the proxy and not
38660 the target system.
38661
38662 For tls:cert events, if GnuTLS is in use this will trigger only per
38663 chain element received on the connection.
38664 For OpenSSL it will trigger for every chain element including those
38665 loaded locally.
38666
38667 . ////////////////////////////////////////////////////////////////////////////
38668 . ////////////////////////////////////////////////////////////////////////////
38669
38670 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38671          "Adding drivers or lookups"
38672 .cindex "adding drivers"
38673 .cindex "new drivers, adding"
38674 .cindex "drivers" "adding new"
38675 The following actions have to be taken in order to add a new router, transport,
38676 authenticator, or lookup type to Exim:
38677
38678 .olist
38679 Choose a name for the driver or lookup type that does not conflict with any
38680 existing name; I will use &"newdriver"& in what follows.
38681 .next
38682 Add to &_src/EDITME_& the line:
38683 .display
38684 <&'type'&>&`_NEWDRIVER=yes`&
38685 .endd
38686 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38687 code is not to be included in the binary by default, comment this line out. You
38688 should also add any relevant comments about the driver or lookup type.
38689 .next
38690 Add to &_src/config.h.defaults_& the line:
38691 .code
38692 #define <type>_NEWDRIVER
38693 .endd
38694 .next
38695 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
38696 and create a table entry as is done for all the other drivers and lookup types.
38697 .next
38698 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
38699 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
38700 Add your &`NEWDRIVER`& to that list.
38701 As long as the dynamic module would be named &_newdriver.so_&, you can use the
38702 simple form that most lookups have.
38703 .next
38704 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
38705 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
38706 driver or lookup type and add it to the definition of OBJ.
38707 .next
38708 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
38709 &_src_&.
38710 .next
38711 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
38712 as for other drivers and lookups.
38713 .endlist
38714
38715 Then all you need to do is write the code! A good way to start is to make a
38716 proforma by copying an existing module of the same type, globally changing all
38717 occurrences of the name, and cutting out most of the code. Note that any
38718 options you create must be listed in alphabetical order, because the tables are
38719 searched using a binary chop procedure.
38720
38721 There is a &_README_& file in each of the sub-directories of &_src_& describing
38722 the interface that is expected.
38723
38724
38725
38726
38727 . ////////////////////////////////////////////////////////////////////////////
38728 . ////////////////////////////////////////////////////////////////////////////
38729
38730 . /////////////////////////////////////////////////////////////////////////////
38731 . These lines are processing instructions for the Simple DocBook Processor that
38732 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38733 . PDFs than using xmlto and fop. They will be ignored by all other XML
38734 . processors.
38735 . /////////////////////////////////////////////////////////////////////////////
38736
38737 .literal xml
38738 <?sdop
38739   format="newpage"
38740   foot_right_recto="&chaptertitle;"
38741   foot_right_verso="&chaptertitle;"
38742 ?>
38743 .literal off
38744
38745 .makeindex "Options index"   "option"
38746 .makeindex "Variables index" "variable"
38747 .makeindex "Concept index"   "concept"
38748
38749
38750 . /////////////////////////////////////////////////////////////////////////////
38751 . /////////////////////////////////////////////////////////////////////////////