fix docs
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.83"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2014
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .endtable
440
441 The main specification and the specification of the filtering language are also
442 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
443 &<<SECTavail>>& below tells you how to get hold of these.
444
445
446
447 .section "FTP and web sites" "SECID2"
448 .cindex "web site"
449 .cindex "FTP site"
450 The primary site for Exim source distributions is currently the University of
451 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
452 distribution'& below. In addition, there is a web site and an FTP site at
453 &%exim.org%&. These are now also hosted at the University of Cambridge. The
454 &%exim.org%& site was previously hosted for a number of years by Energis
455 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
456
457 .cindex "wiki"
458 .cindex "FAQ"
459 As well as Exim distribution tar files, the Exim web site contains a number of
460 differently formatted versions of the documentation. A recent addition to the
461 online information is the Exim wiki (&url(http://wiki.exim.org)),
462 which contains what used to be a separate FAQ, as well as various other
463 examples, tips, and know-how that have been contributed by Exim users.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on this list and not on the general Exim
493 lists.
494
495 .section "Exim training" "SECID4"
496 .cindex "training courses"
497 Training courses in Cambridge (UK) used to be run annually by the author of
498 Exim, before he retired. At the time of writing, there are no plans to run
499 further Exim courses in Cambridge. However, if that changes, relevant
500 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
501
502 .section "Bug reports" "SECID5"
503 .cindex "bug reports"
504 .cindex "reporting bugs"
505 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
506 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
507 whether some behaviour is a bug or not, the best thing to do is to post a
508 message to the &'exim-dev'& mailing list and have it discussed.
509
510
511
512 .section "Where to find the Exim distribution" "SECTavail"
513 .cindex "FTP site"
514 .cindex "distribution" "ftp site"
515 The master ftp site for the Exim distribution is
516 .display
517 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
518 .endd
519 This is mirrored by
520 .display
521 &*ftp://ftp.exim.org/pub/exim*&
522 .endd
523 The file references that follow are relative to the &_exim_& directories at
524 these sites. There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.gz_&
533 &_exim-n.nn.tar.bz2_&
534 .endd
535 where &'n.nn'& is the highest such version number in the directory. The two
536 files contain identical data; the only difference is the type of compression.
537 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
538
539 .cindex "distribution" "signing details"
540 .cindex "distribution" "public key"
541 .cindex "public key for signed distribution"
542 The distributions will be PGP signed by an individual key of the Release
543 Coordinator.  This key will have a uid containing an email address in the
544 &'exim.org'& domain and will have signatures from other people, including
545 other Exim maintainers.  We expect that the key will be in the "strong set" of
546 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
547 PGP key, a version of which can be found in the release directory in the file
548 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
549 such as &'pool.sks-keyservers.net'&.
550
551 At time of last update, releases were being made by Phil Pennock and signed with
552 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
553 A trust path from Nigel's key to Phil's can be observed at
554 &url(https://www.security.spodhuis.org/exim-trustpath).
555
556 Releases have also been authorized to be performed by Todd Lyons who signs with
557 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
558 Pennock and Todd Lyons through a common associate.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.gz.asc_&
563 &_exim-n.nn.tar.bz2.asc_&
564 .endd
565 For each released version, the log of changes is made separately available in a
566 separate file in the directory &_ChangeLogs_& so that it is possible to
567 find out what has changed without having to download the entire distribution.
568
569 .cindex "documentation" "available formats"
570 The main distribution contains ASCII versions of this specification and other
571 documentation; other formats of the documents are available in separate files
572 inside the &_exim4_& directory of the FTP site:
573 .display
574 &_exim-html-n.nn.tar.gz_&
575 &_exim-pdf-n.nn.tar.gz_&
576 &_exim-postscript-n.nn.tar.gz_&
577 &_exim-texinfo-n.nn.tar.gz_&
578 .endd
579 These tar files contain only the &_doc_& directory, not the complete
580 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
581
582
583 .section "Limitations" "SECID6"
584 .ilist
585 .cindex "limitations of Exim"
586 .cindex "bang paths" "not handled by Exim"
587 Exim is designed for use as an Internet MTA, and therefore handles addresses in
588 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
589 simple two-component bang paths can be converted by a straightforward rewriting
590 configuration. This restriction does not prevent Exim from being interfaced to
591 UUCP as a transport mechanism, provided that domain addresses are used.
592 .next
593 .cindex "domainless addresses"
594 .cindex "address" "without domain"
595 Exim insists that every address it handles has a domain attached. For incoming
596 local messages, domainless addresses are automatically qualified with a
597 configured domain value. Configuration options specify from which remote
598 systems unqualified addresses are acceptable. These are then qualified on
599 arrival.
600 .next
601 .cindex "transport" "external"
602 .cindex "external transports"
603 The only external transport mechanisms that are currently implemented are SMTP
604 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
605 transport is available, and there are facilities for writing messages to files
606 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
607 to send messages to other transport mechanisms such as UUCP, provided they can
608 handle domain-style addresses. Batched SMTP input is also catered for.
609 .next
610 Exim is not designed for storing mail for dial-in hosts. When the volumes of
611 such mail are large, it is better to get the messages &"delivered"& into files
612 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
613 other means.
614 .next
615 Although Exim does have basic facilities for scanning incoming messages, these
616 are not comprehensive enough to do full virus or spam scanning. Such operations
617 are best carried out using additional specialized software packages. If you
618 compile Exim with the content-scanning extension, straightforward interfaces to
619 a number of common scanners are provided.
620 .endlist
621
622
623 .section "Run time configuration" "SECID7"
624 Exim's run time configuration is held in a single text file that is divided
625 into a number of sections. The entries in this file consist of keywords and
626 values, in the style of Smail 3 configuration files. A default configuration
627 file which is suitable for simple online installations is provided in the
628 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
629
630
631 .section "Calling interface" "SECID8"
632 .cindex "Sendmail compatibility" "command line interface"
633 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
634 can be a straight replacement for &_/usr/lib/sendmail_& or
635 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
636 about Sendmail in order to run Exim. For actions other than sending messages,
637 Sendmail-compatible options also exist, but those that produce output (for
638 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
639 format. There are also some additional options that are compatible with Smail
640 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
641 documents all Exim's command line options. This information is automatically
642 made into the man page that forms part of the Exim distribution.
643
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called &'eximon'&,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim's command line administration options.
648
649
650
651 .section "Terminology" "SECID9"
652 .cindex "terminology definitions"
653 .cindex "body of message" "definition of"
654 The &'body'& of a message is the actual data that the sender wants to transmit.
655 It is the last part of a message, and is separated from the &'header'& (see
656 below) by a blank line.
657
658 .cindex "bounce message" "definition of"
659 When a message cannot be delivered, it is normally returned to the sender in a
660 delivery failure message or a &"non-delivery report"& (NDR). The term
661 &'bounce'& is commonly used for this action, and the error reports are often
662 called &'bounce messages'&. This is a convenient shorthand for &"delivery
663 failure error report"&. Such messages have an empty sender address in the
664 message's &'envelope'& (see below) to ensure that they cannot themselves give
665 rise to further bounce messages.
666
667 The term &'default'& appears frequently in this manual. It is used to qualify a
668 value which is used in the absence of any setting in the configuration. It may
669 also qualify an action which is taken unless a configuration setting specifies
670 otherwise.
671
672 The term &'defer'& is used when the delivery of a message to a specific
673 destination cannot immediately take place for some reason (a remote host may be
674 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
675 until a later time.
676
677 The word &'domain'& is sometimes used to mean all but the first component of a
678 host's name. It is &'not'& used in that sense here, where it normally refers to
679 the part of an email address following the @ sign.
680
681 .cindex "envelope, definition of"
682 .cindex "sender" "definition of"
683 A message in transit has an associated &'envelope'&, as well as a header and a
684 body. The envelope contains a sender address (to which bounce messages should
685 be delivered), and any number of recipient addresses. References to the
686 sender or the recipients of a message usually mean the addresses in the
687 envelope. An MTA uses these addresses for delivery, and for returning bounce
688 messages, not the addresses that appear in the header lines.
689
690 .cindex "message" "header, definition of"
691 .cindex "header section" "definition of"
692 The &'header'& of a message is the first part of a message's text, consisting
693 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
694 &'Subject:'&, etc. Long header lines can be split over several text lines by
695 indenting the continuations. The header is separated from the body by a blank
696 line.
697
698 .cindex "local part" "definition of"
699 .cindex "domain" "definition of"
700 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
701 part of an email address that precedes the @ sign. The part that follows the
702 @ sign is called the &'domain'& or &'mail domain'&.
703
704 .cindex "local delivery" "definition of"
705 .cindex "remote delivery, definition of"
706 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
707 delivery to a file or a pipe on the local host from delivery by SMTP over
708 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
709 host it is running on are &'remote'&.
710
711 .cindex "return path" "definition of"
712 &'Return path'& is another name that is used for the sender address in a
713 message's envelope.
714
715 .cindex "queue" "definition of"
716 The term &'queue'& is used to refer to the set of messages awaiting delivery,
717 because this term is in widespread use in the context of MTAs. However, in
718 Exim's case the reality is more like a pool than a queue, because there is
719 normally no ordering of waiting messages.
720
721 .cindex "queue runner" "definition of"
722 The term &'queue runner'& is used to describe a process that scans the queue
723 and attempts to deliver those messages whose retry times have come. This term
724 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
725 the waiting messages are normally processed in an unpredictable order.
726
727 .cindex "spool directory" "definition of"
728 The term &'spool directory'& is used for a directory in which Exim keeps the
729 messages on its queue &-- that is, those that it is in the process of
730 delivering. This should not be confused with the directory in which local
731 mailboxes are stored, which is called a &"spool directory"& by some people. In
732 the Exim documentation, &"spool"& is always used in the first sense.
733
734
735
736
737
738
739 . ////////////////////////////////////////////////////////////////////////////
740 . ////////////////////////////////////////////////////////////////////////////
741
742 .chapter "Incorporated code" "CHID2"
743 .cindex "incorporated code"
744 .cindex "regular expressions" "library"
745 .cindex "PCRE"
746 .cindex "OpenDMARC"
747 A number of pieces of external code are included in the Exim distribution.
748
749 .ilist
750 Regular expressions are supported in the main Exim program and in the
751 Exim monitor using the freely-distributable PCRE library, copyright
752 &copy; University of Cambridge. The source to PCRE is no longer shipped with
753 Exim, so you will need to use the version of PCRE shipped with your system,
754 or obtain and install the full version of the library from
755 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
756 .next
757 .cindex "cdb" "acknowledgment"
758 Support for the cdb (Constant DataBase) lookup method is provided by code
759 contributed by Nigel Metheringham of (at the time he contributed it) Planet
760 Online Ltd. The implementation is completely contained within the code of Exim.
761 It does not link against an external cdb library. The code contains the
762 following statements:
763
764 .blockquote
765 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
766
767 This program is free software; you can redistribute it and/or modify it under
768 the terms of the GNU General Public License as published by the Free Software
769 Foundation; either version 2 of the License, or (at your option) any later
770 version.
771 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
772 the spec and sample code for cdb can be obtained from
773 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
774 some code from Dan Bernstein's implementation (which has no license
775 restrictions applied to it).
776 .endblockquote
777 .next
778 .cindex "SPA authentication"
779 .cindex "Samba project"
780 .cindex "Microsoft Secure Password Authentication"
781 Client support for Microsoft's &'Secure Password Authentication'& is provided
782 by code contributed by Marc Prud'hommeaux. Server support was contributed by
783 Tom Kistner. This includes code taken from the Samba project, which is released
784 under the Gnu GPL.
785 .next
786 .cindex "Cyrus"
787 .cindex "&'pwcheck'& daemon"
788 .cindex "&'pwauthd'& daemon"
789 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
790 by code taken from the Cyrus-SASL library and adapted by Alexander S.
791 Sabourenkov. The permission notice appears below, in accordance with the
792 conditions expressed therein.
793
794 .blockquote
795 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
796
797 Redistribution and use in source and binary forms, with or without
798 modification, are permitted provided that the following conditions
799 are met:
800
801 .olist
802 Redistributions of source code must retain the above copyright
803 notice, this list of conditions and the following disclaimer.
804 .next
805 Redistributions in binary form must reproduce the above copyright
806 notice, this list of conditions and the following disclaimer in
807 the documentation and/or other materials provided with the
808 distribution.
809 .next
810 The name &"Carnegie Mellon University"& must not be used to
811 endorse or promote products derived from this software without
812 prior written permission. For permission or any other legal
813 details, please contact
814 .display
815               Office of Technology Transfer
816               Carnegie Mellon University
817               5000 Forbes Avenue
818               Pittsburgh, PA  15213-3890
819               (412) 268-4387, fax: (412) 268-7395
820               tech-transfer@andrew.cmu.edu
821 .endd
822 .next
823 Redistributions of any form whatsoever must retain the following
824 acknowledgment:
825
826 &"This product includes software developed by Computing Services
827 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
828
829 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
830 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
831 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
832 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
833 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
834 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
835 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
836 .endlist
837 .endblockquote
838
839 .next
840 .cindex "Exim monitor" "acknowledgment"
841 .cindex "X-windows"
842 .cindex "Athena"
843 The Exim Monitor program, which is an X-Window application, includes
844 modified versions of the Athena StripChart and TextPop widgets.
845 This code is copyright by DEC and MIT, and their permission notice appears
846 below, in accordance with the conditions expressed therein.
847
848 .blockquote
849 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
850 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
851
852 All Rights Reserved
853
854 Permission to use, copy, modify, and distribute this software and its
855 documentation for any purpose and without fee is hereby granted,
856 provided that the above copyright notice appear in all copies and that
857 both that copyright notice and this permission notice appear in
858 supporting documentation, and that the names of Digital or MIT not be
859 used in advertising or publicity pertaining to distribution of the
860 software without specific, written prior permission.
861
862 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
863 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
864 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
865 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
866 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
867 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
868 SOFTWARE.
869 .endblockquote
870
871 .next
872 .cindex "opendmarc" "acknowledgment"
873 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
874 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
875 derived code are indicated in the respective source files. The full OpenDMARC
876 license is provided in the LICENSE.opendmarc file contained in the distributed
877 source code.
878
879 .next
880 Many people have contributed code fragments, some large, some small, that were
881 not covered by any specific licence requirements. It is assumed that the
882 contributors are happy to see their code incorporated into Exim under the GPL.
883 .endlist
884
885
886
887
888
889 . ////////////////////////////////////////////////////////////////////////////
890 . ////////////////////////////////////////////////////////////////////////////
891
892 .chapter "How Exim receives and delivers mail" "CHID11" &&&
893          "Receiving and delivering mail"
894
895
896 .section "Overall philosophy" "SECID10"
897 .cindex "design philosophy"
898 Exim is designed to work efficiently on systems that are permanently connected
899 to the Internet and are handling a general mix of mail. In such circumstances,
900 most messages can be delivered immediately. Consequently, Exim does not
901 maintain independent queues of messages for specific domains or hosts, though
902 it does try to send several messages in a single SMTP connection after a host
903 has been down, and it also maintains per-host retry information.
904
905
906 .section "Policy control" "SECID11"
907 .cindex "policy control" "overview"
908 Policy controls are now an important feature of MTAs that are connected to the
909 Internet. Perhaps their most important job is to stop MTAs being abused as
910 &"open relays"& by misguided individuals who send out vast amounts of
911 unsolicited junk, and want to disguise its source. Exim provides flexible
912 facilities for specifying policy controls on incoming mail:
913
914 .ilist
915 .cindex "&ACL;" "introduction"
916 Exim 4 (unlike previous versions of Exim) implements policy controls on
917 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
918 series of statements that may either grant or deny access. ACLs can be used at
919 several places in the SMTP dialogue while receiving a message from a remote
920 host. However, the most common places are after each RCPT command, and at the
921 very end of the message. The sysadmin can specify conditions for accepting or
922 rejecting individual recipients or the entire message, respectively, at these
923 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
924 error code.
925 .next
926 An ACL is also available for locally generated, non-SMTP messages. In this
927 case, the only available actions are to accept or deny the entire message.
928 .next
929 When Exim is compiled with the content-scanning extension, facilities are
930 provided in the ACL mechanism for passing the message to external virus and/or
931 spam scanning software. The result of such a scan is passed back to the ACL,
932 which can then use it to decide what to do with the message.
933 .next
934 When a message has been received, either from a remote host or from the local
935 host, but before the final acknowledgment has been sent, a locally supplied C
936 function called &[local_scan()]& can be run to inspect the message and decide
937 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
938 is accepted, the list of recipients can be modified by the function.
939 .next
940 Using the &[local_scan()]& mechanism is another way of calling external scanner
941 software. The &%SA-Exim%& add-on package works this way. It does not require
942 Exim to be compiled with the content-scanning extension.
943 .next
944 After a message has been accepted, a further checking mechanism is available in
945 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
946 runs at the start of every delivery process.
947 .endlist
948
949
950
951 .section "User filters" "SECID12"
952 .cindex "filter" "introduction"
953 .cindex "Sieve filter"
954 In a conventional Exim configuration, users are able to run private filters by
955 setting up appropriate &_.forward_& files in their home directories. See
956 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
957 configuration needed to support this, and the separate document entitled
958 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
959 of filtering are available:
960
961 .ilist
962 Sieve filters are written in the standard filtering language that is defined
963 by RFC 3028.
964 .next
965 Exim filters are written in a syntax that is unique to Exim, but which is more
966 powerful than Sieve, which it pre-dates.
967 .endlist
968
969 User filters are run as part of the routing process, described below.
970
971
972
973 .section "Message identification" "SECTmessiden"
974 .cindex "message ids" "details of format"
975 .cindex "format" "of message id"
976 .cindex "id of message"
977 .cindex "base62"
978 .cindex "base36"
979 .cindex "Darwin"
980 .cindex "Cygwin"
981 Every message handled by Exim is given a &'message id'& which is sixteen
982 characters long. It is divided into three parts, separated by hyphens, for
983 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
984 normally encoding numbers in base 62. However, in the Darwin operating
985 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
986 (avoiding the use of lower case letters) is used instead, because the message
987 id is used to construct file names, and the names of files in those systems are
988 not always case-sensitive.
989
990 .cindex "pid (process id)" "re-use of"
991 The detail of the contents of the message id have changed as Exim has evolved.
992 Earlier versions relied on the operating system not re-using a process id (pid)
993 within one second. On modern operating systems, this assumption can no longer
994 be made, so the algorithm had to be changed. To retain backward compatibility,
995 the format of the message id was retained, which is why the following rules are
996 somewhat eccentric:
997
998 .ilist
999 The first six characters of the message id are the time at which the message
1000 started to be received, to a granularity of one second. That is, this field
1001 contains the number of seconds since the start of the epoch (the normal Unix
1002 way of representing the date and time of day).
1003 .next
1004 After the first hyphen, the next six characters are the id of the process that
1005 received the message.
1006 .next
1007 There are two different possibilities for the final two characters:
1008 .olist
1009 .oindex "&%localhost_number%&"
1010 If &%localhost_number%& is not set, this value is the fractional part of the
1011 time of reception, normally in units of 1/2000 of a second, but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are 1/1000 of a second.
1014 .next
1015 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1016 the fractional part of the time, which in this case is in units of 1/200
1017 (1/100) of a second.
1018 .endlist
1019 .endlist
1020
1021 After a message has been received, Exim waits for the clock to tick at the
1022 appropriate resolution before proceeding, so that if another message is
1023 received by the same process, or by another process with the same (re-used)
1024 pid, it is guaranteed that the time will be different. In most cases, the clock
1025 will already have ticked while the message was being received.
1026
1027
1028 .section "Receiving mail" "SECID13"
1029 .cindex "receiving mail"
1030 .cindex "message" "reception"
1031 The only way Exim can receive mail from another host is using SMTP over
1032 TCP/IP, in which case the sender and recipient addresses are transferred using
1033 SMTP commands. However, from a locally running process (such as a user's MUA),
1034 there are several possibilities:
1035
1036 .ilist
1037 If the process runs Exim with the &%-bm%& option, the message is read
1038 non-interactively (usually via a pipe), with the recipients taken from the
1039 command line, or from the body of the message if &%-t%& is also used.
1040 .next
1041 If the process runs Exim with the &%-bS%& option, the message is also read
1042 non-interactively, but in this case the recipients are listed at the start of
1043 the message in a series of SMTP RCPT commands, terminated by a DATA
1044 command. This is so-called &"batch SMTP"& format,
1045 but it isn't really SMTP. The SMTP commands are just another way of passing
1046 envelope addresses in a non-interactive submission.
1047 .next
1048 If the process runs Exim with the &%-bs%& option, the message is read
1049 interactively, using the SMTP protocol. A two-way pipe is normally used for
1050 passing data between the local process and the Exim process.
1051 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1052 example, the ACLs for SMTP commands are used for this form of submission.
1053 .next
1054 A local process may also make a TCP/IP call to the host's loopback address
1055 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1056 does not treat the loopback address specially. It treats all such connections
1057 in the same way as connections from other hosts.
1058 .endlist
1059
1060
1061 .cindex "message sender, constructed by Exim"
1062 .cindex "sender" "constructed by Exim"
1063 In the three cases that do not involve TCP/IP, the sender address is
1064 constructed from the login name of the user that called Exim and a default
1065 qualification domain (which can be set by the &%qualify_domain%& configuration
1066 option). For local or batch SMTP, a sender address that is passed using the
1067 SMTP MAIL command is ignored. However, the system administrator may allow
1068 certain users (&"trusted users"&) to specify a different sender address
1069 unconditionally, or all users to specify certain forms of different sender
1070 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1071 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1072 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1073 users to change sender addresses.
1074
1075 Messages received by either of the non-interactive mechanisms are subject to
1076 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1077 (either over TCP/IP, or interacting with a local process) can be checked by a
1078 number of ACLs that operate at different times during the SMTP session. Either
1079 individual recipients, or the entire message, can be rejected if local policy
1080 requirements are not met. The &[local_scan()]& function (see chapter
1081 &<<CHAPlocalscan>>&) is run for all incoming messages.
1082
1083 Exim can be configured not to start a delivery process when a message is
1084 received; this can be unconditional, or depend on the number of incoming SMTP
1085 connections or the system load. In these situations, new messages wait on the
1086 queue until a queue runner process picks them up. However, in standard
1087 configurations under normal conditions, delivery is started as soon as a
1088 message is received.
1089
1090
1091
1092
1093
1094 .section "Handling an incoming message" "SECID14"
1095 .cindex "spool directory" "files that hold a message"
1096 .cindex "file" "how a message is held"
1097 When Exim accepts a message, it writes two files in its spool directory. The
1098 first contains the envelope information, the current status of the message, and
1099 the header lines, and the second contains the body of the message. The names of
1100 the two spool files consist of the message id, followed by &`-H`& for the
1101 file containing the envelope and header, and &`-D`& for the data file.
1102
1103 .cindex "spool directory" "&_input_& sub-directory"
1104 By default all these message files are held in a single directory called
1105 &_input_& inside the general Exim spool directory. Some operating systems do
1106 not perform very well if the number of files in a directory gets large; to
1107 improve performance in such cases, the &%split_spool_directory%& option can be
1108 used. This causes Exim to split up the input files into 62 sub-directories
1109 whose names are single letters or digits. When this is done, the queue is
1110 processed one sub-directory at a time instead of all at once, which can improve
1111 overall performance even when there are not enough files in each directory to
1112 affect file system performance.
1113
1114 The envelope information consists of the address of the message's sender and
1115 the addresses of the recipients. This information is entirely separate from
1116 any addresses contained in the header lines. The status of the message includes
1117 a list of recipients who have already received the message. The format of the
1118 first spool file is described in chapter &<<CHAPspool>>&.
1119
1120 .cindex "rewriting" "addresses"
1121 Address rewriting that is specified in the rewrite section of the configuration
1122 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1123 both in the header lines and the envelope, at the time the message is accepted.
1124 If during the course of delivery additional addresses are generated (for
1125 example, via aliasing), these new addresses are rewritten as soon as they are
1126 generated. At the time a message is actually delivered (transported) further
1127 rewriting can take place; because this is a transport option, it can be
1128 different for different forms of delivery. It is also possible to specify the
1129 addition or removal of certain header lines at the time the message is
1130 delivered (see chapters &<<CHAProutergeneric>>& and
1131 &<<CHAPtransportgeneric>>&).
1132
1133
1134
1135 .section "Life of a message" "SECID15"
1136 .cindex "message" "life of"
1137 .cindex "message" "frozen"
1138 A message remains in the spool directory until it is completely delivered to
1139 its recipients or to an error address, or until it is deleted by an
1140 administrator or by the user who originally created it. In cases when delivery
1141 cannot proceed &-- for example, when a message can neither be delivered to its
1142 recipients nor returned to its sender, the message is marked &"frozen"& on the
1143 spool, and no more deliveries are attempted.
1144
1145 .cindex "frozen messages" "thawing"
1146 .cindex "message" "thawing frozen"
1147 An administrator can &"thaw"& such messages when the problem has been
1148 corrected, and can also freeze individual messages by hand if necessary. In
1149 addition, an administrator can force a delivery error, causing a bounce message
1150 to be sent.
1151
1152 .oindex "&%timeout_frozen_after%&"
1153 .oindex "&%ignore_bounce_errors_after%&"
1154 There are options called &%ignore_bounce_errors_after%& and
1155 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1156 The first applies only to frozen bounces, the second to any frozen messages.
1157
1158 .cindex "message" "log file for"
1159 .cindex "log" "file for each message"
1160 While Exim is working on a message, it writes information about each delivery
1161 attempt to its main log file. This includes successful, unsuccessful, and
1162 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1163 lines are also written to a separate &'message log'& file for each message.
1164 These logs are solely for the benefit of the administrator, and are normally
1165 deleted along with the spool files when processing of a message is complete.
1166 The use of individual message logs can be disabled by setting
1167 &%no_message_logs%&; this might give an improvement in performance on very busy
1168 systems.
1169
1170 .cindex "journal file"
1171 .cindex "file" "journal"
1172 All the information Exim itself needs to set up a delivery is kept in the first
1173 spool file, along with the header lines. When a successful delivery occurs, the
1174 address is immediately written at the end of a journal file, whose name is the
1175 message id followed by &`-J`&. At the end of a delivery run, if there are some
1176 addresses left to be tried again later, the first spool file (the &`-H`& file)
1177 is updated to indicate which these are, and the journal file is then deleted.
1178 Updating the spool file is done by writing a new file and renaming it, to
1179 minimize the possibility of data loss.
1180
1181 Should the system or the program crash after a successful delivery but before
1182 the spool file has been updated, the journal is left lying around. The next
1183 time Exim attempts to deliver the message, it reads the journal file and
1184 updates the spool file before proceeding. This minimizes the chances of double
1185 deliveries caused by crashes.
1186
1187
1188
1189 .section "Processing an address for delivery" "SECTprocaddress"
1190 .cindex "drivers" "definition of"
1191 .cindex "router" "definition of"
1192 .cindex "transport" "definition of"
1193 The main delivery processing elements of Exim are called &'routers'& and
1194 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1195 number of them is provided in the source distribution, and compile-time options
1196 specify which ones are included in the binary. Run time options specify which
1197 ones are actually used for delivering messages.
1198
1199 .cindex "drivers" "instance definition"
1200 Each driver that is specified in the run time configuration is an &'instance'&
1201 of that particular driver type. Multiple instances are allowed; for example,
1202 you can set up several different &(smtp)& transports, each with different
1203 option values that might specify different ports or different timeouts. Each
1204 instance has its own identifying name. In what follows we will normally use the
1205 instance name when discussing one particular instance (that is, one specific
1206 configuration of the driver), and the generic driver name when discussing
1207 the driver's features in general.
1208
1209 A &'router'& is a driver that operates on an address, either determining how
1210 its delivery should happen, by assigning it to a specific transport, or
1211 converting the address into one or more new addresses (for example, via an
1212 alias file). A router may also explicitly choose to fail an address, causing it
1213 to be bounced.
1214
1215 A &'transport'& is a driver that transmits a copy of the message from Exim's
1216 spool to some destination. There are two kinds of transport: for a &'local'&
1217 transport, the destination is a file or a pipe on the local host, whereas for a
1218 &'remote'& transport the destination is some other host. A message is passed
1219 to a specific transport as a result of successful routing. If a message has
1220 several recipients, it may be passed to a number of different transports.
1221
1222 .cindex "preconditions" "definition of"
1223 An address is processed by passing it to each configured router instance in
1224 turn, subject to certain preconditions, until a router accepts the address or
1225 specifies that it should be bounced. We will describe this process in more
1226 detail shortly. First, as a simple example, we consider how each recipient
1227 address in a message is processed in a small configuration of three routers.
1228
1229 To make this a more concrete example, it is described in terms of some actual
1230 routers, but remember, this is only an example. You can configure Exim's
1231 routers in many different ways, and there may be any number of routers in a
1232 configuration.
1233
1234 The first router that is specified in a configuration is often one that handles
1235 addresses in domains that are not recognized specially by the local host. These
1236 are typically addresses for arbitrary domains on the Internet. A precondition
1237 is set up which looks for the special domains known to the host (for example,
1238 its own domain name), and the router is run for addresses that do &'not'&
1239 match. Typically, this is a router that looks up domains in the DNS in order to
1240 find the hosts to which this address routes. If it succeeds, the address is
1241 assigned to a suitable SMTP transport; if it does not succeed, the router is
1242 configured to fail the address.
1243
1244 The second router is reached only when the domain is recognized as one that
1245 &"belongs"& to the local host. This router does redirection &-- also known as
1246 aliasing and forwarding. When it generates one or more new addresses from the
1247 original, each of them is routed independently from the start. Otherwise, the
1248 router may cause an address to fail, or it may simply decline to handle the
1249 address, in which case the address is passed to the next router.
1250
1251 The final router in many configurations is one that checks to see if the
1252 address belongs to a local mailbox. The precondition may involve a check to
1253 see if the local part is the name of a login account, or it may look up the
1254 local part in a file or a database. If its preconditions are not met, or if
1255 the router declines, we have reached the end of the routers. When this happens,
1256 the address is bounced.
1257
1258
1259
1260 .section "Processing an address for verification" "SECID16"
1261 .cindex "router" "for verification"
1262 .cindex "verifying address" "overview"
1263 As well as being used to decide how to deliver to an address, Exim's routers
1264 are also used for &'address verification'&. Verification can be requested as
1265 one of the checks to be performed in an ACL for incoming messages, on both
1266 sender and recipient addresses, and it can be tested using the &%-bv%& and
1267 &%-bvs%& command line options.
1268
1269 When an address is being verified, the routers are run in &"verify mode"&. This
1270 does not affect the way the routers work, but it is a state that can be
1271 detected. By this means, a router can be skipped or made to behave differently
1272 when verifying. A common example is a configuration in which the first router
1273 sends all messages to a message-scanning program, unless they have been
1274 previously scanned. Thus, the first router accepts all addresses without any
1275 checking, making it useless for verifying. Normally, the &%no_verify%& option
1276 would be set for such a router, causing it to be skipped in verify mode.
1277
1278
1279
1280
1281 .section "Running an individual router" "SECTrunindrou"
1282 .cindex "router" "running details"
1283 .cindex "preconditions" "checking"
1284 .cindex "router" "result of running"
1285 As explained in the example above, a number of preconditions are checked before
1286 running a router. If any are not met, the router is skipped, and the address is
1287 passed to the next router. When all the preconditions on a router &'are'& met,
1288 the router is run. What happens next depends on the outcome, which is one of
1289 the following:
1290
1291 .ilist
1292 &'accept'&: The router accepts the address, and either assigns it to a
1293 transport, or generates one or more &"child"& addresses. Processing the
1294 original address ceases,
1295 .oindex "&%unseen%&"
1296 unless the &%unseen%& option is set on the router. This option
1297 can be used to set up multiple deliveries with different routing (for example,
1298 for keeping archive copies of messages). When &%unseen%& is set, the address is
1299 passed to the next router. Normally, however, an &'accept'& return marks the
1300 end of routing.
1301
1302 Any child addresses generated by the router are processed independently,
1303 starting with the first router by default. It is possible to change this by
1304 setting the &%redirect_router%& option to specify which router to start at for
1305 child addresses. Unlike &%pass_router%& (see below) the router specified by
1306 &%redirect_router%& may be anywhere in the router configuration.
1307 .next
1308 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1309 requests that the address be passed to another router. By default the address
1310 is passed to the next router, but this can be changed by setting the
1311 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1312 must be below the current router (to avoid loops).
1313 .next
1314 &'decline'&: The router declines to accept the address because it does not
1315 recognize it at all. By default, the address is passed to the next router, but
1316 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1317 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1318 &'decline'& into &'fail'&.
1319 .next
1320 &'fail'&: The router determines that the address should fail, and queues it for
1321 the generation of a bounce message. There is no further processing of the
1322 original address unless &%unseen%& is set on the router.
1323 .next
1324 &'defer'&: The router cannot handle the address at the present time. (A
1325 database may be offline, or a DNS lookup may have timed out.) No further
1326 processing of the address happens in this delivery attempt. It is tried again
1327 next time the message is considered for delivery.
1328 .next
1329 &'error'&: There is some error in the router (for example, a syntax error in
1330 its configuration). The action is as for defer.
1331 .endlist
1332
1333 If an address reaches the end of the routers without having been accepted by
1334 any of them, it is bounced as unrouteable. The default error message in this
1335 situation is &"unrouteable address"&, but you can set your own message by
1336 making use of the &%cannot_route_message%& option. This can be set for any
1337 router; the value from the last router that &"saw"& the address is used.
1338
1339 Sometimes while routing you want to fail a delivery when some conditions are
1340 met but others are not, instead of passing the address on for further routing.
1341 You can do this by having a second router that explicitly fails the delivery
1342 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1343 facility for this purpose.
1344
1345
1346 .section "Duplicate addresses" "SECID17"
1347 .cindex "case of local parts"
1348 .cindex "address duplicate, discarding"
1349 .cindex "duplicate addresses"
1350 Once routing is complete, Exim scans the addresses that are assigned to local
1351 and remote transports, and discards any duplicates that it finds. During this
1352 check, local parts are treated as case-sensitive. This happens only when
1353 actually delivering a message; when testing routers with &%-bt%&, all the
1354 routed addresses are shown.
1355
1356
1357
1358 .section "Router preconditions" "SECTrouprecon"
1359 .cindex "router" "preconditions, order of processing"
1360 .cindex "preconditions" "order of processing"
1361 The preconditions that are tested for each router are listed below, in the
1362 order in which they are tested. The individual configuration options are
1363 described in more detail in chapter &<<CHAProutergeneric>>&.
1364
1365 .ilist
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 If the &%local_parts%& option is set, the local part of the address must be in
1403 the set of local parts that it defines. If &%local_part_prefix%& or
1404 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1405 part before this check. If you want to do precondition tests on local parts
1406 that include affixes, you can do so by using a &%condition%& option (see below)
1407 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1408 &$local_part_suffix$& as necessary.
1409 .next
1410 .vindex "&$local_user_uid$&"
1411 .vindex "&$local_user_gid$&"
1412 .vindex "&$home$&"
1413 If the &%check_local_user%& option is set, the local part must be the name of
1414 an account on the local host. If this check succeeds, the uid and gid of the
1415 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1416 user's home directory is placed in &$home$&; these values can be used in the
1417 remaining preconditions.
1418 .next
1419 If the &%router_home_directory%& option is set, it is expanded at this point,
1420 because it overrides the value of &$home$&. If this expansion were left till
1421 later, the value of &$home$& as set by &%check_local_user%& would be used in
1422 subsequent tests. Having two different values of &$home$& in the same router
1423 could lead to confusion.
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427 .next
1428 If the &%require_files%& option is set, the existence or non-existence of
1429 specified files is tested.
1430 .next
1431 .cindex "customizing" "precondition"
1432 If the &%condition%& option is set, it is evaluated and tested. This option
1433 uses an expanded string to allow you to set up your own custom preconditions.
1434 Expanded strings are described in chapter &<<CHAPexpand>>&.
1435 .endlist
1436
1437
1438 Note that &%require_files%& comes near the end of the list, so you cannot use
1439 it to check for the existence of a file in which to lookup up a domain, local
1440 part, or sender. However, as these options are all expanded, you can use the
1441 &%exists%& expansion condition to make such tests within each condition. The
1442 &%require_files%& option is intended for checking files that the router may be
1443 going to use internally, or which are needed by a specific transport (for
1444 example, &_.procmailrc_&).
1445
1446
1447
1448 .section "Delivery in detail" "SECID18"
1449 .cindex "delivery" "in detail"
1450 When a message is to be delivered, the sequence of events is as follows:
1451
1452 .ilist
1453 If a system-wide filter file is specified, the message is passed to it. The
1454 filter may add recipients to the message, replace the recipients, discard the
1455 message, cause a new message to be generated, or cause the message delivery to
1456 fail. The format of the system filter file is the same as for Exim user filter
1457 files, described in the separate document entitled &'Exim's interfaces to mail
1458 filtering'&.
1459 .cindex "Sieve filter" "not available for system filter"
1460 (&*Note*&: Sieve cannot be used for system filter files.)
1461
1462 Some additional features are available in system filters &-- see chapter
1463 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1464 filter only once per delivery attempt, however many recipients it has. However,
1465 if there are several delivery attempts because one or more addresses could not
1466 be immediately delivered, the system filter is run each time. The filter
1467 condition &%first_delivery%& can be used to detect the first run of the system
1468 filter.
1469 .next
1470 Each recipient address is offered to each configured router in turn, subject to
1471 its preconditions, until one is able to handle it. If no router can handle the
1472 address, that is, if they all decline, the address is failed. Because routers
1473 can be targeted at particular domains, several locally handled domains can be
1474 processed entirely independently of each other.
1475 .next
1476 .cindex "routing" "loops in"
1477 .cindex "loop" "while routing"
1478 A router that accepts an address may assign it to a local or a remote
1479 transport. However, the transport is not run at this time. Instead, the address
1480 is placed on a list for the particular transport, which will be run later.
1481 Alternatively, the router may generate one or more new addresses (typically
1482 from alias, forward, or filter files). New addresses are fed back into this
1483 process from the top, but in order to avoid loops, a router ignores any address
1484 which has an identically-named ancestor that was processed by itself.
1485 .next
1486 When all the routing has been done, addresses that have been successfully
1487 handled are passed to their assigned transports. When local transports are
1488 doing real local deliveries, they handle only one address at a time, but if a
1489 local transport is being used as a pseudo-remote transport (for example, to
1490 collect batched SMTP messages for transmission by some other means) multiple
1491 addresses can be handled. Remote transports can always handle more than one
1492 address at a time, but can be configured not to do so, or to restrict multiple
1493 addresses to the same domain.
1494 .next
1495 Each local delivery to a file or a pipe runs in a separate process under a
1496 non-privileged uid, and these deliveries are run one at a time. Remote
1497 deliveries also run in separate processes, normally under a uid that is private
1498 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1499 run in parallel. The maximum number of simultaneous remote deliveries for any
1500 one message is set by the &%remote_max_parallel%& option.
1501 The order in which deliveries are done is not defined, except that all local
1502 deliveries happen before any remote deliveries.
1503 .next
1504 .cindex "queue runner"
1505 When it encounters a local delivery during a queue run, Exim checks its retry
1506 database to see if there has been a previous temporary delivery failure for the
1507 address before running the local transport. If there was a previous failure,
1508 Exim does not attempt a new delivery until the retry time for the address is
1509 reached. However, this happens only for delivery attempts that are part of a
1510 queue run. Local deliveries are always attempted when delivery immediately
1511 follows message reception, even if retry times are set for them. This makes for
1512 better behaviour if one particular message is causing problems (for example,
1513 causing quota overflow, or provoking an error in a filter file).
1514 .next
1515 .cindex "delivery" "retry in remote transports"
1516 Remote transports do their own retry handling, since an address may be
1517 deliverable to one of a number of hosts, each of which may have a different
1518 retry time. If there have been previous temporary failures and no host has
1519 reached its retry time, no delivery is attempted, whether in a queue run or
1520 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1521 .next
1522 If there were any permanent errors, a bounce message is returned to an
1523 appropriate address (the sender in the common case), with details of the error
1524 for each failing address. Exim can be configured to send copies of bounce
1525 messages to other addresses.
1526 .next
1527 .cindex "delivery" "deferral"
1528 If one or more addresses suffered a temporary failure, the message is left on
1529 the queue, to be tried again later. Delivery of these addresses is said to be
1530 &'deferred'&.
1531 .next
1532 When all the recipient addresses have either been delivered or bounced,
1533 handling of the message is complete. The spool files and message log are
1534 deleted, though the message log can optionally be preserved if required.
1535 .endlist
1536
1537
1538
1539
1540 .section "Retry mechanism" "SECID19"
1541 .cindex "delivery" "retry mechanism"
1542 .cindex "retry" "description of mechanism"
1543 .cindex "queue runner"
1544 Exim's mechanism for retrying messages that fail to get delivered at the first
1545 attempt is the queue runner process. You must either run an Exim daemon that
1546 uses the &%-q%& option with a time interval to start queue runners at regular
1547 intervals, or use some other means (such as &'cron'&) to start them. If you do
1548 not arrange for queue runners to be run, messages that fail temporarily at the
1549 first attempt will remain on your queue for ever. A queue runner process works
1550 its way through the queue, one message at a time, trying each delivery that has
1551 passed its retry time.
1552 You can run several queue runners at once.
1553
1554 Exim uses a set of configured rules to determine when next to retry the failing
1555 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1556 should give up trying to deliver to the address, at which point it generates a
1557 bounce message. If no retry rules are set for a particular host, address, and
1558 error combination, no retries are attempted, and temporary errors are treated
1559 as permanent.
1560
1561
1562
1563 .section "Temporary delivery failure" "SECID20"
1564 .cindex "delivery" "temporary failure"
1565 There are many reasons why a message may not be immediately deliverable to a
1566 particular address. Failure to connect to a remote machine (because it, or the
1567 connection to it, is down) is one of the most common. Temporary failures may be
1568 detected during routing as well as during the transport stage of delivery.
1569 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1570 is on a file system where the user is over quota. Exim can be configured to
1571 impose its own quotas on local mailboxes; where system quotas are set they will
1572 also apply.
1573
1574 If a host is unreachable for a period of time, a number of messages may be
1575 waiting for it by the time it recovers, and sending them in a single SMTP
1576 connection is clearly beneficial. Whenever a delivery to a remote host is
1577 deferred,
1578 .cindex "hints database"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default ISO-8859-1). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&. It is not known
1989 if anyone is actually using A6 records. Exim has support for A6 records, but
1990 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1991 support has not been tested for some time.
1992
1993
1994
1995 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1996 .cindex "lookup modules"
1997 .cindex "dynamic modules"
1998 .cindex ".so building"
1999 On some platforms, Exim supports not compiling all lookup types directly into
2000 the main binary, instead putting some into external modules which can be loaded
2001 on demand.
2002 This permits packagers to build Exim with support for lookups with extensive
2003 library dependencies without requiring all users to install all of those
2004 dependencies.
2005 Most, but not all, lookup types can be built this way.
2006
2007 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2008 installed; Exim will only load modules from that directory, as a security
2009 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2010 for your OS; see &_OS/Makefile-Linux_& for an example.
2011 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2012 see &_src/EDITME_& for details.
2013
2014 Then, for each module to be loaded dynamically, define the relevant
2015 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2016 For example, this will build in lsearch but load sqlite and mysql support
2017 on demand:
2018 .code
2019 LOOKUP_LSEARCH=yes
2020 LOOKUP_SQLITE=2
2021 LOOKUP_MYSQL=2
2022 .endd
2023
2024
2025 .section "The building process" "SECID29"
2026 .cindex "build directory"
2027 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2028 created, run &'make'& at the top level. It determines the architecture and
2029 operating system types, and creates a build directory if one does not exist.
2030 For example, on a Sun system running Solaris 8, the directory
2031 &_build-SunOS5-5.8-sparc_& is created.
2032 .cindex "symbolic link" "to source files"
2033 Symbolic links to relevant source files are installed in the build directory.
2034
2035 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2036 building process fails if it is set.
2037
2038 If this is the first time &'make'& has been run, it calls a script that builds
2039 a make file inside the build directory, using the configuration files from the
2040 &_Local_& directory. The new make file is then passed to another instance of
2041 &'make'&. This does the real work, building a number of utility scripts, and
2042 then compiling and linking the binaries for the Exim monitor (if configured), a
2043 number of utility programs, and finally Exim itself. The command &`make
2044 makefile`& can be used to force a rebuild of the make file in the build
2045 directory, should this ever be necessary.
2046
2047 If you have problems building Exim, check for any comments there may be in the
2048 &_README_& file concerning your operating system, and also take a look at the
2049 FAQ, where some common problems are covered.
2050
2051
2052
2053 .section 'Output from &"make"&' "SECID283"
2054 The output produced by the &'make'& process for compile lines is often very
2055 unreadable, because these lines can be very long. For this reason, the normal
2056 output is suppressed by default, and instead output similar to that which
2057 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2058 each module that is being compiled or linked. However, it is still possible to
2059 get the full output, by calling &'make'& like this:
2060 .code
2061 FULLECHO='' make -e
2062 .endd
2063 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2064 command reflection in &'make'&. When you ask for the full output, it is
2065 given in addition to the short output.
2066
2067
2068
2069 .section "Overriding build-time options for Exim" "SECToverride"
2070 .cindex "build-time options, overriding"
2071 The main make file that is created at the beginning of the building process
2072 consists of the concatenation of a number of files which set configuration
2073 values, followed by a fixed set of &'make'& instructions. If a value is set
2074 more than once, the last setting overrides any previous ones. This provides a
2075 convenient way of overriding defaults. The files that are concatenated are, in
2076 order:
2077 .display
2078 &_OS/Makefile-Default_&
2079 &_OS/Makefile-_&<&'ostype'&>
2080 &_Local/Makefile_&
2081 &_Local/Makefile-_&<&'ostype'&>
2082 &_Local/Makefile-_&<&'archtype'&>
2083 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2084 &_OS/Makefile-Base_&
2085 .endd
2086 .cindex "&_Local/Makefile_&"
2087 .cindex "building Exim" "operating system type"
2088 .cindex "building Exim" "architecture type"
2089 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2090 architecture type. &_Local/Makefile_& is required to exist, and the building
2091 process fails if it is absent. The other three &_Local_& files are optional,
2092 and are often not needed.
2093
2094 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2095 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2096 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2097 values are used, thereby providing a means of forcing particular settings.
2098 Otherwise, the scripts try to get values from the &%uname%& command. If this
2099 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2100 of &'ad hoc'& transformations are then applied, to produce the standard names
2101 that Exim expects. You can run these scripts directly from the shell in order
2102 to find out what values are being used on your system.
2103
2104
2105 &_OS/Makefile-Default_& contains comments about the variables that are set
2106 therein. Some (but not all) are mentioned below. If there is something that
2107 needs changing, review the contents of this file and the contents of the make
2108 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2109 default values are.
2110
2111
2112 .cindex "building Exim" "overriding default settings"
2113 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2114 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2115 need to change the original files. Instead, you should make the changes by
2116 putting the new values in an appropriate &_Local_& file. For example,
2117 .cindex "Tru64-Unix build-time settings"
2118 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2119 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2120 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2121 called with the option &%-std1%&, to make it recognize some of the features of
2122 Standard C that Exim uses. (Most other compilers recognize Standard C by
2123 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2124 containing the lines
2125 .code
2126 CC=cc
2127 CFLAGS=-std1
2128 .endd
2129 If you are compiling for just one operating system, it may be easier to put
2130 these lines directly into &_Local/Makefile_&.
2131
2132 Keeping all your local configuration settings separate from the distributed
2133 files makes it easy to transfer them to new versions of Exim simply by copying
2134 the contents of the &_Local_& directory.
2135
2136
2137 .cindex "NIS lookup type" "including support for"
2138 .cindex "NIS+ lookup type" "including support for"
2139 .cindex "LDAP" "including support for"
2140 .cindex "lookup" "inclusion in binary"
2141 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2142 lookup, but not all systems have these components installed, so the default is
2143 not to include the relevant code in the binary. All the different kinds of file
2144 and database lookup that Exim supports are implemented as separate code modules
2145 which are included only if the relevant compile-time options are set. In the
2146 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2147 .code
2148 LOOKUP_LDAP=yes
2149 LOOKUP_NIS=yes
2150 LOOKUP_NISPLUS=yes
2151 .endd
2152 and similar settings apply to the other lookup types. They are all listed in
2153 &_src/EDITME_&. In many cases the relevant include files and interface
2154 libraries need to be installed before compiling Exim.
2155 .cindex "cdb" "including support for"
2156 However, there are some optional lookup types (such as cdb) for which
2157 the code is entirely contained within Exim, and no external include
2158 files or libraries are required. When a lookup type is not included in the
2159 binary, attempts to configure Exim to use it cause run time configuration
2160 errors.
2161
2162 .cindex "pkg-config" "lookups"
2163 .cindex "pkg-config" "authenticators"
2164 Many systems now use a tool called &'pkg-config'& to encapsulate information
2165 about how to compile against a library; Exim has some initial support for
2166 being able to use pkg-config for lookups and authenticators.  For any given
2167 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2168 variable with the &`_PC`& suffix in the name and assign as the value the
2169 name of the package to be queried.  The results of querying via the
2170 &'pkg-config'& command will be added to the appropriate Makefile variables
2171 with &`+=`& directives, so your version of &'make'& will need to support that
2172 syntax.  For instance:
2173 .code
2174 LOOKUP_SQLITE=yes
2175 LOOKUP_SQLITE_PC=sqlite3
2176 AUTH_GSASL=yes
2177 AUTH_GSASL_PC=libgsasl
2178 AUTH_HEIMDAL_GSSAPI=yes
2179 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2180 .endd
2181
2182 .cindex "Perl" "including support for"
2183 Exim can be linked with an embedded Perl interpreter, allowing Perl
2184 subroutines to be called during string expansion. To enable this facility,
2185 .code
2186 EXIM_PERL=perl.o
2187 .endd
2188 must be defined in &_Local/Makefile_&. Details of this facility are given in
2189 chapter &<<CHAPperl>>&.
2190
2191 .cindex "X11 libraries, location of"
2192 The location of the X11 libraries is something that varies a lot between
2193 operating systems, and there may be different versions of X11 to cope
2194 with. Exim itself makes no use of X11, but if you are compiling the Exim
2195 monitor, the X11 libraries must be available.
2196 The following three variables are set in &_OS/Makefile-Default_&:
2197 .code
2198 X11=/usr/X11R6
2199 XINCLUDE=-I$(X11)/include
2200 XLFLAGS=-L$(X11)/lib
2201 .endd
2202 These are overridden in some of the operating-system configuration files. For
2203 example, in &_OS/Makefile-SunOS5_& there is
2204 .code
2205 X11=/usr/openwin
2206 XINCLUDE=-I$(X11)/include
2207 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2208 .endd
2209 If you need to override the default setting for your operating system, place a
2210 definition of all three of these variables into your
2211 &_Local/Makefile-<ostype>_& file.
2212
2213 .cindex "EXTRALIBS"
2214 If you need to add any extra libraries to the link steps, these can be put in a
2215 variable called EXTRALIBS, which appears in all the link commands, but by
2216 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2217 command for linking the main Exim binary, and not for any associated utilities.
2218
2219 .cindex "DBM libraries" "configuration for building"
2220 There is also DBMLIB, which appears in the link commands for binaries that
2221 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2222 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2223 binary, and which can be used, for example, to include additional X11
2224 libraries.
2225
2226 .cindex "configuration file" "editing"
2227 The make file copes with rebuilding Exim correctly if any of the configuration
2228 files are edited. However, if an optional configuration file is deleted, it is
2229 necessary to touch the associated non-optional file (that is,
2230 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2231
2232
2233 .section "OS-specific header files" "SECID30"
2234 .cindex "&_os.h_&"
2235 .cindex "building Exim" "OS-specific C header files"
2236 The &_OS_& directory contains a number of files with names of the form
2237 &_os.h-<ostype>_&. These are system-specific C header files that should not
2238 normally need to be changed. There is a list of macro settings that are
2239 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2240 are porting Exim to a new operating system.
2241
2242
2243
2244 .section "Overriding build-time options for the monitor" "SECID31"
2245 .cindex "building Eximon"
2246 A similar process is used for overriding things when building the Exim monitor,
2247 where the files that are involved are
2248 .display
2249 &_OS/eximon.conf-Default_&
2250 &_OS/eximon.conf-_&<&'ostype'&>
2251 &_Local/eximon.conf_&
2252 &_Local/eximon.conf-_&<&'ostype'&>
2253 &_Local/eximon.conf-_&<&'archtype'&>
2254 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2255 .endd
2256 .cindex "&_Local/eximon.conf_&"
2257 As with Exim itself, the final three files need not exist, and in this case the
2258 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2259 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2260 variables of the same name, preceded by EXIMON_. For example, setting
2261 EXIMON_LOG_DEPTH in the environment overrides the value of
2262 LOG_DEPTH at run time.
2263 .ecindex IIDbuex
2264
2265
2266 .section "Installing Exim binaries and scripts" "SECID32"
2267 .cindex "installing Exim"
2268 .cindex "BIN_DIRECTORY"
2269 The command &`make install`& runs the &(exim_install)& script with no
2270 arguments. The script copies binaries and utility scripts into the directory
2271 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2272 .cindex "setuid" "installing Exim with"
2273 The install script copies files only if they are newer than the files they are
2274 going to replace. The Exim binary is required to be owned by root and have the
2275 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2276 install`& as root so that it can set up the Exim binary in this way. However, in
2277 some special situations (for example, if a host is doing no local deliveries)
2278 it may be possible to run Exim without making the binary setuid root (see
2279 chapter &<<CHAPsecurity>>& for details).
2280
2281 .cindex "CONFIGURE_FILE"
2282 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2283 in &_Local/Makefile_&. If this names a single file, and the file does not
2284 exist, the default configuration file &_src/configure.default_& is copied there
2285 by the installation script. If a run time configuration file already exists, it
2286 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2287 alternative files, no default is installed.
2288
2289 .cindex "system aliases file"
2290 .cindex "&_/etc/aliases_&"
2291 One change is made to the default configuration file when it is installed: the
2292 default configuration contains a router that references a system aliases file.
2293 The path to this file is set to the value specified by
2294 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2295 If the system aliases file does not exist, the installation script creates it,
2296 and outputs a comment to the user.
2297
2298 The created file contains no aliases, but it does contain comments about the
2299 aliases a site should normally have. Mail aliases have traditionally been
2300 kept in &_/etc/aliases_&. However, some operating systems are now using
2301 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2302 Exim's configuration if necessary.
2303
2304 The default configuration uses the local host's name as the only local domain,
2305 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2306 running as the local user. System aliases and &_.forward_& files in users' home
2307 directories are supported, but no NIS or NIS+ support is configured. Domains
2308 other than the name of the local host are routed using the DNS, with delivery
2309 over SMTP.
2310
2311 It is possible to install Exim for special purposes (such as building a binary
2312 distribution) in a private part of the file system. You can do this by a
2313 command such as
2314 .code
2315 make DESTDIR=/some/directory/ install
2316 .endd
2317 This has the effect of pre-pending the specified directory to all the file
2318 paths, except the name of the system aliases file that appears in the default
2319 configuration. (If a default alias file is created, its name &'is'& modified.)
2320 For backwards compatibility, ROOT is used if DESTDIR is not set,
2321 but this usage is deprecated.
2322
2323 .cindex "installing Exim" "what is not installed"
2324 Running &'make install'& does not copy the Exim 4 conversion script
2325 &'convert4r4'&. You will probably run this only once if you are
2326 upgrading from Exim 3. None of the documentation files in the &_doc_&
2327 directory are copied, except for the info files when you have set
2328 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2329
2330 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2331 to their names. The Exim binary itself, however, is handled differently. It is
2332 installed under a name that includes the version number and the compile number,
2333 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2334 called &_exim_& to point to the binary. If you are updating a previous version
2335 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2336 from the directory (as seen by other processes).
2337
2338 .cindex "installing Exim" "testing the script"
2339 If you want to see what the &'make install'& will do before running it for
2340 real, you can pass the &%-n%& option to the installation script by this
2341 command:
2342 .code
2343 make INSTALL_ARG=-n install
2344 .endd
2345 The contents of the variable INSTALL_ARG are passed to the installation
2346 script. You do not need to be root to run this test. Alternatively, you can run
2347 the installation script directly, but this must be from within the build
2348 directory. For example, from the top-level Exim directory you could use this
2349 command:
2350 .code
2351 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2352 .endd
2353 .cindex "installing Exim" "install script options"
2354 There are two other options that can be supplied to the installation script.
2355
2356 .ilist
2357 &%-no_chown%& bypasses the call to change the owner of the installed binary
2358 to root, and the call to make it a setuid binary.
2359 .next
2360 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2361 installed binary.
2362 .endlist
2363
2364 INSTALL_ARG can be used to pass these options to the script. For example:
2365 .code
2366 make INSTALL_ARG=-no_symlink install
2367 .endd
2368 The installation script can also be given arguments specifying which files are
2369 to be copied. For example, to install just the Exim binary, and nothing else,
2370 without creating the symbolic link, you could use:
2371 .code
2372 make INSTALL_ARG='-no_symlink exim' install
2373 .endd
2374
2375
2376
2377 .section "Installing info documentation" "SECTinsinfdoc"
2378 .cindex "installing Exim" "&'info'& documentation"
2379 Not all systems use the GNU &'info'& system for documentation, and for this
2380 reason, the Texinfo source of Exim's documentation is not included in the main
2381 distribution. Instead it is available separately from the ftp site (see section
2382 &<<SECTavail>>&).
2383
2384 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2385 source of the documentation is found in the source tree, running &`make
2386 install`& automatically builds the info files and installs them.
2387
2388
2389
2390 .section "Setting up the spool directory" "SECID33"
2391 .cindex "spool directory" "creating"
2392 When it starts up, Exim tries to create its spool directory if it does not
2393 exist. The Exim uid and gid are used for the owner and group of the spool
2394 directory. Sub-directories are automatically created in the spool directory as
2395 necessary.
2396
2397
2398
2399
2400 .section "Testing" "SECID34"
2401 .cindex "testing" "installation"
2402 Having installed Exim, you can check that the run time configuration file is
2403 syntactically valid by running the following command, which assumes that the
2404 Exim binary directory is within your PATH environment variable:
2405 .code
2406 exim -bV
2407 .endd
2408 If there are any errors in the configuration file, Exim outputs error messages.
2409 Otherwise it outputs the version number and build date,
2410 the DBM library that is being used, and information about which drivers and
2411 other optional code modules are included in the binary.
2412 Some simple routing tests can be done by using the address testing option. For
2413 example,
2414 .display
2415 &`exim -bt`& <&'local username'&>
2416 .endd
2417 should verify that it recognizes a local mailbox, and
2418 .display
2419 &`exim -bt`& <&'remote address'&>
2420 .endd
2421 a remote one. Then try getting it to deliver mail, both locally and remotely.
2422 This can be done by passing messages directly to Exim, without going through a
2423 user agent. For example:
2424 .code
2425 exim -v postmaster@your.domain.example
2426 From: user@your.domain.example
2427 To: postmaster@your.domain.example
2428 Subject: Testing Exim
2429
2430 This is a test message.
2431 ^D
2432 .endd
2433 The &%-v%& option causes Exim to output some verification of what it is doing.
2434 In this case you should see copies of three log lines, one for the message's
2435 arrival, one for its delivery, and one containing &"Completed"&.
2436
2437 .cindex "delivery" "problems with"
2438 If you encounter problems, look at Exim's log files (&'mainlog'& and
2439 &'paniclog'&) to see if there is any relevant information there. Another source
2440 of information is running Exim with debugging turned on, by specifying the
2441 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2442 with debugging turned on by a command of the form
2443 .display
2444 &`exim -d -M`& <&'exim-message-id'&>
2445 .endd
2446 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2447 produces rather a lot of output, but you can cut this down to specific areas.
2448 For example, if you use &%-d-all+route%& only the debugging information
2449 relevant to routing is included. (See the &%-d%& option in chapter
2450 &<<CHAPcommandline>>& for more details.)
2451
2452 .cindex '&"sticky"& bit'
2453 .cindex "lock files"
2454 One specific problem that has shown up on some sites is the inability to do
2455 local deliveries into a shared mailbox directory, because it does not have the
2456 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2457 writing to a mailbox file, and if it cannot create the lock file, the delivery
2458 is deferred. You can get round this either by setting the &"sticky bit"& on the
2459 directory, or by setting a specific group for local deliveries and allowing
2460 that group to create files in the directory (see the comments above the
2461 &(local_delivery)& transport in the default configuration file). Another
2462 approach is to configure Exim not to use lock files, but just to rely on
2463 &[fcntl()]& locking instead. However, you should do this only if all user
2464 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2465 see chapter &<<CHAPappendfile>>&.
2466
2467 One thing that cannot be tested on a system that is already running an MTA is
2468 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2469 &%-oX%& option can be used to run an Exim daemon that listens on some other
2470 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2471 &'exim_checkaccess'& utility can be used to check out policy controls on
2472 incoming SMTP mail.
2473
2474 Testing a new version on a system that is already running Exim can most easily
2475 be done by building a binary with a different CONFIGURE_FILE setting. From
2476 within the run time configuration, all other file and directory names
2477 that Exim uses can be altered, in order to keep it entirely clear of the
2478 production version.
2479
2480
2481 .section "Replacing another MTA with Exim" "SECID35"
2482 .cindex "replacing another MTA"
2483 Building and installing Exim for the first time does not of itself put it in
2484 general use. The name by which the system's MTA is called by mail user agents
2485 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2486 operating system), and it is necessary to make this name point to the &'exim'&
2487 binary in order to get the user agents to pass messages to Exim. This is
2488 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2489 or &_/usr/lib/sendmail_&
2490 .cindex "symbolic link" "to &'exim'& binary"
2491 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2492 privilege and executable status from the old MTA. It is then necessary to stop
2493 and restart the mailer daemon, if one is running.
2494
2495 .cindex "FreeBSD, MTA indirection"
2496 .cindex "&_/etc/mail/mailer.conf_&"
2497 Some operating systems have introduced alternative ways of switching MTAs. For
2498 example, if you are running FreeBSD, you need to edit the file
2499 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2500 described. A typical example of the contents of this file for running Exim is
2501 as follows:
2502 .code
2503 sendmail            /usr/exim/bin/exim
2504 send-mail           /usr/exim/bin/exim
2505 mailq               /usr/exim/bin/exim -bp
2506 newaliases          /usr/bin/true
2507 .endd
2508 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2509 your Exim installation is &"live"&. Check it by sending a message from your
2510 favourite user agent.
2511
2512 You should consider what to tell your users about the change of MTA. Exim may
2513 have different capabilities to what was previously running, and there are
2514 various operational differences such as the text of messages produced by
2515 command line options and in bounce messages. If you allow your users to make
2516 use of Exim's filtering capabilities, you should make the document entitled
2517 &'Exim's interface to mail filtering'& available to them.
2518
2519
2520
2521 .section "Upgrading Exim" "SECID36"
2522 .cindex "upgrading Exim"
2523 If you are already running Exim on your host, building and installing a new
2524 version automatically makes it available to MUAs, or any other programs that
2525 call the MTA directly. However, if you are running an Exim daemon, you do need
2526 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2527 new binary. You do not need to stop processing mail in order to install a new
2528 version of Exim. The install script does not modify an existing runtime
2529 configuration file.
2530
2531
2532
2533
2534 .section "Stopping the Exim daemon on Solaris" "SECID37"
2535 .cindex "Solaris" "stopping Exim on"
2536 The standard command for stopping the mailer daemon on Solaris is
2537 .code
2538 /etc/init.d/sendmail stop
2539 .endd
2540 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2541 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2542 for the text &"sendmail"&; this is not present because the actual program name
2543 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2544 solution is to replace the line that finds the process id with something like
2545 .code
2546 pid=`cat /var/spool/exim/exim-daemon.pid`
2547 .endd
2548 to obtain the daemon's pid directly from the file that Exim saves it in.
2549
2550 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2551 still be received from local processes, and if automatic delivery is configured
2552 (the normal case), deliveries will still occur.
2553
2554
2555
2556
2557 . ////////////////////////////////////////////////////////////////////////////
2558 . ////////////////////////////////////////////////////////////////////////////
2559
2560 .chapter "The Exim command line" "CHAPcommandline"
2561 .scindex IIDclo1 "command line" "options"
2562 .scindex IIDclo2 "options" "command line"
2563 Exim's command line takes the standard Unix form of a sequence of options,
2564 each starting with a hyphen character, followed by a number of arguments. The
2565 options are compatible with the main options of Sendmail, and there are also
2566 some additional options, some of which are compatible with Smail 3. Certain
2567 combinations of options do not make sense, and provoke an error if used.
2568 The form of the arguments depends on which options are set.
2569
2570
2571 .section "Setting options by program name" "SECID38"
2572 .cindex "&'mailq'&"
2573 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2574 were present before any other options.
2575 The &%-bp%& option requests a listing of the contents of the mail queue on the
2576 standard output.
2577 This feature is for compatibility with some systems that contain a command of
2578 that name in one of the standard libraries, symbolically linked to
2579 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2580
2581 .cindex "&'rsmtp'&"
2582 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2583 were present before any other options, for compatibility with Smail. The
2584 &%-bS%& option is used for reading in a number of messages in batched SMTP
2585 format.
2586
2587 .cindex "&'rmail'&"
2588 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2589 &%-oee%& options were present before any other options, for compatibility with
2590 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2591
2592 .cindex "&'runq'&"
2593 .cindex "queue runner"
2594 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2595 were present before any other options, for compatibility with Smail. The &%-q%&
2596 option causes a single queue runner process to be started.
2597
2598 .cindex "&'newaliases'&"
2599 .cindex "alias file" "building"
2600 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2601 If Exim is called under the name &'newaliases'& it behaves as if the option
2602 &%-bi%& were present before any other options, for compatibility with Sendmail.
2603 This option is used for rebuilding Sendmail's alias file. Exim does not have
2604 the concept of a single alias file, but can be configured to run a given
2605 command if called with the &%-bi%& option.
2606
2607
2608 .section "Trusted and admin users" "SECTtrustedadmin"
2609 Some Exim options are available only to &'trusted users'& and others are
2610 available only to &'admin users'&. In the description below, the phrases &"Exim
2611 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2612 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2613 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2614
2615 .ilist
2616 .cindex "trusted users" "definition of"
2617 .cindex "user" "trusted definition of"
2618 The trusted users are root, the Exim user, any user listed in the
2619 &%trusted_users%& configuration option, and any user whose current group or any
2620 supplementary group is one of those listed in the &%trusted_groups%&
2621 configuration option. Note that the Exim group is not automatically trusted.
2622
2623 .cindex '&"From"& line'
2624 .cindex "envelope sender"
2625 Trusted users are always permitted to use the &%-f%& option or a leading
2626 &"From&~"& line to specify the envelope sender of a message that is passed to
2627 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2628 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2629 users to set envelope senders.
2630
2631 .cindex "&'From:'& header line"
2632 .cindex "&'Sender:'& header line"
2633 For a trusted user, there is never any check on the contents of the &'From:'&
2634 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2635 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2636
2637 Trusted users may also specify a host name, host address, interface address,
2638 protocol name, ident value, and authentication data when submitting a message
2639 locally. Thus, they are able to insert messages into Exim's queue locally that
2640 have the characteristics of messages received from a remote host. Untrusted
2641 users may in some circumstances use &%-f%&, but can never set the other values
2642 that are available to trusted users.
2643 .next
2644 .cindex "user" "admin definition of"
2645 .cindex "admin user" "definition of"
2646 The admin users are root, the Exim user, and any user that is a member of the
2647 Exim group or of any group listed in the &%admin_groups%& configuration option.
2648 The current group does not have to be one of these groups.
2649
2650 Admin users are permitted to list the queue, and to carry out certain
2651 operations on messages, for example, to force delivery failures. It is also
2652 necessary to be an admin user in order to see the full information provided by
2653 the Exim monitor, and full debugging output.
2654
2655 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2656 Exim to attempt delivery of messages on its queue is restricted to admin users.
2657 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2658 option false (that is, specifying &%no_prod_requires_admin%&).
2659
2660 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2661 is restricted to admin users unless &%queue_list_requires_admin%& is set
2662 false.
2663 .endlist
2664
2665
2666 &*Warning*&: If you configure your system so that admin users are able to
2667 edit Exim's configuration file, you are giving those users an easy way of
2668 getting root. There is further discussion of this issue at the start of chapter
2669 &<<CHAPconf>>&.
2670
2671
2672
2673
2674 .section "Command line options" "SECID39"
2675 Exim's command line options are described in alphabetical order below. If none
2676 of the options that specifies a specific action (such as starting the daemon or
2677 a queue runner, or testing an address, or receiving a message in a specific
2678 format, or listing the queue) are present, and there is at least one argument
2679 on the command line, &%-bm%& (accept a local message on the standard input,
2680 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2681 outputs a brief message about itself and exits.
2682
2683 . ////////////////////////////////////////////////////////////////////////////
2684 . Insert a stylized XML comment here, to identify the start of the command line
2685 . options. This is for the benefit of the Perl script that automatically
2686 . creates a man page for the options.
2687 . ////////////////////////////////////////////////////////////////////////////
2688
2689 .literal xml
2690 <!-- === Start of command line options === -->
2691 .literal off
2692
2693
2694 .vlist
2695 .vitem &%--%&
2696 .oindex "--"
2697 .cindex "options" "command line; terminating"
2698 This is a pseudo-option whose only purpose is to terminate the options and
2699 therefore to cause subsequent command line items to be treated as arguments
2700 rather than options, even if they begin with hyphens.
2701
2702 .vitem &%--help%&
2703 .oindex "&%--help%&"
2704 This option causes Exim to output a few sentences stating what it is.
2705 The same output is generated if the Exim binary is called with no options and
2706 no arguments.
2707
2708 .vitem &%--version%&
2709 .oindex "&%--version%&"
2710 This option is an alias for &%-bV%& and causes version information to be
2711 displayed.
2712
2713 .vitem &%-Ac%& &&&
2714        &%-Am%&
2715 .oindex "&%-Ac%&"
2716 .oindex "&%-Am%&"
2717 These options are used by Sendmail for selecting configuration files and are
2718 ignored by Exim.
2719
2720 .vitem &%-B%&<&'type'&>
2721 .oindex "&%-B%&"
2722 .cindex "8-bit characters"
2723 .cindex "Sendmail compatibility" "8-bit characters"
2724 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2725 clean; it ignores this option.
2726
2727 .vitem &%-bd%&
2728 .oindex "&%-bd%&"
2729 .cindex "daemon"
2730 .cindex "SMTP" "listener"
2731 .cindex "queue runner"
2732 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2733 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2734 that the daemon should also initiate periodic queue runs.
2735
2736 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2737 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2738 disconnect from the controlling terminal. When running this way, it can be
2739 stopped by pressing ctrl-C.
2740
2741 By default, Exim listens for incoming connections to the standard SMTP port on
2742 all the host's running interfaces. However, it is possible to listen on other
2743 ports, on multiple ports, and only on specific interfaces. Chapter
2744 &<<CHAPinterfaces>>& contains a description of the options that control this.
2745
2746 When a listening daemon
2747 .cindex "daemon" "process id (pid)"
2748 .cindex "pid (process id)" "of daemon"
2749 is started without the use of &%-oX%& (that is, without overriding the normal
2750 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2751 in Exim's spool directory. This location can be overridden by setting
2752 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2753 running as root.
2754
2755 When &%-oX%& is used on the command line to start a listening daemon, the
2756 process id is not written to the normal pid file path. However, &%-oP%& can be
2757 used to specify a path on the command line if a pid file is required.
2758
2759 The SIGHUP signal
2760 .cindex "SIGHUP"
2761 .cindex "daemon" "restarting"
2762 can be used to cause the daemon to re-execute itself. This should be done
2763 whenever Exim's configuration file, or any file that is incorporated into it by
2764 means of the &%.include%& facility, is changed, and also whenever a new version
2765 of Exim is installed. It is not necessary to do this when other files that are
2766 referenced from the configuration (for example, alias files) are changed,
2767 because these are reread each time they are used.
2768
2769 .vitem &%-bdf%&
2770 .oindex "&%-bdf%&"
2771 This option has the same effect as &%-bd%& except that it never disconnects
2772 from the controlling terminal, even when no debugging is specified.
2773
2774 .vitem &%-be%&
2775 .oindex "&%-be%&"
2776 .cindex "testing" "string expansion"
2777 .cindex "expansion" "testing"
2778 Run Exim in expansion testing mode. Exim discards its root privilege, to
2779 prevent ordinary users from using this mode to read otherwise inaccessible
2780 files. If no arguments are given, Exim runs interactively, prompting for lines
2781 of data. Otherwise, it processes each argument in turn.
2782
2783 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2784 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2785 used without command line arguments. If successful, it uses the &[readline()]&
2786 function, which provides extensive line-editing facilities, for reading the
2787 test data. A line history is supported.
2788
2789 Long expansion expressions can be split over several lines by using backslash
2790 continuations. As in Exim's run time configuration, white space at the start of
2791 continuation lines is ignored. Each argument or data line is passed through the
2792 string expansion mechanism, and the result is output. Variable values from the
2793 configuration file (for example, &$qualify_domain$&) are available, but no
2794 message-specific values (such as &$sender_domain$&) are set, because no message
2795 is being processed (but see &%-bem%& and &%-Mset%&).
2796
2797 &*Note*&: If you use this mechanism to test lookups, and you change the data
2798 files or databases you are using, you must exit and restart Exim before trying
2799 the same lookup again. Otherwise, because each Exim process caches the results
2800 of lookups, you will just get the same result as before.
2801
2802 .vitem &%-bem%&&~<&'filename'&>
2803 .oindex "&%-bem%&"
2804 .cindex "testing" "string expansion"
2805 .cindex "expansion" "testing"
2806 This option operates like &%-be%& except that it must be followed by the name
2807 of a file. For example:
2808 .code
2809 exim -bem /tmp/testmessage
2810 .endd
2811 The file is read as a message (as if receiving a locally-submitted non-SMTP
2812 message) before any of the test expansions are done. Thus, message-specific
2813 variables such as &$message_size$& and &$header_from:$& are available. However,
2814 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2815 recipients are read from the headers in the normal way, and are shown in the
2816 &$recipients$& variable. Note that recipients cannot be given on the command
2817 line, because further arguments are taken as strings to expand (just like
2818 &%-be%&).
2819
2820 .vitem &%-bF%&&~<&'filename'&>
2821 .oindex "&%-bF%&"
2822 .cindex "system filter" "testing"
2823 .cindex "testing" "system filter"
2824 This option is the same as &%-bf%& except that it assumes that the filter being
2825 tested is a system filter. The additional commands that are available only in
2826 system filters are recognized.
2827
2828 .vitem &%-bf%&&~<&'filename'&>
2829 .oindex "&%-bf%&"
2830 .cindex "filter" "testing"
2831 .cindex "testing" "filter file"
2832 .cindex "forward file" "testing"
2833 .cindex "testing" "forward file"
2834 .cindex "Sieve filter" "testing"
2835 This option runs Exim in user filter testing mode; the file is the filter file
2836 to be tested, and a test message must be supplied on the standard input. If
2837 there are no message-dependent tests in the filter, an empty file can be
2838 supplied.
2839
2840 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2841 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2842 filter and a user filter in the same run. For example:
2843 .code
2844 exim -bF /system/filter -bf /user/filter </test/message
2845 .endd
2846 This is helpful when the system filter adds header lines or sets filter
2847 variables that are used by the user filter.
2848
2849 If the test filter file does not begin with one of the special lines
2850 .code
2851 # Exim filter
2852 # Sieve filter
2853 .endd
2854 it is taken to be a normal &_.forward_& file, and is tested for validity under
2855 that interpretation. See sections &<<SECTitenonfilred>>& to
2856 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2857 redirection lists.
2858
2859 The result of an Exim command that uses &%-bf%&, provided no errors are
2860 detected, is a list of the actions that Exim would try to take if presented
2861 with the message for real. More details of filter testing are given in the
2862 separate document entitled &'Exim's interfaces to mail filtering'&.
2863
2864 When testing a filter file,
2865 .cindex "&""From""& line"
2866 .cindex "envelope sender"
2867 .oindex "&%-f%&" "for filter testing"
2868 the envelope sender can be set by the &%-f%& option,
2869 or by a &"From&~"& line at the start of the test message. Various parameters
2870 that would normally be taken from the envelope recipient address of the message
2871 can be set by means of additional command line options (see the next four
2872 options).
2873
2874 .vitem &%-bfd%&&~<&'domain'&>
2875 .oindex "&%-bfd%&"
2876 .vindex "&$qualify_domain$&"
2877 This sets the domain of the recipient address when a filter file is being
2878 tested by means of the &%-bf%& option. The default is the value of
2879 &$qualify_domain$&.
2880
2881 .vitem &%-bfl%&&~<&'local&~part'&>
2882 .oindex "&%-bfl%&"
2883 This sets the local part of the recipient address when a filter file is being
2884 tested by means of the &%-bf%& option. The default is the username of the
2885 process that calls Exim. A local part should be specified with any prefix or
2886 suffix stripped, because that is how it appears to the filter when a message is
2887 actually being delivered.
2888
2889 .vitem &%-bfp%&&~<&'prefix'&>
2890 .oindex "&%-bfp%&"
2891 This sets the prefix of the local part of the recipient address when a filter
2892 file is being tested by means of the &%-bf%& option. The default is an empty
2893 prefix.
2894
2895 .vitem &%-bfs%&&~<&'suffix'&>
2896 .oindex "&%-bfs%&"
2897 This sets the suffix of the local part of the recipient address when a filter
2898 file is being tested by means of the &%-bf%& option. The default is an empty
2899 suffix.
2900
2901 .vitem &%-bh%&&~<&'IP&~address'&>
2902 .oindex "&%-bh%&"
2903 .cindex "testing" "incoming SMTP"
2904 .cindex "SMTP" "testing incoming"
2905 .cindex "testing" "relay control"
2906 .cindex "relaying" "testing configuration"
2907 .cindex "policy control" "testing"
2908 .cindex "debugging" "&%-bh%& option"
2909 This option runs a fake SMTP session as if from the given IP address, using the
2910 standard input and output. The IP address may include a port number at the end,
2911 after a full stop. For example:
2912 .code
2913 exim -bh 10.9.8.7.1234
2914 exim -bh fe80::a00:20ff:fe86:a061.5678
2915 .endd
2916 When an IPv6 address is given, it is converted into canonical form. In the case
2917 of the second example above, the value of &$sender_host_address$& after
2918 conversion to the canonical form is
2919 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2920
2921 Comments as to what is going on are written to the standard error file. These
2922 include lines beginning with &"LOG"& for anything that would have been logged.
2923 This facility is provided for testing configuration options for incoming
2924 messages, to make sure they implement the required policy. For example, you can
2925 test your relay controls using &%-bh%&.
2926
2927 &*Warning 1*&:
2928 .cindex "RFC 1413"
2929 You can test features of the configuration that rely on ident (RFC 1413)
2930 information by using the &%-oMt%& option. However, Exim cannot actually perform
2931 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2932 connection.
2933
2934 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2935 are also skipped when testing using &%-bh%&. If you want these callouts to
2936 occur, use &%-bhc%& instead.
2937
2938 Messages supplied during the testing session are discarded, and nothing is
2939 written to any of the real log files. There may be pauses when DNS (and other)
2940 lookups are taking place, and of course these may time out. The &%-oMi%& option
2941 can be used to specify a specific IP interface and port if this is important,
2942 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2943 session were authenticated.
2944
2945 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2946 output just states whether a given recipient address from a given host is
2947 acceptable or not. See section &<<SECTcheckaccess>>&.
2948
2949 Features such as authentication and encryption, where the client input is not
2950 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2951 specialized SMTP test program such as
2952 &url(http://jetmore.org/john/code/#swaks,swaks).
2953
2954 .vitem &%-bhc%&&~<&'IP&~address'&>
2955 .oindex "&%-bhc%&"
2956 This option operates in the same way as &%-bh%&, except that address
2957 verification callouts are performed if required. This includes consulting and
2958 updating the callout cache database.
2959
2960 .vitem &%-bi%&
2961 .oindex "&%-bi%&"
2962 .cindex "alias file" "building"
2963 .cindex "building alias file"
2964 .cindex "Sendmail compatibility" "&%-bi%& option"
2965 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2966 Exim does not have the concept of a single alias file, and so it cannot mimic
2967 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2968 tend to appear in various scripts such as NIS make files, so the option must be
2969 recognized.
2970
2971 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2972 configuration option is run, under the uid and gid of the caller of Exim. If
2973 the &%-oA%& option is used, its value is passed to the command as an argument.
2974 The command set by &%bi_command%& may not contain arguments. The command can
2975 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2976 if this is required. If the &%bi_command%& option is not set, calling Exim with
2977 &%-bi%& is a no-op.
2978
2979 . // Keep :help first, then the rest in alphabetical order
2980 .vitem &%-bI:help%&
2981 .oindex "&%-bI:help%&"
2982 .cindex "querying exim information"
2983 We shall provide various options starting &`-bI:`& for querying Exim for
2984 information.  The output of many of these will be intended for machine
2985 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2986 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2987 options shall cause Exim to exit after producing the requested output.
2988
2989 .vitem &%-bI:dscp%&
2990 .oindex "&%-bI:dscp%&"
2991 .cindex "DSCP" "values"
2992 This option causes Exim to emit an alphabetically sorted list of all
2993 recognised DSCP names.
2994
2995 .vitem &%-bI:sieve%&
2996 .oindex "&%-bI:sieve%&"
2997 .cindex "Sieve filter" "capabilities"
2998 This option causes Exim to emit an alphabetically sorted list of all supported
2999 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3000 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3001 &`SIEVE`& capability response line.  As the precise list may depend upon
3002 compile-time build options, which this option will adapt to, this is the only
3003 way to guarantee a correct response.
3004
3005 .vitem &%-bm%&
3006 .oindex "&%-bm%&"
3007 .cindex "local message reception"
3008 This option runs an Exim receiving process that accepts an incoming,
3009 locally-generated message on the standard input. The recipients are given as the
3010 command arguments (except when &%-t%& is also present &-- see below). Each
3011 argument can be a comma-separated list of RFC 2822 addresses. This is the
3012 default option for selecting the overall action of an Exim call; it is assumed
3013 if no other conflicting option is present.
3014
3015 If any addresses in the message are unqualified (have no domain), they are
3016 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3017 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3018 suppressing this for special cases.
3019
3020 Policy checks on the contents of local messages can be enforced by means of
3021 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3022
3023 .cindex "return code" "for &%-bm%&"
3024 The return code is zero if the message is successfully accepted. Otherwise, the
3025 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3026
3027 The format
3028 .cindex "message" "format"
3029 .cindex "format" "message"
3030 .cindex "&""From""& line"
3031 .cindex "UUCP" "&""From""& line"
3032 .cindex "Sendmail compatibility" "&""From""& line"
3033 of the message must be as defined in RFC 2822, except that, for
3034 compatibility with Sendmail and Smail, a line in one of the forms
3035 .code
3036 From sender Fri Jan  5 12:55 GMT 1997
3037 From sender Fri, 5 Jan 97 12:55:01
3038 .endd
3039 (with the weekday optional, and possibly with additional text after the date)
3040 is permitted to appear at the start of the message. There appears to be no
3041 authoritative specification of the format of this line. Exim recognizes it by
3042 matching against the regular expression defined by the &%uucp_from_pattern%&
3043 option, which can be changed if necessary.
3044
3045 .oindex "&%-f%&" "overriding &""From""& line"
3046 The specified sender is treated as if it were given as the argument to the
3047 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3048 preference to the address taken from the message. The caller of Exim must be a
3049 trusted user for the sender of a message to be set in this way.
3050
3051 .vitem &%-bmalware%&&~<&'filename'&>
3052 .oindex "&%-bmalware%&"
3053 .cindex "testing", "malware"
3054 .cindex "malware scan test"
3055 This debugging option causes Exim to scan the given file,
3056 using the malware scanning framework.  The option of &%av_scanner%& influences
3057 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3058 the expansion should have defaults which apply to this invocation.  ACLs are
3059 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3060 will never be populated and &%-bmalware%& will fail.
3061
3062 Exim will have changed working directory before resolving the filename, so
3063 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3064 user when it tries to open the file, rather than as the invoking user.
3065 This option requires admin privileges.
3066
3067 The &%-bmalware%& option will not be extended to be more generally useful,
3068 there are better tools for file-scanning.  This option exists to help
3069 administrators verify their Exim and AV scanner configuration.
3070
3071 .vitem &%-bnq%&
3072 .oindex "&%-bnq%&"
3073 .cindex "address qualification, suppressing"
3074 By default, Exim automatically qualifies unqualified addresses (those
3075 without domains) that appear in messages that are submitted locally (that
3076 is, not over TCP/IP). This qualification applies both to addresses in
3077 envelopes, and addresses in header lines. Sender addresses are qualified using
3078 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3079 defaults to the value of &%qualify_domain%&).
3080
3081 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3082 being used to re-submit messages that originally came from remote hosts after
3083 content scanning, you probably do not want to qualify unqualified addresses in
3084 header lines. (Such lines will be present only if you have not enabled a header
3085 syntax check in the appropriate ACL.)
3086
3087 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3088 messages that originate on the local host. When this is used, unqualified
3089 addresses in the envelope provoke errors (causing message rejection) and
3090 unqualified addresses in header lines are left alone.
3091
3092
3093 .vitem &%-bP%&
3094 .oindex "&%-bP%&"
3095 .cindex "configuration options" "extracting"
3096 .cindex "options" "configuration &-- extracting"
3097 If this option is given with no arguments, it causes the values of all Exim's
3098 main configuration options to be written to the standard output. The values
3099 of one or more specific options can be requested by giving their names as
3100 arguments, for example:
3101 .code
3102 exim -bP qualify_domain hold_domains
3103 .endd
3104 .cindex "hiding configuration option values"
3105 .cindex "configuration options" "hiding value of"
3106 .cindex "options" "hiding value of"
3107 However, any option setting that is preceded by the word &"hide"& in the
3108 configuration file is not shown in full, except to an admin user. For other
3109 users, the output is as in this example:
3110 .code
3111 mysql_servers = <value not displayable>
3112 .endd
3113 If &%configure_file%& is given as an argument, the name of the run time
3114 configuration file is output.
3115 If a list of configuration files was supplied, the value that is output here
3116 is the name of the file that was actually used.
3117
3118 .cindex "options" "hiding name of"
3119 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3120 name will not be output.
3121
3122 .cindex "daemon" "process id (pid)"
3123 .cindex "pid (process id)" "of daemon"
3124 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3125 directories where log files and daemon pid files are written are output,
3126 respectively. If these values are unset, log files are written in a
3127 sub-directory of the spool directory called &%log%&, and the pid file is
3128 written directly into the spool directory.
3129
3130 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3131 .code
3132 exim -bP +local_domains
3133 .endd
3134 it searches for a matching named list of any type (domain, host, address, or
3135 local part) and outputs what it finds.
3136
3137 .cindex "options" "router &-- extracting"
3138 .cindex "options" "transport &-- extracting"
3139 .cindex "options" "authenticator &-- extracting"
3140 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3141 followed by the name of an appropriate driver instance, the option settings for
3142 that driver are output. For example:
3143 .code
3144 exim -bP transport local_delivery
3145 .endd
3146 The generic driver options are output first, followed by the driver's private
3147 options. A list of the names of drivers of a particular type can be obtained by
3148 using one of the words &%router_list%&, &%transport_list%&, or
3149 &%authenticator_list%&, and a complete list of all drivers with their option
3150 settings can be obtained by using &%routers%&, &%transports%&, or
3151 &%authenticators%&.
3152
3153 .cindex "options" "macro &-- extracting"
3154 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3155 are available, similarly to the drivers.  Because macros are sometimes used
3156 for storing passwords, this option is restricted.
3157 The output format is one item per line.
3158
3159 .vitem &%-bp%&
3160 .oindex "&%-bp%&"
3161 .cindex "queue" "listing messages on"
3162 .cindex "listing" "messages on the queue"
3163 This option requests a listing of the contents of the mail queue on the
3164 standard output. If the &%-bp%& option is followed by a list of message ids,
3165 just those messages are listed. By default, this option can be used only by an
3166 admin user. However, the &%queue_list_requires_admin%& option can be set false
3167 to allow any user to see the queue.
3168
3169 Each message on the queue is displayed as in the following example:
3170 .code
3171 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3172           red.king@looking-glass.fict.example
3173           <other addresses>
3174 .endd
3175 .cindex "message" "size in queue listing"
3176 .cindex "size" "of message"
3177 The first line contains the length of time the message has been on the queue
3178 (in this case 25 minutes), the size of the message (2.9K), the unique local
3179 identifier for the message, and the message sender, as contained in the
3180 envelope. For bounce messages, the sender address is empty, and appears as
3181 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3182 the default sender address, the user's login name is shown in parentheses
3183 before the sender address.
3184
3185 .cindex "frozen messages" "in queue listing"
3186 If the message is frozen (attempts to deliver it are suspended) then the text
3187 &"*** frozen ***"& is displayed at the end of this line.
3188
3189 The recipients of the message (taken from the envelope, not the headers) are
3190 displayed on subsequent lines. Those addresses to which the message has already
3191 been delivered are marked with the letter D. If an original address gets
3192 expanded into several addresses via an alias or forward file, the original is
3193 displayed with a D only when deliveries for all of its child addresses are
3194 complete.
3195
3196
3197 .vitem &%-bpa%&
3198 .oindex "&%-bpa%&"
3199 This option operates like &%-bp%&, but in addition it shows delivered addresses
3200 that were generated from the original top level address(es) in each message by
3201 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3202 of just &"D"&.
3203
3204
3205 .vitem &%-bpc%&
3206 .oindex "&%-bpc%&"
3207 .cindex "queue" "count of messages on"
3208 This option counts the number of messages on the queue, and writes the total
3209 to the standard output. It is restricted to admin users, unless
3210 &%queue_list_requires_admin%& is set false.
3211
3212
3213 .vitem &%-bpr%&
3214 .oindex "&%-bpr%&"
3215 This option operates like &%-bp%&, but the output is not sorted into
3216 chronological order of message arrival. This can speed it up when there are
3217 lots of messages on the queue, and is particularly useful if the output is
3218 going to be post-processed in a way that doesn't need the sorting.
3219
3220 .vitem &%-bpra%&
3221 .oindex "&%-bpra%&"
3222 This option is a combination of &%-bpr%& and &%-bpa%&.
3223
3224 .vitem &%-bpru%&
3225 .oindex "&%-bpru%&"
3226 This option is a combination of &%-bpr%& and &%-bpu%&.
3227
3228
3229 .vitem &%-bpu%&
3230 .oindex "&%-bpu%&"
3231 This option operates like &%-bp%& but shows only undelivered top-level
3232 addresses for each message displayed. Addresses generated by aliasing or
3233 forwarding are not shown, unless the message was deferred after processing by a
3234 router with the &%one_time%& option set.
3235
3236
3237 .vitem &%-brt%&
3238 .oindex "&%-brt%&"
3239 .cindex "testing" "retry configuration"
3240 .cindex "retry" "configuration testing"
3241 This option is for testing retry rules, and it must be followed by up to three
3242 arguments. It causes Exim to look for a retry rule that matches the values
3243 and to write it to the standard output. For example:
3244 .code
3245 exim -brt bach.comp.mus.example
3246 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3247 .endd
3248 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3249 argument, which is required, can be a complete address in the form
3250 &'local_part@domain'&, or it can be just a domain name. If the second argument
3251 contains a dot, it is interpreted as an optional second domain name; if no
3252 retry rule is found for the first argument, the second is tried. This ties in
3253 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3254 rule is found that matches the host, one that matches the mail domain is
3255 sought. Finally, an argument that is the name of a specific delivery error, as
3256 used in setting up retry rules, can be given. For example:
3257 .code
3258 exim -brt haydn.comp.mus.example quota_3d
3259 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3260 .endd
3261
3262 .vitem &%-brw%&
3263 .oindex "&%-brw%&"
3264 .cindex "testing" "rewriting"
3265 .cindex "rewriting" "testing"
3266 This option is for testing address rewriting rules, and it must be followed by
3267 a single argument, consisting of either a local part without a domain, or a
3268 complete address with a fully qualified domain. Exim outputs how this address
3269 would be rewritten for each possible place it might appear. See chapter
3270 &<<CHAPrewrite>>& for further details.
3271
3272 .vitem &%-bS%&
3273 .oindex "&%-bS%&"
3274 .cindex "SMTP" "batched incoming"
3275 .cindex "batched SMTP input"
3276 This option is used for batched SMTP input, which is an alternative interface
3277 for non-interactive local message submission. A number of messages can be
3278 submitted in a single run. However, despite its name, this is not really SMTP
3279 input. Exim reads each message's envelope from SMTP commands on the standard
3280 input, but generates no responses. If the caller is trusted, or
3281 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3282 believed; otherwise the sender is always the caller of Exim.
3283
3284 The message itself is read from the standard input, in SMTP format (leading
3285 dots doubled), terminated by a line containing just a single dot. An error is
3286 provoked if the terminating dot is missing. A further message may then follow.
3287
3288 As for other local message submissions, the contents of incoming batch SMTP
3289 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3290 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3291 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3292
3293 Some other SMTP commands are recognized in the input. HELO and EHLO act
3294 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3295 QUIT quits, ignoring the rest of the standard input.
3296
3297 .cindex "return code" "for &%-bS%&"
3298 If any error is encountered, reports are written to the standard output and
3299 error streams, and Exim gives up immediately. The return code is 0 if no error
3300 was detected; it is 1 if one or more messages were accepted before the error
3301 was detected; otherwise it is 2.
3302
3303 More details of input using batched SMTP are given in section
3304 &<<SECTincomingbatchedSMTP>>&.
3305
3306 .vitem &%-bs%&
3307 .oindex "&%-bs%&"
3308 .cindex "SMTP" "local input"
3309 .cindex "local SMTP input"
3310 This option causes Exim to accept one or more messages by reading SMTP commands
3311 on the standard input, and producing SMTP replies on the standard output. SMTP
3312 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3313 Some user agents use this interface as a way of passing locally-generated
3314 messages to the MTA.
3315
3316 In
3317 .cindex "sender" "source of"
3318 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3319 set, the senders of messages are taken from the SMTP MAIL commands.
3320 Otherwise the content of these commands is ignored and the sender is set up as
3321 the calling user. Unqualified addresses are automatically qualified using
3322 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3323 &%-bnq%& option is used.
3324
3325 .cindex "inetd"
3326 The
3327 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3328 using a listening daemon. Exim can distinguish the two cases by checking
3329 whether the standard input is a TCP/IP socket. When Exim is called from
3330 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3331 above concerning senders and qualification do not apply. In this situation,
3332 Exim behaves in exactly the same way as it does when receiving a message via
3333 the listening daemon.
3334
3335 .vitem &%-bt%&
3336 .oindex "&%-bt%&"
3337 .cindex "testing" "addresses"
3338 .cindex "address" "testing"
3339 This option runs Exim in address testing mode, in which each argument is taken
3340 as a recipient address to be tested for deliverability. The results are
3341 written to the standard output. If a test fails, and the caller is not an admin
3342 user, no details of the failure are output, because these might contain
3343 sensitive information such as usernames and passwords for database lookups.
3344
3345 If no arguments are given, Exim runs in an interactive manner, prompting with a
3346 right angle bracket for addresses to be tested.
3347
3348 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3349 &[readline()]& function, because it is running as &'root'& and there are
3350 security issues.
3351
3352 Each address is handled as if it were the recipient address of a message
3353 (compare the &%-bv%& option). It is passed to the routers and the result is
3354 written to the standard output. However, any router that has
3355 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3356 genuine routing tests if your first router passes everything to a scanner
3357 program.
3358
3359 .cindex "return code" "for &%-bt%&"
3360 The return code is 2 if any address failed outright; it is 1 if no address
3361 failed outright but at least one could not be resolved for some reason. Return
3362 code 0 is given only when all addresses succeed.
3363
3364 .cindex "duplicate addresses"
3365 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3366 addresses after routing is complete, so that only one delivery takes place.
3367 This does not happen when testing with &%-bt%&; the full results of routing are
3368 always shown.
3369
3370 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3371 routers in the configuration makes any tests on the sender address of a
3372 message,
3373 .oindex "&%-f%&" "for address testing"
3374 you can use the &%-f%& option to set an appropriate sender when running
3375 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3376 default qualifying domain. However, if you have set up (for example) routers
3377 whose behaviour depends on the contents of an incoming message, you cannot test
3378 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3379 doing such tests.
3380
3381 .vitem &%-bV%&
3382 .oindex "&%-bV%&"
3383 .cindex "version number of Exim"
3384 This option causes Exim to write the current version number, compilation
3385 number, and compilation date of the &'exim'& binary to the standard output.
3386 It also lists the DBM library that is being used, the optional modules (such as
3387 specific lookup types), the drivers that are included in the binary, and the
3388 name of the run time configuration file that is in use.
3389
3390 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3391 configuration file. However, this is a static check only. It cannot check
3392 values that are to be expanded. For example, although a misspelt ACL verb is
3393 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3394 alone to discover (for example) all the typos in the configuration; some
3395 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3396 dynamic testing facilities.
3397
3398 .vitem &%-bv%&
3399 .oindex "&%-bv%&"
3400 .cindex "verifying address" "using &%-bv%&"
3401 .cindex "address" "verification"
3402 This option runs Exim in address verification mode, in which each argument is
3403 taken as a recipient address to be verified by the routers. (This does
3404 not involve any verification callouts). During normal operation, verification
3405 happens mostly as a consequence processing a &%verify%& condition in an ACL
3406 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3407 including callouts, see the &%-bh%& and &%-bhc%& options.
3408
3409 If verification fails, and the caller is not an admin user, no details of the
3410 failure are output, because these might contain sensitive information such as
3411 usernames and passwords for database lookups.
3412
3413 If no arguments are given, Exim runs in an interactive manner, prompting with a
3414 right angle bracket for addresses to be verified.
3415
3416 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3417 &[readline()]& function, because it is running as &'exim'& and there are
3418 security issues.
3419
3420 Verification differs from address testing (the &%-bt%& option) in that routers
3421 that have &%no_verify%& set are skipped, and if the address is accepted by a
3422 router that has &%fail_verify%& set, verification fails. The address is
3423 verified as a recipient if &%-bv%& is used; to test verification for a sender
3424 address, &%-bvs%& should be used.
3425
3426 If the &%-v%& option is not set, the output consists of a single line for each
3427 address, stating whether it was verified or not, and giving a reason in the
3428 latter case. Without &%-v%&, generating more than one address by redirection
3429 causes verification to end successfully, without considering the generated
3430 addresses. However, if just one address is generated, processing continues,
3431 and the generated address must verify successfully for the overall verification
3432 to succeed.
3433
3434 When &%-v%& is set, more details are given of how the address has been handled,
3435 and in the case of address redirection, all the generated addresses are also
3436 considered. Verification may succeed for some and fail for others.
3437
3438 The
3439 .cindex "return code" "for &%-bv%&"
3440 return code is 2 if any address failed outright; it is 1 if no address
3441 failed outright but at least one could not be resolved for some reason. Return
3442 code 0 is given only when all addresses succeed.
3443
3444 If any of the routers in the configuration makes any tests on the sender
3445 address of a message, you should use the &%-f%& option to set an appropriate
3446 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3447 calling user at the default qualifying domain.
3448
3449 .vitem &%-bvs%&
3450 .oindex "&%-bvs%&"
3451 This option acts like &%-bv%&, but verifies the address as a sender rather
3452 than a recipient address. This affects any rewriting and qualification that
3453 might happen.
3454
3455 .vitem &%-bw%&
3456 .oindex "&%-bw%&"
3457 .cindex "daemon"
3458 .cindex "inetd"
3459 .cindex "inetd" "wait mode"
3460 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3461 similarly to the &%-bd%& option.  All port specifications on the command-line
3462 and in the configuration file are ignored.  Queue-running may not be specified.
3463
3464 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3465 listening for connections.  This permits the system to start up and have
3466 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3467 each port only when the first connection is received.
3468
3469 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3470 which the daemon will exit, which should cause inetd to listen once more.
3471
3472 .vitem &%-C%&&~<&'filelist'&>
3473 .oindex "&%-C%&"
3474 .cindex "configuration file" "alternate"
3475 .cindex "CONFIGURE_FILE"
3476 .cindex "alternate configuration file"
3477 This option causes Exim to find the run time configuration file from the given
3478 list instead of from the list specified by the CONFIGURE_FILE
3479 compile-time setting. Usually, the list will consist of just a single file
3480 name, but it can be a colon-separated list of names. In this case, the first
3481 file that exists is used. Failure to open an existing file stops Exim from
3482 proceeding any further along the list, and an error is generated.
3483
3484 When this option is used by a caller other than root, and the list is different
3485 from the compiled-in list, Exim gives up its root privilege immediately, and
3486 runs with the real and effective uid and gid set to those of the caller.
3487 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3488 file contains a list of full pathnames, one per line, for configuration files
3489 which are trusted. Root privilege is retained for any configuration file so
3490 listed, as long as the caller is the Exim user (or the user specified in the
3491 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3492 not writeable by inappropriate users or groups.
3493
3494 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3495 configuration using &%-C%& right through message reception and delivery,
3496 even if the caller is root. The reception works, but by that time, Exim is
3497 running as the Exim user, so when it re-executes to regain privilege for the
3498 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3499 test reception and delivery using two separate commands (one to put a message
3500 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3501
3502 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3503 prefix string with which any file named in a &%-C%& command line option
3504 must start. In addition, the file name must not contain the sequence &`/../`&.
3505 However, if the value of the &%-C%& option is identical to the value of
3506 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3507 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3508 unset, any file name can be used with &%-C%&.
3509
3510 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3511 to a directory to which only root has access. This prevents someone who has
3512 broken into the Exim account from running a privileged Exim with an arbitrary
3513 configuration file.
3514
3515 The &%-C%& facility is useful for ensuring that configuration files are
3516 syntactically correct, but cannot be used for test deliveries, unless the
3517 caller is privileged, or unless it is an exotic configuration that does not
3518 require privilege. No check is made on the owner or group of the files
3519 specified by this option.
3520
3521
3522 .vitem &%-D%&<&'macro'&>=<&'value'&>
3523 .oindex "&%-D%&"
3524 .cindex "macro" "setting on command line"
3525 This option can be used to override macro definitions in the configuration file
3526 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3527 unprivileged caller, it causes Exim to give up its root privilege.
3528 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3529 completely disabled, and its use causes an immediate error exit.
3530
3531 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3532 colon-separated list of macros which are considered safe and, if &%-D%& only
3533 supplies macros from this list, and the values are acceptable, then Exim will
3534 not give up root privilege if the caller is root, the Exim run-time user, or
3535 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3536 to be removed in the future.  Acceptable values for the macros satisfy the
3537 regexp: &`^[A-Za-z0-9_/.-]*$`&
3538
3539 The entire option (including equals sign if present) must all be within one
3540 command line item. &%-D%& can be used to set the value of a macro to the empty
3541 string, in which case the equals sign is optional. These two commands are
3542 synonymous:
3543 .code
3544 exim -DABC  ...
3545 exim -DABC= ...
3546 .endd
3547 To include spaces in a macro definition item, quotes must be used. If you use
3548 quotes, spaces are permitted around the macro name and the equals sign. For
3549 example:
3550 .code
3551 exim '-D ABC = something' ...
3552 .endd
3553 &%-D%& may be repeated up to 10 times on a command line.
3554
3555
3556 .vitem &%-d%&<&'debug&~options'&>
3557 .oindex "&%-d%&"
3558 .cindex "debugging" "list of selectors"
3559 .cindex "debugging" "&%-d%& option"
3560 This option causes debugging information to be written to the standard
3561 error stream. It is restricted to admin users because debugging output may show
3562 database queries that contain password information. Also, the details of users'
3563 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3564 writes an error message to the standard error stream and exits with a non-zero
3565 return code.
3566
3567 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3568 standard debugging data is output. This can be reduced, or increased to include
3569 some more rarely needed information, by directly following &%-d%& with a string
3570 made up of names preceded by plus or minus characters. These add or remove sets
3571 of debugging data, respectively. For example, &%-d+filter%& adds filter
3572 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3573 no spaces are allowed in the debug setting. The available debugging categories
3574 are:
3575 .display
3576 &`acl            `& ACL interpretation
3577 &`auth           `& authenticators
3578 &`deliver        `& general delivery logic
3579 &`dns            `& DNS lookups (see also resolver)
3580 &`dnsbl          `& DNS black list (aka RBL) code
3581 &`exec           `& arguments for &[execv()]& calls
3582 &`expand         `& detailed debugging for string expansions
3583 &`filter         `& filter handling
3584 &`hints_lookup   `& hints data lookups
3585 &`host_lookup    `& all types of name-to-IP address handling
3586 &`ident          `& ident lookup
3587 &`interface      `& lists of local interfaces
3588 &`lists          `& matching things in lists
3589 &`load           `& system load checks
3590 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3591                     &<<CHAPlocalscan>>&)
3592 &`lookup         `& general lookup code and all lookups
3593 &`memory         `& memory handling
3594 &`pid            `& add pid to debug output lines
3595 &`process_info   `& setting info for the process log
3596 &`queue_run      `& queue runs
3597 &`receive        `& general message reception logic
3598 &`resolver       `& turn on the DNS resolver's debugging output
3599 &`retry          `& retry handling
3600 &`rewrite        `& address rewriting
3601 &`route          `& address routing
3602 &`timestamp      `& add timestamp to debug output lines
3603 &`tls            `& TLS logic
3604 &`transport      `& transports
3605 &`uid            `& changes of uid/gid and looking up uid/gid
3606 &`verify         `& address verification logic
3607 &`all            `& almost all of the above (see below), and also &%-v%&
3608 .endd
3609 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3610 for &`-all`&. The reason for this is that &`+all`& is something that people
3611 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3612 is included, an awful lot of output that is very rarely of interest is
3613 generated, so it now has to be explicitly requested. However, &`-all`& does
3614 turn everything off.
3615
3616 .cindex "resolver, debugging output"
3617 .cindex "DNS resolver, debugging output"
3618 The &`resolver`& option produces output only if the DNS resolver was compiled
3619 with DEBUG enabled. This is not the case in some operating systems. Also,
3620 unfortunately, debugging output from the DNS resolver is written to stdout
3621 rather than stderr.
3622
3623 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3624 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3625 However, the &`pid`& selector is forced when debugging is turned on for a
3626 daemon, which then passes it on to any re-executed Exims. Exim also
3627 automatically adds the pid to debug lines when several remote deliveries are
3628 run in parallel.
3629
3630 The &`timestamp`& selector causes the current time to be inserted at the start
3631 of all debug output lines. This can be useful when trying to track down delays
3632 in processing.
3633
3634 If the &%debug_print%& option is set in any driver, it produces output whenever
3635 any debugging is selected, or if &%-v%& is used.
3636
3637 .vitem &%-dd%&<&'debug&~options'&>
3638 .oindex "&%-dd%&"
3639 This option behaves exactly like &%-d%& except when used on a command that
3640 starts a daemon process. In that case, debugging is turned off for the
3641 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3642 behaviour of the daemon without creating as much output as full debugging does.
3643
3644 .vitem &%-dropcr%&
3645 .oindex "&%-dropcr%&"
3646 This is an obsolete option that is now a no-op. It used to affect the way Exim
3647 handled CR and LF characters in incoming messages. What happens now is
3648 described in section &<<SECTlineendings>>&.
3649
3650 .vitem &%-E%&
3651 .oindex "&%-E%&"
3652 .cindex "bounce message" "generating"
3653 This option specifies that an incoming message is a locally-generated delivery
3654 failure report. It is used internally by Exim when handling delivery failures
3655 and is not intended for external use. Its only effect is to stop Exim
3656 generating certain messages to the postmaster, as otherwise message cascades
3657 could occur in some situations. As part of the same option, a message id may
3658 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3659 new message contains the id, following &"R="&, as a cross-reference.
3660
3661 .vitem &%-e%&&'x'&
3662 .oindex "&%-e%&&'x'&"
3663 There are a number of Sendmail options starting with &%-oe%& which seem to be
3664 called by various programs without the leading &%o%& in the option. For
3665 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3666 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3667
3668 .vitem &%-F%&&~<&'string'&>
3669 .oindex "&%-F%&"
3670 .cindex "sender" "name"
3671 .cindex "name" "of sender"
3672 This option sets the sender's full name for use when a locally-generated
3673 message is being accepted. In the absence of this option, the user's &'gecos'&
3674 entry from the password data is used. As users are generally permitted to alter
3675 their &'gecos'& entries, no security considerations are involved. White space
3676 between &%-F%& and the <&'string'&> is optional.
3677
3678 .vitem &%-f%&&~<&'address'&>
3679 .oindex "&%-f%&"
3680 .cindex "sender" "address"
3681 .cindex "address" "sender"
3682 .cindex "trusted users"
3683 .cindex "envelope sender"
3684 .cindex "user" "trusted"
3685 This option sets the address of the envelope sender of a locally-generated
3686 message (also known as the return path). The option can normally be used only
3687 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3688 users to use it.
3689
3690 Processes running as root or the Exim user are always trusted. Other
3691 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3692 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3693 of a local message is set to the caller's login name at the default qualify
3694 domain.
3695
3696 There is one exception to the restriction on the use of &%-f%&: an empty sender
3697 can be specified by any user, trusted or not, to create a message that can
3698 never provoke a bounce. An empty sender can be specified either as an empty
3699 string, or as a pair of angle brackets with nothing between them, as in these
3700 examples of shell commands:
3701 .code
3702 exim -f '<>' user@domain
3703 exim -f "" user@domain
3704 .endd
3705 In addition, the use of &%-f%& is not restricted when testing a filter file
3706 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3707 &%-bv%& options.
3708
3709 Allowing untrusted users to change the sender address does not of itself make
3710 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3711 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3712 though this can be overridden by setting &%no_local_from_check%&.
3713
3714 White
3715 .cindex "&""From""& line"
3716 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3717 given as two arguments or one combined argument). The sender of a
3718 locally-generated message can also be set (when permitted) by an initial
3719 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3720 if &%-f%& is also present, it overrides &"From&~"&.
3721
3722 .vitem &%-G%&
3723 .oindex "&%-G%&"
3724 .cindex "submission fixups, suppressing (command-line)"
3725 This option is equivalent to an ACL applying:
3726 .code
3727 control = suppress_local_fixups
3728 .endd
3729 for every message received.  Note that Sendmail will complain about such
3730 bad formatting, where Exim silently just does not fix it up.  This may change
3731 in future.
3732
3733 As this affects audit information, the caller must be a trusted user to use
3734 this option.
3735
3736 .vitem &%-h%&&~<&'number'&>
3737 .oindex "&%-h%&"
3738 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3739 This option is accepted for compatibility with Sendmail, but has no effect. (In
3740 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3741 headers.)
3742
3743 .vitem &%-i%&
3744 .oindex "&%-i%&"
3745 .cindex "Solaris" "&'mail'& command"
3746 .cindex "dot" "in incoming non-SMTP message"
3747 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3748 line by itself should not terminate an incoming, non-SMTP message. I can find
3749 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3750 command in Solaris 2.4 uses it. See also &%-ti%&.
3751
3752 .vitem &%-L%&&~<&'tag'&>
3753 .oindex "&%-L%&"
3754 .cindex "syslog" "process name; set with flag"
3755 This option is equivalent to setting &%syslog_processname%& in the config
3756 file and setting &%log_file_path%& to &`syslog`&.
3757 Its use is restricted to administrators.  The configuration file has to be
3758 read and parsed, to determine access rights, before this is set and takes
3759 effect, so early configuration file errors will not honour this flag.
3760
3761 The tag should not be longer than 32 characters.
3762
3763 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3764 .oindex "&%-M%&"
3765 .cindex "forcing delivery"
3766 .cindex "delivery" "forcing attempt"
3767 .cindex "frozen messages" "forcing delivery"
3768 This option requests Exim to run a delivery attempt on each message in turn. If
3769 any of the messages are frozen, they are automatically thawed before the
3770 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3771 and &%hold_domains%& are ignored.
3772
3773 Retry
3774 .cindex "hints database" "overriding retry hints"
3775 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3776 the normal retry time has not yet been reached. This option requires the caller
3777 to be an admin user. However, there is an option called &%prod_requires_admin%&
3778 which can be set false to relax this restriction (and also the same requirement
3779 for the &%-q%&, &%-R%&, and &%-S%& options).
3780
3781 The deliveries happen synchronously, that is, the original Exim process does
3782 not terminate until all the delivery attempts have finished. No output is
3783 produced unless there is a serious error. If you want to see what is happening,
3784 use the &%-v%& option as well, or inspect Exim's main log.
3785
3786 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3787 .oindex "&%-Mar%&"
3788 .cindex "message" "adding recipients"
3789 .cindex "recipient" "adding"
3790 This option requests Exim to add the addresses to the list of recipients of the
3791 message (&"ar"& for &"add recipients"&). The first argument must be a message
3792 id, and the remaining ones must be email addresses. However, if the message is
3793 active (in the middle of a delivery attempt), it is not altered. This option
3794 can be used only by an admin user.
3795
3796 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3797         &~<&'message&~id'&>"
3798 .oindex "&%-MC%&"
3799 .cindex "SMTP" "passed connection"
3800 .cindex "SMTP" "multiple deliveries"
3801 .cindex "multiple SMTP deliveries"
3802 This option is not intended for use by external callers. It is used internally
3803 by Exim to invoke another instance of itself to deliver a waiting message using
3804 an existing SMTP connection, which is passed as the standard input. Details are
3805 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3806 must be root or the Exim user in order to use it.
3807
3808 .vitem &%-MCA%&
3809 .oindex "&%-MCA%&"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim in conjunction with the &%-MC%& option. It signifies that the
3812 connection to the remote host has been authenticated.
3813
3814 .vitem &%-MCD%&
3815 .oindex "&%-MCD%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option. It signifies that the
3818 remote host supports the ESMTP &_DSN_& extension.
3819
3820 .vitem &%-MCP%&
3821 .oindex "&%-MCP%&"
3822 This option is not intended for use by external callers. It is used internally
3823 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3824 which Exim is connected supports pipelining.
3825
3826 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3827 .oindex "&%-MCQ%&"
3828 This option is not intended for use by external callers. It is used internally
3829 by Exim in conjunction with the &%-MC%& option when the original delivery was
3830 started by a queue runner. It passes on the process id of the queue runner,
3831 together with the file descriptor number of an open pipe. Closure of the pipe
3832 signals the final completion of the sequence of processes that are passing
3833 messages through the same SMTP connection.
3834
3835 .vitem &%-MCS%&
3836 .oindex "&%-MCS%&"
3837 This option is not intended for use by external callers. It is used internally
3838 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3839 SMTP SIZE option should be used on messages delivered down the existing
3840 connection.
3841
3842 .vitem &%-MCT%&
3843 .oindex "&%-MCT%&"
3844 This option is not intended for use by external callers. It is used internally
3845 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3846 host to which Exim is connected supports TLS encryption.
3847
3848 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3849 .oindex "&%-Mc%&"
3850 .cindex "hints database" "not overridden by &%-Mc%&"
3851 .cindex "delivery" "manually started &-- not forced"
3852 This option requests Exim to run a delivery attempt on each message in turn,
3853 but unlike the &%-M%& option, it does check for retry hints, and respects any
3854 that are found. This option is not very useful to external callers. It is
3855 provided mainly for internal use by Exim when it needs to re-invoke itself in
3856 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3857 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3858 respects retry times and other options such as &%hold_domains%& that are
3859 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3860 If you want to run a specific delivery as if in a queue run, you should use
3861 &%-q%& with a message id argument. A distinction between queue run deliveries
3862 and other deliveries is made in one or two places.
3863
3864 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3865 .oindex "&%-Mes%&"
3866 .cindex "message" "changing sender"
3867 .cindex "sender" "changing"
3868 This option requests Exim to change the sender address in the message to the
3869 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3870 &"edit sender"&). There must be exactly two arguments. The first argument must
3871 be a message id, and the second one an email address. However, if the message
3872 is active (in the middle of a delivery attempt), its status is not altered.
3873 This option can be used only by an admin user.
3874
3875 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3876 .oindex "&%-Mf%&"
3877 .cindex "freezing messages"
3878 .cindex "message" "manually freezing"
3879 This option requests Exim to mark each listed message as &"frozen"&. This
3880 prevents any delivery attempts taking place until the message is &"thawed"&,
3881 either manually or as a result of the &%auto_thaw%& configuration option.
3882 However, if any of the messages are active (in the middle of a delivery
3883 attempt), their status is not altered. This option can be used only by an admin
3884 user.
3885
3886 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3887 .oindex "&%-Mg%&"
3888 .cindex "giving up on messages"
3889 .cindex "message" "abandoning delivery attempts"
3890 .cindex "delivery" "abandoning further attempts"
3891 This option requests Exim to give up trying to deliver the listed messages,
3892 including any that are frozen. However, if any of the messages are active,
3893 their status is not altered. For non-bounce messages, a delivery error message
3894 is sent to the sender, containing the text &"cancelled by administrator"&.
3895 Bounce messages are just discarded. This option can be used only by an admin
3896 user.
3897
3898 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3899 .oindex "&%-Mmad%&"
3900 .cindex "delivery" "cancelling all"
3901 This option requests Exim to mark all the recipient addresses in the messages
3902 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3903 message is active (in the middle of a delivery attempt), its status is not
3904 altered. This option can be used only by an admin user.
3905
3906 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3907 .oindex "&%-Mmd%&"
3908 .cindex "delivery" "cancelling by address"
3909 .cindex "recipient" "removing"
3910 .cindex "removing recipients"
3911 This option requests Exim to mark the given addresses as already delivered
3912 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3913 the remaining ones must be email addresses. These are matched to recipient
3914 addresses in the message in a case-sensitive manner. If the message is active
3915 (in the middle of a delivery attempt), its status is not altered. This option
3916 can be used only by an admin user.
3917
3918 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3919 .oindex "&%-Mrm%&"
3920 .cindex "removing messages"
3921 .cindex "abandoning mail"
3922 .cindex "message" "manually discarding"
3923 This option requests Exim to remove the given messages from the queue. No
3924 bounce messages are sent; each message is simply forgotten. However, if any of
3925 the messages are active, their status is not altered. This option can be used
3926 only by an admin user or by the user who originally caused the message to be
3927 placed on the queue.
3928
3929 .vitem &%-Mset%&&~<&'message&~id'&>
3930 .oindex "&%-Mset%&
3931 .cindex "testing" "string expansion"
3932 .cindex "expansion" "testing"
3933 This option is useful only in conjunction with &%-be%& (that is, when testing
3934 string expansions). Exim loads the given message from its spool before doing
3935 the test expansions, thus setting message-specific variables such as
3936 &$message_size$& and the header variables. The &$recipients$& variable is made
3937 available. This feature is provided to make it easier to test expansions that
3938 make use of these variables. However, this option can be used only by an admin
3939 user. See also &%-bem%&.
3940
3941 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3942 .oindex "&%-Mt%&"
3943 .cindex "thawing messages"
3944 .cindex "unfreezing messages"
3945 .cindex "frozen messages" "thawing"
3946 .cindex "message" "thawing frozen"
3947 This option requests Exim to &"thaw"& any of the listed messages that are
3948 &"frozen"&, so that delivery attempts can resume. However, if any of the
3949 messages are active, their status is not altered. This option can be used only
3950 by an admin user.
3951
3952 .vitem &%-Mvb%&&~<&'message&~id'&>
3953 .oindex "&%-Mvb%&"
3954 .cindex "listing" "message body"
3955 .cindex "message" "listing body of"
3956 This option causes the contents of the message body (-D) spool file to be
3957 written to the standard output. This option can be used only by an admin user.
3958
3959 .vitem &%-Mvc%&&~<&'message&~id'&>
3960 .oindex "&%-Mvc%&"
3961 .cindex "message" "listing in RFC 2822 format"
3962 .cindex "listing" "message in RFC 2822 format"
3963 This option causes a copy of the complete message (header lines plus body) to
3964 be written to the standard output in RFC 2822 format. This option can be used
3965 only by an admin user.
3966
3967 .vitem &%-Mvh%&&~<&'message&~id'&>
3968 .oindex "&%-Mvh%&"
3969 .cindex "listing" "message headers"
3970 .cindex "header lines" "listing"
3971 .cindex "message" "listing header lines"
3972 This option causes the contents of the message headers (-H) spool file to be
3973 written to the standard output. This option can be used only by an admin user.
3974
3975 .vitem &%-Mvl%&&~<&'message&~id'&>
3976 .oindex "&%-Mvl%&"
3977 .cindex "listing" "message log"
3978 .cindex "message" "listing message log"
3979 This option causes the contents of the message log spool file to be written to
3980 the standard output. This option can be used only by an admin user.
3981
3982 .vitem &%-m%&
3983 .oindex "&%-m%&"
3984 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3985 treats it that way too.
3986
3987 .vitem &%-N%&
3988 .oindex "&%-N%&"
3989 .cindex "debugging" "&%-N%& option"
3990 .cindex "debugging" "suppressing delivery"
3991 This is a debugging option that inhibits delivery of a message at the transport
3992 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3993 it just doesn't actually transport the message, but instead behaves as if it
3994 had successfully done so. However, it does not make any updates to the retry
3995 database, and the log entries for deliveries are flagged with &"*>"& rather
3996 than &"=>"&.
3997
3998 Because &%-N%& discards any message to which it applies, only root or the Exim
3999 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4000 words, an ordinary user can use it only when supplying an incoming message to
4001 which it will apply. Although transportation never fails when &%-N%& is set, an
4002 address may be deferred because of a configuration problem on a transport, or a
4003 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4004 the message, and applies to any subsequent delivery attempts that may happen
4005 for that message.
4006
4007 .vitem &%-n%&
4008 .oindex "&%-n%&"
4009 This option is interpreted by Sendmail to mean &"no aliasing"&.
4010 For normal modes of operation, it is ignored by Exim.
4011 When combined with &%-bP%& it suppresses the name of an option from being output.
4012
4013 .vitem &%-O%&&~<&'data'&>
4014 .oindex "&%-O%&"
4015 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4016 Exim.
4017
4018 .vitem &%-oA%&&~<&'file&~name'&>
4019 .oindex "&%-oA%&"
4020 .cindex "Sendmail compatibility" "&%-oA%& option"
4021 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4022 alternative alias file name. Exim handles &%-bi%& differently; see the
4023 description above.
4024
4025 .vitem &%-oB%&&~<&'n'&>
4026 .oindex "&%-oB%&"
4027 .cindex "SMTP" "passed connection"
4028 .cindex "SMTP" "multiple deliveries"
4029 .cindex "multiple SMTP deliveries"
4030 This is a debugging option which limits the maximum number of messages that can
4031 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4032 transport. If <&'n'&> is omitted, the limit is set to 1.
4033
4034 .vitem &%-odb%&
4035 .oindex "&%-odb%&"
4036 .cindex "background delivery"
4037 .cindex "delivery" "in the background"
4038 This option applies to all modes in which Exim accepts incoming messages,
4039 including the listening daemon. It requests &"background"& delivery of such
4040 messages, which means that the accepting process automatically starts a
4041 delivery process for each message received, but does not wait for the delivery
4042 processes to finish.
4043
4044 When all the messages have been received, the reception process exits,
4045 leaving the delivery processes to finish in their own time. The standard output
4046 and error streams are closed at the start of each delivery process.
4047 This is the default action if none of the &%-od%& options are present.
4048
4049 If one of the queueing options in the configuration file
4050 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4051 overrides it if &%queue_only_override%& is set true, which is the default
4052 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4053
4054 .vitem &%-odf%&
4055 .oindex "&%-odf%&"
4056 .cindex "foreground delivery"
4057 .cindex "delivery" "in the foreground"
4058 This option requests &"foreground"& (synchronous) delivery when Exim has
4059 accepted a locally-generated message. (For the daemon it is exactly the same as
4060 &%-odb%&.) A delivery process is automatically started to deliver the message,
4061 and Exim waits for it to complete before proceeding.
4062
4063 The original Exim reception process does not finish until the delivery
4064 process for the final message has ended. The standard error stream is left open
4065 during deliveries.
4066
4067 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4068 false and one of the queueing options in the configuration file is in effect.
4069
4070 If there is a temporary delivery error during foreground delivery, the
4071 message is left on the queue for later delivery, and the original reception
4072 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4073 restricted configuration that never queues messages.
4074
4075
4076 .vitem &%-odi%&
4077 .oindex "&%-odi%&"
4078 This option is synonymous with &%-odf%&. It is provided for compatibility with
4079 Sendmail.
4080
4081 .vitem &%-odq%&
4082 .oindex "&%-odq%&"
4083 .cindex "non-immediate delivery"
4084 .cindex "delivery" "suppressing immediate"
4085 .cindex "queueing incoming messages"
4086 This option applies to all modes in which Exim accepts incoming messages,
4087 including the listening daemon. It specifies that the accepting process should
4088 not automatically start a delivery process for each message received. Messages
4089 are placed on the queue, and remain there until a subsequent queue runner
4090 process encounters them. There are several configuration options (such as
4091 &%queue_only%&) that can be used to queue incoming messages under certain
4092 conditions. This option overrides all of them and also &%-odqs%&. It always
4093 forces queueing.
4094
4095 .vitem &%-odqs%&
4096 .oindex "&%-odqs%&"
4097 .cindex "SMTP" "delaying delivery"
4098 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4099 However, like &%-odb%& and &%-odi%&, this option has no effect if
4100 &%queue_only_override%& is false and one of the queueing options in the
4101 configuration file is in effect.
4102
4103 When &%-odqs%& does operate, a delivery process is started for each incoming
4104 message, in the background by default, but in the foreground if &%-odi%& is
4105 also present. The recipient addresses are routed, and local deliveries are done
4106 in the normal way. However, if any SMTP deliveries are required, they are not
4107 done at this time, so the message remains on the queue until a subsequent queue
4108 runner process encounters it. Because routing was done, Exim knows which
4109 messages are waiting for which hosts, and so a number of messages for the same
4110 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4111 configuration option has the same effect for specific domains. See also the
4112 &%-qq%& option.
4113
4114 .vitem &%-oee%&
4115 .oindex "&%-oee%&"
4116 .cindex "error" "reporting"
4117 If an error is detected while a non-SMTP message is being received (for
4118 example, a malformed address), the error is reported to the sender in a mail
4119 message.
4120
4121 .cindex "return code" "for &%-oee%&"
4122 Provided
4123 this error message is successfully sent, the Exim receiving process
4124 exits with a return code of zero. If not, the return code is 2 if the problem
4125 is that the original message has no recipients, or 1 for any other error.
4126 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4127
4128 .vitem &%-oem%&
4129 .oindex "&%-oem%&"
4130 .cindex "error" "reporting"
4131 .cindex "return code" "for &%-oem%&"
4132 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4133 return code, whether or not the error message was successfully sent.
4134 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4135
4136 .vitem &%-oep%&
4137 .oindex "&%-oep%&"
4138 .cindex "error" "reporting"
4139 If an error is detected while a non-SMTP message is being received, the
4140 error is reported by writing a message to the standard error file (stderr).
4141 .cindex "return code" "for &%-oep%&"
4142 The return code is 1 for all errors.
4143
4144 .vitem &%-oeq%&
4145 .oindex "&%-oeq%&"
4146 .cindex "error" "reporting"
4147 This option is supported for compatibility with Sendmail, but has the same
4148 effect as &%-oep%&.
4149
4150 .vitem &%-oew%&
4151 .oindex "&%-oew%&"
4152 .cindex "error" "reporting"
4153 This option is supported for compatibility with Sendmail, but has the same
4154 effect as &%-oem%&.
4155
4156 .vitem &%-oi%&
4157 .oindex "&%-oi%&"
4158 .cindex "dot" "in incoming non-SMTP message"
4159 This option, which has the same effect as &%-i%&, specifies that a dot on a
4160 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4161 single dot does terminate, though Exim does no special processing for other
4162 lines that start with a dot. This option is set by default if Exim is called as
4163 &'rmail'&. See also &%-ti%&.
4164
4165 .vitem &%-oitrue%&
4166 .oindex "&%-oitrue%&"
4167 This option is treated as synonymous with &%-oi%&.
4168
4169 .vitem &%-oMa%&&~<&'host&~address'&>
4170 .oindex "&%-oMa%&"
4171 .cindex "sender" "host address, specifying for local message"
4172 A number of options starting with &%-oM%& can be used to set values associated
4173 with remote hosts on locally-submitted messages (that is, messages not received
4174 over TCP/IP). These options can be used by any caller in conjunction with the
4175 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4176 other circumstances, they are ignored unless the caller is trusted.
4177
4178 The &%-oMa%& option sets the sender host address. This may include a port
4179 number at the end, after a full stop (period). For example:
4180 .code
4181 exim -bs -oMa 10.9.8.7.1234
4182 .endd
4183 An alternative syntax is to enclose the IP address in square brackets,
4184 followed by a colon and the port number:
4185 .code
4186 exim -bs -oMa [10.9.8.7]:1234
4187 .endd
4188 The IP address is placed in the &$sender_host_address$& variable, and the
4189 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4190 are present on the command line, the sender host IP address is taken from
4191 whichever one is last.
4192
4193 .vitem &%-oMaa%&&~<&'name'&>
4194 .oindex "&%-oMaa%&"
4195 .cindex "authentication" "name, specifying for local message"
4196 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4197 option sets the value of &$sender_host_authenticated$& (the authenticator
4198 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4199 This option can be used with &%-bh%& and &%-bs%& to set up an
4200 authenticated SMTP session without actually using the SMTP AUTH command.
4201
4202 .vitem &%-oMai%&&~<&'string'&>
4203 .oindex "&%-oMai%&"
4204 .cindex "authentication" "id, specifying for local message"
4205 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4206 option sets the value of &$authenticated_id$& (the id that was authenticated).
4207 This overrides the default value (the caller's login id, except with &%-bh%&,
4208 where there is no default) for messages from local sources. See chapter
4209 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4210
4211 .vitem &%-oMas%&&~<&'address'&>
4212 .oindex "&%-oMas%&"
4213 .cindex "authentication" "sender, specifying for local message"
4214 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4215 option sets the authenticated sender value in &$authenticated_sender$&. It
4216 overrides the sender address that is created from the caller's login id for
4217 messages from local sources, except when &%-bh%& is used, when there is no
4218 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4219 specified on a MAIL command overrides this value. See chapter
4220 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4221
4222 .vitem &%-oMi%&&~<&'interface&~address'&>
4223 .oindex "&%-oMi%&"
4224 .cindex "interface" "address, specifying for local message"
4225 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4226 option sets the IP interface address value. A port number may be included,
4227 using the same syntax as for &%-oMa%&. The interface address is placed in
4228 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4229
4230 .vitem &%-oMm%&&~<&'message&~reference'&>
4231 .oindex "&%-oMm%&"
4232 .cindex "message reference" "message reference, specifying for local message"
4233 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4234 option sets the message reference, e.g. message-id, and is logged during
4235 delivery. This is useful when some kind of audit trail is required to tie
4236 messages together. The format of the message reference is checked and will
4237 abort if the format is invalid. The option will only be accepted if exim is
4238 running in trusted mode, not as any regular user.
4239
4240 The best example of a message reference is when Exim sends a bounce message.
4241 The message reference is the message-id of the original message for which Exim
4242 is sending the bounce.
4243
4244 .vitem &%-oMr%&&~<&'protocol&~name'&>
4245 .oindex "&%-oMr%&"
4246 .cindex "protocol, specifying for local message"
4247 .vindex "&$received_protocol$&"
4248 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4249 option sets the received protocol value that is stored in
4250 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4251 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4252 SMTP protocol names (see the description of &$received_protocol$& in section
4253 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4254 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4255 be set by &%-oMr%&.
4256
4257 .vitem &%-oMs%&&~<&'host&~name'&>
4258 .oindex "&%-oMs%&"
4259 .cindex "sender" "host name, specifying for local message"
4260 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4261 option sets the sender host name in &$sender_host_name$&. When this option is
4262 present, Exim does not attempt to look up a host name from an IP address; it
4263 uses the name it is given.
4264
4265 .vitem &%-oMt%&&~<&'ident&~string'&>
4266 .oindex "&%-oMt%&"
4267 .cindex "sender" "ident string, specifying for local message"
4268 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4269 option sets the sender ident value in &$sender_ident$&. The default setting for
4270 local callers is the login id of the calling process, except when &%-bh%& is
4271 used, when there is no default.
4272
4273 .vitem &%-om%&
4274 .oindex "&%-om%&"
4275 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4276 In Sendmail, this option means &"me too"&, indicating that the sender of a
4277 message should receive a copy of the message if the sender appears in an alias
4278 expansion. Exim always does this, so the option does nothing.
4279
4280 .vitem &%-oo%&
4281 .oindex "&%-oo%&"
4282 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4283 This option is ignored. In Sendmail it specifies &"old style headers"&,
4284 whatever that means.
4285
4286 .vitem &%-oP%&&~<&'path'&>
4287 .oindex "&%-oP%&"
4288 .cindex "pid (process id)" "of daemon"
4289 .cindex "daemon" "process id (pid)"
4290 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4291 value. The option specifies the file to which the process id of the daemon is
4292 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4293 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4294 because in those cases, the normal pid file is not used.
4295
4296 .vitem &%-or%&&~<&'time'&>
4297 .oindex "&%-or%&"
4298 .cindex "timeout" "for non-SMTP input"
4299 This option sets a timeout value for incoming non-SMTP messages. If it is not
4300 set, Exim will wait forever for the standard input. The value can also be set
4301 by the &%receive_timeout%& option. The format used for specifying times is
4302 described in section &<<SECTtimeformat>>&.
4303
4304 .vitem &%-os%&&~<&'time'&>
4305 .oindex "&%-os%&"
4306 .cindex "timeout" "for SMTP input"
4307 .cindex "SMTP" "input timeout"
4308 This option sets a timeout value for incoming SMTP messages. The timeout
4309 applies to each SMTP command and block of data. The value can also be set by
4310 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4311 for specifying times is described in section &<<SECTtimeformat>>&.
4312
4313 .vitem &%-ov%&
4314 .oindex "&%-ov%&"
4315 This option has exactly the same effect as &%-v%&.
4316
4317 .vitem &%-oX%&&~<&'number&~or&~string'&>
4318 .oindex "&%-oX%&"
4319 .cindex "TCP/IP" "setting listening ports"
4320 .cindex "TCP/IP" "setting listening interfaces"
4321 .cindex "port" "receiving TCP/IP"
4322 This option is relevant only when the &%-bd%& (start listening daemon) option
4323 is also given. It controls which ports and interfaces the daemon uses. Details
4324 of the syntax, and how it interacts with configuration file options, are given
4325 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4326 file is written unless &%-oP%& is also present to specify a pid file name.
4327
4328 .vitem &%-pd%&
4329 .oindex "&%-pd%&"
4330 .cindex "Perl" "starting the interpreter"
4331 This option applies when an embedded Perl interpreter is linked with Exim (see
4332 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4333 option, forcing the starting of the interpreter to be delayed until it is
4334 needed.
4335
4336 .vitem &%-ps%&
4337 .oindex "&%-ps%&"
4338 .cindex "Perl" "starting the interpreter"
4339 This option applies when an embedded Perl interpreter is linked with Exim (see
4340 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4341 option, forcing the starting of the interpreter to occur as soon as Exim is
4342 started.
4343
4344 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4345 .oindex "&%-p%&"
4346 For compatibility with Sendmail, this option is equivalent to
4347 .display
4348 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4349 .endd
4350 It sets the incoming protocol and host name (for trusted callers). The
4351 host name and its colon can be omitted when only the protocol is to be set.
4352 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4353 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4354 or &`s`& using this option (but that does not seem a real limitation).
4355
4356 .vitem &%-q%&
4357 .oindex "&%-q%&"
4358 .cindex "queue runner" "starting manually"
4359 This option is normally restricted to admin users. However, there is a
4360 configuration option called &%prod_requires_admin%& which can be set false to
4361 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4362 and &%-S%& options).
4363
4364 .cindex "queue runner" "description of operation"
4365 The &%-q%& option starts one queue runner process. This scans the queue of
4366 waiting messages, and runs a delivery process for each one in turn. It waits
4367 for each delivery process to finish before starting the next one. A delivery
4368 process may not actually do any deliveries if the retry times for the addresses
4369 have not been reached. Use &%-qf%& (see below) if you want to override this.
4370
4371 If
4372 .cindex "SMTP" "passed connection"
4373 .cindex "SMTP" "multiple deliveries"
4374 .cindex "multiple SMTP deliveries"
4375 the delivery process spawns other processes to deliver other messages down
4376 passed SMTP connections, the queue runner waits for these to finish before
4377 proceeding.
4378
4379 When all the queued messages have been considered, the original queue runner
4380 process terminates. In other words, a single pass is made over the waiting
4381 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4382 this to be repeated periodically.
4383
4384 Exim processes the waiting messages in an unpredictable order. It isn't very
4385 random, but it is likely to be different each time, which is all that matters.
4386 If one particular message screws up a remote MTA, other messages to the same
4387 MTA have a chance of getting through if they get tried first.
4388
4389 It is possible to cause the messages to be processed in lexical message id
4390 order, which is essentially the order in which they arrived, by setting the
4391 &%queue_run_in_order%& option, but this is not recommended for normal use.
4392
4393 .vitem &%-q%&<&'qflags'&>
4394 The &%-q%& option may be followed by one or more flag letters that change its
4395 behaviour. They are all optional, but if more than one is present, they must
4396 appear in the correct order. Each flag is described in a separate item below.
4397
4398 .vitem &%-qq...%&
4399 .oindex "&%-qq%&"
4400 .cindex "queue" "double scanning"
4401 .cindex "queue" "routing"
4402 .cindex "routing" "whole queue before delivery"
4403 An option starting with &%-qq%& requests a two-stage queue run. In the first
4404 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4405 every domain. Addresses are routed, local deliveries happen, but no remote
4406 transports are run.
4407
4408 .cindex "hints database" "remembering routing"
4409 The hints database that remembers which messages are waiting for specific hosts
4410 is updated, as if delivery to those hosts had been deferred. After this is
4411 complete, a second, normal queue scan happens, with routing and delivery taking
4412 place as normal. Messages that are routed to the same host should mostly be
4413 delivered down a single SMTP
4414 .cindex "SMTP" "passed connection"
4415 .cindex "SMTP" "multiple deliveries"
4416 .cindex "multiple SMTP deliveries"
4417 connection because of the hints that were set up during the first queue scan.
4418 This option may be useful for hosts that are connected to the Internet
4419 intermittently.
4420
4421 .vitem &%-q[q]i...%&
4422 .oindex "&%-qi%&"
4423 .cindex "queue" "initial delivery"
4424 If the &'i'& flag is present, the queue runner runs delivery processes only for
4425 those messages that haven't previously been tried. (&'i'& stands for &"initial
4426 delivery"&.) This can be helpful if you are putting messages on the queue using
4427 &%-odq%& and want a queue runner just to process the new messages.
4428
4429 .vitem &%-q[q][i]f...%&
4430 .oindex "&%-qf%&"
4431 .cindex "queue" "forcing delivery"
4432 .cindex "delivery" "forcing in queue run"
4433 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4434 message, whereas without &'f'& only those non-frozen addresses that have passed
4435 their retry times are tried.
4436
4437 .vitem &%-q[q][i]ff...%&
4438 .oindex "&%-qff%&"
4439 .cindex "frozen messages" "forcing delivery"
4440 If &'ff'& is present, a delivery attempt is forced for every message, whether
4441 frozen or not.
4442
4443 .vitem &%-q[q][i][f[f]]l%&
4444 .oindex "&%-ql%&"
4445 .cindex "queue" "local deliveries only"
4446 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4447 be done. If a message requires any remote deliveries, it remains on the queue
4448 for later delivery.
4449
4450 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4451 .cindex "queue" "delivering specific messages"
4452 When scanning the queue, Exim can be made to skip over messages whose ids are
4453 lexically less than a given value by following the &%-q%& option with a
4454 starting message id. For example:
4455 .code
4456 exim -q 0t5C6f-0000c8-00
4457 .endd
4458 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4459 second message id is given, messages whose ids are lexically greater than it
4460 are also skipped. If the same id is given twice, for example,
4461 .code
4462 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4463 .endd
4464 just one delivery process is started, for that message. This differs from
4465 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4466 that it counts as a delivery from a queue run. Note that the selection
4467 mechanism does not affect the order in which the messages are scanned. There
4468 are also other ways of selecting specific sets of messages for delivery in a
4469 queue run &-- see &%-R%& and &%-S%&.
4470
4471 .vitem &%-q%&<&'qflags'&><&'time'&>
4472 .cindex "queue runner" "starting periodically"
4473 .cindex "periodic queue running"
4474 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4475 starting a queue runner process at intervals specified by the given time value
4476 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4477 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4478 single daemon process handles both functions. A common way of starting up a
4479 combined daemon at system boot time is to use a command such as
4480 .code
4481 /usr/exim/bin/exim -bd -q30m
4482 .endd
4483 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4484 process every 30 minutes.
4485
4486 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4487 pid file is written unless one is explicitly requested by the &%-oP%& option.
4488
4489 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4490 .oindex "&%-qR%&"
4491 This option is synonymous with &%-R%&. It is provided for Sendmail
4492 compatibility.
4493
4494 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4495 .oindex "&%-qS%&"
4496 This option is synonymous with &%-S%&.
4497
4498 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4499 .oindex "&%-R%&"
4500 .cindex "queue runner" "for specific recipients"
4501 .cindex "delivery" "to given domain"
4502 .cindex "domain" "delivery to"
4503 The <&'rsflags'&> may be empty, in which case the white space before the string
4504 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4505 which are the possible values for <&'rsflags'&>. White space is required if
4506 <&'rsflags'&> is not empty.
4507
4508 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4509 perform a single queue run, except that, when scanning the messages on the
4510 queue, Exim processes only those that have at least one undelivered recipient
4511 address containing the given string, which is checked in a case-independent
4512 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4513 regular expression; otherwise it is a literal string.
4514
4515 If you want to do periodic queue runs for messages with specific recipients,
4516 you can combine &%-R%& with &%-q%& and a time value. For example:
4517 .code
4518 exim -q25m -R @special.domain.example
4519 .endd
4520 This example does a queue run for messages with recipients in the given domain
4521 every 25 minutes. Any additional flags that are specified with &%-q%& are
4522 applied to each queue run.
4523
4524 Once a message is selected for delivery by this mechanism, all its addresses
4525 are processed. For the first selected message, Exim overrides any retry
4526 information and forces a delivery attempt for each undelivered address. This
4527 means that if delivery of any address in the first message is successful, any
4528 existing retry information is deleted, and so delivery attempts for that
4529 address in subsequently selected messages (which are processed without forcing)
4530 will run. However, if delivery of any address does not succeed, the retry
4531 information is updated, and in subsequently selected messages, the failing
4532 address will be skipped.
4533
4534 .cindex "frozen messages" "forcing delivery"
4535 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4536 all selected messages, not just the first; frozen messages are included when
4537 &'ff'& is present.
4538
4539 The &%-R%& option makes it straightforward to initiate delivery of all messages
4540 to a given domain after a host has been down for some time. When the SMTP
4541 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4542 effect is to run Exim with the &%-R%& option, but it can be configured to run
4543 an arbitrary command instead.
4544
4545 .vitem &%-r%&
4546 .oindex "&%-r%&"
4547 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4548
4549 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4550 .oindex "&%-S%&"
4551 .cindex "delivery" "from given sender"
4552 .cindex "queue runner" "for specific senders"
4553 This option acts like &%-R%& except that it checks the string against each
4554 message's sender instead of against the recipients. If &%-R%& is also set, both
4555 conditions must be met for a message to be selected. If either of the options
4556 has &'f'& or &'ff'& in its flags, the associated action is taken.
4557
4558 .vitem &%-Tqt%&&~<&'times'&>
4559 .oindex "&%-Tqt%&"
4560 This is an option that is exclusively for use by the Exim testing suite. It is not
4561 recognized when Exim is run normally. It allows for the setting up of explicit
4562 &"queue times"& so that various warning/retry features can be tested.
4563
4564 .vitem &%-t%&
4565 .oindex "&%-t%&"
4566 .cindex "recipient" "extracting from header lines"
4567 .cindex "&'Bcc:'& header line"
4568 .cindex "&'Cc:'& header line"
4569 .cindex "&'To:'& header line"
4570 When Exim is receiving a locally-generated, non-SMTP message on its standard
4571 input, the &%-t%& option causes the recipients of the message to be obtained
4572 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4573 from the command arguments. The addresses are extracted before any rewriting
4574 takes place and the &'Bcc:'& header line, if present, is then removed.
4575
4576 .cindex "Sendmail compatibility" "&%-t%& option"
4577 If the command has any arguments, they specify addresses to which the message
4578 is &'not'& to be delivered. That is, the argument addresses are removed from
4579 the recipients list obtained from the headers. This is compatible with Smail 3
4580 and in accordance with the documented behaviour of several versions of
4581 Sendmail, as described in man pages on a number of operating systems (e.g.
4582 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4583 argument addresses to those obtained from the headers, and the O'Reilly
4584 Sendmail book documents it that way. Exim can be made to add argument addresses
4585 instead of subtracting them by setting the option
4586 &%extract_addresses_remove_arguments%& false.
4587
4588 .cindex "&%Resent-%& header lines" "with &%-t%&"
4589 If there are any &%Resent-%& header lines in the message, Exim extracts
4590 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4591 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4592 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4593 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4594
4595 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4596 message is resent several times). The RFC also specifies that they should be
4597 added at the front of the message, and separated by &'Received:'& lines. It is
4598 not at all clear how &%-t%& should operate in the present of multiple sets,
4599 nor indeed exactly what constitutes a &"set"&.
4600 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4601 are often added at the end of the header, and if a message is resent more than
4602 once, it is common for the original set of &%Resent-%& headers to be renamed as
4603 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4604
4605 .vitem &%-ti%&
4606 .oindex "&%-ti%&"
4607 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4608 compatibility with Sendmail.
4609
4610 .vitem &%-tls-on-connect%&
4611 .oindex "&%-tls-on-connect%&"
4612 .cindex "TLS" "use without STARTTLS"
4613 .cindex "TLS" "automatic start"
4614 This option is available when Exim is compiled with TLS support. It forces all
4615 incoming SMTP connections to behave as if the incoming port is listed in the
4616 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4617 &<<CHAPTLS>>& for further details.
4618
4619
4620 .vitem &%-U%&
4621 .oindex "&%-U%&"
4622 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4623 Sendmail uses this option for &"initial message submission"&, and its
4624 documentation states that in future releases, it may complain about
4625 syntactically invalid messages rather than fixing them when this flag is not
4626 set. Exim ignores this option.
4627
4628 .vitem &%-v%&
4629 .oindex "&%-v%&"
4630 This option causes Exim to write information to the standard error stream,
4631 describing what it is doing. In particular, it shows the log lines for
4632 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4633 dialogue is shown. Some of the log lines shown may not actually be written to
4634 the log if the setting of &%log_selector%& discards them. Any relevant
4635 selectors are shown with each log line. If none are shown, the logging is
4636 unconditional.
4637
4638 .vitem &%-x%&
4639 .oindex "&%-x%&"
4640 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4641 National Language Support extended characters in the body of the mail item"&).
4642 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4643 this option.
4644
4645 .vitem &%-X%&&~<&'logfile'&>
4646 .oindex "&%-X%&"
4647 This option is interpreted by Sendmail to cause debug information to be sent
4648 to the named file.  It is ignored by Exim.
4649
4650 .vitem &%-z%&&~<&'log-line'&>
4651 .oindex "&%-z%&"
4652 This option writes its argument to Exim's logfile.
4653 Use is restricted to administrators; the intent is for operational notes.
4654 Quotes should be used to maintain a multi-word item as a single argument,
4655 under most shells.
4656 .endlist
4657
4658 .ecindex IIDclo1
4659 .ecindex IIDclo2
4660
4661
4662 . ////////////////////////////////////////////////////////////////////////////
4663 . Insert a stylized DocBook comment here, to identify the end of the command
4664 . line options. This is for the benefit of the Perl script that automatically
4665 . creates a man page for the options.
4666 . ////////////////////////////////////////////////////////////////////////////
4667
4668 .literal xml
4669 <!-- === End of command line options === -->
4670 .literal off
4671
4672
4673
4674
4675
4676 . ////////////////////////////////////////////////////////////////////////////
4677 . ////////////////////////////////////////////////////////////////////////////
4678
4679
4680 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4681          "The runtime configuration file"
4682
4683 .cindex "run time configuration"
4684 .cindex "configuration file" "general description"
4685 .cindex "CONFIGURE_FILE"
4686 .cindex "configuration file" "errors in"
4687 .cindex "error" "in configuration file"
4688 .cindex "return code" "for bad configuration"
4689 Exim uses a single run time configuration file that is read whenever an Exim
4690 binary is executed. Note that in normal operation, this happens frequently,
4691 because Exim is designed to operate in a distributed manner, without central
4692 control.
4693
4694 If a syntax error is detected while reading the configuration file, Exim
4695 writes a message on the standard error, and exits with a non-zero return code.
4696 The message is also written to the panic log. &*Note*&: Only simple syntax
4697 errors can be detected at this time. The values of any expanded options are
4698 not checked until the expansion happens, even when the expansion does not
4699 actually alter the string.
4700
4701 The name of the configuration file is compiled into the binary for security
4702 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4703 most configurations, this specifies a single file. However, it is permitted to
4704 give a colon-separated list of file names, in which case Exim uses the first
4705 existing file in the list.
4706
4707 .cindex "EXIM_USER"
4708 .cindex "EXIM_GROUP"
4709 .cindex "CONFIGURE_OWNER"
4710 .cindex "CONFIGURE_GROUP"
4711 .cindex "configuration file" "ownership"
4712 .cindex "ownership" "configuration file"
4713 The run time configuration file must be owned by root or by the user that is
4714 specified at compile time by the CONFIGURE_OWNER option (if set). The
4715 configuration file must not be world-writeable, or group-writeable unless its
4716 group is the root group or the one specified at compile time by the
4717 CONFIGURE_GROUP option.
4718
4719 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4720 to root, anybody who is able to edit the run time configuration file has an
4721 easy way to run commands as root. If you specify a user or group in the
4722 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4723 who are members of that group will trivially be able to obtain root privileges.
4724
4725 Up to Exim version 4.72, the run time configuration file was also permitted to
4726 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4727 since it offered a simple privilege escalation for any attacker who managed to
4728 compromise the Exim user account.
4729
4730 A default configuration file, which will work correctly in simple situations,
4731 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4732 defines just one file name, the installation process copies the default
4733 configuration to a new file of that name if it did not previously exist. If
4734 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4735 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4736 configuration.
4737
4738
4739
4740 .section "Using a different configuration file" "SECID40"
4741 .cindex "configuration file" "alternate"
4742 A one-off alternate configuration can be specified by the &%-C%& command line
4743 option, which may specify a single file or a list of files. However, when
4744 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4745 unless the argument for &%-C%& is identical to the built-in value from
4746 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4747 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4748 is useful mainly for checking the syntax of configuration files before
4749 installing them. No owner or group checks are done on a configuration file
4750 specified by &%-C%&, if root privilege has been dropped.
4751
4752 Even the Exim user is not trusted to specify an arbitrary configuration file
4753 with the &%-C%& option to be used with root privileges, unless that file is
4754 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4755 testing a configuration using &%-C%& right through message reception and
4756 delivery, even if the caller is root. The reception works, but by that time,
4757 Exim is running as the Exim user, so when it re-execs to regain privilege for
4758 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4759 can test reception and delivery using two separate commands (one to put a
4760 message on the queue, using &%-odq%&, and another to do the delivery, using
4761 &%-M%&).
4762
4763 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4764 prefix string with which any file named in a &%-C%& command line option must
4765 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4766 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4767 name can be used with &%-C%&.
4768
4769 One-off changes to a configuration can be specified by the &%-D%& command line
4770 option, which defines and overrides values for macros used inside the
4771 configuration file. However, like &%-C%&, the use of this option by a
4772 non-privileged user causes Exim to discard its root privilege.
4773 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4774 completely disabled, and its use causes an immediate error exit.
4775
4776 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4777 to declare certain macro names trusted, such that root privilege will not
4778 necessarily be discarded.
4779 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4780 considered safe and, if &%-D%& only supplies macros from this list, and the
4781 values are acceptable, then Exim will not give up root privilege if the caller
4782 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4783 transition mechanism and is expected to be removed in the future.  Acceptable
4784 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4785
4786 Some sites may wish to use the same Exim binary on different machines that
4787 share a file system, but to use different configuration files on each machine.
4788 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4789 looks for a file whose name is the configuration file name followed by a dot
4790 and the machine's node name, as obtained from the &[uname()]& function. If this
4791 file does not exist, the standard name is tried. This processing occurs for
4792 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4793
4794 In some esoteric situations different versions of Exim may be run under
4795 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4796 help with this. See the comments in &_src/EDITME_& for details.
4797
4798
4799
4800 .section "Configuration file format" "SECTconffilfor"
4801 .cindex "configuration file" "format of"
4802 .cindex "format" "configuration file"
4803 Exim's configuration file is divided into a number of different parts. General
4804 option settings must always appear at the start of the file. The other parts
4805 are all optional, and may appear in any order. Each part other than the first
4806 is introduced by the word &"begin"& followed by the name of the part. The
4807 optional parts are:
4808
4809 .ilist
4810 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4811 &<<CHAPACL>>&).
4812 .next
4813 .cindex "AUTH" "configuration"
4814 &'authenticators'&: Configuration settings for the authenticator drivers. These
4815 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4816 .next
4817 &'routers'&: Configuration settings for the router drivers. Routers process
4818 addresses and determine how the message is to be delivered (see chapters
4819 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4820 .next
4821 &'transports'&: Configuration settings for the transport drivers. Transports
4822 define mechanisms for copying messages to destinations (see chapters
4823 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4824 .next
4825 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4826 If there is no retry section, or if it is empty (that is, no retry rules are
4827 defined), Exim will not retry deliveries. In this situation, temporary errors
4828 are treated the same as permanent errors. Retry rules are discussed in chapter
4829 &<<CHAPretry>>&.
4830 .next
4831 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4832 when new addresses are generated during delivery. Rewriting is discussed in
4833 chapter &<<CHAPrewrite>>&.
4834 .next
4835 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4836 want to use this feature, you must set
4837 .code
4838 LOCAL_SCAN_HAS_OPTIONS=yes
4839 .endd
4840 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4841 facility are given in chapter &<<CHAPlocalscan>>&.
4842 .endlist
4843
4844 .cindex "configuration file" "leading white space in"
4845 .cindex "configuration file" "trailing white space in"
4846 .cindex "white space" "in configuration file"
4847 Leading and trailing white space in configuration lines is always ignored.
4848
4849 Blank lines in the file, and lines starting with a # character (ignoring
4850 leading white space) are treated as comments and are ignored. &*Note*&: A
4851 # character other than at the beginning of a line is not treated specially,
4852 and does not introduce a comment.
4853
4854 Any non-comment line can be continued by ending it with a backslash. Note that
4855 the general rule for white space means that trailing white space after the
4856 backslash and leading white space at the start of continuation
4857 lines is ignored. Comment lines beginning with # (but not empty lines) may
4858 appear in the middle of a sequence of continuation lines.
4859
4860 A convenient way to create a configuration file is to start from the
4861 default, which is supplied in &_src/configure.default_&, and add, delete, or
4862 change settings as required.
4863
4864 The ACLs, retry rules, and rewriting rules have their own syntax which is
4865 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4866 respectively. The other parts of the configuration file have some syntactic
4867 items in common, and these are described below, from section &<<SECTcos>>&
4868 onwards. Before that, the inclusion, macro, and conditional facilities are
4869 described.
4870
4871
4872
4873 .section "File inclusions in the configuration file" "SECID41"
4874 .cindex "inclusions in configuration file"
4875 .cindex "configuration file" "including other files"
4876 .cindex "&`.include`& in configuration file"
4877 .cindex "&`.include_if_exists`& in configuration file"
4878 You can include other files inside Exim's run time configuration file by
4879 using this syntax:
4880 .display
4881 &`.include`& <&'file name'&>
4882 &`.include_if_exists`& <&'file name'&>
4883 .endd
4884 on a line by itself. Double quotes round the file name are optional. If you use
4885 the first form, a configuration error occurs if the file does not exist; the
4886 second form does nothing for non-existent files. In all cases, an absolute file
4887 name is required.
4888
4889 Includes may be nested to any depth, but remember that Exim reads its
4890 configuration file often, so it is a good idea to keep them to a minimum.
4891 If you change the contents of an included file, you must HUP the daemon,
4892 because an included file is read only when the configuration itself is read.
4893
4894 The processing of inclusions happens early, at a physical line level, so, like
4895 comment lines, an inclusion can be used in the middle of an option setting,
4896 for example:
4897 .code
4898 hosts_lookup = a.b.c \
4899                .include /some/file
4900 .endd
4901 Include processing happens after macro processing (see below). Its effect is to
4902 process the lines of the included file as if they occurred inline where the
4903 inclusion appears.
4904
4905
4906
4907 .section "Macros in the configuration file" "SECTmacrodefs"
4908 .cindex "macro" "description of"
4909 .cindex "configuration file" "macros"
4910 If a line in the main part of the configuration (that is, before the first
4911 &"begin"& line) begins with an upper case letter, it is taken as a macro
4912 definition, and must be of the form
4913 .display
4914 <&'name'&> = <&'rest of line'&>
4915 .endd
4916 The name must consist of letters, digits, and underscores, and need not all be
4917 in upper case, though that is recommended. The rest of the line, including any
4918 continuations, is the replacement text, and has leading and trailing white
4919 space removed. Quotes are not removed. The replacement text can never end with
4920 a backslash character, but this doesn't seem to be a serious limitation.
4921
4922 Macros may also be defined between router, transport, authenticator, or ACL
4923 definitions. They may not, however, be defined within an individual driver or
4924 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4925
4926 .section "Macro substitution" "SECID42"
4927 Once a macro is defined, all subsequent lines in the file (and any included
4928 files) are scanned for the macro name; if there are several macros, the line is
4929 scanned for each in turn, in the order in which the macros are defined. The
4930 replacement text is not re-scanned for the current macro, though it is scanned
4931 for subsequently defined macros. For this reason, a macro name may not contain
4932 the name of a previously defined macro as a substring. You could, for example,
4933 define
4934 .display
4935 &`ABCD_XYZ = `&<&'something'&>
4936 &`ABCD = `&<&'something else'&>
4937 .endd
4938 but putting the definitions in the opposite order would provoke a configuration
4939 error. Macro expansion is applied to individual physical lines from the file,
4940 before checking for line continuation or file inclusion (see above). If a line
4941 consists solely of a macro name, and the expansion of the macro is empty, the
4942 line is ignored. A macro at the start of a line may turn the line into a
4943 comment line or a &`.include`& line.
4944
4945
4946 .section "Redefining macros" "SECID43"
4947 Once defined, the value of a macro can be redefined later in the configuration
4948 (or in an included file). Redefinition is specified by using &'=='& instead of
4949 &'='&. For example:
4950 .code
4951 MAC =  initial value
4952 ...
4953 MAC == updated value
4954 .endd
4955 Redefinition does not alter the order in which the macros are applied to the
4956 subsequent lines of the configuration file. It is still the same order in which
4957 the macros were originally defined. All that changes is the macro's value.
4958 Redefinition makes it possible to accumulate values. For example:
4959 .code
4960 MAC =  initial value
4961 ...
4962 MAC == MAC and something added
4963 .endd
4964 This can be helpful in situations where the configuration file is built
4965 from a number of other files.
4966
4967 .section "Overriding macro values" "SECID44"
4968 The values set for macros in the configuration file can be overridden by the
4969 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4970 used, unless called by root or the Exim user. A definition on the command line
4971 using the &%-D%& option causes all definitions and redefinitions within the
4972 file to be ignored.
4973
4974
4975
4976 .section "Example of macro usage" "SECID45"
4977 As an example of macro usage, consider a configuration where aliases are looked
4978 up in a MySQL database. It helps to keep the file less cluttered if long
4979 strings such as SQL statements are defined separately as macros, for example:
4980 .code
4981 ALIAS_QUERY = select mailbox from user where \
4982               login='${quote_mysql:$local_part}';
4983 .endd
4984 This can then be used in a &(redirect)& router setting like this:
4985 .code
4986 data = ${lookup mysql{ALIAS_QUERY}}
4987 .endd
4988 In earlier versions of Exim macros were sometimes used for domain, host, or
4989 address lists. In Exim 4 these are handled better by named lists &-- see
4990 section &<<SECTnamedlists>>&.
4991
4992
4993 .section "Conditional skips in the configuration file" "SECID46"
4994 .cindex "configuration file" "conditional skips"
4995 .cindex "&`.ifdef`&"
4996 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4997 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4998 portions of the configuration file. The processing happens whenever the file is
4999 read (that is, when an Exim binary starts to run).
5000
5001 The implementation is very simple. Instances of the first four directives must
5002 be followed by text that includes the names of one or macros. The condition
5003 that is tested is whether or not any macro substitution has taken place in the
5004 line. Thus:
5005 .code
5006 .ifdef AAA
5007 message_size_limit = 50M
5008 .else
5009 message_size_limit = 100M
5010 .endif
5011 .endd
5012 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5013 otherwise. If there is more than one macro named on the line, the condition
5014 is true if any of them are defined. That is, it is an &"or"& condition. To
5015 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5016
5017 Although you can use a macro expansion to generate one of these directives,
5018 it is not very useful, because the condition &"there was a macro substitution
5019 in this line"& will always be true.
5020
5021 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5022 to clarify complicated nestings.
5023
5024
5025
5026 .section "Common option syntax" "SECTcos"
5027 .cindex "common option syntax"
5028 .cindex "syntax of common options"
5029 .cindex "configuration file" "common option syntax"
5030 For the main set of options, driver options, and &[local_scan()]& options,
5031 each setting is on a line by itself, and starts with a name consisting of
5032 lower-case letters and underscores. Many options require a data value, and in
5033 these cases the name must be followed by an equals sign (with optional white
5034 space) and then the value. For example:
5035 .code
5036 qualify_domain = mydomain.example.com
5037 .endd
5038 .cindex "hiding configuration option values"
5039 .cindex "configuration options" "hiding value of"
5040 .cindex "options" "hiding value of"
5041 Some option settings may contain sensitive data, for example, passwords for
5042 accessing databases. To stop non-admin users from using the &%-bP%& command
5043 line option to read these values, you can precede the option settings with the
5044 word &"hide"&. For example:
5045 .code
5046 hide mysql_servers = localhost/users/admin/secret-password
5047 .endd
5048 For non-admin users, such options are displayed like this:
5049 .code
5050 mysql_servers = <value not displayable>
5051 .endd
5052 If &"hide"& is used on a driver option, it hides the value of that option on
5053 all instances of the same driver.
5054
5055 The following sections describe the syntax used for the different data types
5056 that are found in option settings.
5057
5058
5059 .section "Boolean options" "SECID47"
5060 .cindex "format" "boolean"
5061 .cindex "boolean configuration values"
5062 .oindex "&%no_%&&'xxx'&"
5063 .oindex "&%not_%&&'xxx'&"
5064 Options whose type is given as boolean are on/off switches. There are two
5065 different ways of specifying such options: with and without a data value. If
5066 the option name is specified on its own without data, the switch is turned on;
5067 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5068 boolean options may be followed by an equals sign and one of the words
5069 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5070 the following two settings have exactly the same effect:
5071 .code
5072 queue_only
5073 queue_only = true
5074 .endd
5075 The following two lines also have the same (opposite) effect:
5076 .code
5077 no_queue_only
5078 queue_only = false
5079 .endd
5080 You can use whichever syntax you prefer.
5081
5082
5083
5084
5085 .section "Integer values" "SECID48"
5086 .cindex "integer configuration values"
5087 .cindex "format" "integer"
5088 If an option's type is given as &"integer"&, the value can be given in decimal,
5089 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5090 number is assumed. Otherwise, it is treated as an octal number unless it starts
5091 with the characters &"0x"&, in which case the remainder is interpreted as a
5092 hexadecimal number.
5093
5094 If an integer value is followed by the letter K, it is multiplied by 1024; if
5095 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5096 of integer option settings are output, values which are an exact multiple of
5097 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5098 and M. The printing style is independent of the actual input format that was
5099 used.
5100
5101
5102 .section "Octal integer values" "SECID49"
5103 .cindex "integer format"
5104 .cindex "format" "octal integer"
5105 If an option's type is given as &"octal integer"&, its value is always
5106 interpreted as an octal number, whether or not it starts with the digit zero.
5107 Such options are always output in octal.
5108
5109
5110 .section "Fixed point numbers" "SECID50"
5111 .cindex "fixed point configuration values"
5112 .cindex "format" "fixed point"
5113 If an option's type is given as &"fixed-point"&, its value must be a decimal
5114 integer, optionally followed by a decimal point and up to three further digits.
5115
5116
5117
5118 .section "Time intervals" "SECTtimeformat"
5119 .cindex "time interval" "specifying in configuration"
5120 .cindex "format" "time interval"
5121 A time interval is specified as a sequence of numbers, each followed by one of
5122 the following letters, with no intervening white space:
5123
5124 .table2 30pt
5125 .irow &%s%& seconds
5126 .irow &%m%& minutes
5127 .irow &%h%& hours
5128 .irow &%d%& days
5129 .irow &%w%& weeks
5130 .endtable
5131
5132 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5133 intervals are output in the same format. Exim does not restrict the values; it
5134 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5135
5136
5137
5138 .section "String values" "SECTstrings"
5139 .cindex "string" "format of configuration values"
5140 .cindex "format" "string"
5141 If an option's type is specified as &"string"&, the value can be specified with
5142 or without double-quotes. If it does not start with a double-quote, the value
5143 consists of the remainder of the line plus any continuation lines, starting at
5144 the first character after any leading white space, with trailing white space
5145 removed, and with no interpretation of the characters in the string. Because
5146 Exim removes comment lines (those beginning with #) at an early stage, they can
5147 appear in the middle of a multi-line string. The following two settings are
5148 therefore equivalent:
5149 .code
5150 trusted_users = uucp:mail
5151 trusted_users = uucp:\
5152                 # This comment line is ignored
5153                 mail
5154 .endd
5155 .cindex "string" "quoted"
5156 .cindex "escape characters in quoted strings"
5157 If a string does start with a double-quote, it must end with a closing
5158 double-quote, and any backslash characters other than those used for line
5159 continuation are interpreted as escape characters, as follows:
5160
5161 .table2 100pt
5162 .irow &`\\`&                     "single backslash"
5163 .irow &`\n`&                     "newline"
5164 .irow &`\r`&                     "carriage return"
5165 .irow &`\t`&                     "tab"
5166 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5167 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5168                                    character"
5169 .endtable
5170
5171 If a backslash is followed by some other character, including a double-quote
5172 character, that character replaces the pair.
5173
5174 Quoting is necessary only if you want to make use of the backslash escapes to
5175 insert special characters, or if you need to specify a value with leading or
5176 trailing spaces. These cases are rare, so quoting is almost never needed in
5177 current versions of Exim. In versions of Exim before 3.14, quoting was required
5178 in order to continue lines, so you may come across older configuration files
5179 and examples that apparently quote unnecessarily.
5180
5181
5182 .section "Expanded strings" "SECID51"
5183 .cindex "expansion" "definition of"
5184 Some strings in the configuration file are subjected to &'string expansion'&,
5185 by which means various parts of the string may be changed according to the
5186 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5187 is as just described; in particular, the handling of backslashes in quoted
5188 strings is done as part of the input process, before expansion takes place.
5189 However, backslash is also an escape character for the expander, so any
5190 backslashes that are required for that reason must be doubled if they are
5191 within a quoted configuration string.
5192
5193
5194 .section "User and group names" "SECID52"
5195 .cindex "user name" "format of"
5196 .cindex "format" "user name"
5197 .cindex "groups" "name format"
5198 .cindex "format" "group name"
5199 User and group names are specified as strings, using the syntax described
5200 above, but the strings are interpreted specially. A user or group name must
5201 either consist entirely of digits, or be a name that can be looked up using the
5202 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5203
5204
5205 .section "List construction" "SECTlistconstruct"
5206 .cindex "list" "syntax of in configuration"
5207 .cindex "format" "list item in configuration"
5208 .cindex "string" "list, definition of"
5209 The data for some configuration options is a list of items, with colon as the
5210 default separator. Many of these options are shown with type &"string list"& in
5211 the descriptions later in this document. Others are listed as &"domain list"&,
5212 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5213 are all the same; however, those other than &"string list"& are subject to
5214 particular kinds of interpretation, as described in chapter
5215 &<<CHAPdomhosaddlists>>&.
5216
5217 In all these cases, the entire list is treated as a single string as far as the
5218 input syntax is concerned. The &%trusted_users%& setting in section
5219 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5220 in a list, it must be entered as two colons. Leading and trailing white space
5221 on each item in a list is ignored. This makes it possible to include items that
5222 start with a colon, and in particular, certain forms of IPv6 address. For
5223 example, the list
5224 .code
5225 local_interfaces = 127.0.0.1 : ::::1
5226 .endd
5227 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5228
5229 &*Note*&: Although leading and trailing white space is ignored in individual
5230 list items, it is not ignored when parsing the list. The space after the first
5231 colon in the example above is necessary. If it were not there, the list would
5232 be interpreted as the two items 127.0.0.1:: and 1.
5233
5234 .section "Changing list separators" "SECID53"
5235 .cindex "list separator" "changing"
5236 .cindex "IPv6" "addresses in lists"
5237 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5238 introduced to allow the separator character to be changed. If a list begins
5239 with a left angle bracket, followed by any punctuation character, that
5240 character is used instead of colon as the list separator. For example, the list
5241 above can be rewritten to use a semicolon separator like this:
5242 .code
5243 local_interfaces = <; 127.0.0.1 ; ::1
5244 .endd
5245 This facility applies to all lists, with the exception of the list in
5246 &%log_file_path%&. It is recommended that the use of non-colon separators be
5247 confined to circumstances where they really are needed.
5248
5249 .cindex "list separator" "newline as"
5250 .cindex "newline" "as list separator"
5251 It is also possible to use newline and other control characters (those with
5252 code values less than 32, plus DEL) as separators in lists. Such separators
5253 must be provided literally at the time the list is processed. For options that
5254 are string-expanded, you can write the separator using a normal escape
5255 sequence. This will be processed by the expander before the string is
5256 interpreted as a list. For example, if a newline-separated list of domains is
5257 generated by a lookup, you can process it directly by a line such as this:
5258 .code
5259 domains = <\n ${lookup mysql{.....}}
5260 .endd
5261 This avoids having to change the list separator in such data. You are unlikely
5262 to want to use a control character as a separator in an option that is not
5263 expanded, because the value is literal text. However, it can be done by giving
5264 the value in quotes. For example:
5265 .code
5266 local_interfaces = "<\n 127.0.0.1 \n ::1"
5267 .endd
5268 Unlike printing character separators, which can be included in list items by
5269 doubling, it is not possible to include a control character as data when it is
5270 set as the separator. Two such characters in succession are interpreted as
5271 enclosing an empty list item.
5272
5273
5274
5275 .section "Empty items in lists" "SECTempitelis"
5276 .cindex "list" "empty item in"
5277 An empty item at the end of a list is always ignored. In other words, trailing
5278 separator characters are ignored. Thus, the list in
5279 .code
5280 senders = user@domain :
5281 .endd
5282 contains only a single item. If you want to include an empty string as one item
5283 in a list, it must not be the last item. For example, this list contains three
5284 items, the second of which is empty:
5285 .code
5286 senders = user1@domain : : user2@domain
5287 .endd
5288 &*Note*&: There must be white space between the two colons, as otherwise they
5289 are interpreted as representing a single colon data character (and the list
5290 would then contain just one item). If you want to specify a list that contains
5291 just one, empty item, you can do it as in this example:
5292 .code
5293 senders = :
5294 .endd
5295 In this case, the first item is empty, and the second is discarded because it
5296 is at the end of the list.
5297
5298
5299
5300
5301 .section "Format of driver configurations" "SECTfordricon"
5302 .cindex "drivers" "configuration format"
5303 There are separate parts in the configuration for defining routers, transports,
5304 and authenticators. In each part, you are defining a number of driver
5305 instances, each with its own set of options. Each driver instance is defined by
5306 a sequence of lines like this:
5307 .display
5308 <&'instance name'&>:
5309   <&'option'&>
5310   ...
5311   <&'option'&>
5312 .endd
5313 In the following example, the instance name is &(localuser)&, and it is
5314 followed by three options settings:
5315 .code
5316 localuser:
5317   driver = accept
5318   check_local_user
5319   transport = local_delivery
5320 .endd
5321 For each driver instance, you specify which Exim code module it uses &-- by the
5322 setting of the &%driver%& option &-- and (optionally) some configuration
5323 settings. For example, in the case of transports, if you want a transport to
5324 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5325 a local file you would use the &(appendfile)& driver. Each of the drivers is
5326 described in detail in its own separate chapter later in this manual.
5327
5328 You can have several routers, transports, or authenticators that are based on
5329 the same underlying driver (each must have a different instance name).
5330
5331 The order in which routers are defined is important, because addresses are
5332 passed to individual routers one by one, in order. The order in which
5333 transports are defined does not matter at all. The order in which
5334 authenticators are defined is used only when Exim, as a client, is searching
5335 them to find one that matches an authentication mechanism offered by the
5336 server.
5337
5338 .cindex "generic options"
5339 .cindex "options" "generic &-- definition of"
5340 Within a driver instance definition, there are two kinds of option: &'generic'&
5341 and &'private'&. The generic options are those that apply to all drivers of the
5342 same type (that is, all routers, all transports or all authenticators). The
5343 &%driver%& option is a generic option that must appear in every definition.
5344 .cindex "private options"
5345 The private options are special for each driver, and none need appear, because
5346 they all have default values.
5347
5348 The options may appear in any order, except that the &%driver%& option must
5349 precede any private options, since these depend on the particular driver. For
5350 this reason, it is recommended that &%driver%& always be the first option.
5351
5352 Driver instance names, which are used for reference in log entries and
5353 elsewhere, can be any sequence of letters, digits, and underscores (starting
5354 with a letter) and must be unique among drivers of the same type. A router and
5355 a transport (for example) can each have the same name, but no two router
5356 instances can have the same name. The name of a driver instance should not be
5357 confused with the name of the underlying driver module. For example, the
5358 configuration lines:
5359 .code
5360 remote_smtp:
5361   driver = smtp
5362 .endd
5363 create an instance of the &(smtp)& transport driver whose name is
5364 &(remote_smtp)&. The same driver code can be used more than once, with
5365 different instance names and different option settings each time. A second
5366 instance of the &(smtp)& transport, with different options, might be defined
5367 thus:
5368 .code
5369 special_smtp:
5370   driver = smtp
5371   port = 1234
5372   command_timeout = 10s
5373 .endd
5374 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5375 these transport instances from routers, and these names would appear in log
5376 lines.
5377
5378 Comment lines may be present in the middle of driver specifications. The full
5379 list of option settings for any particular driver instance, including all the
5380 defaulted values, can be extracted by making use of the &%-bP%& command line
5381 option.
5382
5383
5384
5385
5386
5387
5388 . ////////////////////////////////////////////////////////////////////////////
5389 . ////////////////////////////////////////////////////////////////////////////
5390
5391 .chapter "The default configuration file" "CHAPdefconfil"
5392 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5393 .cindex "default" "configuration file &""walk through""&"
5394 The default configuration file supplied with Exim as &_src/configure.default_&
5395 is sufficient for a host with simple mail requirements. As an introduction to
5396 the way Exim is configured, this chapter &"walks through"& the default
5397 configuration, giving brief explanations of the settings. Detailed descriptions
5398 of the options are given in subsequent chapters. The default configuration file
5399 itself contains extensive comments about ways you might want to modify the
5400 initial settings. However, note that there are many options that are not
5401 mentioned at all in the default configuration.
5402
5403
5404
5405 .section "Main configuration settings" "SECTdefconfmain"
5406 The main (global) configuration option settings must always come first in the
5407 file. The first thing you'll see in the file, after some initial comments, is
5408 the line
5409 .code
5410 # primary_hostname =
5411 .endd
5412 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5413 to know the official, fully qualified name of your host, and this is where you
5414 can specify it. However, in most cases you do not need to set this option. When
5415 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5416
5417 The first three non-comment configuration lines are as follows:
5418 .code
5419 domainlist local_domains    = @
5420 domainlist relay_to_domains =
5421 hostlist   relay_from_hosts = 127.0.0.1
5422 .endd
5423 These are not, in fact, option settings. They are definitions of two named
5424 domain lists and one named host list. Exim allows you to give names to lists of
5425 domains, hosts, and email addresses, in order to make it easier to manage the
5426 configuration file (see section &<<SECTnamedlists>>&).
5427
5428 The first line defines a domain list called &'local_domains'&; this is used
5429 later in the configuration to identify domains that are to be delivered
5430 on the local host.
5431
5432 .cindex "@ in a domain list"
5433 There is just one item in this list, the string &"@"&. This is a special form
5434 of entry which means &"the name of the local host"&. Thus, if the local host is
5435 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5436 be delivered locally. Because the local host's name is referenced indirectly,
5437 the same configuration file can be used on different hosts.
5438
5439 The second line defines a domain list called &'relay_to_domains'&, but the
5440 list itself is empty. Later in the configuration we will come to the part that
5441 controls mail relaying through the local host; it allows relaying to any
5442 domains in this list. By default, therefore, no relaying on the basis of a mail
5443 domain is permitted.
5444
5445 The third line defines a host list called &'relay_from_hosts'&. This list is
5446 used later in the configuration to permit relaying from any host or IP address
5447 that matches the list. The default contains just the IP address of the IPv4
5448 loopback interface, which means that processes on the local host are able to
5449 submit mail for relaying by sending it over TCP/IP to that interface. No other
5450 hosts are permitted to submit messages for relaying.
5451
5452 Just to be sure there's no misunderstanding: at this point in the configuration
5453 we aren't actually setting up any controls. We are just defining some domains
5454 and hosts that will be used in the controls that are specified later.
5455
5456 The next two configuration lines are genuine option settings:
5457 .code
5458 acl_smtp_rcpt = acl_check_rcpt
5459 acl_smtp_data = acl_check_data
5460 .endd
5461 These options specify &'Access Control Lists'& (ACLs) that are to be used
5462 during an incoming SMTP session for every recipient of a message (every RCPT
5463 command), and after the contents of the message have been received,
5464 respectively. The names of the lists are &'acl_check_rcpt'& and
5465 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5466 section of the configuration. The RCPT ACL controls which recipients are
5467 accepted for an incoming message &-- if a configuration does not provide an ACL
5468 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5469 contents of a message to be checked.
5470
5471 Two commented-out option settings are next:
5472 .code
5473 # av_scanner = clamd:/tmp/clamd
5474 # spamd_address = 127.0.0.1 783
5475 .endd
5476 These are example settings that can be used when Exim is compiled with the
5477 content-scanning extension. The first specifies the interface to the virus
5478 scanner, and the second specifies the interface to SpamAssassin. Further
5479 details are given in chapter &<<CHAPexiscan>>&.
5480
5481 Three more commented-out option settings follow:
5482 .code
5483 # tls_advertise_hosts = *
5484 # tls_certificate = /etc/ssl/exim.crt
5485 # tls_privatekey = /etc/ssl/exim.pem
5486 .endd
5487 These are example settings that can be used when Exim is compiled with
5488 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5489 first one specifies the list of clients that are allowed to use TLS when
5490 connecting to this server; in this case the wildcard means all clients. The
5491 other options specify where Exim should find its TLS certificate and private
5492 key, which together prove the server's identity to any clients that connect.
5493 More details are given in chapter &<<CHAPTLS>>&.
5494
5495 Another two commented-out option settings follow:
5496 .code
5497 # daemon_smtp_ports = 25 : 465 : 587
5498 # tls_on_connect_ports = 465
5499 .endd
5500 .cindex "port" "465 and 587"
5501 .cindex "port" "for message submission"
5502 .cindex "message" "submission, ports for"
5503 .cindex "ssmtp protocol"
5504 .cindex "smtps protocol"
5505 .cindex "SMTP" "ssmtp protocol"
5506 .cindex "SMTP" "smtps protocol"
5507 These options provide better support for roaming users who wish to use this
5508 server for message submission. They are not much use unless you have turned on
5509 TLS (as described in the previous paragraph) and authentication (about which
5510 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5511 on end-user networks, so RFC 4409 specifies that message submission should use
5512 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5513 configured to use port 587 correctly, so these settings also enable the
5514 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5515 &<<SECTsupobssmt>>&).
5516
5517 Two more commented-out options settings follow:
5518 .code
5519 # qualify_domain =
5520 # qualify_recipient =
5521 .endd
5522 The first of these specifies a domain that Exim uses when it constructs a
5523 complete email address from a local login name. This is often needed when Exim
5524 receives a message from a local process. If you do not set &%qualify_domain%&,
5525 the value of &%primary_hostname%& is used. If you set both of these options,
5526 you can have different qualification domains for sender and recipient
5527 addresses. If you set only the first one, its value is used in both cases.
5528
5529 .cindex "domain literal" "recognizing format"
5530 The following line must be uncommented if you want Exim to recognize
5531 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5532 (an IP address within square brackets) instead of a named domain.
5533 .code
5534 # allow_domain_literals
5535 .endd
5536 The RFCs still require this form, but many people think that in the modern
5537 Internet it makes little sense to permit mail to be sent to specific hosts by
5538 quoting their IP addresses. This ancient format has been used by people who
5539 try to abuse hosts by using them for unwanted relaying. However, some
5540 people believe there are circumstances (for example, messages addressed to
5541 &'postmaster'&) where domain literals are still useful.
5542
5543 The next configuration line is a kind of trigger guard:
5544 .code
5545 never_users = root
5546 .endd
5547 It specifies that no delivery must ever be run as the root user. The normal
5548 convention is to set up &'root'& as an alias for the system administrator. This
5549 setting is a guard against slips in the configuration.
5550 The list of users specified by &%never_users%& is not, however, the complete
5551 list; the build-time configuration in &_Local/Makefile_& has an option called
5552 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5553 contents of &%never_users%& are added to this list. By default
5554 FIXED_NEVER_USERS also specifies root.
5555
5556 When a remote host connects to Exim in order to send mail, the only information
5557 Exim has about the host's identity is its IP address. The next configuration
5558 line,
5559 .code
5560 host_lookup = *
5561 .endd
5562 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5563 in order to get a host name. This improves the quality of the logging
5564 information, but if you feel it is too expensive, you can remove it entirely,
5565 or restrict the lookup to hosts on &"nearby"& networks.
5566 Note that it is not always possible to find a host name from an IP address,
5567 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5568 unreachable.
5569
5570 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5571 1413 (hence their names):
5572 .code
5573 rfc1413_hosts = *
5574 rfc1413_query_timeout = 0s
5575 .endd
5576 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5577 Few hosts offer RFC1413 service these days; calls have to be
5578 terminated by a timeout and this needlessly delays the startup
5579 of an incoming SMTP connection.
5580 If you have hosts for which you trust RFC1413 and need this
5581 information, you can change this.
5582
5583 This line enables an efficiency SMTP option.  It is negociated by clients
5584 and not expected to cause problems but can be disabled if needed.
5585 .code
5586 prdr_enable = true
5587 .endd
5588
5589 When Exim receives messages over SMTP connections, it expects all addresses to
5590 be fully qualified with a domain, as required by the SMTP definition. However,
5591 if you are running a server to which simple clients submit messages, you may
5592 find that they send unqualified addresses. The two commented-out options:
5593 .code
5594 # sender_unqualified_hosts =
5595 # recipient_unqualified_hosts =
5596 .endd
5597 show how you can specify hosts that are permitted to send unqualified sender
5598 and recipient addresses, respectively.
5599
5600 The &%percent_hack_domains%& option is also commented out:
5601 .code
5602 # percent_hack_domains =
5603 .endd
5604 It provides a list of domains for which the &"percent hack"& is to operate.
5605 This is an almost obsolete form of explicit email routing. If you do not know
5606 anything about it, you can safely ignore this topic.
5607
5608 The last two settings in the main part of the default configuration are
5609 concerned with messages that have been &"frozen"& on Exim's queue. When a
5610 message is frozen, Exim no longer continues to try to deliver it. Freezing
5611 occurs when a bounce message encounters a permanent failure because the sender
5612 address of the original message that caused the bounce is invalid, so the
5613 bounce cannot be delivered. This is probably the most common case, but there
5614 are also other conditions that cause freezing, and frozen messages are not
5615 always bounce messages.
5616 .code
5617 ignore_bounce_errors_after = 2d
5618 timeout_frozen_after = 7d
5619 .endd
5620 The first of these options specifies that failing bounce messages are to be
5621 discarded after 2 days on the queue. The second specifies that any frozen
5622 message (whether a bounce message or not) is to be timed out (and discarded)
5623 after a week. In this configuration, the first setting ensures that no failing
5624 bounce message ever lasts a week.
5625
5626
5627
5628 .section "ACL configuration" "SECID54"
5629 .cindex "default" "ACLs"
5630 .cindex "&ACL;" "default configuration"
5631 In the default configuration, the ACL section follows the main configuration.
5632 It starts with the line
5633 .code
5634 begin acl
5635 .endd
5636 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5637 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5638 and &%acl_smtp_data%& above.
5639
5640 .cindex "RCPT" "ACL for"
5641 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5642 RCPT command specifies one of the message's recipients. The ACL statements
5643 are considered in order, until the recipient address is either accepted or
5644 rejected. The RCPT command is then accepted or rejected, according to the
5645 result of the ACL processing.
5646 .code
5647 acl_check_rcpt:
5648 .endd
5649 This line, consisting of a name terminated by a colon, marks the start of the
5650 ACL, and names it.
5651 .code
5652 accept  hosts = :
5653 .endd
5654 This ACL statement accepts the recipient if the sending host matches the list.
5655 But what does that strange list mean? It doesn't actually contain any host
5656 names or IP addresses. The presence of the colon puts an empty item in the
5657 list; Exim matches this only if the incoming message did not come from a remote
5658 host, because in that case, the remote hostname is empty. The colon is
5659 important. Without it, the list itself is empty, and can never match anything.
5660
5661 What this statement is doing is to accept unconditionally all recipients in
5662 messages that are submitted by SMTP from local processes using the standard
5663 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5664 manner.
5665 .code
5666 deny    message       = Restricted characters in address
5667         domains       = +local_domains
5668         local_parts   = ^[.] : ^.*[@%!/|]
5669
5670 deny    message       = Restricted characters in address
5671         domains       = !+local_domains
5672         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5673 .endd
5674 These statements are concerned with local parts that contain any of the
5675 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5676 Although these characters are entirely legal in local parts (in the case of
5677 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5678 in Internet mail addresses.
5679
5680 The first three have in the past been associated with explicitly routed
5681 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5682 option). Addresses containing these characters are regularly tried by spammers
5683 in an attempt to bypass relaying restrictions, and also by open relay testing
5684 programs. Unless you really need them it is safest to reject these characters
5685 at this early stage. This configuration is heavy-handed in rejecting these
5686 characters for all messages it accepts from remote hosts. This is a deliberate
5687 policy of being as safe as possible.
5688
5689 The first rule above is stricter, and is applied to messages that are addressed
5690 to one of the local domains handled by this host. This is implemented by the
5691 first condition, which restricts it to domains that are listed in the
5692 &'local_domains'& domain list. The &"+"& character is used to indicate a
5693 reference to a named list. In this configuration, there is just one domain in
5694 &'local_domains'&, but in general there may be many.
5695
5696 The second condition on the first statement uses two regular expressions to
5697 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5698 or &"|"&. If you have local accounts that include these characters, you will
5699 have to modify this rule.
5700
5701 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5702 allows them because they have been encountered in practice. (Consider the
5703 common convention of local parts constructed as
5704 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5705 the author of Exim, who has no second initial.) However, a local part starting
5706 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5707 file name (for example, for a mailing list). This is also true for local parts
5708 that contain slashes. A pipe symbol can also be troublesome if the local part
5709 is incorporated unthinkingly into a shell command line.
5710
5711 The second rule above applies to all other domains, and is less strict. This
5712 allows your own users to send outgoing messages to sites that use slashes
5713 and vertical bars in their local parts. It blocks local parts that begin
5714 with a dot, slash, or vertical bar, but allows these characters within the
5715 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5716 and &"!"& is blocked, as before. The motivation here is to prevent your users
5717 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5718 .code
5719 accept  local_parts   = postmaster
5720         domains       = +local_domains
5721 .endd
5722 This statement, which has two conditions, accepts an incoming address if the
5723 local part is &'postmaster'& and the domain is one of those listed in the
5724 &'local_domains'& domain list. The &"+"& character is used to indicate a
5725 reference to a named list. In this configuration, there is just one domain in
5726 &'local_domains'&, but in general there may be many.
5727
5728 The presence of this statement means that mail to postmaster is never blocked
5729 by any of the subsequent tests. This can be helpful while sorting out problems
5730 in cases where the subsequent tests are incorrectly denying access.
5731 .code
5732 require verify        = sender
5733 .endd
5734 This statement requires the sender address to be verified before any subsequent
5735 ACL statement can be used. If verification fails, the incoming recipient
5736 address is refused. Verification consists of trying to route the address, to
5737 see if a bounce message could be delivered to it. In the case of remote
5738 addresses, basic verification checks only the domain, but &'callouts'& can be
5739 used for more verification if required. Section &<<SECTaddressverification>>&
5740 discusses the details of address verification.
5741 .code
5742 accept  hosts         = +relay_from_hosts
5743         control       = submission
5744 .endd
5745 This statement accepts the address if the message is coming from one of the
5746 hosts that are defined as being allowed to relay through this host. Recipient
5747 verification is omitted here, because in many cases the clients are dumb MUAs
5748 that do not cope well with SMTP error responses. For the same reason, the
5749 second line specifies &"submission mode"& for messages that are accepted. This
5750 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5751 messages that are deficient in some way, for example, because they lack a
5752 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5753 probably add recipient verification here, and disable submission mode.
5754 .code
5755 accept  authenticated = *
5756         control       = submission
5757 .endd
5758 This statement accepts the address if the client host has authenticated itself.
5759 Submission mode is again specified, on the grounds that such messages are most
5760 likely to come from MUAs. The default configuration does not define any
5761 authenticators, though it does include some nearly complete commented-out
5762 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5763 fact authenticate until you complete the authenticator definitions.
5764 .code
5765 require message = relay not permitted
5766         domains = +local_domains : +relay_to_domains
5767 .endd
5768 This statement rejects the address if its domain is neither a local domain nor
5769 one of the domains for which this host is a relay.
5770 .code
5771 require verify = recipient
5772 .endd
5773 This statement requires the recipient address to be verified; if verification
5774 fails, the address is rejected.
5775 .code
5776 # deny    message     = rejected because $sender_host_address \
5777 #                       is in a black list at $dnslist_domain\n\
5778 #                       $dnslist_text
5779 #         dnslists    = black.list.example
5780 #
5781 # warn    dnslists    = black.list.example
5782 #         add_header  = X-Warning: $sender_host_address is in \
5783 #                       a black list at $dnslist_domain
5784 #         log_message = found in $dnslist_domain
5785 .endd
5786 These commented-out lines are examples of how you could configure Exim to check
5787 sending hosts against a DNS black list. The first statement rejects messages
5788 from blacklisted hosts, whereas the second just inserts a warning header
5789 line.
5790 .code
5791 # require verify = csa
5792 .endd
5793 This commented-out line is an example of how you could turn on client SMTP
5794 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5795 records.
5796 .code
5797 accept
5798 .endd
5799 The final statement in the first ACL unconditionally accepts any recipient
5800 address that has successfully passed all the previous tests.
5801 .code
5802 acl_check_data:
5803 .endd
5804 This line marks the start of the second ACL, and names it. Most of the contents
5805 of this ACL are commented out:
5806 .code
5807 # deny    malware   = *
5808 #         message   = This message contains a virus \
5809 #                     ($malware_name).
5810 .endd
5811 These lines are examples of how to arrange for messages to be scanned for
5812 viruses when Exim has been compiled with the content-scanning extension, and a
5813 suitable virus scanner is installed. If the message is found to contain a
5814 virus, it is rejected with the given custom error message.
5815 .code
5816 # warn    spam      = nobody
5817 #         message   = X-Spam_score: $spam_score\n\
5818 #                     X-Spam_score_int: $spam_score_int\n\
5819 #                     X-Spam_bar: $spam_bar\n\
5820 #                     X-Spam_report: $spam_report
5821 .endd
5822 These lines are an example of how to arrange for messages to be scanned by
5823 SpamAssassin when Exim has been compiled with the content-scanning extension,
5824 and SpamAssassin has been installed. The SpamAssassin check is run with
5825 &`nobody`& as its user parameter, and the results are added to the message as a
5826 series of extra header line. In this case, the message is not rejected,
5827 whatever the spam score.
5828 .code
5829 accept
5830 .endd
5831 This final line in the DATA ACL accepts the message unconditionally.
5832
5833
5834 .section "Router configuration" "SECID55"
5835 .cindex "default" "routers"
5836 .cindex "routers" "default"
5837 The router configuration comes next in the default configuration, introduced
5838 by the line
5839 .code
5840 begin routers
5841 .endd
5842 Routers are the modules in Exim that make decisions about where to send
5843 messages. An address is passed to each router in turn, until it is either
5844 accepted, or failed. This means that the order in which you define the routers
5845 matters. Each router is fully described in its own chapter later in this
5846 manual. Here we give only brief overviews.
5847 .code
5848 # domain_literal:
5849 #   driver = ipliteral
5850 #   domains = !+local_domains
5851 #   transport = remote_smtp
5852 .endd
5853 .cindex "domain literal" "default router"
5854 This router is commented out because the majority of sites do not want to
5855 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5856 you uncomment this router, you also need to uncomment the setting of
5857 &%allow_domain_literals%& in the main part of the configuration.
5858 .code
5859 dnslookup:
5860   driver = dnslookup
5861   domains = ! +local_domains
5862   transport = remote_smtp
5863   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5864   no_more
5865 .endd
5866 The first uncommented router handles addresses that do not involve any local
5867 domains. This is specified by the line
5868 .code
5869 domains = ! +local_domains
5870 .endd
5871 The &%domains%& option lists the domains to which this router applies, but the
5872 exclamation mark is a negation sign, so the router is used only for domains
5873 that are not in the domain list called &'local_domains'& (which was defined at
5874 the start of the configuration). The plus sign before &'local_domains'&
5875 indicates that it is referring to a named list. Addresses in other domains are
5876 passed on to the following routers.
5877
5878 The name of the router driver is &(dnslookup)&,
5879 and is specified by the &%driver%& option. Do not be confused by the fact that
5880 the name of this router instance is the same as the name of the driver. The
5881 instance name is arbitrary, but the name set in the &%driver%& option must be
5882 one of the driver modules that is in the Exim binary.
5883
5884 The &(dnslookup)& router routes addresses by looking up their domains in the
5885 DNS in order to obtain a list of hosts to which the address is routed. If the
5886 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5887 specified by the &%transport%& option. If the router does not find the domain
5888 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5889 the address fails and is bounced.
5890
5891 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5892 be entirely ignored. This option is present because a number of cases have been
5893 encountered where MX records in the DNS point to host names
5894 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5895 Completely ignoring these IP addresses causes Exim to fail to route the
5896 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5897 continue to try to deliver the message periodically until the address timed
5898 out.
5899 .code
5900 system_aliases:
5901   driver = redirect
5902   allow_fail
5903   allow_defer
5904   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5905 # user = exim
5906   file_transport = address_file
5907   pipe_transport = address_pipe
5908 .endd
5909 Control reaches this and subsequent routers only for addresses in the local
5910 domains. This router checks to see whether the local part is defined as an
5911 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5912 data that it looks up from that file. If no data is found for the local part,
5913 the value of the &%data%& option is empty, causing the address to be passed to
5914 the next router.
5915
5916 &_/etc/aliases_& is a conventional name for the system aliases file that is
5917 often used. That is why it is referenced by from the default configuration
5918 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5919 &_Local/Makefile_& before building Exim.
5920 .code
5921 userforward:
5922   driver = redirect
5923   check_local_user
5924 # local_part_suffix = +* : -*
5925 # local_part_suffix_optional
5926   file = $home/.forward
5927 # allow_filter
5928   no_verify
5929   no_expn
5930   check_ancestor
5931   file_transport = address_file
5932   pipe_transport = address_pipe
5933   reply_transport = address_reply
5934 .endd
5935 This is the most complicated router in the default configuration. It is another
5936 redirection router, but this time it is looking for forwarding data set up by
5937 individual users. The &%check_local_user%& setting specifies a check that the
5938 local part of the address is the login name of a local user. If it is not, the
5939 router is skipped. The two commented options that follow &%check_local_user%&,
5940 namely:
5941 .code
5942 # local_part_suffix = +* : -*
5943 # local_part_suffix_optional
5944 .endd
5945 .vindex "&$local_part_suffix$&"
5946 show how you can specify the recognition of local part suffixes. If the first
5947 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5948 by any sequence of characters, is removed from the local part and placed in the
5949 variable &$local_part_suffix$&. The second suffix option specifies that the
5950 presence of a suffix in the local part is optional. When a suffix is present,
5951 the check for a local login uses the local part with the suffix removed.
5952
5953 When a local user account is found, the file called &_.forward_& in the user's
5954 home directory is consulted. If it does not exist, or is empty, the router
5955 declines. Otherwise, the contents of &_.forward_& are interpreted as
5956 redirection data (see chapter &<<CHAPredirect>>& for more details).
5957
5958 .cindex "Sieve filter" "enabling in default router"
5959 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5960 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5961 is commented out by default), the contents of the file are interpreted as a set
5962 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5963 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5964 separate document entitled &'Exim's interfaces to mail filtering'&.
5965
5966 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5967 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5968 There are two reasons for doing this:
5969
5970 .olist
5971 Whether or not a local user has a &_.forward_& file is not really relevant when
5972 checking an address for validity; it makes sense not to waste resources doing
5973 unnecessary work.
5974 .next
5975 More importantly, when Exim is verifying addresses or handling an EXPN
5976 command during an SMTP session, it is running as the Exim user, not as root.
5977 The group is the Exim group, and no additional groups are set up.
5978 It may therefore not be possible for Exim to read users' &_.forward_& files at
5979 this time.
5980 .endlist
5981
5982 The setting of &%check_ancestor%& prevents the router from generating a new
5983 address that is the same as any previous address that was redirected. (This
5984 works round a problem concerning a bad interaction between aliasing and
5985 forwarding &-- see section &<<SECTredlocmai>>&).
5986
5987 The final three option settings specify the transports that are to be used when
5988 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5989 auto-reply, respectively. For example, if a &_.forward_& file contains
5990 .code
5991 a.nother@elsewhere.example, /home/spqr/archive
5992 .endd
5993 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5994 transport.
5995 .code
5996 localuser:
5997   driver = accept
5998   check_local_user
5999 # local_part_suffix = +* : -*
6000 # local_part_suffix_optional
6001   transport = local_delivery
6002 .endd
6003 The final router sets up delivery into local mailboxes, provided that the local
6004 part is the name of a local login, by accepting the address and assigning it to
6005 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6006 routers, so the address is bounced. The commented suffix settings fulfil the
6007 same purpose as they do for the &(userforward)& router.
6008
6009
6010 .section "Transport configuration" "SECID56"
6011 .cindex "default" "transports"
6012 .cindex "transports" "default"
6013 Transports define mechanisms for actually delivering messages. They operate
6014 only when referenced from routers, so the order in which they are defined does
6015 not matter. The transports section of the configuration starts with
6016 .code
6017 begin transports
6018 .endd
6019 One remote transport and four local transports are defined.
6020 .code
6021 remote_smtp:
6022   driver = smtp
6023   hosts_try_prdr = *
6024 .endd
6025 This transport is used for delivering messages over SMTP connections.
6026 The list of remote hosts comes from the router.
6027 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6028 It is negotiated between client and server
6029 and not expected to cause problems but can be disabled if needed.
6030 All other options are defaulted.
6031 .code
6032 local_delivery:
6033   driver = appendfile
6034   file = /var/mail/$local_part
6035   delivery_date_add
6036   envelope_to_add
6037   return_path_add
6038 # group = mail
6039 # mode = 0660
6040 .endd
6041 This &(appendfile)& transport is used for local delivery to user mailboxes in
6042 traditional BSD mailbox format. By default it runs under the uid and gid of the
6043 local user, which requires the sticky bit to be set on the &_/var/mail_&
6044 directory. Some systems use the alternative approach of running mail deliveries
6045 under a particular group instead of using the sticky bit. The commented options
6046 show how this can be done.
6047
6048 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6049 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6050 similarly-named options above.
6051 .code
6052 address_pipe:
6053   driver = pipe
6054   return_output
6055 .endd
6056 This transport is used for handling deliveries to pipes that are generated by
6057 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6058 option specifies that any output generated by the pipe is to be returned to the
6059 sender.
6060 .code
6061 address_file:
6062   driver = appendfile
6063   delivery_date_add
6064   envelope_to_add
6065   return_path_add
6066 .endd
6067 This transport is used for handling deliveries to files that are generated by
6068 redirection. The name of the file is not specified in this instance of
6069 &(appendfile)&, because it comes from the &(redirect)& router.
6070 .code
6071 address_reply:
6072   driver = autoreply
6073 .endd
6074 This transport is used for handling automatic replies generated by users'
6075 filter files.
6076
6077
6078
6079 .section "Default retry rule" "SECID57"
6080 .cindex "retry" "default rule"
6081 .cindex "default" "retry rule"
6082 The retry section of the configuration file contains rules which affect the way
6083 Exim retries deliveries that cannot be completed at the first attempt. It is
6084 introduced by the line
6085 .code
6086 begin retry
6087 .endd
6088 In the default configuration, there is just one rule, which applies to all
6089 errors:
6090 .code
6091 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6092 .endd
6093 This causes any temporarily failing address to be retried every 15 minutes for
6094 2 hours, then at intervals starting at one hour and increasing by a factor of
6095 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6096 is not delivered after 4 days of temporary failure, it is bounced.
6097
6098 If the retry section is removed from the configuration, or is empty (that is,
6099 if no retry rules are defined), Exim will not retry deliveries. This turns
6100 temporary errors into permanent errors.
6101
6102
6103 .section "Rewriting configuration" "SECID58"
6104 The rewriting section of the configuration, introduced by
6105 .code
6106 begin rewrite
6107 .endd
6108 contains rules for rewriting addresses in messages as they arrive. There are no
6109 rewriting rules in the default configuration file.
6110
6111
6112
6113 .section "Authenticators configuration" "SECTdefconfauth"
6114 .cindex "AUTH" "configuration"
6115 The authenticators section of the configuration, introduced by
6116 .code
6117 begin authenticators
6118 .endd
6119 defines mechanisms for the use of the SMTP AUTH command. The default
6120 configuration file contains two commented-out example authenticators
6121 which support plaintext username/password authentication using the
6122 standard PLAIN mechanism and the traditional but non-standard LOGIN
6123 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6124 to support most MUA software.
6125
6126 The example PLAIN authenticator looks like this:
6127 .code
6128 #PLAIN:
6129 #  driver                  = plaintext
6130 #  server_set_id           = $auth2
6131 #  server_prompts          = :
6132 #  server_condition        = Authentication is not yet configured
6133 #  server_advertise_condition = ${if def:tls_in_cipher }
6134 .endd
6135 And the example LOGIN authenticator looks like this:
6136 .code
6137 #LOGIN:
6138 #  driver                  = plaintext
6139 #  server_set_id           = $auth1
6140 #  server_prompts          = <| Username: | Password:
6141 #  server_condition        = Authentication is not yet configured
6142 #  server_advertise_condition = ${if def:tls_in_cipher }
6143 .endd
6144
6145 The &%server_set_id%& option makes Exim remember the authenticated username
6146 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6147 &%server_prompts%& option configures the &(plaintext)& authenticator so
6148 that it implements the details of the specific authentication mechanism,
6149 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6150 when Exim offers authentication to clients; in the examples, this is only
6151 when TLS or SSL has been started, so to enable the authenticators you also
6152 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6153
6154 The &%server_condition%& setting defines how to verify that the username and
6155 password are correct. In the examples it just produces an error message.
6156 To make the authenticators work, you can use a string expansion
6157 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6158
6159 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6160 usercode and password are in different positions.
6161 Chapter &<<CHAPplaintext>>& covers both.
6162
6163 .ecindex IIDconfiwal
6164
6165
6166
6167 . ////////////////////////////////////////////////////////////////////////////
6168 . ////////////////////////////////////////////////////////////////////////////
6169
6170 .chapter "Regular expressions" "CHAPregexp"
6171
6172 .cindex "regular expressions" "library"
6173 .cindex "PCRE"
6174 Exim supports the use of regular expressions in many of its options. It
6175 uses the PCRE regular expression library; this provides regular expression
6176 matching that is compatible with Perl 5. The syntax and semantics of
6177 regular expressions is discussed in many Perl reference books, and also in
6178 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6179 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6180
6181 The documentation for the syntax and semantics of the regular expressions that
6182 are supported by PCRE is included in the PCRE distribution, and no further
6183 description is included here. The PCRE functions are called from Exim using
6184 the default option settings (that is, with no PCRE options set), except that
6185 the PCRE_CASELESS option is set when the matching is required to be
6186 case-insensitive.
6187
6188 In most cases, when a regular expression is required in an Exim configuration,
6189 it has to start with a circumflex, in order to distinguish it from plain text
6190 or an &"ends with"& wildcard. In this example of a configuration setting, the
6191 second item in the colon-separated list is a regular expression.
6192 .code
6193 domains = a.b.c : ^\\d{3} : *.y.z : ...
6194 .endd
6195 The doubling of the backslash is required because of string expansion that
6196 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6197 of this issue, and a way of avoiding the need for doubling backslashes. The
6198 regular expression that is eventually used in this example contains just one
6199 backslash. The circumflex is included in the regular expression, and has the
6200 normal effect of &"anchoring"& it to the start of the string that is being
6201 matched.
6202
6203 There are, however, two cases where a circumflex is not required for the
6204 recognition of a regular expression: these are the &%match%& condition in a
6205 string expansion, and the &%matches%& condition in an Exim filter file. In
6206 these cases, the relevant string is always treated as a regular expression; if
6207 it does not start with a circumflex, the expression is not anchored, and can
6208 match anywhere in the subject string.
6209
6210 In all cases, if you want a regular expression to match at the end of a string,
6211 you must code the $ metacharacter to indicate this. For example:
6212 .code
6213 domains = ^\\d{3}\\.example
6214 .endd
6215 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6216 You need to use:
6217 .code
6218 domains = ^\\d{3}\\.example\$
6219 .endd
6220 if you want &'example'& to be the top-level domain. The backslash before the
6221 $ is needed because string expansion also interprets dollar characters.
6222
6223
6224
6225 . ////////////////////////////////////////////////////////////////////////////
6226 . ////////////////////////////////////////////////////////////////////////////
6227
6228 .chapter "File and database lookups" "CHAPfdlookup"
6229 .scindex IIDfidalo1 "file" "lookups"
6230 .scindex IIDfidalo2 "database" "lookups"
6231 .cindex "lookup" "description of"
6232 Exim can be configured to look up data in files or databases as it processes
6233 messages. Two different kinds of syntax are used:
6234
6235 .olist
6236 A string that is to be expanded may contain explicit lookup requests. These
6237 cause parts of the string to be replaced by data that is obtained from the
6238 lookup. Lookups of this type are conditional expansion items. Different results
6239 can be defined for the cases of lookup success and failure. See chapter
6240 &<<CHAPexpand>>&, where string expansions are described in detail.
6241 .next
6242 Lists of domains, hosts, and email addresses can contain lookup requests as a
6243 way of avoiding excessively long linear lists. In this case, the data that is
6244 returned by the lookup is often (but not always) discarded; whether the lookup
6245 succeeds or fails is what really counts. These kinds of list are described in
6246 chapter &<<CHAPdomhosaddlists>>&.
6247 .endlist
6248
6249 String expansions, lists, and lookups interact with each other in such a way
6250 that there is no order in which to describe any one of them that does not
6251 involve references to the others. Each of these three chapters makes more sense
6252 if you have read the other two first. If you are reading this for the first
6253 time, be aware that some of it will make a lot more sense after you have read
6254 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6255
6256 .section "Examples of different lookup syntax" "SECID60"
6257 It is easy to confuse the two different kinds of lookup, especially as the
6258 lists that may contain the second kind are always expanded before being
6259 processed as lists. Therefore, they may also contain lookups of the first kind.
6260 Be careful to distinguish between the following two examples:
6261 .code
6262 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6263 domains = lsearch;/some/file
6264 .endd
6265 The first uses a string expansion, the result of which must be a domain list.
6266 No strings have been specified for a successful or a failing lookup; the
6267 defaults in this case are the looked-up data and an empty string, respectively.
6268 The expansion takes place before the string is processed as a list, and the
6269 file that is searched could contain lines like this:
6270 .code
6271 192.168.3.4: domain1:domain2:...
6272 192.168.1.9: domain3:domain4:...
6273 .endd
6274 When the lookup succeeds, the result of the expansion is a list of domains (and
6275 possibly other types of item that are allowed in domain lists).
6276
6277 In the second example, the lookup is a single item in a domain list. It causes
6278 Exim to use a lookup to see if the domain that is being processed can be found
6279 in the file. The file could contains lines like this:
6280 .code
6281 domain1:
6282 domain2:
6283 .endd
6284 Any data that follows the keys is not relevant when checking that the domain
6285 matches the list item.
6286
6287 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6288 Consider a file containing lines like this:
6289 .code
6290 192.168.5.6: lsearch;/another/file
6291 .endd
6292 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6293 first &%domains%& setting above generates the second setting, which therefore
6294 causes a second lookup to occur.
6295
6296 The rest of this chapter describes the different lookup types that are
6297 available. Any of them can be used in any part of the configuration where a
6298 lookup is permitted.
6299
6300
6301 .section "Lookup types" "SECID61"
6302 .cindex "lookup" "types of"
6303 .cindex "single-key lookup" "definition of"
6304 Two different types of data lookup are implemented:
6305
6306 .ilist
6307 The &'single-key'& type requires the specification of a file in which to look,
6308 and a single key to search for. The key must be a non-empty string for the
6309 lookup to succeed. The lookup type determines how the file is searched.
6310 .next
6311 .cindex "query-style lookup" "definition of"
6312 The &'query-style'& type accepts a generalized database query. No particular
6313 key value is assumed by Exim for query-style lookups. You can use whichever
6314 Exim variables you need to construct the database query.
6315 .endlist
6316
6317 The code for each lookup type is in a separate source file that is included in
6318 the binary of Exim only if the corresponding compile-time option is set. The
6319 default settings in &_src/EDITME_& are:
6320 .code
6321 LOOKUP_DBM=yes
6322 LOOKUP_LSEARCH=yes
6323 .endd
6324 which means that only linear searching and DBM lookups are included by default.
6325 For some types of lookup (e.g. SQL databases), you need to install appropriate
6326 libraries and header files before building Exim.
6327
6328
6329
6330
6331 .section "Single-key lookup types" "SECTsinglekeylookups"
6332 .cindex "lookup" "single-key types"
6333 .cindex "single-key lookup" "list of types"
6334 The following single-key lookup types are implemented:
6335
6336 .ilist
6337 .cindex "cdb" "description of"
6338 .cindex "lookup" "cdb"
6339 .cindex "binary zero" "in lookup key"
6340 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6341 string without a terminating binary zero. The cdb format is designed for
6342 indexed files that are read frequently and never updated, except by total
6343 re-creation. As such, it is particularly suitable for large files containing
6344 aliases or other indexed data referenced by an MTA. Information about cdb can
6345 be found in several places:
6346 .display
6347 &url(http://www.pobox.com/~djb/cdb.html)
6348 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6349 &url(http://packages.debian.org/stable/utils/freecdb.html)
6350 .endd
6351 A cdb distribution is not needed in order to build Exim with cdb support,
6352 because the code for reading cdb files is included directly in Exim itself.
6353 However, no means of building or testing cdb files is provided with Exim, so
6354 you need to obtain a cdb distribution in order to do this.
6355 .next
6356 .cindex "DBM" "lookup type"
6357 .cindex "lookup" "dbm"
6358 .cindex "binary zero" "in lookup key"
6359 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6360 DBM file by looking up the record with the given key. A terminating binary
6361 zero is included in the key that is passed to the DBM library. See section
6362 &<<SECTdb>>& for a discussion of DBM libraries.
6363
6364 .cindex "Berkeley DB library" "file format"
6365 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6366 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6367 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6368 the DB_UNKNOWN option. This enables it to handle any of the types of database
6369 that the library supports, and can be useful for accessing DBM files created by
6370 other applications. (For earlier DB versions, DB_HASH is always used.)
6371 .next
6372 .cindex "lookup" "dbmjz"
6373 .cindex "lookup" "dbm &-- embedded NULs"
6374 .cindex "sasldb2"
6375 .cindex "dbmjz lookup type"
6376 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6377 interpreted as an Exim list; the elements of the list are joined together with
6378 ASCII NUL characters to form the lookup key.  An example usage would be to
6379 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6380 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6381 &(cram_md5)& authenticator.
6382 .next
6383 .cindex "lookup" "dbmnz"
6384 .cindex "lookup" "dbm &-- terminating zero"
6385 .cindex "binary zero" "in lookup key"
6386 .cindex "Courier"
6387 .cindex "&_/etc/userdbshadow.dat_&"
6388 .cindex "dbmnz lookup type"
6389 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6390 is not included in the key that is passed to the DBM library. You may need this
6391 if you want to look up data in files that are created by or shared with some
6392 other application that does not use terminating zeros. For example, you need to
6393 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6394 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6395 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6396 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6397 .next
6398 .cindex "lookup" "dsearch"
6399 .cindex "dsearch lookup type"
6400 &(dsearch)&: The given file must be a directory; this is searched for an entry
6401 whose name is the key by calling the &[lstat()]& function. The key may not
6402 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6403 the lookup is the name of the entry, which may be a file, directory,
6404 symbolic link, or any other kind of directory entry. An example of how this
6405 lookup can be used to support virtual domains is given in section
6406 &<<SECTvirtualdomains>>&.
6407 .next
6408 .cindex "lookup" "iplsearch"
6409 .cindex "iplsearch lookup type"
6410 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6411 terminated by a colon or white space or the end of the line. The keys in the
6412 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6413 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6414 being interpreted as a key terminator. For example:
6415 .code
6416 1.2.3.4:           data for 1.2.3.4
6417 192.168.0.0/16:    data for 192.168.0.0/16
6418 "abcd::cdab":      data for abcd::cdab
6419 "abcd:abcd::/32"   data for abcd:abcd::/32
6420 .endd
6421 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6422 file is searched linearly, using the CIDR masks where present, until a matching
6423 key is found. The first key that matches is used; there is no attempt to find a
6424 &"best"& match. Apart from the way the keys are matched, the processing for
6425 &(iplsearch)& is the same as for &(lsearch)&.
6426
6427 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6428 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6429 lookup types support only literal keys.
6430
6431 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6432 the implicit key is the host's IP address rather than its name (see section
6433 &<<SECThoslispatsikey>>&).
6434 .next
6435 .cindex "linear search"
6436 .cindex "lookup" "lsearch"
6437 .cindex "lsearch lookup type"
6438 .cindex "case sensitivity" "in lsearch lookup"
6439 &(lsearch)&: The given file is a text file that is searched linearly for a
6440 line beginning with the search key, terminated by a colon or white space or the
6441 end of the line. The search is case-insensitive; that is, upper and lower case
6442 letters are treated as the same. The first occurrence of the key that is found
6443 in the file is used.
6444
6445 White space between the key and the colon is permitted. The remainder of the
6446 line, with leading and trailing white space removed, is the data. This can be
6447 continued onto subsequent lines by starting them with any amount of white
6448 space, but only a single space character is included in the data at such a
6449 junction. If the data begins with a colon, the key must be terminated by a
6450 colon, for example:
6451 .code
6452 baduser:  :fail:
6453 .endd
6454 Empty lines and lines beginning with # are ignored, even if they occur in the
6455 middle of an item. This is the traditional textual format of alias files. Note
6456 that the keys in an &(lsearch)& file are literal strings. There is no
6457 wildcarding of any kind.
6458
6459 .cindex "lookup" "lsearch &-- colons in keys"
6460 .cindex "white space" "in lsearch key"
6461 In most &(lsearch)& files, keys are not required to contain colons or #
6462 characters, or white space. However, if you need this feature, it is available.
6463 If a key begins with a doublequote character, it is terminated only by a
6464 matching quote (or end of line), and the normal escaping rules apply to its
6465 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6466 quoted keys (exactly as for unquoted keys). There is no special handling of
6467 quotes for the data part of an &(lsearch)& line.
6468
6469 .next
6470 .cindex "NIS lookup type"
6471 .cindex "lookup" "NIS"
6472 .cindex "binary zero" "in lookup key"
6473 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6474 the given key, without a terminating binary zero. There is a variant called
6475 &(nis0)& which does include the terminating binary zero in the key. This is
6476 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6477 aliases; the full map names must be used.
6478
6479 .next
6480 .cindex "wildlsearch lookup type"
6481 .cindex "lookup" "wildlsearch"
6482 .cindex "nwildlsearch lookup type"
6483 .cindex "lookup" "nwildlsearch"
6484 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6485 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6486 the file may be wildcarded. The difference between these two lookup types is
6487 that for &(wildlsearch)&, each key in the file is string-expanded before being
6488 used, whereas for &(nwildlsearch)&, no expansion takes place.
6489
6490 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6491 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6492 file that are regular expressions can be made case-sensitive by the use of
6493 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6494
6495 . ==== As this is a nested list, any displays it contains must be indented
6496 . ==== as otherwise they are too far to the left.
6497
6498 .olist
6499 The string may begin with an asterisk to mean &"ends with"&. For example:
6500 .code
6501     *.a.b.c       data for anything.a.b.c
6502     *fish         data for anythingfish
6503 .endd
6504 .next
6505 The string may begin with a circumflex to indicate a regular expression. For
6506 example, for &(wildlsearch)&:
6507 .code
6508     ^\N\d+\.a\.b\N    data for <digits>.a.b
6509 .endd
6510 Note the use of &`\N`& to disable expansion of the contents of the regular
6511 expression. If you are using &(nwildlsearch)&, where the keys are not
6512 string-expanded, the equivalent entry is:
6513 .code
6514     ^\d+\.a\.b        data for <digits>.a.b
6515 .endd
6516 The case-insensitive flag is set at the start of compiling the regular
6517 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6518 For example, to make the entire pattern case-sensitive:
6519 .code
6520     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6521 .endd
6522
6523 If the regular expression contains white space or colon characters, you must
6524 either quote it (see &(lsearch)& above), or represent these characters in other
6525 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6526 colon. This may be easier than quoting, because if you quote, you have to
6527 escape all the backslashes inside the quotes.
6528
6529 &*Note*&: It is not possible to capture substrings in a regular expression
6530 match for later use, because the results of all lookups are cached. If a lookup
6531 is repeated, the result is taken from the cache, and no actual pattern matching
6532 takes place. The values of all the numeric variables are unset after a
6533 &((n)wildlsearch)& match.
6534
6535 .next
6536 Although I cannot see it being of much use, the general matching function that
6537 is used to implement &((n)wildlsearch)& means that the string may begin with a
6538 lookup name terminated by a semicolon, and followed by lookup data. For
6539 example:
6540 .code
6541     cdb;/some/file  data for keys that match the file
6542 .endd
6543 The data that is obtained from the nested lookup is discarded.
6544 .endlist olist
6545
6546 Keys that do not match any of these patterns are interpreted literally. The
6547 continuation rules for the data are the same as for &(lsearch)&, and keys may
6548 be followed by optional colons.
6549
6550 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6551 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6552 lookup types support only literal keys.
6553 .endlist ilist
6554
6555
6556 .section "Query-style lookup types" "SECID62"
6557 .cindex "lookup" "query-style types"
6558 .cindex "query-style lookup" "list of types"
6559 The supported query-style lookup types are listed below. Further details about
6560 many of them are given in later sections.
6561
6562 .ilist
6563 .cindex "DNS" "as a lookup type"
6564 .cindex "lookup" "DNS"
6565 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6566 are given in the supplied query. The resulting data is the contents of the
6567 records. See section &<<SECTdnsdb>>&.
6568 .next
6569 .cindex "InterBase lookup type"
6570 .cindex "lookup" "InterBase"
6571 &(ibase)&: This does a lookup in an InterBase database.
6572 .next
6573 .cindex "LDAP" "lookup type"
6574 .cindex "lookup" "LDAP"
6575 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6576 returns attributes from a single entry. There is a variant called &(ldapm)&
6577 that permits values from multiple entries to be returned. A third variant
6578 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6579 any attribute values. See section &<<SECTldap>>&.
6580 .next
6581 .cindex "MySQL" "lookup type"
6582 .cindex "lookup" "MySQL"
6583 &(mysql)&: The format of the query is an SQL statement that is passed to a
6584 MySQL database. See section &<<SECTsql>>&.
6585 .next
6586 .cindex "NIS+ lookup type"
6587 .cindex "lookup" "NIS+"
6588 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6589 the field to be returned. See section &<<SECTnisplus>>&.
6590 .next
6591 .cindex "Oracle" "lookup type"
6592 .cindex "lookup" "Oracle"
6593 &(oracle)&: The format of the query is an SQL statement that is passed to an
6594 Oracle database. See section &<<SECTsql>>&.
6595 .next
6596 .cindex "lookup" "passwd"
6597 .cindex "passwd lookup type"
6598 .cindex "&_/etc/passwd_&"
6599 &(passwd)& is a query-style lookup with queries that are just user names. The
6600 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6601 success, the result string is the same as you would get from an &(lsearch)&
6602 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6603 password value. For example:
6604 .code
6605 *:42:42:King Rat:/home/kr:/bin/bash
6606 .endd
6607 .next
6608 .cindex "PostgreSQL lookup type"
6609 .cindex "lookup" "PostgreSQL"
6610 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6611 PostgreSQL database. See section &<<SECTsql>>&.
6612
6613 .next
6614 .cindex "sqlite lookup type"
6615 .cindex "lookup" "sqlite"
6616 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6617 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6618
6619 .next
6620 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6621 not likely to be useful in normal operation.
6622 .next
6623 .cindex "whoson lookup type"
6624 .cindex "lookup" "whoson"
6625 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6626 allows a server to check whether a particular (dynamically allocated) IP
6627 address is currently allocated to a known (trusted) user and, optionally, to
6628 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6629 at one time for &"POP before SMTP"& authentication, but that approach has been
6630 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6631 &"POP before SMTP"& checking using ACL statements such as
6632 .code
6633 require condition = \
6634   ${lookup whoson {$sender_host_address}{yes}{no}}
6635 .endd
6636 The query consists of a single IP address. The value returned is the name of
6637 the authenticated user, which is stored in the variable &$value$&. However, in
6638 this example, the data in &$value$& is not used; the result of the lookup is
6639 one of the fixed strings &"yes"& or &"no"&.
6640 .endlist
6641
6642
6643
6644 .section "Temporary errors in lookups" "SECID63"
6645 .cindex "lookup" "temporary error in"
6646 Lookup functions can return temporary error codes if the lookup cannot be
6647 completed. For example, an SQL or LDAP database might be unavailable. For this
6648 reason, it is not advisable to use a lookup that might do this for critical
6649 options such as a list of local domains.
6650
6651 When a lookup cannot be completed in a router or transport, delivery
6652 of the message (to the relevant address) is deferred, as for any other
6653 temporary error. In other circumstances Exim may assume the lookup has failed,
6654 or may give up altogether.
6655
6656
6657
6658 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6659 .cindex "wildcard lookups"
6660 .cindex "lookup" "default values"
6661 .cindex "lookup" "wildcard"
6662 .cindex "lookup" "* added to type"
6663 .cindex "default" "in single-key lookups"
6664 In this context, a &"default value"& is a value specified by the administrator
6665 that is to be used if a lookup fails.
6666
6667 &*Note:*& This section applies only to single-key lookups. For query-style
6668 lookups, the facilities of the query language must be used. An attempt to
6669 specify a default for a query-style lookup provokes an error.
6670
6671 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6672 and the initial lookup fails, the key &"*"& is looked up in the file to
6673 provide a default value. See also the section on partial matching below.
6674
6675 .cindex "*@ with single-key lookup"
6676 .cindex "lookup" "*@ added to type"
6677 .cindex "alias file" "per-domain default"
6678 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6679 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6680 character, a second lookup is done with everything before the last @ replaced
6681 by *. This makes it possible to provide per-domain defaults in alias files
6682 that include the domains in the keys. If the second lookup fails (or doesn't
6683 take place because there is no @ in the key), &"*"& is looked up.
6684 For example, a &(redirect)& router might contain:
6685 .code
6686 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6687 .endd
6688 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6689 looks up these keys, in this order:
6690 .code
6691 jane@eyre.example
6692 *@eyre.example
6693 *
6694 .endd
6695 The data is taken from whichever key it finds first. &*Note*&: In an
6696 &(lsearch)& file, this does not mean the first of these keys in the file. A
6697 complete scan is done for each key, and only if it is not found at all does
6698 Exim move on to try the next key.
6699
6700
6701
6702 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6703 .cindex "partial matching"
6704 .cindex "wildcard lookups"
6705 .cindex "lookup" "partial matching"
6706 .cindex "lookup" "wildcard"
6707 .cindex "asterisk" "in search type"
6708 The normal operation of a single-key lookup is to search the file for an exact
6709 match with the given key. However, in a number of situations where domains are
6710 being looked up, it is useful to be able to do partial matching. In this case,
6711 information in the file that has a key starting with &"*."& is matched by any
6712 domain that ends with the components that follow the full stop. For example, if
6713 a key in a DBM file is
6714 .code
6715 *.dates.fict.example
6716 .endd
6717 then when partial matching is enabled this is matched by (amongst others)
6718 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6719 by &'dates.fict.example'&, if that does not appear as a separate key in the
6720 file.
6721
6722 &*Note*&: Partial matching is not available for query-style lookups. It is
6723 also not available for any lookup items in address lists (see section
6724 &<<SECTaddresslist>>&).
6725
6726 Partial matching is implemented by doing a series of separate lookups using
6727 keys constructed by modifying the original subject key. This means that it can
6728 be used with any of the single-key lookup types, provided that
6729 partial matching keys
6730 beginning with a special prefix (default &"*."&) are included in the data file.
6731 Keys in the file that do not begin with the prefix are matched only by
6732 unmodified subject keys when partial matching is in use.
6733
6734 Partial matching is requested by adding the string &"partial-"& to the front of
6735 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6736 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6737 is added at the start of the subject key, and it is looked up again. If that
6738 fails, further lookups are tried with dot-separated components removed from the
6739 start of the subject key, one-by-one, and &"*."& added on the front of what
6740 remains.
6741
6742 A minimum number of two non-* components are required. This can be adjusted
6743 by including a number before the hyphen in the search type. For example,
6744 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6745 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6746 subject key is &'2250.dates.fict.example'& then the following keys are looked
6747 up when the minimum number of non-* components is two:
6748 .code
6749 2250.dates.fict.example
6750 *.2250.dates.fict.example
6751 *.dates.fict.example
6752 *.fict.example
6753 .endd
6754 As soon as one key in the sequence is successfully looked up, the lookup
6755 finishes.
6756
6757 .cindex "lookup" "partial matching &-- changing prefix"
6758 .cindex "prefix" "for partial matching"
6759 The use of &"*."& as the partial matching prefix is a default that can be
6760 changed. The motivation for this feature is to allow Exim to operate with file
6761 formats that are used by other MTAs. A different prefix can be supplied in
6762 parentheses instead of the hyphen after &"partial"&. For example:
6763 .code
6764 domains = partial(.)lsearch;/some/file
6765 .endd
6766 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6767 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6768 components is unchanged). The prefix may consist of any punctuation characters
6769 other than a closing parenthesis. It may be empty, for example:
6770 .code
6771 domains = partial1()cdb;/some/file
6772 .endd
6773 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6774 &`a.b.c`&, &`b.c`&, and &`c`&.
6775
6776 If &"partial0"& is specified, what happens at the end (when the lookup with
6777 just one non-wild component has failed, and the original key is shortened right
6778 down to the null string) depends on the prefix:
6779
6780 .ilist
6781 If the prefix has zero length, the whole lookup fails.
6782 .next
6783 If the prefix has length 1, a lookup for just the prefix is done. For
6784 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6785 .next
6786 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6787 remainder is looked up. With the default prefix, therefore, the final lookup is
6788 for &"*"& on its own.
6789 .next
6790 Otherwise, the whole prefix is looked up.
6791 .endlist
6792
6793
6794 If the search type ends in &"*"& or &"*@"& (see section
6795 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6796 this implies happens after all partial lookups have failed. If &"partial0"& is
6797 specified, adding &"*"& to the search type has no effect with the default
6798 prefix, because the &"*"& key is already included in the sequence of partial
6799 lookups. However, there might be a use for lookup types such as
6800 &"partial0(.)lsearch*"&.
6801
6802 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6803 in domain lists and the like. Partial matching works only in terms of
6804 dot-separated components; a key such as &`*fict.example`&
6805 in a database file is useless, because the asterisk in a partial matching
6806 subject key is always followed by a dot.
6807
6808
6809
6810
6811 .section "Lookup caching" "SECID64"
6812 .cindex "lookup" "caching"
6813 .cindex "caching" "lookup data"
6814 Exim caches all lookup results in order to avoid needless repetition of
6815 lookups. However, because (apart from the daemon) Exim operates as a collection
6816 of independent, short-lived processes, this caching applies only within a
6817 single Exim process. There is no inter-process lookup caching facility.
6818
6819 For single-key lookups, Exim keeps the relevant files open in case there is
6820 another lookup that needs them. In some types of configuration this can lead to
6821 many files being kept open for messages with many recipients. To avoid hitting
6822 the operating system limit on the number of simultaneously open files, Exim
6823 closes the least recently used file when it needs to open more files than its
6824 own internal limit, which can be changed via the &%lookup_open_max%& option.
6825
6826 The single-key lookup files are closed and the lookup caches are flushed at
6827 strategic points during delivery &-- for example, after all routing is
6828 complete.
6829
6830
6831
6832
6833 .section "Quoting lookup data" "SECID65"
6834 .cindex "lookup" "quoting"
6835 .cindex "quoting" "in lookups"
6836 When data from an incoming message is included in a query-style lookup, there
6837 is the possibility of special characters in the data messing up the syntax of
6838 the query. For example, a NIS+ query that contains
6839 .code
6840 [name=$local_part]
6841 .endd
6842 will be broken if the local part happens to contain a closing square bracket.
6843 For NIS+, data can be enclosed in double quotes like this:
6844 .code
6845 [name="$local_part"]
6846 .endd
6847 but this still leaves the problem of a double quote in the data. The rule for
6848 NIS+ is that double quotes must be doubled. Other lookup types have different
6849 rules, and to cope with the differing requirements, an expansion operator
6850 of the following form is provided:
6851 .code
6852 ${quote_<lookup-type>:<string>}
6853 .endd
6854 For example, the safest way to write the NIS+ query is
6855 .code
6856 [name="${quote_nisplus:$local_part}"]
6857 .endd
6858 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6859 operator can be used for all lookup types, but has no effect for single-key
6860 lookups, since no quoting is ever needed in their key strings.
6861
6862
6863
6864
6865 .section "More about dnsdb" "SECTdnsdb"
6866 .cindex "dnsdb lookup"
6867 .cindex "lookup" "dnsdb"
6868 .cindex "DNS" "as a lookup type"
6869 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6870 of a record type and a domain name, separated by an equals sign. For example,
6871 an expansion string could contain:
6872 .code
6873 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6874 .endd
6875 If the lookup succeeds, the result is placed in &$value$&, which in this case
6876 is used on its own as the result. If the lookup does not succeed, the
6877 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6878 &<<SECTforexpfai>>& for an explanation of what this means.
6879
6880 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
6881 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6882 configured). If no type is given, TXT is assumed. When the type is PTR,
6883 the data can be an IP address, written as normal; inversion and the addition of
6884 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6885 .code
6886 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6887 .endd
6888 If the data for a PTR record is not a syntactically valid IP address, it is not
6889 altered and nothing is added.
6890
6891 For any record type, if multiple records are found (or, for A6 lookups, if a
6892 single record leads to multiple addresses), the data is returned as a
6893 concatenation, with newline as the default separator. The order, of course,
6894 depends on the DNS resolver. You can specify a different separator character
6895 between multiple records by putting a right angle-bracket followed immediately
6896 by the new separator at the start of the query. For example:
6897 .code
6898 ${lookup dnsdb{>: a=host1.example}}
6899 .endd
6900 It is permitted to specify a space as the separator character. Further
6901 white space is ignored.
6902
6903 .cindex "MX record" "in &(dnsdb)& lookup"
6904 .cindex "SRV record" "in &(dnsdb)& lookup"
6905 For an MX lookup, both the preference value and the host name are returned for
6906 each record, separated by a space. For an SRV lookup, the priority, weight,
6907 port, and host name are returned for each record, separated by spaces.
6908 .new
6909 An alternate field separator can be specified using a comma after the main
6910 separator character, followed immediately by the field separator.
6911 .wen
6912
6913 .cindex "TXT record" "in &(dnsdb)& lookup"
6914 .cindex "SPF record" "in &(dnsdb)& lookup"
6915 For TXT records with multiple items of data, only the first item is returned,
6916 unless a separator for them is specified using a comma after the separator
6917 character followed immediately by the TXT record item separator. To concatenate
6918 items without a separator, use a semicolon instead. For SPF records the
6919 default behaviour is to concatenate multiple items without using a separator.
6920 .code
6921 ${lookup dnsdb{>\n,: txt=a.b.example}}
6922 ${lookup dnsdb{>\n; txt=a.b.example}}
6923 ${lookup dnsdb{spf=example.org}}
6924 .endd
6925 It is permitted to specify a space as the separator character. Further
6926 white space is ignored.
6927
6928 .section "Pseudo dnsdb record types" "SECID66"
6929 .cindex "MX record" "in &(dnsdb)& lookup"
6930 By default, both the preference value and the host name are returned for
6931 each MX record, separated by a space. If you want only host names, you can use
6932 the pseudo-type MXH:
6933 .code
6934 ${lookup dnsdb{mxh=a.b.example}}
6935 .endd
6936 In this case, the preference values are omitted, and just the host names are
6937 returned.
6938
6939 .cindex "name server for enclosing domain"
6940 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6941 records on the given domain, but if none are found, it removes the first
6942 component of the domain name, and tries again. This process continues until NS
6943 records are found or there are no more components left (or there is a DNS
6944 error). In other words, it may return the name servers for a top-level domain,
6945 but it never returns the root name servers. If there are no NS records for the
6946 top-level domain, the lookup fails. Consider these examples:
6947 .code
6948 ${lookup dnsdb{zns=xxx.quercite.com}}
6949 ${lookup dnsdb{zns=xxx.edu}}
6950 .endd
6951 Assuming that in each case there are no NS records for the full domain name,
6952 the first returns the name servers for &%quercite.com%&, and the second returns
6953 the name servers for &%edu%&.
6954
6955 You should be careful about how you use this lookup because, unless the
6956 top-level domain does not exist, the lookup always returns some host names. The
6957 sort of use to which this might be put is for seeing if the name servers for a
6958 given domain are on a blacklist. You can probably assume that the name servers
6959 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6960 such a list.
6961
6962 .cindex "CSA" "in &(dnsdb)& lookup"
6963 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6964 records according to the CSA rules, which are described in section
6965 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6966 not sufficient because of the extra parent domain search behaviour of CSA. The
6967 result of a successful lookup such as:
6968 .code
6969 ${lookup dnsdb {csa=$sender_helo_name}}
6970 .endd
6971 has two space-separated fields: an authorization code and a target host name.
6972 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6973 authorization required but absent, or &"?"& for unknown.
6974
6975 .cindex "A+" "in &(dnsdb)& lookup"
6976 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6977 and then an A lookup.  All results are returned; defer processing
6978 (see below) is handled separately for each lookup.  Example:
6979 .code
6980 ${lookup dnsdb {>; a+=$sender_helo_name}}
6981 .endd
6982
6983
6984 .section "Multiple dnsdb lookups" "SECID67"
6985 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6986 However, you can specify a list of domains or IP addresses in a single
6987 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6988 the default separator, but with the ability to change this. For example:
6989 .code
6990 ${lookup dnsdb{one.domain.com:two.domain.com}}
6991 ${lookup dnsdb{a=one.host.com:two.host.com}}
6992 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6993 .endd
6994 In order to retain backwards compatibility, there is one special case: if
6995 the lookup type is PTR and no change of separator is specified, Exim looks
6996 to see if the rest of the string is precisely one IPv6 address. In this
6997 case, it does not treat it as a list.
6998
6999 The data from each lookup is concatenated, with newline separators by default,
7000 in the same way that multiple DNS records for a single item are handled. A
7001 different separator can be specified, as described above.
7002
7003 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
7004 each followed by a comma,
7005 that may appear before the record type.
7006
7007 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7008 temporary DNS error for any of them, the behaviour is controlled by
7009 a defer-option modifier.
7010 The possible keywords are
7011 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7012 With &"strict"& behaviour, any temporary DNS error causes the
7013 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7014 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7015 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7016 error causes the whole lookup to defer only if none of the other lookups
7017 succeed. The default is &"lax"&, so the following lookups are equivalent:
7018 .code
7019 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7020 ${lookup dnsdb{a=one.host.com:two.host.com}}
7021 .endd
7022 Thus, in the default case, as long as at least one of the DNS lookups
7023 yields some data, the lookup succeeds.
7024
7025 .cindex "DNSSEC" "dns lookup"
7026 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7027 The possible keywords are
7028 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7029 With &"strict"& or &"lax"& DNSSEC information is requested
7030 with the lookup.
7031 With &"strict"& a response from the DNS resolver that
7032 is not labelled as authenticated data
7033 is treated as equivalent to a temporary DNS error.
7034 The default is &"never"&.
7035
7036 See also the &$lookup_dnssec_authenticated$& variable.
7037
7038
7039
7040
7041 .section "More about LDAP" "SECTldap"
7042 .cindex "LDAP" "lookup, more about"
7043 .cindex "lookup" "LDAP"
7044 .cindex "Solaris" "LDAP"
7045 The original LDAP implementation came from the University of Michigan; this has
7046 become &"Open LDAP"&, and there are now two different releases. Another
7047 implementation comes from Netscape, and Solaris 7 and subsequent releases
7048 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7049 the lookup function level, their error handling is different. For this reason
7050 it is necessary to set a compile-time variable when building Exim with LDAP, to
7051 indicate which LDAP library is in use. One of the following should appear in
7052 your &_Local/Makefile_&:
7053 .code
7054 LDAP_LIB_TYPE=UMICHIGAN
7055 LDAP_LIB_TYPE=OPENLDAP1
7056 LDAP_LIB_TYPE=OPENLDAP2
7057 LDAP_LIB_TYPE=NETSCAPE
7058 LDAP_LIB_TYPE=SOLARIS
7059 .endd
7060 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7061 same interface as the University of Michigan version.
7062
7063 There are three LDAP lookup types in Exim. These behave slightly differently in
7064 the way they handle the results of a query:
7065
7066 .ilist
7067 &(ldap)& requires the result to contain just one entry; if there are more, it
7068 gives an error.
7069 .next
7070 &(ldapdn)& also requires the result to contain just one entry, but it is the
7071 Distinguished Name that is returned rather than any attribute values.
7072 .next
7073 &(ldapm)& permits the result to contain more than one entry; the attributes
7074 from all of them are returned.
7075 .endlist
7076
7077
7078 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7079 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7080 the data returned by a successful lookup is described in the next section.
7081 First we explain how LDAP queries are coded.
7082
7083
7084 .section "Format of LDAP queries" "SECTforldaque"
7085 .cindex "LDAP" "query format"
7086 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7087 the configuration of a &(redirect)& router one might have this setting:
7088 .code
7089 data = ${lookup ldap \
7090   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7091   c=UK?mailbox?base?}}
7092 .endd
7093 .cindex "LDAP" "with TLS"
7094 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7095 secure (encrypted) LDAP connections. The second of these ensures that an
7096 encrypted TLS connection is used.
7097
7098 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7099 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7100 See the &%ldap_start_tls%& option.
7101
7102 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7103 controlled. Every part of the TLS configuration can be configured by settings in
7104 &_exim.conf_&. Depending on the version of the client libraries installed on
7105 your system, some of the initialization may have required setting options in
7106 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7107 certificates. This revealed a nuance where the current UID that exim was
7108 running as could affect which config files it read. With Exim 4.83, these
7109 methods become optional, only taking effect if not specifically set in
7110 &_exim.conf_&.
7111
7112
7113 .section "LDAP quoting" "SECID68"
7114 .cindex "LDAP" "quoting"
7115 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7116 and the second because the LDAP query is represented as a URL. Furthermore,
7117 within an LDAP query, two different kinds of quoting are required. For this
7118 reason, there are two different LDAP-specific quoting operators.
7119
7120 The &%quote_ldap%& operator is designed for use on strings that are part of
7121 filter specifications. Conceptually, it first does the following conversions on
7122 the string:
7123 .code
7124 *   =>   \2A
7125 (   =>   \28
7126 )   =>   \29
7127 \   =>   \5C
7128 .endd
7129 in accordance with RFC 2254. The resulting string is then quoted according
7130 to the rules for URLs, that is, all non-alphanumeric characters except
7131 .code
7132 ! $ ' - . _ ( ) * +
7133 .endd
7134 are converted to their hex values, preceded by a percent sign. For example:
7135 .code
7136 ${quote_ldap: a(bc)*, a<yz>; }
7137 .endd
7138 yields
7139 .code
7140 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7141 .endd
7142 Removing the URL quoting, this is (with a leading and a trailing space):
7143 .code
7144 a\28bc\29\2A, a<yz>;
7145 .endd
7146 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7147 base DN specifications in queries. Conceptually, it first converts the string
7148 by inserting a backslash in front of any of the following characters:
7149 .code
7150 , + " \ < > ;
7151 .endd
7152 It also inserts a backslash before any leading spaces or # characters, and
7153 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7154 is then quoted according to the rules for URLs. For example:
7155 .code
7156 ${quote_ldap_dn: a(bc)*, a<yz>; }
7157 .endd
7158 yields
7159 .code
7160 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7161 .endd
7162 Removing the URL quoting, this is (with a trailing space):
7163 .code
7164 \ a(bc)*\, a\<yz\>\;\
7165 .endd
7166 There are some further comments about quoting in the section on LDAP
7167 authentication below.
7168
7169
7170 .section "LDAP connections" "SECID69"
7171 .cindex "LDAP" "connections"
7172 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7173 is in use, via a Unix domain socket. The example given above does not specify
7174 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7175 by starting it with
7176 .code
7177 ldap://<hostname>:<port>/...
7178 .endd
7179 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7180 used. When no server is specified in a query, a list of default servers is
7181 taken from the &%ldap_default_servers%& configuration option. This supplies a
7182 colon-separated list of servers which are tried in turn until one successfully
7183 handles a query, or there is a serious error. Successful handling either
7184 returns the requested data, or indicates that it does not exist. Serious errors
7185 are syntactical, or multiple values when only a single value is expected.
7186 Errors which cause the next server to be tried are connection failures, bind
7187 failures, and timeouts.
7188
7189 For each server name in the list, a port number can be given. The standard way
7190 of specifying a host and port is to use a colon separator (RFC 1738). Because
7191 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7192 doubled. For example
7193 .code
7194 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7195 .endd
7196 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7197 to the LDAP library with no server name, and the library's default (normally
7198 the local host) is used.
7199
7200 If you are using the OpenLDAP library, you can connect to an LDAP server using
7201 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7202 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7203 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7204 not available.
7205
7206 For this type of connection, instead of a host name for the server, a pathname
7207 for the socket is required, and the port number is not relevant. The pathname
7208 can be specified either as an item in &%ldap_default_servers%&, or inline in
7209 the query. In the former case, you can have settings such as
7210 .code
7211 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7212 .endd
7213 When the pathname is given in the query, you have to escape the slashes as
7214 &`%2F`& to fit in with the LDAP URL syntax. For example:
7215 .code
7216 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7217 .endd
7218 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7219 a pathname, it uses the Unix domain socket code, even if the query actually
7220 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7221 socket connection. This behaviour means that you can use a setting of
7222 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7223 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7224 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7225 backup host.
7226
7227 If an explicit &`ldapi`& type is given in a query when a host name is
7228 specified, an error is diagnosed. However, if there are more items in
7229 &%ldap_default_servers%&, they are tried. In other words:
7230
7231 .ilist
7232 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7233 interface.
7234 .next
7235 Using &`ldapi`& with a host name causes an error.
7236 .endlist
7237
7238
7239 Using &`ldapi`& with no host or path in the query, and no setting of
7240 &%ldap_default_servers%&, does whatever the library does by default.
7241
7242
7243
7244 .section "LDAP authentication and control information" "SECID70"
7245 .cindex "LDAP" "authentication"
7246 The LDAP URL syntax provides no way of passing authentication and other control
7247 information to the server. To make this possible, the URL in an LDAP query may
7248 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7249 spaces. If a value contains spaces it must be enclosed in double quotes, and
7250 when double quotes are used, backslash is interpreted in the usual way inside
7251 them. The following names are recognized:
7252 .display
7253 &`DEREFERENCE`&  set the dereferencing parameter
7254 &`NETTIME    `&  set a timeout for a network operation
7255 &`USER       `&  set the DN, for authenticating the LDAP bind
7256 &`PASS       `&  set the password, likewise
7257 &`REFERRALS  `&  set the referrals parameter
7258 &`SERVERS    `&  set alternate server list for this query only
7259 &`SIZE       `&  set the limit for the number of entries returned
7260 &`TIME       `&  set the maximum waiting time for a query
7261 .endd
7262 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7263 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7264 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7265 library from trying to follow referrals issued by the LDAP server.
7266
7267 The name CONNECT is an obsolete name for NETTIME, retained for
7268 backwards compatibility. This timeout (specified as a number of seconds) is
7269 enforced from the client end for operations that can be carried out over a
7270 network. Specifically, it applies to network connections and calls to the
7271 &'ldap_result()'& function. If the value is greater than zero, it is used if
7272 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7273 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7274 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7275 Netscape SDK; for OpenLDAP no action is taken.
7276
7277 The TIME parameter (also a number of seconds) is passed to the server to
7278 set a server-side limit on the time taken to complete a search.
7279
7280 The SERVERS parameter allows you to specify an alternate list of ldap servers
7281 to use for an individual lookup.  The global ldap_servers option provides a
7282 default list of ldap servers, and a single lookup can specify a single ldap
7283 server to use.  But when you need to do a lookup with a list of servers that is
7284 different than the default list (maybe different order, maybe a completely
7285 different set of servers), the SERVERS parameter allows you to specify this
7286 alternate list (colon-separated).
7287
7288 Here is an example of an LDAP query in an Exim lookup that uses some of these
7289 values. This is a single line, folded to fit on the page:
7290 .code
7291 ${lookup ldap
7292   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7293   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7294   {$value}fail}
7295 .endd
7296 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7297 any of the auxiliary data. Exim configuration settings that include lookups
7298 which contain password information should be preceded by &"hide"& to prevent
7299 non-admin users from using the &%-bP%& option to see their values.
7300
7301 The auxiliary data items may be given in any order. The default is no
7302 connection timeout (the system timeout is used), no user or password, no limit
7303 on the number of entries returned, and no time limit on queries.
7304
7305 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7306 removes any URL quoting that it may contain before passing it LDAP. Apparently
7307 some libraries do this for themselves, but some do not. Removing the URL
7308 quoting has two advantages:
7309
7310 .ilist
7311 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7312 DNs as with DNs inside actual queries.
7313 .next
7314 It permits spaces inside USER= DNs.
7315 .endlist
7316
7317 For example, a setting such as
7318 .code
7319 USER=cn=${quote_ldap_dn:$1}
7320 .endd
7321 should work even if &$1$& contains spaces.
7322
7323 Expanded data for the PASS= value should be quoted using the &%quote%&
7324 expansion operator, rather than the LDAP quote operators. The only reason this
7325 field needs quoting is to ensure that it conforms to the Exim syntax, which
7326 does not allow unquoted spaces. For example:
7327 .code
7328 PASS=${quote:$3}
7329 .endd
7330 The LDAP authentication mechanism can be used to check passwords as part of
7331 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7332 &<<CHAPexpand>>&.
7333
7334
7335
7336 .section "Format of data returned by LDAP" "SECID71"
7337 .cindex "LDAP" "returned data formats"
7338 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7339 as a sequence of values, for example
7340 .code
7341 cn=manager, o=University of Cambridge, c=UK
7342 .endd
7343 The &(ldap)& lookup type generates an error if more than one entry matches the
7344 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7345 the result between the data from different entries. It is possible for multiple
7346 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7347 you know that whatever values are returned all came from a single entry in the
7348 directory.
7349
7350 In the common case where you specify a single attribute in your LDAP query, the
7351 result is not quoted, and does not contain the attribute name. If the attribute
7352 has multiple values, they are separated by commas.
7353
7354 If you specify multiple attributes, the result contains space-separated, quoted
7355 strings, each preceded by the attribute name and an equals sign. Within the
7356 quotes, the quote character, backslash, and newline are escaped with
7357 backslashes, and commas are used to separate multiple values for the attribute.
7358 .new
7359 Any commas in attribute values are doubled
7360 (permitting treatment of the values as a comma-separated list).
7361 .wen
7362 Apart from the escaping, the string within quotes takes the same form as the
7363 output when a single attribute is requested. Specifying no attributes is the
7364 same as specifying all of an entry's attributes.
7365
7366 .new
7367 Here are some examples of the output format. The first line of each pair is an
7368 LDAP query, and the second is the data that is returned. The attribute called
7369 &%attr1%& has two values, one of them with an embedded comma, whereas
7370 &%attr2%& has only one value:
7371 .code
7372 ldap:///o=base?attr1?sub?(uid=fred)
7373 value1.1,value1,,2
7374
7375 ldap:///o=base?attr2?sub?(uid=fred)
7376 value two
7377
7378 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7379 attr1="value1.1,value1,,2" attr2="value two"
7380
7381 ldap:///o=base??sub?(uid=fred)
7382 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7383 .endd
7384 .wen
7385 You can
7386 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7387 results of LDAP lookups.
7388 The &%extract%& operator in string expansions can be used to pick out
7389 individual fields from data that consists of &'key'&=&'value'& pairs.
7390 .new
7391 The &%listextract%& operator should be used to pick out individual values
7392 of attributes, even when only a single value is expected.
7393 The doubling of embedded commas allows you to use the returned data as a
7394 comma separated list (using the "<," syntax for changing the input list separator).
7395 .wen
7396
7397
7398
7399
7400 .section "More about NIS+" "SECTnisplus"
7401 .cindex "NIS+ lookup type"
7402 .cindex "lookup" "NIS+"
7403 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7404 and field name. If this is given, the result of a successful query is the
7405 contents of the named field; otherwise the result consists of a concatenation
7406 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7407 values containing spaces are quoted. For example, the query
7408 .code
7409 [name=mg1456],passwd.org_dir
7410 .endd
7411 might return the string
7412 .code
7413 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7414 home=/home/mg1456 shell=/bin/bash shadow=""
7415 .endd
7416 (split over two lines here to fit on the page), whereas
7417 .code
7418 [name=mg1456],passwd.org_dir:gcos
7419 .endd
7420 would just return
7421 .code
7422 Martin Guerre
7423 .endd
7424 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7425 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7426 operator is to double any quote characters within the text.
7427
7428
7429
7430 .section "SQL lookups" "SECTsql"
7431 .cindex "SQL lookup types"
7432 .cindex "MySQL" "lookup type"
7433 .cindex "PostgreSQL lookup type"
7434 .cindex "lookup" "MySQL"
7435 .cindex "lookup" "PostgreSQL"
7436 .cindex "Oracle" "lookup type"
7437 .cindex "lookup" "Oracle"
7438 .cindex "InterBase lookup type"
7439 .cindex "lookup" "InterBase"
7440 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7441 databases. Queries for these databases contain SQL statements, so an example
7442 might be
7443 .code
7444 ${lookup mysql{select mailbox from users where id='userx'}\
7445   {$value}fail}
7446 .endd
7447 If the result of the query contains more than one field, the data for each
7448 field in the row is returned, preceded by its name, so the result of
7449 .code
7450 ${lookup pgsql{select home,name from users where id='userx'}\
7451   {$value}}
7452 .endd
7453 might be
7454 .code
7455 home=/home/userx name="Mister X"
7456 .endd
7457 Empty values and values containing spaces are double quoted, with embedded
7458 quotes escaped by a backslash. If the result of the query contains just one
7459 field, the value is passed back verbatim, without a field name, for example:
7460 .code
7461 Mister X
7462 .endd
7463 If the result of the query yields more than one row, it is all concatenated,
7464 with a newline between the data for each row.
7465
7466
7467 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7468 .cindex "MySQL" "lookup type"
7469 .cindex "PostgreSQL lookup type"
7470 .cindex "lookup" "MySQL"
7471 .cindex "lookup" "PostgreSQL"
7472 .cindex "Oracle" "lookup type"
7473 .cindex "lookup" "Oracle"
7474 .cindex "InterBase lookup type"
7475 .cindex "lookup" "InterBase"
7476 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7477 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7478 option (as appropriate) must be set to a colon-separated list of server
7479 information.
7480 (For MySQL and PostgreSQL only, the global option need not be set if all
7481 queries contain their own server information &-- see section
7482 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7483 items: host name, database name, user name, and password. In the case of
7484 Oracle, the host name field is used for the &"service name"&, and the database
7485 name field is not used and should be empty. For example:
7486 .code
7487 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7488 .endd
7489 Because password data is sensitive, you should always precede the setting with
7490 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7491 option. Here is an example where two MySQL servers are listed:
7492 .code
7493 hide mysql_servers = localhost/users/root/secret:\
7494                      otherhost/users/root/othersecret
7495 .endd
7496 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7497 because this is a colon-separated list, the colon has to be doubled. For each
7498 query, these parameter groups are tried in order until a connection is made and
7499 a query is successfully processed. The result of a query may be that no data is
7500 found, but that is still a successful query. In other words, the list of
7501 servers provides a backup facility, not a list of different places to look.
7502
7503 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7504 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7505 respectively, and the characters single-quote, double-quote, and backslash
7506 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7507 addition, escapes the percent and underscore characters. This cannot be done
7508 for MySQL because these escapes are not recognized in contexts where these
7509 characters are not special.
7510
7511 .section "Specifying the server in the query" "SECTspeserque"
7512 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7513 it is possible to specify a list of servers with an individual query. This is
7514 done by starting the query with
7515 .display
7516 &`servers=`&&'server1:server2:server3:...'&&`;`&
7517 .endd
7518 Each item in the list may take one of two forms:
7519 .olist
7520 If it contains no slashes it is assumed to be just a host name. The appropriate
7521 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7522 of the same name, and the remaining parameters (database, user, password) are
7523 taken from there.
7524 .next
7525 If it contains any slashes, it is taken as a complete parameter set.
7526 .endlist
7527 The list of servers is used in exactly the same way as the global list.
7528 Once a connection to a server has happened and a query has been
7529 successfully executed, processing of the lookup ceases.
7530
7531 This feature is intended for use in master/slave situations where updates
7532 are occurring and you want to update the master rather than a slave. If the
7533 master is in the list as a backup for reading, you might have a global setting
7534 like this:
7535 .code
7536 mysql_servers = slave1/db/name/pw:\
7537                 slave2/db/name/pw:\
7538                 master/db/name/pw
7539 .endd
7540 In an updating lookup, you could then write:
7541 .code
7542 ${lookup mysql{servers=master; UPDATE ...} }
7543 .endd
7544 That query would then be sent only to the master server. If, on the other hand,
7545 the master is not to be used for reading, and so is not present in the global
7546 option, you can still update it by a query of this form:
7547 .code
7548 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7549 .endd
7550
7551
7552 .section "Special MySQL features" "SECID73"
7553 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7554 causes a connection to the server on the local host by means of a Unix domain
7555 socket. An alternate socket can be specified in parentheses. The full syntax of
7556 each item in &%mysql_servers%& is:
7557 .display
7558 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7559   <&'user'&>/<&'password'&>
7560 .endd
7561 Any of the three sub-parts of the first field can be omitted. For normal use on
7562 the local host it can be left blank or set to just &"localhost"&.
7563
7564 No database need be supplied &-- but if it is absent here, it must be given in
7565 the queries.
7566
7567 If a MySQL query is issued that does not request any data (an insert, update,
7568 or delete command), the result of the lookup is the number of rows affected.
7569
7570 &*Warning*&: This can be misleading. If an update does not actually change
7571 anything (for example, setting a field to the value it already has), the result
7572 is zero because no rows are affected.
7573
7574
7575 .section "Special PostgreSQL features" "SECID74"
7576 PostgreSQL lookups can also use Unix domain socket connections to the database.
7577 This is usually faster and costs less CPU time than a TCP/IP connection.
7578 However it can be used only if the mail server runs on the same machine as the
7579 database server. A configuration line for PostgreSQL via Unix domain sockets
7580 looks like this:
7581 .code
7582 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7583 .endd
7584 In other words, instead of supplying a host name, a path to the socket is
7585 given. The path name is enclosed in parentheses so that its slashes aren't
7586 visually confused with the delimiters for the other server parameters.
7587
7588 If a PostgreSQL query is issued that does not request any data (an insert,
7589 update, or delete command), the result of the lookup is the number of rows
7590 affected.
7591
7592 .section "More about SQLite" "SECTsqlite"
7593 .cindex "lookup" "SQLite"
7594 .cindex "sqlite lookup type"
7595 SQLite is different to the other SQL lookups because a file name is required in
7596 addition to the SQL query. An SQLite database is a single file, and there is no
7597 daemon as in the other SQL databases. The interface to Exim requires the name
7598 of the file, as an absolute path, to be given at the start of the query. It is
7599 separated from the query by white space. This means that the path name cannot
7600 contain white space. Here is a lookup expansion example:
7601 .code
7602 ${lookup sqlite {/some/thing/sqlitedb \
7603   select name from aliases where id='userx';}}
7604 .endd
7605 In a list, the syntax is similar. For example:
7606 .code
7607 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7608    select * from relays where ip='$sender_host_address';
7609 .endd
7610 The only character affected by the &%quote_sqlite%& operator is a single
7611 quote, which it doubles.
7612
7613 The SQLite library handles multiple simultaneous accesses to the database
7614 internally. Multiple readers are permitted, but only one process can
7615 update at once. Attempts to access the database while it is being updated
7616 are rejected after a timeout period, during which the SQLite library
7617 waits for the lock to be released. In Exim, the default timeout is set
7618 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7619 option.
7620 .ecindex IIDfidalo1
7621 .ecindex IIDfidalo2
7622
7623
7624 . ////////////////////////////////////////////////////////////////////////////
7625 . ////////////////////////////////////////////////////////////////////////////
7626
7627 .chapter "Domain, host, address, and local part lists" &&&
7628          "CHAPdomhosaddlists" &&&
7629          "Domain, host, and address lists"
7630 .scindex IIDdohoadli "lists of domains; hosts; etc."
7631 A number of Exim configuration options contain lists of domains, hosts,
7632 email addresses, or local parts. For example, the &%hold_domains%& option
7633 contains a list of domains whose delivery is currently suspended. These lists
7634 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7635 arguments to expansion conditions such as &%match_domain%&.
7636
7637 Each item in one of these lists is a pattern to be matched against a domain,
7638 host, email address, or local part, respectively. In the sections below, the
7639 different types of pattern for each case are described, but first we cover some
7640 general facilities that apply to all four kinds of list.
7641
7642
7643
7644 .section "Expansion of lists" "SECID75"
7645 .cindex "expansion" "of lists"
7646 Each list is expanded as a single string before it is used. The result of
7647 expansion must be a list, possibly containing empty items, which is split up
7648 into separate items for matching. By default, colon is the separator character,
7649 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7650 &<<SECTempitelis>>& for details of the list syntax; the second of these
7651 discusses the way to specify empty list items.
7652
7653
7654 If the string expansion is forced to fail, Exim behaves as if the item it is
7655 testing (domain, host, address, or local part) is not in the list. Other
7656 expansion failures cause temporary errors.
7657
7658 If an item in a list is a regular expression, backslashes, dollars and possibly
7659 other special characters in the expression must be protected against
7660 misinterpretation by the string expander. The easiest way to do this is to use
7661 the &`\N`& expansion feature to indicate that the contents of the regular
7662 expression should not be expanded. For example, in an ACL you might have:
7663 .code
7664 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7665                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7666 .endd
7667 The first item is a regular expression that is protected from expansion by
7668 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7669 senders based on the receiving domain.
7670
7671
7672
7673
7674 .section "Negated items in lists" "SECID76"
7675 .cindex "list" "negation"
7676 .cindex "negation" "in lists"
7677 Items in a list may be positive or negative. Negative items are indicated by a
7678 leading exclamation mark, which may be followed by optional white space. A list
7679 defines a set of items (domains, etc). When Exim processes one of these lists,
7680 it is trying to find out whether a domain, host, address, or local part
7681 (respectively) is in the set that is defined by the list. It works like this:
7682
7683 The list is scanned from left to right. If a positive item is matched, the
7684 subject that is being checked is in the set; if a negative item is matched, the
7685 subject is not in the set. If the end of the list is reached without the
7686 subject having matched any of the patterns, it is in the set if the last item
7687 was a negative one, but not if it was a positive one. For example, the list in
7688 .code
7689 domainlist relay_to_domains = !a.b.c : *.b.c
7690 .endd
7691 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7692 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7693 list is positive. However, if the setting were
7694 .code
7695 domainlist relay_to_domains = !a.b.c
7696 .endd
7697 then all domains other than &'a.b.c'& would match because the last item in the
7698 list is negative. In other words, a list that ends with a negative item behaves
7699 as if it had an extra item &`:*`& on the end.
7700
7701 Another way of thinking about positive and negative items in lists is to read
7702 the connector as &"or"& after a positive item and as &"and"& after a negative
7703 item.
7704
7705
7706
7707 .section "File names in lists" "SECTfilnamlis"
7708 .cindex "list" "file name in"
7709 If an item in a domain, host, address, or local part list is an absolute file
7710 name (beginning with a slash character), each line of the file is read and
7711 processed as if it were an independent item in the list, except that further
7712 file names are not allowed,
7713 and no expansion of the data from the file takes place.
7714 Empty lines in the file are ignored, and the file may also contain comment
7715 lines:
7716
7717 .ilist
7718 For domain and host lists, if a # character appears anywhere in a line of the
7719 file, it and all following characters are ignored.
7720 .next
7721 Because local parts may legitimately contain # characters, a comment in an
7722 address list or local part list file is recognized only if # is preceded by
7723 white space or the start of the line. For example:
7724 .code
7725 not#comment@x.y.z   # but this is a comment
7726 .endd
7727 .endlist
7728
7729 Putting a file name in a list has the same effect as inserting each line of the
7730 file as an item in the list (blank lines and comments excepted). However, there
7731 is one important difference: the file is read each time the list is processed,
7732 so if its contents vary over time, Exim's behaviour changes.
7733
7734 If a file name is preceded by an exclamation mark, the sense of any match
7735 within the file is inverted. For example, if
7736 .code
7737 hold_domains = !/etc/nohold-domains
7738 .endd
7739 and the file contains the lines
7740 .code
7741 !a.b.c
7742 *.b.c
7743 .endd
7744 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7745 any domain matching &`*.b.c`& is not.
7746
7747
7748
7749 .section "An lsearch file is not an out-of-line list" "SECID77"
7750 As will be described in the sections that follow, lookups can be used in lists
7751 to provide indexed methods of checking list membership. There has been some
7752 confusion about the way &(lsearch)& lookups work in lists. Because
7753 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7754 sometimes thought that it is allowed to contain wild cards and other kinds of
7755 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7756 always fixed strings, just as for any other single-key lookup type.
7757
7758 If you want to use a file to contain wild-card patterns that form part of a
7759 list, just give the file name on its own, without a search type, as described
7760 in the previous section. You could also use the &(wildlsearch)& or
7761 &(nwildlsearch)&, but there is no advantage in doing this.
7762
7763
7764
7765
7766 .section "Named lists" "SECTnamedlists"
7767 .cindex "named lists"
7768 .cindex "list" "named"
7769 A list of domains, hosts, email addresses, or local parts can be given a name
7770 which is then used to refer to the list elsewhere in the configuration. This is
7771 particularly convenient if the same list is required in several different
7772 places. It also allows lists to be given meaningful names, which can improve
7773 the readability of the configuration. For example, it is conventional to define
7774 a domain list called &'local_domains'& for all the domains that are handled
7775 locally on a host, using a configuration line such as
7776 .code
7777 domainlist local_domains = localhost:my.dom.example
7778 .endd
7779 Named lists are referenced by giving their name preceded by a plus sign, so,
7780 for example, a router that is intended to handle local domains would be
7781 configured with the line
7782 .code
7783 domains = +local_domains
7784 .endd
7785 The first router in a configuration is often one that handles all domains
7786 except the local ones, using a configuration with a negated item like this:
7787 .code
7788 dnslookup:
7789   driver = dnslookup
7790   domains = ! +local_domains
7791   transport = remote_smtp
7792   no_more
7793 .endd
7794 The four kinds of named list are created by configuration lines starting with
7795 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7796 respectively. Then there follows the name that you are defining, followed by an
7797 equals sign and the list itself. For example:
7798 .code
7799 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7800 addresslist bad_senders = cdb;/etc/badsenders
7801 .endd
7802 A named list may refer to other named lists:
7803 .code
7804 domainlist  dom1 = first.example : second.example
7805 domainlist  dom2 = +dom1 : third.example
7806 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7807 .endd
7808 &*Warning*&: If the last item in a referenced list is a negative one, the
7809 effect may not be what you intended, because the negation does not propagate
7810 out to the higher level. For example, consider:
7811 .code
7812 domainlist  dom1 = !a.b
7813 domainlist  dom2 = +dom1 : *.b
7814 .endd
7815 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7816 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7817 means it matches the second list as well. The effect is not the same as
7818 .code
7819 domainlist  dom2 = !a.b : *.b
7820 .endd
7821 where &'x.y'& does not match. It's best to avoid negation altogether in
7822 referenced lists if you can.
7823
7824 Named lists may have a performance advantage. When Exim is routing an
7825 address or checking an incoming message, it caches the result of tests on named
7826 lists. So, if you have a setting such as
7827 .code
7828 domains = +local_domains
7829 .endd
7830 on several of your routers
7831 or in several ACL statements,
7832 the actual test is done only for the first one. However, the caching works only
7833 if there are no expansions within the list itself or any sublists that it
7834 references. In other words, caching happens only for lists that are known to be
7835 the same each time they are referenced.
7836
7837 By default, there may be up to 16 named lists of each type. This limit can be
7838 extended by changing a compile-time variable. The use of domain and host lists
7839 is recommended for concepts such as local domains, relay domains, and relay
7840 hosts. The default configuration is set up like this.
7841
7842
7843
7844 .section "Named lists compared with macros" "SECID78"
7845 .cindex "list" "named compared with macro"
7846 .cindex "macro" "compared with named list"
7847 At first sight, named lists might seem to be no different from macros in the
7848 configuration file. However, macros are just textual substitutions. If you
7849 write
7850 .code
7851 ALIST = host1 : host2
7852 auth_advertise_hosts = !ALIST
7853 .endd
7854 it probably won't do what you want, because that is exactly the same as
7855 .code
7856 auth_advertise_hosts = !host1 : host2
7857 .endd
7858 Notice that the second host name is not negated. However, if you use a host
7859 list, and write
7860 .code
7861 hostlist alist = host1 : host2
7862 auth_advertise_hosts = ! +alist
7863 .endd
7864 the negation applies to the whole list, and so that is equivalent to
7865 .code
7866 auth_advertise_hosts = !host1 : !host2
7867 .endd
7868
7869
7870 .section "Named list caching" "SECID79"
7871 .cindex "list" "caching of named"
7872 .cindex "caching" "named lists"
7873 While processing a message, Exim caches the result of checking a named list if
7874 it is sure that the list is the same each time. In practice, this means that
7875 the cache operates only if the list contains no $ characters, which guarantees
7876 that it will not change when it is expanded. Sometimes, however, you may have
7877 an expanded list that you know will be the same each time within a given
7878 message. For example:
7879 .code
7880 domainlist special_domains = \
7881            ${lookup{$sender_host_address}cdb{/some/file}}
7882 .endd
7883 This provides a list of domains that depends only on the sending host's IP
7884 address. If this domain list is referenced a number of times (for example,
7885 in several ACL lines, or in several routers) the result of the check is not
7886 cached by default, because Exim does not know that it is going to be the
7887 same list each time.
7888
7889 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7890 cache the result anyway. For example:
7891 .code
7892 domainlist_cache special_domains = ${lookup{...
7893 .endd
7894 If you do this, you should be absolutely sure that caching is going to do
7895 the right thing in all cases. When in doubt, leave it out.
7896
7897
7898
7899 .section "Domain lists" "SECTdomainlist"
7900 .cindex "domain list" "patterns for"
7901 .cindex "list" "domain list"
7902 Domain lists contain patterns that are to be matched against a mail domain.
7903 The following types of item may appear in domain lists:
7904
7905 .ilist
7906 .cindex "primary host name"
7907 .cindex "host name" "matched in domain list"
7908 .oindex "&%primary_hostname%&"
7909 .cindex "domain list" "matching primary host name"
7910 .cindex "@ in a domain list"
7911 If a pattern consists of a single @ character, it matches the local host name,
7912 as set by the &%primary_hostname%& option (or defaulted). This makes it
7913 possible to use the same configuration file on several different hosts that
7914 differ only in their names.
7915 .next
7916 .cindex "@[] in a domain list"
7917 .cindex "domain list" "matching local IP interfaces"
7918 .cindex "domain literal"
7919 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7920 in square brackets (as in an email address that contains a domain literal), but
7921 only if that IP address is recognized as local for email routing purposes. The
7922 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7923 control which of a host's several IP addresses are treated as local.
7924 In today's Internet, the use of domain literals is controversial.
7925 .next
7926 .cindex "@mx_any"
7927 .cindex "@mx_primary"
7928 .cindex "@mx_secondary"
7929 .cindex "domain list" "matching MX pointers to local host"
7930 If a pattern consists of the string &`@mx_any`& it matches any domain that
7931 has an MX record pointing to the local host or to any host that is listed in
7932 .oindex "&%hosts_treat_as_local%&"
7933 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7934 are similar, except that the first matches only when a primary MX target is the
7935 local host, and the second only when no primary MX target is the local host,
7936 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7937 preference value &-- there may of course be more than one of them.
7938
7939 The MX lookup that takes place when matching a pattern of this type is
7940 performed with the resolver options for widening names turned off. Thus, for
7941 example, a single-component domain will &'not'& be expanded by adding the
7942 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7943 options of the &(dnslookup)& router for a discussion of domain widening.
7944
7945 Sometimes you may want to ignore certain IP addresses when using one of these
7946 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7947 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7948 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7949 on a router). For example:
7950 .code
7951 domains = @mx_any/ignore=127.0.0.1
7952 .endd
7953 This example matches any domain that has an MX record pointing to one of
7954 the local host's IP addresses other than 127.0.0.1.
7955
7956 The list of IP addresses is in fact processed by the same code that processes
7957 host lists, so it may contain CIDR-coded network specifications and it may also
7958 contain negative items.
7959
7960 Because the list of IP addresses is a sublist within a domain list, you have to
7961 be careful about delimiters if there is more than one address. Like any other
7962 list, the default delimiter can be changed. Thus, you might have:
7963 .code
7964 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7965           an.other.domain : ...
7966 .endd
7967 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7968 involved, it is easiest to change the delimiter for the main list as well:
7969 .code
7970 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7971           an.other.domain ? ...
7972 .endd
7973 .next
7974 .cindex "asterisk" "in domain list"
7975 .cindex "domain list" "asterisk in"
7976 .cindex "domain list" "matching &""ends with""&"
7977 If a pattern starts with an asterisk, the remaining characters of the pattern
7978 are compared with the terminating characters of the domain. The use of &"*"& in
7979 domain lists differs from its use in partial matching lookups. In a domain
7980 list, the character following the asterisk need not be a dot, whereas partial
7981 matching works only in terms of dot-separated components. For example, a domain
7982 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7983 &'cipher.key.ex'&.
7984
7985 .next
7986 .cindex "regular expressions" "in domain list"
7987 .cindex "domain list" "matching regular expression"
7988 If a pattern starts with a circumflex character, it is treated as a regular
7989 expression, and matched against the domain using a regular expression matching
7990 function. The circumflex is treated as part of the regular expression.
7991 Email domains are case-independent, so this regular expression match is by
7992 default case-independent, but you can make it case-dependent by starting it
7993 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7994 are given in chapter &<<CHAPregexp>>&.
7995
7996 &*Warning*&: Because domain lists are expanded before being processed, you
7997 must escape any backslash and dollar characters in the regular expression, or
7998 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7999 it is not to be expanded (unless you really do want to build a regular
8000 expression by expansion, of course).
8001 .next
8002 .cindex "lookup" "in domain list"
8003 .cindex "domain list" "matching by lookup"
8004 If a pattern starts with the name of a single-key lookup type followed by a
8005 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8006 must be a file name in a suitable format for the lookup type. For example, for
8007 &"cdb;"& it must be an absolute path:
8008 .code
8009 domains = cdb;/etc/mail/local_domains.cdb
8010 .endd
8011 The appropriate type of lookup is done on the file using the domain name as the
8012 key. In most cases, the data that is looked up is not used; Exim is interested
8013 only in whether or not the key is present in the file. However, when a lookup
8014 is used for the &%domains%& option on a router
8015 or a &%domains%& condition in an ACL statement, the data is preserved in the
8016 &$domain_data$& variable and can be referred to in other router options or
8017 other statements in the same ACL.
8018
8019 .next
8020 Any of the single-key lookup type names may be preceded by
8021 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8022 .code
8023 domains = partial-dbm;/partial/domains
8024 .endd
8025 This causes partial matching logic to be invoked; a description of how this
8026 works is given in section &<<SECTpartiallookup>>&.
8027
8028 .next
8029 .cindex "asterisk" "in lookup type"
8030 Any of the single-key lookup types may be followed by an asterisk. This causes
8031 a default lookup for a key consisting of a single asterisk to be done if the
8032 original lookup fails. This is not a useful feature when using a domain list to
8033 select particular domains (because any domain would match), but it might have
8034 value if the result of the lookup is being used via the &$domain_data$&
8035 expansion variable.
8036 .next
8037 If the pattern starts with the name of a query-style lookup type followed by a
8038 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8039 pattern must be an appropriate query for the lookup type, as described in
8040 chapter &<<CHAPfdlookup>>&. For example:
8041 .code
8042 hold_domains = mysql;select domain from holdlist \
8043   where domain = '${quote_mysql:$domain}';
8044 .endd
8045 In most cases, the data that is looked up is not used (so for an SQL query, for
8046 example, it doesn't matter what field you select). Exim is interested only in
8047 whether or not the query succeeds. However, when a lookup is used for the
8048 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8049 variable and can be referred to in other options.
8050 .next
8051 .cindex "domain list" "matching literal domain name"
8052 If none of the above cases apply, a caseless textual comparison is made
8053 between the pattern and the domain.
8054 .endlist
8055
8056 Here is an example that uses several different kinds of pattern:
8057 .code
8058 domainlist funny_domains = \
8059   @ : \
8060   lib.unseen.edu : \
8061   *.foundation.fict.example : \
8062   \N^[1-2]\d{3}\.fict\.example$\N : \
8063   partial-dbm;/opt/data/penguin/book : \
8064   nis;domains.byname : \
8065   nisplus;[name=$domain,status=local],domains.org_dir
8066 .endd
8067 There are obvious processing trade-offs among the various matching modes. Using
8068 an asterisk is faster than a regular expression, and listing a few names
8069 explicitly probably is too. The use of a file or database lookup is expensive,
8070 but may be the only option if hundreds of names are required. Because the
8071 patterns are tested in order, it makes sense to put the most commonly matched
8072 patterns earlier.
8073
8074
8075
8076 .section "Host lists" "SECThostlist"
8077 .cindex "host list" "patterns in"
8078 .cindex "list" "host list"
8079 Host lists are used to control what remote hosts are allowed to do. For
8080 example, some hosts may be allowed to use the local host as a relay, and some
8081 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8082 two different ways, by name or by IP address. In a host list, some types of
8083 pattern are matched to a host name, and some are matched to an IP address.
8084 You need to be particularly careful with this when single-key lookups are
8085 involved, to ensure that the right value is being used as the key.
8086
8087
8088 .section "Special host list patterns" "SECID80"
8089 .cindex "empty item in hosts list"
8090 .cindex "host list" "empty string in"
8091 If a host list item is the empty string, it matches only when no remote host is
8092 involved. This is the case when a message is being received from a local
8093 process using SMTP on the standard input, that is, when a TCP/IP connection is
8094 not used.
8095
8096 .cindex "asterisk" "in host list"
8097 The special pattern &"*"& in a host list matches any host or no host. Neither
8098 the IP address nor the name is actually inspected.
8099
8100
8101
8102 .section "Host list patterns that match by IP address" "SECThoslispatip"
8103 .cindex "host list" "matching IP addresses"
8104 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8105 the incoming address actually appears in the IPv6 host as
8106 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8107 list, it is converted into a traditional IPv4 address first. (Not all operating
8108 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8109 concerns.)
8110
8111 The following types of pattern in a host list check the remote host by
8112 inspecting its IP address:
8113
8114 .ilist
8115 If the pattern is a plain domain name (not a regular expression, not starting
8116 with *, not a lookup of any kind), Exim calls the operating system function
8117 to find the associated IP address(es). Exim uses the newer
8118 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8119 This typically causes a forward DNS lookup of the name. The result is compared
8120 with the IP address of the subject host.
8121
8122 If there is a temporary problem (such as a DNS timeout) with the host name
8123 lookup, a temporary error occurs. For example, if the list is being used in an
8124 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8125 temporary SMTP error code. If no IP address can be found for the host name,
8126 what happens is described in section &<<SECTbehipnot>>& below.
8127
8128 .next
8129 .cindex "@ in a host list"
8130 If the pattern is &"@"&, the primary host name is substituted and used as a
8131 domain name, as just described.
8132
8133 .next
8134 If the pattern is an IP address, it is matched against the IP address of the
8135 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8136 IPv6 addresses can be given in colon-separated format, but the colons have to
8137 be doubled so as not to be taken as item separators when the default list
8138 separator is used. IPv6 addresses are recognized even when Exim is compiled
8139 without IPv6 support. This means that if they appear in a host list on an
8140 IPv4-only host, Exim will not treat them as host names. They are just addresses
8141 that can never match a client host.
8142
8143 .next
8144 .cindex "@[] in a host list"
8145 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8146 the local host. For example, if the local host is an IPv4 host with one
8147 interface address 10.45.23.56, these two ACL statements have the same effect:
8148 .code
8149 accept hosts = 127.0.0.1 : 10.45.23.56
8150 accept hosts = @[]
8151 .endd
8152 .next
8153 .cindex "CIDR notation"
8154 If the pattern is an IP address followed by a slash and a mask length (for
8155 example 10.11.42.0/24), it is matched against the IP address of the subject
8156 host under the given mask. This allows, an entire network of hosts to be
8157 included (or excluded) by a single item. The mask uses CIDR notation; it
8158 specifies the number of address bits that must match, starting from the most
8159 significant end of the address.
8160
8161 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8162 of a range of addresses. It is the number of bits in the network portion of the
8163 address. The above example specifies a 24-bit netmask, so it matches all 256
8164 addresses in the 10.11.42.0 network. An item such as
8165 .code
8166 192.168.23.236/31
8167 .endd
8168 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8169 32 for an IPv4 address is the same as no mask at all; just a single address
8170 matches.
8171
8172 Here is another example which shows an IPv4 and an IPv6 network:
8173 .code
8174 recipient_unqualified_hosts = 192.168.0.0/16: \
8175                               3ffe::ffff::836f::::/48
8176 .endd
8177 The doubling of list separator characters applies only when these items
8178 appear inline in a host list. It is not required when indirecting via a file.
8179 For example:
8180 .code
8181 recipient_unqualified_hosts = /opt/exim/unqualnets
8182 .endd
8183 could make use of a file containing
8184 .code
8185 172.16.0.0/12
8186 3ffe:ffff:836f::/48
8187 .endd
8188 to have exactly the same effect as the previous example. When listing IPv6
8189 addresses inline, it is usually more convenient to use the facility for
8190 changing separator characters. This list contains the same two networks:
8191 .code
8192 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8193                                  3ffe:ffff:836f::/48
8194 .endd
8195 The separator is changed to semicolon by the leading &"<;"& at the start of the
8196 list.
8197 .endlist
8198
8199
8200
8201 .section "Host list patterns for single-key lookups by host address" &&&
8202          "SECThoslispatsikey"
8203 .cindex "host list" "lookup of IP address"
8204 When a host is to be identified by a single-key lookup of its complete IP
8205 address, the pattern takes this form:
8206 .display
8207 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8208 .endd
8209 For example:
8210 .code
8211 hosts_lookup = net-cdb;/hosts-by-ip.db
8212 .endd
8213 The text form of the IP address of the subject host is used as the lookup key.
8214 IPv6 addresses are converted to an unabbreviated form, using lower case
8215 letters, with dots as separators because colon is the key terminator in
8216 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8217 quoting the keys, but this is a facility that was added later.] The data
8218 returned by the lookup is not used.
8219
8220 .cindex "IP address" "masking"
8221 .cindex "host list" "masked IP address"
8222 Single-key lookups can also be performed using masked IP addresses, using
8223 patterns of this form:
8224 .display
8225 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8226 .endd
8227 For example:
8228 .code
8229 net24-dbm;/networks.db
8230 .endd
8231 The IP address of the subject host is masked using <&'number'&> as the mask
8232 length. A textual string is constructed from the masked value, followed by the
8233 mask, and this is used as the lookup key. For example, if the host's IP address
8234 is 192.168.34.6, the key that is looked up for the above example is
8235 &"192.168.34.0/24"&.
8236
8237 When an IPv6 address is converted to a string, dots are normally used instead
8238 of colons, so that keys in &(lsearch)& files need not contain colons (which
8239 terminate &(lsearch)& keys). This was implemented some time before the ability
8240 to quote keys was made available in &(lsearch)& files. However, the more
8241 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8242 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8243 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8244 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8245 addresses are always used.
8246
8247 Ideally, it would be nice to tidy up this anomalous situation by changing to
8248 colons in all cases, given that quoting is now available for &(lsearch)&.
8249 However, this would be an incompatible change that might break some existing
8250 configurations.
8251
8252 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8253 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8254 the former case the key strings include the mask value, whereas in the latter
8255 case the IP address is used on its own.
8256
8257
8258
8259 .section "Host list patterns that match by host name" "SECThoslispatnam"
8260 .cindex "host" "lookup failures"
8261 .cindex "unknown host name"
8262 .cindex "host list" "matching host name"
8263 There are several types of pattern that require Exim to know the name of the
8264 remote host. These are either wildcard patterns or lookups by name. (If a
8265 complete hostname is given without any wildcarding, it is used to find an IP
8266 address to match against, as described in section &<<SECThoslispatip>>&
8267 above.)
8268
8269 If the remote host name is not already known when Exim encounters one of these
8270 patterns, it has to be found from the IP address.
8271 Although many sites on the Internet are conscientious about maintaining reverse
8272 DNS data for their hosts, there are also many that do not do this.
8273 Consequently, a name cannot always be found, and this may lead to unwanted
8274 effects. Take care when configuring host lists with wildcarded name patterns.
8275 Consider what will happen if a name cannot be found.
8276
8277 Because of the problems of determining host names from IP addresses, matching
8278 against host names is not as common as matching against IP addresses.
8279
8280 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8281 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8282 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8283 are done can be changed by setting the &%host_lookup_order%& option. For
8284 security, once Exim has found one or more names, it looks up the IP addresses
8285 for these names and compares them with the IP address that it started with.
8286 Only those names whose IP addresses match are accepted. Any other names are
8287 discarded. If no names are left, Exim behaves as if the host name cannot be
8288 found. In the most common case there is only one name and one IP address.
8289
8290 There are some options that control what happens if a host name cannot be
8291 found. These are described in section &<<SECTbehipnot>>& below.
8292
8293 .cindex "host" "alias for"
8294 .cindex "alias for host"
8295 As a result of aliasing, hosts may have more than one name. When processing any
8296 of the following types of pattern, all the host's names are checked:
8297
8298 .ilist
8299 .cindex "asterisk" "in host list"
8300 If a pattern starts with &"*"& the remainder of the item must match the end of
8301 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8302 &'.b.c'&. This special simple form is provided because this is a very common
8303 requirement. Other kinds of wildcarding require the use of a regular
8304 expression.
8305 .next
8306 .cindex "regular expressions" "in host list"
8307 .cindex "host list" "regular expression in"
8308 If the item starts with &"^"& it is taken to be a regular expression which is
8309 matched against the host name. Host names are case-independent, so this regular
8310 expression match is by default case-independent, but you can make it
8311 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8312 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8313 example,
8314 .code
8315 ^(a|b)\.c\.d$
8316 .endd
8317 is a regular expression that matches either of the two hosts &'a.c.d'& or
8318 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8319 that backslash and dollar characters are not misinterpreted as part of the
8320 string expansion. The simplest way to do this is to use &`\N`& to mark that
8321 part of the string as non-expandable. For example:
8322 .code
8323 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8324 .endd
8325 &*Warning*&: If you want to match a complete host name, you must include the
8326 &`$`& terminating metacharacter in the regular expression, as in the above
8327 example. Without it, a match at the start of the host name is all that is
8328 required.
8329 .endlist
8330
8331
8332
8333
8334 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8335 .cindex "host" "lookup failures, permanent"
8336 While processing a host list, Exim may need to look up an IP address from a
8337 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8338 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8339 behaviour when it fails to find the information it is seeking is the same.
8340
8341 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8342 apply to temporary DNS errors, whose handling is described in the next section.
8343
8344 .cindex "&`+include_unknown`&"
8345 .cindex "&`+ignore_unknown`&"
8346 Exim parses a host list from left to right. If it encounters a permanent
8347 lookup failure in any item in the host list before it has found a match,
8348 Exim treats it as a failure and the default behavior is as if the host
8349 does not match the list. This may not always be what you want to happen.
8350 To change Exim's behaviour, the special items &`+include_unknown`& or
8351 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8352 not recognized in an indirected file).
8353
8354 .ilist
8355 If any item that follows &`+include_unknown`& requires information that
8356 cannot found, Exim behaves as if the host does match the list. For example,
8357 .code
8358 host_reject_connection = +include_unknown:*.enemy.ex
8359 .endd
8360 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8361 any hosts whose name it cannot find.
8362
8363 .next
8364 If any item that follows &`+ignore_unknown`& requires information that cannot
8365 be found, Exim ignores that item and proceeds to the rest of the list. For
8366 example:
8367 .code
8368 accept hosts = +ignore_unknown : friend.example : \
8369                192.168.4.5
8370 .endd
8371 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8372 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8373 name can be found for 192.168.4.5, it is rejected.
8374 .endlist
8375
8376 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8377 list. The effect of each one lasts until the next, or until the end of the
8378 list.
8379
8380 .section "Mixing wildcarded host names and addresses in host lists" &&&
8381          "SECTmixwilhos"
8382 .cindex "host list" "mixing names and addresses in"
8383
8384 This section explains the host/ip processing logic with the same concepts
8385 as the previous section, but specifically addresses what happens when a
8386 wildcarded hostname is one of the items in the hostlist.
8387
8388 .ilist
8389 If you have name lookups or wildcarded host names and
8390 IP addresses in the same host list, you should normally put the IP
8391 addresses first. For example, in an ACL you could have:
8392 .code
8393 accept hosts = 10.9.8.7 : *.friend.example
8394 .endd
8395 The reason you normally would order it this way lies in the
8396 left-to-right way that Exim processes lists.  It can test IP addresses
8397 without doing any DNS lookups, but when it reaches an item that requires
8398 a host name, it fails if it cannot find a host name to compare with the
8399 pattern. If the above list is given in the opposite order, the
8400 &%accept%& statement fails for a host whose name cannot be found, even
8401 if its IP address is 10.9.8.7.
8402
8403 .next
8404 If you really do want to do the name check first, and still recognize the IP
8405 address, you can rewrite the ACL like this:
8406 .code
8407 accept hosts = *.friend.example
8408 accept hosts = 10.9.8.7
8409 .endd
8410 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8411 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8412 &`+ignore_unknown`&, which was discussed in depth in the first example in
8413 this section.
8414 .endlist
8415
8416
8417 .section "Temporary DNS errors when looking up host information" &&&
8418          "SECTtemdnserr"
8419 .cindex "host" "lookup failures, temporary"
8420 .cindex "&`+include_defer`&"
8421 .cindex "&`+ignore_defer`&"
8422 A temporary DNS lookup failure normally causes a defer action (except when
8423 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8424 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8425 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8426 section. These options should be used with care, probably only in non-critical
8427 host lists such as whitelists.
8428
8429
8430
8431 .section "Host list patterns for single-key lookups by host name" &&&
8432          "SECThoslispatnamsk"
8433 .cindex "unknown host name"
8434 .cindex "host list" "matching host name"
8435 If a pattern is of the form
8436 .display
8437 <&'single-key-search-type'&>;<&'search-data'&>
8438 .endd
8439 for example
8440 .code
8441 dbm;/host/accept/list
8442 .endd
8443 a single-key lookup is performed, using the host name as its key. If the
8444 lookup succeeds, the host matches the item. The actual data that is looked up
8445 is not used.
8446
8447 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8448 keys in the file, not IP addresses. If you want to do lookups based on IP
8449 addresses, you must precede the search type with &"net-"& (see section
8450 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8451 two items in the same list, one doing an address lookup and one doing a name
8452 lookup, both using the same file.
8453
8454
8455
8456 .section "Host list patterns for query-style lookups" "SECID81"
8457 If a pattern is of the form
8458 .display
8459 <&'query-style-search-type'&>;<&'query'&>
8460 .endd
8461 the query is obeyed, and if it succeeds, the host matches the item. The actual
8462 data that is looked up is not used. The variables &$sender_host_address$& and
8463 &$sender_host_name$& can be used in the query. For example:
8464 .code
8465 hosts_lookup = pgsql;\
8466   select ip from hostlist where ip='$sender_host_address'
8467 .endd
8468 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8469 can use the &%sg%& expansion item to change this if you need to. If you want to
8470 use masked IP addresses in database queries, you can use the &%mask%& expansion
8471 operator.
8472
8473 If the query contains a reference to &$sender_host_name$&, Exim automatically
8474 looks up the host name if it has not already done so. (See section
8475 &<<SECThoslispatnam>>& for comments on finding host names.)
8476
8477 Historical note: prior to release 4.30, Exim would always attempt to find a
8478 host name before running the query, unless the search type was preceded by
8479 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8480 still recognized for query-style lookups, but its presence or absence has no
8481 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8482 See section &<<SECThoslispatsikey>>&.)
8483
8484
8485
8486
8487
8488 .section "Address lists" "SECTaddresslist"
8489 .cindex "list" "address list"
8490 .cindex "address list" "empty item"
8491 .cindex "address list" "patterns"
8492 Address lists contain patterns that are matched against mail addresses. There
8493 is one special case to be considered: the sender address of a bounce message is
8494 always empty. You can test for this by providing an empty item in an address
8495 list. For example, you can set up a router to process bounce messages by
8496 using this option setting:
8497 .code
8498 senders = :
8499 .endd
8500 The presence of the colon creates an empty item. If you do not provide any
8501 data, the list is empty and matches nothing. The empty sender can also be
8502 detected by a regular expression that matches an empty string,
8503 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8504
8505 Non-empty items in an address list can be straightforward email addresses. For
8506 example:
8507 .code
8508 senders = jbc@askone.example : hs@anacreon.example
8509 .endd
8510 A certain amount of wildcarding is permitted. If a pattern contains an @
8511 character, but is not a regular expression and does not begin with a
8512 semicolon-terminated lookup type (described below), the local part of the
8513 subject address is compared with the local part of the pattern, which may start
8514 with an asterisk. If the local parts match, the domain is checked in exactly
8515 the same way as for a pattern in a domain list. For example, the domain can be
8516 wildcarded, refer to a named list, or be a lookup:
8517 .code
8518 deny senders = *@*.spamming.site:\
8519                *@+hostile_domains:\
8520                bozo@partial-lsearch;/list/of/dodgy/sites:\
8521                *@dbm;/bad/domains.db
8522 .endd
8523 .cindex "local part" "starting with !"
8524 .cindex "address list" "local part starting with !"
8525 If a local part that begins with an exclamation mark is required, it has to be
8526 specified using a regular expression, because otherwise the exclamation mark is
8527 treated as a sign of negation, as is standard in lists.
8528
8529 If a non-empty pattern that is not a regular expression or a lookup does not
8530 contain an @ character, it is matched against the domain part of the subject
8531 address. The only two formats that are recognized this way are a literal
8532 domain, or a domain pattern that starts with *. In both these cases, the effect
8533 is the same as if &`*@`& preceded the pattern. For example:
8534 .code
8535 deny senders = enemy.domain : *.enemy.domain
8536 .endd
8537
8538 The following kinds of more complicated address list pattern can match any
8539 address, including the empty address that is characteristic of bounce message
8540 senders:
8541
8542 .ilist
8543 .cindex "regular expressions" "in address list"
8544 .cindex "address list" "regular expression in"
8545 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8546 done against the complete address, with the pattern as the regular expression.
8547 You must take care that backslash and dollar characters are not misinterpreted
8548 as part of the string expansion. The simplest way to do this is to use &`\N`&
8549 to mark that part of the string as non-expandable. For example:
8550 .code
8551 deny senders = \N^.*this.*@example\.com$\N : \
8552                \N^\d{8}.+@spamhaus.example$\N : ...
8553 .endd
8554 The &`\N`& sequences are removed by the expansion, so these items do indeed
8555 start with &"^"& by the time they are being interpreted as address patterns.
8556
8557 .next
8558 .cindex "address list" "lookup for complete address"
8559 Complete addresses can be looked up by using a pattern that starts with a
8560 lookup type terminated by a semicolon, followed by the data for the lookup. For
8561 example:
8562 .code
8563 deny senders = cdb;/etc/blocked.senders : \
8564   mysql;select address from blocked where \
8565   address='${quote_mysql:$sender_address}'
8566 .endd
8567 Both query-style and single-key lookup types can be used. For a single-key
8568 lookup type, Exim uses the complete address as the key. However, empty keys are
8569 not supported for single-key lookups, so a match against the empty address
8570 always fails. This restriction does not apply to query-style lookups.
8571
8572 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8573 cannot be used, and is ignored if specified, with an entry being written to the
8574 panic log.
8575 .cindex "*@ with single-key lookup"
8576 However, you can configure lookup defaults, as described in section
8577 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8578 default. For example, with this lookup:
8579 .code
8580 accept senders = lsearch*@;/some/file
8581 .endd
8582 the file could contains lines like this:
8583 .code
8584 user1@domain1.example
8585 *@domain2.example
8586 .endd
8587 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8588 that are tried is:
8589 .code
8590 nimrod@jaeger.example
8591 *@jaeger.example
8592 *
8593 .endd
8594 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8595 would mean that every address matches, thus rendering the test useless.
8596
8597 &*Warning 2*&: Do not confuse these two kinds of item:
8598 .code
8599 deny recipients = dbm*@;/some/file
8600 deny recipients = *@dbm;/some/file
8601 .endd
8602 The first does a whole address lookup, with defaulting, as just described,
8603 because it starts with a lookup type. The second matches the local part and
8604 domain independently, as described in a bullet point below.
8605 .endlist
8606
8607
8608 The following kinds of address list pattern can match only non-empty addresses.
8609 If the subject address is empty, a match against any of these pattern types
8610 always fails.
8611
8612
8613 .ilist
8614 .cindex "@@ with single-key lookup"
8615 .cindex "address list" "@@ lookup type"
8616 .cindex "address list" "split local part and domain"
8617 If a pattern starts with &"@@"& followed by a single-key lookup item
8618 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8619 split into a local part and a domain. The domain is looked up in the file. If
8620 it is not found, there is no match. If it is found, the data that is looked up
8621 from the file is treated as a colon-separated list of local part patterns, each
8622 of which is matched against the subject local part in turn.
8623
8624 .cindex "asterisk" "in address list"
8625 The lookup may be a partial one, and/or one involving a search for a default
8626 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8627 patterns that are looked up can be regular expressions or begin with &"*"&, or
8628 even be further lookups. They may also be independently negated. For example,
8629 with
8630 .code
8631 deny senders = @@dbm;/etc/reject-by-domain
8632 .endd
8633 the data from which the DBM file is built could contain lines like
8634 .code
8635 baddomain.com:  !postmaster : *
8636 .endd
8637 to reject all senders except &%postmaster%& from that domain.
8638
8639 .cindex "local part" "starting with !"
8640 If a local part that actually begins with an exclamation mark is required, it
8641 has to be specified using a regular expression. In &(lsearch)& files, an entry
8642 may be split over several lines by indenting the second and subsequent lines,
8643 but the separating colon must still be included at line breaks. White space
8644 surrounding the colons is ignored. For example:
8645 .code
8646 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8647   spammer3 : spammer4
8648 .endd
8649 As in all colon-separated lists in Exim, a colon can be included in an item by
8650 doubling.
8651
8652 If the last item in the list starts with a right angle-bracket, the remainder
8653 of the item is taken as a new key to look up in order to obtain a continuation
8654 list of local parts. The new key can be any sequence of characters. Thus one
8655 might have entries like
8656 .code
8657 aol.com: spammer1 : spammer 2 : >*
8658 xyz.com: spammer3 : >*
8659 *:       ^\d{8}$
8660 .endd
8661 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8662 local parts for all domains, in addition to the specific local parts listed for
8663 each domain. Of course, using this feature costs another lookup each time a
8664 chain is followed, but the effort needed to maintain the data is reduced.
8665
8666 .cindex "loop" "in lookups"
8667 It is possible to construct loops using this facility, and in order to catch
8668 them, the chains may be no more than fifty items long.
8669
8670 .next
8671 The @@<&'lookup'&> style of item can also be used with a query-style
8672 lookup, but in this case, the chaining facility is not available. The lookup
8673 can only return a single list of local parts.
8674 .endlist
8675
8676 &*Warning*&: There is an important difference between the address list items
8677 in these two examples:
8678 .code
8679 senders = +my_list
8680 senders = *@+my_list
8681 .endd
8682 In the first one, &`my_list`& is a named address list, whereas in the second
8683 example it is a named domain list.
8684
8685
8686
8687
8688 .section "Case of letters in address lists" "SECTcasletadd"
8689 .cindex "case of local parts"
8690 .cindex "address list" "case forcing"
8691 .cindex "case forcing in address lists"
8692 Domains in email addresses are always handled caselessly, but for local parts
8693 case may be significant on some systems (see &%caseful_local_part%& for how
8694 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8695 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8696 blocking lists should be done in a case-independent manner. Since most address
8697 lists in Exim are used for this kind of control, Exim attempts to do this by
8698 default.
8699
8700 The domain portion of an address is always lowercased before matching it to an
8701 address list. The local part is lowercased by default, and any string
8702 comparisons that take place are done caselessly. This means that the data in
8703 the address list itself, in files included as plain file names, and in any file
8704 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8705 keys in files that are looked up by a search type other than &(lsearch)& (which
8706 works caselessly) must be in lower case, because these lookups are not
8707 case-independent.
8708
8709 .cindex "&`+caseful`&"
8710 To allow for the possibility of caseful address list matching, if an item in
8711 an address list is the string &"+caseful"&, the original case of the local
8712 part is restored for any comparisons that follow, and string comparisons are no
8713 longer case-independent. This does not affect the domain, which remains in
8714 lower case. However, although independent matches on the domain alone are still
8715 performed caselessly, regular expressions that match against an entire address
8716 become case-sensitive after &"+caseful"& has been seen.
8717
8718
8719
8720 .section "Local part lists" "SECTlocparlis"
8721 .cindex "list" "local part list"
8722 .cindex "local part" "list"
8723 Case-sensitivity in local part lists is handled in the same way as for address
8724 lists, as just described. The &"+caseful"& item can be used if required. In a
8725 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8726 set false, the subject is lowercased and the matching is initially
8727 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8728 matching in the local part list, but not elsewhere in the router. If
8729 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8730 option is case-sensitive from the start.
8731
8732 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8733 comments are handled in the same way as address lists &-- they are recognized
8734 only if the # is preceded by white space or the start of the line.
8735 Otherwise, local part lists are matched in the same way as domain lists, except
8736 that the special items that refer to the local host (&`@`&, &`@[]`&,
8737 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8738 Refer to section &<<SECTdomainlist>>& for details of the other available item
8739 types.
8740 .ecindex IIDdohoadli
8741
8742
8743
8744
8745 . ////////////////////////////////////////////////////////////////////////////
8746 . ////////////////////////////////////////////////////////////////////////////
8747
8748 .chapter "String expansions" "CHAPexpand"
8749 .scindex IIDstrexp "expansion" "of strings"
8750 Many strings in Exim's run time configuration are expanded before use. Some of
8751 them are expanded every time they are used; others are expanded only once.
8752
8753 When a string is being expanded it is copied verbatim from left to right except
8754 when a dollar or backslash character is encountered. A dollar specifies the
8755 start of a portion of the string that is interpreted and replaced as described
8756 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8757 escape character, as described in the following section.
8758
8759 Whether a string is expanded depends upon the context.  Usually this is solely
8760 dependent upon the option for which a value is sought; in this documentation,
8761 options for which string expansion is performed are marked with &dagger; after
8762 the data type.  ACL rules always expand strings.  A couple of expansion
8763 conditions do not expand some of the brace-delimited branches, for security
8764 reasons.
8765
8766
8767
8768 .section "Literal text in expanded strings" "SECTlittext"
8769 .cindex "expansion" "including literal text"
8770 An uninterpreted dollar can be included in an expanded string by putting a
8771 backslash in front of it. A backslash can be used to prevent any special
8772 character being treated specially in an expansion, including backslash itself.
8773 If the string appears in quotes in the configuration file, two backslashes are
8774 required because the quotes themselves cause interpretation of backslashes when
8775 the string is read in (see section &<<SECTstrings>>&).
8776
8777 .cindex "expansion" "non-expandable substrings"
8778 A portion of the string can specified as non-expandable by placing it between
8779 two occurrences of &`\N`&. This is particularly useful for protecting regular
8780 expressions, which often contain backslashes and dollar signs. For example:
8781 .code
8782 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8783 .endd
8784 On encountering the first &`\N`&, the expander copies subsequent characters
8785 without interpretation until it reaches the next &`\N`& or the end of the
8786 string.
8787
8788
8789
8790 .section "Character escape sequences in expanded strings" "SECID82"
8791 .cindex "expansion" "escape sequences"
8792 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8793 expanded string is recognized as an escape sequence for the character newline,
8794 carriage return, or tab, respectively. A backslash followed by up to three
8795 octal digits is recognized as an octal encoding for a single character, and a
8796 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8797 encoding.
8798
8799 These escape sequences are also recognized in quoted strings when they are read
8800 in. Their interpretation in expansions as well is useful for unquoted strings,
8801 and for other cases such as looked-up strings that are then expanded.
8802
8803
8804 .section "Testing string expansions" "SECID83"
8805 .cindex "expansion" "testing"
8806 .cindex "testing" "string expansion"
8807 .oindex "&%-be%&"
8808 Many expansions can be tested by calling Exim with the &%-be%& option. This
8809 takes the command arguments, or lines from the standard input if there are no
8810 arguments, runs them through the string expansion code, and writes the results
8811 to the standard output. Variables based on configuration values are set up, but
8812 since no message is being processed, variables such as &$local_part$& have no
8813 value. Nevertheless the &%-be%& option can be useful for checking out file and
8814 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8815 and &%nhash%&.
8816
8817 Exim gives up its root privilege when it is called with the &%-be%& option, and
8818 instead runs under the uid and gid it was called with, to prevent users from
8819 using &%-be%& for reading files to which they do not have access.
8820
8821 .oindex "&%-bem%&"
8822 If you want to test expansions that include variables whose values are taken
8823 from a message, there are two other options that can be used. The &%-bem%&
8824 option is like &%-be%& except that it is followed by a file name. The file is
8825 read as a message before doing the test expansions. For example:
8826 .code
8827 exim -bem /tmp/test.message '$h_subject:'
8828 .endd
8829 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8830 Exim message identifier. For example:
8831 .code
8832 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8833 .endd
8834 This loads the message from Exim's spool before doing the test expansions, and
8835 is therefore restricted to admin users.
8836
8837
8838 .section "Forced expansion failure" "SECTforexpfai"
8839 .cindex "expansion" "forced failure"
8840 A number of expansions that are described in the following section have
8841 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8842 (which are sometimes called &"curly brackets"&). Which of the two strings is
8843 used depends on some condition that is evaluated as part of the expansion. If,
8844 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8845 the entire string expansion fails in a way that can be detected by the code
8846 that requested the expansion. This is called &"forced expansion failure"&, and
8847 its consequences depend on the circumstances. In some cases it is no different
8848 from any other expansion failure, but in others a different action may be
8849 taken. Such variations are mentioned in the documentation of the option that is
8850 being expanded.
8851
8852
8853
8854
8855 .section "Expansion items" "SECTexpansionitems"
8856 The following items are recognized in expanded strings. White space may be used
8857 between sub-items that are keywords or substrings enclosed in braces inside an
8858 outer set of braces, to improve readability. &*Warning*&: Within braces,
8859 white space is significant.
8860
8861 .vlist
8862 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8863 .cindex "expansion" "variables"
8864 Substitute the contents of the named variable, for example:
8865 .code
8866 $local_part
8867 ${domain}
8868 .endd
8869 The second form can be used to separate the name from subsequent alphanumeric
8870 characters. This form (using braces) is available only for variables; it does
8871 &'not'& apply to message headers. The names of the variables are given in
8872 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8873 given, the expansion fails.
8874
8875 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8876 .cindex "expansion" "operators"
8877 The string is first itself expanded, and then the operation specified by
8878 <&'op'&> is applied to it. For example:
8879 .code
8880 ${lc:$local_part}
8881 .endd
8882 The string starts with the first character after the colon, which may be
8883 leading white space. A list of operators is given in section &<<SECTexpop>>&
8884 below. The operator notation is used for simple expansion items that have just
8885 one argument, because it reduces the number of braces and therefore makes the
8886 string easier to understand.
8887
8888 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8889 This item inserts &"basic"& header lines. It is described with the &%header%&
8890 expansion item below.
8891
8892
8893 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8894 .cindex "expansion" "calling an acl"
8895 .cindex "&%acl%&" "call from expansion"
8896 The name and zero to nine argument strings are first expanded separately.  The expanded
8897 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8898 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8899 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8900 and may use the variables; if another acl expansion is used the values
8901 are restored after it returns.  If the ACL sets
8902 a value using a "message =" modifier and returns accept or deny, the value becomes
8903 the result of the expansion.
8904 If no message is set and the ACL returns accept or deny
8905 the expansion result is an empty string.
8906 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8907
8908
8909 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8910        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8911 .cindex "expansion" "extracting cerificate fields"
8912 .cindex "&%certextract%&" "certificate fields"
8913 .cindex "certificate" "extracting fields"
8914 The <&'certificate'&> must be a variable of type certificate.
8915 The field name is expanded and used to retrive the relevant field from
8916 the certificate.  Supported fields are:
8917 .display
8918 &`version        `&
8919 &`serial_number  `&
8920 &`subject        `& RFC4514 DN
8921 &`issuer         `& RFC4514 DN
8922 &`notbefore      `& time
8923 &`notafter       `& time
8924 &`sig_algorithm  `&
8925 &`signature      `&
8926 &`subj_altname   `& tagged list
8927 &`ocsp_uri       `& list
8928 &`crl_uri        `& list
8929 .endd
8930 If the field is found,
8931 <&'string2'&> is expanded, and replaces the whole item;
8932 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8933 variable &$value$& contains the value that has been extracted. Afterwards, it
8934 is restored to any previous value it might have had.
8935
8936 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8937 key is not found. If {<&'string2'&>} is also omitted, the value that was
8938 extracted is used.
8939
8940 Some field names take optional modifiers, appended and separated by commas.
8941
8942 The field selectors marked as "RFC4514" above
8943 output a Distinguished Name string which is
8944 not quite
8945 parseable by Exim as a comma-separated tagged list
8946 (the exceptions being elements containin commas).
8947 RDN elements of a single type may be selected by
8948 a modifier of the type label; if so the expansion
8949 result is a list (newline-separated by default).
8950 The separator may be changed by another modifer of
8951 a right angle-bracket followed immediately by the new separator.
8952 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8953
8954 The field selectors marked as "time" above
8955 take an optional modifier of "int"
8956 for which the result is the number of seconds since epoch.
8957 Otherwise the result is a human-readable string
8958 in the timezone selected by the main "timezone" option.
8959
8960 The field selectors marked as "list" above return a list,
8961 newline-separated by default,
8962 (embedded separator characters in elements are doubled).
8963 The separator may be changed by a modifier of
8964 a right angle-bracket followed immediately by the new separator.
8965
8966 The field selectors marked as "tagged" above
8967 prefix each list element with a type string and an equals sign.
8968 Elements of only one type may be selected by a modifier
8969 which is one of "dns", "uri" or "mail";
8970 if so the elenment tags are omitted.
8971
8972 If not otherwise noted field values are presented in human-readable form.
8973
8974 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8975        {*&<&'arg'&>&*}...}*&"
8976 .cindex &%dlfunc%&
8977 This expansion dynamically loads and then calls a locally-written C function.
8978 This functionality is available only if Exim is compiled with
8979 .code
8980 EXPAND_DLFUNC=yes
8981 .endd
8982 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8983 object so that it doesn't reload the same object file in the same Exim process
8984 (but of course Exim does start new processes frequently).
8985
8986 There may be from zero to eight arguments to the function. When compiling
8987 a local function that is to be called in this way, &_local_scan.h_& should be
8988 included. The Exim variables and functions that are defined by that API
8989 are also available for dynamically loaded functions. The function itself
8990 must have the following type:
8991 .code
8992 int dlfunction(uschar **yield, int argc, uschar *argv[])
8993 .endd
8994 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8995 function should return one of the following values:
8996
8997 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8998 into the expanded string that is being built.
8999
9000 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9001 from &'yield'&, if it is set.
9002
9003 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9004 taken from &'yield'& if it is set.
9005
9006 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9007
9008 When compiling a function that is to be used in this way with gcc,
9009 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9010 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9011
9012 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9013        {*&<&'string3'&>&*}}*&"
9014 .cindex "expansion" "extracting substrings by key"
9015 .cindex "&%extract%&" "substrings by key"
9016 The key and <&'string1'&> are first expanded separately. Leading and trailing
9017 white space is removed from the key (but not from any of the strings). The key
9018 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9019 form:
9020 .display
9021 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9022 .endd
9023 .vindex "&$value$&"
9024 where the equals signs and spaces (but not both) are optional. If any of the
9025 values contain white space, they must be enclosed in double quotes, and any
9026 values that are enclosed in double quotes are subject to escape processing as
9027 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9028 for the value that corresponds to the key. The search is case-insensitive. If
9029 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9030 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9031 variable &$value$& contains the value that has been extracted. Afterwards, it
9032 is restored to any previous value it might have had.
9033
9034 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9035 key is not found. If {<&'string2'&>} is also omitted, the value that was
9036 extracted is used. Thus, for example, these two expansions are identical, and
9037 yield &"2001"&:
9038 .code
9039 ${extract{gid}{uid=1984 gid=2001}}
9040 ${extract{gid}{uid=1984 gid=2001}{$value}}
9041 .endd
9042 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9043 appear, for example:
9044 .code
9045 ${extract{Z}{A=... B=...}{$value} fail }
9046 .endd
9047 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9048 {<&'string2'&>} must be present for &"fail"& to be recognized.
9049
9050
9051 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9052         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9053 .cindex "expansion" "extracting substrings by number"
9054 .cindex "&%extract%&" "substrings by number"
9055 The <&'number'&> argument must consist entirely of decimal digits,
9056 apart from leading and trailing white space, which is ignored.
9057 This is what distinguishes this form of &%extract%& from the previous kind. It
9058 behaves in the same way, except that, instead of extracting a named field, it
9059 extracts from <&'string1'&> the field whose number is given as the first
9060 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9061 <&'string3'&> as before.
9062
9063 The fields in the string are separated by any one of the characters in the
9064 separator string. These may include space or tab characters.
9065 The first field is numbered one. If the number is negative, the fields are
9066 counted from the end of the string, with the rightmost one numbered -1. If the
9067 number given is zero, the entire string is returned. If the modulus of the
9068 number is greater than the number of fields in the string, the result is the
9069 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9070 provided. For example:
9071 .code
9072 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9073 .endd
9074 yields &"42"&, and
9075 .code
9076 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9077 .endd
9078 yields &"99"&. Two successive separators mean that the field between them is
9079 empty (for example, the fifth field above).
9080
9081
9082 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9083 .cindex "list" "selecting by condition"
9084 .cindex "expansion" "selecting from list by condition"
9085 .vindex "&$item$&"
9086 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9087 default, but the separator can be changed in the usual way. For each item
9088 in this list, its value is place in &$item$&, and then the condition is
9089 evaluated. If the condition is true, &$item$& is added to the output as an
9090 item in a new list; if the condition is false, the item is discarded. The
9091 separator used for the output list is the same as the one used for the
9092 input, but a separator setting is not included in the output. For example:
9093 .code
9094 ${filter{a:b:c}{!eq{$item}{b}}
9095 .endd
9096 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9097 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9098
9099
9100 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9101 .cindex "hash function" "textual"
9102 .cindex "expansion" "textual hash"
9103 This is a textual hashing function, and was the first to be implemented in
9104 early versions of Exim. In current releases, there are other hashing functions
9105 (numeric, MD5, and SHA-1), which are described below.
9106
9107 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9108 <&'n'&>. If you are using fixed values for these numbers, that is, if
9109 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9110 use the simpler operator notation that avoids some of the braces:
9111 .code
9112 ${hash_<n>_<m>:<string>}
9113 .endd
9114 The second number is optional (in both notations). If <&'n'&> is greater than
9115 or equal to the length of the string, the expansion item returns the string.
9116 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9117 function to the string. The new string consists of characters taken from the
9118 first <&'m'&> characters of the string
9119 .code
9120 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9121 .endd
9122 If <&'m'&> is not present the value 26 is used, so that only lower case
9123 letters appear. For example:
9124 .display
9125 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9126 &`$hash{5}{monty}}           `&   yields  &`monty`&
9127 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9128 .endd
9129
9130 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9131         &*$h_*&<&'header&~name'&>&*:*&" &&&
9132        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9133         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9134        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9135         &*$rh_*&<&'header&~name'&>&*:*&"
9136 .cindex "expansion" "header insertion"
9137 .vindex "&$header_$&"
9138 .vindex "&$bheader_$&"
9139 .vindex "&$rheader_$&"
9140 .cindex "header lines" "in expansion strings"
9141 .cindex "header lines" "character sets"
9142 .cindex "header lines" "decoding"
9143 Substitute the contents of the named message header line, for example
9144 .code
9145 $header_reply-to:
9146 .endd
9147 The newline that terminates a header line is not included in the expansion, but
9148 internal newlines (caused by splitting the header line over several physical
9149 lines) may be present.
9150
9151 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9152 the data in the header line is interpreted.
9153
9154 .ilist
9155 .cindex "white space" "in header lines"
9156 &%rheader%& gives the original &"raw"& content of the header line, with no
9157 processing at all, and without the removal of leading and trailing white space.
9158
9159 .next
9160 .cindex "base64 encoding" "in header lines"
9161 &%bheader%& removes leading and trailing white space, and then decodes base64
9162 or quoted-printable MIME &"words"& within the header text, but does no
9163 character set translation. If decoding of what looks superficially like a MIME
9164 &"word"& fails, the raw string is returned. If decoding
9165 .cindex "binary zero" "in header line"
9166 produces a binary zero character, it is replaced by a question mark &-- this is
9167 what Exim does for binary zeros that are actually received in header lines.
9168
9169 .next
9170 &%header%& tries to translate the string as decoded by &%bheader%& to a
9171 standard character set. This is an attempt to produce the same string as would
9172 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9173 returned. Translation is attempted only on operating systems that support the
9174 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9175 a system Makefile or in &_Local/Makefile_&.
9176 .endlist ilist
9177
9178 In a filter file, the target character set for &%header%& can be specified by a
9179 command of the following form:
9180 .code
9181 headers charset "UTF-8"
9182 .endd
9183 This command affects all references to &$h_$& (or &$header_$&) expansions in
9184 subsequently obeyed filter commands. In the absence of this command, the target
9185 character set in a filter is taken from the setting of the &%headers_charset%&
9186 option in the runtime configuration. The value of this option defaults to the
9187 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9188 ISO-8859-1.
9189
9190 Header names follow the syntax of RFC 2822, which states that they may contain
9191 any printing characters except space and colon. Consequently, curly brackets
9192 &'do not'& terminate header names, and should not be used to enclose them as
9193 if they were variables. Attempting to do so causes a syntax error.
9194
9195 Only header lines that are common to all copies of a message are visible to
9196 this mechanism. These are the original header lines that are received with the
9197 message, and any that are added by an ACL statement or by a system
9198 filter. Header lines that are added to a particular copy of a message by a
9199 router or transport are not accessible.
9200
9201 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9202 before the DATA ACL, because the header structure is not set up until the
9203 message is received. Header lines that are added in a RCPT ACL (for example)
9204 are saved until the message's incoming header lines are available, at which
9205 point they are added. When a DATA ACL is running, however, header lines added
9206 by earlier ACLs are visible.
9207
9208 Upper case and lower case letters are synonymous in header names. If the
9209 following character is white space, the terminating colon may be omitted, but
9210 this is not recommended, because you may then forget it when it is needed. When
9211 white space terminates the header name, it is included in the expanded string.
9212 If the message does not contain the given header, the expansion item is
9213 replaced by an empty string. (See the &%def%& condition in section
9214 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9215
9216 If there is more than one header with the same name, they are all concatenated
9217 to form the substitution string, up to a maximum length of 64K. Unless
9218 &%rheader%& is being used, leading and trailing white space is removed from
9219 each header before concatenation, and a completely empty header is ignored. A
9220 newline character is then inserted between non-empty headers, but there is no
9221 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9222 those headers that contain lists of addresses, a comma is also inserted at the
9223 junctions between headers. This does not happen for the &%rheader%& expansion.
9224
9225
9226 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9227 .cindex "expansion" "hmac hashing"
9228 .cindex &%hmac%&
9229 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9230 shared secret and some text into a message authentication code, as specified in
9231 RFC 2104. This differs from &`${md5:secret_text...}`& or
9232 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9233 cryptographic hash, allowing for authentication that is not possible with MD5
9234 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9235 present. For example:
9236 .code
9237 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9238 .endd
9239 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9240 produces:
9241 .code
9242 dd97e3ba5d1a61b5006108f8c8252953
9243 .endd
9244 As an example of how this might be used, you might put in the main part of
9245 an Exim configuration:
9246 .code
9247 SPAMSCAN_SECRET=cohgheeLei2thahw
9248 .endd
9249 In a router or a transport you could then have:
9250 .code
9251 headers_add = \
9252   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9253   ${hmac{md5}{SPAMSCAN_SECRET}\
9254   {${primary_hostname},${message_exim_id},$h_message-id:}}
9255 .endd
9256 Then given a message, you can check where it was scanned by looking at the
9257 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9258 this header line is authentic by recomputing the authentication code from the
9259 host name, message ID and the &'Message-id:'& header line. This can be done
9260 using Exim's &%-be%& option, or by other means, for example by using the
9261 &'hmac_md5_hex()'& function in Perl.
9262
9263
9264 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9265 .cindex "expansion" "conditional"
9266 .cindex "&%if%&, expansion item"
9267 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9268 item; otherwise <&'string2'&> is used. The available conditions are described
9269 in section &<<SECTexpcond>>& below. For example:
9270 .code
9271 ${if eq {$local_part}{postmaster} {yes}{no} }
9272 .endd
9273 The second string need not be present; if it is not and the condition is not
9274 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9275 be present instead of the second string (without any curly brackets). In this
9276 case, the expansion is forced to fail if the condition is not true (see section
9277 &<<SECTforexpfai>>&).
9278
9279 If both strings are omitted, the result is the string &`true`& if the condition
9280 is true, and the empty string if the condition is false. This makes it less
9281 cumbersome to write custom ACL and router conditions. For example, instead of
9282 .code
9283 condition = ${if >{$acl_m4}{3}{true}{false}}
9284 .endd
9285 you can use
9286 .code
9287 condition = ${if >{$acl_m4}{3}}
9288 .endd
9289
9290 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9291 .cindex "expansion" "string truncation"
9292 .cindex "&%length%& expansion item"
9293 The &%length%& item is used to extract the initial portion of a string. Both
9294 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9295 you are using a fixed value for the number, that is, if <&'string1'&> does not
9296 change when expanded, you can use the simpler operator notation that avoids
9297 some of the braces:
9298 .code
9299 ${length_<n>:<string>}
9300 .endd
9301 The result of this item is either the first <&'n'&> characters or the whole
9302 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9303 &%strlen%&, which gives the length of a string.
9304
9305
9306 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9307         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9308 .cindex "expansion" "extracting list elements by number"
9309 .cindex "&%listextract%&" "extract list elements by number"
9310 .cindex "list" "extracting elements by number"
9311 The <&'number'&> argument must consist entirely of decimal digits,
9312 apart from an optional leading minus,
9313 and leading and trailing white space (which is ignored).
9314
9315 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9316 default, but the separator can be changed in the usual way.
9317
9318 The first field of the list is numbered one.
9319 If the number is negative, the fields are
9320 counted from the end of the list, with the rightmost one numbered -1.
9321 The numbered element of the list is extracted and placed in &$value$&,
9322 then <&'string2'&> is expanded as the result.
9323
9324 If the modulus of the
9325 number is zero or greater than the number of fields in the string,
9326 the result is the expansion of <&'string3'&>.
9327
9328 For example:
9329 .code
9330 ${listextract{2}{x:42:99}}
9331 .endd
9332 yields &"42"&, and
9333 .code
9334 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9335 .endd
9336 yields &"result: 99"&.
9337
9338 If {<&'string3'&>} is omitted, an empty string is used for string3.
9339 If {<&'string2'&>} is also omitted, the value that was
9340 extracted is used.
9341 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9342
9343
9344 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9345         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9346 This is the first of one of two different types of lookup item, which are both
9347 described in the next item.
9348
9349 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9350         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9351 .cindex "expansion" "lookup in"
9352 .cindex "file" "lookups"
9353 .cindex "lookup" "in expanded string"
9354 The two forms of lookup item specify data lookups in files and databases, as
9355 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9356 lookups, and the second is used for query-style lookups. The <&'key'&>,
9357 <&'file'&>, and <&'query'&> strings are expanded before use.
9358
9359 If there is any white space in a lookup item which is part of a filter command,
9360 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9361 other place where white space is significant, the lookup item must be enclosed
9362 in double quotes. The use of data lookups in users' filter files may be locked
9363 out by the system administrator.
9364
9365 .vindex "&$value$&"
9366 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9367 During its expansion, the variable &$value$& contains the data returned by the
9368 lookup. Afterwards it reverts to the value it had previously (at the outer
9369 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9370 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9371 string on failure. If <&'string2'&> is provided, it can itself be a nested
9372 lookup, thus providing a mechanism for looking up a default value when the
9373 original lookup fails.
9374
9375 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9376 data for the outer lookup while the parameters of the second lookup are
9377 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9378 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9379 appear, and in this case, if the lookup fails, the entire expansion is forced
9380 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9381 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9382 successful lookup, and nothing in the case of failure.
9383
9384 For single-key lookups, the string &"partial"& is permitted to precede the
9385 search type in order to do partial matching, and * or *@ may follow a search
9386 type to request default lookups if the key does not match (see sections
9387 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9388
9389 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9390 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9391 and non-wild parts of the key during the expansion of the replacement text.
9392 They return to their previous values at the end of the lookup item.
9393
9394 This example looks up the postmaster alias in the conventional alias file:
9395 .code
9396 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9397 .endd
9398 This example uses NIS+ to look up the full name of the user corresponding to
9399 the local part of an address, forcing the expansion to fail if it is not found:
9400 .code
9401 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9402   {$value}fail}
9403 .endd
9404
9405
9406 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9407 .cindex "expansion" "list creation"
9408 .vindex "&$item$&"
9409 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9410 default, but the separator can be changed in the usual way. For each item
9411 in this list, its value is place in &$item$&, and then <&'string2'&> is
9412 expanded and added to the output as an item in a new list. The separator used
9413 for the output list is the same as the one used for the input, but a separator
9414 setting is not included in the output. For example:
9415 .code
9416 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9417 .endd
9418 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9419 value of &$item$& is restored to what it was before. See also the &*filter*&
9420 and &*reduce*& expansion items.
9421
9422 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9423 .cindex "expansion" "numeric hash"
9424 .cindex "hash function" "numeric"
9425 The three strings are expanded; the first two must yield numbers. Call them
9426 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9427 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9428 can use the simpler operator notation that avoids some of the braces:
9429 .code
9430 ${nhash_<n>_<m>:<string>}
9431 .endd
9432 The second number is optional (in both notations). If there is only one number,
9433 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9434 processed by a div/mod hash function that returns two numbers, separated by a
9435 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9436 example,
9437 .code
9438 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9439 .endd
9440 returns the string &"6/33"&.
9441
9442
9443
9444 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9445 .cindex "Perl" "use in expanded string"
9446 .cindex "expansion" "calling Perl from"
9447 This item is available only if Exim has been built to include an embedded Perl
9448 interpreter. The subroutine name and the arguments are first separately
9449 expanded, and then the Perl subroutine is called with those arguments. No
9450 additional arguments need be given; the maximum number permitted, including the
9451 name of the subroutine, is nine.
9452
9453 The return value of the subroutine is inserted into the expanded string, unless
9454 the return value is &%undef%&. In that case, the expansion fails in the same
9455 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9456 Whatever you return is evaluated in a scalar context. For example, if you
9457 return the name of a Perl vector, the return value is the size of the vector,
9458 not its contents.
9459
9460 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9461 with the error message that was passed to &%die%&. More details of the embedded
9462 Perl facility are given in chapter &<<CHAPperl>>&.
9463
9464 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9465 out the use of this expansion item in filter files.
9466
9467
9468 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9469 .cindex "&%prvs%& expansion item"
9470 The first argument is a complete email address and the second is secret
9471 keystring. The third argument, specifying a key number, is optional. If absent,
9472 it defaults to 0. The result of the expansion is a prvs-signed email address,
9473 to be typically used with the &%return_path%& option on an &(smtp)& transport
9474 as part of a bounce address tag validation (BATV) scheme. For more discussion
9475 and an example, see section &<<SECTverifyPRVS>>&.
9476
9477 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9478         {*&<&'string'&>&*}}*&"
9479 .cindex "&%prvscheck%& expansion item"
9480 This expansion item is the complement of the &%prvs%& item. It is used for
9481 checking prvs-signed addresses. If the expansion of the first argument does not
9482 yield a syntactically valid prvs-signed address, the whole item expands to the
9483 empty string. When the first argument does expand to a syntactically valid
9484 prvs-signed address, the second argument is expanded, with the prvs-decoded
9485 version of the address and the key number extracted from the address in the
9486 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9487
9488 These two variables can be used in the expansion of the second argument to
9489 retrieve the secret. The validity of the prvs-signed address is then checked
9490 against the secret. The result is stored in the variable &$prvscheck_result$&,
9491 which is empty for failure or &"1"& for success.
9492
9493 The third argument is optional; if it is missing, it defaults to an empty
9494 string. This argument is now expanded. If the result is an empty string, the
9495 result of the expansion is the decoded version of the address. This is the case
9496 whether or not the signature was valid. Otherwise, the result of the expansion
9497 is the expansion of the third argument.
9498
9499 All three variables can be used in the expansion of the third argument.
9500 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9501 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9502
9503 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9504 .cindex "expansion" "inserting an entire file"
9505 .cindex "file" "inserting into expansion"
9506 .cindex "&%readfile%& expansion item"
9507 The file name and end-of-line string are first expanded separately. The file is
9508 then read, and its contents replace the entire item. All newline characters in
9509 the file are replaced by the end-of-line string if it is present. Otherwise,
9510 newlines are left in the string.
9511 String expansion is not applied to the contents of the file. If you want this,
9512 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9513 the string expansion fails.
9514
9515 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9516 locks out the use of this expansion item in filter files.
9517
9518
9519
9520 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9521         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9522 .cindex "expansion" "inserting from a socket"
9523 .cindex "socket, use of in expansion"
9524 .cindex "&%readsocket%& expansion item"
9525 This item inserts data from a Unix domain or Internet socket into the expanded
9526 string. The minimal way of using it uses just two arguments, as in these
9527 examples:
9528 .code
9529 ${readsocket{/socket/name}{request string}}
9530 ${readsocket{inet:some.host:1234}{request string}}
9531 .endd
9532 For a Unix domain socket, the first substring must be the path to the socket.
9533 For an Internet socket, the first substring must contain &`inet:`& followed by
9534 a host name or IP address, followed by a colon and a port, which can be a
9535 number or the name of a TCP port in &_/etc/services_&. An IP address may
9536 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9537 example:
9538 .code
9539 ${readsocket{inet:[::1]:1234}{request string}}
9540 .endd
9541 Only a single host name may be given, but if looking it up yields more than
9542 one IP address, they are each tried in turn until a connection is made. For
9543 both kinds of socket, Exim makes a connection, writes the request string
9544 (unless it is an empty string) and reads from the socket until an end-of-file
9545 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9546 extend what can be done. Firstly, you can vary the timeout. For example:
9547 .code
9548 ${readsocket{/socket/name}{request string}{3s}}
9549 .endd
9550 A fourth argument allows you to change any newlines that are in the data
9551 that is read, in the same way as for &%readfile%& (see above). This example
9552 turns them into spaces:
9553 .code
9554 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9555 .endd
9556 As with all expansions, the substrings are expanded before the processing
9557 happens. Errors in these sub-expansions cause the expansion to fail. In
9558 addition, the following errors can occur:
9559
9560 .ilist
9561 Failure to create a socket file descriptor;
9562 .next
9563 Failure to connect the socket;
9564 .next
9565 Failure to write the request string;
9566 .next
9567 Timeout on reading from the socket.
9568 .endlist
9569
9570 By default, any of these errors causes the expansion to fail. However, if
9571 you supply a fifth substring, it is expanded and used when any of the above
9572 errors occurs. For example:
9573 .code
9574 ${readsocket{/socket/name}{request string}{3s}{\n}\
9575   {socket failure}}
9576 .endd
9577 You can test for the existence of a Unix domain socket by wrapping this
9578 expansion in &`${if exists`&, but there is a race condition between that test
9579 and the actual opening of the socket, so it is safer to use the fifth argument
9580 if you want to be absolutely sure of avoiding an expansion error for a
9581 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9582
9583 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9584 locks out the use of this expansion item in filter files.
9585
9586
9587 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9588 .cindex "expansion" "reducing a list to a scalar"
9589 .cindex "list" "reducing to a scalar"
9590 .vindex "&$value$&"
9591 .vindex "&$item$&"
9592 This operation reduces a list to a single, scalar string. After expansion,
9593 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9594 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9595 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9596 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9597 them. The result of that expansion is assigned to &$value$& before the next
9598 iteration. When the end of the list is reached, the final value of &$value$& is
9599 added to the expansion output. The &*reduce*& expansion item can be used in a
9600 number of ways. For example, to add up a list of numbers:
9601 .code
9602 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9603 .endd
9604 The result of that expansion would be &`6`&. The maximum of a list of numbers
9605 can be found:
9606 .code
9607 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9608 .endd
9609 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9610 restored to what they were before. See also the &*filter*& and &*map*&
9611 expansion items.
9612
9613 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9614 This item inserts &"raw"& header lines. It is described with the &%header%&
9615 expansion item above.
9616
9617 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9618         {*&<&'string2'&>&*}}*&"
9619 .cindex "expansion" "running a command"
9620 .cindex "&%run%& expansion item"
9621 The command and its arguments are first expanded as one string. The string is
9622 split apart into individual arguments by spaces, and then the command is run
9623 in a separate process, but under the same uid and gid.  As in other command
9624 executions from Exim, a shell is not used by default. If the command requires
9625 a shell, you must explicitly code it.
9626
9627 Since the arguments are split by spaces, when there is a variable expansion
9628 which has an empty result, it will cause the situation that the argument will
9629 simply be omitted when the program is actually executed by Exim. If the
9630 script/program requires a specific number of arguments and the expanded
9631 variable could possibly result in this empty expansion, the variable must be
9632 quoted. This is more difficult if the expanded variable itself could result
9633 in a string containing quotes, because it would interfere with the quotes
9634 around the command arguments. A possible guard against this is to wrap the
9635 variable in the &%sg%& operator to change any quote marks to some other
9636 character.
9637
9638 The standard input for the command exists, but is empty. The standard output
9639 and standard error are set to the same file descriptor.
9640 .cindex "return code" "from &%run%& expansion"
9641 .vindex "&$value$&"
9642 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9643 and replaces the entire item; during this expansion, the standard output/error
9644 from the command is in the variable &$value$&. If the command fails,
9645 <&'string2'&>, if present, is expanded and used. Once again, during the
9646 expansion, the standard output/error from the command is in the variable
9647 &$value$&.
9648
9649 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9650 can be the word &"fail"& (not in braces) to force expansion failure if the
9651 command does not succeed. If both strings are omitted, the result is contents
9652 of the standard output/error on success, and nothing on failure.
9653
9654 .vindex "&$run_in_acl$&"
9655 The standard output/error of the command is put in the variable &$value$&.
9656 In this ACL example, the output of a command is logged for the admin to
9657 troubleshoot:
9658 .code
9659 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9660       log_message  = Output of id: $value
9661 .endd
9662 If the command requires shell idioms, such as the > redirect operator, the
9663 shell must be invoked directly, such as with:
9664 .code
9665 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9666 .endd
9667
9668 .vindex "&$runrc$&"
9669 The return code from the command is put in the variable &$runrc$&, and this
9670 remains set afterwards, so in a filter file you can do things like this:
9671 .code
9672 if "${run{x y z}{}}$runrc" is 1 then ...
9673   elif $runrc is 2 then ...
9674   ...
9675 endif
9676 .endd
9677 If execution of the command fails (for example, the command does not exist),
9678 the return code is 127 &-- the same code that shells use for non-existent
9679 commands.
9680
9681 &*Warning*&: In a router or transport, you cannot assume the order in which
9682 option values are expanded, except for those preconditions whose order of
9683 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9684 by the expansion of one option, and use it in another.
9685
9686 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9687 out the use of this expansion item in filter files.
9688
9689
9690 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9691 .cindex "expansion" "string substitution"
9692 .cindex "&%sg%& expansion item"
9693 This item works like Perl's substitution operator (s) with the global (/g)
9694 option; hence its name. However, unlike the Perl equivalent, Exim does not
9695 modify the subject string; instead it returns the modified string for insertion
9696 into the overall expansion. The item takes three arguments: the subject string,
9697 a regular expression, and a substitution string. For example:
9698 .code
9699 ${sg{abcdefabcdef}{abc}{xyz}}
9700 .endd
9701 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9702 if any $ or \ characters are required in the regular expression or in the
9703 substitution string, they have to be escaped. For example:
9704 .code
9705 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9706 .endd
9707 yields &"defabc"&, and
9708 .code
9709 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9710 .endd
9711 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9712 the regular expression from string expansion.
9713
9714
9715
9716 .new
9717 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9718 .cindex sorting a list
9719 .cindex list sorting
9720 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9721 default, but the separator can be changed in the usual way.
9722 The <&'comparator'&> argument is interpreted as the operator
9723 of a two-argument expansion condition.
9724 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9725 The comparison should return true when applied to two values
9726 if the first value should sort before the second value.
9727 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9728 the element being placed in &$item$&,
9729 to give values for comparison.
9730
9731 The item result is a sorted list,
9732 with the original list separator,
9733 of the list elements (in full) of the original.
9734
9735 Examples:
9736 .code
9737 ${sort{3:2:1:4}{<}{$item}}
9738 .endd
9739 sorts a list of numbers, and
9740 .code
9741 ${sort {$lookup dnsdb{>:,,mx=example.com}} {<} {${listextract{1}{<,$item}}}}
9742 .endd
9743 will sort an MX lookup into priority order.
9744 .wen
9745
9746
9747 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9748 .cindex "&%substr%& expansion item"
9749 .cindex "substring extraction"
9750 .cindex "expansion" "substring extraction"
9751 The three strings are expanded; the first two must yield numbers. Call them
9752 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9753 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9754 can use the simpler operator notation that avoids some of the braces:
9755 .code
9756 ${substr_<n>_<m>:<string>}
9757 .endd
9758 The second number is optional (in both notations).
9759 If it is absent in the simpler format, the preceding underscore must also be
9760 omitted.
9761
9762 The &%substr%& item can be used to extract more general substrings than
9763 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9764 length required. For example
9765 .code
9766 ${substr{3}{2}{$local_part}}
9767 .endd
9768 If the starting offset is greater than the string length the result is the
9769 null string; if the length plus starting offset is greater than the string
9770 length, the result is the right-hand part of the string, starting from the
9771 given offset. The first character in the string has offset zero.
9772
9773 The &%substr%& expansion item can take negative offset values to count
9774 from the right-hand end of its operand. The last character is offset -1, the
9775 second-last is offset -2, and so on. Thus, for example,
9776 .code
9777 ${substr{-5}{2}{1234567}}
9778 .endd
9779 yields &"34"&. If the absolute value of a negative offset is greater than the
9780 length of the string, the substring starts at the beginning of the string, and
9781 the length is reduced by the amount of overshoot. Thus, for example,
9782 .code
9783 ${substr{-5}{2}{12}}
9784 .endd
9785 yields an empty string, but
9786 .code
9787 ${substr{-3}{2}{12}}
9788 .endd
9789 yields &"1"&.
9790
9791 When the second number is omitted from &%substr%&, the remainder of the string
9792 is taken if the offset is positive. If it is negative, all characters in the
9793 string preceding the offset point are taken. For example, an offset of -1 and
9794 no length, as in these semantically identical examples:
9795 .code
9796 ${substr_-1:abcde}
9797 ${substr{-1}{abcde}}
9798 .endd
9799 yields all but the last character of the string, that is, &"abcd"&.
9800
9801
9802
9803 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9804         {*&<&'replacements'&>&*}}*&"
9805 .cindex "expansion" "character translation"
9806 .cindex "&%tr%& expansion item"
9807 This item does single-character translation on its subject string. The second
9808 argument is a list of characters to be translated in the subject string. Each
9809 matching character is replaced by the corresponding character from the
9810 replacement list. For example
9811 .code
9812 ${tr{abcdea}{ac}{13}}
9813 .endd
9814 yields &`1b3de1`&. If there are duplicates in the second character string, the
9815 last occurrence is used. If the third string is shorter than the second, its
9816 last character is replicated. However, if it is empty, no translation takes
9817 place.
9818 .endlist
9819
9820
9821
9822 .section "Expansion operators" "SECTexpop"
9823 .cindex "expansion" "operators"
9824 For expansion items that perform transformations on a single argument string,
9825 the &"operator"& notation is used because it is simpler and uses fewer braces.
9826 The substring is first expanded before the operation is applied to it. The
9827 following operations can be performed:
9828
9829 .vlist
9830 .vitem &*${address:*&<&'string'&>&*}*&
9831 .cindex "expansion" "RFC 2822 address handling"
9832 .cindex "&%address%& expansion item"
9833 The string is interpreted as an RFC 2822 address, as it might appear in a
9834 header line, and the effective address is extracted from it. If the string does
9835 not parse successfully, the result is empty.
9836
9837
9838 .vitem &*${addresses:*&<&'string'&>&*}*&
9839 .cindex "expansion" "RFC 2822 address handling"
9840 .cindex "&%addresses%& expansion item"
9841 The string (after expansion) is interpreted as a list of addresses in RFC
9842 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9843 operative address (&'local-part@domain'&) is extracted from each item, and the
9844 result of the expansion is a colon-separated list, with appropriate
9845 doubling of colons should any happen to be present in the email addresses.
9846 Syntactically invalid RFC2822 address items are omitted from the output.
9847
9848 It is possible to specify a character other than colon for the output
9849 separator by starting the string with > followed by the new separator
9850 character. For example:
9851 .code
9852 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9853 .endd
9854 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9855 expansion item, which extracts the working address from a single RFC2822
9856 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9857 processing lists.
9858
9859 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9860 a strict interpretation of header line formatting.  Exim parses the bare,
9861 unquoted portion of an email address and if it finds a comma, treats it as an
9862 email address seperator. For the example header line:
9863 .code
9864 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9865 .endd
9866 The first example below demonstrates that Q-encoded email addresses are parsed
9867 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9868 It does not see the comma because it's still encoded as "=2C".  The second
9869 example below is passed the contents of &`$header_from:`&, meaning it gets
9870 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9871 The third example shows that the presence of a comma is skipped when it is
9872 quoted.
9873 .code
9874 # exim -be '${addresses:From: \
9875 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9876 user@example.com
9877 # exim -be '${addresses:From: Last, First <user@example.com>}'
9878 Last:user@example.com
9879 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9880 user@example.com
9881 .endd
9882
9883 .vitem &*${base62:*&<&'digits'&>&*}*&
9884 .cindex "&%base62%& expansion item"
9885 .cindex "expansion" "conversion to base 62"
9886 The string must consist entirely of decimal digits. The number is converted to
9887 base 62 and output as a string of six characters, including leading zeros. In
9888 the few operating environments where Exim uses base 36 instead of base 62 for
9889 its message identifiers (because those systems do not have case-sensitive file
9890 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9891 be absolutely clear: this is &'not'& base64 encoding.
9892
9893 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9894 .cindex "&%base62d%& expansion item"
9895 .cindex "expansion" "conversion to base 62"
9896 The string must consist entirely of base-62 digits, or, in operating
9897 environments where Exim uses base 36 instead of base 62 for its message
9898 identifiers, base-36 digits. The number is converted to decimal and output as a
9899 string.
9900
9901
9902 .vitem &*${domain:*&<&'string'&>&*}*&
9903 .cindex "domain" "extraction"
9904 .cindex "expansion" "domain extraction"
9905 The string is interpreted as an RFC 2822 address and the domain is extracted
9906 from it. If the string does not parse successfully, the result is empty.
9907
9908
9909 .vitem &*${escape:*&<&'string'&>&*}*&
9910 .cindex "expansion" "escaping non-printing characters"
9911 .cindex "&%escape%& expansion item"
9912 If the string contains any non-printing characters, they are converted to
9913 escape sequences starting with a backslash. Whether characters with the most
9914 significant bit set (so-called &"8-bit characters"&) count as printing or not
9915 is controlled by the &%print_topbitchars%& option.
9916
9917
9918 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9919 .cindex "expansion" "expression evaluation"
9920 .cindex "expansion" "arithmetic expression"
9921 .cindex "&%eval%& expansion item"
9922 These items supports simple arithmetic and bitwise logical operations in
9923 expansion strings. The string (after expansion) must be a conventional
9924 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9925 logical operators, and parentheses. All operations are carried out using
9926 integer arithmetic. The operator priorities are as follows (the same as in the
9927 C programming language):
9928 .table2 70pt 300pt
9929 .irow &'highest:'& "not (~), negate (-)"
9930 .irow ""   "multiply (*), divide (/), remainder (%)"
9931 .irow ""   "plus (+), minus (-)"
9932 .irow ""   "shift-left (<<), shift-right (>>)"
9933 .irow ""   "and (&&)"
9934 .irow ""   "xor (^)"
9935 .irow &'lowest:'&  "or (|)"
9936 .endtable
9937 Binary operators with the same priority are evaluated from left to right. White
9938 space is permitted before or after operators.
9939
9940 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9941 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9942 decimal, even if they start with a leading zero; hexadecimal numbers are not
9943 permitted. This can be useful when processing numbers extracted from dates or
9944 times, which often do have leading zeros.
9945
9946 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9947 or 1024*1024*1024,
9948 respectively. Negative numbers are supported. The result of the computation is
9949 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9950
9951 .display
9952 &`${eval:1+1}            `&  yields 2
9953 &`${eval:1+2*3}          `&  yields 7
9954 &`${eval:(1+2)*3}        `&  yields 9
9955 &`${eval:2+42%5}         `&  yields 4
9956 &`${eval:0xc&amp;5}          `&  yields 4
9957 &`${eval:0xc|5}          `&  yields 13
9958 &`${eval:0xc^5}          `&  yields 9
9959 &`${eval:0xc>>1}         `&  yields 6
9960 &`${eval:0xc<<1}         `&  yields 24
9961 &`${eval:~255&amp;0x1234}    `&  yields 4608
9962 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9963 .endd
9964
9965 As a more realistic example, in an ACL you might have
9966 .code
9967 deny   message = Too many bad recipients
9968        condition =                    \
9969          ${if and {                   \
9970            {>{$rcpt_count}{10}}       \
9971            {                          \
9972            <                          \
9973              {$recipients_count}      \
9974              {${eval:$rcpt_count/2}}  \
9975            }                          \
9976          }{yes}{no}}
9977 .endd
9978 The condition is true if there have been more than 10 RCPT commands and
9979 fewer than half of them have resulted in a valid recipient.
9980
9981
9982 .vitem &*${expand:*&<&'string'&>&*}*&
9983 .cindex "expansion" "re-expansion of substring"
9984 The &%expand%& operator causes a string to be expanded for a second time. For
9985 example,
9986 .code
9987 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9988 .endd
9989 first looks up a string in a file while expanding the operand for &%expand%&,
9990 and then re-expands what it has found.
9991
9992
9993 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9994 .cindex "Unicode"
9995 .cindex "UTF-8" "conversion from"
9996 .cindex "expansion" "UTF-8 conversion"
9997 .cindex "&%from_utf8%& expansion item"
9998 The world is slowly moving towards Unicode, although there are no standards for
9999 email yet. However, other applications (including some databases) are starting
10000 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10001 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10002 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10003 the result is an undefined sequence of bytes.
10004
10005 Unicode code points with values less than 256 are compatible with ASCII and
10006 ISO-8859-1 (also known as Latin-1).
10007 For example, character 169 is the copyright symbol in both cases, though the
10008 way it is encoded is different. In UTF-8, more than one byte is needed for
10009 characters with code values greater than 127, whereas ISO-8859-1 is a
10010 single-byte encoding (but thereby limited to 256 characters). This makes
10011 translation from UTF-8 to ISO-8859-1 straightforward.
10012
10013
10014 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10015 .cindex "hash function" "textual"
10016 .cindex "expansion" "textual hash"
10017 The &%hash%& operator is a simpler interface to the hashing function that can
10018 be used when the two parameters are fixed numbers (as opposed to strings that
10019 change when expanded). The effect is the same as
10020 .code
10021 ${hash{<n>}{<m>}{<string>}}
10022 .endd
10023 See the description of the general &%hash%& item above for details. The
10024 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10025
10026
10027
10028 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10029 .cindex "base64 encoding" "conversion from hex"
10030 .cindex "expansion" "hex to base64"
10031 .cindex "&%hex2b64%& expansion item"
10032 This operator converts a hex string into one that is base64 encoded. This can
10033 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10034
10035
10036
10037 .vitem &*${hexquote:*&<&'string'&>&*}*&
10038 .cindex "quoting" "hex-encoded unprintable characters"
10039 .cindex "&%hexquote%& expansion item"
10040 This operator converts non-printable characters in a string into a hex
10041 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10042 as is, and other byte values are converted to &`\xNN`&, for example a
10043 byte value 127 is converted to &`\x7f`&.
10044
10045
10046 .vitem &*${lc:*&<&'string'&>&*}*&
10047 .cindex "case forcing in strings"
10048 .cindex "string" "case forcing"
10049 .cindex "lower casing"
10050 .cindex "expansion" "case forcing"
10051 .cindex "&%lc%& expansion item"
10052 This forces the letters in the string into lower-case, for example:
10053 .code
10054 ${lc:$local_part}
10055 .endd
10056
10057 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10058 .cindex "expansion" "string truncation"
10059 .cindex "&%length%& expansion item"
10060 The &%length%& operator is a simpler interface to the &%length%& function that
10061 can be used when the parameter is a fixed number (as opposed to a string that
10062 changes when expanded). The effect is the same as
10063 .code
10064 ${length{<number>}{<string>}}
10065 .endd
10066 See the description of the general &%length%& item above for details. Note that
10067 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10068 when &%length%& is used as an operator.
10069
10070
10071 .vitem &*${listcount:*&<&'string'&>&*}*&
10072 .cindex "expansion" "list item count"
10073 .cindex "list" "item count"
10074 .cindex "list" "count of items"
10075 .cindex "&%listcount%& expansion item"
10076 The string is interpreted as a list and the number of items is returned.
10077
10078
10079 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10080 .cindex "expansion" "named list"
10081 .cindex "&%listnamed%& expansion item"
10082 The name is interpreted as a named list and the content of the list is returned,
10083 expanding any referenced lists, re-quoting as needed for colon-separation.
10084 If the optional type is given it must be one of "a", "d", "h" or "l"
10085 and selects address-, domain-, host- or localpart- lists to search among respectively.
10086 Otherwise all types are searched in an undefined order and the first
10087 matching list is returned.
10088
10089
10090 .vitem &*${local_part:*&<&'string'&>&*}*&
10091 .cindex "expansion" "local part extraction"
10092 .cindex "&%local_part%& expansion item"
10093 The string is interpreted as an RFC 2822 address and the local part is
10094 extracted from it. If the string does not parse successfully, the result is
10095 empty.
10096
10097
10098 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10099 .cindex "masked IP address"
10100 .cindex "IP address" "masking"
10101 .cindex "CIDR notation"
10102 .cindex "expansion" "IP address masking"
10103 .cindex "&%mask%& expansion item"
10104 If the form of the string to be operated on is not an IP address followed by a
10105 slash and an integer (that is, a network address in CIDR notation), the
10106 expansion fails. Otherwise, this operator converts the IP address to binary,
10107 masks off the least significant bits according to the bit count, and converts
10108 the result back to text, with mask appended. For example,
10109 .code
10110 ${mask:10.111.131.206/28}
10111 .endd
10112 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10113 be mostly used for looking up masked addresses in files, the result for an IPv6
10114 address uses dots to separate components instead of colons, because colon
10115 terminates a key string in lsearch files. So, for example,
10116 .code
10117 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10118 .endd
10119 returns the string
10120 .code
10121 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10122 .endd
10123 Letters in IPv6 addresses are always output in lower case.
10124
10125
10126 .vitem &*${md5:*&<&'string'&>&*}*&
10127 .cindex "MD5 hash"
10128 .cindex "expansion" "MD5 hash"
10129 .cindex "certificate fingerprint"
10130 .cindex "&%md5%& expansion item"
10131 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10132 as a 32-digit hexadecimal number, in which any letters are in lower case.
10133
10134
10135 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10136 .cindex "expansion" "numeric hash"
10137 .cindex "hash function" "numeric"
10138 The &%nhash%& operator is a simpler interface to the numeric hashing function
10139 that can be used when the two parameters are fixed numbers (as opposed to
10140 strings that change when expanded). The effect is the same as
10141 .code
10142 ${nhash{<n>}{<m>}{<string>}}
10143 .endd
10144 See the description of the general &%nhash%& item above for details.
10145
10146
10147 .vitem &*${quote:*&<&'string'&>&*}*&
10148 .cindex "quoting" "in string expansions"
10149 .cindex "expansion" "quoting"
10150 .cindex "&%quote%& expansion item"
10151 The &%quote%& operator puts its argument into double quotes if it
10152 is an empty string or
10153 contains anything other than letters, digits, underscores, dots, and hyphens.
10154 Any occurrences of double quotes and backslashes are escaped with a backslash.
10155 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10156 respectively For example,
10157 .code
10158 ${quote:ab"*"cd}
10159 .endd
10160 becomes
10161 .code
10162 "ab\"*\"cd"
10163 .endd
10164 The place where this is useful is when the argument is a substitution from a
10165 variable or a message header.
10166
10167 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10168 .cindex "&%quote_local_part%& expansion item"
10169 This operator is like &%quote%&, except that it quotes the string only if
10170 required to do so by the rules of RFC 2822 for quoting local parts. For
10171 example, a plus sign would not cause quoting (but it would for &%quote%&).
10172 If you are creating a new email address from the contents of &$local_part$&
10173 (or any other unknown data), you should always use this operator.
10174
10175
10176 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10177 .cindex "quoting" "lookup-specific"
10178 This operator applies lookup-specific quoting rules to the string. Each
10179 query-style lookup type has its own quoting rules which are described with
10180 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10181 .code
10182 ${quote_ldap:two * two}
10183 .endd
10184 returns
10185 .code
10186 two%20%5C2A%20two
10187 .endd
10188 For single-key lookup types, no quoting is ever necessary and this operator
10189 yields an unchanged string.
10190
10191
10192 .vitem &*${randint:*&<&'n'&>&*}*&
10193 .cindex "random number"
10194 This operator returns a somewhat random number which is less than the
10195 supplied number and is at least 0.  The quality of this randomness depends
10196 on how Exim was built; the values are not suitable for keying material.
10197 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10198 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10199 for versions of GnuTLS with that function.
10200 Otherwise, the implementation may be arc4random(), random() seeded by
10201 srandomdev() or srandom(), or a custom implementation even weaker than
10202 random().
10203
10204
10205 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10206 .cindex "expansion" "IP address"
10207 This operator reverses an IP address; for IPv4 addresses, the result is in
10208 dotted-quad decimal form, while for IPv6 addreses the result is in
10209 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10210 for DNS.  For example,
10211 .code
10212 ${reverse_ip:192.0.2.4}
10213 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10214 .endd
10215 returns
10216 .code
10217 4.2.0.192
10218 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
10219 .endd
10220
10221
10222 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10223 .cindex "expansion" "RFC 2047"
10224 .cindex "RFC 2047" "expansion operator"
10225 .cindex "&%rfc2047%& expansion item"
10226 This operator encodes text according to the rules of RFC 2047. This is an
10227 encoding that is used in header lines to encode non-ASCII characters. It is
10228 assumed that the input string is in the encoding specified by the
10229 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10230 contains only characters in the range 33&--126, and no instances of the
10231 characters
10232 .code
10233 ? = ( ) < > @ , ; : \ " . [ ] _
10234 .endd
10235 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10236 string, using as many &"encoded words"& as necessary to encode all the
10237 characters.
10238
10239
10240 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10241 .cindex "expansion" "RFC 2047"
10242 .cindex "RFC 2047" "decoding"
10243 .cindex "&%rfc2047d%& expansion item"
10244 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10245 bytes are replaced by question marks. Characters are converted into the
10246 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10247 not recognized unless &%check_rfc2047_length%& is set false.
10248
10249 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10250 access a header line, RFC 2047 decoding is done automatically. You do not need
10251 to use this operator as well.
10252
10253
10254
10255 .vitem &*${rxquote:*&<&'string'&>&*}*&
10256 .cindex "quoting" "in regular expressions"
10257 .cindex "regular expressions" "quoting"
10258 .cindex "&%rxquote%& expansion item"
10259 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10260 characters in its argument. This is useful when substituting the values of
10261 variables or headers inside regular expressions.
10262
10263
10264 .vitem &*${sha1:*&<&'string'&>&*}*&
10265 .cindex "SHA-1 hash"
10266 .cindex "expansion" "SHA-1 hashing"
10267 .cindex "certificate fingerprint"
10268 .cindex "&%sha2%& expansion item"
10269 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10270 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10271
10272
10273 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10274 .cindex "SHA-256 hash"
10275 .cindex "certificate fingerprint"
10276 .cindex "expansion" "SHA-256 hashing"
10277 .cindex "&%sha256%& expansion item"
10278 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10279 certificate,
10280 and returns
10281 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10282 Only arguments which are a single variable of certificate type are supported.
10283
10284
10285 .vitem &*${stat:*&<&'string'&>&*}*&
10286 .cindex "expansion" "statting a file"
10287 .cindex "file" "extracting characteristics"
10288 .cindex "&%stat%& expansion item"
10289 The string, after expansion, must be a file path. A call to the &[stat()]&
10290 function is made for this path. If &[stat()]& fails, an error occurs and the
10291 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10292 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10293 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10294 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10295 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10296 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10297 can extract individual fields using the &%extract%& expansion item.
10298
10299 The use of the &%stat%& expansion in users' filter files can be locked out by
10300 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10301 systems for files larger than 2GB.
10302
10303 .vitem &*${str2b64:*&<&'string'&>&*}*&
10304 .cindex "expansion" "base64 encoding"
10305 .cindex "base64 encoding" "in string expansion"
10306 .cindex "&%str2b64%& expansion item"
10307 This operator converts a string into one that is base64 encoded.
10308
10309
10310
10311 .vitem &*${strlen:*&<&'string'&>&*}*&
10312 .cindex "expansion" "string length"
10313 .cindex "string" "length in expansion"
10314 .cindex "&%strlen%& expansion item"
10315 The item is replace by the length of the expanded string, expressed as a
10316 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10317
10318
10319 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10320 .cindex "&%substr%& expansion item"
10321 .cindex "substring extraction"
10322 .cindex "expansion" "substring expansion"
10323 The &%substr%& operator is a simpler interface to the &%substr%& function that
10324 can be used when the two parameters are fixed numbers (as opposed to strings
10325 that change when expanded). The effect is the same as
10326 .code
10327 ${substr{<start>}{<length>}{<string>}}
10328 .endd
10329 See the description of the general &%substr%& item above for details. The
10330 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10331
10332 .vitem &*${time_eval:*&<&'string'&>&*}*&
10333 .cindex "&%time_eval%& expansion item"
10334 .cindex "time interval" "decoding"
10335 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10336 seconds.
10337
10338 .vitem &*${time_interval:*&<&'string'&>&*}*&
10339 .cindex "&%time_interval%& expansion item"
10340 .cindex "time interval" "formatting"
10341 The argument (after sub-expansion) must be a sequence of decimal digits that
10342 represents an interval of time as a number of seconds. It is converted into a
10343 number of larger units and output in Exim's normal time format, for example,
10344 &`1w3d4h2m6s`&.
10345
10346 .vitem &*${uc:*&<&'string'&>&*}*&
10347 .cindex "case forcing in strings"
10348 .cindex "string" "case forcing"
10349 .cindex "upper casing"
10350 .cindex "expansion" "case forcing"
10351 .cindex "&%uc%& expansion item"
10352 This forces the letters in the string into upper-case.
10353
10354 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10355 .cindex "correction of invalid utf-8 sequences in strings"
10356 .cindex "utf-8" "utf-8 sequences"
10357 .cindex "incorrect utf-8"
10358 .cindex "expansion" "utf-8 forcing"
10359 .cindex "&%utf8clean%& expansion item"
10360 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10361 .endlist
10362
10363
10364
10365
10366
10367
10368 .section "Expansion conditions" "SECTexpcond"
10369 .scindex IIDexpcond "expansion" "conditions"
10370 The following conditions are available for testing by the &%${if%& construct
10371 while expanding strings:
10372
10373 .vlist
10374 .vitem &*!*&<&'condition'&>
10375 .cindex "expansion" "negating a condition"
10376 .cindex "negation" "in expansion condition"
10377 Preceding any condition with an exclamation mark negates the result of the
10378 condition.
10379
10380 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10381 .cindex "numeric comparison"
10382 .cindex "expansion" "numeric comparison"
10383 There are a number of symbolic operators for doing numeric comparisons. They
10384 are:
10385 .display
10386 &`=   `&   equal
10387 &`==  `&   equal
10388 &`>   `&   greater
10389 &`>=  `&   greater or equal
10390 &`<   `&   less
10391 &`<=  `&   less or equal
10392 .endd
10393 For example:
10394 .code
10395 ${if >{$message_size}{10M} ...
10396 .endd
10397 Note that the general negation operator provides for inequality testing. The
10398 two strings must take the form of optionally signed decimal integers,
10399 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10400 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10401 As a special case, the numerical value of an empty string is taken as
10402 zero.
10403
10404 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10405 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10406 10M, not if 10M is larger than &$message_size$&.
10407
10408
10409 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10410         {*&<&'arg2'&>&*}...}*&
10411 .cindex "expansion" "calling an acl"
10412 .cindex "&%acl%&" "expansion condition"
10413 The name and zero to nine argument strings are first expanded separately.  The expanded
10414 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10415 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10416 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10417 and may use the variables; if another acl expansion is used the values
10418 are restored after it returns.  If the ACL sets
10419 a value using a "message =" modifier the variable $value becomes
10420 the result of the expansion, otherwise it is empty.
10421 If the ACL returns accept the condition is true; if deny, false.
10422 If the ACL returns defer the result is a forced-fail.
10423
10424 .vitem &*bool&~{*&<&'string'&>&*}*&
10425 .cindex "expansion" "boolean parsing"
10426 .cindex "&%bool%& expansion condition"
10427 This condition turns a string holding a true or false representation into
10428 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10429 (case-insensitively); also integer numbers map to true if non-zero,
10430 false if zero.
10431 An empty string is treated as false.
10432 Leading and trailing whitespace is ignored;
10433 thus a string consisting only of whitespace is false.
10434 All other string values will result in expansion failure.
10435
10436 When combined with ACL variables, this expansion condition will let you
10437 make decisions in one place and act on those decisions in another place.
10438 For example:
10439 .code
10440 ${if bool{$acl_m_privileged_sender} ...
10441 .endd
10442
10443
10444 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10445 .cindex "expansion" "boolean parsing"
10446 .cindex "&%bool_lax%& expansion condition"
10447 Like &%bool%&, this condition turns a string into a boolean state.  But
10448 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10449 loose definition that the Router &%condition%& option uses.  The empty string
10450 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10451 true.  Leading and trailing whitespace is ignored.
10452
10453 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10454
10455 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10456 .cindex "expansion" "encrypted comparison"
10457 .cindex "encrypted strings, comparing"
10458 .cindex "&%crypteq%& expansion condition"
10459 This condition is included in the Exim binary if it is built to support any
10460 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10461 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10462 included in the binary.
10463
10464 The &%crypteq%& condition has two arguments. The first is encrypted and
10465 compared against the second, which is already encrypted. The second string may
10466 be in the LDAP form for storing encrypted strings, which starts with the
10467 encryption type in curly brackets, followed by the data. If the second string
10468 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10469 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10470 Typically this will be a field from a password file. An example of an encrypted
10471 string in LDAP form is:
10472 .code
10473 {md5}CY9rzUYh03PK3k6DJie09g==
10474 .endd
10475 If such a string appears directly in an expansion, the curly brackets have to
10476 be quoted, because they are part of the expansion syntax. For example:
10477 .code
10478 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10479 .endd
10480 The following encryption types (whose names are matched case-independently) are
10481 supported:
10482
10483 .ilist
10484 .cindex "MD5 hash"
10485 .cindex "base64 encoding" "in encrypted password"
10486 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10487 printable characters to compare with the remainder of the second string. If the
10488 length of the comparison string is 24, Exim assumes that it is base64 encoded
10489 (as in the above example). If the length is 32, Exim assumes that it is a
10490 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10491 comparison fails.
10492
10493 .next
10494 .cindex "SHA-1 hash"
10495 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10496 printable characters to compare with the remainder of the second string. If the
10497 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10498 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10499 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10500
10501 .next
10502 .cindex "&[crypt()]&"
10503 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10504 only the first eight characters of the password. However, in modern operating
10505 systems this is no longer true, and in many cases the entire password is used,
10506 whatever its length.
10507
10508 .next
10509 .cindex "&[crypt16()]&"
10510 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10511 use up to 16 characters of the password in some operating systems. Again, in
10512 modern operating systems, more characters may be used.
10513 .endlist
10514 Exim has its own version of &[crypt16()]&, which is just a double call to
10515 &[crypt()]&. For operating systems that have their own version, setting
10516 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10517 operating system version instead of its own. This option is set by default in
10518 the OS-dependent &_Makefile_& for those operating systems that are known to
10519 support &[crypt16()]&.
10520
10521 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10522 it was not using the same algorithm as some operating systems' versions. It
10523 turns out that as well as &[crypt16()]& there is a function called
10524 &[bigcrypt()]& in some operating systems. This may or may not use the same
10525 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10526
10527 However, since there is now a move away from the traditional &[crypt()]&
10528 functions towards using SHA1 and other algorithms, tidying up this area of
10529 Exim is seen as very low priority.
10530
10531 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10532 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10533 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10534 default is &`{crypt}`&. Whatever the default, you can always use either
10535 function by specifying it explicitly in curly brackets.
10536
10537 .vitem &*def:*&<&'variable&~name'&>
10538 .cindex "expansion" "checking for empty variable"
10539 .cindex "&%def%& expansion condition"
10540 The &%def%& condition must be followed by the name of one of the expansion
10541 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10542 variable does not contain the empty string. For example:
10543 .code
10544 ${if def:sender_ident {from $sender_ident}}
10545 .endd
10546 Note that the variable name is given without a leading &%$%& character. If the
10547 variable does not exist, the expansion fails.
10548
10549 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10550         &~&*def:h_*&<&'header&~name'&>&*:*&"
10551 .cindex "expansion" "checking header line existence"
10552 This condition is true if a message is being processed and the named header
10553 exists in the message. For example,
10554 .code
10555 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10556 .endd
10557 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10558 the header name must be terminated by a colon if white space does not follow.
10559
10560 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10561        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10562 .cindex "string" "comparison"
10563 .cindex "expansion" "string comparison"
10564 .cindex "&%eq%& expansion condition"
10565 .cindex "&%eqi%& expansion condition"
10566 The two substrings are first expanded. The condition is true if the two
10567 resulting strings are identical. For &%eq%& the comparison includes the case of
10568 letters, whereas for &%eqi%& the comparison is case-independent.
10569
10570 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10571 .cindex "expansion" "file existence test"
10572 .cindex "file" "existence test"
10573 .cindex "&%exists%&, expansion condition"
10574 The substring is first expanded and then interpreted as an absolute path. The
10575 condition is true if the named file (or directory) exists. The existence test
10576 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10577 users' filter files may be locked out by the system administrator.
10578
10579 .vitem &*first_delivery*&
10580 .cindex "delivery" "first"
10581 .cindex "first delivery"
10582 .cindex "expansion" "first delivery test"
10583 .cindex "&%first_delivery%& expansion condition"
10584 This condition, which has no data, is true during a message's first delivery
10585 attempt. It is false during any subsequent delivery attempts.
10586
10587
10588 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10589        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10590 .cindex "list" "iterative conditions"
10591 .cindex "expansion" "&*forall*& condition"
10592 .cindex "expansion" "&*forany*& condition"
10593 .vindex "&$item$&"
10594 These conditions iterate over a list. The first argument is expanded to form
10595 the list. By default, the list separator is a colon, but it can be changed by
10596 the normal method. The second argument is interpreted as a condition that is to
10597 be applied to each item in the list in turn. During the interpretation of the
10598 condition, the current list item is placed in a variable called &$item$&.
10599 .ilist
10600 For &*forany*&, interpretation stops if the condition is true for any item, and
10601 the result of the whole condition is true. If the condition is false for all
10602 items in the list, the overall condition is false.
10603 .next
10604 For &*forall*&, interpretation stops if the condition is false for any item,
10605 and the result of the whole condition is false. If the condition is true for
10606 all items in the list, the overall condition is true.
10607 .endlist
10608 Note that negation of &*forany*& means that the condition must be false for all
10609 items for the overall condition to succeed, and negation of &*forall*& means
10610 that the condition must be false for at least one item. In this example, the
10611 list separator is changed to a comma:
10612 .code
10613 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10614 .endd
10615 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10616 being processed, to enable these expansion items to be nested.
10617
10618 To scan a named list, expand it with the &*listnamed*& operator.
10619
10620
10621 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10622        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10623 .cindex "string" "comparison"
10624 .cindex "expansion" "string comparison"
10625 .cindex "&%ge%& expansion condition"
10626 .cindex "&%gei%& expansion condition"
10627 The two substrings are first expanded. The condition is true if the first
10628 string is lexically greater than or equal to the second string. For &%ge%& the
10629 comparison includes the case of letters, whereas for &%gei%& the comparison is
10630 case-independent.
10631
10632 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10633        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10634 .cindex "string" "comparison"
10635 .cindex "expansion" "string comparison"
10636 .cindex "&%gt%& expansion condition"
10637 .cindex "&%gti%& expansion condition"
10638 The two substrings are first expanded. The condition is true if the first
10639 string is lexically greater than the second string. For &%gt%& the comparison
10640 includes the case of letters, whereas for &%gti%& the comparison is
10641 case-independent.
10642
10643 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10644        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10645 .cindex "string" "comparison"
10646 .cindex "list" "iterative conditions"
10647 Both strings are expanded; the second string is treated as a list of simple
10648 strings; if the first string is a member of the second, then the condition
10649 is true.
10650
10651 These are simpler to use versions of the more powerful &*forany*& condition.
10652 Examples, and the &*forany*& equivalents:
10653 .code
10654 ${if inlist{needle}{foo:needle:bar}}
10655   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10656 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10657   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10658 .endd
10659
10660 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10661        &*isip4&~{*&<&'string'&>&*}*& &&&
10662        &*isip6&~{*&<&'string'&>&*}*&
10663 .cindex "IP address" "testing string format"
10664 .cindex "string" "testing for IP address"
10665 .cindex "&%isip%& expansion condition"
10666 .cindex "&%isip4%& expansion condition"
10667 .cindex "&%isip6%& expansion condition"
10668 The substring is first expanded, and then tested to see if it has the form of
10669 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10670 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10671
10672 For an IPv4 address, the test is for four dot-separated components, each of
10673 which consists of from one to three digits. For an IPv6 address, up to eight
10674 colon-separated components are permitted, each containing from one to four
10675 hexadecimal digits. There may be fewer than eight components if an empty
10676 component (adjacent colons) is present. Only one empty component is permitted.
10677
10678 &*Note*&: The checks are just on the form of the address; actual numerical
10679 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10680 check. The main use of these tests is to distinguish between IP addresses and
10681 host names, or between IPv4 and IPv6 addresses. For example, you could use
10682 .code
10683 ${if isip4{$sender_host_address}...
10684 .endd
10685 to test which IP version an incoming SMTP connection is using.
10686
10687 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10688 .cindex "LDAP" "use for authentication"
10689 .cindex "expansion" "LDAP authentication test"
10690 .cindex "&%ldapauth%& expansion condition"
10691 This condition supports user authentication using LDAP. See section
10692 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10693 queries. For this use, the query must contain a user name and password. The
10694 query itself is not used, and can be empty. The condition is true if the
10695 password is not empty, and the user name and password are accepted by the LDAP
10696 server. An empty password is rejected without calling LDAP because LDAP binds
10697 with an empty password are considered anonymous regardless of the username, and
10698 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10699 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10700 this can be used.
10701
10702
10703 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10704        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10705 .cindex "string" "comparison"
10706 .cindex "expansion" "string comparison"
10707 .cindex "&%le%& expansion condition"
10708 .cindex "&%lei%& expansion condition"
10709 The two substrings are first expanded. The condition is true if the first
10710 string is lexically less than or equal to the second string. For &%le%& the
10711 comparison includes the case of letters, whereas for &%lei%& the comparison is
10712 case-independent.
10713
10714 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10715        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10716 .cindex "string" "comparison"
10717 .cindex "expansion" "string comparison"
10718 .cindex "&%lt%& expansion condition"
10719 .cindex "&%lti%& expansion condition"
10720 The two substrings are first expanded. The condition is true if the first
10721 string is lexically less than the second string. For &%lt%& the comparison
10722 includes the case of letters, whereas for &%lti%& the comparison is
10723 case-independent.
10724
10725
10726 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10727 .cindex "expansion" "regular expression comparison"
10728 .cindex "regular expressions" "match in expanded string"
10729 .cindex "&%match%& expansion condition"
10730 The two substrings are first expanded. The second is then treated as a regular
10731 expression and applied to the first. Because of the pre-expansion, if the
10732 regular expression contains dollar, or backslash characters, they must be
10733 escaped. Care must also be taken if the regular expression contains braces
10734 (curly brackets). A closing brace must be escaped so that it is not taken as a
10735 premature termination of <&'string2'&>. The easiest approach is to use the
10736 &`\N`& feature to disable expansion of the regular expression.
10737 For example,
10738 .code
10739 ${if match {$local_part}{\N^\d{3}\N} ...
10740 .endd
10741 If the whole expansion string is in double quotes, further escaping of
10742 backslashes is also required.
10743
10744 The condition is true if the regular expression match succeeds.
10745 The regular expression is not required to begin with a circumflex
10746 metacharacter, but if there is no circumflex, the expression is not anchored,
10747 and it may match anywhere in the subject, not just at the start. If you want
10748 the pattern to match at the end of the subject, you must include the &`$`&
10749 metacharacter at an appropriate point.
10750
10751 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10752 At the start of an &%if%& expansion the values of the numeric variable
10753 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10754 succeeds causes them to be reset to the substrings of that condition and they
10755 will have these values during the expansion of the success string. At the end
10756 of the &%if%& expansion, the previous values are restored. After testing a
10757 combination of conditions using &%or%&, the subsequent values of the numeric
10758 variables are those of the condition that succeeded.
10759
10760 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10761 .cindex "&%match_address%& expansion condition"
10762 See &*match_local_part*&.
10763
10764 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10765 .cindex "&%match_domain%& expansion condition"
10766 See &*match_local_part*&.
10767
10768 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10769 .cindex "&%match_ip%& expansion condition"
10770 This condition matches an IP address to a list of IP address patterns. It must
10771 be followed by two argument strings. The first (after expansion) must be an IP
10772 address or an empty string. The second (not expanded) is a restricted host
10773 list that can match only an IP address, not a host name. For example:
10774 .code
10775 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10776 .endd
10777 The specific types of host list item that are permitted in the list are:
10778
10779 .ilist
10780 An IP address, optionally with a CIDR mask.
10781 .next
10782 A single asterisk, which matches any IP address.
10783 .next
10784 An empty item, which matches only if the IP address is empty. This could be
10785 useful for testing for a locally submitted message or one from specific hosts
10786 in a single test such as
10787 . ==== As this is a nested list, any displays it contains must be indented
10788 . ==== as otherwise they are too far to the left. This comment applies to
10789 . ==== the use of xmlto plus fop. There's no problem when formatting with
10790 . ==== sdop, with or without the extra indent.
10791 .code
10792   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10793 .endd
10794 where the first item in the list is the empty string.
10795 .next
10796 The item @[] matches any of the local host's interface addresses.
10797 .next
10798 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10799 even if &`net-`& is not specified. There is never any attempt to turn the IP
10800 address into a host name. The most common type of linear search for
10801 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10802 masks. For example:
10803 .code
10804   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10805 .endd
10806 It is of course possible to use other kinds of lookup, and in such a case, you
10807 do need to specify the &`net-`& prefix if you want to specify a specific
10808 address mask, for example:
10809 .code
10810   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10811 .endd
10812 However, unless you are combining a &%match_ip%& condition with others, it is
10813 just as easy to use the fact that a lookup is itself a condition, and write:
10814 .code
10815   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10816 .endd
10817 .endlist ilist
10818
10819 Note that <&'string2'&> is not itself subject to string expansion, unless
10820 Exim was built with the EXPAND_LISTMATCH_RHS option.
10821
10822 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10823
10824 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10825 .cindex "domain list" "in expansion condition"
10826 .cindex "address list" "in expansion condition"
10827 .cindex "local part" "list, in expansion condition"
10828 .cindex "&%match_local_part%& expansion condition"
10829 This condition, together with &%match_address%& and &%match_domain%&, make it
10830 possible to test domain, address, and local part lists within expansions. Each
10831 condition requires two arguments: an item and a list to match. A trivial
10832 example is:
10833 .code
10834 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10835 .endd
10836 In each case, the second argument may contain any of the allowable items for a
10837 list of the appropriate type. Also, because the second argument (after
10838 expansion) is a standard form of list, it is possible to refer to a named list.
10839 Thus, you can use conditions like this:
10840 .code
10841 ${if match_domain{$domain}{+local_domains}{...
10842 .endd
10843 .cindex "&`+caseful`&"
10844 For address lists, the matching starts off caselessly, but the &`+caseful`&
10845 item can be used, as in all address lists, to cause subsequent items to
10846 have their local parts matched casefully. Domains are always matched
10847 caselessly.
10848
10849 Note that <&'string2'&> is not itself subject to string expansion, unless
10850 Exim was built with the EXPAND_LISTMATCH_RHS option.
10851
10852 &*Note*&: Host lists are &'not'& supported in this way. This is because
10853 hosts have two identities: a name and an IP address, and it is not clear
10854 how to specify cleanly how such a test would work. However, IP addresses can be
10855 matched using &%match_ip%&.
10856
10857 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10858 .cindex "PAM authentication"
10859 .cindex "AUTH" "with PAM"
10860 .cindex "Solaris" "PAM support"
10861 .cindex "expansion" "PAM authentication test"
10862 .cindex "&%pam%& expansion condition"
10863 &'Pluggable Authentication Modules'&
10864 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10865 available in the latest releases of Solaris and in some GNU/Linux
10866 distributions. The Exim support, which is intended for use in conjunction with
10867 the SMTP AUTH command, is available only if Exim is compiled with
10868 .code
10869 SUPPORT_PAM=yes
10870 .endd
10871 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10872 in some releases of GNU/Linux &%-ldl%& is also needed.
10873
10874 The argument string is first expanded, and the result must be a
10875 colon-separated list of strings. Leading and trailing white space is ignored.
10876 The PAM module is initialized with the service name &"exim"& and the user name
10877 taken from the first item in the colon-separated data string (<&'string1'&>).
10878 The remaining items in the data string are passed over in response to requests
10879 from the authentication function. In the simple case there will only be one
10880 request, for a password, so the data consists of just two strings.
10881
10882 There can be problems if any of the strings are permitted to contain colon
10883 characters. In the usual way, these have to be doubled to avoid being taken as
10884 separators. If the data is being inserted from a variable, the &%sg%& expansion
10885 item can be used to double any existing colons. For example, the configuration
10886 of a LOGIN authenticator might contain this setting:
10887 .code
10888 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10889 .endd
10890 For a PLAIN authenticator you could use:
10891 .code
10892 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10893 .endd
10894 In some operating systems, PAM authentication can be done only from a process
10895 running as root. Since Exim is running as the Exim user when receiving
10896 messages, this means that PAM cannot be used directly in those systems.
10897 A patched version of the &'pam_unix'& module that comes with the
10898 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10899 The patched module allows one special uid/gid combination, in addition to root,
10900 to authenticate. If you build the patched module to allow the Exim user and
10901 group, PAM can then be used from an Exim authenticator.
10902
10903
10904 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10905 .cindex "&'pwcheck'& daemon"
10906 .cindex "Cyrus"
10907 .cindex "expansion" "&'pwcheck'& authentication test"
10908 .cindex "&%pwcheck%& expansion condition"
10909 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10910 This is one way of making it possible for passwords to be checked by a process
10911 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10912 deprecated. Its replacement is &'saslauthd'& (see below).
10913
10914 The pwcheck support is not included in Exim by default. You need to specify
10915 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10916 building Exim. For example:
10917 .code
10918 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10919 .endd
10920 You do not need to install the full Cyrus software suite in order to use
10921 the pwcheck daemon. You can compile and install just the daemon alone
10922 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10923 access to the &_/var/pwcheck_& directory.
10924
10925 The &%pwcheck%& condition takes one argument, which must be the user name and
10926 password, separated by a colon. For example, in a LOGIN authenticator
10927 configuration, you might have this:
10928 .code
10929 server_condition = ${if pwcheck{$auth1:$auth2}}
10930 .endd
10931 Again, for a PLAIN authenticator configuration, this would be:
10932 .code
10933 server_condition = ${if pwcheck{$auth2:$auth3}}
10934 .endd
10935 .vitem &*queue_running*&
10936 .cindex "queue runner" "detecting when delivering from"
10937 .cindex "expansion" "queue runner test"
10938 .cindex "&%queue_running%& expansion condition"
10939 This condition, which has no data, is true during delivery attempts that are
10940 initiated by queue runner processes, and false otherwise.
10941
10942
10943 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10944 .cindex "Radius"
10945 .cindex "expansion" "Radius authentication"
10946 .cindex "&%radius%& expansion condition"
10947 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10948 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10949 the Radius client configuration file in order to build Exim with Radius
10950 support.
10951
10952 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10953 library, using the original API. If you are using release 0.4.0 or later of
10954 this library, you need to set
10955 .code
10956 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10957 .endd
10958 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10959 &%libradius%& library that comes with FreeBSD. To do this, set
10960 .code
10961 RADIUS_LIB_TYPE=RADLIB
10962 .endd
10963 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10964 You may also have to supply a suitable setting in EXTRALIBS so that the
10965 Radius library can be found when Exim is linked.
10966
10967 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10968 Radius client library, which calls the Radius server. The condition is true if
10969 the authentication is successful. For example:
10970 .code
10971 server_condition = ${if radius{<arguments>}}
10972 .endd
10973
10974
10975 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10976         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10977 .cindex "&'saslauthd'& daemon"
10978 .cindex "Cyrus"
10979 .cindex "expansion" "&'saslauthd'& authentication test"
10980 .cindex "&%saslauthd%& expansion condition"
10981 This condition supports user authentication using the Cyrus &'saslauthd'&
10982 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10983 Using this daemon is one way of making it possible for passwords to be checked
10984 by a process that is not running as root.
10985
10986 The saslauthd support is not included in Exim by default. You need to specify
10987 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10988 building Exim. For example:
10989 .code
10990 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10991 .endd
10992 You do not need to install the full Cyrus software suite in order to use
10993 the saslauthd daemon. You can compile and install just the daemon alone
10994 from the Cyrus SASL library.
10995
10996 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10997 two are mandatory. For example:
10998 .code
10999 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11000 .endd
11001 The service and the realm are optional (which is why the arguments are enclosed
11002 in their own set of braces). For details of the meaning of the service and
11003 realm, and how to run the daemon, consult the Cyrus documentation.
11004 .endlist vlist
11005
11006
11007
11008 .section "Combining expansion conditions" "SECID84"
11009 .cindex "expansion" "combining conditions"
11010 Several conditions can be tested at once by combining them using the &%and%&
11011 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11012 conditions on their own, and precede their lists of sub-conditions. Each
11013 sub-condition must be enclosed in braces within the overall braces that contain
11014 the list. No repetition of &%if%& is used.
11015
11016
11017 .vlist
11018 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11019 .cindex "&""or""& expansion condition"
11020 .cindex "expansion" "&""or""& of conditions"
11021 The sub-conditions are evaluated from left to right. The condition is true if
11022 any one of the sub-conditions is true.
11023 For example,
11024 .code
11025 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11026 .endd
11027 When a true sub-condition is found, the following ones are parsed but not
11028 evaluated. If there are several &"match"& sub-conditions the values of the
11029 numeric variables afterwards are taken from the first one that succeeds.
11030
11031 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11032 .cindex "&""and""& expansion condition"
11033 .cindex "expansion" "&""and""& of conditions"
11034 The sub-conditions are evaluated from left to right. The condition is true if
11035 all of the sub-conditions are true. If there are several &"match"&
11036 sub-conditions, the values of the numeric variables afterwards are taken from
11037 the last one. When a false sub-condition is found, the following ones are
11038 parsed but not evaluated.
11039 .endlist
11040 .ecindex IIDexpcond
11041
11042
11043
11044
11045 .section "Expansion variables" "SECTexpvar"
11046 .cindex "expansion" "variables, list of"
11047 This section contains an alphabetical list of all the expansion variables. Some
11048 of them are available only when Exim is compiled with specific options such as
11049 support for TLS or the content scanning extension.
11050
11051 .vlist
11052 .vitem "&$0$&, &$1$&, etc"
11053 .cindex "numerical variables (&$1$& &$2$& etc)"
11054 When a &%match%& expansion condition succeeds, these variables contain the
11055 captured substrings identified by the regular expression during subsequent
11056 processing of the success string of the containing &%if%& expansion item.
11057 However, they do not retain their values afterwards; in fact, their previous
11058 values are restored at the end of processing an &%if%& item. The numerical
11059 variables may also be set externally by some other matching process which
11060 precedes the expansion of the string. For example, the commands available in
11061 Exim filter files include an &%if%& command with its own regular expression
11062 matching condition.
11063
11064 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11065 Within an acl condition, expansion condition or expansion item
11066 any arguments are copied to these variables,
11067 any unused variables being made empty.
11068
11069 .vitem "&$acl_c...$&"
11070 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11071 can be given any name that starts with &$acl_c$& and is at least six characters
11072 long, but the sixth character must be either a digit or an underscore. For
11073 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11074 variables persist throughout the lifetime of an SMTP connection. They can be
11075 used to pass information between ACLs and between different invocations of the
11076 same ACL. When a message is received, the values of these variables are saved
11077 with the message, and can be accessed by filters, routers, and transports
11078 during subsequent delivery.
11079
11080 .vitem "&$acl_m...$&"
11081 These variables are like the &$acl_c...$& variables, except that their values
11082 are reset after a message has been received. Thus, if several messages are
11083 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11084 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11085 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11086 message is received, the values of these variables are saved with the message,
11087 and can be accessed by filters, routers, and transports during subsequent
11088 delivery.
11089
11090 .vitem &$acl_narg$&
11091 Within an acl condition, expansion condition or expansion item
11092 this variable has the number of arguments.
11093
11094 .vitem &$acl_verify_message$&
11095 .vindex "&$acl_verify_message$&"
11096 After an address verification has failed, this variable contains the failure
11097 message. It retains its value for use in subsequent modifiers. The message can
11098 be preserved by coding like this:
11099 .code
11100 warn !verify = sender
11101      set acl_m0 = $acl_verify_message
11102 .endd
11103 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11104 &%log_message%& modifiers, to include information about the verification
11105 failure.
11106
11107 .vitem &$address_data$&
11108 .vindex "&$address_data$&"
11109 This variable is set by means of the &%address_data%& option in routers. The
11110 value then remains with the address while it is processed by subsequent routers
11111 and eventually a transport. If the transport is handling multiple addresses,
11112 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11113 for more details. &*Note*&: The contents of &$address_data$& are visible in
11114 user filter files.
11115
11116 If &$address_data$& is set when the routers are called from an ACL to verify
11117 a recipient address, the final value is still in the variable for subsequent
11118 conditions and modifiers of the ACL statement. If routing the address caused it
11119 to be redirected to just one address, the child address is also routed as part
11120 of the verification, and in this case the final value of &$address_data$& is
11121 from the child's routing.
11122
11123 If &$address_data$& is set when the routers are called from an ACL to verify a
11124 sender address, the final value is also preserved, but this time in
11125 &$sender_address_data$&, to distinguish it from data from a recipient
11126 address.
11127
11128 In both cases (recipient and sender verification), the value does not persist
11129 after the end of the current ACL statement. If you want to preserve
11130 these values for longer, you can save them in ACL variables.
11131
11132 .vitem &$address_file$&
11133 .vindex "&$address_file$&"
11134 When, as a result of aliasing, forwarding, or filtering, a message is directed
11135 to a specific file, this variable holds the name of the file when the transport
11136 is running. At other times, the variable is empty. For example, using the
11137 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11138 .code
11139 /home/r2d2/savemail
11140 .endd
11141 then when the &(address_file)& transport is running, &$address_file$&
11142 contains the text string &`/home/r2d2/savemail`&.
11143 .cindex "Sieve filter" "value of &$address_file$&"
11144 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11145 then up to the transport configuration to generate an appropriate absolute path
11146 to the relevant file.
11147
11148 .vitem &$address_pipe$&
11149 .vindex "&$address_pipe$&"
11150 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11151 this variable holds the pipe command when the transport is running.
11152
11153 .vitem "&$auth1$& &-- &$auth3$&"
11154 .vindex "&$auth1$&, &$auth2$&, etc"
11155 These variables are used in SMTP authenticators (see chapters
11156 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11157
11158 .vitem &$authenticated_id$&
11159 .cindex "authentication" "id"
11160 .vindex "&$authenticated_id$&"
11161 When a server successfully authenticates a client it may be configured to
11162 preserve some of the authentication information in the variable
11163 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11164 user/password authenticator configuration might preserve the user name for use
11165 in the routers. Note that this is not the same information that is saved in
11166 &$sender_host_authenticated$&.
11167 When a message is submitted locally (that is, not over a TCP connection)
11168 the value of &$authenticated_id$& is normally the login name of the calling
11169 process. However, a trusted user can override this by means of the &%-oMai%&
11170 command line option.
11171
11172 .vitem &$authenticated_fail_id$&
11173 .cindex "authentication" "fail" "id"
11174 .vindex "&$authenticated_fail_id$&"
11175 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11176 will contain the failed authentication id. If more than one authentication
11177 id is attempted, it will contain only the last one. The variable is
11178 available for processing in the ACL's, generally the quit or notquit ACL.
11179 A message to a local recipient could still be accepted without requiring
11180 authentication, which means this variable could also be visible in all of
11181 the ACL's as well.
11182
11183
11184 .vitem &$authenticated_sender$&
11185 .cindex "sender" "authenticated"
11186 .cindex "authentication" "sender"
11187 .cindex "AUTH" "on MAIL command"
11188 .vindex "&$authenticated_sender$&"
11189 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11190 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11191 described in section &<<SECTauthparamail>>&. Unless the data is the string
11192 &"<>"&, it is set as the authenticated sender of the message, and the value is
11193 available during delivery in the &$authenticated_sender$& variable. If the
11194 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11195
11196 .vindex "&$qualify_domain$&"
11197 When a message is submitted locally (that is, not over a TCP connection), the
11198 value of &$authenticated_sender$& is an address constructed from the login
11199 name of the calling process and &$qualify_domain$&, except that a trusted user
11200 can override this by means of the &%-oMas%& command line option.
11201
11202
11203 .vitem &$authentication_failed$&
11204 .cindex "authentication" "failure"
11205 .vindex "&$authentication_failed$&"
11206 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11207 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11208 possible to distinguish between &"did not try to authenticate"&
11209 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11210 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11211 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11212 negative response to an AUTH command, including (for example) an attempt to use
11213 an undefined mechanism.
11214
11215 .vitem &$av_failed$&
11216 .cindex "content scanning" "AV scanner failure"
11217 This variable is available when Exim is compiled with the content-scanning
11218 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11219 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11220 the ACL malware condition.
11221
11222 .vitem &$body_linecount$&
11223 .cindex "message body" "line count"
11224 .cindex "body of message" "line count"
11225 .vindex "&$body_linecount$&"
11226 When a message is being received or delivered, this variable contains the
11227 number of lines in the message's body. See also &$message_linecount$&.
11228
11229 .vitem &$body_zerocount$&
11230 .cindex "message body" "binary zero count"
11231 .cindex "body of message" "binary zero count"
11232 .cindex "binary zero" "in message body"
11233 .vindex "&$body_zerocount$&"
11234 When a message is being received or delivered, this variable contains the
11235 number of binary zero bytes (ASCII NULs) in the message's body.
11236
11237 .vitem &$bounce_recipient$&
11238 .vindex "&$bounce_recipient$&"
11239 This is set to the recipient address of a bounce message while Exim is creating
11240 it. It is useful if a customized bounce message text file is in use (see
11241 chapter &<<CHAPemsgcust>>&).
11242
11243 .vitem &$bounce_return_size_limit$&
11244 .vindex "&$bounce_return_size_limit$&"
11245 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11246 up to a multiple of 1000. It is useful when a customized error message text
11247 file is in use (see chapter &<<CHAPemsgcust>>&).
11248
11249 .vitem &$caller_gid$&
11250 .cindex "gid (group id)" "caller"
11251 .vindex "&$caller_gid$&"
11252 The real group id under which the process that called Exim was running. This is
11253 not the same as the group id of the originator of a message (see
11254 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11255 incarnation normally contains the Exim gid.
11256
11257 .vitem &$caller_uid$&
11258 .cindex "uid (user id)" "caller"
11259 .vindex "&$caller_uid$&"
11260 The real user id under which the process that called Exim was running. This is
11261 not the same as the user id of the originator of a message (see
11262 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11263 incarnation normally contains the Exim uid.
11264
11265 .vitem &$compile_date$&
11266 .vindex "&$compile_date$&"
11267 The date on which the Exim binary was compiled.
11268
11269 .vitem &$compile_number$&
11270 .vindex "&$compile_number$&"
11271 The building process for Exim keeps a count of the number
11272 of times it has been compiled. This serves to distinguish different
11273 compilations of the same version of the program.
11274
11275 .vitem &$config_dir$&
11276 .vindex "&$config_dir$&"
11277 The directory name of the main configuration file. That is, the content of
11278 &$config_file$& with the last component stripped. The value does not
11279 contain the trailing slash. If &$config_file$& does not contain a slash,
11280 &$config_dir$& is ".".
11281
11282 .vitem &$config_file$&
11283 .vindex "&$config_file$&"
11284 The name of the main configuration file Exim is using.
11285
11286 .vitem &$demime_errorlevel$&
11287 .vindex "&$demime_errorlevel$&"
11288 This variable is available when Exim is compiled with
11289 the content-scanning extension and the obsolete &%demime%& condition. For
11290 details, see section &<<SECTdemimecond>>&.
11291
11292 .vitem &$demime_reason$&
11293 .vindex "&$demime_reason$&"
11294 This variable is available when Exim is compiled with the
11295 content-scanning extension and the obsolete &%demime%& condition. For details,
11296 see section &<<SECTdemimecond>>&.
11297
11298 .vitem &$dnslist_domain$& &&&
11299        &$dnslist_matched$& &&&
11300        &$dnslist_text$& &&&
11301        &$dnslist_value$&
11302 .vindex "&$dnslist_domain$&"
11303 .vindex "&$dnslist_matched$&"
11304 .vindex "&$dnslist_text$&"
11305 .vindex "&$dnslist_value$&"
11306 .cindex "black list (DNS)"
11307 When a DNS (black) list lookup succeeds, these variables are set to contain
11308 the following data from the lookup: the list's domain name, the key that was
11309 looked up, the contents of any associated TXT record, and the value from the
11310 main A record. See section &<<SECID204>>& for more details.
11311
11312 .vitem &$domain$&
11313 .vindex "&$domain$&"
11314 When an address is being routed, or delivered on its own, this variable
11315 contains the domain. Uppercase letters in the domain are converted into lower
11316 case for &$domain$&.
11317
11318 Global address rewriting happens when a message is received, so the value of
11319 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11320 is set during user filtering, but not during system filtering, because a
11321 message may have many recipients and the system filter is called just once.
11322
11323 When more than one address is being delivered at once (for example, several
11324 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11325 have the same domain. Transports can be restricted to handling only one domain
11326 at a time if the value of &$domain$& is required at transport time &-- this is
11327 the default for local transports. For further details of the environment in
11328 which local transports are run, see chapter &<<CHAPenvironment>>&.
11329
11330 .oindex "&%delay_warning_condition%&"
11331 At the end of a delivery, if all deferred addresses have the same domain, it is
11332 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11333
11334 The &$domain$& variable is also used in some other circumstances:
11335
11336 .ilist
11337 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11338 the recipient address. The domain of the &'sender'& address is in
11339 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11340 normally set during the running of the MAIL ACL. However, if the sender address
11341 is verified with a callout during the MAIL ACL, the sender domain is placed in
11342 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11343 the &(smtp)& transport.
11344
11345 .next
11346 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11347 &$domain$& contains the domain portion of the address that is being rewritten;
11348 it can be used in the expansion of the replacement address, for example, to
11349 rewrite domains by file lookup.
11350
11351 .next
11352 With one important exception, whenever a domain list is being scanned,
11353 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11354 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11355 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11356 that, in a RCPT ACL, the sender domain list can be dependent on the
11357 recipient domain (which is what is in &$domain$& at this time).
11358
11359 .next
11360 .cindex "ETRN" "value of &$domain$&"
11361 .oindex "&%smtp_etrn_command%&"
11362 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11363 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11364 .endlist
11365
11366
11367 .vitem &$domain_data$&
11368 .vindex "&$domain_data$&"
11369 When the &%domains%& option on a router matches a domain by
11370 means of a lookup, the data read by the lookup is available during the running
11371 of the router as &$domain_data$&. In addition, if the driver routes the
11372 address to a transport, the value is available in that transport. If the
11373 transport is handling multiple addresses, the value from the first address is
11374 used.
11375
11376 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11377 domain by means of a lookup. The data read by the lookup is available during
11378 the rest of the ACL statement. In all other situations, this variable expands
11379 to nothing.
11380
11381 .vitem &$exim_gid$&
11382 .vindex "&$exim_gid$&"
11383 This variable contains the numerical value of the Exim group id.
11384
11385 .vitem &$exim_path$&
11386 .vindex "&$exim_path$&"
11387 This variable contains the path to the Exim binary.
11388
11389 .vitem &$exim_uid$&
11390 .vindex "&$exim_uid$&"
11391 This variable contains the numerical value of the Exim user id.
11392
11393 .vitem &$exim_version$&
11394 .vindex "&$exim_uid$&"
11395 This variable contains the version string of the Exim build.
11396 The first character is a major version number, currently 4.
11397 Then after a dot, the next group of digits is a minor version number.
11398 There may be other characters following the minor version.
11399
11400 .vitem &$found_extension$&
11401 .vindex "&$found_extension$&"
11402 This variable is available when Exim is compiled with the
11403 content-scanning extension and the obsolete &%demime%& condition. For details,
11404 see section &<<SECTdemimecond>>&.
11405
11406 .vitem &$header_$&<&'name'&>
11407 This is not strictly an expansion variable. It is expansion syntax for
11408 inserting the message header line with the given name. Note that the name must
11409 be terminated by colon or white space, because it may contain a wide variety of
11410 characters. Note also that braces must &'not'& be used.
11411
11412 .vitem &$headers_added$&
11413 .vindex "&$headers_added$&"
11414 Within an ACL this variable contains the headers added so far by
11415 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11416 The headers are a newline-separated list.
11417
11418 .vitem &$home$&
11419 .vindex "&$home$&"
11420 When the &%check_local_user%& option is set for a router, the user's home
11421 directory is placed in &$home$& when the check succeeds. In particular, this
11422 means it is set during the running of users' filter files. A router may also
11423 explicitly set a home directory for use by a transport; this can be overridden
11424 by a setting on the transport itself.
11425
11426 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11427 of the environment variable HOME.
11428
11429 .vitem &$host$&
11430 .vindex "&$host$&"
11431 If a router assigns an address to a transport (any transport), and passes a
11432 list of hosts with the address, the value of &$host$& when the transport starts
11433 to run is the name of the first host on the list. Note that this applies both
11434 to local and remote transports.
11435
11436 .cindex "transport" "filter"
11437 .cindex "filter" "transport filter"
11438 For the &(smtp)& transport, if there is more than one host, the value of
11439 &$host$& changes as the transport works its way through the list. In
11440 particular, when the &(smtp)& transport is expanding its options for encryption
11441 using TLS, or for specifying a transport filter (see chapter
11442 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11443 is connected.
11444
11445 When used in the client part of an authenticator configuration (see chapter
11446 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11447 client is connected.
11448
11449
11450 .vitem &$host_address$&
11451 .vindex "&$host_address$&"
11452 This variable is set to the remote host's IP address whenever &$host$& is set
11453 for a remote connection. It is also set to the IP address that is being checked
11454 when the &%ignore_target_hosts%& option is being processed.
11455
11456 .vitem &$host_data$&
11457 .vindex "&$host_data$&"
11458 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11459 result of the lookup is made available in the &$host_data$& variable. This
11460 allows you, for example, to do things like this:
11461 .code
11462 deny  hosts = net-lsearch;/some/file
11463 message = $host_data
11464 .endd
11465 .vitem &$host_lookup_deferred$&
11466 .cindex "host name" "lookup, failure of"
11467 .vindex "&$host_lookup_deferred$&"
11468 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11469 message comes from a remote host and there is an attempt to look up the host's
11470 name from its IP address, and the attempt is not successful, one of these
11471 variables is set to &"1"&.
11472
11473 .ilist
11474 If the lookup receives a definite negative response (for example, a DNS lookup
11475 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11476
11477 .next
11478 If there is any kind of problem during the lookup, such that Exim cannot
11479 tell whether or not the host name is defined (for example, a timeout for a DNS
11480 lookup), &$host_lookup_deferred$& is set to &"1"&.
11481 .endlist ilist
11482
11483 Looking up a host's name from its IP address consists of more than just a
11484 single reverse lookup. Exim checks that a forward lookup of at least one of the
11485 names it receives from a reverse lookup yields the original IP address. If this
11486 is not the case, Exim does not accept the looked up name(s), and
11487 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11488 IP address (for example, the existence of a PTR record in the DNS) is not
11489 sufficient on its own for the success of a host name lookup. If the reverse
11490 lookup succeeds, but there is a lookup problem such as a timeout when checking
11491 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11492 &"1"&. See also &$sender_host_name$&.
11493
11494 .vitem &$host_lookup_failed$&
11495 .vindex "&$host_lookup_failed$&"
11496 See &$host_lookup_deferred$&.
11497
11498 .vitem &$host_port$&
11499 .vindex "&$host_port$&"
11500 This variable is set to the remote host's TCP port whenever &$host$& is set
11501 for an outbound connection.
11502
11503
11504 .vitem &$inode$&
11505 .vindex "&$inode$&"
11506 The only time this variable is set is while expanding the &%directory_file%&
11507 option in the &(appendfile)& transport. The variable contains the inode number
11508 of the temporary file which is about to be renamed. It can be used to construct
11509 a unique name for the file.
11510
11511 .vitem &$interface_address$&
11512 .vindex "&$interface_address$&"
11513 This is an obsolete name for &$received_ip_address$&.
11514
11515 .vitem &$interface_port$&
11516 .vindex "&$interface_port$&"
11517 This is an obsolete name for &$received_port$&.
11518
11519 .vitem &$item$&
11520 .vindex "&$item$&"
11521 This variable is used during the expansion of &*forall*& and &*forany*&
11522 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11523 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11524 empty.
11525
11526 .vitem &$ldap_dn$&
11527 .vindex "&$ldap_dn$&"
11528 This variable, which is available only when Exim is compiled with LDAP support,
11529 contains the DN from the last entry in the most recently successful LDAP
11530 lookup.
11531
11532 .vitem &$load_average$&
11533 .vindex "&$load_average$&"
11534 This variable contains the system load average, multiplied by 1000 so that it
11535 is an integer. For example, if the load average is 0.21, the value of the
11536 variable is 210. The value is recomputed every time the variable is referenced.
11537
11538 .vitem &$local_part$&
11539 .vindex "&$local_part$&"
11540 When an address is being routed, or delivered on its own, this
11541 variable contains the local part. When a number of addresses are being
11542 delivered together (for example, multiple RCPT commands in an SMTP
11543 session), &$local_part$& is not set.
11544
11545 Global address rewriting happens when a message is received, so the value of
11546 &$local_part$& during routing and delivery is the value after rewriting.
11547 &$local_part$& is set during user filtering, but not during system filtering,
11548 because a message may have many recipients and the system filter is called just
11549 once.
11550
11551 .vindex "&$local_part_prefix$&"
11552 .vindex "&$local_part_suffix$&"
11553 If a local part prefix or suffix has been recognized, it is not included in the
11554 value of &$local_part$& during routing and subsequent delivery. The values of
11555 any prefix or suffix are in &$local_part_prefix$& and
11556 &$local_part_suffix$&, respectively.
11557
11558 When a message is being delivered to a file, pipe, or autoreply transport as a
11559 result of aliasing or forwarding, &$local_part$& is set to the local part of
11560 the parent address, not to the file name or command (see &$address_file$& and
11561 &$address_pipe$&).
11562
11563 When an ACL is running for a RCPT command, &$local_part$& contains the
11564 local part of the recipient address.
11565
11566 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11567 &$local_part$& contains the local part of the address that is being rewritten;
11568 it can be used in the expansion of the replacement address, for example.
11569
11570 In all cases, all quoting is removed from the local part. For example, for both
11571 the addresses
11572 .code
11573 "abc:xyz"@test.example
11574 abc\:xyz@test.example
11575 .endd
11576 the value of &$local_part$& is
11577 .code
11578 abc:xyz
11579 .endd
11580 If you use &$local_part$& to create another address, you should always wrap it
11581 inside a quoting operator. For example, in a &(redirect)& router you could
11582 have:
11583 .code
11584 data = ${quote_local_part:$local_part}@new.domain.example
11585 .endd
11586 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11587 to process local parts in a case-dependent manner in a router, you can set the
11588 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11589
11590 .vitem &$local_part_data$&
11591 .vindex "&$local_part_data$&"
11592 When the &%local_parts%& option on a router matches a local part by means of a
11593 lookup, the data read by the lookup is available during the running of the
11594 router as &$local_part_data$&. In addition, if the driver routes the address
11595 to a transport, the value is available in that transport. If the transport is
11596 handling multiple addresses, the value from the first address is used.
11597
11598 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11599 matches a local part by means of a lookup. The data read by the lookup is
11600 available during the rest of the ACL statement. In all other situations, this
11601 variable expands to nothing.
11602
11603 .vitem &$local_part_prefix$&
11604 .vindex "&$local_part_prefix$&"
11605 When an address is being routed or delivered, and a
11606 specific prefix for the local part was recognized, it is available in this
11607 variable, having been removed from &$local_part$&.
11608
11609 .vitem &$local_part_suffix$&
11610 .vindex "&$local_part_suffix$&"
11611 When an address is being routed or delivered, and a
11612 specific suffix for the local part was recognized, it is available in this
11613 variable, having been removed from &$local_part$&.
11614
11615 .vitem &$local_scan_data$&
11616 .vindex "&$local_scan_data$&"
11617 This variable contains the text returned by the &[local_scan()]& function when
11618 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11619
11620 .vitem &$local_user_gid$&
11621 .vindex "&$local_user_gid$&"
11622 See &$local_user_uid$&.
11623
11624 .vitem &$local_user_uid$&
11625 .vindex "&$local_user_uid$&"
11626 This variable and &$local_user_gid$& are set to the uid and gid after the
11627 &%check_local_user%& router precondition succeeds. This means that their values
11628 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11629 and &%condition%&), for the &%address_data%& expansion, and for any
11630 router-specific expansions. At all other times, the values in these variables
11631 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11632
11633 .vitem &$localhost_number$&
11634 .vindex "&$localhost_number$&"
11635 This contains the expanded value of the
11636 &%localhost_number%& option. The expansion happens after the main options have
11637 been read.
11638
11639 .vitem &$log_inodes$&
11640 .vindex "&$log_inodes$&"
11641 The number of free inodes in the disk partition where Exim's
11642 log files are being written. The value is recalculated whenever the variable is
11643 referenced. If the relevant file system does not have the concept of inodes,
11644 the value of is -1. See also the &%check_log_inodes%& option.
11645
11646 .vitem &$log_space$&
11647 .vindex "&$log_space$&"
11648 The amount of free space (as a number of kilobytes) in the disk
11649 partition where Exim's log files are being written. The value is recalculated
11650 whenever the variable is referenced. If the operating system does not have the
11651 ability to find the amount of free space (only true for experimental systems),
11652 the space value is -1. See also the &%check_log_space%& option.
11653
11654
11655 .vitem &$lookup_dnssec_authenticated$&
11656 .vindex "&$lookup_dnssec_authenticated$&"
11657 This variable is set after a DNS lookup done by
11658 a dnsdb lookup expansion, dnslookup router or smtp transport.
11659 It will be empty if &(DNSSEC)& was not requested,
11660 &"no"& if the result was not labelled as authenticated data
11661 and &"yes"& if it was.
11662
11663 .vitem &$mailstore_basename$&
11664 .vindex "&$mailstore_basename$&"
11665 This variable is set only when doing deliveries in &"mailstore"& format in the
11666 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11667 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11668 contains the basename of the files that are being written, that is, the name
11669 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11670 variable is empty.
11671
11672 .vitem &$malware_name$&
11673 .vindex "&$malware_name$&"
11674 This variable is available when Exim is compiled with the
11675 content-scanning extension. It is set to the name of the virus that was found
11676 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11677
11678 .vitem &$max_received_linelength$&
11679 .vindex "&$max_received_linelength$&"
11680 .cindex "maximum" "line length"
11681 .cindex "line length" "maximum"
11682 This variable contains the number of bytes in the longest line that was
11683 received as part of the message, not counting the line termination
11684 character(s).
11685
11686 .vitem &$message_age$&
11687 .cindex "message" "age of"
11688 .vindex "&$message_age$&"
11689 This variable is set at the start of a delivery attempt to contain the number
11690 of seconds since the message was received. It does not change during a single
11691 delivery attempt.
11692
11693 .vitem &$message_body$&
11694 .cindex "body of message" "expansion variable"
11695 .cindex "message body" "in expansion"
11696 .cindex "binary zero" "in message body"
11697 .vindex "&$message_body$&"
11698 .oindex "&%message_body_visible%&"
11699 This variable contains the initial portion of a message's body while it is
11700 being delivered, and is intended mainly for use in filter files. The maximum
11701 number of characters of the body that are put into the variable is set by the
11702 &%message_body_visible%& configuration option; the default is 500.
11703
11704 .oindex "&%message_body_newlines%&"
11705 By default, newlines are converted into spaces in &$message_body$&, to make it
11706 easier to search for phrases that might be split over a line break. However,
11707 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11708 zeros are always converted into spaces.
11709
11710 .vitem &$message_body_end$&
11711 .cindex "body of message" "expansion variable"
11712 .cindex "message body" "in expansion"
11713 .vindex "&$message_body_end$&"
11714 This variable contains the final portion of a message's
11715 body while it is being delivered. The format and maximum size are as for
11716 &$message_body$&.
11717
11718 .vitem &$message_body_size$&
11719 .cindex "body of message" "size"
11720 .cindex "message body" "size"
11721 .vindex "&$message_body_size$&"
11722 When a message is being delivered, this variable contains the size of the body
11723 in bytes. The count starts from the character after the blank line that
11724 separates the body from the header. Newlines are included in the count. See
11725 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11726
11727 .vitem &$message_exim_id$&
11728 .vindex "&$message_exim_id$&"
11729 When a message is being received or delivered, this variable contains the
11730 unique message id that is generated and used by Exim to identify the message.
11731 An id is not created for a message until after its header has been successfully
11732 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11733 line; it is the local id that Exim assigns to the message, for example:
11734 &`1BXTIK-0001yO-VA`&.
11735
11736 .vitem &$message_headers$&
11737 .vindex &$message_headers$&
11738 This variable contains a concatenation of all the header lines when a message
11739 is being processed, except for lines added by routers or transports. The header
11740 lines are separated by newline characters. Their contents are decoded in the
11741 same way as a header line that is inserted by &%bheader%&.
11742
11743 .vitem &$message_headers_raw$&
11744 .vindex &$message_headers_raw$&
11745 This variable is like &$message_headers$& except that no processing of the
11746 contents of header lines is done.
11747
11748 .vitem &$message_id$&
11749 This is an old name for &$message_exim_id$&. It is now deprecated.
11750
11751 .vitem &$message_linecount$&
11752 .vindex "&$message_linecount$&"
11753 This variable contains the total number of lines in the header and body of the
11754 message. Compare &$body_linecount$&, which is the count for the body only.
11755 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11756 number of lines received. Before delivery happens (that is, before filters,
11757 routers, and transports run) the count is increased to include the
11758 &'Received:'& header line that Exim standardly adds, and also any other header
11759 lines that are added by ACLs. The blank line that separates the message header
11760 from the body is not counted.
11761
11762 As with the special case of &$message_size$&, during the expansion of the
11763 appendfile transport's maildir_tag option in maildir format, the value of
11764 &$message_linecount$& is the precise size of the number of newlines in the
11765 file that has been written (minus one for the blank line between the
11766 header and the body).
11767
11768 Here is an example of the use of this variable in a DATA ACL:
11769 .code
11770 deny message   = Too many lines in message header
11771      condition = \
11772       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11773 .endd
11774 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11775 message has not yet been received.
11776
11777 .vitem &$message_size$&
11778 .cindex "size" "of message"
11779 .cindex "message" "size"
11780 .vindex "&$message_size$&"
11781 When a message is being processed, this variable contains its size in bytes. In
11782 most cases, the size includes those headers that were received with the
11783 message, but not those (such as &'Envelope-to:'&) that are added to individual
11784 deliveries as they are written. However, there is one special case: during the
11785 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11786 doing a delivery in maildir format, the value of &$message_size$& is the
11787 precise size of the file that has been written. See also
11788 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11789
11790 .cindex "RCPT" "value of &$message_size$&"
11791 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11792 contains the size supplied on the MAIL command, or -1 if no size was given. The
11793 value may not, of course, be truthful.
11794
11795 .vitem &$mime_$&&'xxx'&
11796 A number of variables whose names start with &$mime$& are
11797 available when Exim is compiled with the content-scanning extension. For
11798 details, see section &<<SECTscanmimepart>>&.
11799
11800 .vitem "&$n0$& &-- &$n9$&"
11801 These variables are counters that can be incremented by means
11802 of the &%add%& command in filter files.
11803
11804 .vitem &$original_domain$&
11805 .vindex "&$domain$&"
11806 .vindex "&$original_domain$&"
11807 When a top-level address is being processed for delivery, this contains the
11808 same value as &$domain$&. However, if a &"child"& address (for example,
11809 generated by an alias, forward, or filter file) is being processed, this
11810 variable contains the domain of the original address (lower cased). This
11811 differs from &$parent_domain$& only when there is more than one level of
11812 aliasing or forwarding. When more than one address is being delivered in a
11813 single transport run, &$original_domain$& is not set.
11814
11815 If a new address is created by means of a &%deliver%& command in a system
11816 filter, it is set up with an artificial &"parent"& address. This has the local
11817 part &'system-filter'& and the default qualify domain.
11818
11819 .vitem &$original_local_part$&
11820 .vindex "&$local_part$&"
11821 .vindex "&$original_local_part$&"
11822 When a top-level address is being processed for delivery, this contains the
11823 same value as &$local_part$&, unless a prefix or suffix was removed from the
11824 local part, because &$original_local_part$& always contains the full local
11825 part. When a &"child"& address (for example, generated by an alias, forward, or
11826 filter file) is being processed, this variable contains the full local part of
11827 the original address.
11828
11829 If the router that did the redirection processed the local part
11830 case-insensitively, the value in &$original_local_part$& is in lower case.
11831 This variable differs from &$parent_local_part$& only when there is more than
11832 one level of aliasing or forwarding. When more than one address is being
11833 delivered in a single transport run, &$original_local_part$& is not set.
11834
11835 If a new address is created by means of a &%deliver%& command in a system
11836 filter, it is set up with an artificial &"parent"& address. This has the local
11837 part &'system-filter'& and the default qualify domain.
11838
11839 .vitem &$originator_gid$&
11840 .cindex "gid (group id)" "of originating user"
11841 .cindex "sender" "gid"
11842 .vindex "&$caller_gid$&"
11843 .vindex "&$originator_gid$&"
11844 This variable contains the value of &$caller_gid$& that was set when the
11845 message was received. For messages received via the command line, this is the
11846 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11847 normally the gid of the Exim user.
11848
11849 .vitem &$originator_uid$&
11850 .cindex "uid (user id)" "of originating user"
11851 .cindex "sender" "uid"
11852 .vindex "&$caller_uid$&"
11853 .vindex "&$originaltor_uid$&"
11854 The value of &$caller_uid$& that was set when the message was received. For
11855 messages received via the command line, this is the uid of the sending user.
11856 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11857 user.
11858
11859 .vitem &$parent_domain$&
11860 .vindex "&$parent_domain$&"
11861 This variable is similar to &$original_domain$& (see
11862 above), except that it refers to the immediately preceding parent address.
11863
11864 .vitem &$parent_local_part$&
11865 .vindex "&$parent_local_part$&"
11866 This variable is similar to &$original_local_part$&
11867 (see above), except that it refers to the immediately preceding parent address.
11868
11869 .vitem &$pid$&
11870 .cindex "pid (process id)" "of current process"
11871 .vindex "&$pid$&"
11872 This variable contains the current process id.
11873
11874 .vitem &$pipe_addresses$&
11875 .cindex "filter" "transport filter"
11876 .cindex "transport" "filter"
11877 .vindex "&$pipe_addresses$&"
11878 This is not an expansion variable, but is mentioned here because the string
11879 &`$pipe_addresses`& is handled specially in the command specification for the
11880 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11881 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11882 It cannot be used in general expansion strings, and provokes an &"unknown
11883 variable"& error if encountered.
11884
11885 .vitem &$primary_hostname$&
11886 .vindex "&$primary_hostname$&"
11887 This variable contains the value set by &%primary_hostname%& in the
11888 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11889 a single-component name, Exim calls &[gethostbyname()]& (or
11890 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11891 qualified host name. See also &$smtp_active_hostname$&.
11892
11893
11894 .vitem &$prvscheck_address$&
11895 This variable is used in conjunction with the &%prvscheck%& expansion item,
11896 which is described in sections &<<SECTexpansionitems>>& and
11897 &<<SECTverifyPRVS>>&.
11898
11899 .vitem &$prvscheck_keynum$&
11900 This variable is used in conjunction with the &%prvscheck%& expansion item,
11901 which is described in sections &<<SECTexpansionitems>>& and
11902 &<<SECTverifyPRVS>>&.
11903
11904 .vitem &$prvscheck_result$&
11905 This variable is used in conjunction with the &%prvscheck%& expansion item,
11906 which is described in sections &<<SECTexpansionitems>>& and
11907 &<<SECTverifyPRVS>>&.
11908
11909 .vitem &$qualify_domain$&
11910 .vindex "&$qualify_domain$&"
11911 The value set for the &%qualify_domain%& option in the configuration file.
11912
11913 .vitem &$qualify_recipient$&
11914 .vindex "&$qualify_recipient$&"
11915 The value set for the &%qualify_recipient%& option in the configuration file,
11916 or if not set, the value of &$qualify_domain$&.
11917
11918 .vitem &$rcpt_count$&
11919 .vindex "&$rcpt_count$&"
11920 When a message is being received by SMTP, this variable contains the number of
11921 RCPT commands received for the current message. If this variable is used in a
11922 RCPT ACL, its value includes the current command.
11923
11924 .vitem &$rcpt_defer_count$&
11925 .vindex "&$rcpt_defer_count$&"
11926 .cindex "4&'xx'& responses" "count of"
11927 When a message is being received by SMTP, this variable contains the number of
11928 RCPT commands in the current message that have previously been rejected with a
11929 temporary (4&'xx'&) response.
11930
11931 .vitem &$rcpt_fail_count$&
11932 .vindex "&$rcpt_fail_count$&"
11933 When a message is being received by SMTP, this variable contains the number of
11934 RCPT commands in the current message that have previously been rejected with a
11935 permanent (5&'xx'&) response.
11936
11937 .vitem &$received_count$&
11938 .vindex "&$received_count$&"
11939 This variable contains the number of &'Received:'& header lines in the message,
11940 including the one added by Exim (so its value is always greater than zero). It
11941 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11942 delivering.
11943
11944 .vitem &$received_for$&
11945 .vindex "&$received_for$&"
11946 If there is only a single recipient address in an incoming message, this
11947 variable contains that address when the &'Received:'& header line is being
11948 built. The value is copied after recipient rewriting has happened, but before
11949 the &[local_scan()]& function is run.
11950
11951 .vitem &$received_ip_address$&
11952 .vindex "&$received_ip_address$&"
11953 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11954 variable is set to the address of the local IP interface, and &$received_port$&
11955 is set to the local port number. (The remote IP address and port are in
11956 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11957 the port value is -1 unless it has been set using the &%-oMi%& command line
11958 option.
11959
11960 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11961 could be used, for example, to make the file name for a TLS certificate depend
11962 on which interface and/or port is being used for the incoming connection. The
11963 values of &$received_ip_address$& and &$received_port$& are saved with any
11964 messages that are received, thus making these variables available at delivery
11965 time.
11966
11967 &*Note:*& There are no equivalent variables for outgoing connections, because
11968 the values are unknown (unless they are explicitly set by options of the
11969 &(smtp)& transport).
11970
11971 .vitem &$received_port$&
11972 .vindex "&$received_port$&"
11973 See &$received_ip_address$&.
11974
11975 .vitem &$received_protocol$&
11976 .vindex "&$received_protocol$&"
11977 When a message is being processed, this variable contains the name of the
11978 protocol by which it was received. Most of the names used by Exim are defined
11979 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11980 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11981 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11982 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11983 connection and the client was successfully authenticated.
11984
11985 Exim uses the protocol name &"smtps"& for the case when encryption is
11986 automatically set up on connection without the use of STARTTLS (see
11987 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11988 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11989 where the client initially uses EHLO, sets up an encrypted connection using
11990 STARTTLS, and then uses HELO afterwards.
11991
11992 The &%-oMr%& option provides a way of specifying a custom protocol name for
11993 messages that are injected locally by trusted callers. This is commonly used to
11994 identify messages that are being re-injected after some kind of scanning.
11995
11996 .vitem &$received_time$&
11997 .vindex "&$received_time$&"
11998 This variable contains the date and time when the current message was received,
11999 as a number of seconds since the start of the Unix epoch.
12000
12001 .vitem &$recipient_data$&
12002 .vindex "&$recipient_data$&"
12003 This variable is set after an indexing lookup success in an ACL &%recipients%&
12004 condition. It contains the data from the lookup, and the value remains set
12005 until the next &%recipients%& test. Thus, you can do things like this:
12006 .display
12007 &`require recipients  = cdb*@;/some/file`&
12008 &`deny    `&&'some further test involving'& &`$recipient_data`&
12009 .endd
12010 &*Warning*&: This variable is set only when a lookup is used as an indexing
12011 method in the address list, using the semicolon syntax as in the example above.
12012 The variable is not set for a lookup that is used as part of the string
12013 expansion that all such lists undergo before being interpreted.
12014
12015 .vitem &$recipient_verify_failure$&
12016 .vindex "&$recipient_verify_failure$&"
12017 In an ACL, when a recipient verification fails, this variable contains
12018 information about the failure. It is set to one of the following words:
12019
12020 .ilist
12021 &"qualify"&: The address was unqualified (no domain), and the message
12022 was neither local nor came from an exempted host.
12023
12024 .next
12025 &"route"&: Routing failed.
12026
12027 .next
12028 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12029 or before the MAIL command (that is, on initial connection, HELO, or
12030 MAIL).
12031
12032 .next
12033 &"recipient"&: The RCPT command in a callout was rejected.
12034 .next
12035
12036 &"postmaster"&: The postmaster check in a callout was rejected.
12037 .endlist
12038
12039 The main use of this variable is expected to be to distinguish between
12040 rejections of MAIL and rejections of RCPT.
12041
12042 .vitem &$recipients$&
12043 .vindex "&$recipients$&"
12044 This variable contains a list of envelope recipients for a message. A comma and
12045 a space separate the addresses in the replacement text. However, the variable
12046 is not generally available, to prevent exposure of Bcc recipients in
12047 unprivileged users' filter files. You can use &$recipients$& only in these
12048 cases:
12049
12050 .olist
12051 In a system filter file.
12052 .next
12053 In the ACLs associated with the DATA command and with non-SMTP messages, that
12054 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12055 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12056 &%acl_not_smtp_mime%&.
12057 .next
12058 From within a &[local_scan()]& function.
12059 .endlist
12060
12061
12062 .vitem &$recipients_count$&
12063 .vindex "&$recipients_count$&"
12064 When a message is being processed, this variable contains the number of
12065 envelope recipients that came with the message. Duplicates are not excluded
12066 from the count. While a message is being received over SMTP, the number
12067 increases for each accepted recipient. It can be referenced in an ACL.
12068
12069
12070 .vitem &$regex_match_string$&
12071 .vindex "&$regex_match_string$&"
12072 This variable is set to contain the matching regular expression after a
12073 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12074
12075
12076 .vitem &$reply_address$&
12077 .vindex "&$reply_address$&"
12078 When a message is being processed, this variable contains the contents of the
12079 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12080 contents of the &'From:'& header line. Apart from the removal of leading
12081 white space, the value is not processed in any way. In particular, no RFC 2047
12082 decoding or character code translation takes place.
12083
12084 .vitem &$return_path$&
12085 .vindex "&$return_path$&"
12086 When a message is being delivered, this variable contains the return path &--
12087 the sender field that will be sent as part of the envelope. It is not enclosed
12088 in <> characters. At the start of routing an address, &$return_path$& has the
12089 same value as &$sender_address$&, but if, for example, an incoming message to a
12090 mailing list has been expanded by a router which specifies a different address
12091 for bounce messages, &$return_path$& subsequently contains the new bounce
12092 address, whereas &$sender_address$& always contains the original sender address
12093 that was received with the message. In other words, &$sender_address$& contains
12094 the incoming envelope sender, and &$return_path$& contains the outgoing
12095 envelope sender.
12096
12097 .vitem &$return_size_limit$&
12098 .vindex "&$return_size_limit$&"
12099 This is an obsolete name for &$bounce_return_size_limit$&.
12100
12101 .vitem &$router_name$&
12102 .cindex "router" "name"
12103 .cindex "name" "of router"
12104 .vindex "&$router_name$&"
12105 During the running of a router this variable contains its name.
12106
12107 .vitem &$runrc$&
12108 .cindex "return code" "from &%run%& expansion"
12109 .vindex "&$runrc$&"
12110 This variable contains the return code from a command that is run by the
12111 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12112 assume the order in which option values are expanded, except for those
12113 preconditions whose order of testing is documented. Therefore, you cannot
12114 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12115 another.
12116
12117 .vitem &$self_hostname$&
12118 .oindex "&%self%&" "value of host name"
12119 .vindex "&$self_hostname$&"
12120 When an address is routed to a supposedly remote host that turns out to be the
12121 local host, what happens is controlled by the &%self%& generic router option.
12122 One of its values causes the address to be passed to another router. When this
12123 happens, &$self_hostname$& is set to the name of the local host that the
12124 original router encountered. In other circumstances its contents are null.
12125
12126 .vitem &$sender_address$&
12127 .vindex "&$sender_address$&"
12128 When a message is being processed, this variable contains the sender's address
12129 that was received in the message's envelope. The case of letters in the address
12130 is retained, in both the local part and the domain. For bounce messages, the
12131 value of this variable is the empty string. See also &$return_path$&.
12132
12133 .vitem &$sender_address_data$&
12134 .vindex "&$address_data$&"
12135 .vindex "&$sender_address_data$&"
12136 If &$address_data$& is set when the routers are called from an ACL to verify a
12137 sender address, the final value is preserved in &$sender_address_data$&, to
12138 distinguish it from data from a recipient address. The value does not persist
12139 after the end of the current ACL statement. If you want to preserve it for
12140 longer, you can save it in an ACL variable.
12141
12142 .vitem &$sender_address_domain$&
12143 .vindex "&$sender_address_domain$&"
12144 The domain portion of &$sender_address$&.
12145
12146 .vitem &$sender_address_local_part$&
12147 .vindex "&$sender_address_local_part$&"
12148 The local part portion of &$sender_address$&.
12149
12150 .vitem &$sender_data$&
12151 .vindex "&$sender_data$&"
12152 This variable is set after a lookup success in an ACL &%senders%& condition or
12153 in a router &%senders%& option. It contains the data from the lookup, and the
12154 value remains set until the next &%senders%& test. Thus, you can do things like
12155 this:
12156 .display
12157 &`require senders      = cdb*@;/some/file`&
12158 &`deny    `&&'some further test involving'& &`$sender_data`&
12159 .endd
12160 &*Warning*&: This variable is set only when a lookup is used as an indexing
12161 method in the address list, using the semicolon syntax as in the example above.
12162 The variable is not set for a lookup that is used as part of the string
12163 expansion that all such lists undergo before being interpreted.
12164
12165 .vitem &$sender_fullhost$&
12166 .vindex "&$sender_fullhost$&"
12167 When a message is received from a remote host, this variable contains the host
12168 name and IP address in a single string. It ends with the IP address in square
12169 brackets, followed by a colon and a port number if the logging of ports is
12170 enabled. The format of the rest of the string depends on whether the host
12171 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12172 looking up its IP address. (Looking up the IP address can be forced by the
12173 &%host_lookup%& option, independent of verification.) A plain host name at the
12174 start of the string is a verified host name; if this is not present,
12175 verification either failed or was not requested. A host name in parentheses is
12176 the argument of a HELO or EHLO command. This is omitted if it is identical to
12177 the verified host name or to the host's IP address in square brackets.
12178
12179 .vitem &$sender_helo_name$&
12180 .vindex "&$sender_helo_name$&"
12181 When a message is received from a remote host that has issued a HELO or EHLO
12182 command, the argument of that command is placed in this variable. It is also
12183 set if HELO or EHLO is used when a message is received using SMTP locally via
12184 the &%-bs%& or &%-bS%& options.
12185
12186 .vitem &$sender_host_address$&
12187 .vindex "&$sender_host_address$&"
12188 When a message is received from a remote host using SMTP,
12189 this variable contains that
12190 host's IP address. For locally non-SMTP submitted messages, it is empty.
12191
12192 .vitem &$sender_host_authenticated$&
12193 .vindex "&$sender_host_authenticated$&"
12194 This variable contains the name (not the public name) of the authenticator
12195 driver that successfully authenticated the client from which the message was
12196 received. It is empty if there was no successful authentication. See also
12197 &$authenticated_id$&.
12198
12199 .vitem &$sender_host_dnssec$&
12200 .vindex "&$sender_host_dnssec$&"
12201 If an attempt to populate &$sender_host_name$& has been made
12202 (by reference, &%hosts_lookup%& or
12203 otherwise) then this boolean will have been set true if, and only if, the
12204 resolver library states that the reverse DNS was authenticated data.  At all
12205 other times, this variable is false.
12206
12207 It is likely that you will need to coerce DNSSEC support on in the resolver
12208 library, by setting:
12209 .code
12210 dns_dnssec_ok = 1
12211 .endd
12212
12213 Exim does not perform DNSSEC validation itself, instead leaving that to a
12214 validating resolver (eg, unbound, or bind with suitable configuration).
12215
12216 Exim does not (currently) check to see if the forward DNS was also secured
12217 with DNSSEC, only the reverse DNS.
12218
12219 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12220 mechanism in the list, then this variable will be false.
12221
12222
12223 .vitem &$sender_host_name$&
12224 .vindex "&$sender_host_name$&"
12225 When a message is received from a remote host, this variable contains the
12226 host's name as obtained by looking up its IP address. For messages received by
12227 other means, this variable is empty.
12228
12229 .vindex "&$host_lookup_failed$&"
12230 If the host name has not previously been looked up, a reference to
12231 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12232 A looked up name is accepted only if it leads back to the original IP address
12233 via a forward lookup. If either the reverse or the forward lookup fails to find
12234 any data, or if the forward lookup does not yield the original IP address,
12235 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12236
12237 .vindex "&$host_lookup_deferred$&"
12238 However, if either of the lookups cannot be completed (for example, there is a
12239 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12240 &$host_lookup_failed$& remains set to &"0"&.
12241
12242 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12243 host name again if there is a subsequent reference to &$sender_host_name$&
12244 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12245 is set to &"1"&.
12246
12247 Exim does not automatically look up every calling host's name. If you want
12248 maximum efficiency, you should arrange your configuration so that it avoids
12249 these lookups altogether. The lookup happens only if one or more of the
12250 following are true:
12251
12252 .ilist
12253 A string containing &$sender_host_name$& is expanded.
12254 .next
12255 The calling host matches the list in &%host_lookup%&. In the default
12256 configuration, this option is set to *, so it must be changed if lookups are
12257 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12258 .next
12259 Exim needs the host name in order to test an item in a host list. The items
12260 that require this are described in sections &<<SECThoslispatnam>>& and
12261 &<<SECThoslispatnamsk>>&.
12262 .next
12263 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12264 In this case, the host name is required to compare with the name quoted in any
12265 EHLO or HELO commands that the client issues.
12266 .next
12267 The remote host issues a EHLO or HELO command that quotes one of the
12268 domains in &%helo_lookup_domains%&. The default value of this option is
12269 . ==== As this is a nested list, any displays it contains must be indented
12270 . ==== as otherwise they are too far to the left.
12271 .code
12272   helo_lookup_domains = @ : @[]
12273 .endd
12274 which causes a lookup if a remote host (incorrectly) gives the server's name or
12275 IP address in an EHLO or HELO command.
12276 .endlist
12277
12278
12279 .vitem &$sender_host_port$&
12280 .vindex "&$sender_host_port$&"
12281 When a message is received from a remote host, this variable contains the port
12282 number that was used on the remote host.
12283
12284 .vitem &$sender_ident$&
12285 .vindex "&$sender_ident$&"
12286 When a message is received from a remote host, this variable contains the
12287 identification received in response to an RFC 1413 request. When a message has
12288 been received locally, this variable contains the login name of the user that
12289 called Exim.
12290
12291 .vitem &$sender_rate_$&&'xxx'&
12292 A number of variables whose names begin &$sender_rate_$& are set as part of the
12293 &%ratelimit%& ACL condition. Details are given in section
12294 &<<SECTratelimiting>>&.
12295
12296 .vitem &$sender_rcvhost$&
12297 .cindex "DNS" "reverse lookup"
12298 .cindex "reverse DNS lookup"
12299 .vindex "&$sender_rcvhost$&"
12300 This is provided specifically for use in &'Received:'& headers. It starts with
12301 either the verified host name (as obtained from a reverse DNS lookup) or, if
12302 there is no verified host name, the IP address in square brackets. After that
12303 there may be text in parentheses. When the first item is a verified host name,
12304 the first thing in the parentheses is the IP address in square brackets,
12305 followed by a colon and a port number if port logging is enabled. When the
12306 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12307 the parentheses.
12308
12309 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12310 was used and its argument was not identical to the real host name or IP
12311 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12312 all three items are present in the parentheses, a newline and tab are inserted
12313 into the string, to improve the formatting of the &'Received:'& header.
12314
12315 .vitem &$sender_verify_failure$&
12316 .vindex "&$sender_verify_failure$&"
12317 In an ACL, when a sender verification fails, this variable contains information
12318 about the failure. The details are the same as for
12319 &$recipient_verify_failure$&.
12320
12321 .vitem &$sending_ip_address$&
12322 .vindex "&$sending_ip_address$&"
12323 This variable is set whenever an outgoing SMTP connection to another host has
12324 been set up. It contains the IP address of the local interface that is being
12325 used. This is useful if a host that has more than one IP address wants to take
12326 on different personalities depending on which one is being used. For incoming
12327 connections, see &$received_ip_address$&.
12328
12329 .vitem &$sending_port$&
12330 .vindex "&$sending_port$&"
12331 This variable is set whenever an outgoing SMTP connection to another host has
12332 been set up. It contains the local port that is being used. For incoming
12333 connections, see &$received_port$&.
12334
12335 .vitem &$smtp_active_hostname$&
12336 .vindex "&$smtp_active_hostname$&"
12337 During an incoming SMTP session, this variable contains the value of the active
12338 host name, as specified by the &%smtp_active_hostname%& option. The value of
12339 &$smtp_active_hostname$& is saved with any message that is received, so its
12340 value can be consulted during routing and delivery.
12341
12342 .vitem &$smtp_command$&
12343 .vindex "&$smtp_command$&"
12344 During the processing of an incoming SMTP command, this variable contains the
12345 entire command. This makes it possible to distinguish between HELO and EHLO in
12346 the HELO ACL, and also to distinguish between commands such as these:
12347 .code
12348 MAIL FROM:<>
12349 MAIL FROM: <>
12350 .endd
12351 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12352 command, the address in &$smtp_command$& is the original address before any
12353 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12354 the address after SMTP-time rewriting.
12355
12356 .vitem &$smtp_command_argument$&
12357 .cindex "SMTP" "command, argument for"
12358 .vindex "&$smtp_command_argument$&"
12359 While an ACL is running to check an SMTP command, this variable contains the
12360 argument, that is, the text that follows the command name, with leading white
12361 space removed. Following the introduction of &$smtp_command$&, this variable is
12362 somewhat redundant, but is retained for backwards compatibility.
12363
12364 .vitem &$smtp_count_at_connection_start$&
12365 .vindex "&$smtp_count_at_connection_start$&"
12366 This variable is set greater than zero only in processes spawned by the Exim
12367 daemon for handling incoming SMTP connections. The name is deliberately long,
12368 in order to emphasize what the contents are. When the daemon accepts a new
12369 connection, it increments this variable. A copy of the variable is passed to
12370 the child process that handles the connection, but its value is fixed, and
12371 never changes. It is only an approximation of how many incoming connections
12372 there actually are, because many other connections may come and go while a
12373 single connection is being processed. When a child process terminates, the
12374 daemon decrements its copy of the variable.
12375
12376 .vitem "&$sn0$& &-- &$sn9$&"
12377 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12378 that were current at the end of the system filter file. This allows a system
12379 filter file to set values that can be tested in users' filter files. For
12380 example, a system filter could set a value indicating how likely it is that a
12381 message is junk mail.
12382
12383 .vitem &$spam_$&&'xxx'&
12384 A number of variables whose names start with &$spam$& are available when Exim
12385 is compiled with the content-scanning extension. For details, see section
12386 &<<SECTscanspamass>>&.
12387
12388
12389 .vitem &$spool_directory$&
12390 .vindex "&$spool_directory$&"
12391 The name of Exim's spool directory.
12392
12393 .vitem &$spool_inodes$&
12394 .vindex "&$spool_inodes$&"
12395 The number of free inodes in the disk partition where Exim's spool files are
12396 being written. The value is recalculated whenever the variable is referenced.
12397 If the relevant file system does not have the concept of inodes, the value of
12398 is -1. See also the &%check_spool_inodes%& option.
12399
12400 .vitem &$spool_space$&
12401 .vindex "&$spool_space$&"
12402 The amount of free space (as a number of kilobytes) in the disk partition where
12403 Exim's spool files are being written. The value is recalculated whenever the
12404 variable is referenced. If the operating system does not have the ability to
12405 find the amount of free space (only true for experimental systems), the space
12406 value is -1. For example, to check in an ACL that there is at least 50
12407 megabytes free on the spool, you could write:
12408 .code
12409 condition = ${if > {$spool_space}{50000}}
12410 .endd
12411 See also the &%check_spool_space%& option.
12412
12413
12414 .vitem &$thisaddress$&
12415 .vindex "&$thisaddress$&"
12416 This variable is set only during the processing of the &%foranyaddress%&
12417 command in a filter file. Its use is explained in the description of that
12418 command, which can be found in the separate document entitled &'Exim's
12419 interfaces to mail filtering'&.
12420
12421 .vitem &$tls_in_bits$&
12422 .vindex "&$tls_in_bits$&"
12423 Contains an approximation of the TLS cipher's bit-strength
12424 on the inbound connection; the meaning of
12425 this depends upon the TLS implementation used.
12426 If TLS has not been negotiated, the value will be 0.
12427 The value of this is automatically fed into the Cyrus SASL authenticator
12428 when acting as a server, to specify the "external SSF" (a SASL term).
12429
12430 The deprecated &$tls_bits$& variable refers to the inbound side
12431 except when used in the context of an outbound SMTP delivery, when it refers to
12432 the outbound.
12433
12434 .vitem &$tls_out_bits$&
12435 .vindex "&$tls_out_bits$&"
12436 Contains an approximation of the TLS cipher's bit-strength
12437 on an outbound SMTP connection; the meaning of
12438 this depends upon the TLS implementation used.
12439 If TLS has not been negotiated, the value will be 0.
12440
12441 .vitem &$tls_in_ourcert$&
12442 .vindex "&$tls_in_ourcert$&"
12443 This variable refers to the certificate presented to the peer of an
12444 inbound connection when the message was received.
12445 It is only useful as the argument of a
12446 .new
12447 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12448 .wen
12449 or a &%def%& condition.
12450
12451 .vitem &$tls_in_peercert$&
12452 .vindex "&$tls_in_peercert$&"
12453 This variable refers to the certificate presented by the peer of an
12454 inbound connection when the message was received.
12455 It is only useful as the argument of a
12456 .new
12457 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12458 .wen
12459 or a &%def%& condition.
12460
12461 .vitem &$tls_out_ourcert$&
12462 .vindex "&$tls_out_ourcert$&"
12463 This variable refers to the certificate presented to the peer of an
12464 outbound connection.  It is only useful as the argument of a
12465 .new
12466 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12467 .wen
12468 or a &%def%& condition.
12469
12470 .vitem &$tls_out_peercert$&
12471 .vindex "&$tls_out_peercert$&"
12472 This variable refers to the certificate presented by the peer of an
12473 outbound connection.  It is only useful as the argument of a
12474 .new
12475 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12476 .wen
12477 or a &%def%& condition.
12478
12479 .vitem &$tls_in_certificate_verified$&
12480 .vindex "&$tls_in_certificate_verified$&"
12481 This variable is set to &"1"& if a TLS certificate was verified when the
12482 message was received, and &"0"& otherwise.
12483
12484 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12485 except when used in the context of an outbound SMTP delivery, when it refers to
12486 the outbound.
12487
12488 .vitem &$tls_out_certificate_verified$&
12489 .vindex "&$tls_out_certificate_verified$&"
12490 This variable is set to &"1"& if a TLS certificate was verified when an
12491 outbound SMTP connection was made,
12492 and &"0"& otherwise.
12493
12494 .vitem &$tls_in_cipher$&
12495 .vindex "&$tls_in_cipher$&"
12496 .vindex "&$tls_cipher$&"
12497 When a message is received from a remote host over an encrypted SMTP
12498 connection, this variable is set to the cipher suite that was negotiated, for
12499 example DES-CBC3-SHA. In other circumstances, in particular, for message
12500 received over unencrypted connections, the variable is empty. Testing
12501 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12502 non-encrypted connections during ACL processing.
12503
12504 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12505 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12506 becomes the same as &$tls_out_cipher$&.
12507
12508 .vitem &$tls_out_cipher$&
12509 .vindex "&$tls_out_cipher$&"
12510 This variable is
12511 cleared before any outgoing SMTP connection is made,
12512 and then set to the outgoing cipher suite if one is negotiated. See chapter
12513 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12514 details of the &(smtp)& transport.
12515
12516 .vitem &$tls_in_ocsp$&
12517 .vindex "&$tls_in_ocsp$&"
12518 When a message is received from a remote client connection
12519 the result of any OCSP request from the client is encoded in this variable:
12520 .code
12521 0 OCSP proof was not requested (default value)
12522 1 No response to request
12523 2 Response not verified
12524 3 Verification failed
12525 4 Verification succeeded
12526 .endd
12527
12528 .vitem &$tls_out_ocsp$&
12529 .vindex "&$tls_out_ocsp$&"
12530 When a message is sent to a remote host connection
12531 the result of any OCSP request made is encoded in this variable.
12532 See &$tls_in_ocsp$& for values.
12533
12534 .vitem &$tls_in_peerdn$&
12535 .vindex "&$tls_in_peerdn$&"
12536 .vindex "&$tls_peerdn$&"
12537 When a message is received from a remote host over an encrypted SMTP
12538 connection, and Exim is configured to request a certificate from the client,
12539 the value of the Distinguished Name of the certificate is made available in the
12540 &$tls_in_peerdn$& during subsequent processing.
12541
12542 The deprecated &$tls_peerdn$& variable refers to the inbound side
12543 except when used in the context of an outbound SMTP delivery, when it refers to
12544 the outbound.
12545
12546 .vitem &$tls_out_peerdn$&
12547 .vindex "&$tls_out_peerdn$&"
12548 When a message is being delivered to a remote host over an encrypted SMTP
12549 connection, and Exim is configured to request a certificate from the server,
12550 the value of the Distinguished Name of the certificate is made available in the
12551 &$tls_out_peerdn$& during subsequent processing.
12552
12553 .vitem &$tls_in_sni$&
12554 .vindex "&$tls_in_sni$&"
12555 .vindex "&$tls_sni$&"
12556 .cindex "TLS" "Server Name Indication"
12557 When a TLS session is being established, if the client sends the Server
12558 Name Indication extension, the value will be placed in this variable.
12559 If the variable appears in &%tls_certificate%& then this option and
12560 some others, described in &<<SECTtlssni>>&,
12561 will be re-expanded early in the TLS session, to permit
12562 a different certificate to be presented (and optionally a different key to be
12563 used) to the client, based upon the value of the SNI extension.
12564
12565 The deprecated &$tls_sni$& variable refers to the inbound side
12566 except when used in the context of an outbound SMTP delivery, when it refers to
12567 the outbound.
12568
12569 .vitem &$tls_out_sni$&
12570 .vindex "&$tls_out_sni$&"
12571 .cindex "TLS" "Server Name Indication"
12572 During outbound
12573 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12574 the transport.
12575
12576 .vitem &$tod_bsdinbox$&
12577 .vindex "&$tod_bsdinbox$&"
12578 The time of day and the date, in the format required for BSD-style mailbox
12579 files, for example: Thu Oct 17 17:14:09 1995.
12580
12581 .vitem &$tod_epoch$&
12582 .vindex "&$tod_epoch$&"
12583 The time and date as a number of seconds since the start of the Unix epoch.
12584
12585 .vitem &$tod_epoch_l$&
12586 .vindex "&$tod_epoch_l$&"
12587 The time and date as a number of microseconds since the start of the Unix epoch.
12588
12589 .vitem &$tod_full$&
12590 .vindex "&$tod_full$&"
12591 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12592 +0100. The timezone is always given as a numerical offset from UTC, with
12593 positive values used for timezones that are ahead (east) of UTC, and negative
12594 values for those that are behind (west).
12595
12596 .vitem &$tod_log$&
12597 .vindex "&$tod_log$&"
12598 The time and date in the format used for writing Exim's log files, for example:
12599 1995-10-12 15:32:29, but without a timezone.
12600
12601 .vitem &$tod_logfile$&
12602 .vindex "&$tod_logfile$&"
12603 This variable contains the date in the format yyyymmdd. This is the format that
12604 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12605 flag.
12606
12607 .vitem &$tod_zone$&
12608 .vindex "&$tod_zone$&"
12609 This variable contains the numerical value of the local timezone, for example:
12610 -0500.
12611
12612 .vitem &$tod_zulu$&
12613 .vindex "&$tod_zulu$&"
12614 This variable contains the UTC date and time in &"Zulu"& format, as specified
12615 by ISO 8601, for example: 20030221154023Z.
12616
12617 .vitem &$transport_name$&
12618 .cindex "transport" "name"
12619 .cindex "name" "of transport"
12620 .vindex "&$transport_name$&"
12621 During the running of a transport, this variable contains its name.
12622
12623 .vitem &$value$&
12624 .vindex "&$value$&"
12625 This variable contains the result of an expansion lookup, extraction operation,
12626 or external command, as described above. It is also used during a
12627 &*reduce*& expansion.
12628
12629 .vitem &$verify_mode$&
12630 .vindex "&$verify_mode$&"
12631 While a router or transport is being run in verify mode
12632 or for cutthrough delivery,
12633 contains "S" for sender-verification or "R" for recipient-verification.
12634 Otherwise, empty.
12635
12636 .vitem &$version_number$&
12637 .vindex "&$version_number$&"
12638 The version number of Exim.
12639
12640 .vitem &$warn_message_delay$&
12641 .vindex "&$warn_message_delay$&"
12642 This variable is set only during the creation of a message warning about a
12643 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12644
12645 .vitem &$warn_message_recipients$&
12646 .vindex "&$warn_message_recipients$&"
12647 This variable is set only during the creation of a message warning about a
12648 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12649 .endlist
12650 .ecindex IIDstrexp
12651
12652
12653
12654 . ////////////////////////////////////////////////////////////////////////////
12655 . ////////////////////////////////////////////////////////////////////////////
12656
12657 .chapter "Embedded Perl" "CHAPperl"
12658 .scindex IIDperl "Perl" "calling from Exim"
12659 Exim can be built to include an embedded Perl interpreter. When this is done,
12660 Perl subroutines can be called as part of the string expansion process. To make
12661 use of the Perl support, you need version 5.004 or later of Perl installed on
12662 your system. To include the embedded interpreter in the Exim binary, include
12663 the line
12664 .code
12665 EXIM_PERL = perl.o
12666 .endd
12667 in your &_Local/Makefile_& and then build Exim in the normal way.
12668
12669
12670 .section "Setting up so Perl can be used" "SECID85"
12671 .oindex "&%perl_startup%&"
12672 Access to Perl subroutines is via a global configuration option called
12673 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12674 no &%perl_startup%& option in the Exim configuration file then no Perl
12675 interpreter is started and there is almost no overhead for Exim (since none of
12676 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12677 option then the associated value is taken to be Perl code which is executed in
12678 a newly created Perl interpreter.
12679
12680 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12681 need backslashes before any characters to escape special meanings. The option
12682 should usually be something like
12683 .code
12684 perl_startup = do '/etc/exim.pl'
12685 .endd
12686 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12687 use from Exim. Exim can be configured either to start up a Perl interpreter as
12688 soon as it is entered, or to wait until the first time it is needed. Starting
12689 the interpreter at the beginning ensures that it is done while Exim still has
12690 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12691 fact used in a particular run. Also, note that this does not mean that Exim is
12692 necessarily running as root when Perl is called at a later time. By default,
12693 the interpreter is started only when it is needed, but this can be changed in
12694 two ways:
12695
12696 .ilist
12697 .oindex "&%perl_at_start%&"
12698 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12699 a startup when Exim is entered.
12700 .next
12701 The command line option &%-ps%& also requests a startup when Exim is entered,
12702 overriding the setting of &%perl_at_start%&.
12703 .endlist
12704
12705 There is also a command line option &%-pd%& (for delay) which suppresses the
12706 initial startup, even if &%perl_at_start%& is set.
12707
12708
12709 .section "Calling Perl subroutines" "SECID86"
12710 When the configuration file includes a &%perl_startup%& option you can make use
12711 of the string expansion item to call the Perl subroutines that are defined
12712 by the &%perl_startup%& code. The operator is used in any of the following
12713 forms:
12714 .code
12715 ${perl{foo}}
12716 ${perl{foo}{argument}}
12717 ${perl{foo}{argument1}{argument2} ... }
12718 .endd
12719 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12720 arguments may be passed. Passing more than this results in an expansion failure
12721 with an error message of the form
12722 .code
12723 Too many arguments passed to Perl subroutine "foo" (max is 8)
12724 .endd
12725 The return value of the Perl subroutine is evaluated in a scalar context before
12726 it is passed back to Exim to be inserted into the expanded string. If the
12727 return value is &'undef'&, the expansion is forced to fail in the same way as
12728 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12729 by obeying Perl's &%die%& function, the expansion fails with the error message
12730 that was passed to &%die%&.
12731
12732
12733 .section "Calling Exim functions from Perl" "SECID87"
12734 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12735 is available to call back into Exim's string expansion function. For example,
12736 the Perl code
12737 .code
12738 my $lp = Exim::expand_string('$local_part');
12739 .endd
12740 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12741 Note those are single quotes and not double quotes to protect against
12742 &$local_part$& being interpolated as a Perl variable.
12743
12744 If the string expansion is forced to fail by a &"fail"& item, the result of
12745 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12746 expansion string, the Perl call from the original expansion string fails with
12747 an appropriate error message, in the same way as if &%die%& were used.
12748
12749 .cindex "debugging" "from embedded Perl"
12750 .cindex "log" "writing from embedded Perl"
12751 Two other Exim functions are available for use from within Perl code.
12752 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12753 debugging is enabled. If you want a newline at the end, you must supply it.
12754 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12755 timestamp. In this case, you should not supply a terminating newline.
12756
12757
12758 .section "Use of standard output and error by Perl" "SECID88"
12759 .cindex "Perl" "standard output and error"
12760 You should not write to the standard error or output streams from within your
12761 Perl code, as it is not defined how these are set up. In versions of Exim
12762 before 4.50, it is possible for the standard output or error to refer to the
12763 SMTP connection during message reception via the daemon. Writing to this stream
12764 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12765 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12766 avoided, but the output is lost.
12767
12768 .cindex "Perl" "use of &%warn%&"
12769 The Perl &%warn%& statement writes to the standard error stream by default.
12770 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12771 you have no control. When Exim starts up the Perl interpreter, it arranges for
12772 output from the &%warn%& statement to be written to the Exim main log. You can
12773 change this by including appropriate Perl magic somewhere in your Perl code.
12774 For example, to discard &%warn%& output completely, you need this:
12775 .code
12776 $SIG{__WARN__} = sub { };
12777 .endd
12778 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12779 example, the code for the subroutine is empty, so it does nothing, but you can
12780 include any Perl code that you like. The text of the &%warn%& message is passed
12781 as the first subroutine argument.
12782 .ecindex IIDperl
12783
12784
12785 . ////////////////////////////////////////////////////////////////////////////
12786 . ////////////////////////////////////////////////////////////////////////////
12787
12788 .chapter "Starting the daemon and the use of network interfaces" &&&
12789          "CHAPinterfaces" &&&
12790          "Starting the daemon"
12791 .cindex "daemon" "starting"
12792 .cindex "interface" "listening"
12793 .cindex "network interface"
12794 .cindex "interface" "network"
12795 .cindex "IP address" "for listening"
12796 .cindex "daemon" "listening IP addresses"
12797 .cindex "TCP/IP" "setting listening interfaces"
12798 .cindex "TCP/IP" "setting listening ports"
12799 A host that is connected to a TCP/IP network may have one or more physical
12800 hardware network interfaces. Each of these interfaces may be configured as one
12801 or more &"logical"& interfaces, which are the entities that a program actually
12802 works with. Each of these logical interfaces is associated with an IP address.
12803 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12804 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12805 knowledge about the host's interfaces for use in three different circumstances:
12806
12807 .olist
12808 When a listening daemon is started, Exim needs to know which interfaces
12809 and ports to listen on.
12810 .next
12811 When Exim is routing an address, it needs to know which IP addresses
12812 are associated with local interfaces. This is required for the correct
12813 processing of MX lists by removing the local host and others with the
12814 same or higher priority values. Also, Exim needs to detect cases
12815 when an address is routed to an IP address that in fact belongs to the
12816 local host. Unless the &%self%& router option or the &%allow_localhost%&
12817 option of the smtp transport is set (as appropriate), this is treated
12818 as an error situation.
12819 .next
12820 When Exim connects to a remote host, it may need to know which interface to use
12821 for the outgoing connection.
12822 .endlist
12823
12824
12825 Exim's default behaviour is likely to be appropriate in the vast majority
12826 of cases. If your host has only one interface, and you want all its IP
12827 addresses to be treated in the same way, and you are using only the
12828 standard SMTP port, you should not need to take any special action. The
12829 rest of this chapter does not apply to you.
12830
12831 In a more complicated situation you may want to listen only on certain
12832 interfaces, or on different ports, and for this reason there are a number of
12833 options that can be used to influence Exim's behaviour. The rest of this
12834 chapter describes how they operate.
12835
12836 When a message is received over TCP/IP, the interface and port that were
12837 actually used are set in &$received_ip_address$& and &$received_port$&.
12838
12839
12840
12841 .section "Starting a listening daemon" "SECID89"
12842 When a listening daemon is started (by means of the &%-bd%& command line
12843 option), the interfaces and ports on which it listens are controlled by the
12844 following options:
12845
12846 .ilist
12847 &%daemon_smtp_ports%& contains a list of default ports
12848 or service names.
12849 (For backward compatibility, this option can also be specified in the singular.)
12850 .next
12851 &%local_interfaces%& contains list of interface IP addresses on which to
12852 listen. Each item may optionally also specify a port.
12853 .endlist
12854
12855 The default list separator in both cases is a colon, but this can be changed as
12856 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12857 it is usually best to change the separator to avoid having to double all the
12858 colons. For example:
12859 .code
12860 local_interfaces = <; 127.0.0.1 ; \
12861                       192.168.23.65 ; \
12862                       ::1 ; \
12863                       3ffe:ffff:836f::fe86:a061
12864 .endd
12865 There are two different formats for specifying a port along with an IP address
12866 in &%local_interfaces%&:
12867
12868 .olist
12869 The port is added onto the address with a dot separator. For example, to listen
12870 on port 1234 on two different IP addresses:
12871 .code
12872 local_interfaces = <; 192.168.23.65.1234 ; \
12873                       3ffe:ffff:836f::fe86:a061.1234
12874 .endd
12875 .next
12876 The IP address is enclosed in square brackets, and the port is added
12877 with a colon separator, for example:
12878 .code
12879 local_interfaces = <; [192.168.23.65]:1234 ; \
12880                       [3ffe:ffff:836f::fe86:a061]:1234
12881 .endd
12882 .endlist
12883
12884 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12885 default setting contains just one port:
12886 .code
12887 daemon_smtp_ports = smtp
12888 .endd
12889 If more than one port is listed, each interface that does not have its own port
12890 specified listens on all of them. Ports that are listed in
12891 &%daemon_smtp_ports%& can be identified either by name (defined in
12892 &_/etc/services_&) or by number. However, when ports are given with individual
12893 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12894
12895
12896
12897 .section "Special IP listening addresses" "SECID90"
12898 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12899 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12900 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12901 instead of setting up separate listening sockets for each interface. The
12902 default value of &%local_interfaces%& is
12903 .code
12904 local_interfaces = 0.0.0.0
12905 .endd
12906 when Exim is built without IPv6 support; otherwise it is:
12907 .code
12908 local_interfaces = <; ::0 ; 0.0.0.0
12909 .endd
12910 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12911
12912
12913
12914 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12915 The &%-oX%& command line option can be used to override the values of
12916 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12917 instance. Another way of doing this would be to use macros and the &%-D%&
12918 option. However, &%-oX%& can be used by any admin user, whereas modification of
12919 the runtime configuration by &%-D%& is allowed only when the caller is root or
12920 exim.
12921
12922 The value of &%-oX%& is a list of items. The default colon separator can be
12923 changed in the usual way if required. If there are any items that do not
12924 contain dots or colons (that is, are not IP addresses), the value of
12925 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12926 items that do contain dots or colons, the value of &%local_interfaces%& is
12927 replaced by those items. Thus, for example,
12928 .code
12929 -oX 1225
12930 .endd
12931 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12932 whereas
12933 .code
12934 -oX 192.168.34.5.1125
12935 .endd
12936 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12937 (However, since &%local_interfaces%& now contains no items without ports, the
12938 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12939
12940
12941
12942 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12943 .cindex "ssmtp protocol"
12944 .cindex "smtps protocol"
12945 .cindex "SMTP" "ssmtp protocol"
12946 .cindex "SMTP" "smtps protocol"
12947 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12948 before the STARTTLS command was standardized for SMTP. Some legacy clients
12949 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12950 list of port numbers or service names,
12951 connections to those ports must use SSMTP. The most
12952 common use of this option is expected to be
12953 .code
12954 tls_on_connect_ports = 465
12955 .endd
12956 because 465 is the usual port number used by the legacy clients. There is also
12957 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12958 this way when a daemon is started.
12959
12960 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12961 daemon to listen on those ports. You must still specify them in
12962 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12963 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12964 connections via the daemon.)
12965
12966
12967
12968
12969 .section "IPv6 address scopes" "SECID92"
12970 .cindex "IPv6" "address scopes"
12971 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12972 can, in principle, have the same link-local IPv6 address on different
12973 interfaces. Thus, additional information is needed, over and above the IP
12974 address, to distinguish individual interfaces. A convention of using a
12975 percent sign followed by something (often the interface name) has been
12976 adopted in some cases, leading to addresses like this:
12977 .code
12978 fe80::202:b3ff:fe03:45c1%eth0
12979 .endd
12980 To accommodate this usage, a percent sign followed by an arbitrary string is
12981 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12982 to convert a textual IPv6 address for actual use. This function recognizes the
12983 percent convention in operating systems that support it, and it processes the
12984 address appropriately. Unfortunately, some older libraries have problems with
12985 &[getaddrinfo()]&. If
12986 .code
12987 IPV6_USE_INET_PTON=yes
12988 .endd
12989 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12990 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12991 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12992 function.) Of course, this means that the additional functionality of
12993 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12994
12995 .section "Disabling IPv6" "SECID93"
12996 .cindex "IPv6" "disabling"
12997 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12998 run on a host whose kernel does not support IPv6. The binary will fall back to
12999 using IPv4, but it may waste resources looking up AAAA records, and trying to
13000 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13001 .oindex "&%disable_ipv6%&"
13002 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13003 activities take place. AAAA records are never looked up, and any IPv6 addresses
13004 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13005 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13006 to handle IPv6 literal addresses.
13007
13008 On the other hand, when IPv6 is in use, there may be times when you want to
13009 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13010 option to globally suppress the lookup of AAAA records for specified domains,
13011 and you can use the &%ignore_target_hosts%& generic router option to ignore
13012 IPv6 addresses in an individual router.
13013
13014
13015
13016 .section "Examples of starting a listening daemon" "SECID94"
13017 The default case in an IPv6 environment is
13018 .code
13019 daemon_smtp_ports = smtp
13020 local_interfaces = <; ::0 ; 0.0.0.0
13021 .endd
13022 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13023 Either one or two sockets may be used, depending on the characteristics of
13024 the TCP/IP stack. (This is complicated and messy; for more information,
13025 read the comments in the &_daemon.c_& source file.)
13026
13027 To specify listening on ports 25 and 26 on all interfaces:
13028 .code
13029 daemon_smtp_ports = 25 : 26
13030 .endd
13031 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13032 .code
13033 local_interfaces = <; ::0.25     ; ::0.26 \
13034                       0.0.0.0.25 ; 0.0.0.0.26
13035 .endd
13036 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13037 IPv4 loopback address only:
13038 .code
13039 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13040 .endd
13041 To specify listening on the default port on specific interfaces only:
13042 .code
13043 local_interfaces = 10.0.0.67 : 192.168.34.67
13044 .endd
13045 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13046
13047
13048
13049 .section "Recognizing the local host" "SECTreclocipadd"
13050 The &%local_interfaces%& option is also used when Exim needs to determine
13051 whether or not an IP address refers to the local host. That is, the IP
13052 addresses of all the interfaces on which a daemon is listening are always
13053 treated as local.
13054
13055 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13056 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13057 available interfaces from the operating system, and extracts the relevant
13058 (that is, IPv4 or IPv6) addresses to use for checking.
13059
13060 Some systems set up large numbers of virtual interfaces in order to provide
13061 many virtual web servers. In this situation, you may want to listen for
13062 email on only a few of the available interfaces, but nevertheless treat all
13063 interfaces as local when routing. You can do this by setting
13064 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13065 &"all"& wildcard values. These addresses are recognized as local, but are not
13066 used for listening. Consider this example:
13067 .code
13068 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13069                       192.168.53.235 ; \
13070                       3ffe:2101:12:1:a00:20ff:fe86:a061
13071
13072 extra_local_interfaces = <; ::0 ; 0.0.0.0
13073 .endd
13074 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13075 address, but all available interface addresses are treated as local when
13076 Exim is routing.
13077
13078 In some environments the local host name may be in an MX list, but with an IP
13079 address that is not assigned to any local interface. In other cases it may be
13080 desirable to treat other host names as if they referred to the local host. Both
13081 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13082 This contains host names rather than IP addresses. When a host is referenced
13083 during routing, either via an MX record or directly, it is treated as the local
13084 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13085 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13086
13087
13088
13089 .section "Delivering to a remote host" "SECID95"
13090 Delivery to a remote host is handled by the smtp transport. By default, it
13091 allows the system's TCP/IP functions to choose which interface to use (if
13092 there is more than one) when connecting to a remote host. However, the
13093 &%interface%& option can be set to specify which interface is used. See the
13094 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13095 details.
13096
13097
13098
13099
13100 . ////////////////////////////////////////////////////////////////////////////
13101 . ////////////////////////////////////////////////////////////////////////////
13102
13103 .chapter "Main configuration" "CHAPmainconfig"
13104 .scindex IIDconfima "configuration file" "main section"
13105 .scindex IIDmaiconf "main configuration"
13106 The first part of the run time configuration file contains three types of item:
13107
13108 .ilist
13109 Macro definitions: These lines start with an upper case letter. See section
13110 &<<SECTmacrodefs>>& for details of macro processing.
13111 .next
13112 Named list definitions: These lines start with one of the words &"domainlist"&,
13113 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13114 section &<<SECTnamedlists>>&.
13115 .next
13116 Main configuration settings: Each setting occupies one line of the file
13117 (with possible continuations). If any setting is preceded by the word
13118 &"hide"&, the &%-bP%& command line option displays its value to admin users
13119 only. See section &<<SECTcos>>& for a description of the syntax of these option
13120 settings.
13121 .endlist
13122
13123 This chapter specifies all the main configuration options, along with their
13124 types and default values. For ease of finding a particular option, they appear
13125 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13126 are now so many options, they are first listed briefly in functional groups, as
13127 an aid to finding the name of the option you are looking for. Some options are
13128 listed in more than one group.
13129
13130 .section "Miscellaneous" "SECID96"
13131 .table2
13132 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13133 .row &%disable_ipv6%&                "do no IPv6 processing"
13134 .row &%keep_malformed%&              "for broken files &-- should not happen"
13135 .row &%localhost_number%&            "for unique message ids in clusters"
13136 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13137 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13138 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13139 .row &%print_topbitchars%&           "top-bit characters are printing"
13140 .row &%timezone%&                    "force time zone"
13141 .endtable
13142
13143
13144 .section "Exim parameters" "SECID97"
13145 .table2
13146 .row &%exim_group%&                  "override compiled-in value"
13147 .row &%exim_path%&                   "override compiled-in value"
13148 .row &%exim_user%&                   "override compiled-in value"
13149 .row &%primary_hostname%&            "default from &[uname()]&"
13150 .row &%split_spool_directory%&       "use multiple directories"
13151 .row &%spool_directory%&             "override compiled-in value"
13152 .endtable
13153
13154
13155
13156 .section "Privilege controls" "SECID98"
13157 .table2
13158 .row &%admin_groups%&                "groups that are Exim admin users"
13159 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13160 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13161 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13162 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13163 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13164 .row &%never_users%&                 "do not run deliveries as these"
13165 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13166 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13167 .row &%trusted_groups%&              "groups that are trusted"
13168 .row &%trusted_users%&               "users that are trusted"
13169 .endtable
13170
13171
13172
13173 .section "Logging" "SECID99"
13174 .table2
13175 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13176 .row &%log_file_path%&               "override compiled-in value"
13177 .row &%log_selector%&                "set/unset optional logging"
13178 .row &%log_timezone%&                "add timezone to log lines"
13179 .row &%message_logs%&                "create per-message logs"
13180 .row &%preserve_message_logs%&       "after message completion"
13181 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13182 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13183 .row &%syslog_facility%&             "set syslog &""facility""& field"
13184 .row &%syslog_processname%&          "set syslog &""ident""& field"
13185 .row &%syslog_timestamp%&            "timestamp syslog lines"
13186 .row &%write_rejectlog%&             "control use of message log"
13187 .endtable
13188
13189
13190
13191 .section "Frozen messages" "SECID100"
13192 .table2
13193 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13194 .row &%freeze_tell%&                 "send message when freezing"
13195 .row &%move_frozen_messages%&        "to another directory"
13196 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13197 .endtable
13198
13199
13200
13201 .section "Data lookups" "SECID101"
13202 .table2
13203 .row &%ibase_servers%&               "InterBase servers"
13204 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13205 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13206 .row &%ldap_cert_file%&              "client cert file for LDAP"
13207 .row &%ldap_cert_key%&               "client key file for LDAP"
13208 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13209 .row &%ldap_default_servers%&        "used if no server in query"
13210 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13211 .row &%ldap_start_tls%&              "require TLS within LDAP"
13212 .row &%ldap_version%&                "set protocol version"
13213 .row &%lookup_open_max%&             "lookup files held open"
13214 .row &%mysql_servers%&               "default MySQL servers"
13215 .row &%oracle_servers%&              "Oracle servers"
13216 .row &%pgsql_servers%&               "default PostgreSQL servers"
13217 .row &%sqlite_lock_timeout%&         "as it says"
13218 .endtable
13219
13220
13221
13222 .section "Message ids" "SECID102"
13223 .table2
13224 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13225 .row &%message_id_header_text%&      "ditto"
13226 .endtable
13227
13228
13229
13230 .section "Embedded Perl Startup" "SECID103"
13231 .table2
13232 .row &%perl_at_start%&               "always start the interpreter"
13233 .row &%perl_startup%&                "code to obey when starting Perl"
13234 .endtable
13235
13236
13237
13238 .section "Daemon" "SECID104"
13239 .table2
13240 .row &%daemon_smtp_ports%&           "default ports"
13241 .row &%daemon_startup_retries%&      "number of times to retry"
13242 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13243 .row &%extra_local_interfaces%&      "not necessarily listened on"
13244 .row &%local_interfaces%&            "on which to listen, with optional ports"
13245 .row &%pid_file_path%&               "override compiled-in value"
13246 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13247 .endtable
13248
13249
13250
13251 .section "Resource control" "SECID105"
13252 .table2
13253 .row &%check_log_inodes%&            "before accepting a message"
13254 .row &%check_log_space%&             "before accepting a message"
13255 .row &%check_spool_inodes%&          "before accepting a message"
13256 .row &%check_spool_space%&           "before accepting a message"
13257 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13258 .row &%queue_only_load%&             "queue incoming if load high"
13259 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13260 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13261 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13262 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13263 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13264 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13265 .row &%smtp_accept_max_per_connection%& "messages per connection"
13266 .row &%smtp_accept_max_per_host%&    "connections from one host"
13267 .row &%smtp_accept_queue%&           "queue mail if more connections"
13268 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13269                                            connection"
13270 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13271 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13272 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13273 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13274 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13275 .endtable
13276
13277
13278
13279 .section "Policy controls" "SECID106"
13280 .table2
13281 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13282 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13283 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13284 .row &%acl_smtp_auth%&               "ACL for AUTH"
13285 .row &%acl_smtp_connect%&            "ACL for connection"
13286 .row &%acl_smtp_data%&               "ACL for DATA"
13287 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13288 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13289 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13290 .row &%acl_smtp_expn%&               "ACL for EXPN"
13291 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13292 .row &%acl_smtp_mail%&               "ACL for MAIL"
13293 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13294 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13295 .row &%acl_smtp_predata%&            "ACL for start of data"
13296 .row &%acl_smtp_quit%&               "ACL for QUIT"
13297 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13298 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13299 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13300 .row &%av_scanner%&                  "specify virus scanner"
13301 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13302                                       words""&"
13303 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13304 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13305 .row &%header_maxsize%&              "total size of message header"
13306 .row &%header_line_maxsize%&         "individual header line limit"
13307 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13308 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13309 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13310 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13311 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13312 .row &%host_lookup%&                 "host name looked up for these hosts"
13313 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13314 .row &%host_reject_connection%&      "reject connection from these hosts"
13315 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13316 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13317 .row &%message_size_limit%&          "for all messages"
13318 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13319 .row &%spamd_address%&               "set interface to SpamAssassin"
13320 .row &%strict_acl_vars%&             "object to unset ACL variables"
13321 .endtable
13322
13323
13324
13325 .section "Callout cache" "SECID107"
13326 .table2
13327 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13328                                          item"
13329 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13330                                          item"
13331 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13332 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13333 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13334 .endtable
13335
13336
13337
13338 .section "TLS" "SECID108"
13339 .table2
13340 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13341 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13342 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13343 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13344 .row &%tls_certificate%&             "location of server certificate"
13345 .row &%tls_crl%&                     "certificate revocation list"
13346 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13347 .row &%tls_dhparam%&                 "DH parameters for server"
13348 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13349 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13350 .row &%tls_privatekey%&              "location of server private key"
13351 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13352 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13353 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13354 .row &%tls_verify_certificates%&     "expected client certificates"
13355 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13356 .endtable
13357
13358
13359
13360 .section "Local user handling" "SECID109"
13361 .table2
13362 .row &%finduser_retries%&            "useful in NIS environments"
13363 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13364 .row &%gecos_pattern%&               "ditto"
13365 .row &%max_username_length%&         "for systems that truncate"
13366 .row &%unknown_login%&               "used when no login name found"
13367 .row &%unknown_username%&            "ditto"
13368 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13369 .row &%uucp_from_sender%&            "ditto"
13370 .endtable
13371
13372
13373
13374 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13375 .table2
13376 .row &%header_maxsize%&              "total size of message header"
13377 .row &%header_line_maxsize%&         "individual header line limit"
13378 .row &%message_size_limit%&          "applies to all messages"
13379 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13380 .row &%received_header_text%&        "expanded to make &'Received:'&"
13381 .row &%received_headers_max%&        "for mail loop detection"
13382 .row &%recipients_max%&              "limit per message"
13383 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13384 .endtable
13385
13386
13387
13388
13389 .section "Non-SMTP incoming messages" "SECID111"
13390 .table2
13391 .row &%receive_timeout%&             "for non-SMTP messages"
13392 .endtable
13393
13394
13395
13396
13397
13398 .section "Incoming SMTP messages" "SECID112"
13399 See also the &'Policy controls'& section above.
13400
13401 .table2
13402 .row &%host_lookup%&                 "host name looked up for these hosts"
13403 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13404 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13405 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13406 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13407 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13408 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13409 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13410 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13411 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13412 .row &%smtp_accept_max_per_connection%& "messages per connection"
13413 .row &%smtp_accept_max_per_host%&    "connections from one host"
13414 .row &%smtp_accept_queue%&           "queue mail if more connections"
13415 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13416                                            connection"
13417 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13418 .row &%smtp_active_hostname%&        "host name to use in messages"
13419 .row &%smtp_banner%&                 "text for welcome banner"
13420 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13421 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13422 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13423 .row &%smtp_etrn_command%&           "what to run for ETRN"
13424 .row &%smtp_etrn_serialize%&         "only one at once"
13425 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13426 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13427 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13428 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13429 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13430 .row &%smtp_receive_timeout%&        "per command or data line"
13431 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13432 .row &%smtp_return_error_details%&   "give detail on rejections"
13433 .endtable
13434
13435
13436
13437 .section "SMTP extensions" "SECID113"
13438 .table2
13439 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13440 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13441 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13442 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13443 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13444 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13445 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13446 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13447 .endtable
13448
13449
13450
13451 .section "Processing messages" "SECID114"
13452 .table2
13453 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13454 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13455 .row &%allow_utf8_domains%&          "in addresses"
13456 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13457                                       words""&"
13458 .row &%delivery_date_remove%&        "from incoming messages"
13459 .row &%envelope_to_remove%&          "from incoming messages"
13460 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13461 .row &%headers_charset%&             "default for translations"
13462 .row &%qualify_domain%&              "default for senders"
13463 .row &%qualify_recipient%&           "default for recipients"
13464 .row &%return_path_remove%&          "from incoming messages"
13465 .row &%strip_excess_angle_brackets%& "in addresses"
13466 .row &%strip_trailing_dot%&          "at end of addresses"
13467 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13468 .endtable
13469
13470
13471
13472 .section "System filter" "SECID115"
13473 .table2
13474 .row &%system_filter%&               "locate system filter"
13475 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13476                                             directory"
13477 .row &%system_filter_file_transport%& "transport for delivery to a file"
13478 .row &%system_filter_group%&         "group for filter running"
13479 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13480 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13481 .row &%system_filter_user%&          "user for filter running"
13482 .endtable
13483
13484
13485
13486 .section "Routing and delivery" "SECID116"
13487 .table2
13488 .row &%disable_ipv6%&                "do no IPv6 processing"
13489 .row &%dns_again_means_nonexist%&    "for broken domains"
13490 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13491 .row &%dns_dnssec_ok%&               "parameter for resolver"
13492 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13493 .row &%dns_retrans%&                 "parameter for resolver"
13494 .row &%dns_retry%&                   "parameter for resolver"
13495 .row &%dns_use_edns0%&               "parameter for resolver"
13496 .row &%hold_domains%&                "hold delivery for these domains"
13497 .row &%local_interfaces%&            "for routing checks"
13498 .row &%queue_domains%&               "no immediate delivery for these"
13499 .row &%queue_only%&                  "no immediate delivery at all"
13500 .row &%queue_only_file%&             "no immediate delivery if file exists"
13501 .row &%queue_only_load%&             "no immediate delivery if load is high"
13502 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13503 .row &%queue_only_override%&         "allow command line to override"
13504 .row &%queue_run_in_order%&          "order of arrival"
13505 .row &%queue_run_max%&               "of simultaneous queue runners"
13506 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13507 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13508 .row &%remote_sort_domains%&         "order of remote deliveries"
13509 .row &%retry_data_expire%&           "timeout for retry data"
13510 .row &%retry_interval_max%&          "safety net for retry rules"
13511 .endtable
13512
13513
13514
13515 .section "Bounce and warning messages" "SECID117"
13516 .table2
13517 .row &%bounce_message_file%&         "content of bounce"
13518 .row &%bounce_message_text%&         "content of bounce"
13519 .row &%bounce_return_body%&          "include body if returning message"
13520 .row &%bounce_return_message%&       "include original message in bounce"
13521 .row &%bounce_return_size_limit%&    "limit on returned message"
13522 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13523 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13524 .row &%errors_copy%&                 "copy bounce messages"
13525 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13526 .row &%delay_warning%&               "time schedule"
13527 .row &%delay_warning_condition%&     "condition for warning messages"
13528 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13529 .row &%smtp_return_error_details%&   "give detail on rejections"
13530 .row &%warn_message_file%&           "content of warning message"
13531 .endtable
13532
13533
13534
13535 .section "Alphabetical list of main options" "SECTalomo"
13536 Those options that undergo string expansion before use are marked with
13537 &dagger;.
13538
13539 .option accept_8bitmime main boolean true
13540 .cindex "8BITMIME"
13541 .cindex "8-bit characters"
13542 .cindex "log" "selectors"
13543 .cindex "log" "8BITMIME"
13544 This option causes Exim to send 8BITMIME in its response to an SMTP
13545 EHLO command, and to accept the BODY= parameter on MAIL commands.
13546 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13547 takes no steps to do anything special with messages received by this route.
13548
13549 Historically Exim kept this option off by default, but the maintainers
13550 feel that in today's Internet, this causes more problems than it solves.
13551 It now defaults to true.
13552 A more detailed analysis of the issues is provided by Dan Bernstein:
13553 .display
13554 &url(http://cr.yp.to/smtp/8bitmime.html)
13555 .endd
13556
13557 To log received 8BITMIME status use
13558 .code
13559 log_selector = +8bitmime
13560 .endd
13561
13562 .option acl_not_smtp main string&!! unset
13563 .cindex "&ACL;" "for non-SMTP messages"
13564 .cindex "non-SMTP messages" "ACLs for"
13565 This option defines the ACL that is run when a non-SMTP message has been
13566 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13567 further details.
13568
13569 .option acl_not_smtp_mime main string&!! unset
13570 This option defines the ACL that is run for individual MIME parts of non-SMTP
13571 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13572 SMTP messages.
13573
13574 .option acl_not_smtp_start main string&!! unset
13575 .cindex "&ACL;" "at start of non-SMTP message"
13576 .cindex "non-SMTP messages" "ACLs for"
13577 This option defines the ACL that is run before Exim starts reading a
13578 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13579
13580 .option acl_smtp_auth main string&!! unset
13581 .cindex "&ACL;" "setting up for SMTP commands"
13582 .cindex "AUTH" "ACL for"
13583 This option defines the ACL that is run when an SMTP AUTH command is
13584 received. See chapter &<<CHAPACL>>& for further details.
13585
13586 .option acl_smtp_connect main string&!! unset
13587 .cindex "&ACL;" "on SMTP connection"
13588 This option defines the ACL that is run when an SMTP connection is received.
13589 See chapter &<<CHAPACL>>& for further details.
13590
13591 .option acl_smtp_data main string&!! unset
13592 .cindex "DATA" "ACL for"
13593 This option defines the ACL that is run after an SMTP DATA command has been
13594 processed and the message itself has been received, but before the final
13595 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13596
13597 .option acl_smtp_data_prdr main string&!! accept
13598 .cindex "PRDR" "ACL for"
13599 .cindex "DATA" "PRDR ACL for"
13600 .cindex "&ACL;" "PRDR-related"
13601 .cindex "&ACL;" "per-user data processing"
13602 This option defines the ACL that,
13603 if the PRDR feature has been negotiated,
13604 is run for each recipient after an SMTP DATA command has been
13605 processed and the message itself has been received, but before the
13606 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13607
13608 .option acl_smtp_etrn main string&!! unset
13609 .cindex "ETRN" "ACL for"
13610 This option defines the ACL that is run when an SMTP ETRN command is
13611 received. See chapter &<<CHAPACL>>& for further details.
13612
13613 .option acl_smtp_expn main string&!! unset
13614 .cindex "EXPN" "ACL for"
13615 This option defines the ACL that is run when an SMTP EXPN command is
13616 received. See chapter &<<CHAPACL>>& for further details.
13617
13618 .option acl_smtp_helo main string&!! unset
13619 .cindex "EHLO" "ACL for"
13620 .cindex "HELO" "ACL for"
13621 This option defines the ACL that is run when an SMTP EHLO or HELO
13622 command is received. See chapter &<<CHAPACL>>& for further details.
13623
13624
13625 .option acl_smtp_mail main string&!! unset
13626 .cindex "MAIL" "ACL for"
13627 This option defines the ACL that is run when an SMTP MAIL command is
13628 received. See chapter &<<CHAPACL>>& for further details.
13629
13630 .option acl_smtp_mailauth main string&!! unset
13631 .cindex "AUTH" "on MAIL command"
13632 This option defines the ACL that is run when there is an AUTH parameter on
13633 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13634 &<<CHAPSMTPAUTH>>& for details of authentication.
13635
13636 .option acl_smtp_mime main string&!! unset
13637 .cindex "MIME content scanning" "ACL for"
13638 This option is available when Exim is built with the content-scanning
13639 extension. It defines the ACL that is run for each MIME part in a message. See
13640 section &<<SECTscanmimepart>>& for details.
13641
13642 .option acl_smtp_predata main string&!! unset
13643 This option defines the ACL that is run when an SMTP DATA command is
13644 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13645 further details.
13646
13647 .option acl_smtp_quit main string&!! unset
13648 .cindex "QUIT, ACL for"
13649 This option defines the ACL that is run when an SMTP QUIT command is
13650 received. See chapter &<<CHAPACL>>& for further details.
13651
13652 .option acl_smtp_rcpt main string&!! unset
13653 .cindex "RCPT" "ACL for"
13654 This option defines the ACL that is run when an SMTP RCPT command is
13655 received. See chapter &<<CHAPACL>>& for further details.
13656
13657 .option acl_smtp_starttls main string&!! unset
13658 .cindex "STARTTLS, ACL for"
13659 This option defines the ACL that is run when an SMTP STARTTLS command is
13660 received. See chapter &<<CHAPACL>>& for further details.
13661
13662 .option acl_smtp_vrfy main string&!! unset
13663 .cindex "VRFY" "ACL for"
13664 This option defines the ACL that is run when an SMTP VRFY command is
13665 received. See chapter &<<CHAPACL>>& for further details.
13666
13667 .option admin_groups main "string list&!!" unset
13668 .cindex "admin user"
13669 This option is expanded just once, at the start of Exim's processing. If the
13670 current group or any of the supplementary groups of an Exim caller is in this
13671 colon-separated list, the caller has admin privileges. If all your system
13672 programmers are in a specific group, for example, you can give them all Exim
13673 admin privileges by putting that group in &%admin_groups%&. However, this does
13674 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13675 To permit this, you have to add individuals to the Exim group.
13676
13677 .option allow_domain_literals main boolean false
13678 .cindex "domain literal"
13679 If this option is set, the RFC 2822 domain literal format is permitted in
13680 email addresses. The option is not set by default, because the domain literal
13681 format is not normally required these days, and few people know about it. It
13682 has, however, been exploited by mail abusers.
13683
13684 Unfortunately, it seems that some DNS black list maintainers are using this
13685 format to report black listing to postmasters. If you want to accept messages
13686 addressed to your hosts by IP address, you need to set
13687 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13688 domains (defined in the named domain list &%local_domains%& in the default
13689 configuration). This &"magic string"& matches the domain literal form of all
13690 the local host's IP addresses.
13691
13692
13693 .option allow_mx_to_ip main boolean false
13694 .cindex "MX record" "pointing to IP address"
13695 It appears that more and more DNS zone administrators are breaking the rules
13696 and putting domain names that look like IP addresses on the right hand side of
13697 MX records. Exim follows the rules and rejects this, giving an error message
13698 that explains the mis-configuration. However, some other MTAs support this
13699 practice, so to avoid &"Why can't Exim do this?"& complaints,
13700 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13701 recommended, except when you have no other choice.
13702
13703 .option allow_utf8_domains main boolean false
13704 .cindex "domain" "UTF-8 characters in"
13705 .cindex "UTF-8" "in domain name"
13706 Lots of discussion is going on about internationalized domain names. One
13707 camp is strongly in favour of just using UTF-8 characters, and it seems
13708 that at least two other MTAs permit this. This option allows Exim users to
13709 experiment if they wish.
13710
13711 If it is set true, Exim's domain parsing function allows valid
13712 UTF-8 multicharacters to appear in domain name components, in addition to
13713 letters, digits, and hyphens. However, just setting this option is not
13714 enough; if you want to look up these domain names in the DNS, you must also
13715 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13716 suitable setting is:
13717 .code
13718 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13719   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13720 .endd
13721 Alternatively, you can just disable this feature by setting
13722 .code
13723 dns_check_names_pattern =
13724 .endd
13725 That is, set the option to an empty string so that no check is done.
13726
13727
13728 .option auth_advertise_hosts main "host list&!!" *
13729 .cindex "authentication" "advertising"
13730 .cindex "AUTH" "advertising"
13731 If any server authentication mechanisms are configured, Exim advertises them in
13732 response to an EHLO command only if the calling host matches this list.
13733 Otherwise, Exim does not advertise AUTH.
13734 Exim does not accept AUTH commands from clients to which it has not
13735 advertised the availability of AUTH. The advertising of individual
13736 authentication mechanisms can be controlled by the use of the
13737 &%server_advertise_condition%& generic authenticator option on the individual
13738 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13739
13740 Certain mail clients (for example, Netscape) require the user to provide a name
13741 and password for authentication if AUTH is advertised, even though it may
13742 not be needed (the host may accept messages from hosts on its local LAN without
13743 authentication, for example). The &%auth_advertise_hosts%& option can be used
13744 to make these clients more friendly by excluding them from the set of hosts to
13745 which Exim advertises AUTH.
13746
13747 .cindex "AUTH" "advertising when encrypted"
13748 If you want to advertise the availability of AUTH only when the connection
13749 is encrypted using TLS, you can make use of the fact that the value of this
13750 option is expanded, with a setting like this:
13751 .code
13752 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13753 .endd
13754 .vindex "&$tls_in_cipher$&"
13755 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13756 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13757 expansion is *, which matches all hosts.
13758
13759
13760 .option auto_thaw main time 0s
13761 .cindex "thawing messages"
13762 .cindex "unfreezing messages"
13763 If this option is set to a time greater than zero, a queue runner will try a
13764 new delivery attempt on any frozen message, other than a bounce message, if
13765 this much time has passed since it was frozen. This may result in the message
13766 being re-frozen if nothing has changed since the last attempt. It is a way of
13767 saying &"keep on trying, even though there are big problems"&.
13768
13769 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13770 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13771 thought to be very useful any more, and its use should probably be avoided.
13772
13773
13774 .option av_scanner main string "see below"
13775 This option is available if Exim is built with the content-scanning extension.
13776 It specifies which anti-virus scanner to use. The default value is:
13777 .code
13778 sophie:/var/run/sophie
13779 .endd
13780 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13781 before use. See section &<<SECTscanvirus>>& for further details.
13782
13783
13784 .option bi_command main string unset
13785 .oindex "&%-bi%&"
13786 This option supplies the name of a command that is run when Exim is called with
13787 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13788 just the command name, it is not a complete command line. If an argument is
13789 required, it must come from the &%-oA%& command line option.
13790
13791
13792 .option bounce_message_file main string unset
13793 .cindex "bounce message" "customizing"
13794 .cindex "customizing" "bounce message"
13795 This option defines a template file containing paragraphs of text to be used
13796 for constructing bounce messages.  Details of the file's contents are given in
13797 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13798
13799
13800 .option bounce_message_text main string unset
13801 When this option is set, its contents are included in the default bounce
13802 message immediately after &"This message was created automatically by mail
13803 delivery software."& It is not used if &%bounce_message_file%& is set.
13804
13805 .option bounce_return_body main boolean true
13806 .cindex "bounce message" "including body"
13807 This option controls whether the body of an incoming message is included in a
13808 bounce message when &%bounce_return_message%& is true. The default setting
13809 causes the entire message, both header and body, to be returned (subject to the
13810 value of &%bounce_return_size_limit%&). If this option is false, only the
13811 message header is included. In the case of a non-SMTP message containing an
13812 error that is detected during reception, only those header lines preceding the
13813 point at which the error was detected are returned.
13814 .cindex "bounce message" "including original"
13815
13816 .option bounce_return_message main boolean true
13817 If this option is set false, none of the original message is included in
13818 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13819 &%bounce_return_body%&.
13820
13821
13822 .option bounce_return_size_limit main integer 100K
13823 .cindex "size" "of bounce, limit"
13824 .cindex "bounce message" "size limit"
13825 .cindex "limit" "bounce message size"
13826 This option sets a limit in bytes on the size of messages that are returned to
13827 senders as part of bounce messages when &%bounce_return_message%& is true. The
13828 limit should be less than the value of the global &%message_size_limit%& and of
13829 any &%message_size_limit%& settings on transports, to allow for the bounce text
13830 that Exim generates. If this option is set to zero there is no limit.
13831
13832 When the body of any message that is to be included in a bounce message is
13833 greater than the limit, it is truncated, and a comment pointing this out is
13834 added at the top. The actual cutoff may be greater than the value given, owing
13835 to the use of buffering for transferring the message in chunks (typically 8K in
13836 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13837 messages.
13838
13839 .option bounce_sender_authentication main string unset
13840 .cindex "bounce message" "sender authentication"
13841 .cindex "authentication" "bounce message"
13842 .cindex "AUTH" "on bounce message"
13843 This option provides an authenticated sender address that is sent with any
13844 bounce messages generated by Exim that are sent over an authenticated SMTP
13845 connection. A typical setting might be:
13846 .code
13847 bounce_sender_authentication = mailer-daemon@my.domain.example
13848 .endd
13849 which would cause bounce messages to be sent using the SMTP command:
13850 .code
13851 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13852 .endd
13853 The value of &%bounce_sender_authentication%& must always be a complete email
13854 address.
13855
13856 .option callout_domain_negative_expire main time 3h
13857 .cindex "caching" "callout timeouts"
13858 .cindex "callout" "caching timeouts"
13859 This option specifies the expiry time for negative callout cache data for a
13860 domain. See section &<<SECTcallver>>& for details of callout verification, and
13861 section &<<SECTcallvercache>>& for details of the caching.
13862
13863
13864 .option callout_domain_positive_expire main time 7d
13865 This option specifies the expiry time for positive callout cache data for a
13866 domain. See section &<<SECTcallver>>& for details of callout verification, and
13867 section &<<SECTcallvercache>>& for details of the caching.
13868
13869
13870 .option callout_negative_expire main time 2h
13871 This option specifies the expiry time for negative callout cache data for an
13872 address. See section &<<SECTcallver>>& for details of callout verification, and
13873 section &<<SECTcallvercache>>& for details of the caching.
13874
13875
13876 .option callout_positive_expire main time 24h
13877 This option specifies the expiry time for positive callout cache data for an
13878 address. See section &<<SECTcallver>>& for details of callout verification, and
13879 section &<<SECTcallvercache>>& for details of the caching.
13880
13881
13882 .option callout_random_local_part main string&!! "see below"
13883 This option defines the &"random"& local part that can be used as part of
13884 callout verification. The default value is
13885 .code
13886 $primary_hostname-$tod_epoch-testing
13887 .endd
13888 See section &<<CALLaddparcall>>& for details of how this value is used.
13889
13890
13891 .option check_log_inodes main integer 0
13892 See &%check_spool_space%& below.
13893
13894
13895 .option check_log_space main integer 0
13896 See &%check_spool_space%& below.
13897
13898 .oindex "&%check_rfc2047_length%&"
13899 .cindex "RFC 2047" "disabling length check"
13900 .option check_rfc2047_length main boolean true
13901 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13902 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13903 word; strings to be encoded that exceed this length are supposed to use
13904 multiple encoded words. By default, Exim does not recognize encoded words that
13905 exceed the maximum length. However, it seems that some software, in violation
13906 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13907 set false, Exim recognizes encoded words of any length.
13908
13909
13910 .option check_spool_inodes main integer 0
13911 See &%check_spool_space%& below.
13912
13913
13914 .option check_spool_space main integer 0
13915 .cindex "checking disk space"
13916 .cindex "disk space, checking"
13917 .cindex "spool directory" "checking space"
13918 The four &%check_...%& options allow for checking of disk resources before a
13919 message is accepted.
13920
13921 .vindex "&$log_inodes$&"
13922 .vindex "&$log_space$&"
13923 .vindex "&$spool_inodes$&"
13924 .vindex "&$spool_space$&"
13925 When any of these options are set, they apply to all incoming messages. If you
13926 want to apply different checks to different kinds of message, you can do so by
13927 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13928 &$spool_space$& in an ACL with appropriate additional conditions.
13929
13930
13931 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13932 either value is greater than zero, for example:
13933 .code
13934 check_spool_space = 10M
13935 check_spool_inodes = 100
13936 .endd
13937 The spool partition is the one that contains the directory defined by
13938 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13939 transit.
13940
13941 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13942 files are written if either is greater than zero. These should be set only if
13943 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13944
13945 If there is less space or fewer inodes than requested, Exim refuses to accept
13946 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13947 error response to the MAIL command. If ESMTP is in use and there was a
13948 SIZE parameter on the MAIL command, its value is added to the
13949 &%check_spool_space%& value, and the check is performed even if
13950 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13951
13952 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13953 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13954
13955 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13956 failure a message is written to stderr and Exim exits with a non-zero code, as
13957 it obviously cannot send an error message of any kind.
13958
13959 .option daemon_smtp_ports main string &`smtp`&
13960 .cindex "port" "for daemon"
13961 .cindex "TCP/IP" "setting listening ports"
13962 This option specifies one or more default SMTP ports on which the Exim daemon
13963 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13964 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13965
13966 .option daemon_startup_retries main integer 9
13967 .cindex "daemon startup, retrying"
13968 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13969 the daemon at startup when it cannot immediately bind a listening socket
13970 (typically because the socket is already in use): &%daemon_startup_retries%&
13971 defines the number of retries after the first failure, and
13972 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13973
13974 .option daemon_startup_sleep main time 30s
13975 See &%daemon_startup_retries%&.
13976
13977 .option delay_warning main "time list" 24h
13978 .cindex "warning of delay"
13979 .cindex "delay warning, specifying"
13980 When a message is delayed, Exim sends a warning message to the sender at
13981 intervals specified by this option. The data is a colon-separated list of times
13982 after which to send warning messages. If the value of the option is an empty
13983 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13984 message has been on the queue for longer than the last time, the last interval
13985 between the times is used to compute subsequent warning times. For example,
13986 with
13987 .code
13988 delay_warning = 4h:8h:24h
13989 .endd
13990 the first message is sent after 4 hours, the second after 8 hours, and
13991 the third one after 24 hours. After that, messages are sent every 16 hours,
13992 because that is the interval between the last two times on the list. If you set
13993 just one time, it specifies the repeat interval. For example, with:
13994 .code
13995 delay_warning = 6h
13996 .endd
13997 messages are repeated every six hours. To stop warnings after a given time, set
13998 a very large time at the end of the list. For example:
13999 .code
14000 delay_warning = 2h:12h:99d
14001 .endd
14002 Note that the option is only evaluated at the time a delivery attempt fails,
14003 which depends on retry and queue-runner configuration.
14004 Typically retries will be configured more frequently than warning messages.
14005
14006 .option delay_warning_condition main string&!! "see below"
14007 .vindex "&$domain$&"
14008 The string is expanded at the time a warning message might be sent. If all the
14009 deferred addresses have the same domain, it is set in &$domain$& during the
14010 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14011 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14012 &"false"& (the comparison being done caselessly) then the warning message is
14013 not sent. The default is:
14014 .code
14015 delay_warning_condition = ${if or {\
14016   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14017   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14018   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14019   } {no}{yes}}
14020 .endd
14021 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14022 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14023 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14024 &"auto-replied"& in an &'Auto-Submitted:'& header.
14025
14026 .option deliver_drop_privilege main boolean false
14027 .cindex "unprivileged delivery"
14028 .cindex "delivery" "unprivileged"
14029 If this option is set true, Exim drops its root privilege at the start of a
14030 delivery process, and runs as the Exim user throughout. This severely restricts
14031 the kinds of local delivery that are possible, but is viable in certain types
14032 of configuration. There is a discussion about the use of root privilege in
14033 chapter &<<CHAPsecurity>>&.
14034
14035 .option deliver_queue_load_max main fixed-point unset
14036 .cindex "load average"
14037 .cindex "queue runner" "abandoning"
14038 When this option is set, a queue run is abandoned if the system load average
14039 becomes greater than the value of the option. The option has no effect on
14040 ancient operating systems on which Exim cannot determine the load average.
14041 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14042
14043
14044 .option delivery_date_remove main boolean true
14045 .cindex "&'Delivery-date:'& header line"
14046 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14047 message when it is delivered, in exactly the same way as &'Return-path:'& is
14048 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14049 should not be present in incoming messages, and this option causes them to be
14050 removed at the time the message is received, to avoid any problems that might
14051 occur when a delivered message is subsequently sent on to some other recipient.
14052
14053 .option disable_fsync main boolean false
14054 .cindex "&[fsync()]&, disabling"
14055 This option is available only if Exim was built with the compile-time option
14056 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14057 a runtime configuration generates an &"unknown option"& error. You should not
14058 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14059 really, really, really understand what you are doing. &'No pre-compiled
14060 distributions of Exim should ever make this option available.'&
14061
14062 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14063 updated files' data to be written to disc before continuing. Unexpected events
14064 such as crashes and power outages may cause data to be lost or scrambled.
14065 Here be Dragons. &*Beware.*&
14066
14067
14068 .option disable_ipv6 main boolean false
14069 .cindex "IPv6" "disabling"
14070 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14071 activities take place. AAAA records are never looked up, and any IPv6 addresses
14072 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14073 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14074 to handle IPv6 literal addresses.
14075
14076
14077 .option dns_again_means_nonexist main "domain list&!!" unset
14078 .cindex "DNS" "&""try again""& response; overriding"
14079 DNS lookups give a &"try again"& response for the DNS errors
14080 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14081 keep trying to deliver a message, or to give repeated temporary errors to
14082 incoming mail. Sometimes the effect is caused by a badly set up name server and
14083 may persist for a long time. If a domain which exhibits this problem matches
14084 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14085 This option should be used with care. You can make it apply to reverse lookups
14086 by a setting such as this:
14087 .code
14088 dns_again_means_nonexist = *.in-addr.arpa
14089 .endd
14090 This option applies to all DNS lookups that Exim does. It also applies when the
14091 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14092 since these are most likely to be caused by DNS lookup problems. The
14093 &(dnslookup)& router has some options of its own for controlling what happens
14094 when lookups for MX or SRV records give temporary errors. These more specific
14095 options are applied after this global option.
14096
14097 .option dns_check_names_pattern main string "see below"
14098 .cindex "DNS" "pre-check of name syntax"
14099 When this option is set to a non-empty string, it causes Exim to check domain
14100 names for characters that are not allowed in host names before handing them to
14101 the DNS resolver, because some resolvers give temporary errors for names that
14102 contain unusual characters. If a domain name contains any unwanted characters,
14103 a &"not found"& result is forced, and the resolver is not called. The check is
14104 done by matching the domain name against a regular expression, which is the
14105 value of this option. The default pattern is
14106 .code
14107 dns_check_names_pattern = \
14108   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14109 .endd
14110 which permits only letters, digits, slashes, and hyphens in components, but
14111 they must start and end with a letter or digit. Slashes are not, in fact,
14112 permitted in host names, but they are found in certain NS records (which can be
14113 accessed in Exim by using a &%dnsdb%& lookup). If you set
14114 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14115 empty string.
14116
14117 .option dns_csa_search_limit main integer 5
14118 This option controls the depth of parental searching for CSA SRV records in the
14119 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14120
14121 .option dns_csa_use_reverse main boolean true
14122 This option controls whether or not an IP address, given as a CSA domain, is
14123 reversed and looked up in the reverse DNS, as described in more detail in
14124 section &<<SECTverifyCSA>>&.
14125
14126
14127 .option dns_dnssec_ok main integer -1
14128 .cindex "DNS" "resolver options"
14129 .cindex "DNS" "DNSSEC"
14130 If this option is set to a non-negative number then Exim will initialise the
14131 DNS resolver library to either use or not use DNSSEC, overriding the system
14132 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14133
14134 If the resolver library does not support DNSSEC then this option has no effect.
14135
14136
14137 .option dns_ipv4_lookup main "domain list&!!" unset
14138 .cindex "IPv6" "DNS lookup for AAAA records"
14139 .cindex "DNS" "IPv6 lookup for AAAA records"
14140 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14141 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14142 (A records) when trying to find IP addresses for hosts, unless the host's
14143 domain matches this list.
14144
14145 This is a fudge to help with name servers that give big delays or otherwise do
14146 not work for the AAAA record type. In due course, when the world's name
14147 servers have all been upgraded, there should be no need for this option.
14148
14149
14150 .option dns_retrans main time 0s
14151 .cindex "DNS" "resolver options"
14152 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14153 retransmission and retry parameters for DNS lookups. Values of zero (the
14154 defaults) leave the system default settings unchanged. The first value is the
14155 time between retries, and the second is the number of retries. It isn't
14156 totally clear exactly how these settings affect the total time a DNS lookup may
14157 take. I haven't found any documentation about timeouts on DNS lookups; these
14158 parameter values are available in the external resolver interface structure,
14159 but nowhere does it seem to describe how they are used or what you might want
14160 to set in them.
14161
14162
14163 .option dns_retry main integer 0
14164 See &%dns_retrans%& above.
14165
14166
14167 .option dns_use_edns0 main integer -1
14168 .cindex "DNS" "resolver options"
14169 .cindex "DNS" "EDNS0"
14170 If this option is set to a non-negative number then Exim will initialise the
14171 DNS resolver library to either use or not use EDNS0 extensions, overriding
14172 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14173 on.
14174
14175 If the resolver library does not support EDNS0 then this option has no effect.
14176
14177
14178 .option drop_cr main boolean false
14179 This is an obsolete option that is now a no-op. It used to affect the way Exim
14180 handled CR and LF characters in incoming messages. What happens now is
14181 described in section &<<SECTlineendings>>&.
14182
14183 .option dsn_advertise_hosts main "host list&!!" unset
14184 .cindex "bounce messages" "success"
14185 .cindex "DSN" "success"
14186 .cindex "Delivery Status Notification" "success"
14187 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14188 and accepted from, these hosts.
14189 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14190 and RET and ORCPT options on MAIL FROM commands.
14191 A NOTIFY=SUCCESS option requests success-DSN messages.
14192 A NOTIFY= option with no argument requests that no delay or failure DSNs
14193 are sent.
14194
14195 .option dsn_from main "string&!!" "see below"
14196 .cindex "&'From:'& header line" "in bounces"
14197 .cindex "bounce messages" "&'From:'& line, specifying"
14198 This option can be used to vary the contents of &'From:'& header lines in
14199 bounces and other automatically generated messages (&"Delivery Status
14200 Notifications"& &-- hence the name of the option). The default setting is:
14201 .code
14202 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14203 .endd
14204 The value is expanded every time it is needed. If the expansion fails, a
14205 panic is logged, and the default value is used.
14206
14207 .option envelope_to_remove main boolean true
14208 .cindex "&'Envelope-to:'& header line"
14209 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14210 message when it is delivered, in exactly the same way as &'Return-path:'& is
14211 handled. &'Envelope-to:'& records the original recipient address from the
14212 messages's envelope that caused the delivery to happen. Such headers should not
14213 be present in incoming messages, and this option causes them to be removed at
14214 the time the message is received, to avoid any problems that might occur when a
14215 delivered message is subsequently sent on to some other recipient.
14216
14217
14218 .option errors_copy main "string list&!!" unset
14219 .cindex "bounce message" "copy to other address"
14220 .cindex "copy of bounce message"
14221 Setting this option causes Exim to send bcc copies of bounce messages that it
14222 generates to other addresses. &*Note*&: This does not apply to bounce messages
14223 coming from elsewhere. The value of the option is a colon-separated list of
14224 items. Each item consists of a pattern, terminated by white space, followed by
14225 a comma-separated list of email addresses. If a pattern contains spaces, it
14226 must be enclosed in double quotes.
14227
14228 Each pattern is processed in the same way as a single item in an address list
14229 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14230 the bounce message, the message is copied to the addresses on the list. The
14231 items are scanned in order, and once a matching one is found, no further items
14232 are examined. For example:
14233 .code
14234 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14235               rqps@mydomain   hostmaster@mydomain.example,\
14236                               postmaster@mydomain.example
14237 .endd
14238 .vindex "&$domain$&"
14239 .vindex "&$local_part$&"
14240 The address list is expanded before use. The expansion variables &$local_part$&
14241 and &$domain$& are set from the original recipient of the error message, and if
14242 there was any wildcard matching in the pattern, the expansion
14243 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14244 variables &$0$&, &$1$&, etc. are set in the normal way.
14245
14246
14247 .option errors_reply_to main string unset
14248 .cindex "bounce message" "&'Reply-to:'& in"
14249 By default, Exim's bounce and delivery warning messages contain the header line
14250 .display
14251 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14252 .endd
14253 .oindex &%quota_warn_message%&
14254 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14255 A warning message that is generated by the &%quota_warn_message%& option in an
14256 &(appendfile)& transport may contain its own &'From:'& header line that
14257 overrides the default.
14258
14259 Experience shows that people reply to bounce messages. If the
14260 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14261 and warning messages. For example:
14262 .code
14263 errors_reply_to = postmaster@my.domain.example
14264 .endd
14265 The value of the option is not expanded. It must specify a valid RFC 2822
14266 address. However, if a warning message that is generated by the
14267 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14268 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14269 not used.
14270
14271
14272 .option exim_group main string "compile-time configured"
14273 .cindex "gid (group id)" "Exim's own"
14274 .cindex "Exim group"
14275 This option changes the gid under which Exim runs when it gives up root
14276 privilege. The default value is compiled into the binary. The value of this
14277 option is used only when &%exim_user%& is also set. Unless it consists entirely
14278 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14279 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14280 security issues.
14281
14282
14283 .option exim_path main string "see below"
14284 .cindex "Exim binary, path name"
14285 This option specifies the path name of the Exim binary, which is used when Exim
14286 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14287 the directory configured at compile time by the BIN_DIRECTORY setting. It
14288 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14289 other place.
14290 &*Warning*&: Do not use a macro to define the value of this option, because
14291 you will break those Exim utilities that scan the configuration file to find
14292 where the binary is. (They then use the &%-bP%& option to extract option
14293 settings such as the value of &%spool_directory%&.)
14294
14295
14296 .option exim_user main string "compile-time configured"
14297 .cindex "uid (user id)" "Exim's own"
14298 .cindex "Exim user"
14299 This option changes the uid under which Exim runs when it gives up root
14300 privilege. The default value is compiled into the binary. Ownership of the run
14301 time configuration file and the use of the &%-C%& and &%-D%& command line
14302 options is checked against the values in the binary, not what is set here.
14303
14304 Unless it consists entirely of digits, the string is looked up using
14305 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14306 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14307 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14308
14309
14310 .option extra_local_interfaces main "string list" unset
14311 This option defines network interfaces that are to be considered local when
14312 routing, but which are not used for listening by the daemon. See section
14313 &<<SECTreclocipadd>>& for details.
14314
14315
14316 . Allow this long option name to split; give it unsplit as a fifth argument
14317 . for the automatic .oindex that is generated by .option.
14318
14319 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14320          extract_addresses_remove_arguments
14321 .oindex "&%-t%&"
14322 .cindex "command line" "addresses with &%-t%&"
14323 .cindex "Sendmail compatibility" "&%-t%& option"
14324 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14325 are present on the command line when the &%-t%& option is used to build an
14326 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14327 line addresses are removed from the recipients list. This is also how Smail
14328 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14329 command line addresses are added to those obtained from the header lines. When
14330 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14331 argument headers. If it is set false, Exim adds rather than removes argument
14332 addresses.
14333
14334
14335 .option finduser_retries main integer 0
14336 .cindex "NIS, retrying user lookups"
14337 On systems running NIS or other schemes in which user and group information is
14338 distributed from a remote system, there can be times when &[getpwnam()]& and
14339 related functions fail, even when given valid data, because things time out.
14340 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14341 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14342 many extra times to find a user or a group, waiting for one second between
14343 retries.
14344
14345 .cindex "&_/etc/passwd_&" "multiple reading of"
14346 You should not set this option greater than zero if your user information is in
14347 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14348 search the file multiple times for non-existent users, and also cause delay.
14349
14350
14351
14352 .option freeze_tell main "string list, comma separated" unset
14353 .cindex "freezing messages" "sending a message when freezing"
14354 On encountering certain errors, or when configured to do so in a system filter,
14355 ACL, or special router, Exim freezes a message. This means that no further
14356 delivery attempts take place until an administrator thaws the message, or the
14357 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14358 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14359 warning message whenever it freezes something, unless the message it is
14360 freezing is a locally-generated bounce message. (Without this exception there
14361 is the possibility of looping.) The warning message is sent to the addresses
14362 supplied as the comma-separated value of this option. If several of the
14363 message's addresses cause freezing, only a single message is sent. If the
14364 freezing was automatic, the reason(s) for freezing can be found in the message
14365 log. If you configure freezing in a filter or ACL, you must arrange for any
14366 logging that you require.
14367
14368
14369 .option gecos_name main string&!! unset
14370 .cindex "HP-UX"
14371 .cindex "&""gecos""& field, parsing"
14372 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14373 password file to hold other information in addition to users' real names. Exim
14374 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14375 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14376 of the field are used unchanged, except that, if an ampersand is encountered,
14377 it is replaced by the user's login name with the first character forced to
14378 upper case, since this is a convention that is observed on many systems.
14379
14380 When these options are set, &%gecos_pattern%& is treated as a regular
14381 expression that is to be applied to the field (again with && replaced by the
14382 login name), and if it matches, &%gecos_name%& is expanded and used as the
14383 user's name.
14384
14385 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14386 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14387 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14388 name terminates at the first comma, the following can be used:
14389 .code
14390 gecos_pattern = ([^,]*)
14391 gecos_name = $1
14392 .endd
14393
14394 .option gecos_pattern main string unset
14395 See &%gecos_name%& above.
14396
14397
14398 .option gnutls_compat_mode main boolean unset
14399 This option controls whether GnuTLS is used in compatibility mode in an Exim
14400 server. This reduces security slightly, but improves interworking with older
14401 implementations of TLS.
14402
14403
14404 option gnutls_allow_auto_pkcs11 main boolean unset
14405 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14406 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14407
14408 See
14409 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14410 for documentation.
14411
14412
14413
14414 .option headers_charset main string "see below"
14415 This option sets a default character set for translating from encoded MIME
14416 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14417 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14418 ultimate default is ISO-8859-1. For more details see the description of header
14419 insertions in section &<<SECTexpansionitems>>&.
14420
14421
14422
14423 .option header_maxsize main integer "see below"
14424 .cindex "header section" "maximum size of"
14425 .cindex "limit" "size of message header section"
14426 This option controls the overall maximum size of a message's header
14427 section. The default is the value of HEADER_MAXSIZE in
14428 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14429 sections are rejected.
14430
14431
14432 .option header_line_maxsize main integer 0
14433 .cindex "header lines" "maximum size of"
14434 .cindex "limit" "size of one header line"
14435 This option limits the length of any individual header line in a message, after
14436 all the continuations have been joined together. Messages with individual
14437 header lines that are longer than the limit are rejected. The default value of
14438 zero means &"no limit"&.
14439
14440
14441
14442
14443 .option helo_accept_junk_hosts main "host list&!!" unset
14444 .cindex "HELO" "accepting junk data"
14445 .cindex "EHLO" "accepting junk data"
14446 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14447 mail, and gives an error response for invalid data. Unfortunately, there are
14448 some SMTP clients that send syntactic junk. They can be accommodated by setting
14449 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14450 if you want to do semantic checking.
14451 See also &%helo_allow_chars%& for a way of extending the permitted character
14452 set.
14453
14454
14455 .option helo_allow_chars main string unset
14456 .cindex "HELO" "underscores in"
14457 .cindex "EHLO" "underscores in"
14458 .cindex "underscore in EHLO/HELO"
14459 This option can be set to a string of rogue characters that are permitted in
14460 all EHLO and HELO names in addition to the standard letters, digits,
14461 hyphens, and dots. If you really must allow underscores, you can set
14462 .code
14463 helo_allow_chars = _
14464 .endd
14465 Note that the value is one string, not a list.
14466
14467
14468 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14469 .cindex "HELO" "forcing reverse lookup"
14470 .cindex "EHLO" "forcing reverse lookup"
14471 If the domain given by a client in a HELO or EHLO command matches this
14472 list, a reverse lookup is done in order to establish the host's true name. The
14473 default forces a lookup if the client host gives the server's name or any of
14474 its IP addresses (in brackets), something that broken clients have been seen to
14475 do.
14476
14477
14478 .option helo_try_verify_hosts main "host list&!!" unset
14479 .cindex "HELO verifying" "optional"
14480 .cindex "EHLO" "verifying, optional"
14481 By default, Exim just checks the syntax of HELO and EHLO commands (see
14482 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14483 to do more extensive checking of the data supplied by these commands. The ACL
14484 condition &`verify = helo`& is provided to make this possible.
14485 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14486 to force the check to occur. From release 4.53 onwards, this is no longer
14487 necessary. If the check has not been done before &`verify = helo`& is
14488 encountered, it is done at that time. Consequently, this option is obsolete.
14489 Its specification is retained here for backwards compatibility.
14490
14491 When an EHLO or HELO command is received, if the calling host matches
14492 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14493 EHLO command either:
14494
14495 .ilist
14496 is an IP literal matching the calling address of the host, or
14497 .next
14498 .cindex "DNS" "reverse lookup"
14499 .cindex "reverse DNS lookup"
14500 matches the host name that Exim obtains by doing a reverse lookup of the
14501 calling host address, or
14502 .next
14503 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14504 available) yields the calling host address.
14505 .endlist
14506
14507 However, the EHLO or HELO command is not rejected if any of the checks
14508 fail. Processing continues, but the result of the check is remembered, and can
14509 be detected later in an ACL by the &`verify = helo`& condition.
14510
14511 .option helo_verify_hosts main "host list&!!" unset
14512 .cindex "HELO verifying" "mandatory"
14513 .cindex "EHLO" "verifying, mandatory"
14514 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14515 backwards compatibility. For hosts that match this option, Exim checks the host
14516 name given in the HELO or EHLO in the same way as for
14517 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14518 rejected with a 550 error, and entries are written to the main and reject logs.
14519 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14520 error.
14521
14522 .option hold_domains main "domain list&!!" unset
14523 .cindex "domain" "delaying delivery"
14524 .cindex "delivery" "delaying certain domains"
14525 This option allows mail for particular domains to be held on the queue
14526 manually. The option is overridden if a message delivery is forced with the
14527 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14528 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14529 item in &%hold_domains%&, no routing or delivery for that address is done, and
14530 it is deferred every time the message is looked at.
14531
14532 This option is intended as a temporary operational measure for delaying the
14533 delivery of mail while some problem is being sorted out, or some new
14534 configuration tested. If you just want to delay the processing of some
14535 domains until a queue run occurs, you should use &%queue_domains%& or
14536 &%queue_smtp_domains%&, not &%hold_domains%&.
14537
14538 A setting of &%hold_domains%& does not override Exim's code for removing
14539 messages from the queue if they have been there longer than the longest retry
14540 time in any retry rule. If you want to hold messages for longer than the normal
14541 retry times, insert a dummy retry rule with a long retry time.
14542
14543
14544 .option host_lookup main "host list&!!" unset
14545 .cindex "host name" "lookup, forcing"
14546 Exim does not look up the name of a calling host from its IP address unless it
14547 is required to compare against some host list, or the host matches
14548 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14549 option (which normally contains IP addresses rather than host names). The
14550 default configuration file contains
14551 .code
14552 host_lookup = *
14553 .endd
14554 which causes a lookup to happen for all hosts. If the expense of these lookups
14555 is felt to be too great, the setting can be changed or removed.
14556
14557 After a successful reverse lookup, Exim does a forward lookup on the name it
14558 has obtained, to verify that it yields the IP address that it started with. If
14559 this check fails, Exim behaves as if the name lookup failed.
14560
14561 .vindex "&$host_lookup_failed$&"
14562 .vindex "&$sender_host_name$&"
14563 After any kind of failure, the host name (in &$sender_host_name$&) remains
14564 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14565 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14566 &`verify = reverse_host_lookup`& in ACLs.
14567
14568
14569 .option host_lookup_order main "string list" &`bydns:byaddr`&
14570 This option specifies the order of different lookup methods when Exim is trying
14571 to find a host name from an IP address. The default is to do a DNS lookup
14572 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14573 if that fails. You can change the order of these lookups, or omit one entirely,
14574 if you want.
14575
14576 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14577 multiple PTR records in the DNS and the IP address is not listed in
14578 &_/etc/hosts_&. Different operating systems give different results in this
14579 case. That is why the default tries a DNS lookup first.
14580
14581
14582
14583 .option host_reject_connection main "host list&!!" unset
14584 .cindex "host" "rejecting connections from"
14585 If this option is set, incoming SMTP calls from the hosts listed are rejected
14586 as soon as the connection is made.
14587 This option is obsolete, and retained only for backward compatibility, because
14588 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14589 connections immediately.
14590
14591 The ability to give an immediate rejection (either by this option or using an
14592 ACL) is provided for use in unusual cases. Many hosts will just try again,
14593 sometimes without much delay. Normally, it is better to use an ACL to reject
14594 incoming messages at a later stage, such as after RCPT commands. See
14595 chapter &<<CHAPACL>>&.
14596
14597
14598 .option hosts_connection_nolog main "host list&!!" unset
14599 .cindex "host" "not logging connections from"
14600 This option defines a list of hosts for which connection logging does not
14601 happen, even though the &%smtp_connection%& log selector is set. For example,
14602 you might want not to log SMTP connections from local processes, or from
14603 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14604 the daemon; you should therefore strive to restrict its value to a short inline
14605 list of IP addresses and networks. To disable logging SMTP connections from
14606 local processes, you must create a host list with an empty item. For example:
14607 .code
14608 hosts_connection_nolog = :
14609 .endd
14610 If the &%smtp_connection%& log selector is not set, this option has no effect.
14611
14612
14613
14614 .option hosts_treat_as_local main "domain list&!!" unset
14615 .cindex "local host" "domains treated as"
14616 .cindex "host" "treated as local"
14617 If this option is set, any host names that match the domain list are treated as
14618 if they were the local host when Exim is scanning host lists obtained from MX
14619 records
14620 or other sources. Note that the value of this option is a domain list, not a
14621 host list, because it is always used to check host names, not IP addresses.
14622
14623 This option also applies when Exim is matching the special items
14624 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14625 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14626 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14627 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14628 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14629 interfaces and recognizing the local host.
14630
14631
14632 .option ibase_servers main "string list" unset
14633 .cindex "InterBase" "server list"
14634 This option provides a list of InterBase servers and associated connection data,
14635 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14636 The option is available only if Exim has been built with InterBase support.
14637
14638
14639
14640 .option ignore_bounce_errors_after main time 10w
14641 .cindex "bounce message" "discarding"
14642 .cindex "discarding bounce message"
14643 This option affects the processing of bounce messages that cannot be delivered,
14644 that is, those that suffer a permanent delivery failure. (Bounce messages that
14645 suffer temporary delivery failures are of course retried in the usual way.)
14646
14647 After a permanent delivery failure, bounce messages are frozen,
14648 because there is no sender to whom they can be returned. When a frozen bounce
14649 message has been on the queue for more than the given time, it is unfrozen at
14650 the next queue run, and a further delivery is attempted. If delivery fails
14651 again, the bounce message is discarded. This makes it possible to keep failed
14652 bounce messages around for a shorter time than the normal maximum retry time
14653 for frozen messages. For example,
14654 .code
14655 ignore_bounce_errors_after = 12h
14656 .endd
14657 retries failed bounce message deliveries after 12 hours, discarding any further
14658 failures. If the value of this option is set to a zero time period, bounce
14659 failures are discarded immediately. Setting a very long time (as in the default
14660 value) has the effect of disabling this option. For ways of automatically
14661 dealing with other kinds of frozen message, see &%auto_thaw%& and
14662 &%timeout_frozen_after%&.
14663
14664
14665 .option ignore_fromline_hosts main "host list&!!" unset
14666 .cindex "&""From""& line"
14667 .cindex "UUCP" "&""From""& line"
14668 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14669 the headers of a message. By default this is treated as the start of the
14670 message's body, which means that any following headers are not recognized as
14671 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14672 match those hosts that insist on sending it. If the sender is actually a local
14673 process rather than a remote host, and is using &%-bs%& to inject the messages,
14674 &%ignore_fromline_local%& must be set to achieve this effect.
14675
14676
14677 .option ignore_fromline_local main boolean false
14678 See &%ignore_fromline_hosts%& above.
14679
14680
14681 .option keep_malformed main time 4d
14682 This option specifies the length of time to keep messages whose spool files
14683 have been corrupted in some way. This should, of course, never happen. At the
14684 next attempt to deliver such a message, it gets removed. The incident is
14685 logged.
14686
14687
14688 .option ldap_ca_cert_dir main string unset
14689 .cindex "LDAP", "TLS CA certificate directory"
14690 This option indicates which directory contains CA certificates for verifying
14691 a TLS certificate presented by an LDAP server.
14692 While Exim does not provide a default value, your SSL library may.
14693 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14694 and constrained to be a directory.
14695
14696
14697 .option ldap_ca_cert_file main string unset
14698 .cindex "LDAP", "TLS CA certificate file"
14699 This option indicates which file contains CA certificates for verifying
14700 a TLS certificate presented by an LDAP server.
14701 While Exim does not provide a default value, your SSL library may.
14702 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14703 and constrained to be a file.
14704
14705
14706 .option ldap_cert_file main string unset
14707 .cindex "LDAP" "TLS client certificate file"
14708 This option indicates which file contains an TLS client certificate which
14709 Exim should present to the LDAP server during TLS negotiation.
14710 Should be used together with &%ldap_cert_key%&.
14711
14712
14713 .option ldap_cert_key main string unset
14714 .cindex "LDAP" "TLS client key file"
14715 This option indicates which file contains the secret/private key to use
14716 to prove identity to the LDAP server during TLS negotiation.
14717 Should be used together with &%ldap_cert_file%&, which contains the
14718 identity to be proven.
14719
14720
14721 .option ldap_cipher_suite main string unset
14722 .cindex "LDAP" "TLS cipher suite"
14723 This controls the TLS cipher-suite negotiation during TLS negotiation with
14724 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14725 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14726
14727
14728 .option ldap_default_servers main "string list" unset
14729 .cindex "LDAP" "default servers"
14730 This option provides a list of LDAP servers which are tried in turn when an
14731 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14732 details of LDAP queries. This option is available only when Exim has been built
14733 with LDAP support.
14734
14735
14736 .option ldap_require_cert main string unset.
14737 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14738 This should be one of the values "hard", "demand", "allow", "try" or "never".
14739 A value other than one of these is interpreted as "never".
14740 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14741 Although Exim does not set a default, the LDAP library probably defaults
14742 to hard/demand.
14743
14744
14745 .option ldap_start_tls main boolean false
14746 .cindex "LDAP" "whether or not to negotiate TLS"
14747 If set, Exim will attempt to negotiate TLS with the LDAP server when
14748 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14749 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14750 of SSL-on-connect.
14751 In the event of failure to negotiate TLS, the action taken is controlled
14752 by &%ldap_require_cert%&.
14753
14754
14755 .option ldap_version main integer unset
14756 .cindex "LDAP" "protocol version, forcing"
14757 This option can be used to force Exim to set a specific protocol version for
14758 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14759 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14760 the LDAP headers; otherwise it is 2. This option is available only when Exim
14761 has been built with LDAP support.
14762
14763
14764
14765 .option local_from_check main boolean true
14766 .cindex "&'Sender:'& header line" "disabling addition of"
14767 .cindex "&'From:'& header line" "disabling checking of"
14768 When a message is submitted locally (that is, not over a TCP/IP connection) by
14769 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14770 checks that the &'From:'& header line matches the login of the calling user and
14771 the domain specified by &%qualify_domain%&.
14772
14773 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14774 locally submitted message is automatically qualified by Exim, unless the
14775 &%-bnq%& command line option is used.
14776
14777 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14778 on the local part. If the &'From:'& header line does not match, Exim adds a
14779 &'Sender:'& header with an address constructed from the calling user's login
14780 and the default qualify domain.
14781
14782 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14783 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14784 &'Sender:'& header lines supplied by untrusted users, you must also set
14785 &%local_sender_retain%& to be true.
14786
14787 .cindex "envelope sender"
14788 These options affect only the header lines in the message. The envelope sender
14789 is still forced to be the login id at the qualify domain unless
14790 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14791
14792 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14793 request similar header line checking. See section &<<SECTthesenhea>>&, which
14794 has more details about &'Sender:'& processing.
14795
14796
14797
14798
14799 .option local_from_prefix main string unset
14800 When Exim checks the &'From:'& header line of locally submitted messages for
14801 matching the login id (see &%local_from_check%& above), it can be configured to
14802 ignore certain prefixes and suffixes in the local part of the address. This is
14803 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14804 appropriate lists, in the same form as the &%local_part_prefix%& and
14805 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14806 example, if
14807 .code
14808 local_from_prefix = *-
14809 .endd
14810 is set, a &'From:'& line containing
14811 .code
14812 From: anything-user@your.domain.example
14813 .endd
14814 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14815 matches the actual sender address that is constructed from the login name and
14816 qualify domain.
14817
14818
14819 .option local_from_suffix main string unset
14820 See &%local_from_prefix%& above.
14821
14822
14823 .option local_interfaces main "string list" "see below"
14824 This option controls which network interfaces are used by the daemon for
14825 listening; they are also used to identify the local host when routing. Chapter
14826 &<<CHAPinterfaces>>& contains a full description of this option and the related
14827 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14828 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14829 &%local_interfaces%& is
14830 .code
14831 local_interfaces = 0.0.0.0
14832 .endd
14833 when Exim is built without IPv6 support; otherwise it is
14834 .code
14835 local_interfaces = <; ::0 ; 0.0.0.0
14836 .endd
14837
14838 .option local_scan_timeout main time 5m
14839 .cindex "timeout" "for &[local_scan()]& function"
14840 .cindex "&[local_scan()]& function" "timeout"
14841 This timeout applies to the &[local_scan()]& function (see chapter
14842 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14843 the incoming message is rejected with a temporary error if it is an SMTP
14844 message. For a non-SMTP message, the message is dropped and Exim ends with a
14845 non-zero code. The incident is logged on the main and reject logs.
14846
14847
14848
14849 .option local_sender_retain main boolean false
14850 .cindex "&'Sender:'& header line" "retaining from local submission"
14851 When a message is submitted locally (that is, not over a TCP/IP connection) by
14852 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14853 do not want this to happen, you must set &%local_sender_retain%&, and you must
14854 also set &%local_from_check%& to be false (Exim will complain if you do not).
14855 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14856 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14857
14858
14859
14860
14861 .option localhost_number main string&!! unset
14862 .cindex "host" "locally unique number for"
14863 .cindex "message ids" "with multiple hosts"
14864 .vindex "&$localhost_number$&"
14865 Exim's message ids are normally unique only within the local host. If
14866 uniqueness among a set of hosts is required, each host must set a different
14867 value for the &%localhost_number%& option. The string is expanded immediately
14868 after reading the configuration file (so that a number can be computed from the
14869 host name, for example) and the result of the expansion must be a number in the
14870 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14871 systems). This is available in subsequent string expansions via the variable
14872 &$localhost_number$&. When &%localhost_number is set%&, the final two
14873 characters of the message id, instead of just being a fractional part of the
14874 time, are computed from the time and the local host number as described in
14875 section &<<SECTmessiden>>&.
14876
14877
14878
14879 .option log_file_path main "string list&!!" "set at compile time"
14880 .cindex "log" "file path for"
14881 This option sets the path which is used to determine the names of Exim's log
14882 files, or indicates that logging is to be to syslog, or both. It is expanded
14883 when Exim is entered, so it can, for example, contain a reference to the host
14884 name. If no specific path is set for the log files at compile or run time, they
14885 are written in a sub-directory called &_log_& in Exim's spool directory.
14886 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14887 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14888 used. If this string is fixed at your installation (contains no expansion
14889 variables) it is recommended that you do not set this option in the
14890 configuration file, but instead supply the path using LOG_FILE_PATH in
14891 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14892 early on &-- in particular, failure to read the configuration file.
14893
14894
14895 .option log_selector main string unset
14896 .cindex "log" "selectors"
14897 This option can be used to reduce or increase the number of things that Exim
14898 writes to its log files. Its argument is made up of names preceded by plus or
14899 minus characters. For example:
14900 .code
14901 log_selector = +arguments -retry_defer
14902 .endd
14903 A list of possible names and what they control is given in the chapter on
14904 logging, in section &<<SECTlogselector>>&.
14905
14906
14907 .option log_timezone main boolean false
14908 .cindex "log" "timezone for entries"
14909 .vindex "&$tod_log$&"
14910 .vindex "&$tod_zone$&"
14911 By default, the timestamps on log lines are in local time without the
14912 timezone. This means that if your timezone changes twice a year, the timestamps
14913 in log lines are ambiguous for an hour when the clocks go back. One way of
14914 avoiding this problem is to set the timezone to UTC. An alternative is to set
14915 &%log_timezone%& true. This turns on the addition of the timezone offset to
14916 timestamps in log lines. Turning on this option can add quite a lot to the size
14917 of log files because each line is extended by 6 characters. Note that the
14918 &$tod_log$& variable contains the log timestamp without the zone, but there is
14919 another variable called &$tod_zone$& that contains just the timezone offset.
14920
14921
14922 .option lookup_open_max main integer 25
14923 .cindex "too many open files"
14924 .cindex "open files, too many"
14925 .cindex "file" "too many open"
14926 .cindex "lookup" "maximum open files"
14927 .cindex "limit" "open files for lookups"
14928 This option limits the number of simultaneously open files for single-key
14929 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14930 Exim normally keeps these files open during routing, because often the same
14931 file is required several times. If the limit is reached, Exim closes the least
14932 recently used file. Note that if you are using the &'ndbm'& library, it
14933 actually opens two files for each logical DBM database, though it still counts
14934 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14935 open files"& errors with NDBM, you need to reduce the value of
14936 &%lookup_open_max%&.
14937
14938
14939 .option max_username_length main integer 0
14940 .cindex "length of login name"
14941 .cindex "user name" "maximum length"
14942 .cindex "limit" "user name length"
14943 Some operating systems are broken in that they truncate long arguments to
14944 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14945 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14946 an argument that is longer behaves as if &[getpwnam()]& failed.
14947
14948
14949 .option message_body_newlines main bool false
14950 .cindex "message body" "newlines in variables"
14951 .cindex "newline" "in message body variables"
14952 .vindex "&$message_body$&"
14953 .vindex "&$message_body_end$&"
14954 By default, newlines in the message body are replaced by spaces when setting
14955 the &$message_body$& and &$message_body_end$& expansion variables. If this
14956 option is set true, this no longer happens.
14957
14958
14959 .option message_body_visible main integer 500
14960 .cindex "body of message" "visible size"
14961 .cindex "message body" "visible size"
14962 .vindex "&$message_body$&"
14963 .vindex "&$message_body_end$&"
14964 This option specifies how much of a message's body is to be included in the
14965 &$message_body$& and &$message_body_end$& expansion variables.
14966
14967
14968 .option message_id_header_domain main string&!! unset
14969 .cindex "&'Message-ID:'& header line"
14970 If this option is set, the string is expanded and used as the right hand side
14971 (domain) of the &'Message-ID:'& header that Exim creates if a
14972 locally-originated incoming message does not have one. &"Locally-originated"&
14973 means &"not received over TCP/IP."&
14974 Otherwise, the primary host name is used.
14975 Only letters, digits, dot and hyphen are accepted; any other characters are
14976 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14977 empty string, the option is ignored.
14978
14979
14980 .option message_id_header_text main string&!! unset
14981 If this variable is set, the string is expanded and used to augment the text of
14982 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14983 message does not have one. The text of this header is required by RFC 2822 to
14984 take the form of an address. By default, Exim uses its internal message id as
14985 the local part, and the primary host name as the domain. If this option is set,
14986 it is expanded, and provided the expansion is not forced to fail, and does not
14987 yield an empty string, the result is inserted into the header immediately
14988 before the @, separated from the internal message id by a dot. Any characters
14989 that are illegal in an address are automatically converted into hyphens. This
14990 means that variables such as &$tod_log$& can be used, because the spaces and
14991 colons will become hyphens.
14992
14993
14994 .option message_logs main boolean true
14995 .cindex "message logs" "disabling"
14996 .cindex "log" "message log; disabling"
14997 If this option is turned off, per-message log files are not created in the
14998 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14999 Exim, by reducing the number of files involved in handling a message from a
15000 minimum of four (header spool file, body spool file, delivery journal, and
15001 per-message log) to three. The other major I/O activity is Exim's main log,
15002 which is not affected by this option.
15003
15004
15005 .option message_size_limit main string&!! 50M
15006 .cindex "message" "size limit"
15007 .cindex "limit" "message size"
15008 .cindex "size" "of message, limit"
15009 This option limits the maximum size of message that Exim will process. The
15010 value is expanded for each incoming connection so, for example, it can be made
15011 to depend on the IP address of the remote host for messages arriving via
15012 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15013 optionally followed by K or M.
15014
15015 &*Note*&: This limit cannot be made to depend on a message's sender or any
15016 other properties of an individual message, because it has to be advertised in
15017 the server's response to EHLO. String expansion failure causes a temporary
15018 error. A value of zero means no limit, but its use is not recommended. See also
15019 &%bounce_return_size_limit%&.
15020
15021 Incoming SMTP messages are failed with a 552 error if the limit is
15022 exceeded; locally-generated messages either get a stderr message or a delivery
15023 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15024 an oversized message is logged in both the main and the reject logs. See also
15025 the generic transport option &%message_size_limit%&, which limits the size of
15026 message that an individual transport can process.
15027
15028 If you use a virus-scanner and set this option to to a value larger than the
15029 maximum size that your virus-scanner is configured to support, you may get
15030 failures triggered by large mails.  The right size to configure for the
15031 virus-scanner depends upon what data is passed and the options in use but it's
15032 probably safest to just set it to a little larger than this value.  Eg, with a
15033 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15034 some problems may result.
15035
15036 A value of 0 will disable size limit checking; Exim will still advertise the
15037 SIZE extension in an EHLO response, but without a limit, so as to permit
15038 SMTP clients to still indicate the message size along with the MAIL verb.
15039
15040
15041 .option move_frozen_messages main boolean false
15042 .cindex "frozen messages" "moving"
15043 This option, which is available only if Exim has been built with the setting
15044 .code
15045 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15046 .endd
15047 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15048 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15049 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15050 standard utilities for handling such moved messages, and they do not show up in
15051 lists generated by &%-bp%& or by the Exim monitor.
15052
15053
15054 .option mua_wrapper main boolean false
15055 Setting this option true causes Exim to run in a very restrictive mode in which
15056 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15057 contains a full description of this facility.
15058
15059
15060
15061 .option mysql_servers main "string list" unset
15062 .cindex "MySQL" "server list"
15063 This option provides a list of MySQL servers and associated connection data, to
15064 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15065 option is available only if Exim has been built with MySQL support.
15066
15067
15068 .option never_users main "string list&!!" unset
15069 This option is expanded just once, at the start of Exim's processing. Local
15070 message deliveries are normally run in processes that are setuid to the
15071 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15072 It is usually desirable to prevent any deliveries from running as root, as a
15073 safety precaution.
15074
15075 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15076 list of users that must not be used for local deliveries. This list is fixed in
15077 the binary and cannot be overridden by the configuration file. By default, it
15078 contains just the single user name &"root"&. The &%never_users%& runtime option
15079 can be used to add more users to the fixed list.
15080
15081 If a message is to be delivered as one of the users on the fixed list or the
15082 &%never_users%& list, an error occurs, and delivery is deferred. A common
15083 example is
15084 .code
15085 never_users = root:daemon:bin
15086 .endd
15087 Including root is redundant if it is also on the fixed list, but it does no
15088 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15089 transport driver.
15090
15091
15092 .option openssl_options main "string list" "+no_sslv2"
15093 .cindex "OpenSSL "compatibility options"
15094 This option allows an administrator to adjust the SSL options applied
15095 by OpenSSL to connections.  It is given as a space-separated list of items,
15096 each one to be +added or -subtracted from the current value.
15097
15098 This option is only available if Exim is built against OpenSSL.  The values
15099 available for this option vary according to the age of your OpenSSL install.
15100 The &"all"& value controls a subset of flags which are available, typically
15101 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15102 list the values known on your system and Exim should support all the
15103 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15104 names lose the leading &"SSL_OP_"& and are lower-cased.
15105
15106 Note that adjusting the options can have severe impact upon the security of
15107 SSL as used by Exim.  It is possible to disable safety checks and shoot
15108 yourself in the foot in various unpleasant ways.  This option should not be
15109 adjusted lightly.  An unrecognised item will be detected at startup, by
15110 invoking Exim with the &%-bV%& flag.
15111
15112 The option affects Exim operating both as a server and as a client.
15113
15114 Historical note: prior to release 4.80, Exim defaulted this value to
15115 "+dont_insert_empty_fragments", which may still be needed for compatibility
15116 with some clients, but which lowers security by increasing exposure to
15117 some now infamous attacks.
15118
15119 Examples:
15120 .code
15121 # Make both old MS and old Eudora happy:
15122 openssl_options = -all +microsoft_big_sslv3_buffer \
15123                        +dont_insert_empty_fragments
15124
15125 # Disable older protocol versions:
15126 openssl_options = +no_sslv2 +no_sslv3
15127 .endd
15128
15129 Possible options may include:
15130 .ilist
15131 &`all`&
15132 .next
15133 &`allow_unsafe_legacy_renegotiation`&
15134 .next
15135 &`cipher_server_preference`&
15136 .next
15137 &`dont_insert_empty_fragments`&
15138 .next
15139 &`ephemeral_rsa`&
15140 .next
15141 &`legacy_server_connect`&
15142 .next
15143 &`microsoft_big_sslv3_buffer`&
15144 .next
15145 &`microsoft_sess_id_bug`&
15146 .next
15147 &`msie_sslv2_rsa_padding`&
15148 .next
15149 &`netscape_challenge_bug`&
15150 .next
15151 &`netscape_reuse_cipher_change_bug`&
15152 .next
15153 &`no_compression`&
15154 .next
15155 &`no_session_resumption_on_renegotiation`&
15156 .next
15157 &`no_sslv2`&
15158 .next
15159 &`no_sslv3`&
15160 .next
15161 &`no_ticket`&
15162 .next
15163 &`no_tlsv1`&
15164 .next
15165 &`no_tlsv1_1`&
15166 .next
15167 &`no_tlsv1_2`&
15168 .next
15169 &`safari_ecdhe_ecdsa_bug`&
15170 .next
15171 &`single_dh_use`&
15172 .next
15173 &`single_ecdh_use`&
15174 .next
15175 &`ssleay_080_client_dh_bug`&
15176 .next
15177 &`sslref2_reuse_cert_type_bug`&
15178 .next
15179 &`tls_block_padding_bug`&
15180 .next
15181 &`tls_d5_bug`&
15182 .next
15183 &`tls_rollback_bug`&
15184 .endlist
15185
15186 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15187 all clients connecting using the MacOS SecureTransport TLS facility prior
15188 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15189 to negotiate TLS then this option value might help, provided that your OpenSSL
15190 release is new enough to contain this work-around.  This may be a situation
15191 where you have to upgrade OpenSSL to get buggy clients working.
15192
15193
15194 .option oracle_servers main "string list" unset
15195 .cindex "Oracle" "server list"
15196 This option provides a list of Oracle servers and associated connection data,
15197 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15198 The option is available only if Exim has been built with Oracle support.
15199
15200
15201 .option percent_hack_domains main "domain list&!!" unset
15202 .cindex "&""percent hack""&"
15203 .cindex "source routing" "in email address"
15204 .cindex "address" "source-routed"
15205 The &"percent hack"& is the convention whereby a local part containing a
15206 percent sign is re-interpreted as a new email address, with the percent
15207 replaced by @. This is sometimes called &"source routing"&, though that term is
15208 also applied to RFC 2822 addresses that begin with an @ character. If this
15209 option is set, Exim implements the percent facility for those domains listed,
15210 but no others. This happens before an incoming SMTP address is tested against
15211 an ACL.
15212
15213 &*Warning*&: The &"percent hack"& has often been abused by people who are
15214 trying to get round relaying restrictions. For this reason, it is best avoided
15215 if at all possible. Unfortunately, a number of less security-conscious MTAs
15216 implement it unconditionally. If you are running Exim on a gateway host, and
15217 routing mail through to internal MTAs without processing the local parts, it is
15218 a good idea to reject recipient addresses with percent characters in their
15219 local parts. Exim's default configuration does this.
15220
15221
15222 .option perl_at_start main boolean false
15223 This option is available only when Exim is built with an embedded Perl
15224 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15225
15226
15227 .option perl_startup main string unset
15228 This option is available only when Exim is built with an embedded Perl
15229 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15230
15231
15232 .option pgsql_servers main "string list" unset
15233 .cindex "PostgreSQL lookup type" "server list"
15234 This option provides a list of PostgreSQL servers and associated connection
15235 data, to be used in conjunction with &(pgsql)& lookups (see section
15236 &<<SECID72>>&). The option is available only if Exim has been built with
15237 PostgreSQL support.
15238
15239
15240 .option pid_file_path main string&!! "set at compile time"
15241 .cindex "daemon" "pid file path"
15242 .cindex "pid file, path for"
15243 This option sets the name of the file to which the Exim daemon writes its
15244 process id. The string is expanded, so it can contain, for example, references
15245 to the host name:
15246 .code
15247 pid_file_path = /var/log/$primary_hostname/exim.pid
15248 .endd
15249 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15250 spool directory.
15251 The value set by the option can be overridden by the &%-oP%& command line
15252 option. A pid file is not written if a &"non-standard"& daemon is run by means
15253 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15254
15255
15256 .option pipelining_advertise_hosts main "host list&!!" *
15257 .cindex "PIPELINING" "suppressing advertising"
15258 This option can be used to suppress the advertisement of the SMTP
15259 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15260 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15261 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15262 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15263 that clients will use it; &"out of order"& commands that are &"expected"& do
15264 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15265
15266
15267 .option prdr_enable main boolean false
15268 .cindex "PRDR" "enabling on server"
15269 This option can be used to enable the Per-Recipient Data Response extension
15270 to SMTP, defined by Eric Hall.
15271 If the option is set, PRDR is advertised by Exim when operating as a server.
15272 If the client requests PRDR, and more than one recipient, for a message 
15273 an additional ACL is called for each recipient after the message content
15274 is recieved.  See section &<<SECTPRDRACL>>&.
15275
15276 .option preserve_message_logs main boolean false
15277 .cindex "message logs" "preserving"
15278 If this option is set, message log files are not deleted when messages are
15279 completed. Instead, they are moved to a sub-directory of the spool directory
15280 called &_msglog.OLD_&, where they remain available for statistical or debugging
15281 purposes. This is a dangerous option to set on systems with any appreciable
15282 volume of mail. Use with care!
15283
15284
15285 .option primary_hostname main string "see below"
15286 .cindex "name" "of local host"
15287 .cindex "host" "name of local"
15288 .cindex "local host" "name of"
15289 .vindex "&$primary_hostname$&"
15290 This specifies the name of the current host. It is used in the default EHLO or
15291 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15292 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15293 The value is also used by default in some SMTP response messages from an Exim
15294 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15295
15296 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15297 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15298 contains only one component, Exim passes it to &[gethostbyname()]& (or
15299 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15300 version. The variable &$primary_hostname$& contains the host name, whether set
15301 explicitly by this option, or defaulted.
15302
15303
15304 .option print_topbitchars main boolean false
15305 .cindex "printing characters"
15306 .cindex "8-bit characters"
15307 By default, Exim considers only those characters whose codes lie in the range
15308 32&--126 to be printing characters. In a number of circumstances (for example,
15309 when writing log entries) non-printing characters are converted into escape
15310 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15311 is set, code values of 128 and above are also considered to be printing
15312 characters.
15313
15314 This option also affects the header syntax checks performed by the
15315 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15316 the user's full name when constructing From: and Sender: addresses (as
15317 described in section &<<SECTconstr>>&). Setting this option can cause
15318 Exim to generate eight bit message headers that do not conform to the
15319 standards.
15320
15321
15322 .option process_log_path main string unset
15323 .cindex "process log path"
15324 .cindex "log" "process log"
15325 .cindex "&'exiwhat'&"
15326 This option sets the name of the file to which an Exim process writes its
15327 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15328 utility script. If this option is unset, the file called &_exim-process.info_&
15329 in Exim's spool directory is used. The ability to specify the name explicitly
15330 can be useful in environments where two different Exims are running, using
15331 different spool directories.
15332
15333
15334 .option prod_requires_admin main boolean true
15335 .oindex "&%-M%&"
15336 .oindex "&%-R%&"
15337 .oindex "&%-q%&"
15338 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15339 admin user unless &%prod_requires_admin%& is set false. See also
15340 &%queue_list_requires_admin%&.
15341
15342
15343 .option qualify_domain main string "see below"
15344 .cindex "domain" "for qualifying addresses"
15345 .cindex "address" "qualification"
15346 This option specifies the domain name that is added to any envelope sender
15347 addresses that do not have a domain qualification. It also applies to
15348 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15349 are accepted by default only for locally-generated messages. Qualification is
15350 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15351 locally-generated messages, unless the &%-bnq%& command line option is used.
15352
15353 Messages from external sources must always contain fully qualified addresses,
15354 unless the sending host matches &%sender_unqualified_hosts%& or
15355 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15356 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15357 necessary. Internally, Exim always works with fully qualified envelope
15358 addresses. If &%qualify_domain%& is not set, it defaults to the
15359 &%primary_hostname%& value.
15360
15361
15362 .option qualify_recipient main string "see below"
15363 This option allows you to specify a different domain for qualifying recipient
15364 addresses to the one that is used for senders. See &%qualify_domain%& above.
15365
15366
15367
15368 .option queue_domains main "domain list&!!" unset
15369 .cindex "domain" "specifying non-immediate delivery"
15370 .cindex "queueing incoming messages"
15371 .cindex "message" "queueing certain domains"
15372 This option lists domains for which immediate delivery is not required.
15373 A delivery process is started whenever a message is received, but only those
15374 domains that do not match are processed. All other deliveries wait until the
15375 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15376
15377
15378 .option queue_list_requires_admin main boolean true
15379 .oindex "&%-bp%&"
15380 The &%-bp%& command-line option, which lists the messages that are on the
15381 queue, requires the caller to be an admin user unless
15382 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15383
15384
15385 .option queue_only main boolean false
15386 .cindex "queueing incoming messages"
15387 .cindex "message" "queueing unconditionally"
15388 If &%queue_only%& is set, a delivery process is not automatically started
15389 whenever a message is received. Instead, the message waits on the queue for the
15390 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15391 delivered immediately when certain conditions (such as heavy load) occur.
15392
15393 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15394 and &%-odi%& command line options override &%queue_only%& unless
15395 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15396 &%queue_only_load%&, and &%smtp_accept_queue%&.
15397
15398
15399 .option queue_only_file main string unset
15400 .cindex "queueing incoming messages"
15401 .cindex "message" "queueing by file existence"
15402 This option can be set to a colon-separated list of absolute path names, each
15403 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15404 it tests for the existence of each listed path using a call to &[stat()]&. For
15405 each path that exists, the corresponding queueing option is set.
15406 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15407 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15408 .code
15409 queue_only_file = smtp/some/file
15410 .endd
15411 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15412 &_/some/file_& exists.
15413
15414
15415 .option queue_only_load main fixed-point unset
15416 .cindex "load average"
15417 .cindex "queueing incoming messages"
15418 .cindex "message" "queueing by load"
15419 If the system load average is higher than this value, incoming messages from
15420 all sources are queued, and no automatic deliveries are started. If this
15421 happens during local or remote SMTP input, all subsequent messages received on
15422 the same SMTP connection are queued by default, whatever happens to the load in
15423 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15424 false.
15425
15426 Deliveries will subsequently be performed by queue runner processes. This
15427 option has no effect on ancient operating systems on which Exim cannot
15428 determine the load average. See also &%deliver_queue_load_max%& and
15429 &%smtp_load_reserve%&.
15430
15431
15432 .option queue_only_load_latch main boolean true
15433 .cindex "load average" "re-evaluating per message"
15434 When this option is true (the default), once one message has been queued
15435 because the load average is higher than the value set by &%queue_only_load%&,
15436 all subsequent messages received on the same SMTP connection are also queued.
15437 This is a deliberate choice; even though the load average may fall below the
15438 threshold, it doesn't seem right to deliver later messages on the same
15439 connection when not delivering earlier ones. However, there are special
15440 circumstances such as very long-lived connections from scanning appliances
15441 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15442 should be set false. This causes the value of the load average to be
15443 re-evaluated for each message.
15444
15445
15446 .option queue_only_override main boolean true
15447 .cindex "queueing incoming messages"
15448 When this option is true, the &%-od%&&'x'& command line options override the
15449 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15450 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15451 to override; they are accepted, but ignored.
15452
15453
15454 .option queue_run_in_order main boolean false
15455 .cindex "queue runner" "processing messages in order"
15456 If this option is set, queue runs happen in order of message arrival instead of
15457 in an arbitrary order. For this to happen, a complete list of the entire queue
15458 must be set up before the deliveries start. When the queue is all held in a
15459 single directory (the default), a single list is created for both the ordered
15460 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15461 single list is not created when &%queue_run_in_order%& is false. In this case,
15462 the sub-directories are processed one at a time (in a random order), and this
15463 avoids setting up one huge list for the whole queue. Thus, setting
15464 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15465 when the queue is large, because of the extra work in setting up the single,
15466 large list. In most situations, &%queue_run_in_order%& should not be set.
15467
15468
15469
15470 .option queue_run_max main integer 5
15471 .cindex "queue runner" "maximum number of"
15472 This controls the maximum number of queue runner processes that an Exim daemon
15473 can run simultaneously. This does not mean that it starts them all at once,
15474 but rather that if the maximum number are still running when the time comes to
15475 start another one, it refrains from starting another one. This can happen with
15476 very large queues and/or very sluggish deliveries. This option does not,
15477 however, interlock with other processes, so additional queue runners can be
15478 started by other means, or by killing and restarting the daemon.
15479
15480 Setting this option to zero does not suppress queue runs; rather, it disables
15481 the limit, allowing any number of simultaneous queue runner processes to be
15482 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15483 the daemon's command line.
15484
15485 .option queue_smtp_domains main "domain list&!!" unset
15486 .cindex "queueing incoming messages"
15487 .cindex "message" "queueing remote deliveries"
15488 When this option is set, a delivery process is started whenever a message is
15489 received, routing is performed, and local deliveries take place.
15490 However, if any SMTP deliveries are required for domains that match
15491 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15492 message waits on the queue for the next queue run. Since routing of the message
15493 has taken place, Exim knows to which remote hosts it must be delivered, and so
15494 when the queue run happens, multiple messages for the same host are delivered
15495 over a single SMTP connection. The &%-odqs%& command line option causes all
15496 SMTP deliveries to be queued in this way, and is equivalent to setting
15497 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15498 &%queue_domains%&.
15499
15500
15501 .option receive_timeout main time 0s
15502 .cindex "timeout" "for non-SMTP input"
15503 This option sets the timeout for accepting a non-SMTP message, that is, the
15504 maximum time that Exim waits when reading a message on the standard input. If
15505 the value is zero, it will wait for ever. This setting is overridden by the
15506 &%-or%& command line option. The timeout for incoming SMTP messages is
15507 controlled by &%smtp_receive_timeout%&.
15508
15509 .option received_header_text main string&!! "see below"
15510 .cindex "customizing" "&'Received:'& header"
15511 .cindex "&'Received:'& header line" "customizing"
15512 This string defines the contents of the &'Received:'& message header that is
15513 added to each message, except for the timestamp, which is automatically added
15514 on at the end (preceded by a semicolon). The string is expanded each time it is
15515 used. If the expansion yields an empty string, no &'Received:'& header line is
15516 added to the message. Otherwise, the string should start with the text
15517 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15518 header lines. The default setting is:
15519
15520 .code
15521 received_header_text = Received: \
15522   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15523   {${if def:sender_ident \
15524   {from ${quote_local_part:$sender_ident} }}\
15525   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15526   by $primary_hostname \
15527   ${if def:received_protocol {with $received_protocol}} \
15528   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15529   (Exim $version_number)\n\t\
15530   ${if def:sender_address \
15531   {(envelope-from <$sender_address>)\n\t}}\
15532   id $message_exim_id\
15533   ${if def:received_for {\n\tfor $received_for}}
15534 .endd
15535
15536 The reference to the TLS cipher is omitted when Exim is built without TLS
15537 support. The use of conditional expansions ensures that this works for both
15538 locally generated messages and messages received from remote hosts, giving
15539 header lines such as the following:
15540 .code
15541 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15542 by marley.carol.example with esmtp (Exim 4.00)
15543 (envelope-from <bob@carol.example>)
15544 id 16IOWa-00019l-00
15545 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15546 Received: by scrooge.carol.example with local (Exim 4.00)
15547 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15548 .endd
15549 Until the body of the message has been received, the timestamp is the time when
15550 the message started to be received. Once the body has arrived, and all policy
15551 checks have taken place, the timestamp is updated to the time at which the
15552 message was accepted.
15553
15554
15555 .option received_headers_max main integer 30
15556 .cindex "loop" "prevention"
15557 .cindex "mail loop prevention"
15558 .cindex "&'Received:'& header line" "counting"
15559 When a message is to be delivered, the number of &'Received:'& headers is
15560 counted, and if it is greater than this parameter, a mail loop is assumed to
15561 have occurred, the delivery is abandoned, and an error message is generated.
15562 This applies to both local and remote deliveries.
15563
15564
15565 .option recipient_unqualified_hosts main "host list&!!" unset
15566 .cindex "unqualified addresses"
15567 .cindex "host" "unqualified addresses from"
15568 This option lists those hosts from which Exim is prepared to accept unqualified
15569 recipient addresses in message envelopes. The addresses are made fully
15570 qualified by the addition of the &%qualify_recipient%& value. This option also
15571 affects message header lines. Exim does not reject unqualified recipient
15572 addresses in headers, but it qualifies them only if the message came from a
15573 host that matches &%recipient_unqualified_hosts%&,
15574 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15575 option was not set.
15576
15577
15578 .option recipients_max main integer 0
15579 .cindex "limit" "number of recipients"
15580 .cindex "recipient" "maximum number"
15581 If this option is set greater than zero, it specifies the maximum number of
15582 original recipients for any message. Additional recipients that are generated
15583 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15584 all recipients over the limit; earlier recipients are delivered as normal.
15585 Non-SMTP messages with too many recipients are failed, and no deliveries are
15586 done.
15587
15588 .cindex "RCPT" "maximum number of incoming"
15589 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15590 RCPT commands in a single message.
15591
15592
15593 .option recipients_max_reject main boolean false
15594 If this option is set true, Exim rejects SMTP messages containing too many
15595 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15596 error to the eventual DATA command. Otherwise (the default) it gives a 452
15597 error to the surplus RCPT commands and accepts the message on behalf of the
15598 initial set of recipients. The remote server should then re-send the message
15599 for the remaining recipients at a later time.
15600
15601
15602 .option remote_max_parallel main integer 2
15603 .cindex "delivery" "parallelism for remote"
15604 This option controls parallel delivery of one message to a number of remote
15605 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15606 does all the remote deliveries for a message one by one. Otherwise, if a single
15607 message has to be delivered to more than one remote host, or if several copies
15608 have to be sent to the same remote host, up to &%remote_max_parallel%&
15609 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15610 deliveries are required, the maximum number of processes are started, and as
15611 each one finishes, another is begun. The order of starting processes is the
15612 same as if sequential delivery were being done, and can be controlled by the
15613 &%remote_sort_domains%& option. If parallel delivery takes place while running
15614 with debugging turned on, the debugging output from each delivery process is
15615 tagged with its process id.
15616
15617 This option controls only the maximum number of parallel deliveries for one
15618 message in one Exim delivery process. Because Exim has no central queue
15619 manager, there is no way of controlling the total number of simultaneous
15620 deliveries if the configuration allows a delivery attempt as soon as a message
15621 is received.
15622
15623 .cindex "number of deliveries"
15624 .cindex "delivery" "maximum number of"
15625 If you want to control the total number of deliveries on the system, you
15626 need to set the &%queue_only%& option. This ensures that all incoming messages
15627 are added to the queue without starting a delivery process. Then set up an Exim
15628 daemon to start queue runner processes at appropriate intervals (probably
15629 fairly often, for example, every minute), and limit the total number of queue
15630 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15631 delivers only one message at a time, the maximum number of deliveries that can
15632 then take place at once is &%queue_run_max%& multiplied by
15633 &%remote_max_parallel%&.
15634
15635 If it is purely remote deliveries you want to control, use
15636 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15637 doing the SMTP routing before queueing, so that several messages for the same
15638 host will eventually get delivered down the same connection.
15639
15640
15641 .option remote_sort_domains main "domain list&!!" unset
15642 .cindex "sorting remote deliveries"
15643 .cindex "delivery" "sorting remote"
15644 When there are a number of remote deliveries for a message, they are sorted by
15645 domain into the order given by this list. For example,
15646 .code
15647 remote_sort_domains = *.cam.ac.uk:*.uk
15648 .endd
15649 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15650 then to those in the &%uk%& domain, then to any others.
15651
15652
15653 .option retry_data_expire main time 7d
15654 .cindex "hints database" "data expiry"
15655 This option sets a &"use before"& time on retry information in Exim's hints
15656 database. Any older retry data is ignored. This means that, for example, once a
15657 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15658 past failures.
15659
15660
15661 .option retry_interval_max main time 24h
15662 .cindex "retry" "limit on interval"
15663 .cindex "limit" "on retry interval"
15664 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15665 intervals between delivery attempts for messages that cannot be delivered
15666 straight away. This option sets an overall limit to the length of time between
15667 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15668 the default value.
15669
15670
15671 .option return_path_remove main boolean true
15672 .cindex "&'Return-path:'& header line" "removing"
15673 RFC 2821, section 4.4, states that an SMTP server must insert a
15674 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15675 The &'Return-path:'& header preserves the sender address as received in the
15676 MAIL command. This description implies that this header should not be present
15677 in an incoming message. If &%return_path_remove%& is true, any existing
15678 &'Return-path:'& headers are removed from messages at the time they are
15679 received. Exim's transports have options for adding &'Return-path:'& headers at
15680 the time of delivery. They are normally used only for final local deliveries.
15681
15682
15683 .option return_size_limit main integer 100K
15684 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15685
15686
15687 .option rfc1413_hosts main "host list&!!" @[]
15688 .cindex "RFC 1413"
15689 .cindex "host" "for RFC 1413 calls"
15690 RFC 1413 identification calls are made to any client host which matches
15691 an item in the list.
15692 The default value specifies just this host, being any local interface
15693 for the system.
15694
15695 .option rfc1413_query_timeout main time 0s
15696 .cindex "RFC 1413" "query timeout"
15697 .cindex "timeout" "for RFC 1413 call"
15698 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15699 no RFC 1413 calls are ever made.
15700
15701
15702 .option sender_unqualified_hosts main "host list&!!" unset
15703 .cindex "unqualified addresses"
15704 .cindex "host" "unqualified addresses from"
15705 This option lists those hosts from which Exim is prepared to accept unqualified
15706 sender addresses. The addresses are made fully qualified by the addition of
15707 &%qualify_domain%&. This option also affects message header lines. Exim does
15708 not reject unqualified addresses in headers that contain sender addresses, but
15709 it qualifies them only if the message came from a host that matches
15710 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15711 using TCP/IP), and the &%-bnq%& option was not set.
15712
15713
15714 .option smtp_accept_keepalive main boolean true
15715 .cindex "keepalive" "on incoming connection"
15716 This option controls the setting of the SO_KEEPALIVE option on incoming
15717 TCP/IP socket connections. When set, it causes the kernel to probe idle
15718 connections periodically, by sending packets with &"old"& sequence numbers. The
15719 other end of the connection should send an acknowledgment if the connection is
15720 still okay or a reset if the connection has been aborted. The reason for doing
15721 this is that it has the beneficial effect of freeing up certain types of
15722 connection that can get stuck when the remote host is disconnected without
15723 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15724 hours to detect unreachable hosts.
15725
15726
15727
15728 .option smtp_accept_max main integer 20
15729 .cindex "limit" "incoming SMTP connections"
15730 .cindex "SMTP" "incoming connection count"
15731 .cindex "inetd"
15732 This option specifies the maximum number of simultaneous incoming SMTP calls
15733 that Exim will accept. It applies only to the listening daemon; there is no
15734 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15735 value is set to zero, no limit is applied. However, it is required to be
15736 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15737 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15738
15739 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15740 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15741 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15742 and &%smtp_load_reserve%& are then checked before accepting the connection.
15743
15744
15745 .option smtp_accept_max_nonmail main integer 10
15746 .cindex "limit" "non-mail SMTP commands"
15747 .cindex "SMTP" "limiting non-mail commands"
15748 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15749 the connection if there are too many. This option defines &"too many"&. The
15750 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15751 client looping sending EHLO, for example. The check is applied only if the
15752 client host matches &%smtp_accept_max_nonmail_hosts%&.
15753
15754 When a new message is expected, one occurrence of RSET is not counted. This
15755 allows a client to send one RSET between messages (this is not necessary,
15756 but some clients do it). Exim also allows one uncounted occurrence of HELO
15757 or EHLO, and one occurrence of STARTTLS between messages. After
15758 starting up a TLS session, another EHLO is expected, and so it too is not
15759 counted. The first occurrence of AUTH in a connection, or immediately
15760 following STARTTLS is not counted. Otherwise, all commands other than
15761 MAIL, RCPT, DATA, and QUIT are counted.
15762
15763
15764 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15765 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15766 check by setting this option. The default value makes it apply to all hosts. By
15767 changing the value, you can exclude any badly-behaved hosts that you have to
15768 live with.
15769
15770
15771 . Allow this long option name to split; give it unsplit as a fifth argument
15772 . for the automatic .oindex that is generated by .option.
15773 . We insert " &~&~" which is both pretty nasty visually and results in
15774 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15775 . zero-width-space, which would be nicer visually and results in (at least)
15776 . html that Firefox will split on when it's forced to reflow (rather than
15777 . inserting a horizontal scrollbar).  However, the text is still not
15778 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15779 . the option name to split.
15780
15781 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15782          smtp_accept_max_per_connection
15783 .cindex "SMTP" "limiting incoming message count"
15784 .cindex "limit" "messages per SMTP connection"
15785 The value of this option limits the number of MAIL commands that Exim is
15786 prepared to accept over a single SMTP connection, whether or not each command
15787 results in the transfer of a message. After the limit is reached, a 421
15788 response is given to subsequent MAIL commands. This limit is a safety
15789 precaution against a client that goes mad (incidents of this type have been
15790 seen).
15791
15792
15793 .option smtp_accept_max_per_host main string&!! unset
15794 .cindex "limit" "SMTP connections from one host"
15795 .cindex "host" "limiting SMTP connections from"
15796 This option restricts the number of simultaneous IP connections from a single
15797 host (strictly, from a single IP address) to the Exim daemon. The option is
15798 expanded, to enable different limits to be applied to different hosts by
15799 reference to &$sender_host_address$&. Once the limit is reached, additional
15800 connection attempts from the same host are rejected with error code 421. This
15801 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15802 of zero imposes no limit. If this option is set greater than zero, it is
15803 required that &%smtp_accept_max%& be non-zero.
15804
15805 &*Warning*&: When setting this option you should not use any expansion
15806 constructions that take an appreciable amount of time. The expansion and test
15807 happen in the main daemon loop, in order to reject additional connections
15808 without forking additional processes (otherwise a denial-of-service attack
15809 could cause a vast number or processes to be created). While the daemon is
15810 doing this processing, it cannot accept any other incoming connections.
15811
15812
15813
15814 .option smtp_accept_queue main integer 0
15815 .cindex "SMTP" "incoming connection count"
15816 .cindex "queueing incoming messages"
15817 .cindex "message" "queueing by SMTP connection count"
15818 If the number of simultaneous incoming SMTP connections being handled via the
15819 listening daemon exceeds this value, messages received by SMTP are just placed
15820 on the queue; no delivery processes are started automatically. The count is
15821 fixed at the start of an SMTP connection. It cannot be updated in the
15822 subprocess that receives messages, and so the queueing or not queueing applies
15823 to all messages received in the same connection.
15824
15825 A value of zero implies no limit, and clearly any non-zero value is useful only
15826 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15827 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15828 various &%-od%&&'x'& command line options.
15829
15830
15831 . See the comment on smtp_accept_max_per_connection
15832
15833 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15834          smtp_accept_queue_per_connection
15835 .cindex "queueing incoming messages"
15836 .cindex "message" "queueing by message count"
15837 This option limits the number of delivery processes that Exim starts
15838 automatically when receiving messages via SMTP, whether via the daemon or by
15839 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15840 and the number of messages received in a single SMTP session exceeds this
15841 number, subsequent messages are placed on the queue, but no delivery processes
15842 are started. This helps to limit the number of Exim processes when a server
15843 restarts after downtime and there is a lot of mail waiting for it on other
15844 systems. On large systems, the default should probably be increased, and on
15845 dial-in client systems it should probably be set to zero (that is, disabled).
15846
15847
15848 .option smtp_accept_reserve main integer 0
15849 .cindex "SMTP" "incoming call count"
15850 .cindex "host" "reserved"
15851 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15852 number of SMTP connections that are reserved for connections from the hosts
15853 that are specified in &%smtp_reserve_hosts%&. The value set in
15854 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15855 restricted to this number of connections; the option specifies a minimum number
15856 of connection slots for them, not a maximum. It is a guarantee that this group
15857 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15858 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15859 individual host.
15860
15861 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15862 set to 5, once there are 45 active connections (from any hosts), new
15863 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15864 provided the other criteria for acceptance are met.
15865
15866
15867 .option smtp_active_hostname main string&!! unset
15868 .cindex "host" "name in SMTP responses"
15869 .cindex "SMTP" "host name in responses"
15870 .vindex "&$primary_hostname$&"
15871 This option is provided for multi-homed servers that want to masquerade as
15872 several different hosts. At the start of an incoming SMTP connection, its value
15873 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15874 responses. For example, it is used as domain name in the response to an
15875 incoming HELO or EHLO command.
15876
15877 .vindex "&$smtp_active_hostname$&"
15878 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15879 is saved with any messages that are received. It is therefore available for use
15880 in routers and transports when the message is later delivered.
15881
15882 If this option is unset, or if its expansion is forced to fail, or if the
15883 expansion results in an empty string, the value of &$primary_hostname$& is
15884 used. Other expansion failures cause a message to be written to the main and
15885 panic logs, and the SMTP command receives a temporary error. Typically, the
15886 value of &%smtp_active_hostname%& depends on the incoming interface address.
15887 For example:
15888 .code
15889 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15890   {cox.mydomain}{box.mydomain}}
15891 .endd
15892
15893 Although &$smtp_active_hostname$& is primarily concerned with incoming
15894 messages, it is also used as the default for HELO commands in callout
15895 verification if there is no remote transport from which to obtain a
15896 &%helo_data%& value.
15897
15898 .option smtp_banner main string&!! "see below"
15899 .cindex "SMTP" "welcome banner"
15900 .cindex "banner for SMTP"
15901 .cindex "welcome banner for SMTP"
15902 .cindex "customizing" "SMTP banner"
15903 This string, which is expanded every time it is used, is output as the initial
15904 positive response to an SMTP connection. The default setting is:
15905 .code
15906 smtp_banner = $smtp_active_hostname ESMTP Exim \
15907   $version_number $tod_full
15908 .endd
15909 Failure to expand the string causes a panic error. If you want to create a
15910 multiline response to the initial SMTP connection, use &"\n"& in the string at
15911 appropriate points, but not at the end. Note that the 220 code is not included
15912 in this string. Exim adds it automatically (several times in the case of a
15913 multiline response).
15914
15915
15916 .option smtp_check_spool_space main boolean true
15917 .cindex "checking disk space"
15918 .cindex "disk space, checking"
15919 .cindex "spool directory" "checking space"
15920 When this option is set, if an incoming SMTP session encounters the SIZE
15921 option on a MAIL command, it checks that there is enough space in the
15922 spool directory's partition to accept a message of that size, while still
15923 leaving free the amount specified by &%check_spool_space%& (even if that value
15924 is zero). If there isn't enough space, a temporary error code is returned.
15925
15926
15927 .option smtp_connect_backlog main integer 20
15928 .cindex "connection backlog"
15929 .cindex "SMTP" "connection backlog"
15930 .cindex "backlog of connections"
15931 This option specifies a maximum number of waiting SMTP connections. Exim passes
15932 this value to the TCP/IP system when it sets up its listener. Once this number
15933 of connections are waiting for the daemon's attention, subsequent connection
15934 attempts are refused at the TCP/IP level. At least, that is what the manuals
15935 say; in some circumstances such connection attempts have been observed to time
15936 out instead. For large systems it is probably a good idea to increase the
15937 value (to 50, say). It also gives some protection against denial-of-service
15938 attacks by SYN flooding.
15939
15940
15941 .option smtp_enforce_sync main boolean true
15942 .cindex "SMTP" "synchronization checking"
15943 .cindex "synchronization checking in SMTP"
15944 The SMTP protocol specification requires the client to wait for a response from
15945 the server at certain points in the dialogue. Without PIPELINING these
15946 synchronization points are after every command; with PIPELINING they are
15947 fewer, but they still exist.
15948
15949 Some spamming sites send out a complete set of SMTP commands without waiting
15950 for any response. Exim protects against this by rejecting a message if the
15951 client has sent further input when it should not have. The error response &"554
15952 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15953 for this error cannot be perfect because of transmission delays (unexpected
15954 input may be on its way but not yet received when Exim checks). However, it
15955 does detect many instances.
15956
15957 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15958 If you want to disable the check selectively (for example, only for certain
15959 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15960 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15961
15962
15963
15964 .option smtp_etrn_command main string&!! unset
15965 .cindex "ETRN" "command to be run"
15966 .vindex "&$domain$&"
15967 If this option is set, the given command is run whenever an SMTP ETRN
15968 command is received from a host that is permitted to issue such commands (see
15969 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15970 are independently expanded. The expansion variable &$domain$& is set to the
15971 argument of the ETRN command, and no syntax checking is done on it. For
15972 example:
15973 .code
15974 smtp_etrn_command = /etc/etrn_command $domain \
15975                     $sender_host_address
15976 .endd
15977 A new process is created to run the command, but Exim does not wait for it to
15978 complete. Consequently, its status cannot be checked. If the command cannot be
15979 run, a line is written to the panic log, but the ETRN caller still receives
15980 a 250 success response. Exim is normally running under its own uid when
15981 receiving SMTP, so it is not possible for it to change the uid before running
15982 the command.
15983
15984
15985 .option smtp_etrn_serialize main boolean true
15986 .cindex "ETRN" "serializing"
15987 When this option is set, it prevents the simultaneous execution of more than
15988 one identical command as a result of ETRN in an SMTP connection. See
15989 section &<<SECTETRN>>& for details.
15990
15991
15992 .option smtp_load_reserve main fixed-point unset
15993 .cindex "load average"
15994 If the system load average ever gets higher than this, incoming SMTP calls are
15995 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15996 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15997 the load is over the limit. The option has no effect on ancient operating
15998 systems on which Exim cannot determine the load average. See also
15999 &%deliver_queue_load_max%& and &%queue_only_load%&.
16000
16001
16002
16003 .option smtp_max_synprot_errors main integer 3
16004 .cindex "SMTP" "limiting syntax and protocol errors"
16005 .cindex "limit" "SMTP syntax and protocol errors"
16006 Exim rejects SMTP commands that contain syntax or protocol errors. In
16007 particular, a syntactically invalid email address, as in this command:
16008 .code
16009 RCPT TO:<abc xyz@a.b.c>
16010 .endd
16011 causes immediate rejection of the command, before any other tests are done.
16012 (The ACL cannot be run if there is no valid address to set up for it.) An
16013 example of a protocol error is receiving RCPT before MAIL. If there are
16014 too many syntax or protocol errors in one SMTP session, the connection is
16015 dropped. The limit is set by this option.
16016
16017 .cindex "PIPELINING" "expected errors"
16018 When the PIPELINING extension to SMTP is in use, some protocol errors are
16019 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16020 Exim assumes that PIPELINING will be used if it advertises it (see
16021 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16022 not count towards the limit.
16023
16024
16025
16026 .option smtp_max_unknown_commands main integer 3
16027 .cindex "SMTP" "limiting unknown commands"
16028 .cindex "limit" "unknown SMTP commands"
16029 If there are too many unrecognized commands in an incoming SMTP session, an
16030 Exim server drops the connection. This is a defence against some kinds of abuse
16031 that subvert web
16032 clients
16033 into making connections to SMTP ports; in these circumstances, a number of
16034 non-SMTP command lines are sent first.
16035
16036
16037
16038 .option smtp_ratelimit_hosts main "host list&!!" unset
16039 .cindex "SMTP" "rate limiting"
16040 .cindex "limit" "rate of message arrival"
16041 .cindex "RCPT" "rate limiting"
16042 Some sites find it helpful to be able to limit the rate at which certain hosts
16043 can send them messages, and the rate at which an individual message can specify
16044 recipients.
16045
16046 Exim has two rate-limiting facilities. This section describes the older
16047 facility, which can limit rates within a single connection. The newer
16048 &%ratelimit%& ACL condition can limit rates across all connections. See section
16049 &<<SECTratelimiting>>& for details of the newer facility.
16050
16051 When a host matches &%smtp_ratelimit_hosts%&, the values of
16052 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16053 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16054 respectively. Each option, if set, must contain a set of four comma-separated
16055 values:
16056
16057 .ilist
16058 A threshold, before which there is no rate limiting.
16059 .next
16060 An initial time delay. Unlike other times in Exim, numbers with decimal
16061 fractional parts are allowed here.
16062 .next
16063 A factor by which to increase the delay each time.
16064 .next
16065 A maximum value for the delay. This should normally be less than 5 minutes,
16066 because after that time, the client is liable to timeout the SMTP command.
16067 .endlist
16068
16069 For example, these settings have been used successfully at the site which
16070 first suggested this feature, for controlling mail from their customers:
16071 .code
16072 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16073 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16074 .endd
16075 The first setting specifies delays that are applied to MAIL commands after
16076 two have been received over a single connection. The initial delay is 0.5
16077 seconds, increasing by a factor of 1.05 each time. The second setting applies
16078 delays to RCPT commands when more than four occur in a single message.
16079
16080
16081 .option smtp_ratelimit_mail main string unset
16082 See &%smtp_ratelimit_hosts%& above.
16083
16084
16085 .option smtp_ratelimit_rcpt main string unset
16086 See &%smtp_ratelimit_hosts%& above.
16087
16088
16089 .option smtp_receive_timeout main time 5m
16090 .cindex "timeout" "for SMTP input"
16091 .cindex "SMTP" "input timeout"
16092 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16093 input, including batch SMTP. If a line of input (either an SMTP command or a
16094 data line) is not received within this time, the SMTP connection is dropped and
16095 the message is abandoned.
16096 A line is written to the log containing one of the following messages:
16097 .code
16098 SMTP command timeout on connection from...
16099 SMTP data timeout on connection from...
16100 .endd
16101 The former means that Exim was expecting to read an SMTP command; the latter
16102 means that it was in the DATA phase, reading the contents of a message.
16103
16104
16105 .oindex "&%-os%&"
16106 The value set by this option can be overridden by the
16107 &%-os%& command-line option. A setting of zero time disables the timeout, but
16108 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16109 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16110 timeout is controlled by &%receive_timeout%& and &%-or%&.
16111
16112
16113 .option smtp_reserve_hosts main "host list&!!" unset
16114 This option defines hosts for which SMTP connections are reserved; see
16115 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16116
16117
16118 .option smtp_return_error_details main boolean false
16119 .cindex "SMTP" "details policy failures"
16120 .cindex "policy control" "rejection, returning details"
16121 In the default state, Exim uses bland messages such as
16122 &"Administrative prohibition"& when it rejects SMTP commands for policy
16123 reasons. Many sysadmins like this because it gives away little information
16124 to spammers. However, some other sysadmins who are applying strict checking
16125 policies want to give out much fuller information about failures. Setting
16126 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16127 example, instead of &"Administrative prohibition"&, it might give:
16128 .code
16129 550-Rejected after DATA: '>' missing at end of address:
16130 550 failing address in "From" header is: <user@dom.ain
16131 .endd
16132
16133 .option spamd_address main string "see below"
16134 This option is available when Exim is compiled with the content-scanning
16135 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16136 The default value is
16137 .code
16138 127.0.0.1 783
16139 .endd
16140 See section &<<SECTscanspamass>>& for more details.
16141
16142
16143
16144 .option split_spool_directory main boolean false
16145 .cindex "multiple spool directories"
16146 .cindex "spool directory" "split"
16147 .cindex "directories, multiple"
16148 If this option is set, it causes Exim to split its input directory into 62
16149 subdirectories, each with a single alphanumeric character as its name. The
16150 sixth character of the message id is used to allocate messages to
16151 subdirectories; this is the least significant base-62 digit of the time of
16152 arrival of the message.
16153
16154 Splitting up the spool in this way may provide better performance on systems
16155 where there are long mail queues, by reducing the number of files in any one
16156 directory. The msglog directory is also split up in a similar way to the input
16157 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16158 are still placed in the single directory &_msglog.OLD_&.
16159
16160 It is not necessary to take any special action for existing messages when
16161 changing &%split_spool_directory%&. Exim notices messages that are in the
16162 &"wrong"& place, and continues to process them. If the option is turned off
16163 after a period of being on, the subdirectories will eventually empty and be
16164 automatically deleted.
16165
16166 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16167 changes. Instead of creating a list of all messages in the queue, and then
16168 trying to deliver each one in turn, it constructs a list of those in one
16169 sub-directory and tries to deliver them, before moving on to the next
16170 sub-directory. The sub-directories are processed in a random order. This
16171 spreads out the scanning of the input directories, and uses less memory. It is
16172 particularly beneficial when there are lots of messages on the queue. However,
16173 if &%queue_run_in_order%& is set, none of this new processing happens. The
16174 entire queue has to be scanned and sorted before any deliveries can start.
16175
16176
16177 .option spool_directory main string&!! "set at compile time"
16178 .cindex "spool directory" "path to"
16179 This defines the directory in which Exim keeps its spool, that is, the messages
16180 it is waiting to deliver. The default value is taken from the compile-time
16181 configuration setting, if there is one. If not, this option must be set. The
16182 string is expanded, so it can contain, for example, a reference to
16183 &$primary_hostname$&.
16184
16185 If the spool directory name is fixed on your installation, it is recommended
16186 that you set it at build time rather than from this option, particularly if the
16187 log files are being written to the spool directory (see &%log_file_path%&).
16188 Otherwise log files cannot be used for errors that are detected early on, such
16189 as failures in the configuration file.
16190
16191 By using this option to override the compiled-in path, it is possible to run
16192 tests of Exim without using the standard spool.
16193
16194 .option sqlite_lock_timeout main time 5s
16195 .cindex "sqlite lookup type" "lock timeout"
16196 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16197 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16198
16199 .option strict_acl_vars main boolean false
16200 .cindex "&ACL;" "variables, handling unset"
16201 This option controls what happens if a syntactically valid but undefined ACL
16202 variable is referenced. If it is false (the default), an empty string
16203 is substituted; if it is true, an error is generated. See section
16204 &<<SECTaclvariables>>& for details of ACL variables.
16205
16206 .option strip_excess_angle_brackets main boolean false
16207 .cindex "angle brackets, excess"
16208 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16209 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16210 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16211 passed on to another MTA, the excess angle brackets are not passed on. If this
16212 option is not set, multiple pairs of angle brackets cause a syntax error.
16213
16214
16215 .option strip_trailing_dot main boolean false
16216 .cindex "trailing dot on domain"
16217 .cindex "dot" "trailing on domain"
16218 If this option is set, a trailing dot at the end of a domain in an address is
16219 ignored. If this is in the envelope and the message is passed on to another
16220 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16221 domain causes a syntax error.
16222 However, addresses in header lines are checked only when an ACL requests header
16223 syntax checking.
16224
16225
16226 .option syslog_duplication main boolean true
16227 .cindex "syslog" "duplicate log lines; suppressing"
16228 When Exim is logging to syslog, it writes the log lines for its three
16229 separate logs at different syslog priorities so that they can in principle
16230 be separated on the logging hosts. Some installations do not require this
16231 separation, and in those cases, the duplication of certain log lines is a
16232 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16233 particular log line is written to syslog. For lines that normally go to
16234 both the main log and the reject log, the reject log version (possibly
16235 containing message header lines) is written, at LOG_NOTICE priority.
16236 Lines that normally go to both the main and the panic log are written at
16237 the LOG_ALERT priority.
16238
16239
16240 .option syslog_facility main string unset
16241 .cindex "syslog" "facility; setting"
16242 This option sets the syslog &"facility"& name, used when Exim is logging to
16243 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16244 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16245 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16246 details of Exim's logging.
16247
16248
16249
16250 .option syslog_processname main string &`exim`&
16251 .cindex "syslog" "process name; setting"
16252 This option sets the syslog &"ident"& name, used when Exim is logging to
16253 syslog. The value must be no longer than 32 characters. See chapter
16254 &<<CHAPlog>>& for details of Exim's logging.
16255
16256
16257
16258 .option syslog_timestamp main boolean true
16259 .cindex "syslog" "timestamps"
16260 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16261 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16262 details of Exim's logging.
16263
16264
16265 .option system_filter main string&!! unset
16266 .cindex "filter" "system filter"
16267 .cindex "system filter" "specifying"
16268 .cindex "Sieve filter" "not available for system filter"
16269 This option specifies an Exim filter file that is applied to all messages at
16270 the start of each delivery attempt, before any routing is done. System filters
16271 must be Exim filters; they cannot be Sieve filters. If the system filter
16272 generates any deliveries to files or pipes, or any new mail messages, the
16273 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16274 which transports are to be used. Details of this facility are given in chapter
16275 &<<CHAPsystemfilter>>&.
16276
16277
16278 .option system_filter_directory_transport main string&!! unset
16279 .vindex "&$address_file$&"
16280 This sets the name of the transport driver that is to be used when the
16281 &%save%& command in a system message filter specifies a path ending in &"/"&,
16282 implying delivery of each message into a separate file in some directory.
16283 During the delivery, the variable &$address_file$& contains the path name.
16284
16285
16286 .option system_filter_file_transport main string&!! unset
16287 .cindex "file" "transport for system filter"
16288 This sets the name of the transport driver that is to be used when the &%save%&
16289 command in a system message filter specifies a path not ending in &"/"&. During
16290 the delivery, the variable &$address_file$& contains the path name.
16291
16292 .option system_filter_group main string unset
16293 .cindex "gid (group id)" "system filter"
16294 This option is used only when &%system_filter_user%& is also set. It sets the
16295 gid under which the system filter is run, overriding any gid that is associated
16296 with the user. The value may be numerical or symbolic.
16297
16298 .option system_filter_pipe_transport main string&!! unset
16299 .cindex "&(pipe)& transport" "for system filter"
16300 .vindex "&$address_pipe$&"
16301 This specifies the transport driver that is to be used when a &%pipe%& command
16302 is used in a system filter. During the delivery, the variable &$address_pipe$&
16303 contains the pipe command.
16304
16305
16306 .option system_filter_reply_transport main string&!! unset
16307 .cindex "&(autoreply)& transport" "for system filter"
16308 This specifies the transport driver that is to be used when a &%mail%& command
16309 is used in a system filter.
16310
16311
16312 .option system_filter_user main string unset
16313 .cindex "uid (user id)" "system filter"
16314 If this option is set to root, the system filter is run in the main Exim
16315 delivery process, as root.  Otherwise, the system filter runs in a separate
16316 process, as the given user, defaulting to the Exim run-time user.
16317 Unless the string consists entirely of digits, it
16318 is looked up in the password data. Failure to find the named user causes a
16319 configuration error. The gid is either taken from the password data, or
16320 specified by &%system_filter_group%&. When the uid is specified numerically,
16321 &%system_filter_group%& is required to be set.
16322
16323 If the system filter generates any pipe, file, or reply deliveries, the uid
16324 under which the filter is run is used when transporting them, unless a
16325 transport option overrides.
16326
16327
16328 .option tcp_nodelay main boolean true
16329 .cindex "daemon" "TCP_NODELAY on sockets"
16330 .cindex "Nagle algorithm"
16331 .cindex "TCP_NODELAY on listening sockets"
16332 If this option is set false, it stops the Exim daemon setting the
16333 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16334 turns off the &"Nagle algorithm"&, which is a way of improving network
16335 performance in interactive (character-by-character) situations. Turning it off
16336 should improve Exim's performance a bit, so that is what happens by default.
16337 However, it appears that some broken clients cannot cope, and time out. Hence
16338 this option. It affects only those sockets that are set up for listening by the
16339 daemon. Sockets created by the smtp transport for delivering mail always set
16340 TCP_NODELAY.
16341
16342
16343 .option timeout_frozen_after main time 0s
16344 .cindex "frozen messages" "timing out"
16345 .cindex "timeout" "frozen messages"
16346 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16347 message of any kind that has been on the queue for longer than the given time
16348 is automatically cancelled at the next queue run. If the frozen message is a
16349 bounce message, it is just discarded; otherwise, a bounce is sent to the
16350 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16351 If you want to timeout frozen bounce messages earlier than other kinds of
16352 frozen message, see &%ignore_bounce_errors_after%&.
16353
16354 &*Note:*& the default value of zero means no timeouts; with this setting,
16355 frozen messages remain on the queue forever (except for any frozen bounce
16356 messages that are released by &%ignore_bounce_errors_after%&).
16357
16358
16359 .option timezone main string unset
16360 .cindex "timezone, setting"
16361 The value of &%timezone%& is used to set the environment variable TZ while
16362 running Exim (if it is different on entry). This ensures that all timestamps
16363 created by Exim are in the required timezone. If you want all your timestamps
16364 to be in UTC (aka GMT) you should set
16365 .code
16366 timezone = UTC
16367 .endd
16368 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16369 or, if that is not set, from the value of the TZ environment variable when Exim
16370 is built. If &%timezone%& is set to the empty string, either at build or run
16371 time, any existing TZ variable is removed from the environment when Exim
16372 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16373 unfortunately not all, operating systems.
16374
16375
16376 .option tls_advertise_hosts main "host list&!!" unset
16377 .cindex "TLS" "advertising"
16378 .cindex "encryption" "on SMTP connection"
16379 .cindex "SMTP" "encrypted connection"
16380 When Exim is built with support for TLS encrypted connections, the availability
16381 of the STARTTLS command to set up an encrypted session is advertised in
16382 response to EHLO only to those client hosts that match this option. See
16383 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16384
16385
16386 .option tls_certificate main string&!! unset
16387 .cindex "TLS" "server certificate; location of"
16388 .cindex "certificate" "server, location of"
16389 The value of this option is expanded, and must then be the absolute path to a
16390 file which contains the server's certificates. The server's private key is also
16391 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16392 &<<CHAPTLS>>& for further details.
16393
16394 &*Note*&: The certificates defined by this option are used only when Exim is
16395 receiving incoming messages as a server. If you want to supply certificates for
16396 use when sending messages as a client, you must set the &%tls_certificate%&
16397 option in the relevant &(smtp)& transport.
16398
16399 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16400 if the OpenSSL build supports TLS extensions and the TLS client sends the
16401 Server Name Indication extension, then this option and others documented in
16402 &<<SECTtlssni>>& will be re-expanded.
16403
16404 .option tls_crl main string&!! unset
16405 .cindex "TLS" "server certificate revocation list"
16406 .cindex "certificate" "revocation list for server"
16407 This option specifies a certificate revocation list. The expanded value must
16408 be the name of a file that contains a CRL in PEM format.
16409
16410 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16411
16412
16413 .option tls_dh_max_bits main integer 2236
16414 .cindex "TLS" "D-H bit count"
16415 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16416 the chosen TLS library.  That value might prove to be too high for
16417 interoperability.  This option provides a maximum clamp on the value
16418 suggested, trading off security for interoperability.
16419
16420 The value must be at least 1024.
16421
16422 The value 2236 was chosen because, at time of adding the option, it was the
16423 hard-coded maximum value supported by the NSS cryptographic library, as used
16424 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16425
16426 If you prefer more security and are willing to break some clients, raise this
16427 number.
16428
16429 Note that the value passed to GnuTLS for *generating* a new prime may be a
16430 little less than this figure, because GnuTLS is inexact and may produce a
16431 larger prime than requested.
16432
16433
16434 .option tls_dhparam main string&!! unset
16435 .cindex "TLS" "D-H parameters for server"
16436 The value of this option is expanded and indicates the source of DH parameters
16437 to be used by Exim.
16438
16439 If it is a filename starting with a &`/`&, then it names a file from which DH
16440 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16441 PKCS#3 representation of the DH prime.  If the file does not exist, for
16442 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16443 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16444 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16445 and treated as though the &%tls_dhparam%& were set to "none".
16446
16447 If this option expands to the string "none", then no DH parameters will be
16448 loaded by Exim.
16449
16450 If this option expands to the string "historic" and Exim is using GnuTLS, then
16451 Exim will attempt to load a file from inside the spool directory.  If the file
16452 does not exist, Exim will attempt to create it.
16453 See section &<<SECTgnutlsparam>>& for further details.
16454
16455 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16456 a default DH prime; the default is the 2048 bit prime described in section
16457 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16458 in IKE is assigned number 23.
16459
16460 Otherwise, the option must expand to the name used by Exim for any of a number
16461 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16462 "ike" followed by the number used by IKE, of "default" which corresponds to
16463 "ike23".
16464
16465 The available primes are:
16466 &`ike1`&, &`ike2`&, &`ike5`&,
16467 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16468 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16469
16470 Some of these will be too small to be accepted by clients.
16471 Some may be too large to be accepted by clients.
16472
16473 The TLS protocol does not negotiate an acceptable size for this; clients tend
16474 to hard-drop connections if what is offered by the server is unacceptable,
16475 whether too large or too small, and there's no provision for the client to
16476 tell the server what these constraints are.  Thus, as a server operator, you
16477 need to make an educated guess as to what is most likely to work for your
16478 userbase.
16479
16480 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16481 is most likely to maximise interoperability.  The upper bound comes from
16482 applications using the Mozilla Network Security Services (NSS) library, which
16483 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16484 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16485 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16486 acceptable bound from 1024 to 2048.
16487
16488
16489 .option tls_ocsp_file main string&!! unset
16490 This option
16491 must if set expand to the absolute path to a file which contains a current
16492 status proof for the server's certificate, as obtained from the
16493 Certificate Authority.
16494
16495
16496 .option tls_on_connect_ports main "string list" unset
16497 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16498 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16499 set up without waiting for the client to issue a STARTTLS command. For
16500 further details, see section &<<SECTsupobssmt>>&.
16501
16502
16503
16504 .option tls_privatekey main string&!! unset
16505 .cindex "TLS" "server private key; location of"
16506 The value of this option is expanded, and must then be the absolute path to a
16507 file which contains the server's private key. If this option is unset, or if
16508 the expansion is forced to fail, or the result is an empty string, the private
16509 key is assumed to be in the same file as the server's certificates. See chapter
16510 &<<CHAPTLS>>& for further details.
16511
16512 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16513
16514
16515 .option tls_remember_esmtp main boolean false
16516 .cindex "TLS" "esmtp state; remembering"
16517 .cindex "TLS" "broken clients"
16518 If this option is set true, Exim violates the RFCs by remembering that it is in
16519 &"esmtp"& state after successfully negotiating a TLS session. This provides
16520 support for broken clients that fail to send a new EHLO after starting a
16521 TLS session.
16522
16523
16524 .option tls_require_ciphers main string&!! unset
16525 .cindex "TLS" "requiring specific ciphers"
16526 .cindex "cipher" "requiring specific"
16527 This option controls which ciphers can be used for incoming TLS connections.
16528 The &(smtp)& transport has an option of the same name for controlling outgoing
16529 connections. This option is expanded for each connection, so can be varied for
16530 different clients if required. The value of this option must be a list of
16531 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16532 in somewhat different ways. If GnuTLS is being used, the client controls the
16533 preference order of the available ciphers. Details are given in sections
16534 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16535
16536
16537 .option tls_try_verify_hosts main "host list&!!" unset
16538 .cindex "TLS" "client certificate verification"
16539 .cindex "certificate" "verification of client"
16540 See &%tls_verify_hosts%& below.
16541
16542
16543 .option tls_verify_certificates main string&!! system
16544 .cindex "TLS" "client certificate verification"
16545 .cindex "certificate" "verification of client"
16546 The value of this option is expanded, and must then be either the
16547 word "system"
16548 or the absolute path to
16549 a file or directory containing permitted certificates for clients that
16550 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16551
16552 The "system" value for the option will use a
16553 system default location compiled into the SSL library.
16554 This is not available for GnuTLS versions preceding 3.0.20,
16555 and will be taken as empty; an explicit location
16556 must be specified.
16557
16558 The use of a directory for the option value is not avilable for GnuTLS versions
16559 preceding 3.3.6 and a single file must be used.
16560
16561 With OpenSSL the certificates specified
16562 explicitly
16563 either by file or directory
16564 are added to those given by the system default location.
16565
16566 These certificates should be for the certificate authorities trusted, rather
16567 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16568 the value is a file then the certificates are sent by Exim as a server to
16569 connecting clients, defining the list of accepted certificate authorities.
16570 Thus the values defined should be considered public data.  To avoid this,
16571 use the explicit directory version.
16572
16573 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16574
16575 A forced expansion failure or setting to an empty string is equivalent to
16576 being unset.
16577
16578
16579 .option tls_verify_hosts main "host list&!!" unset
16580 .cindex "TLS" "client certificate verification"
16581 .cindex "certificate" "verification of client"
16582 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16583 certificates from clients. The expected certificates are defined by
16584 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16585 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16586 &%tls_verify_certificates%& is not set.
16587
16588 Any client that matches &%tls_verify_hosts%& is constrained by
16589 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16590 present one of the listed certificates. If it does not, the connection is
16591 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16592 the host to use TLS. It can still send SMTP commands through unencrypted
16593 connections. Forcing a client to use TLS has to be done separately using an
16594 ACL to reject inappropriate commands when the connection is not encrypted.
16595
16596 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16597 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16598 certificate and checks it against &%tls_verify_certificates%&, but does not
16599 abort the connection if there is no certificate or if it does not match. This
16600 state can be detected in an ACL, which makes it possible to implement policies
16601 such as &"accept for relay only if a verified certificate has been received,
16602 but accept for local delivery if encrypted, even without a verified
16603 certificate"&.
16604
16605 Client hosts that match neither of these lists are not asked to present
16606 certificates.
16607
16608
16609 .option trusted_groups main "string list&!!" unset
16610 .cindex "trusted groups"
16611 .cindex "groups" "trusted"
16612 This option is expanded just once, at the start of Exim's processing. If this
16613 option is set, any process that is running in one of the listed groups, or
16614 which has one of them as a supplementary group, is trusted. The groups can be
16615 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16616 details of what trusted callers are permitted to do. If neither
16617 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16618 are trusted.
16619
16620 .option trusted_users main "string list&!!" unset
16621 .cindex "trusted users"
16622 .cindex "user" "trusted"
16623 This option is expanded just once, at the start of Exim's processing. If this
16624 option is set, any process that is running as one of the listed users is
16625 trusted. The users can be specified numerically or by name. See section
16626 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16627 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16628 Exim user are trusted.
16629
16630 .option unknown_login main string&!! unset
16631 .cindex "uid (user id)" "unknown caller"
16632 .vindex "&$caller_uid$&"
16633 This is a specialized feature for use in unusual configurations. By default, if
16634 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16635 gives up. The &%unknown_login%& option can be used to set a login name to be
16636 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16637 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16638 is used for the user's real name (gecos field), unless this has been set by the
16639 &%-F%& option.
16640
16641 .option unknown_username main string unset
16642 See &%unknown_login%&.
16643
16644 .option untrusted_set_sender main "address list&!!" unset
16645 .cindex "trusted users"
16646 .cindex "sender" "setting by untrusted user"
16647 .cindex "untrusted user setting sender"
16648 .cindex "user" "untrusted setting sender"
16649 .cindex "envelope sender"
16650 When an untrusted user submits a message to Exim using the standard input, Exim
16651 normally creates an envelope sender address from the user's login and the
16652 default qualification domain. Data from the &%-f%& option (for setting envelope
16653 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16654 is used) is ignored.
16655
16656 However, untrusted users are permitted to set an empty envelope sender address,
16657 to declare that a message should never generate any bounces. For example:
16658 .code
16659 exim -f '<>' user@domain.example
16660 .endd
16661 .vindex "&$sender_ident$&"
16662 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16663 other envelope sender addresses in a controlled way. When it is set, untrusted
16664 users are allowed to set envelope sender addresses that match any of the
16665 patterns in the list. Like all address lists, the string is expanded. The
16666 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16667 users to setting senders that start with their login ids
16668 followed by a hyphen
16669 by a setting like this:
16670 .code
16671 untrusted_set_sender = ^$sender_ident-
16672 .endd
16673 If you want to allow untrusted users to set envelope sender addresses without
16674 restriction, you can use
16675 .code
16676 untrusted_set_sender = *
16677 .endd
16678 The &%untrusted_set_sender%& option applies to all forms of local input, but
16679 only to the setting of the envelope sender. It does not permit untrusted users
16680 to use the other options which trusted user can use to override message
16681 parameters. Furthermore, it does not stop Exim from removing an existing
16682 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16683 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16684 overriding these actions. The handling of the &'Sender:'& header is also
16685 described in section &<<SECTthesenhea>>&.
16686
16687 The log line for a message's arrival shows the envelope sender following
16688 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16689 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16690 envelope sender address, the user's login is shown in parentheses after the
16691 sender address.
16692
16693
16694 .option uucp_from_pattern main string "see below"
16695 .cindex "&""From""& line"
16696 .cindex "UUCP" "&""From""& line"
16697 Some applications that pass messages to an MTA via a command line interface use
16698 an initial line starting with &"From&~"& to pass the envelope sender. In
16699 particular, this is used by UUCP software. Exim recognizes such a line by means
16700 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16701 matches, the sender address is constructed by expanding the contents of
16702 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16703 default pattern recognizes lines in the following two forms:
16704 .code
16705 From ph10 Fri Jan  5 12:35 GMT 1996
16706 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16707 .endd
16708 The pattern can be seen by running
16709 .code
16710 exim -bP uucp_from_pattern
16711 .endd
16712 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16713 year in the second case. The first word after &"From&~"& is matched in the
16714 regular expression by a parenthesized subpattern. The default value for
16715 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16716 (&"ph10"& in the example above) as the message's sender. See also
16717 &%ignore_fromline_hosts%&.
16718
16719
16720 .option uucp_from_sender main string&!! &`$1`&
16721 See &%uucp_from_pattern%& above.
16722
16723
16724 .option warn_message_file main string unset
16725 .cindex "warning of delay" "customizing the message"
16726 .cindex "customizing" "warning message"
16727 This option defines a template file containing paragraphs of text to be used
16728 for constructing the warning message which is sent by Exim when a message has
16729 been on the queue for a specified amount of time, as specified by
16730 &%delay_warning%&. Details of the file's contents are given in chapter
16731 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16732
16733
16734 .option write_rejectlog main boolean true
16735 .cindex "reject log" "disabling"
16736 If this option is set false, Exim no longer writes anything to the reject log.
16737 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16738 .ecindex IIDconfima
16739 .ecindex IIDmaiconf
16740
16741
16742
16743
16744 . ////////////////////////////////////////////////////////////////////////////
16745 . ////////////////////////////////////////////////////////////////////////////
16746
16747 .chapter "Generic options for routers" "CHAProutergeneric"
16748 .scindex IIDgenoprou1 "options" "generic; for routers"
16749 .scindex IIDgenoprou2 "generic options" "router"
16750 This chapter describes the generic options that apply to all routers.
16751 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16752
16753 For a general description of how a router operates, see sections
16754 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16755 which the preconditions are tested. The order of expansion of the options that
16756 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16757 &%headers_remove%&, &%transport%&.
16758
16759
16760
16761 .option address_data routers string&!! unset
16762 .cindex "router" "data attached to address"
16763 The string is expanded just before the router is run, that is, after all the
16764 precondition tests have succeeded. If the expansion is forced to fail, the
16765 router declines, the value of &%address_data%& remains unchanged, and the
16766 &%more%& option controls what happens next. Other expansion failures cause
16767 delivery of the address to be deferred.
16768
16769 .vindex "&$address_data$&"
16770 When the expansion succeeds, the value is retained with the address, and can be
16771 accessed using the variable &$address_data$& in the current router, subsequent
16772 routers, and the eventual transport.
16773
16774 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16775 that runs a user's filter file, the contents of &$address_data$& are accessible
16776 in the filter. This is not normally a problem, because such data is usually
16777 either not confidential or it &"belongs"& to the current user, but if you do
16778 put confidential data into &$address_data$& you need to remember this point.
16779
16780 Even if the router declines or passes, the value of &$address_data$& remains
16781 with the address, though it can be changed by another &%address_data%& setting
16782 on a subsequent router. If a router generates child addresses, the value of
16783 &$address_data$& propagates to them. This also applies to the special kind of
16784 &"child"& that is generated by a router with the &%unseen%& option.
16785
16786 The idea of &%address_data%& is that you can use it to look up a lot of data
16787 for the address once, and then pick out parts of the data later. For example,
16788 you could use a single LDAP lookup to return a string of the form
16789 .code
16790 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16791 .endd
16792 In the transport you could pick out the mailbox by a setting such as
16793 .code
16794 file = ${extract{mailbox}{$address_data}}
16795 .endd
16796 This makes the configuration file less messy, and also reduces the number of
16797 lookups (though Exim does cache lookups).
16798
16799 .vindex "&$sender_address_data$&"
16800 .vindex "&$address_data$&"
16801 The &%address_data%& facility is also useful as a means of passing information
16802 from one router to another, and from a router to a transport. In addition, if
16803 &$address_data$& is set by a router when verifying a recipient address from an
16804 ACL, it remains available for use in the rest of the ACL statement. After
16805 verifying a sender, the value is transferred to &$sender_address_data$&.
16806
16807
16808
16809 .option address_test routers&!? boolean true
16810 .oindex "&%-bt%&"
16811 .cindex "router" "skipping when address testing"
16812 If this option is set false, the router is skipped when routing is being tested
16813 by means of the &%-bt%& command line option. This can be a convenience when
16814 your first router sends messages to an external scanner, because it saves you
16815 having to set the &"already scanned"& indicator when testing real address
16816 routing.
16817
16818
16819
16820 .option cannot_route_message routers string&!! unset
16821 .cindex "router" "customizing &""cannot route""& message"
16822 .cindex "customizing" "&""cannot route""& message"
16823 This option specifies a text message that is used when an address cannot be
16824 routed because Exim has run out of routers. The default message is
16825 &"Unrouteable address"&. This option is useful only on routers that have
16826 &%more%& set false, or on the very last router in a configuration, because the
16827 value that is used is taken from the last router that is considered. This
16828 includes a router that is skipped because its preconditions are not met, as
16829 well as a router that declines. For example, using the default configuration,
16830 you could put:
16831 .code
16832 cannot_route_message = Remote domain not found in DNS
16833 .endd
16834 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16835 and
16836 .code
16837 cannot_route_message = Unknown local user
16838 .endd
16839 on the final router that checks for local users. If string expansion fails for
16840 this option, the default message is used. Unless the expansion failure was
16841 explicitly forced, a message about the failure is written to the main and panic
16842 logs, in addition to the normal message about the routing failure.
16843
16844
16845 .option caseful_local_part routers boolean false
16846 .cindex "case of local parts"
16847 .cindex "router" "case of local parts"
16848 By default, routers handle the local parts of addresses in a case-insensitive
16849 manner, though the actual case is preserved for transmission with the message.
16850 If you want the case of letters to be significant in a router, you must set
16851 this option true. For individual router options that contain address or local
16852 part lists (for example, &%local_parts%&), case-sensitive matching can be
16853 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16854 more details.
16855
16856 .vindex "&$local_part$&"
16857 .vindex "&$original_local_part$&"
16858 .vindex "&$parent_local_part$&"
16859 The value of the &$local_part$& variable is forced to lower case while a
16860 router is running unless &%caseful_local_part%& is set. When a router assigns
16861 an address to a transport, the value of &$local_part$& when the transport runs
16862 is the same as it was in the router. Similarly, when a router generates child
16863 addresses by aliasing or forwarding, the values of &$original_local_part$&
16864 and &$parent_local_part$& are those that were used by the redirecting router.
16865
16866 This option applies to the processing of an address by a router. When a
16867 recipient address is being processed in an ACL, there is a separate &%control%&
16868 modifier that can be used to specify case-sensitive processing within the ACL
16869 (see section &<<SECTcontrols>>&).
16870
16871
16872
16873 .option check_local_user routers&!? boolean false
16874 .cindex "local user, checking in router"
16875 .cindex "router" "checking for local user"
16876 .cindex "&_/etc/passwd_&"
16877 .vindex "&$home$&"
16878 When this option is true, Exim checks that the local part of the recipient
16879 address (with affixes removed if relevant) is the name of an account on the
16880 local system. The check is done by calling the &[getpwnam()]& function rather
16881 than trying to read &_/etc/passwd_& directly. This means that other methods of
16882 holding password data (such as NIS) are supported. If the local part is a local
16883 user, &$home$& is set from the password data, and can be tested in other
16884 preconditions that are evaluated after this one (the order of evaluation is
16885 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16886 overridden by &%router_home_directory%&. If the local part is not a local user,
16887 the router is skipped.
16888
16889 If you want to check that the local part is either the name of a local user
16890 or matches something else, you cannot combine &%check_local_user%& with a
16891 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16892 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16893 setting to achieve this. For example:
16894 .code
16895 local_parts = passwd;$local_part : lsearch;/etc/other/users
16896 .endd
16897 Note, however, that the side effects of &%check_local_user%& (such as setting
16898 up a home directory) do not occur when a &(passwd)& lookup is used in a
16899 &%local_parts%& (or any other) precondition.
16900
16901
16902
16903 .option condition routers&!? string&!! unset
16904 .cindex "router" "customized precondition"
16905 This option specifies a general precondition test that has to succeed for the
16906 router to be called. The &%condition%& option is the last precondition to be
16907 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16908 result is a forced failure, or an empty string, or one of the strings &"0"& or
16909 &"no"& or &"false"& (checked without regard to the case of the letters), the
16910 router is skipped, and the address is offered to the next one.
16911
16912 If the result is any other value, the router is run (as this is the last
16913 precondition to be evaluated, all the other preconditions must be true).
16914
16915 This option is unusual in that multiple &%condition%& options may be present.
16916 All &%condition%& options must succeed.
16917
16918 The &%condition%& option provides a means of applying custom conditions to the
16919 running of routers. Note that in the case of a simple conditional expansion,
16920 the default expansion values are exactly what is wanted. For example:
16921 .code
16922 condition = ${if >{$message_age}{600}}
16923 .endd
16924 Because of the default behaviour of the string expansion, this is equivalent to
16925 .code
16926 condition = ${if >{$message_age}{600}{true}{}}
16927 .endd
16928
16929 A multiple condition example, which succeeds:
16930 .code
16931 condition = ${if >{$message_age}{600}}
16932 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16933 condition = foobar
16934 .endd
16935
16936 If the expansion fails (other than forced failure) delivery is deferred. Some
16937 of the other precondition options are common special cases that could in fact
16938 be specified using &%condition%&.
16939
16940 .new
16941 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
16942 are far older, and use one set of semantics.  ACLs are newer and when
16943 they were created, the ACL &%condition%& process was given far stricter
16944 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
16945 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
16946 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
16947 Router rules processing behavior.
16948
16949 This is best illustrated in an example:
16950 .code
16951 # If used in an ACL condition will fail with a syntax error, but
16952 # in a router condition any extra characters are treated as a string
16953
16954 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
16955 true {yes} {no}}
16956
16957 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
16958  {yes} {no}}
16959 .endd
16960 In each example above, the &%if%& statement actually ends after
16961 &"{google.com}}"&.  Since no true or false braces were defined, the
16962 default &%if%& behavior is to return a boolean true or a null answer
16963 (which evaluates to false). The rest of the line is then treated as a
16964 string. So the first example resulted in the boolean answer &"true"&
16965 with the string &" {yes} {no}}"& appended to it. The second example
16966 resulted in the null output (indicating false) with the string
16967 &" {yes} {no}}"& appended to it.
16968
16969 In fact you can put excess forward braces in too.  In the router
16970 &%condition%&, Exim's parser only looks for &"{"& symbols when they
16971 mean something, like after a &"$"& or when required as part of a
16972 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
16973 string characters.
16974
16975 Thus, in a Router, the above expansion strings will both always evaluate
16976 true, as the result of expansion is a non-empty string which doesn't
16977 match an explicit false value.  This can be tricky to debug.  By
16978 contrast, in an ACL either of those strings will always result in an
16979 expansion error because the result doesn't look sufficiently boolean.
16980 .wen
16981
16982
16983 .option debug_print routers string&!! unset
16984 .cindex "testing" "variables in drivers"
16985 If this option is set and debugging is enabled (see the &%-d%& command line
16986 option) or in address-testing mode (see the &%-bt%& command line option),
16987 the string is expanded and included in the debugging output.
16988 If expansion of the string fails, the error message is written to the debugging
16989 output, and Exim carries on processing.
16990 This option is provided to help with checking out the values of variables and
16991 so on when debugging router configurations. For example, if a &%condition%&
16992 option appears not to be working, &%debug_print%& can be used to output the
16993 variables it references. The output happens after checks for &%domains%&,
16994 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16995 are tested. A newline is added to the text if it does not end with one.
16996 The variable &$router_name$& contains the name of the router.
16997
16998
16999
17000 .option disable_logging routers boolean false
17001 If this option is set true, nothing is logged for any routing errors
17002 or for any deliveries caused by this router. You should not set this option
17003 unless you really, really know what you are doing. See also the generic
17004 transport option of the same name.
17005
17006
17007 .option domains routers&!? "domain list&!!" unset
17008 .cindex "router" "restricting to specific domains"
17009 .vindex "&$domain_data$&"
17010 If this option is set, the router is skipped unless the current domain matches
17011 the list. If the match is achieved by means of a file lookup, the data that the
17012 lookup returned for the domain is placed in &$domain_data$& for use in string
17013 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17014 a list of the order in which preconditions are evaluated.
17015
17016
17017
17018 .option driver routers string unset
17019 This option must always be set. It specifies which of the available routers is
17020 to be used.
17021
17022
17023 .option dsn_lasthop routers boolean false
17024 .cindex "DSN" "success"
17025 .cindex "Delivery Status Notification" "success"
17026 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17027 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17028 instead send a success DSN as if the next hop does not support DSN.
17029 Not effective on redirect routers.
17030
17031
17032
17033 .option errors_to routers string&!! unset
17034 .cindex "envelope sender"
17035 .cindex "router" "changing address for errors"
17036 If a router successfully handles an address, it may assign the address to a
17037 transport for delivery or it may generate child addresses. In both cases, if
17038 there is a delivery problem during later processing, the resulting bounce
17039 message is sent to the address that results from expanding this string,
17040 provided that the address verifies successfully. The &%errors_to%& option is
17041 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17042
17043 The &%errors_to%& setting associated with an address can be overridden if it
17044 subsequently passes through other routers that have their own &%errors_to%&
17045 settings, or if the message is delivered by a transport with a &%return_path%&
17046 setting.
17047
17048 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17049 the expansion fails to verify, the errors address associated with the incoming
17050 address is used. At top level, this is the envelope sender. A non-forced
17051 expansion failure causes delivery to be deferred.
17052
17053 If an address for which &%errors_to%& has been set ends up being delivered over
17054 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17055 any bounces that are generated by other MTAs on the delivery route are also
17056 sent there. You can set &%errors_to%& to the empty string by either of these
17057 settings:
17058 .code
17059 errors_to =
17060 errors_to = ""
17061 .endd
17062 An expansion item that yields an empty string has the same effect. If you do
17063 this, a locally detected delivery error for addresses processed by this router
17064 no longer gives rise to a bounce message; the error is discarded. If the
17065 address is delivered to a remote host, the return path is set to &`<>`&, unless
17066 overridden by the &%return_path%& option on the transport.
17067
17068 .vindex "&$address_data$&"
17069 If for some reason you want to discard local errors, but use a non-empty
17070 MAIL command for remote delivery, you can preserve the original return
17071 path in &$address_data$& in the router, and reinstate it in the transport by
17072 setting &%return_path%&.
17073
17074 The most common use of &%errors_to%& is to direct mailing list bounces to the
17075 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17076 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17077
17078
17079
17080 .option expn routers&!? boolean true
17081 .cindex "address" "testing"
17082 .cindex "testing" "addresses"
17083 .cindex "EXPN" "router skipping"
17084 .cindex "router" "skipping for EXPN"
17085 If this option is turned off, the router is skipped when testing an address
17086 as a result of processing an SMTP EXPN command. You might, for example,
17087 want to turn it off on a router for users' &_.forward_& files, while leaving it
17088 on for the system alias file.
17089 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17090 are evaluated.
17091
17092 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17093 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17094 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17095
17096
17097
17098 .option fail_verify routers boolean false
17099 .cindex "router" "forcing verification failure"
17100 Setting this option has the effect of setting both &%fail_verify_sender%& and
17101 &%fail_verify_recipient%& to the same value.
17102
17103
17104
17105 .option fail_verify_recipient routers boolean false
17106 If this option is true and an address is accepted by this router when
17107 verifying a recipient, verification fails.
17108
17109
17110
17111 .option fail_verify_sender routers boolean false
17112 If this option is true and an address is accepted by this router when
17113 verifying a sender, verification fails.
17114
17115
17116
17117 .option fallback_hosts routers "string list" unset
17118 .cindex "router" "fallback hosts"
17119 .cindex "fallback" "hosts specified on router"
17120 String expansion is not applied to this option. The argument must be a
17121 colon-separated list of host names or IP addresses. The list separator can be
17122 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17123 each name or address. In fact, the format of each item is exactly the same as
17124 defined for the list of hosts in a &(manualroute)& router (see section
17125 &<<SECTformatonehostitem>>&).
17126
17127 If a router queues an address for a remote transport, this host list is
17128 associated with the address, and used instead of the transport's fallback host
17129 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17130 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17131 transport for further details.
17132
17133
17134 .option group routers string&!! "see below"
17135 .cindex "gid (group id)" "local delivery"
17136 .cindex "local transports" "uid and gid"
17137 .cindex "transport" "local"
17138 .cindex "router" "setting group"
17139 When a router queues an address for a transport, and the transport does not
17140 specify a group, the group given here is used when running the delivery
17141 process.
17142 The group may be specified numerically or by name. If expansion fails, the
17143 error is logged and delivery is deferred.
17144 The default is unset, unless &%check_local_user%& is set, when the default
17145 is taken from the password information. See also &%initgroups%& and &%user%&
17146 and the discussion in chapter &<<CHAPenvironment>>&.
17147
17148
17149
17150 .option headers_add routers list&!! unset
17151 .cindex "header lines" "adding"
17152 .cindex "router" "adding header lines"
17153 This option specifies a list of text headers, newline-separated,
17154 that is associated with any addresses that are accepted by the router.
17155 Each item is separately expanded, at routing time.  However, this
17156 option has no effect when an address is just being verified. The way in which
17157 the text is used to add header lines at transport time is described in section
17158 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17159 message is in the process of being transported. This means that references to
17160 header lines in string expansions in the transport's configuration do not
17161 &"see"& the added header lines.
17162
17163 The &%headers_add%& option is expanded after &%errors_to%&, but before
17164 &%headers_remove%& and &%transport%&. If an item is empty, or if
17165 an item expansion is forced to fail, the item has no effect. Other expansion
17166 failures are treated as configuration errors.
17167
17168 Unlike most options, &%headers_add%& can be specified multiple times
17169 for a router; all listed headers are added.
17170
17171 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17172 router that has the &%one_time%& option set.
17173
17174 .cindex "duplicate addresses"
17175 .oindex "&%unseen%&"
17176 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17177 additions are deleted when the address is passed on to subsequent routers.
17178 For a &%redirect%& router, if a generated address is the same as the incoming
17179 address, this can lead to duplicate addresses with different header
17180 modifications. Exim does not do duplicate deliveries (except, in certain
17181 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17182 which of the duplicates is discarded, so this ambiguous situation should be
17183 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17184
17185
17186
17187 .option headers_remove routers list&!! unset
17188 .cindex "header lines" "removing"
17189 .cindex "router" "removing header lines"
17190 This option specifies a list of text headers, colon-separated,
17191 that is associated with any addresses that are accepted by the router.
17192 Each item is separately expanded, at routing time.  However, this
17193 option has no effect when an address is just being verified. The way in which
17194 the text is used to remove header lines at transport time is described in
17195 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17196 the message is in the process of being transported. This means that references
17197 to header lines in string expansions in the transport's configuration still
17198 &"see"& the original header lines.
17199
17200 The &%headers_remove%& option is expanded after &%errors_to%& and
17201 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17202 the item has no effect. Other expansion failures are treated as configuration
17203 errors.
17204
17205 Unlike most options, &%headers_remove%& can be specified multiple times
17206 for a router; all listed headers are removed.
17207
17208 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17209 router that has the &%one_time%& option set.
17210
17211 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17212 removal requests are deleted when the address is passed on to subsequent
17213 routers, and this can lead to problems with duplicates -- see the similar
17214 warning for &%headers_add%& above.
17215
17216
17217 .option ignore_target_hosts routers "host list&!!" unset
17218 .cindex "IP address" "discarding"
17219 .cindex "router" "discarding IP addresses"
17220 Although this option is a host list, it should normally contain IP address
17221 entries rather than names. If any host that is looked up by the router has an
17222 IP address that matches an item in this list, Exim behaves as if that IP
17223 address did not exist. This option allows you to cope with rogue DNS entries
17224 like
17225 .code
17226 remote.domain.example.  A  127.0.0.1
17227 .endd
17228 by setting
17229 .code
17230 ignore_target_hosts = 127.0.0.1
17231 .endd
17232 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17233 discarded in this way, the router declines. In a conventional configuration, an
17234 attempt to mail to such a domain would normally provoke the &"unrouteable
17235 domain"& error, and an attempt to verify an address in the domain would fail.
17236 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17237 router declines if presented with one of the listed addresses.
17238
17239 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17240 means of the first or the second of the following settings, respectively:
17241 .code
17242 ignore_target_hosts = 0.0.0.0/0
17243 ignore_target_hosts = <; 0::0/0
17244 .endd
17245 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17246 in the second line matches all IPv6 addresses.
17247
17248 This option may also be useful for ignoring link-local and site-local IPv6
17249 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17250 is expanded before use as a list, it is possible to make it dependent on the
17251 domain that is being routed.
17252
17253 .vindex "&$host_address$&"
17254 During its expansion, &$host_address$& is set to the IP address that is being
17255 checked.
17256
17257 .option initgroups routers boolean false
17258 .cindex "additional groups"
17259 .cindex "groups" "additional"
17260 .cindex "local transports" "uid and gid"
17261 .cindex "transport" "local"
17262 If the router queues an address for a transport, and this option is true, and
17263 the uid supplied by the router is not overridden by the transport, the
17264 &[initgroups()]& function is called when running the transport to ensure that
17265 any additional groups associated with the uid are set up. See also &%group%&
17266 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17267
17268
17269
17270 .option local_part_prefix routers&!? "string list" unset
17271 .cindex "router" "prefix for local part"
17272 .cindex "prefix" "for local part, used in router"
17273 If this option is set, the router is skipped unless the local part starts with
17274 one of the given strings, or &%local_part_prefix_optional%& is true. See
17275 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17276 evaluated.
17277
17278 The list is scanned from left to right, and the first prefix that matches is
17279 used. A limited form of wildcard is available; if the prefix begins with an
17280 asterisk, it matches the longest possible sequence of arbitrary characters at
17281 the start of the local part. An asterisk should therefore always be followed by
17282 some character that does not occur in normal local parts.
17283 .cindex "multiple mailboxes"
17284 .cindex "mailbox" "multiple"
17285 Wildcarding can be used to set up multiple user mailboxes, as described in
17286 section &<<SECTmulbox>>&.
17287
17288 .vindex "&$local_part$&"
17289 .vindex "&$local_part_prefix$&"
17290 During the testing of the &%local_parts%& option, and while the router is
17291 running, the prefix is removed from the local part, and is available in the
17292 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17293 the router accepts the address, this remains true during subsequent delivery by
17294 a transport. In particular, the local part that is transmitted in the RCPT
17295 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17296 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17297 the relevant transport.
17298
17299 When an address is being verified, &%local_part_prefix%& affects only the
17300 behaviour of the router. If the callout feature of verification is in use, this
17301 means that the full address, including the prefix, will be used during the
17302 callout.
17303
17304 The prefix facility is commonly used to handle local parts of the form
17305 &%owner-something%&. Another common use is to support local parts of the form
17306 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17307 to tell a user their forwarding is broken &-- by placing a router like this one
17308 immediately before the router that handles &_.forward_& files:
17309 .code
17310 real_localuser:
17311   driver = accept
17312   local_part_prefix = real-
17313   check_local_user
17314   transport = local_delivery
17315 .endd
17316 For security, it would probably be a good idea to restrict the use of this
17317 router to locally-generated messages, using a condition such as this:
17318 .code
17319   condition = ${if match {$sender_host_address}\
17320                          {\N^(|127\.0\.0\.1)$\N}}
17321 .endd
17322
17323 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17324 both conditions must be met if not optional. Care must be taken if wildcards
17325 are used in both a prefix and a suffix on the same router. Different
17326 separator characters must be used to avoid ambiguity.
17327
17328
17329 .option local_part_prefix_optional routers boolean false
17330 See &%local_part_prefix%& above.
17331
17332
17333
17334 .option local_part_suffix routers&!? "string list" unset
17335 .cindex "router" "suffix for local part"
17336 .cindex "suffix for local part" "used in router"
17337 This option operates in the same way as &%local_part_prefix%&, except that the
17338 local part must end (rather than start) with the given string, the
17339 &%local_part_suffix_optional%& option determines whether the suffix is
17340 mandatory, and the wildcard * character, if present, must be the last
17341 character of the suffix. This option facility is commonly used to handle local
17342 parts of the form &%something-request%& and multiple user mailboxes of the form
17343 &%username-foo%&.
17344
17345
17346 .option local_part_suffix_optional routers boolean false
17347 See &%local_part_suffix%& above.
17348
17349
17350
17351 .option local_parts routers&!? "local part list&!!" unset
17352 .cindex "router" "restricting to specific local parts"
17353 .cindex "local part" "checking in router"
17354 The router is run only if the local part of the address matches the list.
17355 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17356 are evaluated, and
17357 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17358 string is expanded, it is possible to make it depend on the domain, for
17359 example:
17360 .code
17361 local_parts = dbm;/usr/local/specials/$domain
17362 .endd
17363 .vindex "&$local_part_data$&"
17364 If the match is achieved by a lookup, the data that the lookup returned
17365 for the local part is placed in the variable &$local_part_data$& for use in
17366 expansions of the router's private options. You might use this option, for
17367 example, if you have a large number of local virtual domains, and you want to
17368 send all postmaster mail to the same place without having to set up an alias in
17369 each virtual domain:
17370 .code
17371 postmaster:
17372   driver = redirect
17373   local_parts = postmaster
17374   data = postmaster@real.domain.example
17375 .endd
17376
17377
17378 .option log_as_local routers boolean "see below"
17379 .cindex "log" "delivery line"
17380 .cindex "delivery" "log line format"
17381 Exim has two logging styles for delivery, the idea being to make local
17382 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17383 recipient address is given just as the local part, without a domain. The use of
17384 this style is controlled by this option. It defaults to true for the &(accept)&
17385 router, and false for all the others. This option applies only when a
17386 router assigns an address to a transport. It has no effect on routers that
17387 redirect addresses.
17388
17389
17390
17391 .option more routers boolean&!! true
17392 The result of string expansion for this option must be a valid boolean value,
17393 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17394 result causes an error, and delivery is deferred. If the expansion is forced to
17395 fail, the default value for the option (true) is used. Other failures cause
17396 delivery to be deferred.
17397
17398 If this option is set false, and the router declines to handle the address, no
17399 further routers are tried, routing fails, and the address is bounced.
17400 .oindex "&%self%&"
17401 However, if the router explicitly passes an address to the following router by
17402 means of the setting
17403 .code
17404 self = pass
17405 .endd
17406 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17407 does not affect the behaviour if one of the precondition tests fails. In that
17408 case, the address is always passed to the next router.
17409
17410 Note that &%address_data%& is not considered to be a precondition. If its
17411 expansion is forced to fail, the router declines, and the value of &%more%&
17412 controls what happens next.
17413
17414
17415 .option pass_on_timeout routers boolean false
17416 .cindex "timeout" "of router"
17417 .cindex "router" "timeout"
17418 If a router times out during a host lookup, it normally causes deferral of the
17419 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17420 router, overriding &%no_more%&. This may be helpful for systems that are
17421 intermittently connected to the Internet, or those that want to pass to a smart
17422 host any messages that cannot immediately be delivered.
17423
17424 There are occasional other temporary errors that can occur while doing DNS
17425 lookups. They are treated in the same way as a timeout, and this option
17426 applies to all of them.
17427
17428
17429
17430 .option pass_router routers string unset
17431 .cindex "router" "go to after &""pass""&"
17432 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17433 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17434 routing to continue, and overriding a false setting of &%more%&. When one of
17435 these routers returns &"pass"&, the address is normally handed on to the next
17436 router in sequence. This can be changed by setting &%pass_router%& to the name
17437 of another router. However (unlike &%redirect_router%&) the named router must
17438 be below the current router, to avoid loops. Note that this option applies only
17439 to the special case of &"pass"&. It does not apply when a router returns
17440 &"decline"& because it cannot handle an address.
17441
17442
17443
17444 .option redirect_router routers string unset
17445 .cindex "router" "start at after redirection"
17446 Sometimes an administrator knows that it is pointless to reprocess addresses
17447 generated from alias or forward files with the same router again. For
17448 example, if an alias file translates real names into login ids there is no
17449 point searching the alias file a second time, especially if it is a large file.
17450
17451 The &%redirect_router%& option can be set to the name of any router instance.
17452 It causes the routing of any generated addresses to start at the named router
17453 instead of at the first router. This option has no effect if the router in
17454 which it is set does not generate new addresses.
17455
17456
17457
17458 .option require_files routers&!? "string list&!!" unset
17459 .cindex "file" "requiring for router"
17460 .cindex "router" "requiring file existence"
17461 This option provides a general mechanism for predicating the running of a
17462 router on the existence or non-existence of certain files or directories.
17463 Before running a router, as one of its precondition tests, Exim works its way
17464 through the &%require_files%& list, expanding each item separately.
17465
17466 Because the list is split before expansion, any colons in expansion items must
17467 be doubled, or the facility for using a different list separator must be used.
17468 If any expansion is forced to fail, the item is ignored. Other expansion
17469 failures cause routing of the address to be deferred.
17470
17471 If any expanded string is empty, it is ignored. Otherwise, except as described
17472 below, each string must be a fully qualified file path, optionally preceded by
17473 &"!"&. The paths are passed to the &[stat()]& function to test for the
17474 existence of the files or directories. The router is skipped if any paths not
17475 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17476
17477 .cindex "NFS"
17478 If &[stat()]& cannot determine whether a file exists or not, delivery of
17479 the message is deferred. This can happen when NFS-mounted filesystems are
17480 unavailable.
17481
17482 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17483 options, so you cannot use it to check for the existence of a file in which to
17484 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17485 full list of the order in which preconditions are evaluated.) However, as
17486 these options are all expanded, you can use the &%exists%& expansion condition
17487 to make such tests. The &%require_files%& option is intended for checking files
17488 that the router may be going to use internally, or which are needed by a
17489 transport (for example &_.procmailrc_&).
17490
17491 During delivery, the &[stat()]& function is run as root, but there is a
17492 facility for some checking of the accessibility of a file by another user.
17493 This is not a proper permissions check, but just a &"rough"& check that
17494 operates as follows:
17495
17496 If an item in a &%require_files%& list does not contain any forward slash
17497 characters, it is taken to be the user (and optional group, separated by a
17498 comma) to be checked for subsequent files in the list. If no group is specified
17499 but the user is specified symbolically, the gid associated with the uid is
17500 used. For example:
17501 .code
17502 require_files = mail:/some/file
17503 require_files = $local_part:$home/.procmailrc
17504 .endd
17505 If a user or group name in a &%require_files%& list does not exist, the
17506 &%require_files%& condition fails.
17507
17508 Exim performs the check by scanning along the components of the file path, and
17509 checking the access for the given uid and gid. It checks for &"x"& access on
17510 directories, and &"r"& access on the final file. Note that this means that file
17511 access control lists, if the operating system has them, are ignored.
17512
17513 &*Warning 1*&: When the router is being run to verify addresses for an
17514 incoming SMTP message, Exim is not running as root, but under its own uid. This
17515 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17516 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17517 user is not permitted to read one of the directories on the file's path.
17518
17519 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17520 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17521 without root access. In this case, if a check for access by a particular user
17522 is requested, Exim creates a subprocess that runs as that user, and tries the
17523 check again in that process.
17524
17525 The default action for handling an unresolved EACCES is to consider it to
17526 be caused by a configuration error, and routing is deferred because the
17527 existence or non-existence of the file cannot be determined. However, in some
17528 circumstances it may be desirable to treat this condition as if the file did
17529 not exist. If the file name (or the exclamation mark that precedes the file
17530 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17531 as if the file did not exist. For example:
17532 .code
17533 require_files = +/some/file
17534 .endd
17535 If the router is not an essential part of verification (for example, it
17536 handles users' &_.forward_& files), another solution is to set the &%verify%&
17537 option false so that the router is skipped when verifying.
17538
17539
17540
17541 .option retry_use_local_part routers boolean "see below"
17542 .cindex "hints database" "retry keys"
17543 .cindex "local part" "in retry keys"
17544 When a delivery suffers a temporary routing failure, a retry record is created
17545 in Exim's hints database. For addresses whose routing depends only on the
17546 domain, the key for the retry record should not involve the local part, but for
17547 other addresses, both the domain and the local part should be included.
17548 Usually, remote routing is of the former kind, and local routing is of the
17549 latter kind.
17550
17551 This option controls whether the local part is used to form the key for retry
17552 hints for addresses that suffer temporary errors while being handled by this
17553 router. The default value is true for any router that has &%check_local_user%&
17554 set, and false otherwise. Note that this option does not apply to hints keys
17555 for transport delays; they are controlled by a generic transport option of the
17556 same name.
17557
17558 The setting of &%retry_use_local_part%& applies only to the router on which it
17559 appears. If the router generates child addresses, they are routed
17560 independently; this setting does not become attached to them.
17561
17562
17563
17564 .option router_home_directory routers string&!! unset
17565 .cindex "router" "home directory for"
17566 .cindex "home directory" "for router"
17567 .vindex "&$home$&"
17568 This option sets a home directory for use while the router is running. (Compare
17569 &%transport_home_directory%&, which sets a home directory for later
17570 transporting.) In particular, if used on a &(redirect)& router, this option
17571 sets a value for &$home$& while a filter is running. The value is expanded;
17572 forced expansion failure causes the option to be ignored &-- other failures
17573 cause the router to defer.
17574
17575 Expansion of &%router_home_directory%& happens immediately after the
17576 &%check_local_user%& test (if configured), before any further expansions take
17577 place.
17578 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17579 are evaluated.)
17580 While the router is running, &%router_home_directory%& overrides the value of
17581 &$home$& that came from &%check_local_user%&.
17582
17583 When a router accepts an address and assigns it to a local transport (including
17584 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17585 delivery), the home directory setting for the transport is taken from the first
17586 of these values that is set:
17587
17588 .ilist
17589 The &%home_directory%& option on the transport;
17590 .next
17591 The &%transport_home_directory%& option on the router;
17592 .next
17593 The password data if &%check_local_user%& is set on the router;
17594 .next
17595 The &%router_home_directory%& option on the router.
17596 .endlist
17597
17598 In other words, &%router_home_directory%& overrides the password data for the
17599 router, but not for the transport.
17600
17601
17602
17603 .option self routers string freeze
17604 .cindex "MX record" "pointing to local host"
17605 .cindex "local host" "MX pointing to"
17606 This option applies to those routers that use a recipient address to find a
17607 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17608 and &(manualroute)& routers.
17609 Certain configurations of the &(queryprogram)& router can also specify a list
17610 of remote hosts.
17611 Usually such routers are configured to send the message to a remote host via an
17612 &(smtp)& transport. The &%self%& option specifies what happens when the first
17613 host on the list turns out to be the local host.
17614 The way in which Exim checks for the local host is described in section
17615 &<<SECTreclocipadd>>&.
17616
17617 Normally this situation indicates either an error in Exim's configuration (for
17618 example, the router should be configured not to process this domain), or an
17619 error in the DNS (for example, the MX should not point to this host). For this
17620 reason, the default action is to log the incident, defer the address, and
17621 freeze the message. The following alternatives are provided for use in special
17622 cases:
17623
17624 .vlist
17625 .vitem &%defer%&
17626 Delivery of the message is tried again later, but the message is not frozen.
17627
17628 .vitem "&%reroute%&: <&'domain'&>"
17629 The domain is changed to the given domain, and the address is passed back to
17630 be reprocessed by the routers. No rewriting of headers takes place. This
17631 behaviour is essentially a redirection.
17632
17633 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17634 The domain is changed to the given domain, and the address is passed back to be
17635 reprocessed by the routers. Any headers that contain the original domain are
17636 rewritten.
17637
17638 .vitem &%pass%&
17639 .oindex "&%more%&"
17640 .vindex "&$self_hostname$&"
17641 The router passes the address to the next router, or to the router named in the
17642 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17643 subsequent routing and delivery, the variable &$self_hostname$& contains the
17644 name of the local host that the router encountered. This can be used to
17645 distinguish between different cases for hosts with multiple names. The
17646 combination
17647 .code
17648 self = pass
17649 no_more
17650 .endd
17651 ensures that only those addresses that routed to the local host are passed on.
17652 Without &%no_more%&, addresses that were declined for other reasons would also
17653 be passed to the next router.
17654
17655 .vitem &%fail%&
17656 Delivery fails and an error report is generated.
17657
17658 .vitem &%send%&
17659 .cindex "local host" "sending to"
17660 The anomaly is ignored and the address is queued for the transport. This
17661 setting should be used with extreme caution. For an &(smtp)& transport, it
17662 makes sense only in cases where the program that is listening on the SMTP port
17663 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17664 different configuration file that handles the domain in another way.
17665 .endlist
17666
17667
17668
17669 .option senders routers&!? "address list&!!" unset
17670 .cindex "router" "checking senders"
17671 If this option is set, the router is skipped unless the message's sender
17672 address matches something on the list.
17673 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17674 are evaluated.
17675
17676 There are issues concerning verification when the running of routers is
17677 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17678 setting, it sets the sender to the null string. When using the &%-bt%& option
17679 to check a configuration file, it is necessary also to use the &%-f%& option to
17680 set an appropriate sender. For incoming mail, the sender is unset when
17681 verifying the sender, but is available when verifying any recipients. If the
17682 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17683 matters.
17684
17685
17686 .option translate_ip_address routers string&!! unset
17687 .cindex "IP address" "translating"
17688 .cindex "packet radio"
17689 .cindex "router" "IP address translation"
17690 There exist some rare networking situations (for example, packet radio) where
17691 it is helpful to be able to translate IP addresses generated by normal routing
17692 mechanisms into other IP addresses, thus performing a kind of manual IP
17693 routing. This should be done only if the normal IP routing of the TCP/IP stack
17694 is inadequate or broken. Because this is an extremely uncommon requirement, the
17695 code to support this option is not included in the Exim binary unless
17696 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17697
17698 .vindex "&$host_address$&"
17699 The &%translate_ip_address%& string is expanded for every IP address generated
17700 by the router, with the generated address set in &$host_address$&. If the
17701 expansion is forced to fail, no action is taken.
17702 For any other expansion error, delivery of the message is deferred.
17703 If the result of the expansion is an IP address, that replaces the original
17704 address; otherwise the result is assumed to be a host name &-- this is looked
17705 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17706 produce one or more replacement IP addresses. For example, to subvert all IP
17707 addresses in some specific networks, this could be added to a router:
17708 .code
17709 translate_ip_address = \
17710   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17711     {$value}fail}}
17712 .endd
17713 The file would contain lines like
17714 .code
17715 10.2.3.128/26    some.host
17716 10.8.4.34/26     10.44.8.15
17717 .endd
17718 You should not make use of this facility unless you really understand what you
17719 are doing.
17720
17721
17722
17723 .option transport routers string&!! unset
17724 This option specifies the transport to be used when a router accepts an address
17725 and sets it up for delivery. A transport is never needed if a router is used
17726 only for verification. The value of the option is expanded at routing time,
17727 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17728 and result must be the name of one of the configured transports. If it is not,
17729 delivery is deferred.
17730
17731 The &%transport%& option is not used by the &(redirect)& router, but it does
17732 have some private options that set up transports for pipe and file deliveries
17733 (see chapter &<<CHAPredirect>>&).
17734
17735
17736
17737 .option transport_current_directory routers string&!! unset
17738 .cindex "current directory for local transport"
17739 This option associates a current directory with any address that is routed
17740 to a local transport. This can happen either because a transport is
17741 explicitly configured for the router, or because it generates a delivery to a
17742 file or a pipe. During the delivery process (that is, at transport time), this
17743 option string is expanded and is set as the current directory, unless
17744 overridden by a setting on the transport.
17745 If the expansion fails for any reason, including forced failure, an error is
17746 logged, and delivery is deferred.
17747 See chapter &<<CHAPenvironment>>& for details of the local delivery
17748 environment.
17749
17750
17751
17752
17753 .option transport_home_directory routers string&!! "see below"
17754 .cindex "home directory" "for local transport"
17755 This option associates a home directory with any address that is routed to a
17756 local transport. This can happen either because a transport is explicitly
17757 configured for the router, or because it generates a delivery to a file or a
17758 pipe. During the delivery process (that is, at transport time), the option
17759 string is expanded and is set as the home directory, unless overridden by a
17760 setting of &%home_directory%& on the transport.
17761 If the expansion fails for any reason, including forced failure, an error is
17762 logged, and delivery is deferred.
17763
17764 If the transport does not specify a home directory, and
17765 &%transport_home_directory%& is not set for the router, the home directory for
17766 the transport is taken from the password data if &%check_local_user%& is set for
17767 the router. Otherwise it is taken from &%router_home_directory%& if that option
17768 is set; if not, no home directory is set for the transport.
17769
17770 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17771 environment.
17772
17773
17774
17775
17776 .option unseen routers boolean&!! false
17777 .cindex "router" "carrying on after success"
17778 The result of string expansion for this option must be a valid boolean value,
17779 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17780 result causes an error, and delivery is deferred. If the expansion is forced to
17781 fail, the default value for the option (false) is used. Other failures cause
17782 delivery to be deferred.
17783
17784 When this option is set true, routing does not cease if the router accepts the
17785 address. Instead, a copy of the incoming address is passed to the next router,
17786 overriding a false setting of &%more%&. There is little point in setting
17787 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17788 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17789 sometimes true and sometimes false).
17790
17791 .cindex "copy of message (&%unseen%& option)"
17792 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17793 qualifier in filter files. It can be used to cause copies of messages to be
17794 delivered to some other destination, while also carrying out a normal delivery.
17795 In effect, the current address is made into a &"parent"& that has two children
17796 &-- one that is delivered as specified by this router, and a clone that goes on
17797 to be routed further. For this reason, &%unseen%& may not be combined with the
17798 &%one_time%& option in a &(redirect)& router.
17799
17800 &*Warning*&: Header lines added to the address (or specified for removal) by
17801 this router or by previous routers affect the &"unseen"& copy of the message
17802 only. The clone that continues to be processed by further routers starts with
17803 no added headers and none specified for removal. For a &%redirect%& router, if
17804 a generated address is the same as the incoming address, this can lead to
17805 duplicate addresses with different header modifications. Exim does not do
17806 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17807 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17808 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17809 &%redirect%& router may be of help.
17810
17811 Unlike the handling of header modifications, any data that was set by the
17812 &%address_data%& option in the current or previous routers &'is'& passed on to
17813 subsequent routers.
17814
17815
17816 .option user routers string&!! "see below"
17817 .cindex "uid (user id)" "local delivery"
17818 .cindex "local transports" "uid and gid"
17819 .cindex "transport" "local"
17820 .cindex "router" "user for filter processing"
17821 .cindex "filter" "user for processing"
17822 When a router queues an address for a transport, and the transport does not
17823 specify a user, the user given here is used when running the delivery process.
17824 The user may be specified numerically or by name. If expansion fails, the
17825 error is logged and delivery is deferred.
17826 This user is also used by the &(redirect)& router when running a filter file.
17827 The default is unset, except when &%check_local_user%& is set. In this case,
17828 the default is taken from the password information. If the user is specified as
17829 a name, and &%group%& is not set, the group associated with the user is used.
17830 See also &%initgroups%& and &%group%& and the discussion in chapter
17831 &<<CHAPenvironment>>&.
17832
17833
17834
17835 .option verify routers&!? boolean true
17836 Setting this option has the effect of setting &%verify_sender%& and
17837 &%verify_recipient%& to the same value.
17838
17839
17840 .option verify_only routers&!? boolean false
17841 .cindex "EXPN" "with &%verify_only%&"
17842 .oindex "&%-bv%&"
17843 .cindex "router" "used only when verifying"
17844 If this option is set, the router is used only when verifying an address,
17845 delivering in cutthrough mode or
17846 testing with the &%-bv%& option, not when actually doing a delivery, testing
17847 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17848 restricted to verifying only senders or recipients by means of
17849 &%verify_sender%& and &%verify_recipient%&.
17850
17851 &*Warning*&: When the router is being run to verify addresses for an incoming
17852 SMTP message, Exim is not running as root, but under its own uid. If the router
17853 accesses any files, you need to make sure that they are accessible to the Exim
17854 user or group.
17855
17856
17857 .option verify_recipient routers&!? boolean true
17858 If this option is false, the router is skipped when verifying recipient
17859 addresses,
17860 delivering in cutthrough mode
17861 or testing recipient verification using &%-bv%&.
17862 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17863 are evaluated.
17864 See also the &$verify_mode$& variable.
17865
17866
17867 .option verify_sender routers&!? boolean true
17868 If this option is false, the router is skipped when verifying sender addresses
17869 or testing sender verification using &%-bvs%&.
17870 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17871 are evaluated.
17872 See also the &$verify_mode$& variable.
17873 .ecindex IIDgenoprou1
17874 .ecindex IIDgenoprou2
17875
17876
17877
17878
17879
17880
17881 . ////////////////////////////////////////////////////////////////////////////
17882 . ////////////////////////////////////////////////////////////////////////////
17883
17884 .chapter "The accept router" "CHID4"
17885 .cindex "&(accept)& router"
17886 .cindex "routers" "&(accept)&"
17887 The &(accept)& router has no private options of its own. Unless it is being
17888 used purely for verification (see &%verify_only%&) a transport is required to
17889 be defined by the generic &%transport%& option. If the preconditions that are
17890 specified by generic options are met, the router accepts the address and queues
17891 it for the given transport. The most common use of this router is for setting
17892 up deliveries to local mailboxes. For example:
17893 .code
17894 localusers:
17895   driver = accept
17896   domains = mydomain.example
17897   check_local_user
17898   transport = local_delivery
17899 .endd
17900 The &%domains%& condition in this example checks the domain of the address, and
17901 &%check_local_user%& checks that the local part is the login of a local user.
17902 When both preconditions are met, the &(accept)& router runs, and queues the
17903 address for the &(local_delivery)& transport.
17904
17905
17906
17907
17908
17909
17910 . ////////////////////////////////////////////////////////////////////////////
17911 . ////////////////////////////////////////////////////////////////////////////
17912
17913 .chapter "The dnslookup router" "CHAPdnslookup"
17914 .scindex IIDdnsrou1 "&(dnslookup)& router"
17915 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17916 The &(dnslookup)& router looks up the hosts that handle mail for the
17917 recipient's domain in the DNS. A transport must always be set for this router,
17918 unless &%verify_only%& is set.
17919
17920 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17921 SRV records. If none are found, or if SRV support is not configured,
17922 MX records are looked up. If no MX records exist, address records are sought.
17923 However, &%mx_domains%& can be set to disable the direct use of address
17924 records.
17925
17926 MX records of equal priority are sorted by Exim into a random order. Exim then
17927 looks for address records for the host names obtained from MX or SRV records.
17928 When a host has more than one IP address, they are sorted into a random order,
17929 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17930 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17931 generic option, the router declines.
17932
17933 Unless they have the highest priority (lowest MX value), MX records that point
17934 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17935 are discarded, together with any other MX records of equal or lower priority.
17936
17937 .cindex "MX record" "pointing to local host"
17938 .cindex "local host" "MX pointing to"
17939 .oindex "&%self%&" "in &(dnslookup)& router"
17940 If the host pointed to by the highest priority MX record, or looked up as an
17941 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17942 happens is controlled by the generic &%self%& option.
17943
17944
17945 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17946 There have been problems with DNS servers when SRV records are looked up.
17947 Some mis-behaving servers return a DNS error or timeout when a non-existent
17948 SRV record is sought. Similar problems have in the past been reported for
17949 MX records. The global &%dns_again_means_nonexist%& option can help with this
17950 problem, but it is heavy-handed because it is a global option.
17951
17952 For this reason, there are two options, &%srv_fail_domains%& and
17953 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17954 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17955 an attempt to look up an SRV or MX record causes one of these results, and the
17956 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17957 such record"&. In the case of an SRV lookup, this means that the router
17958 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17959 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17960 case routing fails.
17961
17962
17963 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17964 .cindex "&(dnslookup)& router" "declines"
17965 There are a few cases where a &(dnslookup)& router will decline to accept
17966 an address; if such a router is expected to handle "all remaining non-local
17967 domains", then it is important to set &%no_more%&.
17968
17969 Reasons for a &(dnslookup)& router to decline currently include:
17970 .ilist
17971 The domain does not exist in DNS
17972 .next
17973 The domain exists but the MX record's host part is just "."; this is a common
17974 convention (borrowed from SRV) used to indicate that there is no such service
17975 for this domain and to not fall back to trying A/AAAA records.
17976 .next
17977 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17978 .next
17979 MX record points to a non-existent host.
17980 .next
17981 MX record points to an IP address and the main section option
17982 &%allow_mx_to_ip%& is not set.
17983 .next
17984 MX records exist and point to valid hosts, but all hosts resolve only to
17985 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17986 .next
17987 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17988 &%dns_check_names_pattern%& for handling one variant of this)
17989 .next
17990 &%check_secondary_mx%& is set on this router but the local host can
17991 not be found in the MX records (see below)
17992 .endlist
17993
17994
17995
17996
17997 .section "Private options for dnslookup" "SECID118"
17998 .cindex "options" "&(dnslookup)& router"
17999 The private options for the &(dnslookup)& router are as follows:
18000
18001 .option check_secondary_mx dnslookup boolean false
18002 .cindex "MX record" "checking for secondary"
18003 If this option is set, the router declines unless the local host is found in
18004 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18005 process domains for which the local host is a secondary mail exchanger
18006 differently to other domains. The way in which Exim decides whether a host is
18007 the local host is described in section &<<SECTreclocipadd>>&.
18008
18009
18010 .option check_srv dnslookup string&!! unset
18011 .cindex "SRV record" "enabling use of"
18012 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18013 addition to MX and address records. The support is disabled by default. To
18014 enable SRV support, set the &%check_srv%& option to the name of the service
18015 required. For example,
18016 .code
18017 check_srv = smtp
18018 .endd
18019 looks for SRV records that refer to the normal smtp service. The option is
18020 expanded, so the service name can vary from message to message or address
18021 to address. This might be helpful if SRV records are being used for a
18022 submission service. If the expansion is forced to fail, the &%check_srv%&
18023 option is ignored, and the router proceeds to look for MX records in the
18024 normal way.
18025
18026 When the expansion succeeds, the router searches first for SRV records for
18027 the given service (it assumes TCP protocol). A single SRV record with a
18028 host name that consists of just a single dot indicates &"no such service for
18029 this domain"&; if this is encountered, the router declines. If other kinds of
18030 SRV record are found, they are used to construct a host list for delivery
18031 according to the rules of RFC 2782. MX records are not sought in this case.
18032
18033 When no SRV records are found, MX records (and address records) are sought in
18034 the traditional way. In other words, SRV records take precedence over MX
18035 records, just as MX records take precedence over address records. Note that
18036 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18037 defined it. It is apparently believed that MX records are sufficient for email
18038 and that SRV records should not be used for this purpose. However, SRV records
18039 have an additional &"weight"& feature which some people might find useful when
18040 trying to split an SMTP load between hosts of different power.
18041
18042 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18043 when there is a DNS lookup error.
18044
18045
18046
18047 .option dnssec_request_domains dnslookup "domain list&!!" unset
18048 .cindex "MX record" "security"
18049 .cindex "DNSSEC" "MX lookup"
18050 .cindex "security" "MX lookup"
18051 .cindex "DNS" "DNSSEC"
18052 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18053 the dnssec request bit set.
18054 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
18055
18056
18057
18058 .option dnssec_require_domains dnslookup "domain list&!!" unset
18059 .cindex "MX record" "security"
18060 .cindex "DNSSEC" "MX lookup"
18061 .cindex "security" "MX lookup"
18062 .cindex "DNS" "DNSSEC"
18063 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18064 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18065 (AD bit) set wil be ignored and logged as a host-lookup failure.
18066 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
18067
18068
18069
18070 .option mx_domains dnslookup "domain list&!!" unset
18071 .cindex "MX record" "required to exist"
18072 .cindex "SRV record" "required to exist"
18073 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18074 record in order to be recognized. (The name of this option could be improved.)
18075 For example, if all the mail hosts in &'fict.example'& are known to have MX
18076 records, except for those in &'discworld.fict.example'&, you could use this
18077 setting:
18078 .code
18079 mx_domains = ! *.discworld.fict.example : *.fict.example
18080 .endd
18081 This specifies that messages addressed to a domain that matches the list but
18082 has no MX record should be bounced immediately instead of being routed using
18083 the address record.
18084
18085
18086 .option mx_fail_domains dnslookup "domain list&!!" unset
18087 If the DNS lookup for MX records for one of the domains in this list causes a
18088 DNS lookup error, Exim behaves as if no MX records were found. See section
18089 &<<SECTprowitdnsloo>>& for more discussion.
18090
18091
18092
18093
18094 .option qualify_single dnslookup boolean true
18095 .cindex "DNS" "resolver options"
18096 .cindex "DNS" "qualifying single-component names"
18097 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18098 lookups. Typically, but not standardly, this causes the resolver to qualify
18099 single-component names with the default domain. For example, on a machine
18100 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18101 &'thesaurus.ref.example'& inside the resolver. For details of what your
18102 resolver actually does, consult your man pages for &'resolver'& and
18103 &'resolv.conf'&.
18104
18105
18106
18107 .option rewrite_headers dnslookup boolean true
18108 .cindex "rewriting" "header lines"
18109 .cindex "header lines" "rewriting"
18110 If the domain name in the address that is being processed is not fully
18111 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18112 an address is specified as &'dormouse@teaparty'&, the domain might be
18113 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18114 occur as a result of setting the &%widen_domains%& option. If
18115 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18116 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18117 header lines of the message are rewritten with the full domain name.
18118
18119 This option should be turned off only when it is known that no message is
18120 ever going to be sent outside an environment where the abbreviation makes
18121 sense.
18122
18123 When an MX record is looked up in the DNS and matches a wildcard record, name
18124 servers normally return a record containing the name that has been looked up,
18125 making it impossible to detect whether a wildcard was present or not. However,
18126 some name servers have recently been seen to return the wildcard entry. If the
18127 name returned by a DNS lookup begins with an asterisk, it is not used for
18128 header rewriting.
18129
18130
18131 .option same_domain_copy_routing dnslookup boolean false
18132 .cindex "address" "copying routing"
18133 Addresses with the same domain are normally routed by the &(dnslookup)& router
18134 to the same list of hosts. However, this cannot be presumed, because the router
18135 options and preconditions may refer to the local part of the address. By
18136 default, therefore, Exim routes each address in a message independently. DNS
18137 servers run caches, so repeated DNS lookups are not normally expensive, and in
18138 any case, personal messages rarely have more than a few recipients.
18139
18140 If you are running mailing lists with large numbers of subscribers at the same
18141 domain, and you are using a &(dnslookup)& router which is independent of the
18142 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18143 lookups for identical domains in one message. In this case, when &(dnslookup)&
18144 routes an address to a remote transport, any other unrouted addresses in the
18145 message that have the same domain are automatically given the same routing
18146 without processing them independently,
18147 provided the following conditions are met:
18148
18149 .ilist
18150 No router that processed the address specified &%headers_add%& or
18151 &%headers_remove%&.
18152 .next
18153 The router did not change the address in any way, for example, by &"widening"&
18154 the domain.
18155 .endlist
18156
18157
18158
18159
18160 .option search_parents dnslookup boolean false
18161 .cindex "DNS" "resolver options"
18162 When this option is true, the resolver option RES_DNSRCH is set for DNS
18163 lookups. This is different from the &%qualify_single%& option in that it
18164 applies to domains containing dots. Typically, but not standardly, it causes
18165 the resolver to search for the name in the current domain and in parent
18166 domains. For example, on a machine in the &'fict.example'& domain, if looking
18167 up &'teaparty.wonderland'& failed, the resolver would try
18168 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18169 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18170
18171 Setting this option true can cause problems in domains that have a wildcard MX
18172 record, because any domain that does not have its own MX record matches the
18173 local wildcard.
18174
18175
18176
18177 .option srv_fail_domains dnslookup "domain list&!!" unset
18178 If the DNS lookup for SRV records for one of the domains in this list causes a
18179 DNS lookup error, Exim behaves as if no SRV records were found. See section
18180 &<<SECTprowitdnsloo>>& for more discussion.
18181
18182
18183
18184
18185 .option widen_domains dnslookup "string list" unset
18186 .cindex "domain" "partial; widening"
18187 If a DNS lookup fails and this option is set, each of its strings in turn is
18188 added onto the end of the domain, and the lookup is tried again. For example,
18189 if
18190 .code
18191 widen_domains = fict.example:ref.example
18192 .endd
18193 is set and a lookup of &'klingon.dictionary'& fails,
18194 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18195 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18196 and &%search_parents%& options can cause some widening to be undertaken inside
18197 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18198 when verifying, unless &%rewrite_headers%& is false (not the default).
18199
18200
18201 .section "Effect of qualify_single and search_parents" "SECID119"
18202 When a domain from an envelope recipient is changed by the resolver as a result
18203 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18204 corresponding address in the message's header lines unless &%rewrite_headers%&
18205 is set false. Exim then re-routes the address, using the full domain.
18206
18207 These two options affect only the DNS lookup that takes place inside the router
18208 for the domain of the address that is being routed. They do not affect lookups
18209 such as that implied by
18210 .code
18211 domains = @mx_any
18212 .endd
18213 that may happen while processing a router precondition before the router is
18214 entered. No widening ever takes place for these lookups.
18215 .ecindex IIDdnsrou1
18216 .ecindex IIDdnsrou2
18217
18218
18219
18220
18221
18222
18223
18224
18225
18226 . ////////////////////////////////////////////////////////////////////////////
18227 . ////////////////////////////////////////////////////////////////////////////
18228
18229 .chapter "The ipliteral router" "CHID5"
18230 .cindex "&(ipliteral)& router"
18231 .cindex "domain literal" "routing"
18232 .cindex "routers" "&(ipliteral)&"
18233 This router has no private options. Unless it is being used purely for
18234 verification (see &%verify_only%&) a transport is required to be defined by the
18235 generic &%transport%& option. The router accepts the address if its domain part
18236 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18237 router handles the address
18238 .code
18239 root@[192.168.1.1]
18240 .endd
18241 by setting up delivery to the host with that IP address. IPv4 domain literals
18242 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18243 are similar, but the address is preceded by &`ipv6:`&. For example:
18244 .code
18245 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18246 .endd
18247 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18248 grounds that sooner or later somebody will try it.
18249
18250 .oindex "&%self%&" "in &(ipliteral)& router"
18251 If the IP address matches something in &%ignore_target_hosts%&, the router
18252 declines. If an IP literal turns out to refer to the local host, the generic
18253 &%self%& option determines what happens.
18254
18255 The RFCs require support for domain literals; however, their use is
18256 controversial in today's Internet. If you want to use this router, you must
18257 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18258 Exim will not recognize the domain literal syntax in addresses.
18259
18260
18261
18262 . ////////////////////////////////////////////////////////////////////////////
18263 . ////////////////////////////////////////////////////////////////////////////
18264
18265 .chapter "The iplookup router" "CHID6"
18266 .cindex "&(iplookup)& router"
18267 .cindex "routers" "&(iplookup)&"
18268 The &(iplookup)& router was written to fulfil a specific requirement in
18269 Cambridge University (which in fact no longer exists). For this reason, it is
18270 not included in the binary of Exim by default. If you want to include it, you
18271 must set
18272 .code
18273 ROUTER_IPLOOKUP=yes
18274 .endd
18275 in your &_Local/Makefile_& configuration file.
18276
18277 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18278 connection to one or more specific hosts. The host can then return the same or
18279 a different address &-- in effect rewriting the recipient address in the
18280 message's envelope. The new address is then passed on to subsequent routers. If
18281 this process fails, the address can be passed on to other routers, or delivery
18282 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18283 must not be specified for it.
18284
18285 .cindex "options" "&(iplookup)& router"
18286 .option hosts iplookup string unset
18287 This option must be supplied. Its value is a colon-separated list of host
18288 names. The hosts are looked up using &[gethostbyname()]&
18289 (or &[getipnodebyname()]& when available)
18290 and are tried in order until one responds to the query. If none respond, what
18291 happens is controlled by &%optional%&.
18292
18293
18294 .option optional iplookup boolean false
18295 If &%optional%& is true, if no response is obtained from any host, the address
18296 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18297 delivery to the address is deferred.
18298
18299
18300 .option port iplookup integer 0
18301 .cindex "port" "&(iplookup)& router"
18302 This option must be supplied. It specifies the port number for the TCP or UDP
18303 call.
18304
18305
18306 .option protocol iplookup string udp
18307 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18308 protocols is to be used.
18309
18310
18311 .option query iplookup string&!! "see below"
18312 This defines the content of the query that is sent to the remote hosts. The
18313 default value is:
18314 .code
18315 $local_part@$domain $local_part@$domain
18316 .endd
18317 The repetition serves as a way of checking that a response is to the correct
18318 query in the default case (see &%response_pattern%& below).
18319
18320
18321 .option reroute iplookup string&!! unset
18322 If this option is not set, the rerouted address is precisely the byte string
18323 returned by the remote host, up to the first white space, if any. If set, the
18324 string is expanded to form the rerouted address. It can include parts matched
18325 in the response by &%response_pattern%& by means of numeric variables such as
18326 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18327 whether or not a pattern is in use. In all cases, the rerouted address must end
18328 up in the form &'local_part@domain'&.
18329
18330
18331 .option response_pattern iplookup string unset
18332 This option can be set to a regular expression that is applied to the string
18333 returned from the remote host. If the pattern does not match the response, the
18334 router declines. If &%response_pattern%& is not set, no checking of the
18335 response is done, unless the query was defaulted, in which case there is a
18336 check that the text returned after the first white space is the original
18337 address. This checks that the answer that has been received is in response to
18338 the correct question. For example, if the response is just a new domain, the
18339 following could be used:
18340 .code
18341 response_pattern = ^([^@]+)$
18342 reroute = $local_part@$1
18343 .endd
18344
18345 .option timeout iplookup time 5s
18346 This specifies the amount of time to wait for a response from the remote
18347 machine. The same timeout is used for the &[connect()]& function for a TCP
18348 call. It does not apply to UDP.
18349
18350
18351
18352
18353 . ////////////////////////////////////////////////////////////////////////////
18354 . ////////////////////////////////////////////////////////////////////////////
18355
18356 .chapter "The manualroute router" "CHID7"
18357 .scindex IIDmanrou1 "&(manualroute)& router"
18358 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18359 .cindex "domain" "manually routing"
18360 The &(manualroute)& router is so-called because it provides a way of manually
18361 routing an address according to its domain. It is mainly used when you want to
18362 route addresses to remote hosts according to your own rules, bypassing the
18363 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18364 route to local transports, a facility that may be useful if you want to save
18365 messages for dial-in hosts in local files.
18366
18367 The &(manualroute)& router compares a list of domain patterns with the domain
18368 it is trying to route. If there is no match, the router declines. Each pattern
18369 has associated with it a list of hosts and some other optional data, which may
18370 include a transport. The combination of a pattern and its data is called a
18371 &"routing rule"&. For patterns that do not have an associated transport, the
18372 generic &%transport%& option must specify a transport, unless the router is
18373 being used purely for verification (see &%verify_only%&).
18374
18375 .vindex "&$host$&"
18376 In the case of verification, matching the domain pattern is sufficient for the
18377 router to accept the address. When actually routing an address for delivery,
18378 an address that matches a domain pattern is queued for the associated
18379 transport. If the transport is not a local one, a host list must be associated
18380 with the pattern; IP addresses are looked up for the hosts, and these are
18381 passed to the transport along with the mail address. For local transports, a
18382 host list is optional. If it is present, it is passed in &$host$& as a single
18383 text string.
18384
18385 The list of routing rules can be provided as an inline string in
18386 &%route_list%&, or the data can be obtained by looking up the domain in a file
18387 or database by setting &%route_data%&. Only one of these settings may appear in
18388 any one instance of &(manualroute)&. The format of routing rules is described
18389 below, following the list of private options.
18390
18391
18392 .section "Private options for manualroute" "SECTprioptman"
18393
18394 .cindex "options" "&(manualroute)& router"
18395 The private options for the &(manualroute)& router are as follows:
18396
18397 .option host_all_ignored manualroute string defer
18398 See &%host_find_failed%&.
18399
18400 .option host_find_failed manualroute string freeze
18401 This option controls what happens when &(manualroute)& tries to find an IP
18402 address for a host, and the host does not exist. The option can be set to one
18403 of the following values:
18404 .code
18405 decline
18406 defer
18407 fail
18408 freeze
18409 ignore
18410 pass
18411 .endd
18412 The default (&"freeze"&) assumes that this state is a serious configuration
18413 error. The difference between &"pass"& and &"decline"& is that the former
18414 forces the address to be passed to the next router (or the router defined by
18415 &%pass_router%&),
18416 .oindex "&%more%&"
18417 overriding &%no_more%&, whereas the latter passes the address to the next
18418 router only if &%more%& is true.
18419
18420 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18421 cannot be found. If all the hosts in the list are ignored, the behaviour is
18422 controlled by the &%host_all_ignored%& option. This takes the same values
18423 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18424
18425 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18426 state; if a host lookup gets a temporary error, delivery is deferred unless the
18427 generic &%pass_on_timeout%& option is set.
18428
18429
18430 .option hosts_randomize manualroute boolean false
18431 .cindex "randomized host list"
18432 .cindex "host" "list of; randomized"
18433 If this option is set, the order of the items in a host list in a routing rule
18434 is randomized each time the list is used, unless an option in the routing rule
18435 overrides (see below). Randomizing the order of a host list can be used to do
18436 crude load sharing. However, if more than one mail address is routed by the
18437 same router to the same host list, the host lists are considered to be the same
18438 (even though they may be randomized into different orders) for the purpose of
18439 deciding whether to batch the deliveries into a single SMTP transaction.
18440
18441 When &%hosts_randomize%& is true, a host list may be split
18442 into groups whose order is separately randomized. This makes it possible to
18443 set up MX-like behaviour. The boundaries between groups are indicated by an
18444 item that is just &`+`& in the host list. For example:
18445 .code
18446 route_list = * host1:host2:host3:+:host4:host5
18447 .endd
18448 The order of the first three hosts and the order of the last two hosts is
18449 randomized for each use, but the first three always end up before the last two.
18450 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18451 randomized host list is passed to an &(smtp)& transport that also has
18452 &%hosts_randomize set%&, the list is not re-randomized.
18453
18454
18455 .option route_data manualroute string&!! unset
18456 If this option is set, it must expand to yield the data part of a routing rule.
18457 Typically, the expansion string includes a lookup based on the domain. For
18458 example:
18459 .code
18460 route_data = ${lookup{$domain}dbm{/etc/routes}}
18461 .endd
18462 If the expansion is forced to fail, or the result is an empty string, the
18463 router declines. Other kinds of expansion failure cause delivery to be
18464 deferred.
18465
18466
18467 .option route_list manualroute "string list" unset
18468 This string is a list of routing rules, in the form defined below. Note that,
18469 unlike most string lists, the items are separated by semicolons. This is so
18470 that they may contain colon-separated host lists.
18471
18472
18473 .option same_domain_copy_routing manualroute boolean false
18474 .cindex "address" "copying routing"
18475 Addresses with the same domain are normally routed by the &(manualroute)&
18476 router to the same list of hosts. However, this cannot be presumed, because the
18477 router options and preconditions may refer to the local part of the address. By
18478 default, therefore, Exim routes each address in a message independently. DNS
18479 servers run caches, so repeated DNS lookups are not normally expensive, and in
18480 any case, personal messages rarely have more than a few recipients.
18481
18482 If you are running mailing lists with large numbers of subscribers at the same
18483 domain, and you are using a &(manualroute)& router which is independent of the
18484 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18485 lookups for identical domains in one message. In this case, when
18486 &(manualroute)& routes an address to a remote transport, any other unrouted
18487 addresses in the message that have the same domain are automatically given the
18488 same routing without processing them independently. However, this is only done
18489 if &%headers_add%& and &%headers_remove%& are unset.
18490
18491
18492
18493
18494 .section "Routing rules in route_list" "SECID120"
18495 The value of &%route_list%& is a string consisting of a sequence of routing
18496 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18497 entered as two semicolons. Alternatively, the list separator can be changed as
18498 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18499 Empty rules are ignored. The format of each rule is
18500 .display
18501 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18502 .endd
18503 The following example contains two rules, each with a simple domain pattern and
18504 no options:
18505 .code
18506 route_list = \
18507   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18508   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18509 .endd
18510 The three parts of a rule are separated by white space. The pattern and the
18511 list of hosts can be enclosed in quotes if necessary, and if they are, the
18512 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18513 single domain pattern, which is the only mandatory item in the rule. The
18514 pattern is in the same format as one item in a domain list (see section
18515 &<<SECTdomainlist>>&),
18516 except that it may not be the name of an interpolated file.
18517 That is, it may be wildcarded, or a regular expression, or a file or database
18518 lookup (with semicolons doubled, because of the use of semicolon as a separator
18519 in a &%route_list%&).
18520
18521 The rules in &%route_list%& are searched in order until one of the patterns
18522 matches the domain that is being routed. The list of hosts and then options are
18523 then used as described below. If there is no match, the router declines. When
18524 &%route_list%& is set, &%route_data%& must not be set.
18525
18526
18527
18528 .section "Routing rules in route_data" "SECID121"
18529 The use of &%route_list%& is convenient when there are only a small number of
18530 routing rules. For larger numbers, it is easier to use a file or database to
18531 hold the routing information, and use the &%route_data%& option instead.
18532 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18533 Most commonly, &%route_data%& is set as a string that contains an
18534 expansion lookup. For example, suppose we place two routing rules in a file
18535 like this:
18536 .code
18537 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18538 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18539 .endd
18540 This data can be accessed by setting
18541 .code
18542 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18543 .endd
18544 Failure of the lookup results in an empty string, causing the router to
18545 decline. However, you do not have to use a lookup in &%route_data%&. The only
18546 requirement is that the result of expanding the string is a list of hosts,
18547 possibly followed by options, separated by white space. The list of hosts must
18548 be enclosed in quotes if it contains white space.
18549
18550
18551
18552
18553 .section "Format of the list of hosts" "SECID122"
18554 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18555 always separately expanded before use. If the expansion fails, the router
18556 declines. The result of the expansion must be a colon-separated list of names
18557 and/or IP addresses, optionally also including ports. The format of each item
18558 in the list is described in the next section. The list separator can be changed
18559 as described in section &<<SECTlistconstruct>>&.
18560
18561 If the list of hosts was obtained from a &%route_list%& item, the following
18562 variables are set during its expansion:
18563
18564 .ilist
18565 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18566 If the domain was matched against a regular expression, the numeric variables
18567 &$1$&, &$2$&, etc. may be set. For example:
18568 .code
18569 route_list = ^domain(\d+)   host-$1.text.example
18570 .endd
18571 .next
18572 &$0$& is always set to the entire domain.
18573 .next
18574 &$1$& is also set when partial matching is done in a file lookup.
18575
18576 .next
18577 .vindex "&$value$&"
18578 If the pattern that matched the domain was a lookup item, the data that was
18579 looked up is available in the expansion variable &$value$&. For example:
18580 .code
18581 route_list = lsearch;;/some/file.routes  $value
18582 .endd
18583 .endlist
18584
18585 Note the doubling of the semicolon in the pattern that is necessary because
18586 semicolon is the default route list separator.
18587
18588
18589
18590 .section "Format of one host item" "SECTformatonehostitem"
18591 Each item in the list of hosts is either a host name or an IP address,
18592 optionally with an attached port number. When no port is given, an IP address
18593 is not enclosed in brackets. When a port is specified, it overrides the port
18594 specification on the transport. The port is separated from the name or address
18595 by a colon. This leads to some complications:
18596
18597 .ilist
18598 Because colon is the default separator for the list of hosts, either
18599 the colon that specifies a port must be doubled, or the list separator must
18600 be changed. The following two examples have the same effect:
18601 .code
18602 route_list = * "host1.tld::1225 : host2.tld::1226"
18603 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18604 .endd
18605 .next
18606 When IPv6 addresses are involved, it gets worse, because they contain
18607 colons of their own. To make this case easier, it is permitted to
18608 enclose an IP address (either v4 or v6) in square brackets if a port
18609 number follows. For example:
18610 .code
18611 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18612 .endd
18613 .endlist
18614
18615 .section "How the list of hosts is used" "SECThostshowused"
18616 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18617 the hosts is tried, in the order specified, when carrying out the SMTP
18618 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18619 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18620 transport.
18621
18622 Hosts may be listed by name or by IP address. An unadorned name in the list of
18623 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18624 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18625 records in the DNS. For example:
18626 .code
18627 route_list = *  x.y.z:p.q.r/MX:e.f.g
18628 .endd
18629 If this feature is used with a port specifier, the port must come last. For
18630 example:
18631 .code
18632 route_list = *  dom1.tld/mx::1225
18633 .endd
18634 If the &%hosts_randomize%& option is set, the order of the items in the list is
18635 randomized before any lookups are done. Exim then scans the list; for any name
18636 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18637 be an interface on the local host and the item is not the first in the list,
18638 Exim discards it and any subsequent items. If it is the first item, what
18639 happens is controlled by the
18640 .oindex "&%self%&" "in &(manualroute)& router"
18641 &%self%& option of the router.
18642
18643 A name on the list that is followed by &`/MX`& is replaced with the list of
18644 hosts obtained by looking up MX records for the name. This is always a DNS
18645 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18646 below) are not relevant here. The order of these hosts is determined by the
18647 preference values in the MX records, according to the usual rules. Because
18648 randomizing happens before the MX lookup, it does not affect the order that is
18649 defined by MX preferences.
18650
18651 If the local host is present in the sublist obtained from MX records, but is
18652 not the most preferred host in that list, it and any equally or less
18653 preferred hosts are removed before the sublist is inserted into the main list.
18654
18655 If the local host is the most preferred host in the MX list, what happens
18656 depends on where in the original list of hosts the &`/MX`& item appears. If it
18657 is not the first item (that is, there are previous hosts in the main list),
18658 Exim discards this name and any subsequent items in the main list.
18659
18660 If the MX item is first in the list of hosts, and the local host is the
18661 most preferred host, what happens is controlled by the &%self%& option of the
18662 router.
18663
18664 DNS failures when lookup up the MX records are treated in the same way as DNS
18665 failures when looking up IP addresses: &%pass_on_timeout%& and
18666 &%host_find_failed%& are used when relevant.
18667
18668 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18669 whether obtained from an MX lookup or not.
18670
18671
18672
18673 .section "How the options are used" "SECThowoptused"
18674 The options are a sequence of words; in practice no more than three are ever
18675 present. One of the words can be the name of a transport; this overrides the
18676 &%transport%& option on the router for this particular routing rule only. The
18677 other words (if present) control randomization of the list of hosts on a
18678 per-rule basis, and how the IP addresses of the hosts are to be found when
18679 routing to a remote transport. These options are as follows:
18680
18681 .ilist
18682 &%randomize%&: randomize the order of the hosts in this list, overriding the
18683 setting of &%hosts_randomize%& for this routing rule only.
18684 .next
18685 &%no_randomize%&: do not randomize the order of the hosts in this list,
18686 overriding the setting of &%hosts_randomize%& for this routing rule only.
18687 .next
18688 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18689 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18690 also look in &_/etc/hosts_& or other sources of information.
18691 .next
18692 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18693 no address records are found. If there is a temporary DNS error (such as a
18694 timeout), delivery is deferred.
18695 .endlist
18696
18697 For example:
18698 .code
18699 route_list = domain1  host1:host2:host3  randomize bydns;\
18700              domain2  host4:host5
18701 .endd
18702 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18703 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18704 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18705 or &[gethostbyname()]&, and the result of the lookup is the result of that
18706 call.
18707
18708 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18709 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18710 instead of TRY_AGAIN. That is why the default action is to try a DNS
18711 lookup first. Only if that gives a definite &"no such host"& is the local
18712 function called.
18713
18714
18715
18716 If no IP address for a host can be found, what happens is controlled by the
18717 &%host_find_failed%& option.
18718
18719 .vindex "&$host$&"
18720 When an address is routed to a local transport, IP addresses are not looked up.
18721 The host list is passed to the transport in the &$host$& variable.
18722
18723
18724
18725 .section "Manualroute examples" "SECID123"
18726 In some of the examples that follow, the presence of the &%remote_smtp%&
18727 transport, as defined in the default configuration file, is assumed:
18728
18729 .ilist
18730 .cindex "smart host" "example router"
18731 The &(manualroute)& router can be used to forward all external mail to a
18732 &'smart host'&. If you have set up, in the main part of the configuration, a
18733 named domain list that contains your local domains, for example:
18734 .code
18735 domainlist local_domains = my.domain.example
18736 .endd
18737 You can arrange for all other domains to be routed to a smart host by making
18738 your first router something like this:
18739 .code
18740 smart_route:
18741   driver = manualroute
18742   domains = !+local_domains
18743   transport = remote_smtp
18744   route_list = * smarthost.ref.example
18745 .endd
18746 This causes all non-local addresses to be sent to the single host
18747 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18748 they are tried in order
18749 (but you can use &%hosts_randomize%& to vary the order each time).
18750 Another way of configuring the same thing is this:
18751 .code
18752 smart_route:
18753   driver = manualroute
18754   transport = remote_smtp
18755   route_list = !+local_domains  smarthost.ref.example
18756 .endd
18757 There is no difference in behaviour between these two routers as they stand.
18758 However, they behave differently if &%no_more%& is added to them. In the first
18759 example, the router is skipped if the domain does not match the &%domains%&
18760 precondition; the following router is always tried. If the router runs, it
18761 always matches the domain and so can never decline. Therefore, &%no_more%&
18762 would have no effect. In the second case, the router is never skipped; it
18763 always runs. However, if it doesn't match the domain, it declines. In this case
18764 &%no_more%& would prevent subsequent routers from running.
18765
18766 .next
18767 .cindex "mail hub example"
18768 A &'mail hub'& is a host which receives mail for a number of domains via MX
18769 records in the DNS and delivers it via its own private routing mechanism. Often
18770 the final destinations are behind a firewall, with the mail hub being the one
18771 machine that can connect to machines both inside and outside the firewall. The
18772 &(manualroute)& router is usually used on a mail hub to route incoming messages
18773 to the correct hosts. For a small number of domains, the routing can be inline,
18774 using the &%route_list%& option, but for a larger number a file or database
18775 lookup is easier to manage.
18776
18777 If the domain names are in fact the names of the machines to which the mail is
18778 to be sent by the mail hub, the configuration can be quite simple. For
18779 example:
18780 .code
18781 hub_route:
18782   driver = manualroute
18783   transport = remote_smtp
18784   route_list = *.rhodes.tvs.example  $domain
18785 .endd
18786 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18787 whose names are the same as the mail domains. A similar approach can be taken
18788 if the host name can be obtained from the domain name by a string manipulation
18789 that the expansion facilities can handle. Otherwise, a lookup based on the
18790 domain can be used to find the host:
18791 .code
18792 through_firewall:
18793   driver = manualroute
18794   transport = remote_smtp
18795   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18796 .endd
18797 The result of the lookup must be the name or IP address of the host (or
18798 hosts) to which the address is to be routed. If the lookup fails, the route
18799 data is empty, causing the router to decline. The address then passes to the
18800 next router.
18801
18802 .next
18803 .cindex "batched SMTP output example"
18804 .cindex "SMTP" "batched outgoing; example"
18805 You can use &(manualroute)& to deliver messages to pipes or files in batched
18806 SMTP format for onward transportation by some other means. This is one way of
18807 storing mail for a dial-up host when it is not connected. The route list entry
18808 can be as simple as a single domain name in a configuration like this:
18809 .code
18810 save_in_file:
18811   driver = manualroute
18812   transport = batchsmtp_appendfile
18813   route_list = saved.domain.example
18814 .endd
18815 though often a pattern is used to pick up more than one domain. If there are
18816 several domains or groups of domains with different transport requirements,
18817 different transports can be listed in the routing information:
18818 .code
18819 save_in_file:
18820   driver = manualroute
18821   route_list = \
18822     *.saved.domain1.example  $domain  batch_appendfile; \
18823     *.saved.domain2.example  \
18824       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18825       batch_pipe
18826 .endd
18827 .vindex "&$domain$&"
18828 .vindex "&$host$&"
18829 The first of these just passes the domain in the &$host$& variable, which
18830 doesn't achieve much (since it is also in &$domain$&), but the second does a
18831 file lookup to find a value to pass, causing the router to decline to handle
18832 the address if the lookup fails.
18833
18834 .next
18835 .cindex "UUCP" "example of router for"
18836 Routing mail directly to UUCP software is a specific case of the use of
18837 &(manualroute)& in a gateway to another mail environment. This is an example of
18838 one way it can be done:
18839 .code
18840 # Transport
18841 uucp:
18842   driver = pipe
18843   user = nobody
18844   command = /usr/local/bin/uux -r - \
18845     ${substr_-5:$host}!rmail ${local_part}
18846   return_fail_output = true
18847
18848 # Router
18849 uucphost:
18850   transport = uucp
18851   driver = manualroute
18852   route_data = \
18853     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18854 .endd
18855 The file &_/usr/local/exim/uucphosts_& contains entries like
18856 .code
18857 darksite.ethereal.example:           darksite.UUCP
18858 .endd
18859 It can be set up more simply without adding and removing &".UUCP"& but this way
18860 makes clear the distinction between the domain name
18861 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18862 .endlist
18863 .ecindex IIDmanrou1
18864 .ecindex IIDmanrou2
18865
18866
18867
18868
18869
18870
18871
18872
18873 . ////////////////////////////////////////////////////////////////////////////
18874 . ////////////////////////////////////////////////////////////////////////////
18875
18876 .chapter "The queryprogram router" "CHAPdriverlast"
18877 .scindex IIDquerou1 "&(queryprogram)& router"
18878 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18879 .cindex "routing" "by external program"
18880 The &(queryprogram)& router routes an address by running an external command
18881 and acting on its output. This is an expensive way to route, and is intended
18882 mainly for use in lightly-loaded systems, or for performing experiments.
18883 However, if it is possible to use the precondition options (&%domains%&,
18884 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18885 be used in special cases, even on a busy host. There are the following private
18886 options:
18887 .cindex "options" "&(queryprogram)& router"
18888
18889 .option command queryprogram string&!! unset
18890 This option must be set. It specifies the command that is to be run. The
18891 command is split up into a command name and arguments, and then each is
18892 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18893 &<<CHAPpipetransport>>&).
18894
18895
18896 .option command_group queryprogram string unset
18897 .cindex "gid (group id)" "in &(queryprogram)& router"
18898 This option specifies a gid to be set when running the command while routing an
18899 address for deliver. It must be set if &%command_user%& specifies a numerical
18900 uid. If it begins with a digit, it is interpreted as the numerical value of the
18901 gid. Otherwise it is looked up using &[getgrnam()]&.
18902
18903
18904 .option command_user queryprogram string unset
18905 .cindex "uid (user id)" "for &(queryprogram)&"
18906 This option must be set. It specifies the uid which is set when running the
18907 command while routing an address for delivery. If the value begins with a digit,
18908 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18909 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18910 not set, a value for the gid also.
18911
18912 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18913 root, which it does during a normal delivery in a conventional configuration.
18914 However, when an address is being verified during message reception, Exim is
18915 usually running as the Exim user, not as root. If the &(queryprogram)& router
18916 is called from a non-root process, Exim cannot change uid or gid before running
18917 the command. In this circumstance the command runs under the current uid and
18918 gid.
18919
18920
18921 .option current_directory queryprogram string /
18922 This option specifies an absolute path which is made the current directory
18923 before running the command.
18924
18925
18926 .option timeout queryprogram time 1h
18927 If the command does not complete within the timeout period, its process group
18928 is killed and the message is frozen. A value of zero time specifies no
18929 timeout.
18930
18931
18932 The standard output of the command is connected to a pipe, which is read when
18933 the command terminates. It should consist of a single line of output,
18934 containing up to five fields, separated by white space. The maximum length of
18935 the line is 1023 characters. Longer lines are silently truncated. The first
18936 field is one of the following words (case-insensitive):
18937
18938 .ilist
18939 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18940 below).
18941 .next
18942 &'Decline'&: the router declines; pass the address to the next router, unless
18943 &%no_more%& is set.
18944 .next
18945 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18946 subsequent text on the line is an error message. If the router is run as part
18947 of address verification during an incoming SMTP message, the message is
18948 included in the SMTP response.
18949 .next
18950 &'Defer'&: routing could not be completed at this time; try again later. Any
18951 subsequent text on the line is an error message which is logged. It is not
18952 included in any SMTP response.
18953 .next
18954 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18955 .next
18956 &'Pass'&: pass the address to the next router (or the router specified by
18957 &%pass_router%&), overriding &%no_more%&.
18958 .next
18959 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18960 new addresses, which are routed independently, starting with the first router,
18961 or the router specified by &%redirect_router%&, if set.
18962 .endlist
18963
18964 When the first word is &'accept'&, the remainder of the line consists of a
18965 number of keyed data values, as follows (split into two lines here, to fit on
18966 the page):
18967 .code
18968 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18969 LOOKUP=byname|bydns DATA=<text>
18970 .endd
18971 The data items can be given in any order, and all are optional. If no transport
18972 is included, the transport specified by the generic &%transport%& option is
18973 used. The list of hosts and the lookup type are needed only if the transport is
18974 an &(smtp)& transport that does not itself supply a list of hosts.
18975
18976 The format of the list of hosts is the same as for the &(manualroute)& router.
18977 As well as host names and IP addresses with optional port numbers, as described
18978 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18979 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18980 (see section &<<SECThostshowused>>&).
18981
18982 If the lookup type is not specified, Exim behaves as follows when trying to
18983 find an IP address for each host: First, a DNS lookup is done. If this yields
18984 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18985 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18986 result of the lookup is the result of that call.
18987
18988 .vindex "&$address_data$&"
18989 If the DATA field is set, its value is placed in the &$address_data$&
18990 variable. For example, this return line
18991 .code
18992 accept hosts=x1.y.example:x2.y.example data="rule1"
18993 .endd
18994 routes the address to the default transport, passing a list of two hosts. When
18995 the transport runs, the string &"rule1"& is in &$address_data$&.
18996 .ecindex IIDquerou1
18997 .ecindex IIDquerou2
18998
18999
19000
19001
19002 . ////////////////////////////////////////////////////////////////////////////
19003 . ////////////////////////////////////////////////////////////////////////////
19004
19005 .chapter "The redirect router" "CHAPredirect"
19006 .scindex IIDredrou1 "&(redirect)& router"
19007 .scindex IIDredrou2 "routers" "&(redirect)&"
19008 .cindex "alias file" "in a &(redirect)& router"
19009 .cindex "address redirection" "&(redirect)& router"
19010 The &(redirect)& router handles several kinds of address redirection. Its most
19011 common uses are for resolving local part aliases from a central alias file
19012 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19013 files, but it has many other potential uses. The incoming address can be
19014 redirected in several different ways:
19015
19016 .ilist
19017 It can be replaced by one or more new addresses which are themselves routed
19018 independently.
19019 .next
19020 It can be routed to be delivered to a given file or directory.
19021 .next
19022 It can be routed to be delivered to a specified pipe command.
19023 .next
19024 It can cause an automatic reply to be generated.
19025 .next
19026 It can be forced to fail, optionally with a custom error message.
19027 .next
19028 It can be temporarily deferred, optionally with a custom message.
19029 .next
19030 It can be discarded.
19031 .endlist
19032
19033 The generic &%transport%& option must not be set for &(redirect)& routers.
19034 However, there are some private options which define transports for delivery to
19035 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19036 &%pipe_transport%& and &%reply_transport%& descriptions below.
19037
19038 If success DSNs have been requested
19039 .cindex "DSN" "success"
19040 .cindex "Delivery Status Notification" "success"
19041 redirection triggers one and the DSN options are not passed any further.
19042
19043
19044
19045 .section "Redirection data" "SECID124"
19046 The router operates by interpreting a text string which it obtains either by
19047 expanding the contents of the &%data%& option, or by reading the entire
19048 contents of a file whose name is given in the &%file%& option. These two
19049 options are mutually exclusive. The first is commonly used for handling system
19050 aliases, in a configuration like this:
19051 .code
19052 system_aliases:
19053   driver = redirect
19054   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19055 .endd
19056 If the lookup fails, the expanded string in this example is empty. When the
19057 expansion of &%data%& results in an empty string, the router declines. A forced
19058 expansion failure also causes the router to decline; other expansion failures
19059 cause delivery to be deferred.
19060
19061 A configuration using &%file%& is commonly used for handling users'
19062 &_.forward_& files, like this:
19063 .code
19064 userforward:
19065   driver = redirect
19066   check_local_user
19067   file = $home/.forward
19068   no_verify
19069 .endd
19070 If the file does not exist, or causes no action to be taken (for example, it is
19071 empty or consists only of comments), the router declines. &*Warning*&: This
19072 is not the case when the file contains syntactically valid items that happen to
19073 yield empty addresses, for example, items containing only RFC 2822 address
19074 comments.
19075
19076
19077
19078 .section "Forward files and address verification" "SECID125"
19079 .cindex "address redirection" "while verifying"
19080 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19081 &_.forward_& files, as in the example above. There are two reasons for this:
19082
19083 .ilist
19084 When Exim is receiving an incoming SMTP message from a remote host, it is
19085 running under the Exim uid, not as root. Exim is unable to change uid to read
19086 the file as the user, and it may not be able to read it as the Exim user. So in
19087 practice the router may not be able to operate.
19088 .next
19089 However, even when the router can operate, the existence of a &_.forward_& file
19090 is unimportant when verifying an address. What should be checked is whether the
19091 local part is a valid user name or not. Cutting out the redirection processing
19092 saves some resources.
19093 .endlist
19094
19095
19096
19097
19098
19099
19100 .section "Interpreting redirection data" "SECID126"
19101 .cindex "Sieve filter" "specifying in redirection data"
19102 .cindex "filter" "specifying in redirection data"
19103 The contents of the data string, whether obtained from &%data%& or &%file%&,
19104 can be interpreted in two different ways:
19105
19106 .ilist
19107 If the &%allow_filter%& option is set true, and the data begins with the text
19108 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19109 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19110 respectively. Details of the syntax and semantics of filter files are described
19111 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19112 document is intended for use by end users.
19113 .next
19114 Otherwise, the data must be a comma-separated list of redirection items, as
19115 described in the next section.
19116 .endlist
19117
19118 When a message is redirected to a file (a &"mail folder"&), the file name given
19119 in a non-filter redirection list must always be an absolute path. A filter may
19120 generate a relative path &-- how this is handled depends on the transport's
19121 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19122 for the &(appendfile)& transport.
19123
19124
19125
19126 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19127 .cindex "address redirection" "non-filter list items"
19128 When the redirection data is not an Exim or Sieve filter, for example, if it
19129 comes from a conventional alias or forward file, it consists of a list of
19130 addresses, file names, pipe commands, or certain special items (see section
19131 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19132 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19133 depending on their default values. The items in the list are separated by
19134 commas or newlines.
19135 If a comma is required in an item, the entire item must be enclosed in double
19136 quotes.
19137
19138 Lines starting with a # character are comments, and are ignored, and # may
19139 also appear following a comma, in which case everything between the # and the
19140 next newline character is ignored.
19141
19142 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19143 double quotes are retained because some forms of mail address require their use
19144 (but never to enclose the entire address). In the following description,
19145 &"item"& refers to what remains after any surrounding double quotes have been
19146 removed.
19147
19148 .vindex "&$local_part$&"
19149 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19150 and the expansion contains a reference to &$local_part$&, you should make use
19151 of the &%quote_local_part%& expansion operator, in case the local part contains
19152 special characters. For example, to redirect all mail for the domain
19153 &'obsolete.example'&, retaining the existing local part, you could use this
19154 setting:
19155 .code
19156 data = ${quote_local_part:$local_part}@newdomain.example
19157 .endd
19158
19159
19160 .section "Redirecting to a local mailbox" "SECTredlocmai"
19161 .cindex "routing" "loops in"
19162 .cindex "loop" "while routing, avoidance of"
19163 .cindex "address redirection" "to local mailbox"
19164 A redirection item may safely be the same as the address currently under
19165 consideration. This does not cause a routing loop, because a router is
19166 automatically skipped if any ancestor of the address that is being processed
19167 is the same as the current address and was processed by the current router.
19168 Such an address is therefore passed to the following routers, so it is handled
19169 as if there were no redirection. When making this loop-avoidance test, the
19170 complete local part, including any prefix or suffix, is used.
19171
19172 .cindex "address redirection" "local part without domain"
19173 Specifying the same local part without a domain is a common usage in personal
19174 filter files when the user wants to have messages delivered to the local
19175 mailbox and also forwarded elsewhere. For example, the user whose login is
19176 &'cleo'& might have a &_.forward_& file containing this:
19177 .code
19178 cleo, cleopatra@egypt.example
19179 .endd
19180 .cindex "backslash in alias file"
19181 .cindex "alias file" "backslash in"
19182 For compatibility with other MTAs, such unqualified local parts may be
19183 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19184 it does make a difference if more than one domain is being handled
19185 synonymously.
19186
19187 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19188 2822 address that does not include a domain, the item is qualified using the
19189 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19190 addresses are qualified using the value in &%qualify_recipient%&, but you can
19191 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19192
19193 Care must be taken if there are alias names for local users.
19194 Consider an MTA handling a single local domain where the system alias file
19195 contains:
19196 .code
19197 Sam.Reman: spqr
19198 .endd
19199 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19200 messages in the local mailbox, and also forward copies elsewhere. He creates
19201 this forward file:
19202 .code
19203 Sam.Reman, spqr@reme.elsewhere.example
19204 .endd
19205 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19206 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19207 second time round, because it has previously routed it,
19208 and the following routers presumably cannot handle the alias. The forward file
19209 should really contain
19210 .code
19211 spqr, spqr@reme.elsewhere.example
19212 .endd
19213 but because this is such a common error, the &%check_ancestor%& option (see
19214 below) exists to provide a way to get round it. This is normally set on a
19215 &(redirect)& router that is handling users' &_.forward_& files.
19216
19217
19218
19219 .section "Special items in redirection lists" "SECTspecitredli"
19220 In addition to addresses, the following types of item may appear in redirection
19221 lists (that is, in non-filter redirection data):
19222
19223 .ilist
19224 .cindex "pipe" "in redirection list"
19225 .cindex "address redirection" "to pipe"
19226 An item is treated as a pipe command if it begins with &"|"& and does not parse
19227 as a valid RFC 2822 address that includes a domain. A transport for running the
19228 command must be specified by the &%pipe_transport%& option.
19229 Normally, either the router or the transport specifies a user and a group under
19230 which to run the delivery. The default is to use the Exim user and group.
19231
19232 Single or double quotes can be used for enclosing the individual arguments of
19233 the pipe command; no interpretation of escapes is done for single quotes. If
19234 the command contains a comma character, it is necessary to put the whole item
19235 in double quotes, for example:
19236 .code
19237 "|/some/command ready,steady,go"
19238 .endd
19239 since items in redirection lists are terminated by commas. Do not, however,
19240 quote just the command. An item such as
19241 .code
19242 |"/some/command ready,steady,go"
19243 .endd
19244 is interpreted as a pipe with a rather strange command name, and no arguments.
19245
19246 Note that the above example assumes that the text comes from a lookup source
19247 of some sort, so that the quotes are part of the data.  If composing a
19248 redirect router with a &%data%& option directly specifying this command, the
19249 quotes will be used by the configuration parser to define the extent of one
19250 string, but will not be passed down into the redirect router itself.  There
19251 are two main approaches to get around this: escape quotes to be part of the
19252 data itself, or avoid using this mechanism and instead create a custom
19253 transport with the &%command%& option set and reference that transport from
19254 an &%accept%& router.
19255
19256 .next
19257 .cindex "file" "in redirection list"
19258 .cindex "address redirection" "to file"
19259 An item is interpreted as a path name if it begins with &"/"& and does not
19260 parse as a valid RFC 2822 address that includes a domain. For example,
19261 .code
19262 /home/world/minbari
19263 .endd
19264 is treated as a file name, but
19265 .code
19266 /s=molari/o=babylon/@x400gate.way
19267 .endd
19268 is treated as an address. For a file name, a transport must be specified using
19269 the &%file_transport%& option. However, if the generated path name ends with a
19270 forward slash character, it is interpreted as a directory name rather than a
19271 file name, and &%directory_transport%& is used instead.
19272
19273 Normally, either the router or the transport specifies a user and a group under
19274 which to run the delivery. The default is to use the Exim user and group.
19275
19276 .cindex "&_/dev/null_&"
19277 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19278 bypassed at a high level, and the log entry shows &"**bypassed**"&
19279 instead of a transport name. In this case the user and group are not used.
19280
19281 .next
19282 .cindex "included address list"
19283 .cindex "address redirection" "included external list"
19284 If an item is of the form
19285 .code
19286 :include:<path name>
19287 .endd
19288 a list of further items is taken from the given file and included at that
19289 point. &*Note*&: Such a file can not be a filter file; it is just an
19290 out-of-line addition to the list. The items in the included list are separated
19291 by commas or newlines and are not subject to expansion. If this is the first
19292 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19293 the alias name. This example is incorrect:
19294 .code
19295 list1    :include:/opt/lists/list1
19296 .endd
19297 It must be given as
19298 .code
19299 list1:   :include:/opt/lists/list1
19300 .endd
19301 .next
19302 .cindex "address redirection" "to black hole"
19303 Sometimes you want to throw away mail to a particular local part. Making the
19304 &%data%& option expand to an empty string does not work, because that causes
19305 the router to decline. Instead, the alias item
19306 .cindex "black hole"
19307 .cindex "abandoning mail"
19308 &':blackhole:'& can be used. It does what its name implies. No delivery is
19309 done, and no error message is generated. This has the same effect as specifing
19310 &_/dev/null_& as a destination, but it can be independently disabled.
19311
19312 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19313 delivery is done for the original local part, even if other redirection items
19314 are present. If you are generating a multi-item list (for example, by reading a
19315 database) and need the ability to provide a no-op item, you must use
19316 &_/dev/null_&.
19317
19318 .next
19319 .cindex "delivery" "forcing failure"
19320 .cindex "delivery" "forcing deferral"
19321 .cindex "failing delivery" "forcing"
19322 .cindex "deferred delivery, forcing"
19323 .cindex "customizing" "failure message"
19324 An attempt to deliver a particular address can be deferred or forced to fail by
19325 redirection items of the form
19326 .code
19327 :defer:
19328 :fail:
19329 .endd
19330 respectively. When a redirection list contains such an item, it applies
19331 to the entire redirection; any other items in the list are ignored. Any
19332 text following &':fail:'& or &':defer:'& is placed in the error text
19333 associated with the failure. For example, an alias file might contain:
19334 .code
19335 X.Employee:  :fail: Gone away, no forwarding address
19336 .endd
19337 In the case of an address that is being verified from an ACL or as the subject
19338 of a
19339 .cindex "VRFY" "error text, display of"
19340 VRFY command, the text is included in the SMTP error response by
19341 default.
19342 .cindex "EXPN" "error text, display of"
19343 The text is not included in the response to an EXPN command. In non-SMTP cases
19344 the text is included in the error message that Exim generates.
19345
19346 .cindex "SMTP" "error codes"
19347 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19348 &':fail:'&. However, if the message starts with three digits followed by a
19349 space, optionally followed by an extended code of the form &'n.n.n'&, also
19350 followed by a space, and the very first digit is the same as the default error
19351 code, the code from the message is used instead. If the very first digit is
19352 incorrect, a panic error is logged, and the default code is used. You can
19353 suppress the use of the supplied code in a redirect router by setting the
19354 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19355 ignored.
19356
19357 .vindex "&$acl_verify_message$&"
19358 In an ACL, an explicitly provided message overrides the default, but the
19359 default message is available in the variable &$acl_verify_message$& and can
19360 therefore be included in a custom message if this is desired.
19361
19362 Normally the error text is the rest of the redirection list &-- a comma does
19363 not terminate it &-- but a newline does act as a terminator. Newlines are not
19364 normally present in alias expansions. In &(lsearch)& lookups they are removed
19365 as part of the continuation process, but they may exist in other kinds of
19366 lookup and in &':include:'& files.
19367
19368 During routing for message delivery (as opposed to verification), a redirection
19369 containing &':fail:'& causes an immediate failure of the incoming address,
19370 whereas &':defer:'& causes the message to remain on the queue so that a
19371 subsequent delivery attempt can happen at a later time. If an address is
19372 deferred for too long, it will ultimately fail, because the normal retry
19373 rules still apply.
19374
19375 .next
19376 .cindex "alias file" "exception to default"
19377 Sometimes it is useful to use a single-key search type with a default (see
19378 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19379 for exceptions to the default. These can be handled by aliasing them to
19380 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19381 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19382 results in an empty redirection list has the same effect.
19383 .endlist
19384
19385
19386 .section "Duplicate addresses" "SECTdupaddr"
19387 .cindex "duplicate addresses"
19388 .cindex "address duplicate, discarding"
19389 .cindex "pipe" "duplicated"
19390 Exim removes duplicate addresses from the list to which it is delivering, so as
19391 to deliver just one copy to each address. This does not apply to deliveries
19392 routed to pipes by different immediate parent addresses, but an indirect
19393 aliasing scheme of the type
19394 .code
19395 pipe:       |/some/command $local_part
19396 localpart1: pipe
19397 localpart2: pipe
19398 .endd
19399 does not work with a message that is addressed to both local parts, because
19400 when the second is aliased to the intermediate local part &"pipe"& it gets
19401 discarded as being the same as a previously handled address. However, a scheme
19402 such as
19403 .code
19404 localpart1: |/some/command $local_part
19405 localpart2: |/some/command $local_part
19406 .endd
19407 does result in two different pipe deliveries, because the immediate parents of
19408 the pipes are distinct.
19409
19410
19411
19412 .section "Repeated redirection expansion" "SECID128"
19413 .cindex "repeated redirection expansion"
19414 .cindex "address redirection" "repeated for each delivery attempt"
19415 When a message cannot be delivered to all of its recipients immediately,
19416 leading to two or more delivery attempts, redirection expansion is carried out
19417 afresh each time for those addresses whose children were not all previously
19418 delivered. If redirection is being used as a mailing list, this can lead to new
19419 members of the list receiving copies of old messages. The &%one_time%& option
19420 can be used to avoid this.
19421
19422
19423 .section "Errors in redirection lists" "SECID129"
19424 .cindex "address redirection" "errors"
19425 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19426 error is skipped, and an entry is written to the main log. This may be useful
19427 for mailing lists that are automatically managed. Otherwise, if an error is
19428 detected while generating the list of new addresses, the original address is
19429 deferred. See also &%syntax_errors_to%&.
19430
19431
19432
19433 .section "Private options for the redirect router" "SECID130"
19434
19435 .cindex "options" "&(redirect)& router"
19436 The private options for the &(redirect)& router are as follows:
19437
19438
19439 .option allow_defer redirect boolean false
19440 Setting this option allows the use of &':defer:'& in non-filter redirection
19441 data, or the &%defer%& command in an Exim filter file.
19442
19443
19444 .option allow_fail redirect boolean false
19445 .cindex "failing delivery" "from filter"
19446 If this option is true, the &':fail:'& item can be used in a redirection list,
19447 and the &%fail%& command may be used in an Exim filter file.
19448
19449
19450 .option allow_filter redirect boolean false
19451 .cindex "filter" "enabling use of"
19452 .cindex "Sieve filter" "enabling use of"
19453 Setting this option allows Exim to interpret redirection data that starts with
19454 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19455 are some features of Exim filter files that some administrators may wish to
19456 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19457
19458 It is also possible to lock out Exim filters or Sieve filters while allowing
19459 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19460
19461
19462 The filter is run using the uid and gid set by the generic &%user%& and
19463 &%group%& options. These take their defaults from the password data if
19464 &%check_local_user%& is set, so in the normal case of users' personal filter
19465 files, the filter is run as the relevant user. When &%allow_filter%& is set
19466 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19467
19468
19469
19470 .option allow_freeze redirect boolean false
19471 .cindex "freezing messages" "allowing in filter"
19472 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19473 This command is more normally encountered in system filters, and is disabled by
19474 default for redirection filters because it isn't something you usually want to
19475 let ordinary users do.
19476
19477
19478
19479 .option check_ancestor redirect boolean false
19480 This option is concerned with handling generated addresses that are the same
19481 as some address in the list of redirection ancestors of the current address.
19482 Although it is turned off by default in the code, it is set in the default
19483 configuration file for handling users' &_.forward_& files. It is recommended
19484 for this use of the &(redirect)& router.
19485
19486 When &%check_ancestor%& is set, if a generated address (including the domain)
19487 is the same as any ancestor of the current address, it is replaced by a copy of
19488 the current address. This helps in the case where local part A is aliased to B,
19489 and B has a &_.forward_& file pointing back to A. For example, within a single
19490 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19491 &_&~jb/.forward_& contains:
19492 .code
19493 \Joe.Bloggs, <other item(s)>
19494 .endd
19495 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19496 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19497 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19498 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19499 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19500 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19501 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19502 original address. See also the &%repeat_use%& option below.
19503
19504
19505 .option check_group redirect boolean "see below"
19506 When the &%file%& option is used, the group owner of the file is checked only
19507 when this option is set. The permitted groups are those listed in the
19508 &%owngroups%& option, together with the user's default group if
19509 &%check_local_user%& is set. If the file has the wrong group, routing is
19510 deferred. The default setting for this option is true if &%check_local_user%&
19511 is set and the &%modemask%& option permits the group write bit, or if the
19512 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19513
19514
19515
19516 .option check_owner redirect boolean "see below"
19517 When the &%file%& option is used, the owner of the file is checked only when
19518 this option is set. If &%check_local_user%& is set, the local user is
19519 permitted; otherwise the owner must be one of those listed in the &%owners%&
19520 option. The default value for this option is true if &%check_local_user%& or
19521 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19522
19523
19524 .option data redirect string&!! unset
19525 This option is mutually exclusive with &%file%&. One or other of them must be
19526 set, but not both. The contents of &%data%& are expanded, and then used as the
19527 list of forwarding items, or as a set of filtering instructions. If the
19528 expansion is forced to fail, or the result is an empty string or a string that
19529 has no effect (consists entirely of comments), the router declines.
19530
19531 When filtering instructions are used, the string must begin with &"#Exim
19532 filter"&, and all comments in the string, including this initial one, must be
19533 terminated with newline characters. For example:
19534 .code
19535 data = #Exim filter\n\
19536        if $h_to: contains Exim then save $home/mail/exim endif
19537 .endd
19538 If you are reading the data from a database where newlines cannot be included,
19539 you can use the &${sg}$& expansion item to turn the escape string of your
19540 choice into a newline.
19541
19542
19543 .option directory_transport redirect string&!! unset
19544 A &(redirect)& router sets up a direct delivery to a directory when a path name
19545 ending with a slash is specified as a new &"address"&. The transport used is
19546 specified by this option, which, after expansion, must be the name of a
19547 configured transport. This should normally be an &(appendfile)& transport.
19548
19549
19550 .option file redirect string&!! unset
19551 This option specifies the name of a file that contains the redirection data. It
19552 is mutually exclusive with the &%data%& option. The string is expanded before
19553 use; if the expansion is forced to fail, the router declines. Other expansion
19554 failures cause delivery to be deferred. The result of a successful expansion
19555 must be an absolute path. The entire file is read and used as the redirection
19556 data. If the data is an empty string or a string that has no effect (consists
19557 entirely of comments), the router declines.
19558
19559 .cindex "NFS" "checking for file existence"
19560 If the attempt to open the file fails with a &"does not exist"& error, Exim
19561 runs a check on the containing directory,
19562 unless &%ignore_enotdir%& is true (see below).
19563 If the directory does not appear to exist, delivery is deferred. This can
19564 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19565 is a mount problem. If the containing directory does exist, but the file does
19566 not, the router declines.
19567
19568
19569 .option file_transport redirect string&!! unset
19570 .vindex "&$address_file$&"
19571 A &(redirect)& router sets up a direct delivery to a file when a path name not
19572 ending in a slash is specified as a new &"address"&. The transport used is
19573 specified by this option, which, after expansion, must be the name of a
19574 configured transport. This should normally be an &(appendfile)& transport. When
19575 it is running, the file name is in &$address_file$&.
19576
19577
19578 .option filter_prepend_home redirect boolean true
19579 When this option is true, if a &(save)& command in an Exim filter specifies a
19580 relative path, and &$home$& is defined, it is automatically prepended to the
19581 relative path. If this option is set false, this action does not happen. The
19582 relative path is then passed to the transport unmodified.
19583
19584
19585 .option forbid_blackhole redirect boolean false
19586 If this option is true, the &':blackhole:'& item may not appear in a
19587 redirection list.
19588
19589
19590 .option forbid_exim_filter redirect boolean false
19591 If this option is set true, only Sieve filters are permitted when
19592 &%allow_filter%& is true.
19593
19594
19595
19596
19597 .option forbid_file redirect boolean false
19598 .cindex "delivery" "to file; forbidding"
19599 .cindex "Sieve filter" "forbidding delivery to a file"
19600 .cindex "Sieve filter" "&""keep""& facility; disabling"
19601 If this option is true, this router may not generate a new address that
19602 specifies delivery to a local file or directory, either from a filter or from a
19603 conventional forward file. This option is forced to be true if &%one_time%& is
19604 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19605 locks out the Sieve's &"keep"& facility.
19606
19607
19608 .option forbid_filter_dlfunc redirect boolean false
19609 .cindex "filter" "locking out certain features"
19610 If this option is true, string expansions in Exim filters are not allowed to
19611 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19612 functions.
19613
19614 .option forbid_filter_existstest redirect boolean false
19615 .cindex "expansion" "statting a file"
19616 If this option is true, string expansions in Exim filters are not allowed to
19617 make use of the &%exists%& condition or the &%stat%& expansion item.
19618
19619 .option forbid_filter_logwrite redirect boolean false
19620 If this option is true, use of the logging facility in Exim filters is not
19621 permitted. Logging is in any case available only if the filter is being run
19622 under some unprivileged uid (which is normally the case for ordinary users'
19623 &_.forward_& files).
19624
19625
19626 .option forbid_filter_lookup redirect boolean false
19627 If this option is true, string expansions in Exim filter files are not allowed
19628 to make use of &%lookup%& items.
19629
19630
19631 .option forbid_filter_perl redirect boolean false
19632 This option has an effect only if Exim is built with embedded Perl support. If
19633 it is true, string expansions in Exim filter files are not allowed to make use
19634 of the embedded Perl support.
19635
19636
19637 .option forbid_filter_readfile redirect boolean false
19638 If this option is true, string expansions in Exim filter files are not allowed
19639 to make use of &%readfile%& items.
19640
19641
19642 .option forbid_filter_readsocket redirect boolean false
19643 If this option is true, string expansions in Exim filter files are not allowed
19644 to make use of &%readsocket%& items.
19645
19646
19647 .option forbid_filter_reply redirect boolean false
19648 If this option is true, this router may not generate an automatic reply
19649 message. Automatic replies can be generated only from Exim or Sieve filter
19650 files, not from traditional forward files. This option is forced to be true if
19651 &%one_time%& is set.
19652
19653
19654 .option forbid_filter_run redirect boolean false
19655 If this option is true, string expansions in Exim filter files are not allowed
19656 to make use of &%run%& items.
19657
19658
19659 .option forbid_include redirect boolean false
19660 If this option is true, items of the form
19661 .code
19662 :include:<path name>
19663 .endd
19664 are not permitted in non-filter redirection lists.
19665
19666
19667 .option forbid_pipe redirect boolean false
19668 .cindex "delivery" "to pipe; forbidding"
19669 If this option is true, this router may not generate a new address which
19670 specifies delivery to a pipe, either from an Exim filter or from a conventional
19671 forward file. This option is forced to be true if &%one_time%& is set.
19672
19673
19674 .option forbid_sieve_filter redirect boolean false
19675 If this option is set true, only Exim filters are permitted when
19676 &%allow_filter%& is true.
19677
19678
19679 .cindex "SMTP" "error codes"
19680 .option forbid_smtp_code redirect boolean false
19681 If this option is set true, any SMTP error codes that are present at the start
19682 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19683 the default codes (451 and 550, respectively) are always used.
19684
19685
19686
19687
19688 .option hide_child_in_errmsg redirect boolean false
19689 .cindex "bounce message" "redirection details; suppressing"
19690 If this option is true, it prevents Exim from quoting a child address if it
19691 generates a bounce or delay message for it. Instead it says &"an address
19692 generated from <&'the top level address'&>"&. Of course, this applies only to
19693 bounces generated locally. If a message is forwarded to another host, &'its'&
19694 bounce may well quote the generated address.
19695
19696
19697 .option ignore_eacces redirect boolean false
19698 .cindex "EACCES"
19699 If this option is set and an attempt to open a redirection file yields the
19700 EACCES error (permission denied), the &(redirect)& router behaves as if the
19701 file did not exist.
19702
19703
19704 .option ignore_enotdir redirect boolean false
19705 .cindex "ENOTDIR"
19706 If this option is set and an attempt to open a redirection file yields the
19707 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19708 router behaves as if the file did not exist.
19709
19710 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19711 router that has the &%file%& option set discovers that the file does not exist
19712 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19713 against unmounted NFS directories. If the parent can not be statted, delivery
19714 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19715 is set, because that option tells Exim to ignore &"something on the path is not
19716 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19717 that some operating systems give ENOENT where others give ENOTDIR.
19718
19719
19720
19721 .option include_directory redirect string unset
19722 If this option is set, the path names of any &':include:'& items in a
19723 redirection list must start with this directory.
19724
19725
19726 .option modemask redirect "octal integer" 022
19727 This specifies mode bits which must not be set for a file specified by the
19728 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19729
19730
19731 .option one_time redirect boolean false
19732 .cindex "one-time aliasing/forwarding expansion"
19733 .cindex "alias file" "one-time expansion"
19734 .cindex "forward file" "one-time expansion"
19735 .cindex "mailing lists" "one-time expansion"
19736 .cindex "address redirection" "one-time expansion"
19737 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19738 files each time it tries to deliver a message causes a problem when one or more
19739 of the generated addresses fails be delivered at the first attempt. The problem
19740 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19741 but of what happens when the redirection list changes during the time that the
19742 message is on Exim's queue. This is particularly true in the case of mailing
19743 lists, where new subscribers might receive copies of messages that were posted
19744 before they subscribed.
19745
19746 If &%one_time%& is set and any addresses generated by the router fail to
19747 deliver at the first attempt, the failing addresses are added to the message as
19748 &"top level"& addresses, and the parent address that generated them is marked
19749 &"delivered"&. Thus, redirection does not happen again at the next delivery
19750 attempt.
19751
19752 &*Warning 1*&: Any header line addition or removal that is specified by this
19753 router would be lost if delivery did not succeed at the first attempt. For this
19754 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19755 permitted when &%one_time%& is set.
19756
19757 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19758 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19759 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19760
19761 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19762 &%one_time%&.
19763
19764 The original top-level address is remembered with each of the generated
19765 addresses, and is output in any log messages. However, any intermediate parent
19766 addresses are not recorded. This makes a difference to the log only if
19767 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19768 typically be used for mailing lists, where there is normally just one level of
19769 expansion.
19770
19771
19772 .option owners redirect "string list" unset
19773 .cindex "ownership" "alias file"
19774 .cindex "ownership" "forward file"
19775 .cindex "alias file" "ownership"
19776 .cindex "forward file" "ownership"
19777 This specifies a list of permitted owners for the file specified by &%file%&.
19778 This list is in addition to the local user when &%check_local_user%& is set.
19779 See &%check_owner%& above.
19780
19781
19782 .option owngroups redirect "string list" unset
19783 This specifies a list of permitted groups for the file specified by &%file%&.
19784 The list is in addition to the local user's primary group when
19785 &%check_local_user%& is set. See &%check_group%& above.
19786
19787
19788 .option pipe_transport redirect string&!! unset
19789 .vindex "&$address_pipe$&"
19790 A &(redirect)& router sets up a direct delivery to a pipe when a string
19791 starting with a vertical bar character is specified as a new &"address"&. The
19792 transport used is specified by this option, which, after expansion, must be the
19793 name of a configured transport. This should normally be a &(pipe)& transport.
19794 When the transport is run, the pipe command is in &$address_pipe$&.
19795
19796
19797 .option qualify_domain redirect string&!! unset
19798 .vindex "&$qualify_recipient$&"
19799 If this option is set, and an unqualified address (one without a domain) is
19800 generated, and that address would normally be qualified by the global setting
19801 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19802 expanding this string. If the expansion fails, the router declines. If you want
19803 to revert to the default, you can have the expansion generate
19804 &$qualify_recipient$&.
19805
19806 This option applies to all unqualified addresses generated by Exim filters,
19807 but for traditional &_.forward_& files, it applies only to addresses that are
19808 not preceded by a backslash. Sieve filters cannot generate unqualified
19809 addresses.
19810
19811 .option qualify_preserve_domain redirect boolean false
19812 .cindex "domain" "in redirection; preserving"
19813 .cindex "preserving domain in redirection"
19814 .cindex "address redirection" "domain; preserving"
19815 If this option is set, the router's local &%qualify_domain%& option must not be
19816 set (a configuration error occurs if it is). If an unqualified address (one
19817 without a domain) is generated, it is qualified with the domain of the parent
19818 address (the immediately preceding ancestor) instead of the global
19819 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19820 this applies whether or not the address is preceded by a backslash.
19821
19822
19823 .option repeat_use redirect boolean true
19824 If this option is set false, the router is skipped for a child address that has
19825 any ancestor that was routed by this router. This test happens before any of
19826 the other preconditions are tested. Exim's default anti-looping rules skip
19827 only when the ancestor is the same as the current address. See also
19828 &%check_ancestor%& above and the generic &%redirect_router%& option.
19829
19830
19831 .option reply_transport redirect string&!! unset
19832 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19833 &%vacation%& command is used in a filter file. The transport used is specified
19834 by this option, which, after expansion, must be the name of a configured
19835 transport. This should normally be an &(autoreply)& transport. Other transports
19836 are unlikely to do anything sensible or useful.
19837
19838
19839 .option rewrite redirect boolean true
19840 .cindex "address redirection" "disabling rewriting"
19841 If this option is set false, addresses generated by the router are not
19842 subject to address rewriting. Otherwise, they are treated like new addresses
19843 and are rewritten according to the global rewriting rules.
19844
19845
19846 .option sieve_subaddress redirect string&!! unset
19847 The value of this option is passed to a Sieve filter to specify the
19848 :subaddress part of an address.
19849
19850 .option sieve_useraddress redirect string&!! unset
19851 The value of this option is passed to a Sieve filter to specify the :user part
19852 of an address. However, if it is unset, the entire original local part
19853 (including any prefix or suffix) is used for :user.
19854
19855
19856 .option sieve_vacation_directory redirect string&!! unset
19857 .cindex "Sieve filter" "vacation directory"
19858 To enable the &"vacation"& extension for Sieve filters, you must set
19859 &%sieve_vacation_directory%& to the directory where vacation databases are held
19860 (do not put anything else in that directory), and ensure that the
19861 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19862 needs their own directory; Exim will create it if necessary.
19863
19864
19865
19866 .option skip_syntax_errors redirect boolean false
19867 .cindex "forward file" "broken"
19868 .cindex "address redirection" "broken files"
19869 .cindex "alias file" "broken"
19870 .cindex "broken alias or forward files"
19871 .cindex "ignoring faulty addresses"
19872 .cindex "skipping faulty addresses"
19873 .cindex "error" "skipping bad syntax"
19874 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19875 non-filter redirection data are skipped, and each failing address is logged. If
19876 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19877 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19878 are expanded and placed at the head of the error message generated by
19879 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19880 be the same address as the generic &%errors_to%& option. The
19881 &%skip_syntax_errors%& option is often used when handling mailing lists.
19882
19883 If all the addresses in a redirection list are skipped because of syntax
19884 errors, the router declines to handle the original address, and it is passed to
19885 the following routers.
19886
19887 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19888 error in the filter causes filtering to be abandoned without any action being
19889 taken. The incident is logged, and the router declines to handle the address,
19890 so it is passed to the following routers.
19891
19892 .cindex "Sieve filter" "syntax errors in"
19893 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19894 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19895 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19896
19897 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19898 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19899 option, used with an address that does not get redirected, can be used to
19900 notify users of these errors, by means of a router like this:
19901 .code
19902 userforward:
19903   driver = redirect
19904   allow_filter
19905   check_local_user
19906   file = $home/.forward
19907   file_transport = address_file
19908   pipe_transport = address_pipe
19909   reply_transport = address_reply
19910   no_verify
19911   skip_syntax_errors
19912   syntax_errors_to = real-$local_part@$domain
19913   syntax_errors_text = \
19914    This is an automatically generated message. An error has\n\
19915    been found in your .forward file. Details of the error are\n\
19916    reported below. While this error persists, you will receive\n\
19917    a copy of this message for every message that is addressed\n\
19918    to you. If your .forward file is a filter file, or if it is\n\
19919    a non-filter file containing no valid forwarding addresses,\n\
19920    a copy of each incoming message will be put in your normal\n\
19921    mailbox. If a non-filter file contains at least one valid\n\
19922    forwarding address, forwarding to the valid addresses will\n\
19923    happen, and those will be the only deliveries that occur.
19924 .endd
19925 You also need a router to ensure that local addresses that are prefixed by
19926 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19927 put this immediately before the &(userforward)& router:
19928 .code
19929 real_localuser:
19930   driver = accept
19931   check_local_user
19932   local_part_prefix = real-
19933   transport = local_delivery
19934 .endd
19935 For security, it would probably be a good idea to restrict the use of this
19936 router to locally-generated messages, using a condition such as this:
19937 .code
19938   condition = ${if match {$sender_host_address}\
19939                          {\N^(|127\.0\.0\.1)$\N}}
19940 .endd
19941
19942
19943 .option syntax_errors_text redirect string&!! unset
19944 See &%skip_syntax_errors%& above.
19945
19946
19947 .option syntax_errors_to redirect string unset
19948 See &%skip_syntax_errors%& above.
19949 .ecindex IIDredrou1
19950 .ecindex IIDredrou2
19951
19952
19953
19954
19955
19956
19957 . ////////////////////////////////////////////////////////////////////////////
19958 . ////////////////////////////////////////////////////////////////////////////
19959
19960 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19961          "Environment for local transports"
19962 .scindex IIDenvlotra1 "local transports" "environment for"
19963 .scindex IIDenvlotra2 "environment for local transports"
19964 .scindex IIDenvlotra3 "transport" "local; environment for"
19965 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19966 transport can be thought of as similar to a pipe.) Exim always runs transports
19967 in subprocesses, under specified uids and gids. Typical deliveries to local
19968 mailboxes run under the uid and gid of the local user.
19969
19970 Exim also sets a specific current directory while running the transport; for
19971 some transports a home directory setting is also relevant. The &(pipe)&
19972 transport is the only one that sets up environment variables; see section
19973 &<<SECTpipeenv>>& for details.
19974
19975 The values used for the uid, gid, and the directories may come from several
19976 different places. In many cases, the router that handles the address associates
19977 settings with that address as a result of its &%check_local_user%&, &%group%&,
19978 or &%user%& options. However, values may also be given in the transport's own
19979 configuration, and these override anything that comes from the router.
19980
19981
19982
19983 .section "Concurrent deliveries" "SECID131"
19984 .cindex "concurrent deliveries"
19985 .cindex "simultaneous deliveries"
19986 If two different messages for the same local recipient arrive more or less
19987 simultaneously, the two delivery processes are likely to run concurrently. When
19988 the &(appendfile)& transport is used to write to a file, Exim applies locking
19989 rules to stop concurrent processes from writing to the same file at the same
19990 time.
19991
19992 However, when you use a &(pipe)& transport, it is up to you to arrange any
19993 locking that is needed. Here is a silly example:
19994 .code
19995 my_transport:
19996   driver = pipe
19997   command = /bin/sh -c 'cat >>/some/file'
19998 .endd
19999 This is supposed to write the message at the end of the file. However, if two
20000 messages arrive at the same time, the file will be scrambled. You can use the
20001 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20002 file using the same algorithm that Exim itself uses.
20003
20004
20005
20006
20007 .section "Uids and gids" "SECTenvuidgid"
20008 .cindex "local transports" "uid and gid"
20009 .cindex "transport" "local; uid and gid"
20010 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20011 overrides any group that the router set in the address, even if &%user%& is not
20012 set for the transport. This makes it possible, for example, to run local mail
20013 delivery under the uid of the recipient (set by the router), but in a special
20014 group (set by the transport). For example:
20015 .code
20016 # Routers ...
20017 # User/group are set by check_local_user in this router
20018 local_users:
20019   driver = accept
20020   check_local_user
20021   transport = group_delivery
20022
20023 # Transports ...
20024 # This transport overrides the group
20025 group_delivery:
20026   driver = appendfile
20027   file = /var/spool/mail/$local_part
20028   group = mail
20029 .endd
20030 If &%user%& is set for a transport, its value overrides what is set in the
20031 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20032 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20033 set.
20034
20035 .oindex "&%initgroups%&"
20036 When the uid is taken from the transport's configuration, the &[initgroups()]&
20037 function is called for the groups associated with that uid if the
20038 &%initgroups%& option is set for the transport. When the uid is not specified
20039 by the transport, but is associated with the address by a router, the option
20040 for calling &[initgroups()]& is taken from the router configuration.
20041
20042 .cindex "&(pipe)& transport" "uid for"
20043 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20044 is set and &%user%& is not set, the uid of the process that called Exim to
20045 receive the message is used, and if &%group%& is not set, the corresponding
20046 original gid is also used.
20047
20048 This is the detailed preference order for obtaining a gid; the first of the
20049 following that is set is used:
20050
20051 .ilist
20052 A &%group%& setting of the transport;
20053 .next
20054 A &%group%& setting of the router;
20055 .next
20056 A gid associated with a user setting of the router, either as a result of
20057 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20058 .next
20059 The group associated with a non-numeric &%user%& setting of the transport;
20060 .next
20061 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20062 the uid is the creator's uid;
20063 .next
20064 The Exim gid if the Exim uid is being used as a default.
20065 .endlist
20066
20067 If, for example, the user is specified numerically on the router and there are
20068 no group settings, no gid is available. In this situation, an error occurs.
20069 This is different for the uid, for which there always is an ultimate default.
20070 The first of the following that is set is used:
20071
20072 .ilist
20073 A &%user%& setting of the transport;
20074 .next
20075 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20076 .next
20077 A &%user%& setting of the router;
20078 .next
20079 A &%check_local_user%& setting of the router;
20080 .next
20081 The Exim uid.
20082 .endlist
20083
20084 Of course, an error will still occur if the uid that is chosen is on the
20085 &%never_users%& list.
20086
20087
20088
20089
20090
20091 .section "Current and home directories" "SECID132"
20092 .cindex "current directory for local transport"
20093 .cindex "home directory" "for local transport"
20094 .cindex "transport" "local; home directory for"
20095 .cindex "transport" "local; current directory for"
20096 Routers may set current and home directories for local transports by means of
20097 the &%transport_current_directory%& and &%transport_home_directory%& options.
20098 However, if the transport's &%current_directory%& or &%home_directory%& options
20099 are set, they override the router's values. In detail, the home directory
20100 for a local transport is taken from the first of these values that is set:
20101
20102 .ilist
20103 The &%home_directory%& option on the transport;
20104 .next
20105 The &%transport_home_directory%& option on the router;
20106 .next
20107 The password data if &%check_local_user%& is set on the router;
20108 .next
20109 The &%router_home_directory%& option on the router.
20110 .endlist
20111
20112 The current directory is taken from the first of these values that is set:
20113
20114 .ilist
20115 The &%current_directory%& option on the transport;
20116 .next
20117 The &%transport_current_directory%& option on the router.
20118 .endlist
20119
20120
20121 If neither the router nor the transport sets a current directory, Exim uses the
20122 value of the home directory, if it is set. Otherwise it sets the current
20123 directory to &_/_& before running a local transport.
20124
20125
20126
20127 .section "Expansion variables derived from the address" "SECID133"
20128 .vindex "&$domain$&"
20129 .vindex "&$local_part$&"
20130 .vindex "&$original_domain$&"
20131 Normally a local delivery is handling a single address, and in that case the
20132 variables such as &$domain$& and &$local_part$& are set during local
20133 deliveries. However, in some circumstances more than one address may be handled
20134 at once (for example, while writing batch SMTP for onward transmission by some
20135 other means). In this case, the variables associated with the local part are
20136 never set, &$domain$& is set only if all the addresses have the same domain,
20137 and &$original_domain$& is never set.
20138 .ecindex IIDenvlotra1
20139 .ecindex IIDenvlotra2
20140 .ecindex IIDenvlotra3
20141
20142
20143
20144
20145
20146
20147
20148 . ////////////////////////////////////////////////////////////////////////////
20149 . ////////////////////////////////////////////////////////////////////////////
20150
20151 .chapter "Generic options for transports" "CHAPtransportgeneric"
20152 .scindex IIDgenoptra1 "generic options" "transport"
20153 .scindex IIDgenoptra2 "options" "generic; for transports"
20154 .scindex IIDgenoptra3 "transport" "generic options for"
20155 The following generic options apply to all transports:
20156
20157
20158 .option body_only transports boolean false
20159 .cindex "transport" "body only"
20160 .cindex "message" "transporting body only"
20161 .cindex "body of message" "transporting"
20162 If this option is set, the message's headers are not transported. It is
20163 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20164 or &(pipe)& transports, the settings of &%message_prefix%& and
20165 &%message_suffix%& should be checked, because this option does not
20166 automatically suppress them.
20167
20168
20169 .option current_directory transports string&!! unset
20170 .cindex "transport" "current directory for"
20171 This specifies the current directory that is to be set while running the
20172 transport, overriding any value that may have been set by the router.
20173 If the expansion fails for any reason, including forced failure, an error is
20174 logged, and delivery is deferred.
20175
20176
20177 .option disable_logging transports boolean false
20178 If this option is set true, nothing is logged for any
20179 deliveries by the transport or for any
20180 transport errors. You should not set this option unless you really, really know
20181 what you are doing.
20182
20183
20184 .option debug_print transports string&!! unset
20185 .cindex "testing" "variables in drivers"
20186 If this option is set and debugging is enabled (see the &%-d%& command line
20187 option), the string is expanded and included in the debugging output when the
20188 transport is run.
20189 If expansion of the string fails, the error message is written to the debugging
20190 output, and Exim carries on processing.
20191 This facility is provided to help with checking out the values of variables and
20192 so on when debugging driver configurations. For example, if a &%headers_add%&
20193 option is not working properly, &%debug_print%& could be used to output the
20194 variables it references. A newline is added to the text if it does not end with
20195 one.
20196 The variables &$transport_name$& and &$router_name$& contain the name of the
20197 transport and the router that called it.
20198
20199 .option delivery_date_add transports boolean false
20200 .cindex "&'Delivery-date:'& header line"
20201 If this option is true, a &'Delivery-date:'& header is added to the message.
20202 This gives the actual time the delivery was made. As this is not a standard
20203 header, Exim has a configuration option (&%delivery_date_remove%&) which
20204 requests its removal from incoming messages, so that delivered messages can
20205 safely be resent to other recipients.
20206
20207
20208 .option driver transports string unset
20209 This specifies which of the available transport drivers is to be used.
20210 There is no default, and this option must be set for every transport.
20211
20212
20213 .option envelope_to_add transports boolean false
20214 .cindex "&'Envelope-to:'& header line"
20215 If this option is true, an &'Envelope-to:'& header is added to the message.
20216 This gives the original address(es) in the incoming envelope that caused this
20217 delivery to happen. More than one address may be present if the transport is
20218 configured to handle several addresses at once, or if more than one original
20219 address was redirected to the same final address. As this is not a standard
20220 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20221 its removal from incoming messages, so that delivered messages can safely be
20222 resent to other recipients.
20223
20224
20225 .option group transports string&!! "Exim group"
20226 .cindex "transport" "group; specifying"
20227 This option specifies a gid for running the transport process, overriding any
20228 value that the router supplies, and also overriding any value associated with
20229 &%user%& (see below).
20230
20231
20232 .option headers_add transports list&!! unset
20233 .cindex "header lines" "adding in transport"
20234 .cindex "transport" "header lines; adding"
20235 This option specifies a list of text headers, newline-separated,
20236 which are (separately) expanded and added to the header
20237 portion of a message as it is transported, as described in section
20238 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20239 routers. If the result of the expansion is an empty string, or if the expansion
20240 is forced to fail, no action is taken. Other expansion failures are treated as
20241 errors and cause the delivery to be deferred.
20242
20243 Unlike most options, &%headers_add%& can be specified multiple times
20244 for a transport; all listed headers are added.
20245
20246
20247 .option headers_only transports boolean false
20248 .cindex "transport" "header lines only"
20249 .cindex "message" "transporting headers only"
20250 .cindex "header lines" "transporting"
20251 If this option is set, the message's body is not transported. It is mutually
20252 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20253 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20254 checked, since this option does not automatically suppress them.
20255
20256
20257 .option headers_remove transports list&!! unset
20258 .cindex "header lines" "removing"
20259 .cindex "transport" "header lines; removing"
20260 This option specifies a list of header names, colon-separated;
20261 these headers are omitted from the message as it is transported, as described
20262 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20263 routers.
20264 Each list item is separately expanded.
20265 If the result of the expansion is an empty string, or if the expansion
20266 is forced to fail, no action is taken. Other expansion failures are treated as
20267 errors and cause the delivery to be deferred.
20268
20269 Unlike most options, &%headers_remove%& can be specified multiple times
20270 for a router; all listed headers are removed.
20271
20272
20273
20274 .option headers_rewrite transports string unset
20275 .cindex "transport" "header lines; rewriting"
20276 .cindex "rewriting" "at transport time"
20277 This option allows addresses in header lines to be rewritten at transport time,
20278 that is, as the message is being copied to its destination. The contents of the
20279 option are a colon-separated list of rewriting rules. Each rule is in exactly
20280 the same form as one of the general rewriting rules that are applied when a
20281 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20282 example,
20283 .code
20284 headers_rewrite = a@b c@d f : \
20285                   x@y w@z
20286 .endd
20287 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20288 &'w@z'& in all address-bearing header lines. The rules are applied to the
20289 header lines just before they are written out at transport time, so they affect
20290 only those copies of the message that pass through the transport. However, only
20291 the message's original header lines, and any that were added by a system
20292 filter, are rewritten. If a router or transport adds header lines, they are not
20293 affected by this option. These rewriting rules are &'not'& applied to the
20294 envelope. You can change the return path using &%return_path%&, but you cannot
20295 change envelope recipients at this time.
20296
20297
20298 .option home_directory transports string&!! unset
20299 .cindex "transport" "home directory for"
20300 .vindex "&$home$&"
20301 This option specifies a home directory setting for a local transport,
20302 overriding any value that may be set by the router. The home directory is
20303 placed in &$home$& while expanding the transport's private options. It is also
20304 used as the current directory if no current directory is set by the
20305 &%current_directory%& option on the transport or the
20306 &%transport_current_directory%& option on the router. If the expansion fails
20307 for any reason, including forced failure, an error is logged, and delivery is
20308 deferred.
20309
20310
20311 .option initgroups transports boolean false
20312 .cindex "additional groups"
20313 .cindex "groups" "additional"
20314 .cindex "transport" "group; additional"
20315 If this option is true and the uid for the delivery process is provided by the
20316 transport, the &[initgroups()]& function is called when running the transport
20317 to ensure that any additional groups associated with the uid are set up.
20318
20319
20320 .option message_size_limit transports string&!! 0
20321 .cindex "limit" "message size per transport"
20322 .cindex "size" "of message, limit"
20323 .cindex "transport" "message size; limiting"
20324 This option controls the size of messages passed through the transport. It is
20325 expanded before use; the result of the expansion must be a sequence of decimal
20326 digits, optionally followed by K or M. If the expansion fails for any reason,
20327 including forced failure, or if the result is not of the required form,
20328 delivery is deferred. If the value is greater than zero and the size of a
20329 message exceeds this limit, the address is failed. If there is any chance that
20330 the resulting bounce message could be routed to the same transport, you should
20331 ensure that &%return_size_limit%& is less than the transport's
20332 &%message_size_limit%&, as otherwise the bounce message will fail to get
20333 delivered.
20334
20335
20336
20337 .option rcpt_include_affixes transports boolean false
20338 .cindex "prefix" "for local part, including in envelope"
20339 .cindex "suffix for local part" "including in envelope"
20340 .cindex "local part" "prefix"
20341 .cindex "local part" "suffix"
20342 When this option is false (the default), and an address that has had any
20343 affixes (prefixes or suffixes) removed from the local part is delivered by any
20344 form of SMTP or LMTP, the affixes are not included. For example, if a router
20345 that contains
20346 .code
20347 local_part_prefix = *-
20348 .endd
20349 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20350 is delivered with
20351 .code
20352 RCPT TO:<xyz@some.domain>
20353 .endd
20354 This is also the case when an ACL-time callout is being used to verify a
20355 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20356 whole local part is included in the RCPT command. This option applies to BSMTP
20357 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20358 &(lmtp)& and &(smtp)& transports.
20359
20360
20361 .option retry_use_local_part transports boolean "see below"
20362 .cindex "hints database" "retry keys"
20363 When a delivery suffers a temporary failure, a retry record is created
20364 in Exim's hints database. For remote deliveries, the key for the retry record
20365 is based on the name and/or IP address of the failing remote host. For local
20366 deliveries, the key is normally the entire address, including both the local
20367 part and the domain. This is suitable for most common cases of local delivery
20368 temporary failure &-- for example, exceeding a mailbox quota should delay only
20369 deliveries to that mailbox, not to the whole domain.
20370
20371 However, in some special cases you may want to treat a temporary local delivery
20372 as a failure associated with the domain, and not with a particular local part.
20373 (For example, if you are storing all mail for some domain in files.) You can do
20374 this by setting &%retry_use_local_part%& false.
20375
20376 For all the local transports, its default value is true. For remote transports,
20377 the default value is false for tidiness, but changing the value has no effect
20378 on a remote transport in the current implementation.
20379
20380
20381 .option return_path transports string&!! unset
20382 .cindex "envelope sender"
20383 .cindex "transport" "return path; changing"
20384 .cindex "return path" "changing in transport"
20385 If this option is set, the string is expanded at transport time and replaces
20386 the existing return path (envelope sender) value in the copy of the message
20387 that is being delivered. An empty return path is permitted. This feature is
20388 designed for remote deliveries, where the value of this option is used in the
20389 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20390 only effect is to change the address that is placed in the &'Return-path:'&
20391 header line, if one is added to the message (see the next option).
20392
20393 &*Note:*& A changed return path is not logged unless you add
20394 &%return_path_on_delivery%& to the log selector.
20395
20396 .vindex "&$return_path$&"
20397 The expansion can refer to the existing value via &$return_path$&. This is
20398 either the message's envelope sender, or an address set by the
20399 &%errors_to%& option on a router. If the expansion is forced to fail, no
20400 replacement occurs; if it fails for another reason, delivery is deferred. This
20401 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20402 section &<<SECTverp>>&.
20403
20404 &*Note*&: If a delivery error is detected locally, including the case when a
20405 remote server rejects a message at SMTP time, the bounce message is not sent to
20406 the value of this option. It is sent to the previously set errors address.
20407 This defaults to the incoming sender address, but can be changed by setting
20408 &%errors_to%& in a router.
20409
20410
20411
20412 .option return_path_add transports boolean false
20413 .cindex "&'Return-path:'& header line"
20414 If this option is true, a &'Return-path:'& header is added to the message.
20415 Although the return path is normally available in the prefix line of BSD
20416 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20417 have easy access to it.
20418
20419 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20420 the delivery SMTP server makes the final delivery"&. This implies that this
20421 header should not be present in incoming messages. Exim has a configuration
20422 option, &%return_path_remove%&, which requests removal of this header from
20423 incoming messages, so that delivered messages can safely be resent to other
20424 recipients.
20425
20426
20427 .option shadow_condition transports string&!! unset
20428 See &%shadow_transport%& below.
20429
20430
20431 .option shadow_transport transports string unset
20432 .cindex "shadow transport"
20433 .cindex "transport" "shadow"
20434 A local transport may set the &%shadow_transport%& option to the name of
20435 another local transport. Shadow remote transports are not supported.
20436
20437 Whenever a delivery to the main transport succeeds, and either
20438 &%shadow_condition%& is unset, or its expansion does not result in the empty
20439 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20440 passed to the shadow transport, with the same delivery address or addresses. If
20441 expansion fails, no action is taken except that non-forced expansion failures
20442 cause a log line to be written.
20443
20444 The result of the shadow transport is discarded and does not affect the
20445 subsequent processing of the message. Only a single level of shadowing is
20446 provided; the &%shadow_transport%& option is ignored on any transport when it
20447 is running as a shadow. Options concerned with output from pipes are also
20448 ignored. The log line for the successful delivery has an item added on the end,
20449 of the form
20450 .code
20451 ST=<shadow transport name>
20452 .endd
20453 If the shadow transport did not succeed, the error message is put in
20454 parentheses afterwards. Shadow transports can be used for a number of different
20455 purposes, including keeping more detailed log information than Exim normally
20456 provides, and implementing automatic acknowledgment policies based on message
20457 headers that some sites insist on.
20458
20459
20460 .option transport_filter transports string&!! unset
20461 .cindex "transport" "filter"
20462 .cindex "filter" "transport filter"
20463 This option sets up a filtering (in the Unix shell sense) process for messages
20464 at transport time. It should not be confused with mail filtering as set up by
20465 individual users or via a system filter.
20466
20467 When the message is about to be written out, the command specified by
20468 &%transport_filter%& is started up in a separate, parallel process, and
20469 the entire message, including the header lines, is passed to it on its standard
20470 input (this in fact is done from a third process, to avoid deadlock). The
20471 command must be specified as an absolute path.
20472
20473 The lines of the message that are written to the transport filter are
20474 terminated by newline (&"\n"&). The message is passed to the filter before any
20475 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20476 lines beginning with a dot, and also before any processing implied by the
20477 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20478 &(pipe)& transports.
20479
20480 The standard error for the filter process is set to the same destination as its
20481 standard output; this is read and written to the message's ultimate
20482 destination. The process that writes the message to the filter, the
20483 filter itself, and the original process that reads the result and delivers it
20484 are all run in parallel, like a shell pipeline.
20485
20486 The filter can perform any transformations it likes, but of course should take
20487 care not to break RFC 2822 syntax. Exim does not check the result, except to
20488 test for a final newline when SMTP is in use. All messages transmitted over
20489 SMTP must end with a newline, so Exim supplies one if it is missing.
20490
20491 .cindex "content scanning" "per user"
20492 A transport filter can be used to provide content-scanning on a per-user basis
20493 at delivery time if the only required effect of the scan is to modify the
20494 message. For example, a content scan could insert a new header line containing
20495 a spam score. This could be interpreted by a filter in the user's MUA. It is
20496 not possible to discard a message at this stage.
20497
20498 .cindex "SMTP" "SIZE"
20499 A problem might arise if the filter increases the size of a message that is
20500 being sent down an SMTP connection. If the receiving SMTP server has indicated
20501 support for the SIZE parameter, Exim will have sent the size of the message
20502 at the start of the SMTP session. If what is actually sent is substantially
20503 more, the server might reject the message. This can be worked round by setting
20504 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20505 additions to the message, or to disable the use of SIZE altogether.
20506
20507 .vindex "&$pipe_addresses$&"
20508 The value of the &%transport_filter%& option is the command string for starting
20509 the filter, which is run directly from Exim, not under a shell. The string is
20510 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20511 Exim breaks it up into arguments and then expands each argument separately (see
20512 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20513 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20514 of arguments, one for each address that applies to this delivery. (This isn't
20515 an ideal name for this feature here, but as it was already implemented for the
20516 &(pipe)& transport, it seemed sensible not to change it.)
20517
20518 .vindex "&$host$&"
20519 .vindex "&$host_address$&"
20520 The expansion variables &$host$& and &$host_address$& are available when the
20521 transport is a remote one. They contain the name and IP address of the host to
20522 which the message is being sent. For example:
20523 .code
20524 transport_filter = /some/directory/transport-filter.pl \
20525   $host $host_address $sender_address $pipe_addresses
20526 .endd
20527
20528 Two problems arise if you want to use more complicated expansion items to
20529 generate transport filter commands, both of which due to the fact that the
20530 command is split up &'before'& expansion.
20531 .ilist
20532 If an expansion item contains white space, you must quote it, so that it is all
20533 part of the same command item. If the entire option setting is one such
20534 expansion item, you have to take care what kind of quoting you use. For
20535 example:
20536 .code
20537 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20538 .endd
20539 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20540 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20541 stripped by Exim when it read the option's value. When the value is used, if
20542 the single quotes were missing, the line would be split into two items,
20543 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20544 Exim tried to expand the first one.
20545 .next
20546 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20547 expansion cannot generate multiple arguments, or a command name followed by
20548 arguments. Consider this example:
20549 .code
20550 transport_filter = ${lookup{$host}lsearch{/a/file}\
20551                     {$value}{/bin/cat}}
20552 .endd
20553 The result of the lookup is interpreted as the name of the command, even
20554 if it contains white space. The simplest way round this is to use a shell:
20555 .code
20556 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20557                                {$value}{/bin/cat}}
20558 .endd
20559 .endlist
20560
20561 The filter process is run under the same uid and gid as the normal delivery.
20562 For remote deliveries this is the Exim uid/gid by default. The command should
20563 normally yield a zero return code. Transport filters are not supposed to fail.
20564 A non-zero code is taken to mean that the transport filter encountered some
20565 serious problem. Delivery of the message is deferred; the message remains on
20566 the queue and is tried again later. It is not possible to cause a message to be
20567 bounced from a transport filter.
20568
20569 If a transport filter is set on an autoreply transport, the original message is
20570 passed through the filter as it is being copied into the newly generated
20571 message, which happens if the &%return_message%& option is set.
20572
20573
20574 .option transport_filter_timeout transports time 5m
20575 .cindex "transport" "filter, timeout"
20576 When Exim is reading the output of a transport filter, it applies a timeout
20577 that can be set by this option. Exceeding the timeout is normally treated as a
20578 temporary delivery failure. However, if a transport filter is used with a
20579 &(pipe)& transport, a timeout in the transport filter is treated in the same
20580 way as a timeout in the pipe command itself. By default, a timeout is a hard
20581 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20582 becomes a temporary error.
20583
20584
20585 .option user transports string&!! "Exim user"
20586 .cindex "uid (user id)" "local delivery"
20587 .cindex "transport" "user, specifying"
20588 This option specifies the user under whose uid the delivery process is to be
20589 run, overriding any uid that may have been set by the router. If the user is
20590 given as a name, the uid is looked up from the password data, and the
20591 associated group is taken as the value of the gid to be used if the &%group%&
20592 option is not set.
20593
20594 For deliveries that use local transports, a user and group are normally
20595 specified explicitly or implicitly (for example, as a result of
20596 &%check_local_user%&) by the router or transport.
20597
20598 .cindex "hints database" "access by remote transport"
20599 For remote transports, you should leave this option unset unless you really are
20600 sure you know what you are doing. When a remote transport is running, it needs
20601 to be able to access Exim's hints databases, because each host may have its own
20602 retry data.
20603 .ecindex IIDgenoptra1
20604 .ecindex IIDgenoptra2
20605 .ecindex IIDgenoptra3
20606
20607
20608
20609
20610
20611
20612 . ////////////////////////////////////////////////////////////////////////////
20613 . ////////////////////////////////////////////////////////////////////////////
20614
20615 .chapter "Address batching in local transports" "CHAPbatching" &&&
20616          "Address batching"
20617 .cindex "transport" "local; address batching in"
20618 The only remote transport (&(smtp)&) is normally configured to handle more than
20619 one address at a time, so that when several addresses are routed to the same
20620 remote host, just one copy of the message is sent. Local transports, however,
20621 normally handle one address at a time. That is, a separate instance of the
20622 transport is run for each address that is routed to the transport. A separate
20623 copy of the message is delivered each time.
20624
20625 .cindex "batched local delivery"
20626 .oindex "&%batch_max%&"
20627 .oindex "&%batch_id%&"
20628 In special cases, it may be desirable to handle several addresses at once in a
20629 local transport, for example:
20630
20631 .ilist
20632 In an &(appendfile)& transport, when storing messages in files for later
20633 delivery by some other means, a single copy of the message with multiple
20634 recipients saves space.
20635 .next
20636 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20637 a single copy saves time, and is the normal way LMTP is expected to work.
20638 .next
20639 In a &(pipe)& transport, when passing the message
20640 to a scanner program or
20641 to some other delivery mechanism such as UUCP, multiple recipients may be
20642 acceptable.
20643 .endlist
20644
20645 These three local transports all have the same options for controlling multiple
20646 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20647 repeating the information for each transport, these options are described here.
20648
20649 The &%batch_max%& option specifies the maximum number of addresses that can be
20650 delivered together in a single run of the transport. Its default value is one
20651 (no batching). When more than one address is routed to a transport that has a
20652 &%batch_max%& value greater than one, the addresses are delivered in a batch
20653 (that is, in a single run of the transport with multiple recipients), subject
20654 to certain conditions:
20655
20656 .ilist
20657 .vindex "&$local_part$&"
20658 If any of the transport's options contain a reference to &$local_part$&, no
20659 batching is possible.
20660 .next
20661 .vindex "&$domain$&"
20662 If any of the transport's options contain a reference to &$domain$&, only
20663 addresses with the same domain are batched.
20664 .next
20665 .cindex "customizing" "batching condition"
20666 If &%batch_id%& is set, it is expanded for each address, and only those
20667 addresses with the same expanded value are batched. This allows you to specify
20668 customized batching conditions. Failure of the expansion for any reason,
20669 including forced failure, disables batching, but it does not stop the delivery
20670 from taking place.
20671 .next
20672 Batched addresses must also have the same errors address (where to send
20673 delivery errors), the same header additions and removals, the same user and
20674 group for the transport, and if a host list is present, the first host must
20675 be the same.
20676 .endlist
20677
20678 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20679 both when the file or pipe command is specified in the transport, and when it
20680 is specified by a &(redirect)& router, but all the batched addresses must of
20681 course be routed to the same file or pipe command. These two transports have an
20682 option called &%use_bsmtp%&, which causes them to deliver the message in
20683 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20684 &%check_string%& and &%escape_string%& options are forced to the values
20685 .code
20686 check_string = "."
20687 escape_string = ".."
20688 .endd
20689 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20690 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20691 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20692
20693 .cindex "&'Envelope-to:'& header line"
20694 If the generic &%envelope_to_add%& option is set for a batching transport, the
20695 &'Envelope-to:'& header that is added to the message contains all the addresses
20696 that are being processed together. If you are using a batching &(appendfile)&
20697 transport without &%use_bsmtp%&, the only way to preserve the recipient
20698 addresses is to set the &%envelope_to_add%& option.
20699
20700 .cindex "&(pipe)& transport" "with multiple addresses"
20701 .vindex "&$pipe_addresses$&"
20702 If you are using a &(pipe)& transport without BSMTP, and setting the
20703 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20704 the command. This is not a true variable; it is a bit of magic that causes each
20705 of the recipient addresses to be inserted into the command as a separate
20706 argument. This provides a way of accessing all the addresses that are being
20707 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20708 are specified by a &(redirect)& router.
20709
20710
20711
20712
20713 . ////////////////////////////////////////////////////////////////////////////
20714 . ////////////////////////////////////////////////////////////////////////////
20715
20716 .chapter "The appendfile transport" "CHAPappendfile"
20717 .scindex IIDapptra1 "&(appendfile)& transport"
20718 .scindex IIDapptra2 "transports" "&(appendfile)&"
20719 .cindex "directory creation"
20720 .cindex "creating directories"
20721 The &(appendfile)& transport delivers a message by appending it to an existing
20722 file, or by creating an entirely new file in a specified directory. Single
20723 files to which messages are appended can be in the traditional Unix mailbox
20724 format, or optionally in the MBX format supported by the Pine MUA and
20725 University of Washington IMAP daemon, &'inter alia'&. When each message is
20726 being delivered as a separate file, &"maildir"& format can optionally be used
20727 to give added protection against failures that happen part-way through the
20728 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20729 supported. For all file formats, Exim attempts to create as many levels of
20730 directory as necessary, provided that &%create_directory%& is set.
20731
20732 The code for the optional formats is not included in the Exim binary by
20733 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20734 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20735 included.
20736
20737 .cindex "quota" "system"
20738 Exim recognizes system quota errors, and generates an appropriate message. Exim
20739 also supports its own quota control within the transport, for use when the
20740 system facility is unavailable or cannot be used for some reason.
20741
20742 If there is an error while appending to a file (for example, quota exceeded or
20743 partition filled), Exim attempts to reset the file's length and last
20744 modification time back to what they were before. If there is an error while
20745 creating an entirely new file, the new file is removed.
20746
20747 Before appending to a file, a number of security checks are made, and the
20748 file is locked. A detailed description is given below, after the list of
20749 private options.
20750
20751 The &(appendfile)& transport is most commonly used for local deliveries to
20752 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20753 putting messages into files for remote delivery by some means other than Exim.
20754 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20755 option).
20756
20757
20758
20759 .section "The file and directory options" "SECTfildiropt"
20760 The &%file%& option specifies a single file, to which the message is appended;
20761 the &%directory%& option specifies a directory, in which a new file containing
20762 the message is created. Only one of these two options can be set, and for
20763 normal deliveries to mailboxes, one of them &'must'& be set.
20764
20765 .vindex "&$address_file$&"
20766 .vindex "&$local_part$&"
20767 However, &(appendfile)& is also used for delivering messages to files or
20768 directories whose names (or parts of names) are obtained from alias,
20769 forwarding, or filtering operations (for example, a &%save%& command in a
20770 user's Exim filter). When such a transport is running, &$local_part$& contains
20771 the local part that was aliased or forwarded, and &$address_file$& contains the
20772 name (or partial name) of the file or directory generated by the redirection
20773 operation. There are two cases:
20774
20775 .ilist
20776 If neither &%file%& nor &%directory%& is set, the redirection operation
20777 must specify an absolute path (one that begins with &`/`&). This is the most
20778 common case when users with local accounts use filtering to sort mail into
20779 different folders. See for example, the &(address_file)& transport in the
20780 default configuration. If the path ends with a slash, it is assumed to be the
20781 name of a directory. A delivery to a directory can also be forced by setting
20782 &%maildir_format%& or &%mailstore_format%&.
20783 .next
20784 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20785 used to determine the file or directory name for the delivery. Normally, the
20786 contents of &$address_file$& are used in some way in the string expansion.
20787 .endlist
20788
20789
20790 .cindex "Sieve filter" "configuring &(appendfile)&"
20791 .cindex "Sieve filter" "relative mailbox path handling"
20792 As an example of the second case, consider an environment where users do not
20793 have home directories. They may be permitted to use Exim filter commands of the
20794 form:
20795 .code
20796 save folder23
20797 .endd
20798 or Sieve filter commands of the form:
20799 .code
20800 require "fileinto";
20801 fileinto "folder23";
20802 .endd
20803 In this situation, the expansion of &%file%& or &%directory%& in the transport
20804 must transform the relative path into an appropriate absolute file name. In the
20805 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20806 is used as a result of a &"keep"& action in the filter. This example shows one
20807 way of handling this requirement:
20808 .code
20809 file = ${if eq{$address_file}{inbox} \
20810             {/var/mail/$local_part} \
20811             {${if eq{${substr_0_1:$address_file}}{/} \
20812                   {$address_file} \
20813                   {$home/mail/$address_file} \
20814             }} \
20815        }
20816 .endd
20817 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20818 location, absolute paths are used without change, and other folders are in the
20819 &_mail_& directory within the home directory.
20820
20821 &*Note 1*&: While processing an Exim filter, a relative path such as
20822 &_folder23_& is turned into an absolute path if a home directory is known to
20823 the router. In particular, this is the case if &%check_local_user%& is set. If
20824 you want to prevent this happening at routing time, you can set
20825 &%router_home_directory%& empty. This forces the router to pass the relative
20826 path to the transport.
20827
20828 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20829 the &%file%& or &%directory%& option is still used if it is set.
20830
20831
20832
20833
20834 .section "Private options for appendfile" "SECID134"
20835 .cindex "options" "&(appendfile)& transport"
20836
20837
20838
20839 .option allow_fifo appendfile boolean false
20840 .cindex "fifo (named pipe)"
20841 .cindex "named pipe (fifo)"
20842 .cindex "pipe" "named (fifo)"
20843 Setting this option permits delivery to named pipes (FIFOs) as well as to
20844 regular files. If no process is reading the named pipe at delivery time, the
20845 delivery is deferred.
20846
20847
20848 .option allow_symlink appendfile boolean false
20849 .cindex "symbolic link" "to mailbox"
20850 .cindex "mailbox" "symbolic link"
20851 By default, &(appendfile)& will not deliver if the path name for the file is
20852 that of a symbolic link. Setting this option relaxes that constraint, but there
20853 are security issues involved in the use of symbolic links. Be sure you know
20854 what you are doing if you set this. Details of exactly what this option affects
20855 are included in the discussion which follows this list of options.
20856
20857
20858 .option batch_id appendfile string&!! unset
20859 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20860 However, batching is automatically disabled for &(appendfile)& deliveries that
20861 happen as a result of forwarding or aliasing or other redirection directly to a
20862 file.
20863
20864
20865 .option batch_max appendfile integer 1
20866 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20867
20868
20869 .option check_group appendfile boolean false
20870 When this option is set, the group owner of the file defined by the &%file%&
20871 option is checked to see that it is the same as the group under which the
20872 delivery process is running. The default setting is false because the default
20873 file mode is 0600, which means that the group is irrelevant.
20874
20875
20876 .option check_owner appendfile boolean true
20877 When this option is set, the owner of the file defined by the &%file%& option
20878 is checked to ensure that it is the same as the user under which the delivery
20879 process is running.
20880
20881
20882 .option check_string appendfile string "see below"
20883 .cindex "&""From""& line"
20884 As &(appendfile)& writes the message, the start of each line is tested for
20885 matching &%check_string%&, and if it does, the initial matching characters are
20886 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20887 a literal string, not a regular expression, and the case of any letters it
20888 contains is significant.
20889
20890 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20891 are forced to &"."& and &".."& respectively, and any settings in the
20892 configuration are ignored. Otherwise, they default to &"From&~"& and
20893 &">From&~"& when the &%file%& option is set, and unset when any of the
20894 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20895
20896 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20897 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20898 &"From&~"& indicates the start of a new message. All four options need changing
20899 if another format is used. For example, to deliver to mailboxes in MMDF format:
20900 .cindex "MMDF format mailbox"
20901 .cindex "mailbox" "MMDF format"
20902 .code
20903 check_string = "\1\1\1\1\n"
20904 escape_string = "\1\1\1\1 \n"
20905 message_prefix = "\1\1\1\1\n"
20906 message_suffix = "\1\1\1\1\n"
20907 .endd
20908 .option create_directory appendfile boolean true
20909 .cindex "directory creation"
20910 When this option is true, Exim attempts to create any missing superior
20911 directories for the file that it is about to write. A created directory's mode
20912 is given by the &%directory_mode%& option.
20913
20914 The group ownership of a newly created directory is highly dependent on the
20915 operating system (and possibly the file system) that is being used. For
20916 example, in Solaris, if the parent directory has the setgid bit set, its group
20917 is propagated to the child; if not, the currently set group is used. However,
20918 in FreeBSD, the parent's group is always used.
20919
20920
20921
20922 .option create_file appendfile string anywhere
20923 This option constrains the location of files and directories that are created
20924 by this transport. It applies to files defined by the &%file%& option and
20925 directories defined by the &%directory%& option. In the case of maildir
20926 delivery, it applies to the top level directory, not the maildir directories
20927 beneath.
20928
20929 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20930 &"belowhome"&. In the second and third cases, a home directory must have been
20931 set for the transport. This option is not useful when an explicit file name is
20932 given for normal mailbox deliveries. It is intended for the case when file
20933 names are generated from users' &_.forward_& files. These are usually handled
20934 by an &(appendfile)& transport called &%address_file%&. See also
20935 &%file_must_exist%&.
20936
20937
20938 .option directory appendfile string&!! unset
20939 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20940 or &%directory%& must be set, unless the delivery is the direct result of a
20941 redirection (see section &<<SECTfildiropt>>&).
20942
20943 When &%directory%& is set, the string is expanded, and the message is delivered
20944 into a new file or files in or below the given directory, instead of being
20945 appended to a single mailbox file. A number of different formats are provided
20946 (see &%maildir_format%& and &%mailstore_format%&), and see section
20947 &<<SECTopdir>>& for further details of this form of delivery.
20948
20949
20950 .option directory_file appendfile string&!! "see below"
20951 .cindex "base62"
20952 .vindex "&$inode$&"
20953 When &%directory%& is set, but neither &%maildir_format%& nor
20954 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20955 whose name is obtained by expanding this string. The default value is:
20956 .code
20957 q${base62:$tod_epoch}-$inode
20958 .endd
20959 This generates a unique name from the current time, in base 62 form, and the
20960 inode of the file. The variable &$inode$& is available only when expanding this
20961 option.
20962
20963
20964 .option directory_mode appendfile "octal integer" 0700
20965 If &(appendfile)& creates any directories as a result of the
20966 &%create_directory%& option, their mode is specified by this option.
20967
20968
20969 .option escape_string appendfile string "see description"
20970 See &%check_string%& above.
20971
20972
20973 .option file appendfile string&!! unset
20974 This option is mutually exclusive with the &%directory%& option, but one of
20975 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20976 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20977 specifies a single file, to which the message is appended. One or more of
20978 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20979 &%file%&.
20980
20981 .cindex "NFS" "lock file"
20982 .cindex "locking files"
20983 .cindex "lock files"
20984 If you are using more than one host to deliver over NFS into the same
20985 mailboxes, you should always use lock files.
20986
20987 The string value is expanded for each delivery, and must yield an absolute
20988 path. The most common settings of this option are variations on one of these
20989 examples:
20990 .code
20991 file = /var/spool/mail/$local_part
20992 file = /home/$local_part/inbox
20993 file = $home/inbox
20994 .endd
20995 .cindex "&""sticky""& bit"
20996 In the first example, all deliveries are done into the same directory. If Exim
20997 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20998 create a file in the directory, so the &"sticky"& bit must be turned on for
20999 deliveries to be possible, or alternatively the &%group%& option can be used to
21000 run the delivery under a group id which has write access to the directory.
21001
21002
21003
21004 .option file_format appendfile string unset
21005 .cindex "file" "mailbox; checking existing format"
21006 This option requests the transport to check the format of an existing file
21007 before adding to it. The check consists of matching a specific string at the
21008 start of the file. The value of the option consists of an even number of
21009 colon-separated strings. The first of each pair is the test string, and the
21010 second is the name of a transport. If the transport associated with a matched
21011 string is not the current transport, control is passed over to the other
21012 transport. For example, suppose the standard &(local_delivery)& transport has
21013 this added to it:
21014 .code
21015 file_format = "From       : local_delivery :\
21016                \1\1\1\1\n : local_mmdf_delivery"
21017 .endd
21018 Mailboxes that begin with &"From"& are still handled by this transport, but if
21019 a mailbox begins with four binary ones followed by a newline, control is passed
21020 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21021 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21022 is assumed to match the current transport. If the start of a mailbox doesn't
21023 match any string, or if the transport named for a given string is not defined,
21024 delivery is deferred.
21025
21026
21027 .option file_must_exist appendfile boolean false
21028 If this option is true, the file specified by the &%file%& option must exist.
21029 A temporary error occurs if it does not, causing delivery to be deferred.
21030 If this option is false, the file is created if it does not exist.
21031
21032
21033 .option lock_fcntl_timeout appendfile time 0s
21034 .cindex "timeout" "mailbox locking"
21035 .cindex "mailbox" "locking, blocking and non-blocking"
21036 .cindex "locking files"
21037 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21038 when locking an open mailbox file. If the call fails, the delivery process
21039 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21040 Non-blocking calls are used so that the file is not kept open during the wait
21041 for the lock; the reason for this is to make it as safe as possible for
21042 deliveries over NFS in the case when processes might be accessing an NFS
21043 mailbox without using a lock file. This should not be done, but
21044 misunderstandings and hence misconfigurations are not unknown.
21045
21046 On a busy system, however, the performance of a non-blocking lock approach is
21047 not as good as using a blocking lock with a timeout. In this case, the waiting
21048 is done inside the system call, and Exim's delivery process acquires the lock
21049 and can proceed as soon as the previous lock holder releases it.
21050
21051 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21052 timeout, are used. There may still be some retrying: the maximum number of
21053 retries is
21054 .code
21055 (lock_retries * lock_interval) / lock_fcntl_timeout
21056 .endd
21057 rounded up to the next whole number. In other words, the total time during
21058 which &(appendfile)& is trying to get a lock is roughly the same, unless
21059 &%lock_fcntl_timeout%& is set very large.
21060
21061 You should consider setting this option if you are getting a lot of delayed
21062 local deliveries because of errors of the form
21063 .code
21064 failed to lock mailbox /some/file (fcntl)
21065 .endd
21066
21067 .option lock_flock_timeout appendfile time 0s
21068 This timeout applies to file locking when using &[flock()]& (see
21069 &%use_flock%&); the timeout operates in a similar manner to
21070 &%lock_fcntl_timeout%&.
21071
21072
21073 .option lock_interval appendfile time 3s
21074 This specifies the time to wait between attempts to lock the file. See below
21075 for details of locking.
21076
21077
21078 .option lock_retries appendfile integer 10
21079 This specifies the maximum number of attempts to lock the file. A value of zero
21080 is treated as 1. See below for details of locking.
21081
21082
21083 .option lockfile_mode appendfile "octal integer" 0600
21084 This specifies the mode of the created lock file, when a lock file is being
21085 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21086
21087
21088 .option lockfile_timeout appendfile time 30m
21089 .cindex "timeout" "mailbox locking"
21090 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21091 exists and is older than this value, it is assumed to have been left behind by
21092 accident, and Exim attempts to remove it.
21093
21094
21095 .option mailbox_filecount appendfile string&!! unset
21096 .cindex "mailbox" "specifying size of"
21097 .cindex "size" "of mailbox"
21098 If this option is set, it is expanded, and the result is taken as the current
21099 number of files in the mailbox. It must be a decimal number, optionally
21100 followed by K or M. This provides a way of obtaining this information from an
21101 external source that maintains the data.
21102
21103
21104 .option mailbox_size appendfile string&!! unset
21105 .cindex "mailbox" "specifying size of"
21106 .cindex "size" "of mailbox"
21107 If this option is set, it is expanded, and the result is taken as the current
21108 size the mailbox. It must be a decimal number, optionally followed by K or M.
21109 This provides a way of obtaining this information from an external source that
21110 maintains the data. This is likely to be helpful for maildir deliveries where
21111 it is computationally expensive to compute the size of a mailbox.
21112
21113
21114
21115 .option maildir_format appendfile boolean false
21116 .cindex "maildir format" "specifying"
21117 If this option is set with the &%directory%& option, the delivery is into a new
21118 file, in the &"maildir"& format that is used by other mail software. When the
21119 transport is activated directly from a &(redirect)& router (for example, the
21120 &(address_file)& transport in the default configuration), setting
21121 &%maildir_format%& causes the path received from the router to be treated as a
21122 directory, whether or not it ends with &`/`&. This option is available only if
21123 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21124 &<<SECTmaildirdelivery>>& below for further details.
21125
21126
21127 .option maildir_quota_directory_regex appendfile string "See below"
21128 .cindex "maildir format" "quota; directories included in"
21129 .cindex "quota" "maildir; directories included in"
21130 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21131 a regular expression for specifying directories, relative to the quota
21132 directory (see &%quota_directory%&), that should be included in the quota
21133 calculation. The default value is:
21134 .code
21135 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21136 .endd
21137 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21138 (directories whose names begin with a dot). If you want to exclude the
21139 &_Trash_&
21140 folder from the count (as some sites do), you need to change this setting to
21141 .code
21142 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21143 .endd
21144 This uses a negative lookahead in the regular expression to exclude the
21145 directory whose name is &_.Trash_&. When a directory is excluded from quota
21146 calculations, quota processing is bypassed for any messages that are delivered
21147 directly into that directory.
21148
21149
21150 .option maildir_retries appendfile integer 10
21151 This option specifies the number of times to retry when writing a file in
21152 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21153
21154
21155 .option maildir_tag appendfile string&!! unset
21156 This option applies only to deliveries in maildir format, and is described in
21157 section &<<SECTmaildirdelivery>>& below.
21158
21159
21160 .option maildir_use_size_file appendfile&!! boolean false
21161 .cindex "maildir format" "&_maildirsize_& file"
21162 The result of string expansion for this option must be a valid boolean value.
21163 If it is true, it enables support for &_maildirsize_& files. Exim
21164 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21165 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21166 value is zero. See &%maildir_quota_directory_regex%& above and section
21167 &<<SECTmaildirdelivery>>& below for further details.
21168
21169 .option maildirfolder_create_regex appendfile string unset
21170 .cindex "maildir format" "&_maildirfolder_& file"
21171 .cindex "&_maildirfolder_&, creating"
21172 The value of this option is a regular expression. If it is unset, it has no
21173 effect. Otherwise, before a maildir delivery takes place, the pattern is
21174 matched against the name of the maildir directory, that is, the directory
21175 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21176 delivery. If there is a match, Exim checks for the existence of a file called
21177 &_maildirfolder_& in the directory, and creates it if it does not exist.
21178 See section &<<SECTmaildirdelivery>>& for more details.
21179
21180
21181 .option mailstore_format appendfile boolean false
21182 .cindex "mailstore format" "specifying"
21183 If this option is set with the &%directory%& option, the delivery is into two
21184 new files in  &"mailstore"& format. The option is available only if
21185 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21186 below for further details.
21187
21188
21189 .option mailstore_prefix appendfile string&!! unset
21190 This option applies only to deliveries in mailstore format, and is described in
21191 section &<<SECTopdir>>& below.
21192
21193
21194 .option mailstore_suffix appendfile string&!! unset
21195 This option applies only to deliveries in mailstore format, and is described in
21196 section &<<SECTopdir>>& below.
21197
21198
21199 .option mbx_format appendfile boolean false
21200 .cindex "locking files"
21201 .cindex "file" "locking"
21202 .cindex "file" "MBX format"
21203 .cindex "MBX format, specifying"
21204 This option is available only if Exim has been compiled with SUPPORT_MBX
21205 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21206 the message is appended to the mailbox file in MBX format instead of
21207 traditional Unix format. This format is supported by Pine4 and its associated
21208 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21209
21210 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21211 automatically changed by the use of &%mbx_format%&. They should normally be set
21212 empty when using MBX format, so this option almost always appears in this
21213 combination:
21214 .code
21215 mbx_format = true
21216 message_prefix =
21217 message_suffix =
21218 .endd
21219 If none of the locking options are mentioned in the configuration,
21220 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21221 is possible to specify the other kinds of locking with &%mbx_format%&, but
21222 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21223 interworks with &'c-client'&, providing for shared access to the mailbox. It
21224 should not be used if any program that does not use this form of locking is
21225 going to access the mailbox, nor should it be used if the mailbox file is NFS
21226 mounted, because it works only when the mailbox is accessed from a single host.
21227
21228 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21229 the standard version of &'c-client'&, because as long as it has a mailbox open
21230 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21231 append messages to it.
21232
21233
21234 .option message_prefix appendfile string&!! "see below"
21235 .cindex "&""From""& line"
21236 The string specified here is expanded and output at the start of every message.
21237 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21238 in which case it is:
21239 .code
21240 message_prefix = "From ${if def:return_path{$return_path}\
21241   {MAILER-DAEMON}} $tod_bsdinbox\n"
21242 .endd
21243 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21244 &`\n`& to &`\r\n`& in &%message_prefix%&.
21245
21246 .option message_suffix appendfile string&!! "see below"
21247 The string specified here is expanded and output at the end of every message.
21248 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21249 in which case it is a single newline character. The suffix can be suppressed by
21250 setting
21251 .code
21252 message_suffix =
21253 .endd
21254 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21255 &`\n`& to &`\r\n`& in &%message_suffix%&.
21256
21257 .option mode appendfile "octal integer" 0600
21258 If the output file is created, it is given this mode. If it already exists and
21259 has wider permissions, they are reduced to this mode. If it has narrower
21260 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21261 if the delivery is the result of a &%save%& command in a filter file specifying
21262 a particular mode, the mode of the output file is always forced to take that
21263 value, and this option is ignored.
21264
21265
21266 .option mode_fail_narrower appendfile boolean true
21267 This option applies in the case when an existing mailbox file has a narrower
21268 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21269 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21270 continues with the delivery attempt, using the existing mode of the file.
21271
21272
21273 .option notify_comsat appendfile boolean false
21274 If this option is true, the &'comsat'& daemon is notified after every
21275 successful delivery to a user mailbox. This is the daemon that notifies logged
21276 on users about incoming mail.
21277
21278
21279 .option quota appendfile string&!! unset
21280 .cindex "quota" "imposed by Exim"
21281 This option imposes a limit on the size of the file to which Exim is appending,
21282 or to the total space used in the directory tree when the &%directory%& option
21283 is set. In the latter case, computation of the space used is expensive, because
21284 all the files in the directory (and any sub-directories) have to be
21285 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21286 &%maildir_use_size_file%& for ways to avoid this in environments where users
21287 have no shell access to their mailboxes).
21288
21289 As there is no interlock against two simultaneous deliveries into a
21290 multi-file mailbox, it is possible for the quota to be overrun in this case.
21291 For single-file mailboxes, of course, an interlock is a necessity.
21292
21293 A file's size is taken as its &'used'& value. Because of blocking effects, this
21294 may be a lot less than the actual amount of disk space allocated to the file.
21295 If the sizes of a number of files are being added up, the rounding effect can
21296 become quite noticeable, especially on systems that have large block sizes.
21297 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21298 the obvious value which users understand most easily.
21299
21300 The value of the option is expanded, and must then be a numerical value
21301 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21302 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21303 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21304 be handled.
21305
21306 &*Note*&: A value of zero is interpreted as &"no quota"&.
21307
21308 The expansion happens while Exim is running as root, before it changes uid for
21309 the delivery. This means that files that are inaccessible to the end user can
21310 be used to hold quota values that are looked up in the expansion. When delivery
21311 fails because this quota is exceeded, the handling of the error is as for
21312 system quota failures.
21313
21314 By default, Exim's quota checking mimics system quotas, and restricts the
21315 mailbox to the specified maximum size, though the value is not accurate to the
21316 last byte, owing to separator lines and additional headers that may get added
21317 during message delivery. When a mailbox is nearly full, large messages may get
21318 refused even though small ones are accepted, because the size of the current
21319 message is added to the quota when the check is made. This behaviour can be
21320 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21321 for exceeding the quota does not include the current message. Thus, deliveries
21322 continue until the quota has been exceeded; thereafter, no further messages are
21323 delivered. See also &%quota_warn_threshold%&.
21324
21325
21326 .option quota_directory appendfile string&!! unset
21327 This option defines the directory to check for quota purposes when delivering
21328 into individual files. The default is the delivery directory, or, if a file
21329 called &_maildirfolder_& exists in a maildir directory, the parent of the
21330 delivery directory.
21331
21332
21333 .option quota_filecount appendfile string&!! 0
21334 This option applies when the &%directory%& option is set. It limits the total
21335 number of files in the directory (compare the inode limit in system quotas). It
21336 can only be used if &%quota%& is also set. The value is expanded; an expansion
21337 failure causes delivery to be deferred. A value of zero is interpreted as
21338 &"no quota"&.
21339
21340
21341 .option quota_is_inclusive appendfile boolean true
21342 See &%quota%& above.
21343
21344
21345 .option quota_size_regex appendfile string unset
21346 This option applies when one of the delivery modes that writes a separate file
21347 for each message is being used. When Exim wants to find the size of one of
21348 these files in order to test the quota, it first checks &%quota_size_regex%&.
21349 If this is set to a regular expression that matches the file name, and it
21350 captures one string, that string is interpreted as a representation of the
21351 file's size. The value of &%quota_size_regex%& is not expanded.
21352
21353 This feature is useful only when users have no shell access to their mailboxes
21354 &-- otherwise they could defeat the quota simply by renaming the files. This
21355 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21356 the file length to the file name. For example:
21357 .code
21358 maildir_tag = ,S=$message_size
21359 quota_size_regex = ,S=(\d+)
21360 .endd
21361 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21362 number of lines in the message.
21363
21364 The regular expression should not assume that the length is at the end of the
21365 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21366 sometimes add other information onto the ends of message file names.
21367
21368 Section &<<SECID136>>& contains further information.
21369
21370
21371 .option quota_warn_message appendfile string&!! "see below"
21372 See below for the use of this option. If it is not set when
21373 &%quota_warn_threshold%& is set, it defaults to
21374 .code
21375 quota_warn_message = "\
21376   To: $local_part@$domain\n\
21377   Subject: Your mailbox\n\n\
21378   This message is automatically created \
21379   by mail delivery software.\n\n\
21380   The size of your mailbox has exceeded \
21381   a warning threshold that is\n\
21382   set by the system administrator.\n"
21383 .endd
21384
21385
21386 .option quota_warn_threshold appendfile string&!! 0
21387 .cindex "quota" "warning threshold"
21388 .cindex "mailbox" "size warning"
21389 .cindex "size" "of mailbox"
21390 This option is expanded in the same way as &%quota%& (see above). If the
21391 resulting value is greater than zero, and delivery of the message causes the
21392 size of the file or total space in the directory tree to cross the given
21393 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21394 may be specified as a percentage of it by following the value with a percent
21395 sign. For example:
21396 .code
21397 quota = 10M
21398 quota_warn_threshold = 75%
21399 .endd
21400 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21401 percent sign is ignored.
21402
21403 The warning message itself is specified by the &%quota_warn_message%& option,
21404 and it must start with a &'To:'& header line containing the recipient(s) of the
21405 warning message. These do not necessarily have to include the recipient(s) of
21406 the original message. A &'Subject:'& line should also normally be supplied. You
21407 can include any other header lines that you want. If you do not include a
21408 &'From:'& line, the default is:
21409 .code
21410 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21411 .endd
21412 .oindex &%errors_reply_to%&
21413 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21414 option.
21415
21416 The &%quota%& option does not have to be set in order to use this option; they
21417 are independent of one another except when the threshold is specified as a
21418 percentage.
21419
21420
21421 .option use_bsmtp appendfile boolean false
21422 .cindex "envelope sender"
21423 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21424 format, with the envelope sender and recipient(s) included as SMTP commands. If
21425 you want to include a leading HELO command with such messages, you can do
21426 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21427 for details of batch SMTP.
21428
21429
21430 .option use_crlf appendfile boolean false
21431 .cindex "carriage return"
21432 .cindex "linefeed"
21433 This option causes lines to be terminated with the two-character CRLF sequence
21434 (carriage return, linefeed) instead of just a linefeed character. In the case
21435 of batched SMTP, the byte sequence written to the file is then an exact image
21436 of what would be sent down a real SMTP connection.
21437
21438 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21439 (which are used to supply the traditional &"From&~"& and blank line separators
21440 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21441 carriage return characters if these are needed. In cases where these options
21442 have non-empty defaults, the values end with a single linefeed, so they must be
21443 changed to end with &`\r\n`& if &%use_crlf%& is set.
21444
21445
21446 .option use_fcntl_lock appendfile boolean "see below"
21447 This option controls the use of the &[fcntl()]& function to lock a file for
21448 exclusive use when a message is being appended. It is set by default unless
21449 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21450 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21451 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21452
21453
21454 .option use_flock_lock appendfile boolean false
21455 This option is provided to support the use of &[flock()]& for file locking, for
21456 the few situations where it is needed. Most modern operating systems support
21457 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21458 each other. Exim uses &[fcntl()]& locking by default.
21459
21460 This option is required only if you are using an operating system where
21461 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21462 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21463 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21464
21465 .cindex "Solaris" "&[flock()]& support"
21466 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21467 have it (and some, I think, provide a not quite right version built on top of
21468 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21469 the ability to use it, and any attempt to do so will cause a configuration
21470 error.
21471
21472 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21473 is just being mapped onto &[fcntl()]& by the OS).
21474
21475
21476 .option use_lockfile appendfile boolean "see below"
21477 If this option is turned off, Exim does not attempt to create a lock file when
21478 appending to a mailbox file. In this situation, the only locking is by
21479 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21480 sure that every MUA that is ever going to look at your users' mailboxes uses
21481 &[fcntl()]& rather than a lock file, and even then only when you are not
21482 delivering over NFS from more than one host.
21483
21484 .cindex "NFS" "lock file"
21485 In order to append to an NFS file safely from more than one host, it is
21486 necessary to take out a lock &'before'& opening the file, and the lock file
21487 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21488 file corruption.
21489
21490 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21491 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21492 except when &%mbx_format%& is set.
21493
21494
21495 .option use_mbx_lock appendfile boolean "see below"
21496 This option is available only if Exim has been compiled with SUPPORT_MBX
21497 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21498 locking rules be used. It is set by default if &%mbx_format%& is set and none
21499 of the locking options are mentioned in the configuration. The locking rules
21500 are the same as are used by the &'c-client'& library that underlies Pine and
21501 the IMAP4 and POP daemons that come with it (see the discussion below). The
21502 rules allow for shared access to the mailbox. However, this kind of locking
21503 does not work when the mailbox is NFS mounted.
21504
21505 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21506 &%use_flock_lock%& to control what kind of locking is used in implementing the
21507 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21508 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21509
21510
21511
21512
21513 .section "Operational details for appending" "SECTopappend"
21514 .cindex "appending to a file"
21515 .cindex "file" "appending"
21516 Before appending to a file, the following preparations are made:
21517
21518 .ilist
21519 If the name of the file is &_/dev/null_&, no action is taken, and a success
21520 return is given.
21521
21522 .next
21523 .cindex "directory creation"
21524 If any directories on the file's path are missing, Exim creates them if the
21525 &%create_directory%& option is set. A created directory's mode is given by the
21526 &%directory_mode%& option.
21527
21528 .next
21529 If &%file_format%& is set, the format of an existing file is checked. If this
21530 indicates that a different transport should be used, control is passed to that
21531 transport.
21532
21533 .next
21534 .cindex "file" "locking"
21535 .cindex "locking files"
21536 .cindex "NFS" "lock file"
21537 If &%use_lockfile%& is set, a lock file is built in a way that will work
21538 reliably over NFS, as follows:
21539
21540 .olist
21541 Create a &"hitching post"& file whose name is that of the lock file with the
21542 current time, primary host name, and process id added, by opening for writing
21543 as a new file. If this fails with an access error, delivery is deferred.
21544 .next
21545 Close the hitching post file, and hard link it to the lock file name.
21546 .next
21547 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21548 Unlink the hitching post name.
21549 .next
21550 Otherwise, use &[stat()]& to get information about the hitching post file, and
21551 then unlink hitching post name. If the number of links is exactly two, creation
21552 of the lock file succeeded but something (for example, an NFS server crash and
21553 restart) caused this fact not to be communicated to the &[link()]& call.
21554 .next
21555 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21556 up to &%lock_retries%& times. However, since any program that writes to a
21557 mailbox should complete its task very quickly, it is reasonable to time out old
21558 lock files that are normally the result of user agent and system crashes. If an
21559 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21560 it before trying again.
21561 .endlist olist
21562
21563 .next
21564 A call is made to &[lstat()]& to discover whether the main file exists, and if
21565 so, what its characteristics are. If &[lstat()]& fails for any reason other
21566 than non-existence, delivery is deferred.
21567
21568 .next
21569 .cindex "symbolic link" "to mailbox"
21570 .cindex "mailbox" "symbolic link"
21571 If the file does exist and is a symbolic link, delivery is deferred, unless the
21572 &%allow_symlink%& option is set, in which case the ownership of the link is
21573 checked, and then &[stat()]& is called to find out about the real file, which
21574 is then subjected to the checks below. The check on the top-level link
21575 ownership prevents one user creating a link for another's mailbox in a sticky
21576 directory, though allowing symbolic links in this case is definitely not a good
21577 idea. If there is a chain of symbolic links, the intermediate ones are not
21578 checked.
21579
21580 .next
21581 If the file already exists but is not a regular file, or if the file's owner
21582 and group (if the group is being checked &-- see &%check_group%& above) are
21583 different from the user and group under which the delivery is running,
21584 delivery is deferred.
21585
21586 .next
21587 If the file's permissions are more generous than specified, they are reduced.
21588 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21589 is set false, in which case the delivery is tried using the existing
21590 permissions.
21591
21592 .next
21593 The file's inode number is saved, and the file is then opened for appending.
21594 If this fails because the file has vanished, &(appendfile)& behaves as if it
21595 hadn't existed (see below). For any other failures, delivery is deferred.
21596
21597 .next
21598 If the file is opened successfully, check that the inode number hasn't
21599 changed, that it is still a regular file, and that the owner and permissions
21600 have not changed. If anything is wrong, defer delivery and freeze the message.
21601
21602 .next
21603 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21604 option is set. Otherwise, check that the file is being created in a permitted
21605 directory if the &%create_file%& option is set (deferring on failure), and then
21606 open for writing as a new file, with the O_EXCL and O_CREAT options,
21607 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21608 set). In this case, which can happen if the link points to a non-existent file,
21609 the file is opened for writing using O_CREAT but not O_EXCL, because
21610 that prevents link following.
21611
21612 .next
21613 .cindex "loop" "while file testing"
21614 If opening fails because the file exists, obey the tests given above for
21615 existing files. However, to avoid looping in a situation where the file is
21616 being continuously created and destroyed, the exists/not-exists loop is broken
21617 after 10 repetitions, and the message is then frozen.
21618
21619 .next
21620 If opening fails with any other error, defer delivery.
21621
21622 .next
21623 .cindex "file" "locking"
21624 .cindex "locking files"
21625 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21626 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21627 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21628 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21629 file, and an exclusive lock on the file whose name is
21630 .code
21631 /tmp/.<device-number>.<inode-number>
21632 .endd
21633 using the device and inode numbers of the open mailbox file, in accordance with
21634 the MBX locking rules. This file is created with a mode that is specified by
21635 the &%lockfile_mode%& option.
21636
21637 If Exim fails to lock the file, there are two possible courses of action,
21638 depending on the value of the locking timeout. This is obtained from
21639 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21640
21641 If the timeout value is zero, the file is closed, Exim waits for
21642 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21643 to lock it again. This happens up to &%lock_retries%& times, after which the
21644 delivery is deferred.
21645
21646 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21647 &[flock()]& are used (with the given timeout), so there has already been some
21648 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21649 immediately. It retries up to
21650 .code
21651 (lock_retries * lock_interval) / <timeout>
21652 .endd
21653 times (rounded up).
21654 .endlist
21655
21656 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21657 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21658
21659
21660 .section "Operational details for delivery to a new file" "SECTopdir"
21661 .cindex "delivery" "to single file"
21662 .cindex "&""From""& line"
21663 When the &%directory%& option is set instead of &%file%&, each message is
21664 delivered into a newly-created file or set of files. When &(appendfile)& is
21665 activated directly from a &(redirect)& router, neither &%file%& nor
21666 &%directory%& is normally set, because the path for delivery is supplied by the
21667 router. (See for example, the &(address_file)& transport in the default
21668 configuration.) In this case, delivery is to a new file if either the path name
21669 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21670
21671 No locking is required while writing the message to a new file, so the various
21672 locking options of the transport are ignored. The &"From"& line that by default
21673 separates messages in a single file is not normally needed, nor is the escaping
21674 of message lines that start with &"From"&, and there is no need to ensure a
21675 newline at the end of each message. Consequently, the default values for
21676 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21677 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21678
21679 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21680 the files in the delivery directory by default. However, you can specify a
21681 different directory by setting &%quota_directory%&. Also, for maildir
21682 deliveries (see below) the &_maildirfolder_& convention is honoured.
21683
21684
21685 .cindex "maildir format"
21686 .cindex "mailstore format"
21687 There are three different ways in which delivery to individual files can be
21688 done, controlled by the settings of the &%maildir_format%& and
21689 &%mailstore_format%& options. Note that code to support maildir or mailstore
21690 formats is not included in the binary unless SUPPORT_MAILDIR or
21691 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21692
21693 .cindex "directory creation"
21694 In all three cases an attempt is made to create the directory and any necessary
21695 sub-directories if they do not exist, provided that the &%create_directory%&
21696 option is set (the default). The location of a created directory can be
21697 constrained by setting &%create_file%&. A created directory's mode is given by
21698 the &%directory_mode%& option. If creation fails, or if the
21699 &%create_directory%& option is not set when creation is required, delivery is
21700 deferred.
21701
21702
21703
21704 .section "Maildir delivery" "SECTmaildirdelivery"
21705 .cindex "maildir format" "description of"
21706 If the &%maildir_format%& option is true, Exim delivers each message by writing
21707 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21708 directory that is defined by the &%directory%& option (the &"delivery
21709 directory"&). If the delivery is successful, the file is renamed into the
21710 &_new_& subdirectory.
21711
21712 In the file name, <&'stime'&> is the current time of day in seconds, and
21713 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21714 Exim checks that the time-of-day clock has moved on by at least one microsecond
21715 before terminating the delivery process. This guarantees uniqueness for the
21716 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21717 opening it. If any response other than ENOENT (does not exist) is given,
21718 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21719
21720 Before Exim carries out a maildir delivery, it ensures that subdirectories
21721 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21722 do not exist, Exim tries to create them and any superior directories in their
21723 path, subject to the &%create_directory%& and &%create_file%& options. If the
21724 &%maildirfolder_create_regex%& option is set, and the regular expression it
21725 contains matches the delivery directory, Exim also ensures that a file called
21726 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21727 &_maildirfolder_& file cannot be created, delivery is deferred.
21728
21729 These features make it possible to use Exim to create all the necessary files
21730 and directories in a maildir mailbox, including subdirectories for maildir++
21731 folders. Consider this example:
21732 .code
21733 maildir_format = true
21734 directory = /var/mail/$local_part\
21735            ${if eq{$local_part_suffix}{}{}\
21736            {/.${substr_1:$local_part_suffix}}}
21737 maildirfolder_create_regex = /\.[^/]+$
21738 .endd
21739 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21740 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21741 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21742 not match this name, so Exim will not look for or create the file
21743 &_/var/mail/pimbo/maildirfolder_&, though it will create
21744 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21745
21746 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21747 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21748 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21749 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21750 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21751
21752 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21753 not inadvertently match the toplevel maildir directory, because a
21754 &_maildirfolder_& file at top level would completely break quota calculations.
21755
21756 .cindex "quota" "in maildir delivery"
21757 .cindex "maildir++"
21758 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21759 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21760 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21761 Exim assumes the directory is a maildir++ folder directory, which is one level
21762 down from the user's top level mailbox directory. This causes it to start at
21763 the parent directory instead of the current directory when calculating the
21764 amount of space used.
21765
21766 One problem with delivering into a multi-file mailbox is that it is
21767 computationally expensive to compute the size of the mailbox for quota
21768 checking. Various approaches have been taken to reduce the amount of work
21769 needed. The next two sections describe two of them. A third alternative is to
21770 use some external process for maintaining the size data, and use the expansion
21771 of the &%mailbox_size%& option as a way of importing it into Exim.
21772
21773
21774
21775
21776 .section "Using tags to record message sizes" "SECID135"
21777 If &%maildir_tag%& is set, the string is expanded for each delivery.
21778 When the maildir file is renamed into the &_new_& sub-directory, the
21779 tag is added to its name. However, if adding the tag takes the length of the
21780 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21781 the tag is dropped and the maildir file is created with no tag.
21782
21783
21784 .vindex "&$message_size$&"
21785 Tags can be used to encode the size of files in their names; see
21786 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21787 happens after the message has been written. The value of the &$message_size$&
21788 variable is set to the number of bytes actually written. If the expansion is
21789 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21790 be deferred. The expanded tag may contain any printing characters except &"/"&.
21791 Non-printing characters in the string are ignored; if the resulting string is
21792 empty, it is ignored. If it starts with an alphanumeric character, a leading
21793 colon is inserted; this default has not proven to be the path that popular
21794 maildir implementations have chosen (but changing it in Exim would break
21795 backwards compatibility).
21796
21797 For one common implementation, you might set:
21798 .code
21799 maildir_tag = ,S=${message_size}
21800 .endd
21801 but you should check the documentation of the other software to be sure.
21802
21803 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21804 as this allows Exim to extract the size from your tag, instead of having to
21805 &[stat()]& each message file.
21806
21807
21808 .section "Using a maildirsize file" "SECID136"
21809 .cindex "quota" "in maildir delivery"
21810 .cindex "maildir format" "&_maildirsize_& file"
21811 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21812 storing quota and message size information in a file called &_maildirsize_&
21813 within the toplevel maildir directory. If this file does not exist, Exim
21814 creates it, setting the quota from the &%quota%& option of the transport. If
21815 the maildir directory itself does not exist, it is created before any attempt
21816 to write a &_maildirsize_& file.
21817
21818 The &_maildirsize_& file is used to hold information about the sizes of
21819 messages in the maildir, thus speeding up quota calculations. The quota value
21820 in the file is just a cache; if the quota is changed in the transport, the new
21821 value overrides the cached value when the next message is delivered. The cache
21822 is maintained for the benefit of other programs that access the maildir and
21823 need to know the quota.
21824
21825 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21826 file is maintained (with a zero quota setting), but no quota is imposed.
21827
21828 A regular expression is available for controlling which directories in the
21829 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21830 See the description of the &%maildir_quota_directory_regex%& option above for
21831 details.
21832
21833
21834 .section "Mailstore delivery" "SECID137"
21835 .cindex "mailstore format" "description of"
21836 If the &%mailstore_format%& option is true, each message is written as two
21837 files in the given directory. A unique base name is constructed from the
21838 message id and the current delivery process, and the files that are written use
21839 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21840 contains the message's envelope, and the &_.msg_& file contains the message
21841 itself. The base name is placed in the variable &$mailstore_basename$&.
21842
21843 During delivery, the envelope is first written to a file with the suffix
21844 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21845 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21846 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21847 file before accessing either of them. An alternative approach is to wait for
21848 the absence of a &_.tmp_& file.
21849
21850 The envelope file starts with any text defined by the &%mailstore_prefix%&
21851 option, expanded and terminated by a newline if there isn't one. Then follows
21852 the sender address on one line, then all the recipient addresses, one per line.
21853 There can be more than one recipient only if the &%batch_max%& option is set
21854 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21855 appended to the file, followed by a newline if it does not end with one.
21856
21857 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21858 failure, it is ignored. Other expansion errors are treated as serious
21859 configuration errors, and delivery is deferred. The variable
21860 &$mailstore_basename$& is available for use during these expansions.
21861
21862
21863 .section "Non-special new file delivery" "SECID138"
21864 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21865 file is created directly in the named directory. For example, when delivering
21866 messages into files in batched SMTP format for later delivery to some host (see
21867 section &<<SECTbatchSMTP>>&), a setting such as
21868 .code
21869 directory = /var/bsmtp/$host
21870 .endd
21871 might be used. A message is written to a file with a temporary name, which is
21872 then renamed when the delivery is complete. The final name is obtained by
21873 expanding the contents of the &%directory_file%& option.
21874 .ecindex IIDapptra1
21875 .ecindex IIDapptra2
21876
21877
21878
21879
21880
21881
21882 . ////////////////////////////////////////////////////////////////////////////
21883 . ////////////////////////////////////////////////////////////////////////////
21884
21885 .chapter "The autoreply transport" "CHID8"
21886 .scindex IIDauttra1 "transports" "&(autoreply)&"
21887 .scindex IIDauttra2 "&(autoreply)& transport"
21888 The &(autoreply)& transport is not a true transport in that it does not cause
21889 the message to be transmitted. Instead, it generates a new mail message as an
21890 automatic reply to the incoming message. &'References:'& and
21891 &'Auto-Submitted:'& header lines are included. These are constructed according
21892 to the rules in RFCs 2822 and 3834, respectively.
21893
21894 If the router that passes the message to this transport does not have the
21895 &%unseen%& option set, the original message (for the current recipient) is not
21896 delivered anywhere. However, when the &%unseen%& option is set on the router
21897 that passes the message to this transport, routing of the address continues, so
21898 another router can set up a normal message delivery.
21899
21900
21901 The &(autoreply)& transport is usually run as the result of mail filtering, a
21902 &"vacation"& message being the standard example. However, it can also be run
21903 directly from a router like any other transport. To reduce the possibility of
21904 message cascades, messages created by the &(autoreply)& transport always have
21905 empty envelope sender addresses, like bounce messages.
21906
21907 The parameters of the message to be sent can be specified in the configuration
21908 by options described below. However, these are used only when the address
21909 passed to the transport does not contain its own reply information. When the
21910 transport is run as a consequence of a
21911 &%mail%&
21912 or &%vacation%& command in a filter file, the parameters of the message are
21913 supplied by the filter, and passed with the address. The transport's options
21914 that define the message are then ignored (so they are not usually set in this
21915 case). The message is specified entirely by the filter or by the transport; it
21916 is never built from a mixture of options. However, the &%file_optional%&,
21917 &%mode%&, and &%return_message%& options apply in all cases.
21918
21919 &(Autoreply)& is implemented as a local transport. When used as a result of a
21920 command in a user's filter file, &(autoreply)& normally runs under the uid and
21921 gid of the user, and with appropriate current and home directories (see chapter
21922 &<<CHAPenvironment>>&).
21923
21924 There is a subtle difference between routing a message to a &(pipe)& transport
21925 that generates some text to be returned to the sender, and routing it to an
21926 &(autoreply)& transport. This difference is noticeable only if more than one
21927 address from the same message is so handled. In the case of a pipe, the
21928 separate outputs from the different addresses are gathered up and returned to
21929 the sender in a single message, whereas if &(autoreply)& is used, a separate
21930 message is generated for each address that is passed to it.
21931
21932 Non-printing characters are not permitted in the header lines generated for the
21933 message that &(autoreply)& creates, with the exception of newlines that are
21934 immediately followed by white space. If any non-printing characters are found,
21935 the transport defers.
21936 Whether characters with the top bit set count as printing characters or not is
21937 controlled by the &%print_topbitchars%& global option.
21938
21939 If any of the generic options for manipulating headers (for example,
21940 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21941 of the original message that is included in the generated message when
21942 &%return_message%& is set. They do not apply to the generated message itself.
21943
21944 .vindex "&$sender_address$&"
21945 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21946 the message, indicating that there were no recipients, it does not treat this
21947 as an error. This means that autoreplies sent to &$sender_address$& when this
21948 is empty (because the incoming message is a bounce message) do not cause
21949 problems. They are just discarded.
21950
21951
21952
21953 .section "Private options for autoreply" "SECID139"
21954 .cindex "options" "&(autoreply)& transport"
21955
21956 .option bcc autoreply string&!! unset
21957 This specifies the addresses that are to receive &"blind carbon copies"& of the
21958 message when the message is specified by the transport.
21959
21960
21961 .option cc autoreply string&!! unset
21962 This specifies recipients of the message and the contents of the &'Cc:'& header
21963 when the message is specified by the transport.
21964
21965
21966 .option file autoreply string&!! unset
21967 The contents of the file are sent as the body of the message when the message
21968 is specified by the transport. If both &%file%& and &%text%& are set, the text
21969 string comes first.
21970
21971
21972 .option file_expand autoreply boolean false
21973 If this is set, the contents of the file named by the &%file%& option are
21974 subjected to string expansion as they are added to the message.
21975
21976
21977 .option file_optional autoreply boolean false
21978 If this option is true, no error is generated if the file named by the &%file%&
21979 option or passed with the address does not exist or cannot be read.
21980
21981
21982 .option from autoreply string&!! unset
21983 This specifies the contents of the &'From:'& header when the message is
21984 specified by the transport.
21985
21986
21987 .option headers autoreply string&!! unset
21988 This specifies additional RFC 2822 headers that are to be added to the message
21989 when the message is specified by the transport. Several can be given by using
21990 &"\n"& to separate them. There is no check on the format.
21991
21992
21993 .option log autoreply string&!! unset
21994 This option names a file in which a record of every message sent is logged when
21995 the message is specified by the transport.
21996
21997
21998 .option mode autoreply "octal integer" 0600
21999 If either the log file or the &"once"& file has to be created, this mode is
22000 used.
22001
22002
22003 .option never_mail autoreply "address list&!!" unset
22004 If any run of the transport creates a message with a recipient that matches any
22005 item in the list, that recipient is quietly discarded. If all recipients are
22006 discarded, no message is created. This applies both when the recipients are
22007 generated by a filter and when they are specified in the transport.
22008
22009
22010
22011 .option once autoreply string&!! unset
22012 This option names a file or DBM database in which a record of each &'To:'&
22013 recipient is kept when the message is specified by the transport. &*Note*&:
22014 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22015
22016 If &%once%& is unset, or is set to an empty string, the message is always sent.
22017 By default, if &%once%& is set to a non-empty file name, the message
22018 is not sent if a potential recipient is already listed in the database.
22019 However, if the &%once_repeat%& option specifies a time greater than zero, the
22020 message is sent if that much time has elapsed since a message was last sent to
22021 this recipient. A setting of zero time for &%once_repeat%& (the default)
22022 prevents a message from being sent a second time &-- in this case, zero means
22023 infinity.
22024
22025 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22026 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22027 greater than zero, it changes the way Exim implements the &%once%& option.
22028 Instead of using a DBM file to record every recipient it sends to, it uses a
22029 regular file, whose size will never get larger than the given value.
22030
22031 In the file, Exim keeps a linear list of recipient addresses and the times at
22032 which they were sent messages. If the file is full when a new address needs to
22033 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22034 means that a given recipient may receive multiple messages, but at
22035 unpredictable intervals that depend on the rate of turnover of addresses in the
22036 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22037
22038
22039 .option once_file_size autoreply integer 0
22040 See &%once%& above.
22041
22042
22043 .option once_repeat autoreply time&!! 0s
22044 See &%once%& above.
22045 After expansion, the value of this option must be a valid time value.
22046
22047
22048 .option reply_to autoreply string&!! unset
22049 This specifies the contents of the &'Reply-To:'& header when the message is
22050 specified by the transport.
22051
22052
22053 .option return_message autoreply boolean false
22054 If this is set, a copy of the original message is returned with the new
22055 message, subject to the maximum size set in the &%return_size_limit%& global
22056 configuration option.
22057
22058
22059 .option subject autoreply string&!! unset
22060 This specifies the contents of the &'Subject:'& header when the message is
22061 specified by the transport. It is tempting to quote the original subject in
22062 automatic responses. For example:
22063 .code
22064 subject = Re: $h_subject:
22065 .endd
22066 There is a danger in doing this, however. It may allow a third party to
22067 subscribe your users to an opt-in mailing list, provided that the list accepts
22068 bounce messages as subscription confirmations. Well-managed lists require a
22069 non-bounce message to confirm a subscription, so the danger is relatively
22070 small.
22071
22072
22073
22074 .option text autoreply string&!! unset
22075 This specifies a single string to be used as the body of the message when the
22076 message is specified by the transport. If both &%text%& and &%file%& are set,
22077 the text comes first.
22078
22079
22080 .option to autoreply string&!! unset
22081 This specifies recipients of the message and the contents of the &'To:'& header
22082 when the message is specified by the transport.
22083 .ecindex IIDauttra1
22084 .ecindex IIDauttra2
22085
22086
22087
22088
22089 . ////////////////////////////////////////////////////////////////////////////
22090 . ////////////////////////////////////////////////////////////////////////////
22091
22092 .chapter "The lmtp transport" "CHAPLMTP"
22093 .cindex "transports" "&(lmtp)&"
22094 .cindex "&(lmtp)& transport"
22095 .cindex "LMTP" "over a pipe"
22096 .cindex "LMTP" "over a socket"
22097 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22098 specified command
22099 or by interacting with a Unix domain socket.
22100 This transport is something of a cross between the &(pipe)& and &(smtp)&
22101 transports. Exim also has support for using LMTP over TCP/IP; this is
22102 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22103 to be of minority interest, the default build-time configure in &_src/EDITME_&
22104 has it commented out. You need to ensure that
22105 .code
22106 TRANSPORT_LMTP=yes
22107 .endd
22108 .cindex "options" "&(lmtp)& transport"
22109 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22110 included in the Exim binary. The private options of the &(lmtp)& transport are
22111 as follows:
22112
22113 .option batch_id lmtp string&!! unset
22114 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22115
22116
22117 .option batch_max lmtp integer 1
22118 This limits the number of addresses that can be handled in a single delivery.
22119 Most LMTP servers can handle several addresses at once, so it is normally a
22120 good idea to increase this value. See the description of local delivery
22121 batching in chapter &<<CHAPbatching>>&.
22122
22123
22124 .option command lmtp string&!! unset
22125 This option must be set if &%socket%& is not set. The string is a command which
22126 is run in a separate process. It is split up into a command name and list of
22127 arguments, each of which is separately expanded (so expansion cannot change the
22128 number of arguments). The command is run directly, not via a shell. The message
22129 is passed to the new process using the standard input and output to operate the
22130 LMTP protocol.
22131
22132 .option ignore_quota lmtp boolean false
22133 .cindex "LMTP" "ignoring quota errors"
22134 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22135 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22136 in its response to the LHLO command.
22137
22138 .option socket lmtp string&!! unset
22139 This option must be set if &%command%& is not set. The result of expansion must
22140 be the name of a Unix domain socket. The transport connects to the socket and
22141 delivers the message to it using the LMTP protocol.
22142
22143
22144 .option timeout lmtp time 5m
22145 The transport is aborted if the created process or Unix domain socket does not
22146 respond to LMTP commands or message input within this timeout. Delivery
22147 is deferred, and will be tried again later. Here is an example of a typical
22148 LMTP transport:
22149 .code
22150 lmtp:
22151   driver = lmtp
22152   command = /some/local/lmtp/delivery/program
22153   batch_max = 20
22154   user = exim
22155 .endd
22156 This delivers up to 20 addresses at a time, in a mixture of domains if
22157 necessary, running as the user &'exim'&.
22158
22159
22160
22161 . ////////////////////////////////////////////////////////////////////////////
22162 . ////////////////////////////////////////////////////////////////////////////
22163
22164 .chapter "The pipe transport" "CHAPpipetransport"
22165 .scindex IIDpiptra1 "transports" "&(pipe)&"
22166 .scindex IIDpiptra2 "&(pipe)& transport"
22167 The &(pipe)& transport is used to deliver messages via a pipe to a command
22168 running in another process. One example is the use of &(pipe)& as a
22169 pseudo-remote transport for passing messages to some other delivery mechanism
22170 (such as UUCP). Another is the use by individual users to automatically process
22171 their incoming messages. The &(pipe)& transport can be used in one of the
22172 following ways:
22173
22174 .ilist
22175 .vindex "&$local_part$&"
22176 A router routes one address to a transport in the normal way, and the
22177 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22178 contains the local part of the address (as usual), and the command that is run
22179 is specified by the &%command%& option on the transport.
22180 .next
22181 .vindex "&$pipe_addresses$&"
22182 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22183 transport can handle more than one address in a single run. In this case, when
22184 more than one address is routed to the transport, &$local_part$& is not set
22185 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22186 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22187 that are routed to the transport.
22188 .next
22189 .vindex "&$address_pipe$&"
22190 A router redirects an address directly to a pipe command (for example, from an
22191 alias or forward file). In this case, &$address_pipe$& contains the text of the
22192 pipe command, and the &%command%& option on the transport is ignored unless
22193 &%force_command%& is set. If only one address is being transported
22194 (&%batch_max%& is not greater than one, or only one address was redirected to
22195 this pipe command), &$local_part$& contains the local part that was redirected.
22196 .endlist
22197
22198
22199 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22200 deliver messages over pipes using the LMTP interactive protocol. This is
22201 implemented by the &(lmtp)& transport.
22202
22203 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22204 &_.forward_& file, the command runs under the uid and gid of that user. In
22205 other cases, the uid and gid have to be specified explicitly, either on the
22206 transport or on the router that handles the address. Current and &"home"&
22207 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22208 details of the local delivery environment and chapter &<<CHAPbatching>>&
22209 for a discussion of local delivery batching.
22210
22211
22212 .section "Concurrent delivery" "SECID140"
22213 If two messages arrive at almost the same time, and both are routed to a pipe
22214 delivery, the two pipe transports may be run concurrently. You must ensure that
22215 any pipe commands you set up are robust against this happening. If the commands
22216 write to a file, the &%exim_lock%& utility might be of use.
22217
22218
22219
22220
22221 .section "Returned status and data" "SECID141"
22222 .cindex "&(pipe)& transport" "returned data"
22223 If the command exits with a non-zero return code, the delivery is deemed to
22224 have failed, unless either the &%ignore_status%& option is set (in which case
22225 the return code is treated as zero), or the return code is one of those listed
22226 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22227 later"&. In this case, delivery is deferred. Details of a permanent failure are
22228 logged, but are not included in the bounce message, which merely contains
22229 &"local delivery failed"&.
22230
22231 If the command exits on a signal and the &%freeze_signal%& option is set then
22232 the message will be frozen in the queue. If that option is not set, a bounce
22233 will be sent as normal.
22234
22235 If the return code is greater than 128 and the command being run is a shell
22236 script, it normally means that the script was terminated by a signal whose
22237 value is the return code minus 128. The &%freeze_signal%& option does not
22238 apply in this case.
22239
22240 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22241 return code is set to 127. This is the value that a shell returns if it is
22242 asked to run a non-existent command. The wording for the log line suggests that
22243 a non-existent command may be the problem.
22244
22245 The &%return_output%& option can affect the result of a pipe delivery. If it is
22246 set and the command produces any output on its standard output or standard
22247 error streams, the command is considered to have failed, even if it gave a zero
22248 return code or if &%ignore_status%& is set. The output from the command is
22249 included as part of the bounce message. The &%return_fail_output%& option is
22250 similar, except that output is returned only when the command exits with a
22251 failure return code, that is, a value other than zero or a code that matches
22252 &%temp_errors%&.
22253
22254
22255
22256 .section "How the command is run" "SECThowcommandrun"
22257 .cindex "&(pipe)& transport" "path for command"
22258 The command line is (by default) broken down into a command name and arguments
22259 by the &(pipe)& transport itself. The &%allow_commands%& and
22260 &%restrict_to_path%& options can be used to restrict the commands that may be
22261 run.
22262
22263 .cindex "quoting" "in pipe command"
22264 Unquoted arguments are delimited by white space. If an argument appears in
22265 double quotes, backslash is interpreted as an escape character in the usual
22266 way. If an argument appears in single quotes, no escaping is done.
22267
22268 String expansion is applied to the command line except when it comes from a
22269 traditional &_.forward_& file (commands from a filter file are expanded). The
22270 expansion is applied to each argument in turn rather than to the whole line.
22271 For this reason, any string expansion item that contains white space must be
22272 quoted so as to be contained within a single argument. A setting such as
22273 .code
22274 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22275 .endd
22276 will not work, because the expansion item gets split between several
22277 arguments. You have to write
22278 .code
22279 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22280 .endd
22281 to ensure that it is all in one argument. The expansion is done in this way,
22282 argument by argument, so that the number of arguments cannot be changed as a
22283 result of expansion, and quotes or backslashes in inserted variables do not
22284 interact with external quoting. However, this leads to problems if you want to
22285 generate multiple arguments (or the command name plus arguments) from a single
22286 expansion. In this situation, the simplest solution is to use a shell. For
22287 example:
22288 .code
22289 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22290 .endd
22291
22292 .cindex "transport" "filter"
22293 .cindex "filter" "transport filter"
22294 .vindex "&$pipe_addresses$&"
22295 Special handling takes place when an argument consists of precisely the text
22296 &`$pipe_addresses`&. This is not a general expansion variable; the only
22297 place this string is recognized is when it appears as an argument for a pipe or
22298 transport filter command. It causes each address that is being handled to be
22299 inserted in the argument list at that point &'as a separate argument'&. This
22300 avoids any problems with spaces or shell metacharacters, and is of use when a
22301 &(pipe)& transport is handling groups of addresses in a batch.
22302
22303 If &%force_command%& is enabled on the transport, Special handling takes place
22304 for an argument that consists of precisely the text &`$address_pipe`&.  It
22305 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22306 argument is inserted in the argument list at that point
22307 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22308 the only item in the argument; in fact, if it were then &%force_command%&
22309 should behave as a no-op.  Rather, it should be used to adjust the command
22310 run while preserving the argument vector separation.
22311
22312 After splitting up into arguments and expansion, the resulting command is run
22313 in a subprocess directly from the transport, &'not'& under a shell. The
22314 message that is being delivered is supplied on the standard input, and the
22315 standard output and standard error are both connected to a single pipe that is
22316 read by Exim. The &%max_output%& option controls how much output the command
22317 may produce, and the &%return_output%& and &%return_fail_output%& options
22318 control what is done with it.
22319
22320 Not running the command under a shell (by default) lessens the security risks
22321 in cases when a command from a user's filter file is built out of data that was
22322 taken from an incoming message. If a shell is required, it can of course be
22323 explicitly specified as the command to be run. However, there are circumstances
22324 where existing commands (for example, in &_.forward_& files) expect to be run
22325 under a shell and cannot easily be modified. To allow for these cases, there is
22326 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22327 works. Instead of breaking up the command line as just described, it expands it
22328 as a single string and passes the result to &_/bin/sh_&. The
22329 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22330 with &%use_shell%&, and the whole mechanism is inherently less secure.
22331
22332
22333
22334 .section "Environment variables" "SECTpipeenv"
22335 .cindex "&(pipe)& transport" "environment for command"
22336 .cindex "environment for pipe transport"
22337 The environment variables listed below are set up when the command is invoked.
22338 This list is a compromise for maximum compatibility with other MTAs. Note that
22339 the &%environment%& option can be used to add additional variables to this
22340 environment.
22341 .display
22342 &`DOMAIN            `&   the domain of the address
22343 &`HOME              `&   the home directory, if set
22344 &`HOST              `&   the host name when called from a router (see below)
22345 &`LOCAL_PART        `&   see below
22346 &`LOCAL_PART_PREFIX `&   see below
22347 &`LOCAL_PART_SUFFIX `&   see below
22348 &`LOGNAME           `&   see below
22349 &`MESSAGE_ID        `&   Exim's local ID for the message
22350 &`PATH              `&   as specified by the &%path%& option below
22351 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22352 &`RECIPIENT         `&   the complete recipient address
22353 &`SENDER            `&   the sender of the message (empty if a bounce)
22354 &`SHELL             `&   &`/bin/sh`&
22355 &`TZ                `&   the value of the &%timezone%& option, if set
22356 &`USER              `&   see below
22357 .endd
22358 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22359 router, LOCAL_PART is set to the local part of the address. When it is
22360 called as a result of a forward or alias expansion, LOCAL_PART is set to
22361 the local part of the address that was expanded. In both cases, any affixes are
22362 removed from the local part, and made available in LOCAL_PART_PREFIX and
22363 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22364 same value as LOCAL_PART for compatibility with other MTAs.
22365
22366 .cindex "HOST"
22367 HOST is set only when a &(pipe)& transport is called from a router that
22368 associates hosts with an address, typically when using &(pipe)& as a
22369 pseudo-remote transport. HOST is set to the first host name specified by
22370 the router.
22371
22372 .cindex "HOME"
22373 If the transport's generic &%home_directory%& option is set, its value is used
22374 for the HOME environment variable. Otherwise, a home directory may be set
22375 by the router's &%transport_home_directory%& option, which defaults to the
22376 user's home directory if &%check_local_user%& is set.
22377
22378
22379 .section "Private options for pipe" "SECID142"
22380 .cindex "options" "&(pipe)& transport"
22381
22382
22383
22384 .option allow_commands pipe "string list&!!" unset
22385 .cindex "&(pipe)& transport" "permitted commands"
22386 The string is expanded, and is then interpreted as a colon-separated list of
22387 permitted commands. If &%restrict_to_path%& is not set, the only commands
22388 permitted are those in the &%allow_commands%& list. They need not be absolute
22389 paths; the &%path%& option is still used for relative paths. If
22390 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22391 in the &%allow_commands%& list, or a name without any slashes that is found on
22392 the path. In other words, if neither &%allow_commands%& nor
22393 &%restrict_to_path%& is set, there is no restriction on the command, but
22394 otherwise only commands that are permitted by one or the other are allowed. For
22395 example, if
22396 .code
22397 allow_commands = /usr/bin/vacation
22398 .endd
22399 and &%restrict_to_path%& is not set, the only permitted command is
22400 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22401 &%use_shell%& is set.
22402
22403
22404 .option batch_id pipe string&!! unset
22405 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22406
22407
22408 .option batch_max pipe integer 1
22409 This limits the number of addresses that can be handled in a single delivery.
22410 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22411
22412
22413 .option check_string pipe string unset
22414 As &(pipe)& writes the message, the start of each line is tested for matching
22415 &%check_string%&, and if it does, the initial matching characters are replaced
22416 by the contents of &%escape_string%&, provided both are set. The value of
22417 &%check_string%& is a literal string, not a regular expression, and the case of
22418 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22419 of &%check_string%& and &%escape_string%& are forced to values that implement
22420 the SMTP escaping protocol. Any settings made in the configuration file are
22421 ignored.
22422
22423
22424 .option command pipe string&!! unset
22425 This option need not be set when &(pipe)& is being used to deliver to pipes
22426 obtained directly from address redirections. In other cases, the option must be
22427 set, to provide a command to be run. It need not yield an absolute path (see
22428 the &%path%& option below). The command is split up into separate arguments by
22429 Exim, and each argument is separately expanded, as described in section
22430 &<<SECThowcommandrun>>& above.
22431
22432
22433 .option environment pipe string&!! unset
22434 .cindex "&(pipe)& transport" "environment for command"
22435 .cindex "environment for &(pipe)& transport"
22436 This option is used to add additional variables to the environment in which the
22437 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22438 a string which is expanded, and then interpreted as a colon-separated list of
22439 environment settings of the form <&'name'&>=<&'value'&>.
22440
22441
22442 .option escape_string pipe string unset
22443 See &%check_string%& above.
22444
22445
22446 .option freeze_exec_fail pipe boolean false
22447 .cindex "exec failure"
22448 .cindex "failure of exec"
22449 .cindex "&(pipe)& transport" "failure of exec"
22450 Failure to exec the command in a pipe transport is by default treated like
22451 any other failure while running the command. However, if &%freeze_exec_fail%&
22452 is set, failure to exec is treated specially, and causes the message to be
22453 frozen, whatever the setting of &%ignore_status%&.
22454
22455
22456 .option freeze_signal pipe boolean false
22457 .cindex "signal exit"
22458 .cindex "&(pipe)& transport", "signal exit"
22459 Normally if the process run by a command in a pipe transport exits on a signal,
22460 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22461 frozen in Exim's queue instead.
22462
22463
22464 .option force_command pipe boolean false
22465 .cindex "force command"
22466 .cindex "&(pipe)& transport", "force command"
22467 Normally when a router redirects an address directly to a pipe command
22468 the &%command%& option on the transport is ignored.  If &%force_command%&
22469 is set, the &%command%& option will used. This is especially
22470 useful for forcing a wrapper or additional argument to be added to the
22471 command. For example:
22472 .code
22473 command = /usr/bin/remote_exec myhost -- $address_pipe
22474 force_command
22475 .endd
22476
22477 Note that &$address_pipe$& is handled specially in &%command%& when
22478 &%force_command%& is set, expanding out to the original argument vector as
22479 separate items, similarly to a Unix shell &`"$@"`& construct.
22480
22481 .option ignore_status pipe boolean false
22482 If this option is true, the status returned by the subprocess that is set up to
22483 run the command is ignored, and Exim behaves as if zero had been returned.
22484 Otherwise, a non-zero status or termination by signal causes an error return
22485 from the transport unless the status value is one of those listed in
22486 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22487
22488 &*Note*&: This option does not apply to timeouts, which do not return a status.
22489 See the &%timeout_defer%& option for how timeouts are handled.
22490
22491 .option log_defer_output pipe boolean false
22492 .cindex "&(pipe)& transport" "logging output"
22493 If this option is set, and the status returned by the command is
22494 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22495 and any output was produced, the first line of it is written to the main log.
22496
22497
22498 .option log_fail_output pipe boolean false
22499 If this option is set, and the command returns any output, and also ends with a
22500 return code that is neither zero nor one of the return codes listed in
22501 &%temp_errors%& (that is, the delivery failed), the first line of output is
22502 written to the main log. This option and &%log_output%& are mutually exclusive.
22503 Only one of them may be set.
22504
22505
22506
22507 .option log_output pipe boolean false
22508 If this option is set and the command returns any output, the first line of
22509 output is written to the main log, whatever the return code. This option and
22510 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22511
22512
22513
22514 .option max_output pipe integer 20K
22515 This specifies the maximum amount of output that the command may produce on its
22516 standard output and standard error file combined. If the limit is exceeded, the
22517 process running the command is killed. This is intended as a safety measure to
22518 catch runaway processes. The limit is applied independently of the settings of
22519 the options that control what is done with such output (for example,
22520 &%return_output%&). Because of buffering effects, the amount of output may
22521 exceed the limit by a small amount before Exim notices.
22522
22523
22524 .option message_prefix pipe string&!! "see below"
22525 The string specified here is expanded and output at the start of every message.
22526 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22527 .code
22528 message_prefix = \
22529   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22530   ${tod_bsdinbox}\n
22531 .endd
22532 .cindex "Cyrus"
22533 .cindex "&%tmail%&"
22534 .cindex "&""From""& line"
22535 This is required by the commonly used &_/usr/bin/vacation_& program.
22536 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22537 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22538 setting
22539 .code
22540 message_prefix =
22541 .endd
22542 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22543 &`\n`& to &`\r\n`& in &%message_prefix%&.
22544
22545
22546 .option message_suffix pipe string&!! "see below"
22547 The string specified here is expanded and output at the end of every message.
22548 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22549 The suffix can be suppressed by setting
22550 .code
22551 message_suffix =
22552 .endd
22553 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22554 &`\n`& to &`\r\n`& in &%message_suffix%&.
22555
22556
22557 .option path pipe string "see below"
22558 This option specifies the string that is set up in the PATH environment
22559 variable of the subprocess. The default is:
22560 .code
22561 /bin:/usr/bin
22562 .endd
22563 If the &%command%& option does not yield an absolute path name, the command is
22564 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22565 apply to a command specified as a transport filter.
22566
22567
22568 .option permit_coredump pipe boolean false
22569 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22570 a core-dump of a pipe command, enable this command.  This enables core-dumps
22571 during delivery and affects both the Exim binary and the pipe command run.
22572 It is recommended that this option remain off unless and until you have a need
22573 for it and that this only be enabled when needed, as the risk of excessive
22574 resource consumption can be quite high.  Note also that Exim is typically
22575 installed as a setuid binary and most operating systems will inhibit coredumps
22576 of these by default, so further OS-specific action may be required.
22577
22578
22579 .option pipe_as_creator pipe boolean false
22580 .cindex "uid (user id)" "local delivery"
22581 If the generic &%user%& option is not set and this option is true, the delivery
22582 process is run under the uid that was in force when Exim was originally called
22583 to accept the message. If the group id is not otherwise set (via the generic
22584 &%group%& option), the gid that was in force when Exim was originally called to
22585 accept the message is used.
22586
22587
22588 .option restrict_to_path pipe boolean false
22589 When this option is set, any command name not listed in &%allow_commands%& must
22590 contain no slashes. The command is searched for only in the directories listed
22591 in the &%path%& option. This option is intended for use in the case when a pipe
22592 command has been generated from a user's &_.forward_& file. This is usually
22593 handled by a &(pipe)& transport called &%address_pipe%&.
22594
22595
22596 .option return_fail_output pipe boolean false
22597 If this option is true, and the command produced any output and ended with a
22598 return code other than zero or one of the codes listed in &%temp_errors%& (that
22599 is, the delivery failed), the output is returned in the bounce message.
22600 However, if the message has a null sender (that is, it is itself a bounce
22601 message), output from the command is discarded. This option and
22602 &%return_output%& are mutually exclusive. Only one of them may be set.
22603
22604
22605
22606 .option return_output pipe boolean false
22607 If this option is true, and the command produced any output, the delivery is
22608 deemed to have failed whatever the return code from the command, and the output
22609 is returned in the bounce message. Otherwise, the output is just discarded.
22610 However, if the message has a null sender (that is, it is a bounce message),
22611 output from the command is always discarded, whatever the setting of this
22612 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22613 of them may be set.
22614
22615
22616
22617 .option temp_errors pipe "string list" "see below"
22618 .cindex "&(pipe)& transport" "temporary failure"
22619 This option contains either a colon-separated list of numbers, or a single
22620 asterisk. If &%ignore_status%& is false
22621 and &%return_output%& is not set,
22622 and the command exits with a non-zero return code, the failure is treated as
22623 temporary and the delivery is deferred if the return code matches one of the
22624 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22625 codes are treated as permanent errors. The default setting contains the codes
22626 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22627 compiled on a system that does not define these macros, it assumes values of 75
22628 and 73, respectively.
22629
22630
22631 .option timeout pipe time 1h
22632 If the command fails to complete within this time, it is killed. This normally
22633 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22634 specifies no timeout. In order to ensure that any subprocesses created by the
22635 command are also killed, Exim makes the initial process a process group leader,
22636 and kills the whole process group on a timeout. However, this can be defeated
22637 if one of the processes starts a new process group.
22638
22639 .option timeout_defer pipe boolean false
22640 A timeout in a &(pipe)& transport, either in the command that the transport
22641 runs, or in a transport filter that is associated with it, is by default
22642 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22643 is set true, both kinds of timeout become temporary errors, causing the
22644 delivery to be deferred.
22645
22646 .option umask pipe "octal integer" 022
22647 This specifies the umask setting for the subprocess that runs the command.
22648
22649
22650 .option use_bsmtp pipe boolean false
22651 .cindex "envelope sender"
22652 If this option is set true, the &(pipe)& transport writes messages in &"batch
22653 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22654 commands. If you want to include a leading HELO command with such messages,
22655 you can do so by setting the &%message_prefix%& option. See section
22656 &<<SECTbatchSMTP>>& for details of batch SMTP.
22657
22658 .option use_classresources pipe boolean false
22659 .cindex "class resources (BSD)"
22660 This option is available only when Exim is running on FreeBSD, NetBSD, or
22661 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22662 resource limits when a &(pipe)& transport is run to perform a delivery. The
22663 limits for the uid under which the pipe is to run are obtained from the login
22664 class database.
22665
22666
22667 .option use_crlf pipe boolean false
22668 .cindex "carriage return"
22669 .cindex "linefeed"
22670 This option causes lines to be terminated with the two-character CRLF sequence
22671 (carriage return, linefeed) instead of just a linefeed character. In the case
22672 of batched SMTP, the byte sequence written to the pipe is then an exact image
22673 of what would be sent down a real SMTP connection.
22674
22675 The contents of the &%message_prefix%& and &%message_suffix%& options are
22676 written verbatim, so must contain their own carriage return characters if these
22677 are needed. When &%use_bsmtp%& is not set, the default values for both
22678 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22679 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22680
22681
22682 .option use_shell pipe boolean false
22683 .vindex "&$pipe_addresses$&"
22684 If this option is set, it causes the command to be passed to &_/bin/sh_&
22685 instead of being run directly from the transport, as described in section
22686 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22687 where the command is expected to be run under a shell and cannot easily be
22688 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22689 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22690 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22691 its &%-c%& option.
22692
22693
22694
22695 .section "Using an external local delivery agent" "SECID143"
22696 .cindex "local delivery" "using an external agent"
22697 .cindex "&'procmail'&"
22698 .cindex "external local delivery"
22699 .cindex "delivery" "&'procmail'&"
22700 .cindex "delivery" "by external agent"
22701 The &(pipe)& transport can be used to pass all messages that require local
22702 delivery to a separate local delivery agent such as &%procmail%&. When doing
22703 this, care must be taken to ensure that the pipe is run under an appropriate
22704 uid and gid. In some configurations one wants this to be a uid that is trusted
22705 by the delivery agent to supply the correct sender of the message. It may be
22706 necessary to recompile or reconfigure the delivery agent so that it trusts an
22707 appropriate user. The following is an example transport and router
22708 configuration for &%procmail%&:
22709 .code
22710 # transport
22711 procmail_pipe:
22712   driver = pipe
22713   command = /usr/local/bin/procmail -d $local_part
22714   return_path_add
22715   delivery_date_add
22716   envelope_to_add
22717   check_string = "From "
22718   escape_string = ">From "
22719   umask = 077
22720   user = $local_part
22721   group = mail
22722
22723 # router
22724 procmail:
22725   driver = accept
22726   check_local_user
22727   transport = procmail_pipe
22728 .endd
22729 In this example, the pipe is run as the local user, but with the group set to
22730 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22731 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22732 user to supply a correct sender address. If you do not specify either a
22733 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22734 home directory is the user's home directory by default.
22735
22736 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22737 .code
22738 IFS=" "
22739 .endd
22740 as shown in some &%procmail%& documentation, because Exim does not by default
22741 use a shell to run pipe commands.
22742
22743 .cindex "Cyrus"
22744 The next example shows a transport and a router for a system where local
22745 deliveries are handled by the Cyrus IMAP server.
22746 .code
22747 # transport
22748 local_delivery_cyrus:
22749   driver = pipe
22750   command = /usr/cyrus/bin/deliver \
22751             -m ${substr_1:$local_part_suffix} -- $local_part
22752   user = cyrus
22753   group = mail
22754   return_output
22755   log_output
22756   message_prefix =
22757   message_suffix =
22758
22759 # router
22760 local_user_cyrus:
22761   driver = accept
22762   check_local_user
22763   local_part_suffix = .*
22764   transport = local_delivery_cyrus
22765 .endd
22766 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22767 &%return_output%& to cause any text written by Cyrus to be returned to the
22768 sender.
22769 .ecindex IIDpiptra1
22770 .ecindex IIDpiptra2
22771
22772
22773 . ////////////////////////////////////////////////////////////////////////////
22774 . ////////////////////////////////////////////////////////////////////////////
22775
22776 .chapter "The smtp transport" "CHAPsmtptrans"
22777 .scindex IIDsmttra1 "transports" "&(smtp)&"
22778 .scindex IIDsmttra2 "&(smtp)& transport"
22779 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22780 or LMTP protocol. The list of hosts to try can either be taken from the address
22781 that is being processed (having been set up by the router), or specified
22782 explicitly for the transport. Timeout and retry processing (see chapter
22783 &<<CHAPretry>>&) is applied to each IP address independently.
22784
22785
22786 .section "Multiple messages on a single connection" "SECID144"
22787 The sending of multiple messages over a single TCP/IP connection can arise in
22788 two ways:
22789
22790 .ilist
22791 If a message contains more than &%max_rcpt%& (see below) addresses that are
22792 routed to the same host, more than one copy of the message has to be sent to
22793 that host. In this situation, multiple copies may be sent in a single run of
22794 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22795 does when it has too many addresses to send in one message also depends on the
22796 value of the global &%remote_max_parallel%& option. Details are given in
22797 section &<<SECToutSMTPTCP>>&.)
22798 .next
22799 .cindex "hints database" "remembering routing"
22800 When a message has been successfully delivered over a TCP/IP connection, Exim
22801 looks in its hints database to see if there are any other messages awaiting a
22802 connection to the same host. If there are, a new delivery process is started
22803 for one of them, and the current TCP/IP connection is passed on to it. The new
22804 process may in turn send multiple copies and possibly create yet another
22805 process.
22806 .endlist
22807
22808
22809 For each copy sent over the same TCP/IP connection, a sequence counter is
22810 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22811 no further messages are sent over that connection.
22812
22813
22814
22815 .section "Use of the $host and $host_address variables" "SECID145"
22816 .vindex "&$host$&"
22817 .vindex "&$host_address$&"
22818 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22819 &$host_address$& are the name and IP address of the first host on the host list
22820 passed by the router. However, when the transport is about to connect to a
22821 specific host, and while it is connected to that host, &$host$& and
22822 &$host_address$& are set to the values for that host. These are the values
22823 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22824 &%serialize_hosts%&, and the various TLS options are expanded.
22825
22826
22827 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22828 .vindex &$tls_bits$&
22829 .vindex &$tls_cipher$&
22830 .vindex &$tls_peerdn$&
22831 .vindex &$tls_sni$&
22832 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22833 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22834 are the values that were set when the message was received.
22835 These are the values that are used for options that are expanded before any
22836 SMTP connections are made. Just before each connection is made, these four
22837 variables are emptied. If TLS is subsequently started, they are set to the
22838 appropriate values for the outgoing connection, and these are the values that
22839 are in force when any authenticators are run and when the
22840 &%authenticated_sender%& option is expanded.
22841
22842 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22843 and will be removed in a future release.
22844
22845
22846 .section "Private options for smtp" "SECID146"
22847 .cindex "options" "&(smtp)& transport"
22848 The private options of the &(smtp)& transport are as follows:
22849
22850
22851 .option address_retry_include_sender smtp boolean true
22852 .cindex "4&'xx'& responses" "retrying after"
22853 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22854 is the combination of sender and recipient that is delayed in subsequent queue
22855 runs until the retry time is reached. You can delay the recipient without
22856 reference to the sender (which is what earlier versions of Exim did), by
22857 setting &%address_retry_include_sender%& false. However, this can lead to
22858 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22859
22860 .option allow_localhost smtp boolean false
22861 .cindex "local host" "sending to"
22862 .cindex "fallback" "hosts specified on transport"
22863 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22864 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22865 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22866 the delivery anyway. This should be used only in special cases when the
22867 configuration ensures that no looping will result (for example, a differently
22868 configured Exim is listening on the port to which the message is sent).
22869
22870
22871 .option authenticated_sender smtp string&!! unset
22872 .cindex "Cyrus"
22873 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22874 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22875 overriding any existing authenticated sender value. If the string expansion is
22876 forced to fail, the option is ignored. Other expansion failures cause delivery
22877 to be deferred. If the result of expansion is an empty string, that is also
22878 ignored.
22879
22880 The expansion happens after the outgoing connection has been made and TLS
22881 started, if required. This means that the &$host$&, &$host_address$&,
22882 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22883 particular connection.
22884
22885 If the SMTP session is not authenticated, the expansion of
22886 &%authenticated_sender%& still happens (and can cause the delivery to be
22887 deferred if it fails), but no AUTH= item is added to MAIL commands
22888 unless &%authenticated_sender_force%& is true.
22889
22890 This option allows you to use the &(smtp)& transport in LMTP mode to
22891 deliver mail to Cyrus IMAP and provide the proper local part as the
22892 &"authenticated sender"&, via a setting such as:
22893 .code
22894 authenticated_sender = $local_part
22895 .endd
22896 This removes the need for IMAP subfolders to be assigned special ACLs to
22897 allow direct delivery to those subfolders.
22898
22899 Because of expected uses such as that just described for Cyrus (when no
22900 domain is involved), there is no checking on the syntax of the provided
22901 value.
22902
22903
22904 .option authenticated_sender_force smtp boolean false
22905 If this option is set true, the &%authenticated_sender%& option's value
22906 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22907 authenticated as a client.
22908
22909
22910 .option command_timeout smtp time 5m
22911 This sets a timeout for receiving a response to an SMTP command that has been
22912 sent out. It is also used when waiting for the initial banner line from the
22913 remote host. Its value must not be zero.
22914
22915
22916 .option connect_timeout smtp time 5m
22917 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22918 to a remote host. A setting of zero allows the system timeout (typically
22919 several minutes) to act. To have any effect, the value of this option must be
22920 less than the system timeout. However, it has been observed that on some
22921 systems there is no system timeout, which is why the default value for this
22922 option is 5 minutes, a value recommended by RFC 1123.
22923
22924
22925 .option connection_max_messages smtp integer 500
22926 .cindex "SMTP" "passed connection"
22927 .cindex "SMTP" "multiple deliveries"
22928 .cindex "multiple SMTP deliveries"
22929 This controls the maximum number of separate message deliveries that are sent
22930 over a single TCP/IP connection. If the value is zero, there is no limit.
22931 For testing purposes, this value can be overridden by the &%-oB%& command line
22932 option.
22933
22934
22935 .option data_timeout smtp time 5m
22936 This sets a timeout for the transmission of each block in the data portion of
22937 the message. As a result, the overall timeout for a message depends on the size
22938 of the message. Its value must not be zero. See also &%final_timeout%&.
22939
22940
22941 .option delay_after_cutoff smtp boolean true
22942 This option controls what happens when all remote IP addresses for a given
22943 domain have been inaccessible for so long that they have passed their retry
22944 cutoff times.
22945
22946 In the default state, if the next retry time has not been reached for any of
22947 them, the address is bounced without trying any deliveries. In other words,
22948 Exim delays retrying an IP address after the final cutoff time until a new
22949 retry time is reached, and can therefore bounce an address without ever trying
22950 a delivery, when machines have been down for a long time. Some people are
22951 unhappy at this prospect, so...
22952
22953 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22954 addresses are past their final cutoff time, Exim tries to deliver to those
22955 IP addresses that have not been tried since the message arrived. If there are
22956 none, of if they all fail, the address is bounced. In other words, it does not
22957 delay when a new message arrives, but immediately tries those expired IP
22958 addresses that haven't been tried since the message arrived. If there is a
22959 continuous stream of messages for the dead hosts, unsetting
22960 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22961 to them.
22962
22963
22964 .option dns_qualify_single smtp boolean true
22965 If the &%hosts%& or &%fallback_hosts%& option is being used,
22966 and the &%gethostbyname%& option is false,
22967 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22968 in chapter &<<CHAPdnslookup>>& for more details.
22969
22970
22971 .option dns_search_parents smtp boolean false
22972 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22973 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22974 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22975 details.
22976
22977
22978 .option dnssec_request_domains smtp "domain list&!!" unset
22979 .cindex "MX record" "security"
22980 .cindex "DNSSEC" "MX lookup"
22981 .cindex "security" "MX lookup"
22982 .cindex "DNS" "DNSSEC"
22983 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22984 the dnssec request bit set.
22985 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22986
22987
22988
22989 .option dnssec_require_domains smtp "domain list&!!" unset
22990 .cindex "MX record" "security"
22991 .cindex "DNSSEC" "MX lookup"
22992 .cindex "security" "MX lookup"
22993 .cindex "DNS" "DNSSEC"
22994 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22995 the dnssec request bit set.  Any returns not having the Authenticated Data bit
22996 (AD bit) set wil be ignored and logged as a host-lookup failure.
22997 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22998
22999
23000
23001 .option dscp smtp string&!! unset
23002 .cindex "DCSP" "outbound"
23003 This option causes the DSCP value associated with a socket to be set to one
23004 of a number of fixed strings or to numeric value.
23005 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23006 Common values include &`throughput`&, &`mincost`&, and on newer systems
23007 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23008
23009 The outbound packets from Exim will be marked with this value in the header
23010 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23011 that these values will have any effect, not be stripped by networking
23012 equipment, or do much of anything without cooperation with your Network
23013 Engineer and those of all network operators between the source and destination.
23014
23015
23016 .option fallback_hosts smtp "string list" unset
23017 .cindex "fallback" "hosts specified on transport"
23018 String expansion is not applied to this option. The argument must be a
23019 colon-separated list of host names or IP addresses, optionally also including
23020 port numbers, though the separator can be changed, as described in section
23021 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23022 item in a &%route_list%& setting for the &(manualroute)& router, as described
23023 in section &<<SECTformatonehostitem>>&.
23024
23025 Fallback hosts can also be specified on routers, which associate them with the
23026 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23027 &%fallback_hosts%& specified on the transport is used only if the address does
23028 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23029 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23030 However, &%hosts_randomize%& does apply to fallback host lists.
23031
23032 If Exim is unable to deliver to any of the hosts for a particular address, and
23033 the errors are not permanent rejections, the address is put on a separate
23034 transport queue with its host list replaced by the fallback hosts, unless the
23035 address was routed via MX records and the current host was in the original MX
23036 list. In that situation, the fallback host list is not used.
23037
23038 Once normal deliveries are complete, the fallback queue is delivered by
23039 re-running the same transports with the new host lists. If several failing
23040 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23041 copy of the message is sent.
23042
23043 The resolution of the host names on the fallback list is controlled by the
23044 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23045 both to cases when the host list comes with the address and when it is taken
23046 from &%hosts%&. This option provides a &"use a smart host only if delivery
23047 fails"& facility.
23048
23049
23050 .option final_timeout smtp time 10m
23051 This is the timeout that applies while waiting for the response to the final
23052 line containing just &"."& that terminates a message. Its value must not be
23053 zero.
23054
23055 .option gethostbyname smtp boolean false
23056 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23057 being used, names are looked up using &[gethostbyname()]&
23058 (or &[getipnodebyname()]& when available)
23059 instead of using the DNS. Of course, that function may in fact use the DNS, but
23060 it may also consult other sources of information such as &_/etc/hosts_&.
23061
23062 .option gnutls_compat_mode smtp boolean unset
23063 This option controls whether GnuTLS is used in compatibility mode in an Exim
23064 server. This reduces security slightly, but improves interworking with older
23065 implementations of TLS.
23066
23067 .option helo_data smtp string&!! "see below"
23068 .cindex "HELO" "argument, setting"
23069 .cindex "EHLO" "argument, setting"
23070 .cindex "LHLO argument setting"
23071 The value of this option is expanded after a connection to a another host has
23072 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23073 command that starts the outgoing SMTP or LMTP session. The default value of the
23074 option is:
23075 .code
23076 $primary_hostname
23077 .endd
23078 During the expansion, the variables &$host$& and &$host_address$& are set to
23079 the identity of the remote host, and the variables &$sending_ip_address$& and
23080 &$sending_port$& are set to the local IP address and port number that are being
23081 used. These variables can be used to generate different values for different
23082 servers or different local IP addresses. For example, if you want the string
23083 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23084 interface address, you could use this:
23085 .code
23086 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23087   {$primary_hostname}}
23088 .endd
23089 The use of &%helo_data%& applies both to sending messages and when doing
23090 callouts.
23091
23092 .option hosts smtp "string list&!!" unset
23093 Hosts are associated with an address by a router such as &(dnslookup)&, which
23094 finds the hosts by looking up the address domain in the DNS, or by
23095 &(manualroute)&, which has lists of hosts in its configuration. However,
23096 email addresses can be passed to the &(smtp)& transport by any router, and not
23097 all of them can provide an associated list of hosts.
23098
23099 The &%hosts%& option specifies a list of hosts to be used if the address being
23100 processed does not have any hosts associated with it. The hosts specified by
23101 &%hosts%& are also used, whether or not the address has its own hosts, if
23102 &%hosts_override%& is set.
23103
23104 The string is first expanded, before being interpreted as a colon-separated
23105 list of host names or IP addresses, possibly including port numbers. The
23106 separator may be changed to something other than colon, as described in section
23107 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23108 item in a &%route_list%& setting for the &(manualroute)& router, as described
23109 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23110 of the &(manualroute)& router is not available here.
23111
23112 If the expansion fails, delivery is deferred. Unless the failure was caused by
23113 the inability to complete a lookup, the error is logged to the panic log as
23114 well as the main log. Host names are looked up either by searching directly for
23115 address records in the DNS or by calling &[gethostbyname()]& (or
23116 &[getipnodebyname()]& when available), depending on the setting of the
23117 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23118 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23119 address are used.
23120
23121 During delivery, the hosts are tried in order, subject to their retry status,
23122 unless &%hosts_randomize%& is set.
23123
23124
23125 .option hosts_avoid_esmtp smtp "host list&!!" unset
23126 .cindex "ESMTP, avoiding use of"
23127 .cindex "HELO" "forcing use of"
23128 .cindex "EHLO" "avoiding use of"
23129 .cindex "PIPELINING" "avoiding the use of"
23130 This option is for use with broken hosts that announce ESMTP facilities (for
23131 example, PIPELINING) and then fail to implement them properly. When a host
23132 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23133 start of the SMTP session. This means that it cannot use any of the ESMTP
23134 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23135
23136
23137 .option hosts_avoid_pipelining smtp "host list&!!" unset
23138 .cindex "PIPELINING" "avoiding the use of"
23139 Exim will not use the SMTP PIPELINING extension when delivering to any host
23140 that matches this list, even if the server host advertises PIPELINING support.
23141
23142
23143 .option hosts_avoid_tls smtp "host list&!!" unset
23144 .cindex "TLS" "avoiding for certain hosts"
23145 Exim will not try to start a TLS session when delivering to any host that
23146 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23147
23148 .option hosts_verify_avoid_tls smtp "host list&!!" *
23149 .cindex "TLS" "avoiding for certain hosts"
23150 Exim will not try to start a TLS session for a verify callout,
23151 or when delivering in cutthrough mode,
23152 to any host that matches this list.
23153 Note that the default is to not use TLS.
23154
23155
23156 .option hosts_max_try smtp integer 5
23157 .cindex "host" "maximum number to try"
23158 .cindex "limit" "number of hosts tried"
23159 .cindex "limit" "number of MX tried"
23160 .cindex "MX record" "maximum tried"
23161 This option limits the number of IP addresses that are tried for any one
23162 delivery in cases where there are temporary delivery errors. Section
23163 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23164
23165
23166 .option hosts_max_try_hardlimit smtp integer 50
23167 This is an additional check on the maximum number of IP addresses that Exim
23168 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23169 why it exists.
23170
23171
23172
23173 .option hosts_nopass_tls smtp "host list&!!" unset
23174 .cindex "TLS" "passing connection"
23175 .cindex "multiple SMTP deliveries"
23176 .cindex "TLS" "multiple message deliveries"
23177 For any host that matches this list, a connection on which a TLS session has
23178 been started will not be passed to a new delivery process for sending another
23179 message on the same connection. See section &<<SECTmulmessam>>& for an
23180 explanation of when this might be needed.
23181
23182
23183 .option hosts_override smtp boolean false
23184 If this option is set and the &%hosts%& option is also set, any hosts that are
23185 attached to the address are ignored, and instead the hosts specified by the
23186 &%hosts%& option are always used. This option does not apply to
23187 &%fallback_hosts%&.
23188
23189
23190 .option hosts_randomize smtp boolean false
23191 .cindex "randomized host list"
23192 .cindex "host" "list of; randomized"
23193 .cindex "fallback" "randomized hosts"
23194 If this option is set, and either the list of hosts is taken from the
23195 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23196 were not obtained from MX records (this includes fallback hosts from the
23197 router), and were not randomized by the router, the order of trying the hosts
23198 is randomized each time the transport runs. Randomizing the order of a host
23199 list can be used to do crude load sharing.
23200
23201 When &%hosts_randomize%& is true, a host list may be split into groups whose
23202 order is separately randomized. This makes it possible to set up MX-like
23203 behaviour. The boundaries between groups are indicated by an item that is just
23204 &`+`& in the host list. For example:
23205 .code
23206 hosts = host1:host2:host3:+:host4:host5
23207 .endd
23208 The order of the first three hosts and the order of the last two hosts is
23209 randomized for each use, but the first three always end up before the last two.
23210 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23211
23212 .option hosts_require_auth smtp "host list&!!" unset
23213 .cindex "authentication" "required by client"
23214 This option provides a list of servers for which authentication must succeed
23215 before Exim will try to transfer a message. If authentication fails for
23216 servers which are not in this list, Exim tries to send unauthenticated. If
23217 authentication fails for one of these servers, delivery is deferred. This
23218 temporary error is detectable in the retry rules, so it can be turned into a
23219 hard failure if required. See also &%hosts_try_auth%&, and chapter
23220 &<<CHAPSMTPAUTH>>& for details of authentication.
23221
23222
23223 .option hosts_request_ocsp smtp "host list&!!" *
23224 .cindex "TLS" "requiring for certain servers"
23225 Exim will request a Certificate Status on a
23226 TLS session for any host that matches this list.
23227 &%tls_verify_certificates%& should also be set for the transport.
23228
23229 .option hosts_require_ocsp smtp "host list&!!" unset
23230 .cindex "TLS" "requiring for certain servers"
23231 Exim will request, and check for a valid Certificate Status being given, on a
23232 TLS session for any host that matches this list.
23233 &%tls_verify_certificates%& should also be set for the transport.
23234
23235 .option hosts_require_tls smtp "host list&!!" unset
23236 .cindex "TLS" "requiring for certain servers"
23237 Exim will insist on using a TLS session when delivering to any host that
23238 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23239 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23240 incoming messages, use an appropriate ACL.
23241
23242 .option hosts_try_auth smtp "host list&!!" unset
23243 .cindex "authentication" "optional in client"
23244 This option provides a list of servers to which, provided they announce
23245 authentication support, Exim will attempt to authenticate as a client when it
23246 connects. If authentication fails, Exim will try to transfer the message
23247 unauthenticated. See also &%hosts_require_auth%&, and chapter
23248 &<<CHAPSMTPAUTH>>& for details of authentication.
23249
23250 .option hosts_try_prdr smtp "host list&!!" *
23251 .cindex "PRDR" "enabling, optional in client"
23252 This option provides a list of servers to which, provided they announce
23253 PRDR support, Exim will attempt to negotiate PRDR
23254 for multi-recipient messages.
23255 The option can usually be left as default.
23256
23257 .option interface smtp "string list&!!" unset
23258 .cindex "bind IP address"
23259 .cindex "IP address" "binding"
23260 .vindex "&$host$&"
23261 .vindex "&$host_address$&"
23262 This option specifies which interface to bind to when making an outgoing SMTP
23263 call. The value is an IP address, not an interface name such as
23264 &`eth0`&. Do not confuse this with the interface address that was used when a
23265 message was received, which is in &$received_ip_address$&, formerly known as
23266 &$interface_address$&. The name was changed to minimize confusion with the
23267 outgoing interface address. There is no variable that contains an outgoing
23268 interface address because, unless it is set by this option, its value is
23269 unknown.
23270
23271 During the expansion of the &%interface%& option the variables &$host$& and
23272 &$host_address$& refer to the host to which a connection is about to be made
23273 during the expansion of the string. Forced expansion failure, or an empty
23274 string result causes the option to be ignored. Otherwise, after expansion, the
23275 string must be a list of IP addresses, colon-separated by default, but the
23276 separator can be changed in the usual way. For example:
23277 .code
23278 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23279 .endd
23280 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23281 connection. If none of them are the correct type, the option is ignored. If
23282 &%interface%& is not set, or is ignored, the system's IP functions choose which
23283 interface to use if the host has more than one.
23284
23285
23286 .option keepalive smtp boolean true
23287 .cindex "keepalive" "on outgoing connection"
23288 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23289 connections. When set, it causes the kernel to probe idle connections
23290 periodically, by sending packets with &"old"& sequence numbers. The other end
23291 of the connection should send a acknowledgment if the connection is still okay
23292 or a reset if the connection has been aborted. The reason for doing this is
23293 that it has the beneficial effect of freeing up certain types of connection
23294 that can get stuck when the remote host is disconnected without tidying up the
23295 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23296 unreachable hosts.
23297
23298
23299 .option lmtp_ignore_quota smtp boolean false
23300 .cindex "LMTP" "ignoring quota errors"
23301 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23302 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23303 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23304
23305 .option max_rcpt smtp integer 100
23306 .cindex "RCPT" "maximum number of outgoing"
23307 This option limits the number of RCPT commands that are sent in a single
23308 SMTP message transaction. Each set of addresses is treated independently, and
23309 so can cause parallel connections to the same host if &%remote_max_parallel%&
23310 permits this.
23311
23312
23313 .option multi_domain smtp boolean&!! true
23314 .vindex "&$domain$&"
23315 When this option is set, the &(smtp)& transport can handle a number of
23316 addresses containing a mixture of different domains provided they all resolve
23317 to the same list of hosts. Turning the option off restricts the transport to
23318 handling only one domain at a time. This is useful if you want to use
23319 &$domain$& in an expansion for the transport, because it is set only when there
23320 is a single domain involved in a remote delivery.
23321
23322 It is expanded per-address and can depend on any of
23323 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23324 &$host$&, &$host_address$& and &$host_port$&.
23325
23326 .option port smtp string&!! "see below"
23327 .cindex "port" "sending TCP/IP"
23328 .cindex "TCP/IP" "setting outgoing port"
23329 This option specifies the TCP/IP port on the server to which Exim connects.
23330 &*Note:*& Do not confuse this with the port that was used when a message was
23331 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23332 The name was changed to minimize confusion with the outgoing port. There is no
23333 variable that contains an outgoing port.
23334
23335 If the value of this option begins with a digit it is taken as a port number;
23336 otherwise it is looked up using &[getservbyname()]&. The default value is
23337 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23338 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23339 is deferred.
23340
23341
23342
23343 .option protocol smtp string smtp
23344 .cindex "LMTP" "over TCP/IP"
23345 .cindex "ssmtp protocol" "outbound"
23346 .cindex "TLS" "SSL-on-connect outbound"
23347 .vindex "&$port$&"
23348 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23349 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23350 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23351 deliveries into closed message stores. Exim also has support for running LMTP
23352 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23353
23354 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23355 changes to &"smtps"&, and the transport initiates TLS immediately after
23356 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23357 The Internet standards bodies strongly discourage use of this mode.
23358
23359
23360 .option retry_include_ip_address smtp boolean&!! true
23361 Exim normally includes both the host name and the IP address in the key it
23362 constructs for indexing retry data after a temporary delivery failure. This
23363 means that when one of several IP addresses for a host is failing, it gets
23364 tried periodically (controlled by the retry rules), but use of the other IP
23365 addresses is not affected.
23366
23367 However, in some dialup environments hosts are assigned a different IP address
23368 each time they connect. In this situation the use of the IP address as part of
23369 the retry key leads to undesirable behaviour. Setting this option false causes
23370 Exim to use only the host name.
23371 Since it is expanded it can be made to depend on the host or domain.
23372
23373
23374 .option serialize_hosts smtp "host list&!!" unset
23375 .cindex "serializing connections"
23376 .cindex "host" "serializing connections"
23377 Because Exim operates in a distributed manner, if several messages for the same
23378 host arrive at around the same time, more than one simultaneous connection to
23379 the remote host can occur. This is not usually a problem except when there is a
23380 slow link between the hosts. In that situation it may be helpful to restrict
23381 Exim to one connection at a time. This can be done by setting
23382 &%serialize_hosts%& to match the relevant hosts.
23383
23384 .cindex "hints database" "serializing deliveries to a host"
23385 Exim implements serialization by means of a hints database in which a record is
23386 written whenever a process connects to one of the restricted hosts. The record
23387 is deleted when the connection is completed. Obviously there is scope for
23388 records to get left lying around if there is a system or program crash. To
23389 guard against this, Exim ignores any records that are more than six hours old.
23390
23391 If you set up this kind of serialization, you should also arrange to delete the
23392 relevant hints database whenever your system reboots. The names of the files
23393 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23394 may be one or two files, depending on the type of DBM in use. The same files
23395 are used for ETRN serialization.
23396
23397
23398 .option size_addition smtp integer 1024
23399 .cindex "SMTP" "SIZE"
23400 .cindex "message" "size issue for transport filter"
23401 .cindex "size" "of message"
23402 .cindex "transport" "filter"
23403 .cindex "filter" "transport filter"
23404 If a remote SMTP server indicates that it supports the SIZE option of the
23405 MAIL command, Exim uses this to pass over the message size at the start of
23406 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23407 sends, to allow for headers and other text that may be added during delivery by
23408 configuration options or in a transport filter. It may be necessary to increase
23409 this if a lot of text is added to messages.
23410
23411 Alternatively, if the value of &%size_addition%& is set negative, it disables
23412 the use of the SIZE option altogether.
23413
23414
23415 .option tls_certificate smtp string&!! unset
23416 .cindex "TLS" "client certificate, location of"
23417 .cindex "certificate" "client, location of"
23418 .vindex "&$host$&"
23419 .vindex "&$host_address$&"
23420 The value of this option must be the absolute path to a file which contains the
23421 client's certificate, for possible use when sending a message over an encrypted
23422 connection. The values of &$host$& and &$host_address$& are set to the name and
23423 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23424 details of TLS.
23425
23426 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23427 certificate when sending messages as a client. The global option of the same
23428 name specifies the certificate for Exim as a server; it is not automatically
23429 assumed that the same certificate should be used when Exim is operating as a
23430 client.
23431
23432
23433 .option tls_crl smtp string&!! unset
23434 .cindex "TLS" "client certificate revocation list"
23435 .cindex "certificate" "revocation list for client"
23436 This option specifies a certificate revocation list. The expanded value must
23437 be the name of a file that contains a CRL in PEM format.
23438
23439
23440 .option tls_dh_min_bits smtp integer 1024
23441 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23442 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23443 key agreement is negotiated, the server will provide a large prime number
23444 for use.  This option establishes the minimum acceptable size of that number.
23445 If the parameter offered by the server is too small, then the TLS handshake
23446 will fail.
23447
23448 Only supported when using GnuTLS.
23449
23450
23451 .option tls_privatekey smtp string&!! unset
23452 .cindex "TLS" "client private key, location of"
23453 .vindex "&$host$&"
23454 .vindex "&$host_address$&"
23455 The value of this option must be the absolute path to a file which contains the
23456 client's private key. This is used when sending a message over an encrypted
23457 connection using a client certificate. The values of &$host$& and
23458 &$host_address$& are set to the name and address of the server during the
23459 expansion. If this option is unset, or the expansion is forced to fail, or the
23460 result is an empty string, the private key is assumed to be in the same file as
23461 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23462
23463
23464 .option tls_require_ciphers smtp string&!! unset
23465 .cindex "TLS" "requiring specific ciphers"
23466 .cindex "cipher" "requiring specific"
23467 .vindex "&$host$&"
23468 .vindex "&$host_address$&"
23469 The value of this option must be a list of permitted cipher suites, for use
23470 when setting up an outgoing encrypted connection. (There is a global option of
23471 the same name for controlling incoming connections.) The values of &$host$& and
23472 &$host_address$& are set to the name and address of the server during the
23473 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23474 is used in different ways by OpenSSL and GnuTLS (see sections
23475 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23476 ciphers is a preference order.
23477
23478
23479
23480 .option tls_sni smtp string&!! unset
23481 .cindex "TLS" "Server Name Indication"
23482 .vindex "&$tls_sni$&"
23483 If this option is set then it sets the $tls_out_sni variable and causes any
23484 TLS session to pass this value as the Server Name Indication extension to
23485 the remote side, which can be used by the remote side to select an appropriate
23486 certificate and private key for the session.
23487
23488 See &<<SECTtlssni>>& for more information.
23489
23490 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23491 TLS extensions.
23492
23493
23494
23495
23496 .option tls_tempfail_tryclear smtp boolean true
23497 .cindex "4&'xx'& responses" "to STARTTLS"
23498 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23499 setting up a TLS session, this option determines whether or not Exim should try
23500 to deliver the message unencrypted. If it is set false, delivery to the
23501 current host is deferred; if there are other hosts, they are tried. If this
23502 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23503 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23504 TLS negotiation fails, Exim closes the current connection (because it is in an
23505 unknown state), opens a new one to the same host, and then tries the delivery
23506 in clear.
23507
23508
23509 .option tls_try_verify_hosts smtp "host list&!!" *
23510 .cindex "TLS" "server certificate verification"
23511 .cindex "certificate" "verification of server"
23512 This option gives a list of hosts for which, on encrypted connections,
23513 certificate verification will be tried but need not succeed.
23514 The &%tls_verify_certificates%& option must also be set.
23515 Note that unless the host is in this list
23516 TLS connections will be denied to hosts using self-signed certificates
23517 when &%tls_verify_certificates%& is matched.
23518 The &$tls_out_certificate_verified$& variable is set when
23519 certificate verification succeeds.
23520
23521
23522 .option tls_verify_cert_hostnames smtp "host list&!!" *
23523 .cindex "TLS" "server certificate hostname verification"
23524 .cindex "certificate" "verification of server"
23525 This option give a list of hosts for which,
23526 while verifying the server certificate,
23527 checks will be included on the host name
23528 (note that this will generally be the result of a DNS MX lookup)
23529 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23530 limited to being the initial component of a 3-or-more component FQDN.
23531
23532 There is no equivalent checking on client certificates.
23533
23534
23535 .option tls_verify_certificates smtp string&!! system
23536 .cindex "TLS" "server certificate verification"
23537 .cindex "certificate" "verification of server"
23538 .vindex "&$host$&"
23539 .vindex "&$host_address$&"
23540 The value of this option must be either the
23541 word "system"
23542 or the absolute path to
23543 a file or directory containing permitted certificates for servers,
23544 for use when setting up an encrypted connection.
23545
23546 The "system" value for the option will use a location compiled into the SSL library.
23547 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23548 is taken as empty and an explicit location
23549 must be specified.
23550
23551 The use of a directory for the option value is not avilable for GnuTLS versions
23552 preceding 3.3.6 and a single file must be used.
23553
23554 With OpenSSL the certificates specified
23555 explicitly
23556 either by file or directory
23557 are added to those given by the system default location.
23558
23559 The values of &$host$& and
23560 &$host_address$& are set to the name and address of the server during the
23561 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23562
23563 For back-compatability,
23564 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23565 (a single-colon empty list counts as being set)
23566 and certificate verification fails the TLS connection is closed.
23567
23568
23569 .option tls_verify_hosts smtp "host list&!!" unset
23570 .cindex "TLS" "server certificate verification"
23571 .cindex "certificate" "verification of server"
23572 This option gives a list of hosts for which. on encrypted connections,
23573 certificate verification must succeed.
23574 The &%tls_verify_certificates%& option must also be set.
23575 If both this option and &%tls_try_verify_hosts%& are unset
23576 operation is as if this option selected all hosts.
23577
23578
23579
23580
23581 .section "How the limits for the number of hosts to try are used" &&&
23582          "SECTvalhosmax"
23583 .cindex "host" "maximum number to try"
23584 .cindex "limit" "hosts; maximum number tried"
23585 There are two options that are concerned with the number of hosts that are
23586 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23587 &%hosts_max_try_hardlimit%&.
23588
23589
23590 The &%hosts_max_try%& option limits the number of hosts that are tried
23591 for a single delivery. However, despite the term &"host"& in its name, the
23592 option actually applies to each IP address independently. In other words, a
23593 multihomed host is treated as several independent hosts, just as it is for
23594 retrying.
23595
23596 Many of the larger ISPs have multiple MX records which often point to
23597 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23598 created as a result of routing one of these domains.
23599
23600 Trying every single IP address on such a long list does not seem sensible; if
23601 several at the top of the list fail, it is reasonable to assume there is some
23602 problem that is likely to affect all of them. Roughly speaking, the value of
23603 &%hosts_max_try%& is the maximum number that are tried before deferring the
23604 delivery. However, the logic cannot be quite that simple.
23605
23606 Firstly, IP addresses that are skipped because their retry times have not
23607 arrived do not count, and in addition, addresses that are past their retry
23608 limits are also not counted, even when they are tried. This means that when
23609 some IP addresses are past their retry limits, more than the value of
23610 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23611 that all IP addresses are considered before timing out an email address (but
23612 see below for an exception).
23613
23614 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23615 list to see if there is a subsequent host with a different (higher valued) MX.
23616 If there is, that host is considered next, and the current IP address is used
23617 but not counted. This behaviour helps in the case of a domain with a retry rule
23618 that hardly ever delays any hosts, as is now explained:
23619
23620 Consider the case of a long list of hosts with one MX value, and a few with a
23621 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23622 hosts at the top of the list are tried at first. With the default retry rule,
23623 which specifies increasing retry times, the higher MX hosts are eventually
23624 tried when those at the top of the list are skipped because they have not
23625 reached their retry times.
23626
23627 However, it is common practice to put a fixed short retry time on domains for
23628 large ISPs, on the grounds that their servers are rarely down for very long.
23629 Unfortunately, these are exactly the domains that tend to resolve to long lists
23630 of hosts. The short retry time means that the lowest MX hosts are tried every
23631 time. The attempts may be in a different order because of random sorting, but
23632 without the special MX check, the higher MX hosts would never be tried until
23633 all the lower MX hosts had timed out (which might be several days), because
23634 there are always some lower MX hosts that have reached their retry times. With
23635 the special check, Exim considers at least one IP address from each MX value at
23636 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23637 reached.
23638
23639 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23640 particular, Exim normally eventually tries all the IP addresses before timing
23641 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23642 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23643 been set up with hundreds of IP addresses for some domains. It can
23644 take a very long time indeed for an address to time out in these cases.
23645
23646 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23647 Exim never tries more than this number of IP addresses; if it hits this limit
23648 and they are all timed out, the email address is bounced, even though not all
23649 possible IP addresses have been tried.
23650 .ecindex IIDsmttra1
23651 .ecindex IIDsmttra2
23652
23653
23654
23655
23656
23657 . ////////////////////////////////////////////////////////////////////////////
23658 . ////////////////////////////////////////////////////////////////////////////
23659
23660 .chapter "Address rewriting" "CHAPrewrite"
23661 .scindex IIDaddrew "rewriting" "addresses"
23662 There are some circumstances in which Exim automatically rewrites domains in
23663 addresses. The two most common are when an address is given without a domain
23664 (referred to as an &"unqualified address"&) or when an address contains an
23665 abbreviated domain that is expanded by DNS lookup.
23666
23667 Unqualified envelope addresses are accepted only for locally submitted
23668 messages, or for messages that are received from hosts matching
23669 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23670 appropriate. Unqualified addresses in header lines are qualified if they are in
23671 locally submitted messages, or messages from hosts that are permitted to send
23672 unqualified envelope addresses. Otherwise, unqualified addresses in header
23673 lines are neither qualified nor rewritten.
23674
23675 One situation in which Exim does &'not'& automatically rewrite a domain is
23676 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23677 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23678 do this. The new RFCs do not contain this suggestion.
23679
23680
23681 .section "Explicitly configured address rewriting" "SECID147"
23682 This chapter describes the rewriting rules that can be used in the
23683 main rewrite section of the configuration file, and also in the generic
23684 &%headers_rewrite%& option that can be set on any transport.
23685
23686 Some people believe that configured address rewriting is a Mortal Sin.
23687 Others believe that life is not possible without it. Exim provides the
23688 facility; you do not have to use it.
23689
23690 The main rewriting rules that appear in the &"rewrite"& section of the
23691 configuration file are applied to addresses in incoming messages, both envelope
23692 addresses and addresses in header lines. Each rule specifies the types of
23693 address to which it applies.
23694
23695 Whether or not addresses in header lines are rewritten depends on the origin of
23696 the headers and the type of rewriting. Global rewriting, that is, rewriting
23697 rules from the rewrite section of the configuration file, is applied only to
23698 those headers that were received with the message. Header lines that are added
23699 by ACLs or by a system filter or by individual routers or transports (which
23700 are specific to individual recipient addresses) are not rewritten by the global
23701 rules.
23702
23703 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23704 applies all headers except those added by routers and transports. That is, as
23705 well as the headers that were received with the message, it also applies to
23706 headers that were added by an ACL or a system filter.
23707
23708
23709 In general, rewriting addresses from your own system or domain has some
23710 legitimacy. Rewriting other addresses should be done only with great care and
23711 in special circumstances. The author of Exim believes that rewriting should be
23712 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23713 Although it can sometimes be used as a routing tool, this is very strongly
23714 discouraged.
23715
23716 There are two commonly encountered circumstances where rewriting is used, as
23717 illustrated by these examples:
23718
23719 .ilist
23720 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23721 exchange mail with each other behind a firewall, but there is only a single
23722 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23723 &'hitch.fict.example'& when sending mail off-site.
23724 .next
23725 A host rewrites the local parts of its own users so that, for example,
23726 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23727 .endlist
23728
23729
23730
23731 .section "When does rewriting happen?" "SECID148"
23732 .cindex "rewriting" "timing of"
23733 .cindex "&ACL;" "rewriting addresses in"
23734 Configured address rewriting can take place at several different stages of a
23735 message's processing.
23736
23737 .vindex "&$sender_address$&"
23738 At the start of an ACL for MAIL, the sender address may have been rewritten
23739 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23740 ordinary rewrite rules have yet been applied. If, however, the sender address
23741 is verified in the ACL, it is rewritten before verification, and remains
23742 rewritten thereafter. The subsequent value of &$sender_address$& is the
23743 rewritten address. This also applies if sender verification happens in a
23744 RCPT ACL. Otherwise, when the sender address is not verified, it is
23745 rewritten as soon as a message's header lines have been received.
23746
23747 .vindex "&$domain$&"
23748 .vindex "&$local_part$&"
23749 Similarly, at the start of an ACL for RCPT, the current recipient's address
23750 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23751 rewrite rules have yet been applied to it. However, the behaviour is different
23752 from the sender address when a recipient is verified. The address is rewritten
23753 for the verification, but the rewriting is not remembered at this stage. The
23754 value of &$local_part$& and &$domain$& after verification are always the same
23755 as they were before (that is, they contain the unrewritten &-- except for
23756 SMTP-time rewriting &-- address).
23757
23758 As soon as a message's header lines have been received, all the envelope
23759 recipient addresses are permanently rewritten, and rewriting is also applied to
23760 the addresses in the header lines (if configured). This happens before adding
23761 any header lines that were specified in MAIL or RCPT ACLs, and
23762 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23763 before the DATA ACL and &[local_scan()]& functions are run.
23764
23765 When an address is being routed, either for delivery or for verification,
23766 rewriting is applied immediately to child addresses that are generated by
23767 redirection, unless &%no_rewrite%& is set on the router.
23768
23769 .cindex "envelope sender" "rewriting at transport time"
23770 .cindex "rewriting" "at transport time"
23771 .cindex "header lines" "rewriting at transport time"
23772 At transport time, additional rewriting of addresses in header lines can be
23773 specified by setting the generic &%headers_rewrite%& option on a transport.
23774 This option contains rules that are identical in form to those in the rewrite
23775 section of the configuration file. They are applied to the original message
23776 header lines and any that were added by ACLs or a system filter. They are not
23777 applied to header lines that are added by routers or the transport.
23778
23779 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23780 transport option. However, it is not possible to rewrite envelope recipients at
23781 transport time.
23782
23783
23784
23785
23786 .section "Testing the rewriting rules that apply on input" "SECID149"
23787 .cindex "rewriting" "testing"
23788 .cindex "testing" "rewriting"
23789 Exim's input rewriting configuration appears in a part of the run time
23790 configuration file headed by &"begin rewrite"&. It can be tested by the
23791 &%-brw%& command line option. This takes an address (which can be a full RFC
23792 2822 address) as its argument. The output is a list of how the address would be
23793 transformed by the rewriting rules for each of the different places it might
23794 appear in an incoming message, that is, for each different header and for the
23795 envelope sender and recipient fields. For example,
23796 .code
23797 exim -brw ph10@exim.workshop.example
23798 .endd
23799 might produce the output
23800 .code
23801 sender: Philip.Hazel@exim.workshop.example
23802 from: Philip.Hazel@exim.workshop.example
23803 to: ph10@exim.workshop.example
23804 cc: ph10@exim.workshop.example
23805 bcc: ph10@exim.workshop.example
23806 reply-to: Philip.Hazel@exim.workshop.example
23807 env-from: Philip.Hazel@exim.workshop.example
23808 env-to: ph10@exim.workshop.example
23809 .endd
23810 which shows that rewriting has been set up for that address when used in any of
23811 the source fields, but not when it appears as a recipient address. At the
23812 present time, there is no equivalent way of testing rewriting rules that are
23813 set for a particular transport.
23814
23815
23816 .section "Rewriting rules" "SECID150"
23817 .cindex "rewriting" "rules"
23818 The rewrite section of the configuration file consists of lines of rewriting
23819 rules in the form
23820 .display
23821 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23822 .endd
23823 Rewriting rules that are specified for the &%headers_rewrite%& generic
23824 transport option are given as a colon-separated list. Each item in the list
23825 takes the same form as a line in the main rewriting configuration (except that
23826 any colons must be doubled, of course).
23827
23828 The formats of source patterns and replacement strings are described below.
23829 Each is terminated by white space, unless enclosed in double quotes, in which
23830 case normal quoting conventions apply inside the quotes. The flags are single
23831 characters which may appear in any order. Spaces and tabs between them are
23832 ignored.
23833
23834 For each address that could potentially be rewritten, the rules are scanned in
23835 order, and replacements for the address from earlier rules can themselves be
23836 replaced by later rules (but see the &"q"& and &"R"& flags).
23837
23838 The order in which addresses are rewritten is undefined, may change between
23839 releases, and must not be relied on, with one exception: when a message is
23840 received, the envelope sender is always rewritten first, before any header
23841 lines are rewritten. For example, the replacement string for a rewrite of an
23842 address in &'To:'& must not assume that the message's address in &'From:'& has
23843 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23844 that the envelope sender has already been rewritten.
23845
23846 .vindex "&$domain$&"
23847 .vindex "&$local_part$&"
23848 The variables &$local_part$& and &$domain$& can be used in the replacement
23849 string to refer to the address that is being rewritten. Note that lookup-driven
23850 rewriting can be done by a rule of the form
23851 .code
23852 *@*   ${lookup ...
23853 .endd
23854 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23855 refer to the address that is being rewritten.
23856
23857
23858 .section "Rewriting patterns" "SECID151"
23859 .cindex "rewriting" "patterns"
23860 .cindex "address list" "in a rewriting pattern"
23861 The source pattern in a rewriting rule is any item which may appear in an
23862 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23863 single-item address list, which means that it is expanded before being tested
23864 against the address. As always, if you use a regular expression as a pattern,
23865 you must take care to escape dollar and backslash characters, or use the &`\N`&
23866 facility to suppress string expansion within the regular expression.
23867
23868 Domains in patterns should be given in lower case. Local parts in patterns are
23869 case-sensitive. If you want to do case-insensitive matching of local parts, you
23870 can use a regular expression that starts with &`^(?i)`&.
23871
23872 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23873 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23874 depending on the type of match which occurred. These can be used in the
23875 replacement string to insert portions of the incoming address. &$0$& always
23876 refers to the complete incoming address. When a regular expression is used, the
23877 numerical variables are set from its capturing subexpressions. For other types
23878 of pattern they are set as follows:
23879
23880 .ilist
23881 If a local part or domain starts with an asterisk, the numerical variables
23882 refer to the character strings matched by asterisks, with &$1$& associated with
23883 the first asterisk, and &$2$& with the second, if present. For example, if the
23884 pattern
23885 .code
23886 *queen@*.fict.example
23887 .endd
23888 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23889 .code
23890 $0 = hearts-queen@wonderland.fict.example
23891 $1 = hearts-
23892 $2 = wonderland
23893 .endd
23894 Note that if the local part does not start with an asterisk, but the domain
23895 does, it is &$1$& that contains the wild part of the domain.
23896
23897 .next
23898 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23899 of the domain are placed in the next available numerical variables. Suppose,
23900 for example, that the address &'foo@bar.baz.example'& is processed by a
23901 rewriting rule of the form
23902 .display
23903 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23904 .endd
23905 and the key in the file that matches the domain is &`*.baz.example`&. Then
23906 .code
23907 $1 = foo
23908 $2 = bar
23909 $3 = baz.example
23910 .endd
23911 If the address &'foo@baz.example'& is looked up, this matches the same
23912 wildcard file entry, and in this case &$2$& is set to the empty string, but
23913 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23914 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23915 whole domain. For non-partial domain lookups, no numerical variables are set.
23916 .endlist
23917
23918
23919 .section "Rewriting replacements" "SECID152"
23920 .cindex "rewriting" "replacements"
23921 If the replacement string for a rule is a single asterisk, addresses that
23922 match the pattern and the flags are &'not'& rewritten, and no subsequent
23923 rewriting rules are scanned. For example,
23924 .code
23925 hatta@lookingglass.fict.example  *  f
23926 .endd
23927 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23928 &'From:'& headers.
23929
23930 .vindex "&$domain$&"
23931 .vindex "&$local_part$&"
23932 If the replacement string is not a single asterisk, it is expanded, and must
23933 yield a fully qualified address. Within the expansion, the variables
23934 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23935 Any letters they contain retain their original case &-- they are not lower
23936 cased. The numerical variables are set up according to the type of pattern that
23937 matched the address, as described above. If the expansion is forced to fail by
23938 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23939 current rule is abandoned, but subsequent rules may take effect. Any other
23940 expansion failure causes the entire rewriting operation to be abandoned, and an
23941 entry written to the panic log.
23942
23943
23944
23945 .section "Rewriting flags" "SECID153"
23946 There are three different kinds of flag that may appear on rewriting rules:
23947
23948 .ilist
23949 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23950 c, f, h, r, s, t.
23951 .next
23952 A flag that specifies rewriting at SMTP time: S.
23953 .next
23954 Flags that control the rewriting process: Q, q, R, w.
23955 .endlist
23956
23957 For rules that are part of the &%headers_rewrite%& generic transport option,
23958 E, F, T, and S are not permitted.
23959
23960
23961
23962 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23963          "SECID154"
23964 .cindex "rewriting" "flags"
23965 If none of the following flag letters, nor the &"S"& flag (see section
23966 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23967 and to both the sender and recipient fields of the envelope, whereas a
23968 transport-time rewriting rule just applies to all headers. Otherwise, the
23969 rewriting rule is skipped unless the relevant addresses are being processed.
23970 .display
23971 &`E`&       rewrite all envelope fields
23972 &`F`&       rewrite the envelope From field
23973 &`T`&       rewrite the envelope To field
23974 &`b`&       rewrite the &'Bcc:'& header
23975 &`c`&       rewrite the &'Cc:'& header
23976 &`f`&       rewrite the &'From:'& header
23977 &`h`&       rewrite all headers
23978 &`r`&       rewrite the &'Reply-To:'& header
23979 &`s`&       rewrite the &'Sender:'& header
23980 &`t`&       rewrite the &'To:'& header
23981 .endd
23982 "All headers" means all of the headers listed above that can be selected
23983 individually, plus their &'Resent-'& versions. It does not include
23984 other headers such as &'Subject:'& etc.
23985
23986 You should be particularly careful about rewriting &'Sender:'& headers, and
23987 restrict this to special known cases in your own domains.
23988
23989
23990 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23991 .cindex "SMTP" "rewriting malformed addresses"
23992 .cindex "RCPT" "rewriting argument of"
23993 .cindex "MAIL" "rewriting argument of"
23994 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23995 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23996 before any other processing; even before syntax checking. The pattern is
23997 required to be a regular expression, and it is matched against the whole of the
23998 data for the command, including any surrounding angle brackets.
23999
24000 .vindex "&$domain$&"
24001 .vindex "&$local_part$&"
24002 This form of rewrite rule allows for the handling of addresses that are not
24003 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24004 input). Because the input is not required to be a syntactically valid address,
24005 the variables &$local_part$& and &$domain$& are not available during the
24006 expansion of the replacement string. The result of rewriting replaces the
24007 original address in the MAIL or RCPT command.
24008
24009
24010 .section "Flags controlling the rewriting process" "SECID155"
24011 There are four flags which control the way the rewriting process works. These
24012 take effect only when a rule is invoked, that is, when the address is of the
24013 correct type (matches the flags) and matches the pattern:
24014
24015 .ilist
24016 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24017 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24018 absence of &"Q"& the rewritten address must always include a domain.
24019 .next
24020 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24021 even if no rewriting actually takes place because of a &"fail"& in the
24022 expansion. The &"q"& flag is not effective if the address is of the wrong type
24023 (does not match the flags) or does not match the pattern.
24024 .next
24025 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24026 address, up to ten times. It can be combined with the &"q"& flag, to stop
24027 rewriting once it fails to match (after at least one successful rewrite).
24028 .next
24029 .cindex "rewriting" "whole addresses"
24030 When an address in a header is rewritten, the rewriting normally applies only
24031 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24032 left unchanged. For example, rewriting might change
24033 .code
24034 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24035 .endd
24036 into
24037 .code
24038 From: Ford Prefect <prefectf@hitch.fict.example>
24039 .endd
24040 .cindex "RFC 2047"
24041 Sometimes there is a need to replace the whole address item, and this can be
24042 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24043 causes an address in a header line to be rewritten, the entire address is
24044 replaced, not just the working part. The replacement must be a complete RFC
24045 2822 address, including the angle brackets if necessary. If text outside angle
24046 brackets contains a character whose value is greater than 126 or less than 32
24047 (except for tab), the text is encoded according to RFC 2047. The character set
24048 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
24049
24050 When the &"w"& flag is set on a rule that causes an envelope address to be
24051 rewritten, all but the working part of the replacement address is discarded.
24052 .endlist
24053
24054
24055 .section "Rewriting examples" "SECID156"
24056 Here is an example of the two common rewriting paradigms:
24057 .code
24058 *@*.hitch.fict.example  $1@hitch.fict.example
24059 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24060                      {$value}fail}@hitch.fict.example bctfrF
24061 .endd
24062 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24063 the string expansion to fail if the lookup does not succeed. In this context it
24064 has the effect of leaving the original address unchanged, but Exim goes on to
24065 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24066 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24067 explicitly, which would cause the rewritten address to be the same as before,
24068 at the cost of a small bit of processing. Not supplying either of these is an
24069 error, since the rewritten address would then contain no local part.
24070
24071 The first example above replaces the domain with a superior, more general
24072 domain. This may not be desirable for certain local parts. If the rule
24073 .code
24074 root@*.hitch.fict.example  *
24075 .endd
24076 were inserted before the first rule, rewriting would be suppressed for the
24077 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24078
24079 Rewriting can be made conditional on a number of tests, by making use of
24080 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24081 messages that originate outside the local host:
24082 .code
24083 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24084                          {$1@hitch.fict.example}fail}"
24085 .endd
24086 The replacement string is quoted in this example because it contains white
24087 space.
24088
24089 .cindex "rewriting" "bang paths"
24090 .cindex "bang paths" "rewriting"
24091 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24092 an address it treats it as an unqualified local part which it qualifies with
24093 the local qualification domain (if the source of the message is local or if the
24094 remote host is permitted to send unqualified addresses). Rewriting can
24095 sometimes be used to handle simple bang paths with a fixed number of
24096 components. For example, the rule
24097 .code
24098 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24099 .endd
24100 rewrites a two-component bang path &'host.name!user'& as the domain address
24101 &'user@host.name'&. However, there is a security implication in using this as
24102 a global rewriting rule for envelope addresses. It can provide a backdoor
24103 method for using your system as a relay, because the incoming addresses appear
24104 to be local. If the bang path addresses are received via SMTP, it is safer to
24105 use the &"S"& flag to rewrite them as they are received, so that relay checking
24106 can be done on the rewritten addresses.
24107 .ecindex IIDaddrew
24108
24109
24110
24111
24112
24113 . ////////////////////////////////////////////////////////////////////////////
24114 . ////////////////////////////////////////////////////////////////////////////
24115
24116 .chapter "Retry configuration" "CHAPretry"
24117 .scindex IIDretconf1 "retry" "configuration, description of"
24118 .scindex IIDregconf2 "configuration file" "retry section"
24119 The &"retry"& section of the runtime configuration file contains a list of
24120 retry rules that control how often Exim tries to deliver messages that cannot
24121 be delivered at the first attempt. If there are no retry rules (the section is
24122 empty or not present), there are no retries. In this situation, temporary
24123 errors are treated as permanent. The default configuration contains a single,
24124 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24125 line option can be used to test which retry rule will be used for a given
24126 address, domain and error.
24127
24128 The most common cause of retries is temporary failure to deliver to a remote
24129 host because the host is down, or inaccessible because of a network problem.
24130 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24131 address) basis, not on a per-message basis. Thus, if one message has recently
24132 been delayed, delivery of a new message to the same host is not immediately
24133 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24134 log selector is set, the message
24135 .cindex "retry" "time not reached"
24136 &"retry time not reached"& is written to the main log whenever a delivery is
24137 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24138 the handling of errors during remote deliveries.
24139
24140 Retry processing applies to routing as well as to delivering, except as covered
24141 in the next paragraph. The retry rules do not distinguish between these
24142 actions. It is not possible, for example, to specify different behaviour for
24143 failures to route the domain &'snark.fict.example'& and failures to deliver to
24144 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24145 added complication, so did not implement it. However, although they share the
24146 same retry rule, the actual retry times for routing and transporting a given
24147 domain are maintained independently.
24148
24149 When a delivery is not part of a queue run (typically an immediate delivery on
24150 receipt of a message), the routers are always run, and local deliveries are
24151 always attempted, even if retry times are set for them. This makes for better
24152 behaviour if one particular message is causing problems (for example, causing
24153 quota overflow, or provoking an error in a filter file). If such a delivery
24154 suffers a temporary failure, the retry data is updated as normal, and
24155 subsequent delivery attempts from queue runs occur only when the retry time for
24156 the local address is reached.
24157
24158 .section "Changing retry rules" "SECID157"
24159 If you change the retry rules in your configuration, you should consider
24160 whether or not to delete the retry data that is stored in Exim's spool area in
24161 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24162 always safe; that is why they are called &"hints"&.
24163
24164 The hints retry data contains suggested retry times based on the previous
24165 rules. In the case of a long-running problem with a remote host, it might
24166 record the fact that the host has timed out. If your new rules increase the
24167 timeout time for such a host, you should definitely remove the old retry data
24168 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24169 messages that it should now be retaining.
24170
24171
24172
24173 .section "Format of retry rules" "SECID158"
24174 .cindex "retry" "rules"
24175 Each retry rule occupies one line and consists of three or four parts,
24176 separated by white space: a pattern, an error name, an optional list of sender
24177 addresses, and a list of retry parameters. The pattern and sender lists must be
24178 enclosed in double quotes if they contain white space. The rules are searched
24179 in order until one is found where the pattern, error name, and sender list (if
24180 present) match the failing host or address, the error that occurred, and the
24181 message's sender, respectively.
24182
24183
24184 The pattern is any single item that may appear in an address list (see section
24185 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24186 which means that it is expanded before being tested against the address that
24187 has been delayed. A negated address list item is permitted. Address
24188 list processing treats a plain domain name as if it were preceded by &"*@"&,
24189 which makes it possible for many retry rules to start with just a domain. For
24190 example,
24191 .code
24192 lookingglass.fict.example        *  F,24h,30m;
24193 .endd
24194 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24195 whereas
24196 .code
24197 alice@lookingglass.fict.example  *  F,24h,30m;
24198 .endd
24199 applies only to temporary failures involving the local part &%alice%&.
24200 In practice, almost all rules start with a domain name pattern without a local
24201 part.
24202
24203 .cindex "regular expressions" "in retry rules"
24204 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24205 must match a complete address, not just a domain, because that is how regular
24206 expressions work in address lists.
24207 .display
24208 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24209 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24210 .endd
24211
24212
24213 .section "Choosing which retry rule to use for address errors" "SECID159"
24214 When Exim is looking for a retry rule after a routing attempt has failed (for
24215 example, after a DNS timeout), each line in the retry configuration is tested
24216 against the complete address only if &%retry_use_local_part%& is set for the
24217 router. Otherwise, only the domain is used, except when matching against a
24218 regular expression, when the local part of the address is replaced with &"*"&.
24219 A domain on its own can match a domain pattern, or a pattern that starts with
24220 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24221 &%check_local_user%& is true, and false for other routers.
24222
24223 Similarly, when Exim is looking for a retry rule after a local delivery has
24224 failed (for example, after a mailbox full error), each line in the retry
24225 configuration is tested against the complete address only if
24226 &%retry_use_local_part%& is set for the transport (it defaults true for all
24227 local transports).
24228
24229 .cindex "4&'xx'& responses" "retry rules for"
24230 However, when Exim is looking for a retry rule after a remote delivery attempt
24231 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24232 whole address is always used as the key when searching the retry rules. The
24233 rule that is found is used to create a retry time for the combination of the
24234 failing address and the message's sender. It is the combination of sender and
24235 recipient that is delayed in subsequent queue runs until its retry time is
24236 reached. You can delay the recipient without regard to the sender by setting
24237 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24238 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24239 commands.
24240
24241
24242
24243 .section "Choosing which retry rule to use for host and message errors" &&&
24244          "SECID160"
24245 For a temporary error that is not related to an individual address (for
24246 example, a connection timeout), each line in the retry configuration is checked
24247 twice. First, the name of the remote host is used as a domain name (preceded by
24248 &"*@"& when matching a regular expression). If this does not match the line,
24249 the domain from the email address is tried in a similar fashion. For example,
24250 suppose the MX records for &'a.b.c.example'& are
24251 .code
24252 a.b.c.example  MX  5  x.y.z.example
24253                MX  6  p.q.r.example
24254                MX  7  m.n.o.example
24255 .endd
24256 and the retry rules are
24257 .code
24258 p.q.r.example    *      F,24h,30m;
24259 a.b.c.example    *      F,4d,45m;
24260 .endd
24261 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24262 first rule matches neither the host nor the domain, so Exim looks at the second
24263 rule. This does not match the host, but it does match the domain, so it is used
24264 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24265 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24266 first retry rule is used, because it matches the host.
24267
24268 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24269 first rule to determine retry times, but for all the other hosts for the domain
24270 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24271 routing to &'a.b.c.example'& suffers a temporary failure.
24272
24273 &*Note*&: The host name is used when matching the patterns, not its IP address.
24274 However, if a message is routed directly to an IP address without the use of a
24275 host name, for example, if a &(manualroute)& router contains a setting such as:
24276 .code
24277 route_list = *.a.example  192.168.34.23
24278 .endd
24279 then the &"host name"& that is used when searching for a retry rule is the
24280 textual form of the IP address.
24281
24282 .section "Retry rules for specific errors" "SECID161"
24283 .cindex "retry" "specific errors; specifying"
24284 The second field in a retry rule is the name of a particular error, or an
24285 asterisk, which matches any error. The errors that can be tested for are:
24286
24287 .vlist
24288 .vitem &%auth_failed%&
24289 Authentication failed when trying to send to a host in the
24290 &%hosts_require_auth%& list in an &(smtp)& transport.
24291
24292 .vitem &%data_4xx%&
24293 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24294 after the command, or after sending the message's data.
24295
24296 .vitem &%mail_4xx%&
24297 A 4&'xx'& error was received for an outgoing MAIL command.
24298
24299 .vitem &%rcpt_4xx%&
24300 A 4&'xx'& error was received for an outgoing RCPT command.
24301 .endlist
24302
24303 For the three 4&'xx'& errors, either the first or both of the x's can be given
24304 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24305 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24306 and have retries every ten minutes with a one-hour timeout, you could set up a
24307 retry rule of this form:
24308 .code
24309 the.domain.name  rcpt_452   F,1h,10m
24310 .endd
24311 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24312 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24313
24314 .vlist
24315 .vitem &%lost_connection%&
24316 A server unexpectedly closed the SMTP connection. There may, of course,
24317 legitimate reasons for this (host died, network died), but if it repeats a lot
24318 for the same host, it indicates something odd.
24319
24320 .vitem &%refused_MX%&
24321 A connection to a host obtained from an MX record was refused.
24322
24323 .vitem &%refused_A%&
24324 A connection to a host not obtained from an MX record was refused.
24325
24326 .vitem &%refused%&
24327 A connection was refused.
24328
24329 .vitem &%timeout_connect_MX%&
24330 A connection attempt to a host obtained from an MX record timed out.
24331
24332 .vitem &%timeout_connect_A%&
24333 A connection attempt to a host not obtained from an MX record timed out.
24334
24335 .vitem &%timeout_connect%&
24336 A connection attempt timed out.
24337
24338 .vitem &%timeout_MX%&
24339 There was a timeout while connecting or during an SMTP session with a host
24340 obtained from an MX record.
24341
24342 .vitem &%timeout_A%&
24343 There was a timeout while connecting or during an SMTP session with a host not
24344 obtained from an MX record.
24345
24346 .vitem &%timeout%&
24347 There was a timeout while connecting or during an SMTP session.
24348
24349 .vitem &%tls_required%&
24350 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24351 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24352 to STARTTLS, or there was a problem setting up the TLS connection.
24353
24354 .vitem &%quota%&
24355 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24356 transport.
24357
24358 .vitem &%quota_%&<&'time'&>
24359 .cindex "quota" "error testing in retry rule"
24360 .cindex "retry" "quota error testing"
24361 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24362 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24363 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24364 for four days.
24365 .endlist
24366
24367 .cindex "mailbox" "time of last read"
24368 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24369 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24370 it should be based on the last time that the user accessed the mailbox.
24371 However, it is not always possible to determine this. Exim uses the following
24372 heuristic rules:
24373
24374 .ilist
24375 If the mailbox is a single file, the time of last access (the &"atime"&) is
24376 used. As no new messages are being delivered (because the mailbox is over
24377 quota), Exim does not access the file, so this is the time of last user access.
24378 .next
24379 .cindex "maildir format" "time of last read"
24380 For a maildir delivery, the time of last modification of the &_new_&
24381 subdirectory is used. As the mailbox is over quota, no new files are created in
24382 the &_new_& subdirectory, because no new messages are being delivered. Any
24383 change to the &_new_& subdirectory is therefore assumed to be the result of an
24384 MUA moving a new message to the &_cur_& directory when it is first read. The
24385 time that is used is therefore the last time that the user read a new message.
24386 .next
24387 For other kinds of multi-file mailbox, the time of last access cannot be
24388 obtained, so a retry rule that uses this type of error field is never matched.
24389 .endlist
24390
24391 The quota errors apply both to system-enforced quotas and to Exim's own quota
24392 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24393 when a local delivery is deferred because a partition is full (the ENOSPC
24394 error).
24395
24396
24397
24398 .section "Retry rules for specified senders" "SECID162"
24399 .cindex "retry" "rules; sender-specific"
24400 You can specify retry rules that apply only when the failing message has a
24401 specific sender. In particular, this can be used to define retry rules that
24402 apply only to bounce messages. The third item in a retry rule can be of this
24403 form:
24404 .display
24405 &`senders=`&<&'address list'&>
24406 .endd
24407 The retry timings themselves are then the fourth item. For example:
24408 .code
24409 *   rcpt_4xx   senders=:   F,1h,30m
24410 .endd
24411 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24412 host. If the address list contains white space, it must be enclosed in quotes.
24413 For example:
24414 .code
24415 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24416 .endd
24417 &*Warning*&: This facility can be unhelpful if it is used for host errors
24418 (which do not depend on the recipient). The reason is that the sender is used
24419 only to match the retry rule. Once the rule has been found for a host error,
24420 its contents are used to set a retry time for the host, and this will apply to
24421 all messages, not just those with specific senders.
24422
24423 When testing retry rules using &%-brt%&, you can supply a sender using the
24424 &%-f%& command line option, like this:
24425 .code
24426 exim -f "" -brt user@dom.ain
24427 .endd
24428 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24429 list is never matched.
24430
24431
24432
24433
24434
24435 .section "Retry parameters" "SECID163"
24436 .cindex "retry" "parameters in rules"
24437 The third (or fourth, if a senders list is present) field in a retry rule is a
24438 sequence of retry parameter sets, separated by semicolons. Each set consists of
24439 .display
24440 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24441 .endd
24442 The letter identifies the algorithm for computing a new retry time; the cutoff
24443 time is the time beyond which this algorithm no longer applies, and the
24444 arguments vary the algorithm's action. The cutoff time is measured from the
24445 time that the first failure for the domain (combined with the local part if
24446 relevant) was detected, not from the time the message was received.
24447
24448 .cindex "retry" "algorithms"
24449 .cindex "retry" "fixed intervals"
24450 .cindex "retry" "increasing intervals"
24451 .cindex "retry" "random intervals"
24452 The available algorithms are:
24453
24454 .ilist
24455 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24456 the interval.
24457 .next
24458 &'G'&: retry at geometrically increasing intervals. The first argument
24459 specifies a starting value for the interval, and the second a multiplier, which
24460 is used to increase the size of the interval at each retry.
24461 .next
24462 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24463 retry, the previous interval is multiplied by the factor in order to get a
24464 maximum for the next interval. The minimum interval is the first argument of
24465 the parameter, and an actual interval is chosen randomly between them. Such a
24466 rule has been found to be helpful in cluster configurations when all the
24467 members of the cluster restart at once, and may therefore synchronize their
24468 queue processing times.
24469 .endlist
24470
24471 When computing the next retry time, the algorithm definitions are scanned in
24472 order until one whose cutoff time has not yet passed is reached. This is then
24473 used to compute a new retry time that is later than the current time. In the
24474 case of fixed interval retries, this simply means adding the interval to the
24475 current time. For geometrically increasing intervals, retry intervals are
24476 computed from the rule's parameters until one that is greater than the previous
24477 interval is found. The main configuration variable
24478 .cindex "limit" "retry interval"
24479 .cindex "retry" "interval, maximum"
24480 .oindex "&%retry_interval_max%&"
24481 &%retry_interval_max%& limits the maximum interval between retries. It
24482 cannot be set greater than &`24h`&, which is its default value.
24483
24484 A single remote domain may have a number of hosts associated with it, and each
24485 host may have more than one IP address. Retry algorithms are selected on the
24486 basis of the domain name, but are applied to each IP address independently. If,
24487 for example, a host has two IP addresses and one is unusable, Exim will
24488 generate retry times for it and will not try to use it until its next retry
24489 time comes. Thus the good IP address is likely to be tried first most of the
24490 time.
24491
24492 .cindex "hints database" "use for retrying"
24493 Retry times are hints rather than promises. Exim does not make any attempt to
24494 run deliveries exactly at the computed times. Instead, a queue runner process
24495 starts delivery processes for delayed messages periodically, and these attempt
24496 new deliveries only for those addresses that have passed their next retry time.
24497 If a new message arrives for a deferred address, an immediate delivery attempt
24498 occurs only if the address has passed its retry time. In the absence of new
24499 messages, the minimum time between retries is the interval between queue runner
24500 processes. There is not much point in setting retry times of five minutes if
24501 your queue runners happen only once an hour, unless there are a significant
24502 number of incoming messages (which might be the case on a system that is
24503 sending everything to a smart host, for example).
24504
24505 The data in the retry hints database can be inspected by using the
24506 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24507 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24508 &'exinext'& utility script can be used to find out what the next retry times
24509 are for the hosts associated with a particular mail domain, and also for local
24510 deliveries that have been deferred.
24511
24512
24513 .section "Retry rule examples" "SECID164"
24514 Here are some example retry rules:
24515 .code
24516 alice@wonderland.fict.example quota_5d  F,7d,3h
24517 wonderland.fict.example       quota_5d
24518 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24519 lookingglass.fict.example     *         F,24h,30m;
24520 *                 refused_A   F,2h,20m;
24521 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24522 .endd
24523 The first rule sets up special handling for mail to
24524 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24525 mailbox has not been read for at least 5 days. Retries continue every three
24526 hours for 7 days. The second rule handles over-quota errors for all other local
24527 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24528 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24529 fail are bounced immediately if the mailbox has not been read for at least 5
24530 days.
24531
24532 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24533 happen every 15 minutes for an hour, then with geometrically increasing
24534 intervals until two days have passed since a delivery first failed. After the
24535 first hour there is a delay of one hour, then two hours, then four hours, and
24536 so on (this is a rather extreme example).
24537
24538 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24539 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24540 all other domains, with special action for connection refusal from hosts that
24541 were not obtained from an MX record.
24542
24543 The final rule in a retry configuration should always have asterisks in the
24544 first two fields so as to provide a general catch-all for any addresses that do
24545 not have their own special handling. This example tries every 15 minutes for 2
24546 hours, then with intervals starting at one hour and increasing by a factor of
24547 1.5 up to 16 hours, then every 8 hours up to 5 days.
24548
24549
24550
24551 .section "Timeout of retry data" "SECID165"
24552 .cindex "timeout" "of retry data"
24553 .oindex "&%retry_data_expire%&"
24554 .cindex "hints database" "data expiry"
24555 .cindex "retry" "timeout of data"
24556 Exim timestamps the data that it writes to its retry hints database. When it
24557 consults the data during a delivery it ignores any that is older than the value
24558 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24559 been tried for 7 days, Exim will try to deliver to it immediately a message
24560 arrives, and if that fails, it will calculate a retry time as if it were
24561 failing for the first time.
24562
24563 This improves the behaviour for messages routed to rarely-used hosts such as MX
24564 backups. If such a host was down at one time, and happens to be down again when
24565 Exim tries a month later, using the old retry data would imply that it had been
24566 down all the time, which is not a justified assumption.
24567
24568 If a host really is permanently dead, this behaviour causes a burst of retries
24569 every now and again, but only if messages routed to it are rare. If there is a
24570 message at least once every 7 days the retry data never expires.
24571
24572
24573
24574
24575 .section "Long-term failures" "SECID166"
24576 .cindex "delivery failure, long-term"
24577 .cindex "retry" "after long-term failure"
24578 Special processing happens when an email address has been failing for so long
24579 that the cutoff time for the last algorithm is reached. For example, using the
24580 default retry rule:
24581 .code
24582 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24583 .endd
24584 the cutoff time is four days. Reaching the retry cutoff is independent of how
24585 long any specific message has been failing; it is the length of continuous
24586 failure for the recipient address that counts.
24587
24588 When the cutoff time is reached for a local delivery, or for all the IP
24589 addresses associated with a remote delivery, a subsequent delivery failure
24590 causes Exim to give up on the address, and a bounce message is generated.
24591 In order to cater for new messages that use the failing address, a next retry
24592 time is still computed from the final algorithm, and is used as follows:
24593
24594 For local deliveries, one delivery attempt is always made for any subsequent
24595 messages. If this delivery fails, the address fails immediately. The
24596 post-cutoff retry time is not used.
24597
24598 If the delivery is remote, there are two possibilities, controlled by the
24599 .oindex "&%delay_after_cutoff%&"
24600 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24601 default. Until the post-cutoff retry time for one of the IP addresses is
24602 reached, the failing email address is bounced immediately, without a delivery
24603 attempt taking place. After that time, one new delivery attempt is made to
24604 those IP addresses that are past their retry times, and if that still fails,
24605 the address is bounced and new retry times are computed.
24606
24607 In other words, when all the hosts for a given email address have been failing
24608 for a long time, Exim bounces rather then defers until one of the hosts' retry
24609 times is reached. Then it tries once, and bounces if that attempt fails. This
24610 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24611 to a broken destination, but if the host does recover, Exim will eventually
24612 notice.
24613
24614 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24615 addresses are past their final cutoff time, Exim tries to deliver to those IP
24616 addresses that have not been tried since the message arrived. If there are
24617 no suitable IP addresses, or if they all fail, the address is bounced. In other
24618 words, it does not delay when a new message arrives, but tries the expired
24619 addresses immediately, unless they have been tried since the message arrived.
24620 If there is a continuous stream of messages for the failing domains, setting
24621 &%delay_after_cutoff%& false means that there will be many more attempts to
24622 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24623 true.
24624
24625 .section "Deliveries that work intermittently" "SECID167"
24626 .cindex "retry" "intermittently working deliveries"
24627 Some additional logic is needed to cope with cases where a host is
24628 intermittently available, or when a message has some attribute that prevents
24629 its delivery when others to the same address get through. In this situation,
24630 because some messages are successfully delivered, the &"retry clock"& for the
24631 host or address keeps getting reset by the successful deliveries, and so
24632 failing messages remain on the queue for ever because the cutoff time is never
24633 reached.
24634
24635 Two exceptional actions are applied to prevent this happening. The first
24636 applies to errors that are related to a message rather than a remote host.
24637 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24638 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24639 commands, and quota failures. For this type of error, if a message's arrival
24640 time is earlier than the &"first failed"& time for the error, the earlier time
24641 is used when scanning the retry rules to decide when to try next and when to
24642 time out the address.
24643
24644 The exceptional second action applies in all cases. If a message has been on
24645 the queue for longer than the cutoff time of any applicable retry rule for a
24646 given address, a delivery is attempted for that address, even if it is not yet
24647 time, and if this delivery fails, the address is timed out. A new retry time is
24648 not computed in this case, so that other messages for the same address are
24649 considered immediately.
24650 .ecindex IIDretconf1
24651 .ecindex IIDregconf2
24652
24653
24654
24655
24656
24657
24658 . ////////////////////////////////////////////////////////////////////////////
24659 . ////////////////////////////////////////////////////////////////////////////
24660
24661 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24662 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24663 .scindex IIDauthconf2 "authentication"
24664 The &"authenticators"& section of Exim's run time configuration is concerned
24665 with SMTP authentication. This facility is an extension to the SMTP protocol,
24666 described in RFC 2554, which allows a client SMTP host to authenticate itself
24667 to a server. This is a common way for a server to recognize clients that are
24668 permitted to use it as a relay. SMTP authentication is not of relevance to the
24669 transfer of mail between servers that have no managerial connection with each
24670 other.
24671
24672 .cindex "AUTH" "description of"
24673 Very briefly, the way SMTP authentication works is as follows:
24674
24675 .ilist
24676 The server advertises a number of authentication &'mechanisms'& in response to
24677 the client's EHLO command.
24678 .next
24679 The client issues an AUTH command, naming a specific mechanism. The command
24680 may, optionally, contain some authentication data.
24681 .next
24682 The server may issue one or more &'challenges'&, to which the client must send
24683 appropriate responses. In simple authentication mechanisms, the challenges are
24684 just prompts for user names and passwords. The server does not have to issue
24685 any challenges &-- in some mechanisms the relevant data may all be transmitted
24686 with the AUTH command.
24687 .next
24688 The server either accepts or denies authentication.
24689 .next
24690 If authentication succeeds, the client may optionally make use of the AUTH
24691 option on the MAIL command to pass an authenticated sender in subsequent
24692 mail transactions. Authentication lasts for the remainder of the SMTP
24693 connection.
24694 .next
24695 If authentication fails, the client may give up, or it may try a different
24696 authentication mechanism, or it may try transferring mail over the
24697 unauthenticated connection.
24698 .endlist
24699
24700 If you are setting up a client, and want to know which authentication
24701 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24702 SMTP port) on the server, and issue an EHLO command. The response to this
24703 includes the list of supported mechanisms. For example:
24704 .display
24705 &`$ `&&*&`telnet server.example 25`&*&
24706 &`Trying 192.168.34.25...`&
24707 &`Connected to server.example.`&
24708 &`Escape character is &#x0027;^]&#x0027;.`&
24709 &`220 server.example ESMTP Exim 4.20 ...`&
24710 &*&`ehlo client.example`&*&
24711 &`250-server.example Hello client.example [10.8.4.5]`&
24712 &`250-SIZE 52428800`&
24713 &`250-PIPELINING`&
24714 &`250-AUTH PLAIN`&
24715 &`250 HELP`&
24716 .endd
24717 The second-last line of this example output shows that the server supports
24718 authentication using the PLAIN mechanism. In Exim, the different authentication
24719 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24720 routers and transports, which authenticators are included in the binary is
24721 controlled by build-time definitions. The following are currently available,
24722 included by setting
24723 .code
24724 AUTH_CRAM_MD5=yes
24725 AUTH_CYRUS_SASL=yes
24726 AUTH_DOVECOT=yes
24727 AUTH_GSASL=yes
24728 AUTH_HEIMDAL_GSSAPI=yes
24729 AUTH_PLAINTEXT=yes
24730 AUTH_SPA=yes
24731 .endd
24732 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24733 authentication mechanism (RFC 2195), and the second provides an interface to
24734 the Cyrus SASL authentication library.
24735 The third is an interface to Dovecot's authentication system, delegating the
24736 work via a socket interface.
24737 The fourth provides an interface to the GNU SASL authentication library, which
24738 provides mechanisms but typically not data sources.
24739 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24740 supporting setting a server keytab.
24741 The sixth can be configured to support
24742 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24743 not formally documented, but used by several MUAs. The seventh authenticator
24744 supports Microsoft's &'Secure Password Authentication'& mechanism.
24745
24746 The authenticators are configured using the same syntax as other drivers (see
24747 section &<<SECTfordricon>>&). If no authenticators are required, no
24748 authentication section need be present in the configuration file. Each
24749 authenticator can in principle have both server and client functions. When Exim
24750 is receiving SMTP mail, it is acting as a server; when it is sending out
24751 messages over SMTP, it is acting as a client. Authenticator configuration
24752 options are provided for use in both these circumstances.
24753
24754 To make it clear which options apply to which situation, the prefixes
24755 &%server_%& and &%client_%& are used on option names that are specific to
24756 either the server or the client function, respectively. Server and client
24757 functions are disabled if none of their options are set. If an authenticator is
24758 to be used for both server and client functions, a single definition, using
24759 both sets of options, is required. For example:
24760 .code
24761 cram:
24762   driver = cram_md5
24763   public_name = CRAM-MD5
24764   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24765   client_name = ph10
24766   client_secret = secret2
24767 .endd
24768 The &%server_%& option is used when Exim is acting as a server, and the
24769 &%client_%& options when it is acting as a client.
24770
24771 Descriptions of the individual authenticators are given in subsequent chapters.
24772 The remainder of this chapter covers the generic options for the
24773 authenticators, followed by general discussion of the way authentication works
24774 in Exim.
24775
24776 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24777 per-mechanism basis.  Please read carefully to determine which variables hold
24778 account labels such as usercodes and which hold passwords or other
24779 authenticating data.
24780
24781 Note that some mechanisms support two different identifiers for accounts: the
24782 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24783 and &'authz'& are commonly encountered.  The American spelling is standard here.
24784 Conceptually, authentication data such as passwords are tied to the identifier
24785 used to authenticate; servers may have rules to permit one user to act as a
24786 second user, so that after login the session is treated as though that second
24787 user had logged in.  That second user is the &'authorization id'&.  A robust
24788 configuration might confirm that the &'authz'& field is empty or matches the
24789 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24790 as verified data, the &'authz'& as an unverified request which the server might
24791 choose to honour.
24792
24793 A &'realm'& is a text string, typically a domain name, presented by a server
24794 to a client to help it select an account and credentials to use.  In some
24795 mechanisms, the client and server provably agree on the realm, but clients
24796 typically can not treat the realm as secure data to be blindly trusted.
24797
24798
24799
24800 .section "Generic options for authenticators" "SECID168"
24801 .cindex "authentication" "generic options"
24802 .cindex "options" "generic; for authenticators"
24803
24804 .option client_condition authenticators string&!! unset
24805 When Exim is authenticating as a client, it skips any authenticator whose
24806 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24807 used, for example, to skip plain text authenticators when the connection is not
24808 encrypted by a setting such as:
24809 .code
24810 client_condition = ${if !eq{$tls_out_cipher}{}}
24811 .endd
24812
24813
24814 .option client_set_id authenticators string&!! unset
24815 When client authentication succeeds, this condition is expanded; the
24816 result is used in the log lines for outbound messasges.
24817 Typically it will be the user name used for authentication.
24818
24819
24820 .option driver authenticators string unset
24821 This option must always be set. It specifies which of the available
24822 authenticators is to be used.
24823
24824
24825 .option public_name authenticators string unset
24826 This option specifies the name of the authentication mechanism that the driver
24827 implements, and by which it is known to the outside world. These names should
24828 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24829 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24830 defaults to the driver's instance name.
24831
24832
24833 .option server_advertise_condition authenticators string&!! unset
24834 When a server is about to advertise an authentication mechanism, the condition
24835 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24836 mechanism is not advertised.
24837 If the expansion fails, the mechanism is not advertised. If the failure was not
24838 forced, and was not caused by a lookup defer, the incident is logged.
24839 See section &<<SECTauthexiser>>& below for further discussion.
24840
24841
24842 .option server_condition authenticators string&!! unset
24843 This option must be set for a &%plaintext%& server authenticator, where it
24844 is used directly to control authentication. See section &<<SECTplainserver>>&
24845 for details.
24846
24847 For the &(gsasl)& authenticator, this option is required for various
24848 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24849
24850 For the other authenticators, &%server_condition%& can be used as an additional
24851 authentication or authorization mechanism that is applied after the other
24852 authenticator conditions succeed. If it is set, it is expanded when the
24853 authenticator would otherwise return a success code. If the expansion is forced
24854 to fail, authentication fails. Any other expansion failure causes a temporary
24855 error code to be returned. If the result of a successful expansion is an empty
24856 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24857 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24858 other result, a temporary error code is returned, with the expanded string as
24859 the error text.
24860
24861
24862 .option server_debug_print authenticators string&!! unset
24863 If this option is set and authentication debugging is enabled (see the &%-d%&
24864 command line option), the string is expanded and included in the debugging
24865 output when the authenticator is run as a server. This can help with checking
24866 out the values of variables.
24867 If expansion of the string fails, the error message is written to the debugging
24868 output, and Exim carries on processing.
24869
24870
24871 .option server_set_id authenticators string&!! unset
24872 .vindex "&$authenticated_id$&"
24873 When an Exim server successfully authenticates a client, this string is
24874 expanded using data from the authentication, and preserved for any incoming
24875 messages in the variable &$authenticated_id$&. It is also included in the log
24876 lines for incoming messages. For example, a user/password authenticator
24877 configuration might preserve the user name that was used to authenticate, and
24878 refer to it subsequently during delivery of the message.
24879 If expansion fails, the option is ignored.
24880
24881
24882 .option server_mail_auth_condition authenticators string&!! unset
24883 This option allows a server to discard authenticated sender addresses supplied
24884 as part of MAIL commands in SMTP connections that are authenticated by the
24885 driver on which &%server_mail_auth_condition%& is set. The option is not used
24886 as part of the authentication process; instead its (unexpanded) value is
24887 remembered for later use.
24888 How it is used is described in the following section.
24889
24890
24891
24892
24893
24894 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24895 .cindex "authentication" "sender; authenticated"
24896 .cindex "AUTH" "on MAIL command"
24897 When a client supplied an AUTH= item on a MAIL command, Exim applies
24898 the following checks before accepting it as the authenticated sender of the
24899 message:
24900
24901 .ilist
24902 If the connection is not using extended SMTP (that is, HELO was used rather
24903 than EHLO), the use of AUTH= is a syntax error.
24904 .next
24905 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24906 .next
24907 .vindex "&$authenticated_sender$&"
24908 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24909 running, the value of &$authenticated_sender$& is set to the value obtained
24910 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24911 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24912 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24913 given for the MAIL command.
24914 .next
24915 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24916 is accepted and placed in &$authenticated_sender$& only if the client has
24917 authenticated.
24918 .next
24919 If the AUTH= value was accepted by either of the two previous rules, and
24920 the client has authenticated, and the authenticator has a setting for the
24921 &%server_mail_auth_condition%&, the condition is checked at this point. The
24922 valued that was saved from the authenticator is expanded. If the expansion
24923 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24924 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24925 the value of &$authenticated_sender$& is retained and passed on with the
24926 message.
24927 .endlist
24928
24929
24930 When &$authenticated_sender$& is set for a message, it is passed on to other
24931 hosts to which Exim authenticates as a client. Do not confuse this value with
24932 &$authenticated_id$&, which is a string obtained from the authentication
24933 process, and which is not usually a complete email address.
24934
24935 .vindex "&$sender_address$&"
24936 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24937 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24938 therefore make use of &$authenticated_sender$&. The converse is not true: the
24939 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24940 ACL is run.
24941
24942
24943
24944 .section "Authentication on an Exim server" "SECTauthexiser"
24945 .cindex "authentication" "on an Exim server"
24946 When Exim receives an EHLO command, it advertises the public names of those
24947 authenticators that are configured as servers, subject to the following
24948 conditions:
24949
24950 .ilist
24951 The client host must match &%auth_advertise_hosts%& (default *).
24952 .next
24953 It the &%server_advertise_condition%& option is set, its expansion must not
24954 yield the empty string, &"0"&, &"no"&, or &"false"&.
24955 .endlist
24956
24957 The order in which the authenticators are defined controls the order in which
24958 the mechanisms are advertised.
24959
24960 Some mail clients (for example, some versions of Netscape) require the user to
24961 provide a name and password for authentication whenever AUTH is advertised,
24962 even though authentication may not in fact be needed (for example, Exim may be
24963 set up to allow unconditional relaying from the client by an IP address check).
24964 You can make such clients more friendly by not advertising AUTH to them.
24965 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24966 that runs for RCPT) to relay without authentication, you should set
24967 .code
24968 auth_advertise_hosts = ! 10.9.8.0/24
24969 .endd
24970 so that no authentication mechanisms are advertised to them.
24971
24972 The &%server_advertise_condition%& controls the advertisement of individual
24973 authentication mechanisms. For example, it can be used to restrict the
24974 advertisement of a particular mechanism to encrypted connections, by a setting
24975 such as:
24976 .code
24977 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24978 .endd
24979 .vindex "&$tls_in_cipher$&"
24980 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24981 yields &"yes"&, which allows the advertisement to happen.
24982
24983 When an Exim server receives an AUTH command from a client, it rejects it
24984 immediately if AUTH was not advertised in response to an earlier EHLO
24985 command. This is the case if
24986
24987 .ilist
24988 The client host does not match &%auth_advertise_hosts%&; or
24989 .next
24990 No authenticators are configured with server options; or
24991 .next
24992 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24993 server authenticators.
24994 .endlist
24995
24996
24997 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24998 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24999 AUTH is accepted from any client host.
25000
25001 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25002 server authentication mechanism that was advertised in response to EHLO and
25003 that matches the one named in the AUTH command. If it finds one, it runs
25004 the appropriate authentication protocol, and authentication either succeeds or
25005 fails. If there is no matching advertised mechanism, the AUTH command is
25006 rejected with a 504 error.
25007
25008 .vindex "&$received_protocol$&"
25009 .vindex "&$sender_host_authenticated$&"
25010 When a message is received from an authenticated host, the value of
25011 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25012 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25013 public name) of the authenticator driver that successfully authenticated the
25014 client from which the message was received. This variable is empty if there was
25015 no successful authentication.
25016
25017
25018
25019
25020 .section "Testing server authentication" "SECID169"
25021 .cindex "authentication" "testing a server"
25022 .cindex "AUTH" "testing a server"
25023 .cindex "base64 encoding" "creating authentication test data"
25024 Exim's &%-bh%& option can be useful for testing server authentication
25025 configurations. The data for the AUTH command has to be sent using base64
25026 encoding. A quick way to produce such data for testing is the following Perl
25027 script:
25028 .code
25029 use MIME::Base64;
25030 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25031 .endd
25032 .cindex "binary zero" "in authentication data"
25033 This interprets its argument as a Perl string, and then encodes it. The
25034 interpretation as a Perl string allows binary zeros, which are required for
25035 some kinds of authentication, to be included in the data. For example, a
25036 command line to run this script on such data might be
25037 .code
25038 encode '\0user\0password'
25039 .endd
25040 Note the use of single quotes to prevent the shell interpreting the
25041 backslashes, so that they can be interpreted by Perl to specify characters
25042 whose code value is zero.
25043
25044 &*Warning 1*&: If either of the user or password strings starts with an octal
25045 digit, you must use three zeros instead of one after the leading backslash. If
25046 you do not, the octal digit that starts your string will be incorrectly
25047 interpreted as part of the code for the first character.
25048
25049 &*Warning 2*&: If there are characters in the strings that Perl interprets
25050 specially, you must use a Perl escape to prevent them being misinterpreted. For
25051 example, a command such as
25052 .code
25053 encode '\0user@domain.com\0pas$$word'
25054 .endd
25055 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25056
25057 If you have the &%mimencode%& command installed, another way to do produce
25058 base64-encoded strings is to run the command
25059 .code
25060 echo -e -n `\0user\0password' | mimencode
25061 .endd
25062 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25063 in the argument, and the &%-n%& option specifies no newline at the end of its
25064 output. However, not all versions of &%echo%& recognize these options, so you
25065 should check your version before relying on this suggestion.
25066
25067
25068
25069 .section "Authentication by an Exim client" "SECID170"
25070 .cindex "authentication" "on an Exim client"
25071 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25072 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25073 announces support for authentication, and the host matches an entry in either
25074 of these options, Exim (as a client) tries to authenticate as follows:
25075
25076 .ilist
25077 For each authenticator that is configured as a client, in the order in which
25078 they are defined in the configuration, it searches the authentication
25079 mechanisms announced by the server for one whose name matches the public name
25080 of the authenticator.
25081 .next
25082 .vindex "&$host$&"
25083 .vindex "&$host_address$&"
25084 When it finds one that matches, it runs the authenticator's client code. The
25085 variables &$host$& and &$host_address$& are available for any string expansions
25086 that the client might do. They are set to the server's name and IP address. If
25087 any expansion is forced to fail, the authentication attempt is abandoned, and
25088 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25089 delivery to be deferred.
25090 .next
25091 If the result of the authentication attempt is a temporary error or a timeout,
25092 Exim abandons trying to send the message to the host for the moment. It will
25093 try again later. If there are any backup hosts available, they are tried in the
25094 usual way.
25095 .next
25096 If the response to authentication is a permanent error (5&'xx'& code), Exim
25097 carries on searching the list of authenticators and tries another one if
25098 possible. If all authentication attempts give permanent errors, or if there are
25099 no attempts because no mechanisms match (or option expansions force failure),
25100 what happens depends on whether the host matches &%hosts_require_auth%& or
25101 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25102 delivery is deferred. The error can be detected in the retry rules, and thereby
25103 turned into a permanent error if you wish. In the second case, Exim tries to
25104 deliver the message unauthenticated.
25105 .endlist
25106
25107 .cindex "AUTH" "on MAIL command"
25108 When Exim has authenticated itself to a remote server, it adds the AUTH
25109 parameter to the MAIL commands it sends, if it has an authenticated sender for
25110 the message. If the message came from a remote host, the authenticated sender
25111 is the one that was receiving on an incoming MAIL command, provided that the
25112 incoming connection was authenticated and the &%server_mail_auth%& condition
25113 allowed the authenticated sender to be retained. If a local process calls Exim
25114 to send a message, the sender address that is built from the login name and
25115 &%qualify_domain%& is treated as authenticated. However, if the
25116 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25117 the authenticated sender that was received with the message.
25118 .ecindex IIDauthconf1
25119 .ecindex IIDauthconf2
25120
25121
25122
25123
25124
25125
25126 . ////////////////////////////////////////////////////////////////////////////
25127 . ////////////////////////////////////////////////////////////////////////////
25128
25129 .chapter "The plaintext authenticator" "CHAPplaintext"
25130 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25131 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25132 The &(plaintext)& authenticator can be configured to support the PLAIN and
25133 LOGIN authentication mechanisms, both of which transfer authentication data as
25134 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25135 security risk; you are strongly advised to insist on the use of SMTP encryption
25136 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25137 use unencrypted plain text, you should not use the same passwords for SMTP
25138 connections as you do for login accounts.
25139
25140 .section "Plaintext options" "SECID171"
25141 .cindex "options" "&(plaintext)& authenticator (server)"
25142 When configured as a server, &(plaintext)& uses the following options:
25143
25144 .option server_condition authenticators string&!! unset
25145 This is actually a global authentication option, but it must be set in order to
25146 configure the &(plaintext)& driver as a server. Its use is described below.
25147
25148 .option server_prompts plaintext string&!! unset
25149 The contents of this option, after expansion, must be a colon-separated list of
25150 prompt strings. If expansion fails, a temporary authentication rejection is
25151 given.
25152
25153 .section "Using plaintext in a server" "SECTplainserver"
25154 .cindex "AUTH" "in &(plaintext)& authenticator"
25155 .cindex "binary zero" "in &(plaintext)& authenticator"
25156 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25157         "in &(plaintext)& authenticator"
25158 .vindex "&$auth1$&, &$auth2$&, etc"
25159 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25160
25161 When running as a server, &(plaintext)& performs the authentication test by
25162 expanding a string. The data sent by the client with the AUTH command, or in
25163 response to subsequent prompts, is base64 encoded, and so may contain any byte
25164 values when decoded. If any data is supplied with the command, it is treated as
25165 a list of strings, separated by NULs (binary zeros), the first three of which
25166 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25167 (neither LOGIN nor PLAIN uses more than three strings).
25168
25169 For compatibility with previous releases of Exim, the values are also placed in
25170 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25171 variables for this purpose is now deprecated, as it can lead to confusion in
25172 string expansions that also use them for other things.
25173
25174 If there are more strings in &%server_prompts%& than the number of strings
25175 supplied with the AUTH command, the remaining prompts are used to obtain more
25176 data. Each response from the client may be a list of NUL-separated strings.
25177
25178 .vindex "&$authenticated_id$&"
25179 Once a sufficient number of data strings have been received,
25180 &%server_condition%& is expanded. If the expansion is forced to fail,
25181 authentication fails. Any other expansion failure causes a temporary error code
25182 to be returned. If the result of a successful expansion is an empty string,
25183 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25184 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25185 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25186 For any other result, a temporary error code is returned, with the expanded
25187 string as the error text
25188
25189 &*Warning*&: If you use a lookup in the expansion to find the user's
25190 password, be sure to make the authentication fail if the user is unknown.
25191 There are good and bad examples at the end of the next section.
25192
25193
25194
25195 .section "The PLAIN authentication mechanism" "SECID172"
25196 .cindex "PLAIN authentication mechanism"
25197 .cindex "authentication" "PLAIN mechanism"
25198 .cindex "binary zero" "in &(plaintext)& authenticator"
25199 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25200 sent as one item of data (that is, one combined string containing two NUL
25201 separators). The data is sent either as part of the AUTH command, or
25202 subsequently in response to an empty prompt from the server.
25203
25204 The second and third strings are a user name and a corresponding password.
25205 Using a single fixed user name and password as an example, this could be
25206 configured as follows:
25207 .code
25208 fixed_plain:
25209   driver = plaintext
25210   public_name = PLAIN
25211   server_prompts = :
25212   server_condition = \
25213     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25214   server_set_id = $auth2
25215 .endd
25216 Note that the default result strings from &%if%& (&"true"& or an empty string)
25217 are exactly what we want here, so they need not be specified. Obviously, if the
25218 password contains expansion-significant characters such as dollar, backslash,
25219 or closing brace, they have to be escaped.
25220
25221 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25222 the end of a string list are ignored). If all the data comes as part of the
25223 AUTH command, as is commonly the case, the prompt is not used. This
25224 authenticator is advertised in the response to EHLO as
25225 .code
25226 250-AUTH PLAIN
25227 .endd
25228 and a client host can authenticate itself by sending the command
25229 .code
25230 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25231 .endd
25232 As this contains three strings (more than the number of prompts), no further
25233 data is required from the client. Alternatively, the client may just send
25234 .code
25235 AUTH PLAIN
25236 .endd
25237 to initiate authentication, in which case the server replies with an empty
25238 prompt. The client must respond with the combined data string.
25239
25240 The data string is base64 encoded, as required by the RFC. This example,
25241 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25242 represents a zero byte. This is split up into three strings, the first of which
25243 is empty. The &%server_condition%& option in the authenticator checks that the
25244 second two are &`username`& and &`mysecret`& respectively.
25245
25246 Having just one fixed user name and password, as in this example, is not very
25247 realistic, though for a small organization with only a handful of
25248 authenticating clients it could make sense.
25249
25250 A more sophisticated instance of this authenticator could use the user name in
25251 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25252 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25253 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25254 This is an incorrect example:
25255 .code
25256 server_condition = \
25257   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25258 .endd
25259 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25260 which it then compares to the supplied password (&$auth3$&). Why is this example
25261 incorrect? It works fine for existing users, but consider what happens if a
25262 non-existent user name is given. The lookup fails, but as no success/failure
25263 strings are given for the lookup, it yields an empty string. Thus, to defeat
25264 the authentication, all a client has to do is to supply a non-existent user
25265 name and an empty password. The correct way of writing this test is:
25266 .code
25267 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25268   {${if eq{$value}{$auth3}}} {false}}
25269 .endd
25270 In this case, if the lookup succeeds, the result is checked; if the lookup
25271 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25272 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25273 always fails if its second argument is empty. However, the second way of
25274 writing the test makes the logic clearer.
25275
25276
25277 .section "The LOGIN authentication mechanism" "SECID173"
25278 .cindex "LOGIN authentication mechanism"
25279 .cindex "authentication" "LOGIN mechanism"
25280 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25281 in a number of programs. No data is sent with the AUTH command. Instead, a
25282 user name and password are supplied separately, in response to prompts. The
25283 plaintext authenticator can be configured to support this as in this example:
25284 .code
25285 fixed_login:
25286   driver = plaintext
25287   public_name = LOGIN
25288   server_prompts = User Name : Password
25289   server_condition = \
25290     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25291   server_set_id = $auth1
25292 .endd
25293 Because of the way plaintext operates, this authenticator accepts data supplied
25294 with the AUTH command (in contravention of the specification of LOGIN), but
25295 if the client does not supply it (as is the case for LOGIN clients), the prompt
25296 strings are used to obtain two data items.
25297
25298 Some clients are very particular about the precise text of the prompts. For
25299 example, Outlook Express is reported to recognize only &"Username:"& and
25300 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25301 strings. It uses the &%ldapauth%& expansion condition to check the user
25302 name and password by binding to an LDAP server:
25303 .code
25304 login:
25305   driver = plaintext
25306   public_name = LOGIN
25307   server_prompts = Username:: : Password::
25308   server_condition = ${if and{{ \
25309     !eq{}{$auth1} }{ \
25310     ldapauth{\
25311       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25312       pass=${quote:$auth2} \
25313       ldap://ldap.example.org/} }} }
25314   server_set_id = uid=$auth1,ou=people,o=example.org
25315 .endd
25316 We have to check that the username is not empty before using it, because LDAP
25317 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25318 operator to correctly quote the DN for authentication. However, the basic
25319 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25320 correct one to use for the password, because quoting is needed only to make
25321 the password conform to the Exim syntax. At the LDAP level, the password is an
25322 uninterpreted string.
25323
25324
25325 .section "Support for different kinds of authentication" "SECID174"
25326 A number of string expansion features are provided for the purpose of
25327 interfacing to different ways of user authentication. These include checking
25328 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25329 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25330 &<<SECTexpcond>>&.
25331
25332
25333
25334
25335 .section "Using plaintext in a client" "SECID175"
25336 .cindex "options" "&(plaintext)& authenticator (client)"
25337 The &(plaintext)& authenticator has two client options:
25338
25339 .option client_ignore_invalid_base64 plaintext boolean false
25340 If the client receives a server prompt that is not a valid base64 string,
25341 authentication is abandoned by default. However, if this option is set true,
25342 the error in the challenge is ignored and the client sends the response as
25343 usual.
25344
25345 .option client_send plaintext string&!! unset
25346 The string is a colon-separated list of authentication data strings. Each
25347 string is independently expanded before being sent to the server. The first
25348 string is sent with the AUTH command; any more strings are sent in response
25349 to prompts from the server. Before each string is expanded, the value of the
25350 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25351 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25352 way. Thus, the prompt that is received in response to sending the first string
25353 (with the AUTH command) can be used in the expansion of the second string, and
25354 so on. If an invalid base64 string is received when
25355 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25356 &$auth$&<&'n'&> variable.
25357
25358 &*Note*&: You cannot use expansion to create multiple strings, because
25359 splitting takes priority and happens first.
25360
25361 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25362 the data, further processing is applied to each string before it is sent. If
25363 there are any single circumflex characters in the string, they are converted to
25364 NULs. Should an actual circumflex be required as data, it must be doubled in
25365 the string.
25366
25367 This is an example of a client configuration that implements the PLAIN
25368 authentication mechanism with a fixed user name and password:
25369 .code
25370 fixed_plain:
25371   driver = plaintext
25372   public_name = PLAIN
25373   client_send = ^username^mysecret
25374 .endd
25375 The lack of colons means that the entire text is sent with the AUTH
25376 command, with the circumflex characters converted to NULs. A similar example
25377 that uses the LOGIN mechanism is:
25378 .code
25379 fixed_login:
25380   driver = plaintext
25381   public_name = LOGIN
25382   client_send = : username : mysecret
25383 .endd
25384 The initial colon means that the first string is empty, so no data is sent with
25385 the AUTH command itself. The remaining strings are sent in response to
25386 prompts.
25387 .ecindex IIDplaiauth1
25388 .ecindex IIDplaiauth2
25389
25390
25391
25392
25393 . ////////////////////////////////////////////////////////////////////////////
25394 . ////////////////////////////////////////////////////////////////////////////
25395
25396 .chapter "The cram_md5 authenticator" "CHID9"
25397 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25398 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25399 .cindex "CRAM-MD5 authentication mechanism"
25400 .cindex "authentication" "CRAM-MD5 mechanism"
25401 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25402 sends a challenge string to the client, and the response consists of a user
25403 name and the CRAM-MD5 digest of the challenge string combined with a secret
25404 string (password) which is known to both server and client. Thus, the secret
25405 is not sent over the network as plain text, which makes this authenticator more
25406 secure than &(plaintext)&. However, the downside is that the secret has to be
25407 available in plain text at either end.
25408
25409
25410 .section "Using cram_md5 as a server" "SECID176"
25411 .cindex "options" "&(cram_md5)& authenticator (server)"
25412 This authenticator has one server option, which must be set to configure the
25413 authenticator as a server:
25414
25415 .option server_secret cram_md5 string&!! unset
25416 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25417 When the server receives the client's response, the user name is placed in
25418 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25419 obtain the password for that user. The server then computes the CRAM-MD5 digest
25420 that the client should have sent, and checks that it received the correct
25421 string. If the expansion of &%server_secret%& is forced to fail, authentication
25422 fails. If the expansion fails for some other reason, a temporary error code is
25423 returned to the client.
25424
25425 For compatibility with previous releases of Exim, the user name is also placed
25426 in &$1$&. However, the use of this variables for this purpose is now
25427 deprecated, as it can lead to confusion in string expansions that also use
25428 numeric variables for other things.
25429
25430 For example, the following authenticator checks that the user name given by the
25431 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25432 user name, authentication fails.
25433 .code
25434 fixed_cram:
25435   driver = cram_md5
25436   public_name = CRAM-MD5
25437   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25438   server_set_id = $auth1
25439 .endd
25440 .vindex "&$authenticated_id$&"
25441 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25442 name in &$authenticated_id$&. A more typical configuration might look up the
25443 secret string in a file, using the user name as the key. For example:
25444 .code
25445 lookup_cram:
25446   driver = cram_md5
25447   public_name = CRAM-MD5
25448   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25449                   {$value}fail}
25450   server_set_id = $auth1
25451 .endd
25452 Note that this expansion explicitly forces failure if the lookup fails
25453 because &$auth1$& contains an unknown user name.
25454
25455 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25456 using the relevant libraries, you need to know the realm to specify in the
25457 lookup and then ask for the &"userPassword"& attribute for that user in that
25458 realm, with:
25459 .code
25460 cyrusless_crammd5:
25461   driver = cram_md5
25462   public_name = CRAM-MD5
25463   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25464                   dbmjz{/etc/sasldb2}}
25465   server_set_id = $auth1
25466 .endd
25467
25468 .section "Using cram_md5 as a client" "SECID177"
25469 .cindex "options" "&(cram_md5)& authenticator (client)"
25470 When used as a client, the &(cram_md5)& authenticator has two options:
25471
25472
25473
25474 .option client_name cram_md5 string&!! "the primary host name"
25475 This string is expanded, and the result used as the user name data when
25476 computing the response to the server's challenge.
25477
25478
25479 .option client_secret cram_md5 string&!! unset
25480 This option must be set for the authenticator to work as a client. Its value is
25481 expanded and the result used as the secret string when computing the response.
25482
25483
25484 .vindex "&$host$&"
25485 .vindex "&$host_address$&"
25486 Different user names and secrets can be used for different servers by referring
25487 to &$host$& or &$host_address$& in the options. Forced failure of either
25488 expansion string is treated as an indication that this authenticator is not
25489 prepared to handle this case. Exim moves on to the next configured client
25490 authenticator. Any other expansion failure causes Exim to give up trying to
25491 send the message to the current server.
25492
25493 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25494 strings, is:
25495 .code
25496 fixed_cram:
25497   driver = cram_md5
25498   public_name = CRAM-MD5
25499   client_name = ph10
25500   client_secret = secret
25501 .endd
25502 .ecindex IIDcramauth1
25503 .ecindex IIDcramauth2
25504
25505
25506
25507 . ////////////////////////////////////////////////////////////////////////////
25508 . ////////////////////////////////////////////////////////////////////////////
25509
25510 .chapter "The cyrus_sasl authenticator" "CHID10"
25511 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25512 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25513 .cindex "Cyrus" "SASL library"
25514 .cindex "Kerberos"
25515 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25516 Digital Ltd (&url(http://www.aldigital.co.uk)).
25517
25518 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25519 library implementation of the RFC 2222 (&"Simple Authentication and Security
25520 Layer"&). This library supports a number of authentication mechanisms,
25521 including PLAIN and LOGIN, but also several others that Exim does not support
25522 directly. In particular, there is support for Kerberos authentication.
25523
25524 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25525 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25526 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25527 name of the driver to determine which mechanism to support.
25528
25529 Where access to some kind of secret file is required, for example in GSSAPI
25530 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25531 user, and that the Cyrus SASL library has no way of escalating privileges
25532 by default. You may also find you need to set environment variables,
25533 depending on the driver you are using.
25534
25535 The application name provided by Exim is &"exim"&, so various SASL options may
25536 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25537 Kerberos, note that because of limitations in the GSSAPI interface,
25538 changing the server keytab might need to be communicated down to the Kerberos
25539 layer independently. The mechanism for doing so is dependent upon the Kerberos
25540 implementation.
25541
25542 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25543 may be set to point to an alternative keytab file. Exim will pass this
25544 variable through from its own inherited environment when started as root or the
25545 Exim user. The keytab file needs to be readable by the Exim user.
25546 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25547 environment variable.  In practice, for those releases, the Cyrus authenticator
25548 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25549 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25550
25551
25552 .section "Using cyrus_sasl as a server" "SECID178"
25553 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25554 (on a successful authentication) into &$auth1$&. For compatibility with
25555 previous releases of Exim, the username is also placed in &$1$&. However, the
25556 use of this variable for this purpose is now deprecated, as it can lead to
25557 confusion in string expansions that also use numeric variables for other
25558 things.
25559
25560
25561 .option server_hostname cyrus_sasl string&!! "see below"
25562 This option selects the hostname that is used when communicating with the
25563 library. The default value is &`$primary_hostname`&. It is up to the underlying
25564 SASL plug-in what it does with this data.
25565
25566
25567 .option server_mech cyrus_sasl string "see below"
25568 This option selects the authentication mechanism this driver should use. The
25569 default is the value of the generic &%public_name%& option. This option allows
25570 you to use a different underlying mechanism from the advertised name. For
25571 example:
25572 .code
25573 sasl:
25574   driver = cyrus_sasl
25575   public_name = X-ANYTHING
25576   server_mech = CRAM-MD5
25577   server_set_id = $auth1
25578 .endd
25579
25580 .option server_realm cyrus_sasl string&!! unset
25581 This specifies the SASL realm that the server claims to be in.
25582
25583
25584 .option server_service cyrus_sasl string &`smtp`&
25585 This is the SASL service that the server claims to implement.
25586
25587
25588 For straightforward cases, you do not need to set any of the authenticator's
25589 private options. All you need to do is to specify an appropriate mechanism as
25590 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25591 PLAIN, you could have two authenticators as follows:
25592 .code
25593 sasl_cram_md5:
25594   driver = cyrus_sasl
25595   public_name = CRAM-MD5
25596   server_set_id = $auth1
25597
25598 sasl_plain:
25599   driver = cyrus_sasl
25600   public_name = PLAIN
25601   server_set_id = $auth2
25602 .endd
25603 Cyrus SASL does implement the LOGIN authentication method, even though it is
25604 not a standard method. It is disabled by default in the source distribution,
25605 but it is present in many binary distributions.
25606 .ecindex IIDcyrauth1
25607 .ecindex IIDcyrauth2
25608
25609
25610
25611
25612 . ////////////////////////////////////////////////////////////////////////////
25613 . ////////////////////////////////////////////////////////////////////////////
25614 .chapter "The dovecot authenticator" "CHAPdovecot"
25615 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25616 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25617 This authenticator is an interface to the authentication facility of the
25618 Dovecot POP/IMAP server, which can support a number of authentication methods.
25619 Note that Dovecot must be configured to use auth-client not auth-userdb.
25620 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25621 to use the same mechanisms for SMTP authentication. This is a server
25622 authenticator only. There is only one option:
25623
25624 .option server_socket dovecot string unset
25625
25626 This option must specify the socket that is the interface to Dovecot
25627 authentication. The &%public_name%& option must specify an authentication
25628 mechanism that Dovecot is configured to support. You can have several
25629 authenticators for different mechanisms. For example:
25630 .code
25631 dovecot_plain:
25632   driver = dovecot
25633   public_name = PLAIN
25634   server_socket = /var/run/dovecot/auth-client
25635   server_set_id = $auth1
25636
25637 dovecot_ntlm:
25638   driver = dovecot
25639   public_name = NTLM
25640   server_socket = /var/run/dovecot/auth-client
25641   server_set_id = $auth1
25642 .endd
25643 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25644 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25645 option is passed in the Dovecot authentication command. If, for a TLS
25646 connection, a client certificate has been verified, the &"valid-client-cert"&
25647 option is passed. When authentication succeeds, the identity of the user
25648 who authenticated is placed in &$auth1$&.
25649 .ecindex IIDdcotauth1
25650 .ecindex IIDdcotauth2
25651
25652
25653 . ////////////////////////////////////////////////////////////////////////////
25654 . ////////////////////////////////////////////////////////////////////////////
25655 .chapter "The gsasl authenticator" "CHAPgsasl"
25656 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25657 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25658 .cindex "authentication" "GNU SASL"
25659 .cindex "authentication" "SASL"
25660 .cindex "authentication" "EXTERNAL"
25661 .cindex "authentication" "ANONYMOUS"
25662 .cindex "authentication" "PLAIN"
25663 .cindex "authentication" "LOGIN"
25664 .cindex "authentication" "DIGEST-MD5"
25665 .cindex "authentication" "CRAM-MD5"
25666 .cindex "authentication" "SCRAM-SHA-1"
25667 The &(gsasl)& authenticator provides server integration for the GNU SASL
25668 library and the mechanisms it provides.  This is new as of the 4.80 release
25669 and there are a few areas where the library does not let Exim smoothly
25670 scale to handle future authentication mechanisms, so no guarantee can be
25671 made that any particular new authentication mechanism will be supported
25672 without code changes in Exim.
25673
25674
25675 .option server_channelbinding gsasl boolean false
25676 Some authentication mechanisms are able to use external context at both ends
25677 of the session to bind the authentication to that context, and fail the
25678 authentication process if that context differs.  Specifically, some TLS
25679 ciphersuites can provide identifying information about the cryptographic
25680 context.
25681
25682 This means that certificate identity and verification becomes a non-issue,
25683 as a man-in-the-middle attack will cause the correct client and server to
25684 see different identifiers and authentication will fail.
25685
25686 This is currently only supported when using the GnuTLS library.  This is
25687 only usable by mechanisms which support "channel binding"; at time of
25688 writing, that's the SCRAM family.
25689
25690 This defaults off to ensure smooth upgrade across Exim releases, in case
25691 this option causes some clients to start failing.  Some future release
25692 of Exim may switch the default to be true.
25693
25694
25695 .option server_hostname gsasl string&!! "see below"
25696 This option selects the hostname that is used when communicating with the
25697 library. The default value is &`$primary_hostname`&.
25698 Some mechanisms will use this data.
25699
25700
25701 .option server_mech gsasl string "see below"
25702 This option selects the authentication mechanism this driver should use. The
25703 default is the value of the generic &%public_name%& option. This option allows
25704 you to use a different underlying mechanism from the advertised name. For
25705 example:
25706 .code
25707 sasl:
25708   driver = gsasl
25709   public_name = X-ANYTHING
25710   server_mech = CRAM-MD5
25711   server_set_id = $auth1
25712 .endd
25713
25714
25715 .option server_password gsasl string&!! unset
25716 Various mechanisms need access to the cleartext password on the server, so
25717 that proof-of-possession can be demonstrated on the wire, without sending
25718 the password itself.
25719
25720 The data available for lookup varies per mechanism.
25721 In all cases, &$auth1$& is set to the &'authentication id'&.
25722 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25723 if available, else the empty string.
25724 The &$auth3$& variable will always be the &'realm'& if available,
25725 else the empty string.
25726
25727 A forced failure will cause authentication to defer.
25728
25729 If using this option, it may make sense to set the &%server_condition%&
25730 option to be simply "true".
25731
25732
25733 .option server_realm gsasl string&!! unset
25734 This specifies the SASL realm that the server claims to be in.
25735 Some mechanisms will use this data.
25736
25737
25738 .option server_scram_iter gsasl string&!! unset
25739 This option provides data for the SCRAM family of mechanisms.
25740 &$auth1$& is not available at evaluation time.
25741 (This may change, as we receive feedback on use)
25742
25743
25744 .option server_scram_salt gsasl string&!! unset
25745 This option provides data for the SCRAM family of mechanisms.
25746 &$auth1$& is not available at evaluation time.
25747 (This may change, as we receive feedback on use)
25748
25749
25750 .option server_service gsasl string &`smtp`&
25751 This is the SASL service that the server claims to implement.
25752 Some mechanisms will use this data.
25753
25754
25755 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25756 .vindex "&$auth1$&, &$auth2$&, etc"
25757 These may be set when evaluating specific options, as detailed above.
25758 They will also be set when evaluating &%server_condition%&.
25759
25760 Unless otherwise stated below, the &(gsasl)& integration will use the following
25761 meanings for these variables:
25762
25763 .ilist
25764 .vindex "&$auth1$&"
25765 &$auth1$&: the &'authentication id'&
25766 .next
25767 .vindex "&$auth2$&"
25768 &$auth2$&: the &'authorization id'&
25769 .next
25770 .vindex "&$auth3$&"
25771 &$auth3$&: the &'realm'&
25772 .endlist
25773
25774 On a per-mechanism basis:
25775
25776 .ilist
25777 .cindex "authentication" "EXTERNAL"
25778 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25779 the &%server_condition%& option must be present.
25780 .next
25781 .cindex "authentication" "ANONYMOUS"
25782 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25783 the &%server_condition%& option must be present.
25784 .next
25785 .cindex "authentication" "GSSAPI"
25786 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25787 &$auth2$& will be set to the &'authorization id'&,
25788 the &%server_condition%& option must be present.
25789 .endlist
25790
25791 An &'anonymous token'& is something passed along as an unauthenticated
25792 identifier; this is analogous to FTP anonymous authentication passing an
25793 email address, or software-identifier@, as the "password".
25794
25795
25796 An example showing the password having the realm specified in the callback
25797 and demonstrating a Cyrus SASL to GSASL migration approach is:
25798 .code
25799 gsasl_cyrusless_crammd5:
25800   driver = gsasl
25801   public_name = CRAM-MD5
25802   server_realm = imap.example.org
25803   server_password = ${lookup{$auth1:$auth3:userPassword}\
25804                     dbmjz{/etc/sasldb2}{$value}fail}
25805   server_set_id = ${quote:$auth1}
25806   server_condition = yes
25807 .endd
25808
25809
25810 . ////////////////////////////////////////////////////////////////////////////
25811 . ////////////////////////////////////////////////////////////////////////////
25812
25813 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25814 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25815 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25816 .cindex "authentication" "GSSAPI"
25817 .cindex "authentication" "Kerberos"
25818 The &(heimdal_gssapi)& authenticator provides server integration for the
25819 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25820 reliably.
25821
25822 .option server_hostname heimdal_gssapi string&!! "see below"
25823 This option selects the hostname that is used, with &%server_service%&,
25824 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25825 identifier.  The default value is &`$primary_hostname`&.
25826
25827 .option server_keytab heimdal_gssapi string&!! unset
25828 If set, then Heimdal will not use the system default keytab (typically
25829 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25830 The value should be a pathname, with no &"file:"& prefix.
25831
25832 .option server_service heimdal_gssapi string&!! "smtp"
25833 This option specifies the service identifier used, in conjunction with
25834 &%server_hostname%&, for building the identifer for finding credentials
25835 from the keytab.
25836
25837
25838 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25839 Beware that these variables will typically include a realm, thus will appear
25840 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25841 not verified, so a malicious client can set it to anything.
25842
25843 The &$auth1$& field should be safely trustable as a value from the Key
25844 Distribution Center.  Note that these are not quite email addresses.
25845 Each identifier is for a role, and so the left-hand-side may include a
25846 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25847
25848 .vindex "&$auth1$&, &$auth2$&, etc"
25849 .ilist
25850 .vindex "&$auth1$&"
25851 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25852 .next
25853 .vindex "&$auth2$&"
25854 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25855 authentication.  If that was empty, this will also be set to the
25856 GSS Display Name.
25857 .endlist
25858
25859
25860 . ////////////////////////////////////////////////////////////////////////////
25861 . ////////////////////////////////////////////////////////////////////////////
25862
25863 .chapter "The spa authenticator" "CHAPspa"
25864 .scindex IIDspaauth1 "&(spa)& authenticator"
25865 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25866 .cindex "authentication" "Microsoft Secure Password"
25867 .cindex "authentication" "NTLM"
25868 .cindex "Microsoft Secure Password Authentication"
25869 .cindex "NTLM authentication"
25870 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25871 Password Authentication'& mechanism,
25872 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25873 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25874 taken from the Samba project (&url(http://www.samba.org)). The code for the
25875 server side was subsequently contributed by Tom Kistner. The mechanism works as
25876 follows:
25877
25878 .ilist
25879 After the AUTH command has been accepted, the client sends an SPA
25880 authentication request based on the user name and optional domain.
25881 .next
25882 The server sends back a challenge.
25883 .next
25884 The client builds a challenge response which makes use of the user's password
25885 and sends it to the server, which then accepts or rejects it.
25886 .endlist
25887
25888 Encryption is used to protect the password in transit.
25889
25890
25891
25892 .section "Using spa as a server" "SECID179"
25893 .cindex "options" "&(spa)& authenticator (server)"
25894 The &(spa)& authenticator has just one server option:
25895
25896 .option server_password spa string&!! unset
25897 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25898 This option is expanded, and the result must be the cleartext password for the
25899 authenticating user, whose name is at this point in &$auth1$&. For
25900 compatibility with previous releases of Exim, the user name is also placed in
25901 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25902 it can lead to confusion in string expansions that also use numeric variables
25903 for other things. For example:
25904 .code
25905 spa:
25906   driver = spa
25907   public_name = NTLM
25908   server_password = \
25909     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25910 .endd
25911 If the expansion is forced to fail, authentication fails. Any other expansion
25912 failure causes a temporary error code to be returned.
25913
25914
25915
25916
25917
25918 .section "Using spa as a client" "SECID180"
25919 .cindex "options" "&(spa)& authenticator (client)"
25920 The &(spa)& authenticator has the following client options:
25921
25922
25923
25924 .option client_domain spa string&!! unset
25925 This option specifies an optional domain for the authentication.
25926
25927
25928 .option client_password spa string&!! unset
25929 This option specifies the user's password, and must be set.
25930
25931
25932 .option client_username spa string&!! unset
25933 This option specifies the user name, and must be set. Here is an example of a
25934 configuration of this authenticator for use with the mail servers at
25935 &'msn.com'&:
25936 .code
25937 msn:
25938   driver = spa
25939   public_name = MSN
25940   client_username = msn/msn_username
25941   client_password = msn_plaintext_password
25942   client_domain = DOMAIN_OR_UNSET
25943 .endd
25944 .ecindex IIDspaauth1
25945 .ecindex IIDspaauth2
25946
25947
25948
25949
25950
25951 . ////////////////////////////////////////////////////////////////////////////
25952 . ////////////////////////////////////////////////////////////////////////////
25953
25954 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25955          "Encrypted SMTP connections"
25956 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25957 .scindex IIDencsmtp2 "SMTP" "encryption"
25958 .cindex "TLS" "on SMTP connection"
25959 .cindex "OpenSSL"
25960 .cindex "GnuTLS"
25961 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25962 Sockets Layer), is implemented by making use of the OpenSSL library or the
25963 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25964 cryptographic code in the Exim distribution itself for implementing TLS. In
25965 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25966 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25967 You also need to understand the basic concepts of encryption at a managerial
25968 level, and in particular, the way that public keys, private keys, and
25969 certificates are used.
25970
25971 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25972 connection is established, the client issues a STARTTLS command. If the
25973 server accepts this, the client and the server negotiate an encryption
25974 mechanism. If the negotiation succeeds, the data that subsequently passes
25975 between them is encrypted.
25976
25977 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25978 and if so, what cipher suite is in use, whether the client supplied a
25979 certificate, and whether or not that certificate was verified. This makes it
25980 possible for an Exim server to deny or accept certain commands based on the
25981 encryption state.
25982
25983 &*Warning*&: Certain types of firewall and certain anti-virus products can
25984 disrupt TLS connections. You need to turn off SMTP scanning for these products
25985 in order to get TLS to work.
25986
25987
25988
25989 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25990          "SECID284"
25991 .cindex "ssmtp protocol"
25992 .cindex "smtps protocol"
25993 .cindex "SMTP" "ssmtp protocol"
25994 .cindex "SMTP" "smtps protocol"
25995 Early implementations of encrypted SMTP used a different TCP port from normal
25996 SMTP, and expected an encryption negotiation to start immediately, instead of
25997 waiting for a STARTTLS command from the client using the standard SMTP
25998 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25999 allocated for this purpose.
26000
26001 This approach was abandoned when encrypted SMTP was standardized, but there are
26002 still some legacy clients that use it. Exim supports these clients by means of
26003 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26004 numbers; the most common use is expected to be:
26005 .code
26006 tls_on_connect_ports = 465
26007 .endd
26008 The port numbers specified by this option apply to all SMTP connections, both
26009 via the daemon and via &'inetd'&. You still need to specify all the ports that
26010 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26011 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26012 an extra port &-- rather, it specifies different behaviour on a port that is
26013 defined elsewhere.
26014
26015 There is also a &%-tls-on-connect%& command line option. This overrides
26016 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26017
26018
26019
26020
26021
26022
26023 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26024 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26025 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26026 followed later, when the first versions of GnuTLS were released. To build Exim
26027 to use GnuTLS, you need to set
26028 .code
26029 USE_GNUTLS=yes
26030 .endd
26031 in Local/Makefile, in addition to
26032 .code
26033 SUPPORT_TLS=yes
26034 .endd
26035 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26036 include files and libraries for GnuTLS can be found.
26037
26038 There are some differences in usage when using GnuTLS instead of OpenSSL:
26039
26040 .ilist
26041 The &%tls_verify_certificates%& option
26042 cannot be the path of a directory
26043 for GnuTLS versions before 3.3.6
26044 (for later versions, or OpenSSL, it can be either).
26045 .next
26046 The default value for &%tls_dhparam%& differs for historical reasons.
26047 .next
26048 .vindex "&$tls_in_peerdn$&"
26049 .vindex "&$tls_out_peerdn$&"
26050 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26051 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26052 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26053 .next
26054 OpenSSL identifies cipher suites using hyphens as separators, for example:
26055 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26056 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26057 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26058 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26059 to handle its own older variants) when processing lists of cipher suites in the
26060 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26061 option).
26062 .next
26063 The &%tls_require_ciphers%& options operate differently, as described in the
26064 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26065 .next
26066 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26067 When using OpenSSL, this option is ignored.
26068 (If an API is found to let OpenSSL be configured in this way,
26069 let the Exim Maintainers know and we'll likely use it).
26070 .next
26071 Some other recently added features may only be available in one or the other.
26072 This should be documented with the feature.  If the documentation does not
26073 explicitly state that the feature is infeasible in the other TLS
26074 implementation, then patches are welcome.
26075 .endlist
26076
26077
26078 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26079 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26080 an explicit path; if the latter, then the text about generation still applies,
26081 but not the chosen filename.
26082 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26083 See the documentation of &%tls_dhparam%& for more information.
26084
26085 GnuTLS uses D-H parameters that may take a substantial amount of time
26086 to compute. It is unreasonable to re-compute them for every TLS session.
26087 Therefore, Exim keeps this data in a file in its spool directory, called
26088 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26089 of bits requested.
26090 The file is owned by the Exim user and is readable only by
26091 its owner. Every Exim process that start up GnuTLS reads the D-H
26092 parameters from this file. If the file does not exist, the first Exim process
26093 that needs it computes the data and writes it to a temporary file which is
26094 renamed once it is complete. It does not matter if several Exim processes do
26095 this simultaneously (apart from wasting a few resources). Once a file is in
26096 place, new Exim processes immediately start using it.
26097
26098 For maximum security, the parameters that are stored in this file should be
26099 recalculated periodically, the frequency depending on your paranoia level.
26100 If you are avoiding using the fixed D-H primes published in RFCs, then you
26101 are concerned about some advanced attacks and will wish to do this; if you do
26102 not regenerate then you might as well stick to the standard primes.
26103
26104 Arranging this is easy in principle; just delete the file when you want new
26105 values to be computed. However, there may be a problem. The calculation of new
26106 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26107 If the system is not very active, &_/dev/random_& may delay returning data
26108 until enough randomness (entropy) is available. This may cause Exim to hang for
26109 a substantial amount of time, causing timeouts on incoming connections.
26110
26111 The solution is to generate the parameters externally to Exim. They are stored
26112 in &_gnutls-params-N_& in PEM format, which means that they can be
26113 generated externally using the &(certtool)& command that is part of GnuTLS.
26114
26115 To replace the parameters with new ones, instead of deleting the file
26116 and letting Exim re-create it, you can generate new parameters using
26117 &(certtool)& and, when this has been done, replace Exim's cache file by
26118 renaming. The relevant commands are something like this:
26119 .code
26120 # ls
26121 [ look for file; assume gnutls-params-2236 is the most recent ]
26122 # rm -f new-params
26123 # touch new-params
26124 # chown exim:exim new-params
26125 # chmod 0600 new-params
26126 # certtool --generate-dh-params --bits 2236 >>new-params
26127 # openssl dhparam -noout -text -in new-params | head
26128 [ check the first line, make sure it's not more than 2236;
26129   if it is, then go back to the start ("rm") and repeat
26130   until the size generated is at most the size requested ]
26131 # chmod 0400 new-params
26132 # mv new-params gnutls-params-2236
26133 .endd
26134 If Exim never has to generate the parameters itself, the possibility of
26135 stalling is removed.
26136
26137 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26138 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26139 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26140 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26141 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26142 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26143 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26144 which applies to all D-H usage, client or server.  If the value returned by
26145 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26146 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26147 limit, which is still much higher than Exim historically used.
26148
26149 The filename and bits used will change as the GnuTLS maintainers change the
26150 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26151 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26152 2432 bits, while NSS is limited to 2236 bits.
26153
26154 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26155 increase the chance of the generated prime actually being within acceptable
26156 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26157 procedure above.  There is no sane procedure available to Exim to double-check
26158 the size of the generated prime, so it might still be too large.
26159
26160
26161 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26162 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26163 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26164 There is a function in the OpenSSL library that can be passed a list of cipher
26165 suites before the cipher negotiation takes place. This specifies which ciphers
26166 are acceptable. The list is colon separated and may contain names like
26167 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26168 directly to this function call.
26169 Many systems will install the OpenSSL manual-pages, so you may have
26170 &'ciphers(1)'& available to you.
26171 The following quotation from the OpenSSL
26172 documentation specifies what forms of item are allowed in the cipher string:
26173
26174 .ilist
26175 It can consist of a single cipher suite such as RC4-SHA.
26176 .next
26177 It can represent a list of cipher suites containing a certain algorithm,
26178 or cipher suites of a certain type. For example SHA1 represents all
26179 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26180 SSL v3 algorithms.
26181 .next
26182 Lists of cipher suites can be combined in a single cipher string using
26183 the + character. This is used as a logical and operation. For example
26184 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26185 algorithms.
26186 .endlist
26187
26188 Each cipher string can be optionally preceded by one of the characters &`!`&,
26189 &`-`& or &`+`&.
26190 .ilist
26191 If &`!`& is used, the ciphers are permanently deleted from the list. The
26192 ciphers deleted can never reappear in the list even if they are explicitly
26193 stated.
26194 .next
26195 If &`-`& is used, the ciphers are deleted from the list, but some or all
26196 of the ciphers can be added again by later options.
26197 .next
26198 If &`+`& is used, the ciphers are moved to the end of the list. This
26199 option does not add any new ciphers; it just moves matching existing ones.
26200 .endlist
26201
26202 If none of these characters is present, the string is interpreted as
26203 a list of ciphers to be appended to the current preference list. If the list
26204 includes any ciphers already present they will be ignored: that is, they will
26205 not be moved to the end of the list.
26206 .endlist
26207
26208 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26209 string:
26210 .code
26211 # note single-quotes to get ! past any shell history expansion
26212 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26213 .endd
26214
26215 This example will let the library defaults be permitted on the MX port, where
26216 there's probably no identity verification anyway, but ups the ante on the
26217 submission ports where the administrator might have some influence on the
26218 choice of clients used:
26219 .code
26220 # OpenSSL variant; see man ciphers(1)
26221 tls_require_ciphers = ${if =={$received_port}{25}\
26222                            {DEFAULT}\
26223                            {HIGH:!MD5:!SHA1}}
26224 .endd
26225
26226
26227
26228 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26229          "SECTreqciphgnu"
26230 .cindex "GnuTLS" "specifying parameters for"
26231 .cindex "TLS" "specifying ciphers (GnuTLS)"
26232 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26233 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26234 .cindex "TLS" "specifying protocols (GnuTLS)"
26235 .cindex "TLS" "specifying priority string (GnuTLS)"
26236 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26237 The GnuTLS library allows the caller to provide a "priority string", documented
26238 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26239 ciphersuite specification in OpenSSL.
26240
26241 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26242 and controls both protocols and ciphers.
26243
26244 The &%tls_require_ciphers%& option is available both as an global option,
26245 controlling how Exim behaves as a server, and also as an option of the
26246 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26247 the value is string expanded.  The resulting string is not an Exim list and
26248 the string is given to the GnuTLS library, so that Exim does not need to be
26249 aware of future feature enhancements of GnuTLS.
26250
26251 Documentation of the strings accepted may be found in the GnuTLS manual, under
26252 "Priority strings".  This is online as
26253 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26254 but beware that this relates to GnuTLS 3, which may be newer than the version
26255 installed on your system.  If you are using GnuTLS 3,
26256 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26257 on that site can be used to test a given string.
26258
26259 For example:
26260 .code
26261 # Disable older versions of protocols
26262 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26263 .endd
26264
26265 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26266 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26267 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26268
26269 This example will let the library defaults be permitted on the MX port, where
26270 there's probably no identity verification anyway, and lowers security further
26271 by increasing compatibility; but this ups the ante on the submission ports
26272 where the administrator might have some influence on the choice of clients
26273 used:
26274 .code
26275 # GnuTLS variant
26276 tls_require_ciphers = ${if =={$received_port}{25}\
26277                            {NORMAL:%COMPAT}\
26278                            {SECURE128}}
26279 .endd
26280
26281
26282 .section "Configuring an Exim server to use TLS" "SECID182"
26283 .cindex "TLS" "configuring an Exim server"
26284 When Exim has been built with TLS support, it advertises the availability of
26285 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26286 but not to any others. The default value of this option is unset, which means
26287 that STARTTLS is not advertised at all. This default is chosen because you
26288 need to set some other options in order to make TLS available, and also it is
26289 sensible for systems that want to use TLS only as a client.
26290
26291 If a client issues a STARTTLS command and there is some configuration
26292 problem in the server, the command is rejected with a 454 error. If the client
26293 persists in trying to issue SMTP commands, all except QUIT are rejected
26294 with the error
26295 .code
26296 554 Security failure
26297 .endd
26298 If a STARTTLS command is issued within an existing TLS session, it is
26299 rejected with a 554 error code.
26300
26301 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26302 match some hosts. You can, of course, set it to * to match all hosts.
26303 However, this is not all you need to do. TLS sessions to a server won't work
26304 without some further configuration at the server end.
26305
26306 It is rumoured that all existing clients that support TLS/SSL use RSA
26307 encryption. To make this work you need to set, in the server,
26308 .code
26309 tls_certificate = /some/file/name
26310 tls_privatekey = /some/file/name
26311 .endd
26312 These options are, in fact, expanded strings, so you can make them depend on
26313 the identity of the client that is connected if you wish. The first file
26314 contains the server's X509 certificate, and the second contains the private key
26315 that goes with it. These files need to be
26316 PEM format and readable by the Exim user, and must
26317 always be given as full path names.
26318 The key must not be password-protected.
26319 They can be the same file if both the
26320 certificate and the key are contained within it. If &%tls_privatekey%& is not
26321 set, or if its expansion is forced to fail or results in an empty string, this
26322 is assumed to be the case. The certificate file may also contain intermediate
26323 certificates that need to be sent to the client to enable it to authenticate
26324 the server's certificate.
26325
26326 If you do not understand about certificates and keys, please try to find a
26327 source of this background information, which is not Exim-specific. (There are a
26328 few comments below in section &<<SECTcerandall>>&.)
26329
26330 &*Note*&: These options do not apply when Exim is operating as a client &--
26331 they apply only in the case of a server. If you need to use a certificate in an
26332 Exim client, you must set the options of the same names in an &(smtp)&
26333 transport.
26334
26335 With just these options, an Exim server will be able to use TLS. It does not
26336 require the client to have a certificate (but see below for how to insist on
26337 this). There is one other option that may be needed in other situations. If
26338 .code
26339 tls_dhparam = /some/file/name
26340 .endd
26341 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26342 with the parameters contained in the file.
26343 Set this to &`none`& to disable use of DH entirely, by making no prime
26344 available:
26345 .code
26346 tls_dhparam = none
26347 .endd
26348 This may also be set to a string identifying a standard prime to be used for
26349 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26350 used is &`ike23`&.  There are a few standard primes available, see the
26351 documentation for &%tls_dhparam%& for the complete list.
26352
26353 See the command
26354 .code
26355 openssl dhparam
26356 .endd
26357 for a way of generating file data.
26358
26359 The strings supplied for these three options are expanded every time a client
26360 host connects. It is therefore possible to use different certificates and keys
26361 for different hosts, if you so wish, by making use of the client's IP address
26362 in &$sender_host_address$& to control the expansion. If a string expansion is
26363 forced to fail, Exim behaves as if the option is not set.
26364
26365 .cindex "cipher" "logging"
26366 .cindex "log" "TLS cipher"
26367 .vindex "&$tls_in_cipher$&"
26368 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26369 an incoming TLS connection. It is included in the &'Received:'& header of an
26370 incoming message (by default &-- you can, of course, change this), and it is
26371 also included in the log line that records a message's arrival, keyed by
26372 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26373 condition can be used to test for specific cipher suites in ACLs.
26374
26375 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26376 can check the name of the cipher suite and vary their actions accordingly. The
26377 cipher suite names vary, depending on which TLS library is being used. For
26378 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26379 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26380 documentation for more details.
26381
26382 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26383 (again depending on the &%tls_cipher%& log selector).
26384
26385
26386 .section "Requesting and verifying client certificates" "SECID183"
26387 .cindex "certificate" "verification of client"
26388 .cindex "TLS" "client certificate verification"
26389 If you want an Exim server to request a certificate when negotiating a TLS
26390 session with a client, you must set either &%tls_verify_hosts%& or
26391 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26392 apply to all TLS connections. For any host that matches one of these options,
26393 Exim requests a certificate as part of the setup of the TLS session. The
26394 contents of the certificate are verified by comparing it with a list of
26395 expected certificates.
26396 These may be the system default set (depending on library version),
26397 an explicit file or,
26398 depending on library version, a directory, identified by
26399 &%tls_verify_certificates%&.
26400
26401 A file can contain multiple certificates, concatenated end to end. If a
26402 directory is used
26403 (OpenSSL only),
26404 each certificate must be in a separate file, with a name (or a symbolic link)
26405 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26406 certificate. You can compute the relevant hash by running the command
26407 .code
26408 openssl x509 -hash -noout -in /cert/file
26409 .endd
26410 where &_/cert/file_& contains a single certificate.
26411
26412 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26413 what happens if the client does not supply a certificate, or if the certificate
26414 does not match any of the certificates in the collection named by
26415 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26416 attempt to set up a TLS session is aborted, and the incoming connection is
26417 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26418 session continues. ACLs that run for subsequent SMTP commands can detect the
26419 fact that no certificate was verified, and vary their actions accordingly. For
26420 example, you can insist on a certificate before accepting a message for
26421 relaying, but not when the message is destined for local delivery.
26422
26423 .vindex "&$tls_in_peerdn$&"
26424 When a client supplies a certificate (whether it verifies or not), the value of
26425 the Distinguished Name of the certificate is made available in the variable
26426 &$tls_in_peerdn$& during subsequent processing of the message.
26427
26428 .cindex "log" "distinguished name"
26429 Because it is often a long text string, it is not included in the log line or
26430 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26431 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26432 &%received_header_text%& to change the &'Received:'& header. When no
26433 certificate is supplied, &$tls_in_peerdn$& is empty.
26434
26435
26436 .section "Revoked certificates" "SECID184"
26437 .cindex "TLS" "revoked certificates"
26438 .cindex "revocation list"
26439 .cindex "certificate" "revocation list"
26440 .cindex "OCSP" "stapling"
26441 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26442 certificates are revoked. If you have such a list, you can pass it to an Exim
26443 server using the global option called &%tls_crl%& and to an Exim client using
26444 an identically named option for the &(smtp)& transport. In each case, the value
26445 of the option is expanded and must then be the name of a file that contains a
26446 CRL in PEM format.
26447 The downside is that clients have to periodically re-download a potentially huge
26448 file from every certificate authority they know of.
26449
26450 The way with most moving parts at query time is Online Certificate
26451 Status Protocol (OCSP), where the client verifies the certificate
26452 against an OCSP server run by the CA.  This lets the CA track all
26453 usage of the certs.  It requires running software with access to the
26454 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26455 is based on HTTP and can be proxied accordingly.
26456
26457 The only widespread OCSP server implementation (known to this writer)
26458 comes as part of OpenSSL and aborts on an invalid request, such as
26459 connecting to the port and then disconnecting.  This requires
26460 re-entering the passphrase each time some random client does this.
26461
26462 The third way is OCSP Stapling; in this, the server using a certificate
26463 issued by the CA periodically requests an OCSP proof of validity from
26464 the OCSP server, then serves it up inline as part of the TLS
26465 negotiation.   This approach adds no extra round trips, does not let the
26466 CA track users, scales well with number of certs issued by the CA and is
26467 resilient to temporary OCSP server failures, as long as the server
26468 starts retrying to fetch an OCSP proof some time before its current
26469 proof expires.  The downside is that it requires server support.
26470
26471 Unless Exim is built with the support disabled,
26472 or with GnuTLS earlier than version 3.1.3,
26473 support for OCSP stapling is included.
26474
26475 There is a global option called &%tls_ocsp_file%&.
26476 The file specified therein is expected to be in DER format, and contain
26477 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26478 option will be re-expanded for SNI, if the &%tls_certificate%& option
26479 contains &`tls_in_sni`&, as per other TLS options.
26480
26481 Exim does not at this time implement any support for fetching a new OCSP
26482 proof.  The burden is on the administrator to handle this, outside of
26483 Exim.  The file specified should be replaced atomically, so that the
26484 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26485 on each connection, so a new file will be handled transparently on the
26486 next connection.
26487
26488 When built with OpenSSL Exim will check for a valid next update timestamp
26489 in the OCSP proof; if not present, or if the proof has expired, it will be
26490 ignored.
26491
26492 For the client to be able to verify the stapled OCSP the server must
26493 also supply, in its stapled information, any intermediate
26494 certificates for the chain leading to the OCSP proof from the signer
26495 of the server certificate.  There may be zero or one such. These
26496 intermediate certificates should be added to the server OCSP stapling
26497 file named by &%tls_ocsp_file%&.
26498
26499 Note that the proof only covers the terminal server certificate,
26500 not any of the chain from CA to it.
26501
26502 There is no current way to staple a proof for a client certificate.
26503
26504 .code
26505   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26506   OCSP server is supplied.  The server URL may be included in the
26507   server certificate, if the CA is helpful.
26508
26509   One failure mode seen was the OCSP Signer cert expiring before the end
26510   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26511   noted this as invalid overall, but the re-fetch script did not.
26512 .endd
26513
26514
26515
26516
26517 .section "Configuring an Exim client to use TLS" "SECID185"
26518 .cindex "cipher" "logging"
26519 .cindex "log" "TLS cipher"
26520 .cindex "log" "distinguished name"
26521 .cindex "TLS" "configuring an Exim client"
26522 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26523 deliveries as well as to incoming, the latter one causing logging of the
26524 server certificate's DN. The remaining client configuration for TLS is all
26525 within the &(smtp)& transport.
26526
26527 It is not necessary to set any options to have TLS work in the &(smtp)&
26528 transport. If Exim is built with TLS support, and TLS is advertised by a
26529 server, the &(smtp)& transport always tries to start a TLS session. However,
26530 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26531 transport) to a list of server hosts for which TLS should not be used.
26532
26533 If you do not want Exim to attempt to send messages unencrypted when an attempt
26534 to set up an encrypted connection fails in any way, you can set
26535 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26536 those hosts, delivery is always deferred if an encrypted connection cannot be
26537 set up. If there are any other hosts for the address, they are tried in the
26538 usual way.
26539
26540 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26541 the message unencrypted. It always does this if the response to STARTTLS is
26542 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26543 session after a success response code, what happens is controlled by the
26544 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26545 delivery to this host is deferred, and other hosts (if available) are tried. If
26546 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26547 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26548 negotiation fails, Exim closes the current connection (because it is in an
26549 unknown state), opens a new one to the same host, and then tries the delivery
26550 unencrypted.
26551
26552 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26553 transport provide the client with a certificate, which is passed to the server
26554 if it requests it. If the server is Exim, it will request a certificate only if
26555 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26556
26557 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26558 specifies a collection of expected server certificates.
26559 These may be the system default set (depeding on library version),
26560 a file or,
26561 depnding on liibrary version, a directory,
26562 must name a file or,
26563 for OpenSSL only (not GnuTLS), a directory.
26564 The client verifies the server's certificate
26565 against this collection, taking into account any revoked certificates that are
26566 in the list defined by &%tls_crl%&.
26567 Failure to verify fails the TLS connection unless either of the
26568 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26569
26570 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26571 certificate verification to the listed servers.  Verification either must
26572 or need not succeed respectively.
26573
26574 The &(smtp)& transport has two OCSP-related options:
26575 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26576 is requested and required for the connection to proceed.  The default
26577 value is empty.
26578 &%hosts_request_ocsp%&; a host-list for which (additionally)
26579 a Certificate Status is requested (but not necessarily verified).  The default
26580 value is "*" meaning that requests are made unless configured
26581 otherwise.
26582
26583 The host(s) should also be in &%hosts_require_tls%&, and
26584 &%tls_verify_certificates%& configured for the transport,
26585 for OCSP to be relevant.
26586
26587 If
26588 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26589 list of permitted cipher suites. If either of these checks fails, delivery to
26590 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26591 alternative hosts, if any.
26592
26593  &*Note*&:
26594 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26595 is operating as a client. Exim does not assume that a server certificate (set
26596 by the global options of the same name) should also be used when operating as a
26597 client.
26598
26599 .vindex "&$host$&"
26600 .vindex "&$host_address$&"
26601 All the TLS options in the &(smtp)& transport are expanded before use, with
26602 &$host$& and &$host_address$& containing the name and address of the server to
26603 which the client is connected. Forced failure of an expansion causes Exim to
26604 behave as if the relevant option were unset.
26605
26606 .vindex &$tls_out_bits$&
26607 .vindex &$tls_out_cipher$&
26608 .vindex &$tls_out_peerdn$&
26609 .vindex &$tls_out_sni$&
26610 Before an SMTP connection is established, the
26611 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26612 variables are emptied. (Until the first connection, they contain the values
26613 that were set when the message was received.) If STARTTLS is subsequently
26614 successfully obeyed, these variables are set to the relevant values for the
26615 outgoing connection.
26616
26617
26618
26619 .section "Use of TLS Server Name Indication" "SECTtlssni"
26620 .cindex "TLS" "Server Name Indication"
26621 .vindex "&$tls_in_sni$&"
26622 .oindex "&%tls_in_sni%&"
26623 With TLS1.0 or above, there is an extension mechanism by which extra
26624 information can be included at various points in the protocol.  One of these
26625 extensions, documented in RFC 6066 (and before that RFC 4366) is
26626 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26627 client in the initial handshake, so that the server can examine the servername
26628 within and possibly choose to use different certificates and keys (and more)
26629 for this session.
26630
26631 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26632 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26633 address.
26634
26635 With SMTP to MX, there are the same problems here as in choosing the identity
26636 against which to validate a certificate: you can't rely on insecure DNS to
26637 provide the identity which you then cryptographically verify.  So this will
26638 be of limited use in that environment.
26639
26640 With SMTP to Submission, there is a well-defined hostname which clients are
26641 connecting to and can validate certificates against.  Thus clients &*can*&
26642 choose to include this information in the TLS negotiation.  If this becomes
26643 wide-spread, then hosters can choose to present different certificates to
26644 different clients.  Or even negotiate different cipher suites.
26645
26646 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26647 if not empty, will be sent on a TLS session as part of the handshake.  There's
26648 nothing more to it.  Choosing a sensible value not derived insecurely is the
26649 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26650 for the lifetime of the client connection (including during authentication).
26651
26652 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26653 received from a client.
26654 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26655
26656 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26657 option (prior to expansion) then the following options will be re-expanded
26658 during TLS session handshake, to permit alternative values to be chosen:
26659
26660 .ilist
26661 .vindex "&%tls_certificate%&"
26662 &%tls_certificate%&
26663 .next
26664 .vindex "&%tls_crl%&"
26665 &%tls_crl%&
26666 .next
26667 .vindex "&%tls_privatekey%&"
26668 &%tls_privatekey%&
26669 .next
26670 .vindex "&%tls_verify_certificates%&"
26671 &%tls_verify_certificates%&
26672 .next
26673 .vindex "&%tls_ocsp_file%&"
26674 &%tls_verify_certificates%&
26675 .endlist
26676
26677 Great care should be taken to deal with matters of case, various injection
26678 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26679 can always be referenced; it is important to remember that &$tls_sni$& is
26680 arbitrary unverified data provided prior to authentication.
26681
26682 The Exim developers are proceeding cautiously and so far no other TLS options
26683 are re-expanded.
26684
26685 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26686 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26687 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26688 see &`-servername`& in the output, then OpenSSL has support.
26689
26690 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26691 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26692 built, then you have SNI support).
26693
26694
26695
26696 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26697          "SECTmulmessam"
26698 .cindex "multiple SMTP deliveries with TLS"
26699 .cindex "TLS" "multiple message deliveries"
26700 Exim sends multiple messages down the same TCP/IP connection by starting up
26701 an entirely new delivery process for each message, passing the socket from
26702 one process to the next. This implementation does not fit well with the use
26703 of TLS, because there is quite a lot of state information associated with a TLS
26704 connection, not just a socket identification. Passing all the state information
26705 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26706 session before passing the socket to a new process. The new process may then
26707 try to start a new TLS session, and if successful, may try to re-authenticate
26708 if AUTH is in use, before sending the next message.
26709
26710 The RFC is not clear as to whether or not an SMTP session continues in clear
26711 after TLS has been shut down, or whether TLS may be restarted again later, as
26712 just described. However, if the server is Exim, this shutdown and
26713 reinitialization works. It is not known which (if any) other servers operate
26714 successfully if the client closes a TLS session and continues with unencrypted
26715 SMTP, but there are certainly some that do not work. For such servers, Exim
26716 should not pass the socket to another process, because the failure of the
26717 subsequent attempt to use it would cause Exim to record a temporary host error,
26718 and delay other deliveries to that host.
26719
26720 To test for this case, Exim sends an EHLO command to the server after
26721 closing down the TLS session. If this fails in any way, the connection is
26722 closed instead of being passed to a new delivery process, but no retry
26723 information is recorded.
26724
26725 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26726 &(smtp)& transport to match those hosts for which Exim should not pass
26727 connections to new processes if TLS has been used.
26728
26729
26730
26731
26732 .section "Certificates and all that" "SECTcerandall"
26733 .cindex "certificate" "references to discussion"
26734 In order to understand fully how TLS works, you need to know about
26735 certificates, certificate signing, and certificate authorities. This is not the
26736 place to give a tutorial, especially as I do not know very much about it
26737 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26738 to Apache, currently at
26739 .display
26740 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26741 .endd
26742 Other parts of the &'modssl'& documentation are also helpful, and have
26743 links to further files.
26744 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26745 0-201-61598-3), contains both introductory and more in-depth descriptions.
26746 Some sample programs taken from the book are available from
26747 .display
26748 &url(http://www.rtfm.com/openssl-examples/)
26749 .endd
26750
26751
26752 .section "Certificate chains" "SECID186"
26753 The file named by &%tls_certificate%& may contain more than one
26754 certificate. This is useful in the case where the certificate that is being
26755 sent is validated by an intermediate certificate which the other end does
26756 not have. Multiple certificates must be in the correct order in the file.
26757 First the host's certificate itself, then the first intermediate
26758 certificate to validate the issuer of the host certificate, then the next
26759 intermediate certificate to validate the issuer of the first intermediate
26760 certificate, and so on, until finally (optionally) the root certificate.
26761 The root certificate must already be trusted by the recipient for
26762 validation to succeed, of course, but if it's not preinstalled, sending the
26763 root certificate along with the rest makes it available for the user to
26764 install if the receiving end is a client MUA that can interact with a user.
26765
26766 Note that certificates using MD5 are unlikely to work on today's Internet;
26767 even if your libraries allow loading them for use in Exim when acting as a
26768 server, increasingly clients will not accept such certificates.  The error
26769 diagnostics in such a case can be frustratingly vague.
26770
26771
26772
26773 .section "Self-signed certificates" "SECID187"
26774 .cindex "certificate" "self-signed"
26775 You can create a self-signed certificate using the &'req'& command provided
26776 with OpenSSL, like this:
26777 . ==== Do not shorten the duration here without reading and considering
26778 . ==== the text below.  Please leave it at 9999 days.
26779 .code
26780 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26781             -days 9999 -nodes
26782 .endd
26783 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26784 delimited and so can be identified independently. The &%-days%& option
26785 specifies a period for which the certificate is valid. The &%-nodes%& option is
26786 important: if you do not set it, the key is encrypted with a passphrase
26787 that you are prompted for, and any use that is made of the key causes more
26788 prompting for the passphrase. This is not helpful if you are going to use
26789 this certificate and key in an MTA, where prompting is not possible.
26790
26791 . ==== I expect to still be working 26 years from now.  The less technical
26792 . ==== debt I create, in terms of storing up trouble for my later years, the
26793 . ==== happier I will be then.  We really have reached the point where we
26794 . ==== should start, at the very least, provoking thought and making folks
26795 . ==== pause before proceeding, instead of leaving all the fixes until two
26796 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26797 . ==== -pdp, 2012
26798 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26799 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26800 the above command might produce a date in the past.  Think carefully about
26801 the lifetime of the systems you're deploying, and either reduce the duration
26802 of the certificate or reconsider your platform deployment.  (At time of
26803 writing, reducing the duration is the most likely choice, but the inexorable
26804 progression of time takes us steadily towards an era where this will not
26805 be a sensible resolution).
26806
26807 A self-signed certificate made in this way is sufficient for testing, and
26808 may be adequate for all your requirements if you are mainly interested in
26809 encrypting transfers, and not in secure identification.
26810
26811 However, many clients require that the certificate presented by the server be a
26812 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26813 certificate. In this situation, the self-signed certificate described above
26814 must be installed on the client host as a trusted root &'certification
26815 authority'& (CA), and the certificate used by Exim must be a user certificate
26816 signed with that self-signed certificate.
26817
26818 For information on creating self-signed CA certificates and using them to sign
26819 user certificates, see the &'General implementation overview'& chapter of the
26820 Open-source PKI book, available online at
26821 &url(http://ospkibook.sourceforge.net/).
26822 .ecindex IIDencsmtp1
26823 .ecindex IIDencsmtp2
26824
26825
26826
26827 . ////////////////////////////////////////////////////////////////////////////
26828 . ////////////////////////////////////////////////////////////////////////////
26829
26830 .chapter "Access control lists" "CHAPACL"
26831 .scindex IIDacl "&ACL;" "description"
26832 .cindex "control of incoming mail"
26833 .cindex "message" "controlling incoming"
26834 .cindex "policy control" "access control lists"
26835 Access Control Lists (ACLs) are defined in a separate section of the run time
26836 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26837 name, terminated by a colon. Here is a complete ACL section that contains just
26838 one very small ACL:
26839 .code
26840 begin acl
26841 small_acl:
26842   accept   hosts = one.host.only
26843 .endd
26844 You can have as many lists as you like in the ACL section, and the order in
26845 which they appear does not matter. The lists are self-terminating.
26846
26847 The majority of ACLs are used to control Exim's behaviour when it receives
26848 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26849 when a local process submits a message using SMTP by specifying the &%-bs%&
26850 option. The most common use is for controlling which recipients are accepted
26851 in incoming messages. In addition, you can define an ACL that is used to check
26852 local non-SMTP messages. The default configuration file contains an example of
26853 a realistic ACL for checking RCPT commands. This is discussed in chapter
26854 &<<CHAPdefconfil>>&.
26855
26856
26857 .section "Testing ACLs" "SECID188"
26858 The &%-bh%& command line option provides a way of testing your ACL
26859 configuration locally by running a fake SMTP session with which you interact.
26860 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26861 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26862
26863
26864
26865 .section "Specifying when ACLs are used" "SECID189"
26866 .cindex "&ACL;" "options for specifying"
26867 In order to cause an ACL to be used, you have to name it in one of the relevant
26868 options in the main part of the configuration. These options are:
26869 .cindex "AUTH" "ACL for"
26870 .cindex "DATA" "ACLs for"
26871 .cindex "ETRN" "ACL for"
26872 .cindex "EXPN" "ACL for"
26873 .cindex "HELO" "ACL for"
26874 .cindex "EHLO" "ACL for"
26875 .cindex "MAIL" "ACL for"
26876 .cindex "QUIT, ACL for"
26877 .cindex "RCPT" "ACL for"
26878 .cindex "STARTTLS, ACL for"
26879 .cindex "VRFY" "ACL for"
26880 .cindex "SMTP" "connection, ACL for"
26881 .cindex "non-SMTP messages" "ACLs for"
26882 .cindex "MIME content scanning" "ACL for"
26883 .cindex "PRDR" "ACL for"
26884
26885 .table2 140pt
26886 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26887 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26888 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26889 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26890 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26891 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26892 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26893 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26894 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26895 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26896 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26897 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26898 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26899 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26900 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26901 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26902 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26903 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26904 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26905 .endtable
26906
26907 For example, if you set
26908 .code
26909 acl_smtp_rcpt = small_acl
26910 .endd
26911 the little ACL defined above is used whenever Exim receives a RCPT command
26912 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26913 done when RCPT commands arrive. A rejection of RCPT should cause the
26914 sending MTA to give up on the recipient address contained in the RCPT
26915 command, whereas rejection at other times may cause the client MTA to keep on
26916 trying to deliver the message. It is therefore recommended that you do as much
26917 testing as possible at RCPT time.
26918
26919
26920 .section "The non-SMTP ACLs" "SECID190"
26921 .cindex "non-SMTP messages" "ACLs for"
26922 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26923 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26924 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26925 the state of the SMTP connection such as encryption and authentication) are not
26926 relevant and are forbidden in these ACLs. However, the sender and recipients
26927 are known, so the &%senders%& and &%sender_domains%& conditions and the
26928 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26929 &$authenticated_sender$& are also available. You can specify added header lines
26930 in any of these ACLs.
26931
26932 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26933 non-SMTP message, before any of the message has been read. (This is the
26934 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26935 batched SMTP input, it runs after the DATA command has been reached. The
26936 result of this ACL is ignored; it cannot be used to reject a message. If you
26937 really need to, you could set a value in an ACL variable here and reject based
26938 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26939 controls, and in particular, it can be used to set
26940 .code
26941 control = suppress_local_fixups
26942 .endd
26943 This cannot be used in the other non-SMTP ACLs because by the time they are
26944 run, it is too late.
26945
26946 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26947 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26948
26949 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26950 kind of rejection is treated as permanent, because there is no way of sending a
26951 temporary error for these kinds of message.
26952
26953
26954 .section "The SMTP connect ACL" "SECID191"
26955 .cindex "SMTP" "connection, ACL for"
26956 .oindex &%smtp_banner%&
26957 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26958 session, after the test specified by &%host_reject_connection%& (which is now
26959 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26960 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26961 the message override the banner message that is otherwise specified by the
26962 &%smtp_banner%& option.
26963
26964
26965 .section "The EHLO/HELO ACL" "SECID192"
26966 .cindex "EHLO" "ACL for"
26967 .cindex "HELO" "ACL for"
26968 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26969 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26970 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26971 Note that a client may issue more than one EHLO or HELO command in an SMTP
26972 session, and indeed is required to issue a new EHLO or HELO after successfully
26973 setting up encryption following a STARTTLS command.
26974
26975 If the command is accepted by an &%accept%& verb that has a &%message%&
26976 modifier, the message may not contain more than one line (it will be truncated
26977 at the first newline and a panic logged if it does). Such a message cannot
26978 affect the EHLO options that are listed on the second and subsequent lines of
26979 an EHLO response.
26980
26981
26982 .section "The DATA ACLs" "SECID193"
26983 .cindex "DATA" "ACLs for"
26984 Two ACLs are associated with the DATA command, because it is two-stage
26985 command, with two responses being sent to the client.
26986 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26987 is obeyed. This gives you control after all the RCPT commands, but before
26988 the message itself is received. It offers the opportunity to give a negative
26989 response to the DATA command before the data is transmitted. Header lines
26990 added by MAIL or RCPT ACLs are not visible at this time, but any that
26991 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26992
26993 You cannot test the contents of the message, for example, to verify addresses
26994 in the headers, at RCPT time or when the DATA command is received. Such
26995 tests have to appear in the ACL that is run after the message itself has been
26996 received, before the final response to the DATA command is sent. This is
26997 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26998 associated with the DATA command.
26999
27000 For both of these ACLs, it is not possible to reject individual recipients. An
27001 error response rejects the entire message. Unfortunately, it is known that some
27002 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27003 before or after the data) correctly &-- they keep the message on their queues
27004 and try again later, but that is their problem, though it does waste some of
27005 your resources.
27006
27007 The &%acl_smtp_data%& ACL is run after
27008 the &%acl_smtp_data_prdr%&,
27009 the &%acl_smtp_dkim%&
27010 and the &%acl_smtp_mime%& ACLs.
27011
27012 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27013 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27014 enabled (which is the default).
27015
27016 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27017 received, and is executed for each DKIM signature found in a message.  If not
27018 otherwise specified, the default action is to accept.
27019
27020 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27021
27022 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27023
27024
27025 .section "The SMTP MIME ACL" "SECID194"
27026 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27027 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27028
27029 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27030
27031
27032 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27033 .cindex "PRDR" "ACL for"
27034 .oindex "&%prdr_enable%&"
27035 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27036 with PRDR support enabled (which is the default).
27037 It becomes active only when the PRDR feature is negotiated between
27038 client and server for a message, and more than one recipient
27039 has been accepted.
27040
27041 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
27042 has been recieved, and is executed once for each recipient of the message
27043 with &$local_part$& and &$domain$& valid.
27044 The test may accept, defer or deny for inividual recipients.
27045 The &%acl_smtp_data%& will still be called after this ACL and
27046 can reject the message overall, even if this ACL has accepted it
27047 for some or all recipients.
27048
27049 PRDR may be used to support per-user content filtering.  Without it
27050 one must defer any recipient after the first that has a different
27051 content-filter configuration.  With PRDR, the RCPT-time check
27052 for this can be disabled when the MAIL-time $smtp_command included
27053 "PRDR".  Any required difference in behaviour of the main DATA-time
27054 ACL should however depend on the PRDR-time ACL having run, as Exim
27055 will avoid doing so in some situations (eg.  single-recipient mails).
27056
27057 See also the &%prdr_enable%& global option
27058 and the &%hosts_try_prdr%& smtp transport option.
27059
27060 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27061 If the ACL is not defined, processing completes as if
27062 the feature was not requested by the client.
27063
27064 .section "The QUIT ACL" "SECTQUITACL"
27065 .cindex "QUIT, ACL for"
27066 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27067 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27068 does not in fact control any access. For this reason, the only verbs that are
27069 permitted are &%accept%& and &%warn%&.
27070
27071 This ACL can be used for tasks such as custom logging at the end of an SMTP
27072 session. For example, you can use ACL variables in other ACLs to count
27073 messages, recipients, etc., and log the totals at QUIT time using one or
27074 more &%logwrite%& modifiers on a &%warn%& verb.
27075
27076 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27077 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27078
27079 You do not need to have a final &%accept%&, but if you do, you can use a
27080 &%message%& modifier to specify custom text that is sent as part of the 221
27081 response to QUIT.
27082
27083 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27084 failure (for example, failure to open a log file, or when Exim is bombing out
27085 because it has detected an unrecoverable error), all SMTP commands from the
27086 client are given temporary error responses until QUIT is received or the
27087 connection is closed. In these special cases, the QUIT ACL does not run.
27088
27089
27090 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27091 .vindex &$acl_smtp_notquit$&
27092 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27093 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27094 trouble, such as being unable to write to its log files, this ACL is not run,
27095 because it might try to do things (such as write to log files) that make the
27096 situation even worse.
27097
27098 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27099 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27100 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27101 and &%warn%&.
27102
27103 .vindex &$smtp_notquit_reason$&
27104 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27105 to a string that indicates the reason for the termination of the SMTP
27106 connection. The possible values are:
27107 .table2
27108 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27109 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27110 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27111 .irow &`connection-lost`&          "The SMTP connection has been lost"
27112 .irow &`data-timeout`&             "Timeout while reading message data"
27113 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27114 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27115 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27116 .irow &`synchronization-error`&    "SMTP synchronization error"
27117 .irow &`tls-failed`&               "TLS failed to start"
27118 .endtable
27119 In most cases when an SMTP connection is closed without having received QUIT,
27120 Exim sends an SMTP response message before actually closing the connection.
27121 With the exception of the &`acl-drop`& case, the default message can be
27122 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27123 &%drop%& verb in another ACL, it is the message from the other ACL that is
27124 used.
27125
27126
27127 .section "Finding an ACL to use" "SECID195"
27128 .cindex "&ACL;" "finding which to use"
27129 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27130 you can use different ACLs in different circumstances. For example,
27131 .code
27132 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27133                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27134 .endd
27135 In the default configuration file there are some example settings for
27136 providing an RFC 4409 message submission service on port 587 and a
27137 non-standard &"smtps"& service on port 465. You can use a string
27138 expansion like this to choose an ACL for MUAs on these ports which is
27139 more appropriate for this purpose than the default ACL on port 25.
27140
27141 The expanded string does not have to be the name of an ACL in the
27142 configuration file; there are other possibilities. Having expanded the
27143 string, Exim searches for an ACL as follows:
27144
27145 .ilist
27146 If the string begins with a slash, Exim uses it as a file name, and reads its
27147 contents as an ACL. The lines are processed in the same way as lines in the
27148 Exim configuration file. In particular, continuation lines are supported, blank
27149 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27150 If the file does not exist or cannot be read, an error occurs (typically
27151 causing a temporary failure of whatever caused the ACL to be run). For example:
27152 .code
27153 acl_smtp_data = /etc/acls/\
27154   ${lookup{$sender_host_address}lsearch\
27155   {/etc/acllist}{$value}{default}}
27156 .endd
27157 This looks up an ACL file to use on the basis of the host's IP address, falling
27158 back to a default if the lookup fails. If an ACL is successfully read from a
27159 file, it is retained in memory for the duration of the Exim process, so that it
27160 can be re-used without having to re-read the file.
27161 .next
27162 If the string does not start with a slash, and does not contain any spaces,
27163 Exim searches the ACL section of the configuration for an ACL whose name
27164 matches the string.
27165 .next
27166 If no named ACL is found, or if the string contains spaces, Exim parses
27167 the string as an inline ACL. This can save typing in cases where you just
27168 want to have something like
27169 .code
27170 acl_smtp_vrfy = accept
27171 .endd
27172 in order to allow free use of the VRFY command. Such a string may contain
27173 newlines; it is processed in the same way as an ACL that is read from a file.
27174 .endlist
27175
27176
27177
27178
27179 .section "ACL return codes" "SECID196"
27180 .cindex "&ACL;" "return codes"
27181 Except for the QUIT ACL, which does not affect the SMTP return code (see
27182 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27183 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27184 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27185 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27186 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27187 This also causes a 4&'xx'& return code.
27188
27189 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27190 &"deny"&, because there is no mechanism for passing temporary errors to the
27191 submitters of non-SMTP messages.
27192
27193
27194 ACLs that are relevant to message reception may also return &"discard"&. This
27195 has the effect of &"accept"&, but causes either the entire message or an
27196 individual recipient address to be discarded. In other words, it is a
27197 blackholing facility. Use it with care.
27198
27199 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27200 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27201 RCPT ACL is to discard just the one recipient address. If there are no
27202 recipients left when the message's data is received, the DATA ACL is not
27203 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27204 remaining recipients. The &"discard"& return is not permitted for the
27205 &%acl_smtp_predata%& ACL.
27206
27207
27208 .cindex "&[local_scan()]& function" "when all recipients discarded"
27209 The &[local_scan()]& function is always run, even if there are no remaining
27210 recipients; it may create new recipients.
27211
27212
27213
27214 .section "Unset ACL options" "SECID197"
27215 .cindex "&ACL;" "unset options"
27216 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27217 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27218 not defined at all. For any defined ACL, the default action when control
27219 reaches the end of the ACL statements is &"deny"&.
27220
27221 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27222 these two are ACLs that are used only for their side effects. They cannot be
27223 used to accept or reject anything.
27224
27225 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27226 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27227 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27228 when the ACL is not defined is &"accept"&.
27229
27230 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27231 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27232 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27233 messages over an SMTP connection. For an example, see the ACL in the default
27234 configuration file.
27235
27236
27237
27238
27239 .section "Data for message ACLs" "SECID198"
27240 .cindex "&ACL;" "data for message ACL"
27241 .vindex &$domain$&
27242 .vindex &$local_part$&
27243 .vindex &$sender_address$&
27244 .vindex &$sender_host_address$&
27245 .vindex &$smtp_command$&
27246 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27247 that contain information about the host and the message's sender (for example,
27248 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27249 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27250 &$local_part$& are set from the argument address. The entire SMTP command
27251 is available in &$smtp_command$&.
27252
27253 When an ACL for the AUTH parameter of MAIL is running, the variables that
27254 contain information about the host are set, but &$sender_address$& is not yet
27255 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27256 how it is used.
27257
27258 .vindex "&$message_size$&"
27259 The &$message_size$& variable is set to the value of the SIZE parameter on
27260 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27261 that parameter is not given. The value is updated to the true message size by
27262 the time the final DATA ACL is run (after the message data has been
27263 received).
27264
27265 .vindex "&$rcpt_count$&"
27266 .vindex "&$recipients_count$&"
27267 The &$rcpt_count$& variable increases by one for each RCPT command received.
27268 The &$recipients_count$& variable increases by one each time a RCPT command is
27269 accepted, so while an ACL for RCPT is being processed, it contains the number
27270 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27271 &$rcpt_count$& contains the total number of RCPT commands, and
27272 &$recipients_count$& contains the total number of accepted recipients.
27273
27274
27275
27276
27277
27278 .section "Data for non-message ACLs" "SECTdatfornon"
27279 .cindex "&ACL;" "data for non-message ACL"
27280 .vindex &$smtp_command_argument$&
27281 .vindex &$smtp_command$&
27282 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27283 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27284 and the entire SMTP command is available in &$smtp_command$&.
27285 These variables can be tested using a &%condition%& condition. For example,
27286 here is an ACL for use with AUTH, which insists that either the session is
27287 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27288 does not permit authentication methods that use cleartext passwords on
27289 unencrypted connections.
27290 .code
27291 acl_check_auth:
27292   accept encrypted = *
27293   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27294                      {CRAM-MD5}}
27295   deny   message   = TLS encryption or CRAM-MD5 required
27296 .endd
27297 (Another way of applying this restriction is to arrange for the authenticators
27298 that use cleartext passwords not to be advertised when the connection is not
27299 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27300 option to do this.)
27301
27302
27303
27304 .section "Format of an ACL" "SECID199"
27305 .cindex "&ACL;" "format of"
27306 .cindex "&ACL;" "verbs, definition of"
27307 An individual ACL consists of a number of statements. Each statement starts
27308 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27309 Modifiers can change the way the verb operates, define error and log messages,
27310 set variables, insert delays, and vary the processing of accepted messages.
27311
27312 If all the conditions are met, the verb is obeyed. The same condition may be
27313 used (with different arguments) more than once in the same statement. This
27314 provides a means of specifying an &"and"& conjunction between conditions. For
27315 example:
27316 .code
27317 deny  dnslists = list1.example
27318 dnslists = list2.example
27319 .endd
27320 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27321 the conditions and modifiers when it reaches a condition that fails. What
27322 happens then depends on the verb (and in one case, on a special modifier). Not
27323 all the conditions make sense at every testing point. For example, you cannot
27324 test a sender address in the ACL that is run for a VRFY command.
27325
27326
27327 .section "ACL verbs" "SECID200"
27328 The ACL verbs are as follows:
27329
27330 .ilist
27331 .cindex "&%accept%& ACL verb"
27332 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27333 of the conditions are not met, what happens depends on whether &%endpass%&
27334 appears among the conditions (for syntax see below). If the failing condition
27335 is before &%endpass%&, control is passed to the next ACL statement; if it is
27336 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27337 check a RCPT command:
27338 .code
27339 accept domains = +local_domains
27340 endpass
27341 verify = recipient
27342 .endd
27343 If the recipient domain does not match the &%domains%& condition, control
27344 passes to the next statement. If it does match, the recipient is verified, and
27345 the command is accepted if verification succeeds. However, if verification
27346 fails, the ACL yields &"deny"&, because the failing condition is after
27347 &%endpass%&.
27348
27349 The &%endpass%& feature has turned out to be confusing to many people, so its
27350 use is not recommended nowadays. It is always possible to rewrite an ACL so
27351 that &%endpass%& is not needed, and it is no longer used in the default
27352 configuration.
27353
27354 .cindex "&%message%& ACL modifier" "with &%accept%&"
27355 If a &%message%& modifier appears on an &%accept%& statement, its action
27356 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27357 (when an &%accept%& verb either accepts or passes control to the next
27358 statement), &%message%& can be used to vary the message that is sent when an
27359 SMTP command is accepted. For example, in a RCPT ACL you could have:
27360 .display
27361 &`accept  `&<&'some conditions'&>
27362 &`        message = OK, I will allow you through today`&
27363 .endd
27364 You can specify an SMTP response code, optionally followed by an &"extended
27365 response code"& at the start of the message, but the first digit must be the
27366 same as would be sent by default, which is 2 for an &%accept%& verb.
27367
27368 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27369 an error message that is used when access is denied. This behaviour is retained
27370 for backward compatibility, but current &"best practice"& is to avoid the use
27371 of &%endpass%&.
27372
27373
27374 .next
27375 .cindex "&%defer%& ACL verb"
27376 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27377 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27378 &%defer%& is the same as &%deny%&, because there is no way of sending a
27379 temporary error. For a RCPT command, &%defer%& is much the same as using a
27380 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27381 be used in any ACL, and even for a recipient it might be a simpler approach.
27382
27383
27384 .next
27385 .cindex "&%deny%& ACL verb"
27386 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27387 the conditions are not met, control is passed to the next ACL statement. For
27388 example,
27389 .code
27390 deny dnslists = blackholes.mail-abuse.org
27391 .endd
27392 rejects commands from hosts that are on a DNS black list.
27393
27394
27395 .next
27396 .cindex "&%discard%& ACL verb"
27397 &%discard%&: This verb behaves like &%accept%&, except that it returns
27398 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27399 that are concerned with receiving messages. When all the conditions are true,
27400 the sending entity receives a &"success"& response. However, &%discard%& causes
27401 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27402 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27403 message's recipients are discarded. Recipients that are discarded before DATA
27404 do not appear in the log line when the &%received_recipients%& log selector is set.
27405
27406 If the &%log_message%& modifier is set when &%discard%& operates,
27407 its contents are added to the line that is automatically written to the log.
27408 The &%message%& modifier operates exactly as it does for &%accept%&.
27409
27410
27411 .next
27412 .cindex "&%drop%& ACL verb"
27413 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27414 forcibly closed after the 5&'xx'& error message has been sent. For example:
27415 .code
27416 drop   message   = I don't take more than 20 RCPTs
27417        condition = ${if > {$rcpt_count}{20}}
27418 .endd
27419 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27420 The connection is always dropped after sending a 550 response.
27421
27422 .next
27423 .cindex "&%require%& ACL verb"
27424 &%require%&: If all the conditions are met, control is passed to the next ACL
27425 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27426 example, when checking a RCPT command,
27427 .code
27428 require message = Sender did not verify
27429         verify  = sender
27430 .endd
27431 passes control to subsequent statements only if the message's sender can be
27432 verified. Otherwise, it rejects the command. Note the positioning of the
27433 &%message%& modifier, before the &%verify%& condition. The reason for this is
27434 discussed in section &<<SECTcondmodproc>>&.
27435
27436 .next
27437 .cindex "&%warn%& ACL verb"
27438 &%warn%&: If all the conditions are true, a line specified by the
27439 &%log_message%& modifier is written to Exim's main log. Control always passes
27440 to the next ACL statement. If any condition is false, the log line is not
27441 written. If an identical log line is requested several times in the same
27442 message, only one copy is actually written to the log. If you want to force
27443 duplicates to be written, use the &%logwrite%& modifier instead.
27444
27445 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27446 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27447 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27448 first failing condition. There is more about adding header lines in section
27449 &<<SECTaddheadacl>>&.
27450
27451 If any condition on a &%warn%& statement cannot be completed (that is, there is
27452 some sort of defer), the log line specified by &%log_message%& is not written.
27453 This does not include the case of a forced failure from a lookup, which
27454 is considered to be a successful completion. After a defer, no further
27455 conditions or modifiers in the &%warn%& statement are processed. The incident
27456 is logged, and the ACL continues to be processed, from the next statement
27457 onwards.
27458
27459
27460 .vindex "&$acl_verify_message$&"
27461 When one of the &%warn%& conditions is an address verification that fails, the
27462 text of the verification failure message is in &$acl_verify_message$&. If you
27463 want this logged, you must set it up explicitly. For example:
27464 .code
27465 warn   !verify = sender
27466        log_message = sender verify failed: $acl_verify_message
27467 .endd
27468 .endlist
27469
27470 At the end of each ACL there is an implicit unconditional &%deny%&.
27471
27472 As you can see from the examples above, the conditions and modifiers are
27473 written one to a line, with the first one on the same line as the verb, and
27474 subsequent ones on following lines. If you have a very long condition, you can
27475 continue it onto several physical lines by the usual backslash continuation
27476 mechanism. It is conventional to align the conditions vertically.
27477
27478
27479
27480 .section "ACL variables" "SECTaclvariables"
27481 .cindex "&ACL;" "variables"
27482 There are some special variables that can be set during ACL processing. They
27483 can be used to pass information between different ACLs, different invocations
27484 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27485 transports, and filters that are used to deliver a message. The names of these
27486 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27487 an underscore, but the remainder of the name can be any sequence of
27488 alphanumeric characters and underscores that you choose. There is no limit on
27489 the number of ACL variables. The two sets act as follows:
27490 .ilist
27491 The values of those variables whose names begin with &$acl_c$& persist
27492 throughout an SMTP connection. They are never reset. Thus, a value that is set
27493 while receiving one message is still available when receiving the next message
27494 on the same SMTP connection.
27495 .next
27496 The values of those variables whose names begin with &$acl_m$& persist only
27497 while a message is being received. They are reset afterwards. They are also
27498 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27499 .endlist
27500
27501 When a message is accepted, the current values of all the ACL variables are
27502 preserved with the message and are subsequently made available at delivery
27503 time. The ACL variables are set by a modifier called &%set%&. For example:
27504 .code
27505 accept hosts = whatever
27506        set acl_m4 = some value
27507 accept authenticated = *
27508        set acl_c_auth = yes
27509 .endd
27510 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27511 be set. If you want to set a variable without taking any action, you can use a
27512 &%warn%& verb without any other modifiers or conditions.
27513
27514 .oindex &%strict_acl_vars%&
27515 What happens if a syntactically valid but undefined ACL variable is
27516 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27517 false (the default), an empty string is substituted; if it is true, an
27518 error is generated.
27519
27520 Versions of Exim before 4.64 have a limited set of numbered variables, but
27521 their names are compatible, so there is no problem with upgrading.
27522
27523
27524 .section "Condition and modifier processing" "SECTcondmodproc"
27525 .cindex "&ACL;" "conditions; processing"
27526 .cindex "&ACL;" "modifiers; processing"
27527 An exclamation mark preceding a condition negates its result. For example:
27528 .code
27529 deny   domains = *.dom.example
27530       !verify  = recipient
27531 .endd
27532 causes the ACL to return &"deny"& if the recipient domain ends in
27533 &'dom.example'& and the recipient address cannot be verified. Sometimes
27534 negation can be used on the right-hand side of a condition. For example, these
27535 two statements are equivalent:
27536 .code
27537 deny  hosts = !192.168.3.4
27538 deny !hosts =  192.168.3.4
27539 .endd
27540 However, for many conditions (&%verify%& being a good example), only left-hand
27541 side negation of the whole condition is possible.
27542
27543 The arguments of conditions and modifiers are expanded. A forced failure
27544 of an expansion causes a condition to be ignored, that is, it behaves as if the
27545 condition is true. Consider these two statements:
27546 .code
27547 accept  senders = ${lookup{$host_name}lsearch\
27548                   {/some/file}{$value}fail}
27549 accept  senders = ${lookup{$host_name}lsearch\
27550                   {/some/file}{$value}{}}
27551 .endd
27552 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27553 the returned list is searched, but if the lookup fails the behaviour is
27554 different in the two cases. The &%fail%& in the first statement causes the
27555 condition to be ignored, leaving no further conditions. The &%accept%& verb
27556 therefore succeeds. The second statement, however, generates an empty list when
27557 the lookup fails. No sender can match an empty list, so the condition fails,
27558 and therefore the &%accept%& also fails.
27559
27560 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27561 specify actions that are taken as the conditions for a statement are checked;
27562 others specify text for messages that are used when access is denied or a
27563 warning is generated. The &%control%& modifier affects the way an incoming
27564 message is handled.
27565
27566 The positioning of the modifiers in an ACL statement is important, because the
27567 processing of a verb ceases as soon as its outcome is known. Only those
27568 modifiers that have already been encountered will take effect. For example,
27569 consider this use of the &%message%& modifier:
27570 .code
27571 require message = Can't verify sender
27572         verify  = sender
27573         message = Can't verify recipient
27574         verify  = recipient
27575         message = This message cannot be used
27576 .endd
27577 If sender verification fails, Exim knows that the result of the statement is
27578 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27579 so its text is used as the error message. If sender verification succeeds, but
27580 recipient verification fails, the second message is used. If recipient
27581 verification succeeds, the third message becomes &"current"&, but is never used
27582 because there are no more conditions to cause failure.
27583
27584 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27585 modifier that is used, because all the conditions must be true for rejection to
27586 happen. Specifying more than one &%message%& modifier does not make sense, and
27587 the message can even be specified after all the conditions. For example:
27588 .code
27589 deny   hosts = ...
27590       !senders = *@my.domain.example
27591        message = Invalid sender from client host
27592 .endd
27593 The &"deny"& result does not happen until the end of the statement is reached,
27594 by which time Exim has set up the message.
27595
27596
27597
27598 .section "ACL modifiers" "SECTACLmodi"
27599 .cindex "&ACL;" "modifiers; list of"
27600 The ACL modifiers are as follows:
27601
27602 .vlist
27603 .vitem &*add_header*&&~=&~<&'text'&>
27604 This modifier specifies one or more header lines that are to be added to an
27605 incoming message, assuming, of course, that the message is ultimately
27606 accepted. For details, see section &<<SECTaddheadacl>>&.
27607
27608 .vitem &*continue*&&~=&~<&'text'&>
27609 .cindex "&%continue%& ACL modifier"
27610 .cindex "database" "updating in ACL"
27611 This modifier does nothing of itself, and processing of the ACL always
27612 continues with the next condition or modifier. The value of &%continue%& is in
27613 the side effects of expanding its argument. Typically this could be used to
27614 update a database. It is really just a syntactic tidiness, to avoid having to
27615 write rather ugly lines like this:
27616 .display
27617 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27618 .endd
27619 Instead, all you need is
27620 .display
27621 &`continue = `&<&'some expansion'&>
27622 .endd
27623
27624 .vitem &*control*&&~=&~<&'text'&>
27625 .cindex "&%control%& ACL modifier"
27626 This modifier affects the subsequent processing of the SMTP connection or of an
27627 incoming message that is accepted. The effect of the first type of control
27628 lasts for the duration of the connection, whereas the effect of the second type
27629 lasts only until the current message has been received. The message-specific
27630 controls always apply to the whole message, not to individual recipients,
27631 even if the &%control%& modifier appears in a RCPT ACL.
27632
27633 As there are now quite a few controls that can be applied, they are described
27634 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27635 in several different ways. For example:
27636
27637 . ==== As this is a nested list, any displays it contains must be indented
27638 . ==== as otherwise they are too far to the left. That comment applies only
27639 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27640 . ==== way.
27641
27642 .ilist
27643 It can be at the end of an &%accept%& statement:
27644 .code
27645     accept  ...some conditions
27646             control = queue_only
27647 .endd
27648 In this case, the control is applied when this statement yields &"accept"&, in
27649 other words, when the conditions are all true.
27650
27651 .next
27652 It can be in the middle of an &%accept%& statement:
27653 .code
27654     accept  ...some conditions...
27655             control = queue_only
27656             ...some more conditions...
27657 .endd
27658 If the first set of conditions are true, the control is applied, even if the
27659 statement does not accept because one of the second set of conditions is false.
27660 In this case, some subsequent statement must yield &"accept"& for the control
27661 to be relevant.
27662
27663 .next
27664 It can be used with &%warn%& to apply the control, leaving the
27665 decision about accepting or denying to a subsequent verb. For
27666 example:
27667 .code
27668     warn    ...some conditions...
27669             control = freeze
27670     accept  ...
27671 .endd
27672 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27673 &%logwrite%&, so it does not add anything to the message and does not write a
27674 log entry.
27675
27676 .next
27677 If you want to apply a control unconditionally, you can use it with a
27678 &%require%& verb. For example:
27679 .code
27680     require  control = no_multiline_responses
27681 .endd
27682 .endlist
27683
27684 .vitem &*delay*&&~=&~<&'time'&>
27685 .cindex "&%delay%& ACL modifier"
27686 .oindex "&%-bh%&"
27687 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27688 the time interval before proceeding. However, when testing Exim using the
27689 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27690 output instead). The time is given in the usual Exim notation, and the delay
27691 happens as soon as the modifier is processed. In an SMTP session, pending
27692 output is flushed before the delay is imposed.
27693
27694 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27695 example:
27696 .code
27697 deny    ...some conditions...
27698         delay = 30s
27699 .endd
27700 The delay happens if all the conditions are true, before the statement returns
27701 &"deny"&. Compare this with:
27702 .code
27703 deny    delay = 30s
27704         ...some conditions...
27705 .endd
27706 which waits for 30s before processing the conditions. The &%delay%& modifier
27707 can also be used with &%warn%& and together with &%control%&:
27708 .code
27709 warn    ...some conditions...
27710         delay = 2m
27711         control = freeze
27712 accept  ...
27713 .endd
27714
27715 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27716 responses to several commands are no longer buffered and sent in one packet (as
27717 they would normally be) because all output is flushed before imposing the
27718 delay. This optimization is disabled so that a number of small delays do not
27719 appear to the client as one large aggregated delay that might provoke an
27720 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27721 using a &%control%& modifier to set &%no_delay_flush%&.
27722
27723
27724 .vitem &*endpass*&
27725 .cindex "&%endpass%& ACL modifier"
27726 This modifier, which has no argument, is recognized only in &%accept%& and
27727 &%discard%& statements. It marks the boundary between the conditions whose
27728 failure causes control to pass to the next statement, and the conditions whose
27729 failure causes the ACL to return &"deny"&. This concept has proved to be
27730 confusing to some people, so the use of &%endpass%& is no longer recommended as
27731 &"best practice"&. See the description of &%accept%& above for more details.
27732
27733
27734 .vitem &*log_message*&&~=&~<&'text'&>
27735 .cindex "&%log_message%& ACL modifier"
27736 This modifier sets up a message that is used as part of the log message if the
27737 ACL denies access or a &%warn%& statement's conditions are true. For example:
27738 .code
27739 require log_message = wrong cipher suite $tls_in_cipher
27740         encrypted   = DES-CBC3-SHA
27741 .endd
27742 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27743 example:
27744 .display
27745 &`discard `&<&'some conditions'&>
27746 &`        log_message = Discarded $local_part@$domain because...`&
27747 .endd
27748 When access is denied, &%log_message%& adds to any underlying error message
27749 that may exist because of a condition failure. For example, while verifying a
27750 recipient address, a &':fail:'& redirection might have already set up a
27751 message.
27752
27753 The message may be defined before the conditions to which it applies, because
27754 the string expansion does not happen until Exim decides that access is to be
27755 denied. This means that any variables that are set by the condition are
27756 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27757 variables are set after a DNS black list lookup succeeds. If the expansion of
27758 &%log_message%& fails, or if the result is an empty string, the modifier is
27759 ignored.
27760
27761 .vindex "&$acl_verify_message$&"
27762 If you want to use a &%warn%& statement to log the result of an address
27763 verification, you can use &$acl_verify_message$& to include the verification
27764 error message.
27765
27766 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27767 the start of the logged message. If the same warning log message is requested
27768 more than once while receiving  a single email message, only one copy is
27769 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27770 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27771 is logged for a successful &%warn%& statement.
27772
27773 If &%log_message%& is not present and there is no underlying error message (for
27774 example, from the failure of address verification), but &%message%& is present,
27775 the &%message%& text is used for logging rejections. However, if any text for
27776 logging contains newlines, only the first line is logged. In the absence of
27777 both &%log_message%& and &%message%&, a default built-in message is used for
27778 logging rejections.
27779
27780
27781 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27782 .cindex "&%log_reject_target%& ACL modifier"
27783 .cindex "logging in ACL" "specifying which log"
27784 This modifier makes it possible to specify which logs are used for messages
27785 about ACL rejections. Its argument is a colon-separated list of words that can
27786 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27787 may be empty, in which case a rejection is not logged at all. For example, this
27788 ACL fragment writes no logging information when access is denied:
27789 .display
27790 &`deny `&<&'some conditions'&>
27791 &`     log_reject_target =`&
27792 .endd
27793 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27794 permanent and temporary rejections. Its effect lasts for the rest of the
27795 current ACL.
27796
27797
27798 .vitem &*logwrite*&&~=&~<&'text'&>
27799 .cindex "&%logwrite%& ACL modifier"
27800 .cindex "logging in ACL" "immediate"
27801 This modifier writes a message to a log file as soon as it is encountered when
27802 processing an ACL. (Compare &%log_message%&, which, except in the case of
27803 &%warn%& and &%discard%&, is used only if the ACL statement denies
27804 access.) The &%logwrite%& modifier can be used to log special incidents in
27805 ACLs. For example:
27806 .display
27807 &`accept `&<&'some special conditions'&>
27808 &`       control  = freeze`&
27809 &`       logwrite = froze message because ...`&
27810 .endd
27811 By default, the message is written to the main log. However, it may begin
27812 with a colon, followed by a comma-separated list of log names, and then
27813 another colon, to specify exactly which logs are to be written. For
27814 example:
27815 .code
27816 logwrite = :main,reject: text for main and reject logs
27817 logwrite = :panic: text for panic log only
27818 .endd
27819
27820
27821 .vitem &*message*&&~=&~<&'text'&>
27822 .cindex "&%message%& ACL modifier"
27823 This modifier sets up a text string that is expanded and used as a response
27824 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27825 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27826 there is some complication if &%endpass%& is involved; see the description of
27827 &%accept%& for details.)
27828
27829 The expansion of the message happens at the time Exim decides that the ACL is
27830 to end, not at the time it processes &%message%&. If the expansion fails, or
27831 generates an empty string, the modifier is ignored. Here is an example where
27832 &%message%& must be specified first, because the ACL ends with a rejection if
27833 the &%hosts%& condition fails:
27834 .code
27835 require  message = Host not recognized
27836          hosts = 10.0.0.0/8
27837 .endd
27838 (Once a condition has failed, no further conditions or modifiers are
27839 processed.)
27840
27841 .cindex "SMTP" "error codes"
27842 .oindex "&%smtp_banner%&
27843 For ACLs that are triggered by SMTP commands, the message is returned as part
27844 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27845 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27846 is accepted. In the case of the connect ACL, accepting with a message modifier
27847 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27848 accept message may not contain more than one line (otherwise it will be
27849 truncated at the first newline and a panic logged), and it cannot affect the
27850 EHLO options.
27851
27852 When SMTP is involved, the message may begin with an overriding response code,
27853 consisting of three digits optionally followed by an &"extended response code"&
27854 of the form &'n.n.n'&, each code being followed by a space. For example:
27855 .code
27856 deny  message = 599 1.2.3 Host not welcome
27857       hosts = 192.168.34.0/24
27858 .endd
27859 The first digit of the supplied response code must be the same as would be sent
27860 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27861 access, but for the predata ACL, note that the default success code is 354, not
27862 2&'xx'&.
27863
27864 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27865 the message modifier cannot override the 221 response code.
27866
27867 The text in a &%message%& modifier is literal; any quotes are taken as
27868 literals, but because the string is expanded, backslash escapes are processed
27869 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27870 response.
27871
27872 .vindex "&$acl_verify_message$&"
27873 .new
27874 For ACLs that are called by an &%acl =%& ACL condition, the message is
27875 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27876 .wen
27877
27878 If &%message%& is used on a statement that verifies an address, the message
27879 specified overrides any message that is generated by the verification process.
27880 However, the original message is available in the variable
27881 &$acl_verify_message$&, so you can incorporate it into your message if you
27882 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27883 routers to be passed back as part of the SMTP response, you should either not
27884 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27885
27886 For compatibility with previous releases of Exim, a &%message%& modifier that
27887 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27888 modifier, but this usage is now deprecated. However, &%message%& acts only when
27889 all the conditions are true, wherever it appears in an ACL command, whereas
27890 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27891 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27892 effect.
27893
27894
27895 .vitem &*remove_header*&&~=&~<&'text'&>
27896 This modifier specifies one or more header names in a colon-separated list
27897  that are to be removed from an incoming message, assuming, of course, that
27898 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27899
27900
27901 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27902 .cindex "&%set%& ACL modifier"
27903 This modifier puts a value into one of the ACL variables (see section
27904 &<<SECTaclvariables>>&).
27905
27906
27907 .vitem &*udpsend*&&~=&~<&'parameters'&>
27908 This modifier sends a UDP packet, for purposes such as statistics
27909 collection or behaviour monitoring. The parameters are expanded, and
27910 the result of the expansion must be a colon-separated list consisting
27911 of a destination server, port number, and the packet contents. The
27912 server can be specified as a host name or IPv4 or IPv6 address. The
27913 separator can be changed with the usual angle bracket syntax. For
27914 example, you might want to collect information on which hosts connect
27915 when:
27916 .code
27917 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27918              $tod_zulu $sender_host_address
27919 .endd
27920 .endlist
27921
27922
27923
27924
27925 .section "Use of the control modifier" "SECTcontrols"
27926 .cindex "&%control%& ACL modifier"
27927 The &%control%& modifier supports the following settings:
27928
27929 .vlist
27930 .vitem &*control&~=&~allow_auth_unadvertised*&
27931 This modifier allows a client host to use the SMTP AUTH command even when it
27932 has not been advertised in response to EHLO. Furthermore, because there are
27933 apparently some really broken clients that do this, Exim will accept AUTH after
27934 HELO (rather than EHLO) when this control is set. It should be used only if you
27935 really need it, and you should limit its use to those broken clients that do
27936 not work without it. For example:
27937 .code
27938 warn hosts   = 192.168.34.25
27939      control = allow_auth_unadvertised
27940 .endd
27941 Normally, when an Exim server receives an AUTH command, it checks the name of
27942 the authentication mechanism that is given in the command to ensure that it
27943 matches an advertised mechanism. When this control is set, the check that a
27944 mechanism has been advertised is bypassed. Any configured mechanism can be used
27945 by the client. This control is permitted only in the connection and HELO ACLs.
27946
27947
27948 .vitem &*control&~=&~caseful_local_part*& &&&
27949        &*control&~=&~caselower_local_part*&
27950 .cindex "&ACL;" "case of local part in"
27951 .cindex "case of local parts"
27952 .vindex "&$local_part$&"
27953 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27954 (that is, during RCPT processing). By default, the contents of &$local_part$&
27955 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27956 any uppercase letters in the original local part are restored in &$local_part$&
27957 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27958 is encountered.
27959
27960 These controls affect only the current recipient. Moreover, they apply only to
27961 local part handling that takes place directly in the ACL (for example, as a key
27962 in lookups). If a test to verify the recipient is obeyed, the case-related
27963 handling of the local part during the verification is controlled by the router
27964 configuration (see the &%caseful_local_part%& generic router option).
27965
27966 This facility could be used, for example, to add a spam score to local parts
27967 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27968 spam score:
27969 .code
27970 warn  control = caseful_local_part
27971       set acl_m4 = ${eval:\
27972                      $acl_m4 + \
27973                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27974                     }
27975       control = caselower_local_part
27976 .endd
27977 Notice that we put back the lower cased version afterwards, assuming that
27978 is what is wanted for subsequent tests.
27979
27980
27981 .vitem &*control&~=&~cutthrough_delivery*&
27982 .cindex "&ACL;" "cutthrough routing"
27983 .cindex "cutthrough" "requesting"
27984 This option requests delivery be attempted while the item is being received.
27985 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27986 from one SMTP connection to another.  If a recipient-verify callout connection is
27987 requested in the same ACL it is held open and used for the data, otherwise one is made
27988 after the ACL completes.
27989
27990 Note that routers are used in verify mode,
27991 and cannot depend on content of received headers.
27992 Note also that headers cannot be
27993 modified by any of the post-data ACLs (DATA, MIME and DKIM).
27994 Headers may be modified by routers (subject to the above) and transports.
27995
27996 Cutthrough delivery is not supported via transport-filters or when DKIM signing
27997 of outgoing messages is done, because it sends data to the ultimate destination
27998 before the entire message has been received from the source.
27999
28000 Should the ultimate destination system positively accept or reject the mail,
28001 a corresponding indication is given to the source system and nothing is queued.
28002 If there is a temporary error the item is queued for later delivery in the
28003 usual fashion. If the item is successfully delivered in cutthrough mode the log line
28004 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
28005 line.
28006
28007 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
28008 sender when the destination system is doing content-scan based rejection.
28009
28010
28011 .vitem &*control&~=&~debug/*&<&'options'&>
28012 .cindex "&ACL;" "enabling debug logging"
28013 .cindex "debugging" "enabling from an ACL"
28014 This control turns on debug logging, almost as though Exim had been invoked
28015 with &`-d`&, with the output going to a new logfile, by default called
28016 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28017 may access any variables already defined.  The logging may be adjusted with
28018 the &'opts'& option, which takes the same values as the &`-d`& command-line
28019 option.  Some examples (which depend on variables that don't exist in all
28020 contexts):
28021 .code
28022       control = debug
28023       control = debug/tag=.$sender_host_address
28024       control = debug/opts=+expand+acl
28025       control = debug/tag=.$message_exim_id/opts=+expand
28026 .endd
28027
28028
28029 .vitem &*control&~=&~dkim_disable_verify*&
28030 .cindex "disable DKIM verify"
28031 .cindex "DKIM" "disable verify"
28032 This control turns off DKIM verification processing entirely.  For details on
28033 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28034
28035
28036 .vitem &*control&~=&~dscp/*&<&'value'&>
28037 .cindex "&ACL;" "setting DSCP value"
28038 .cindex "DSCP" "inbound"
28039 This option causes the DSCP value associated with the socket for the inbound
28040 connection to be adjusted to a given value, given as one of a number of fixed
28041 strings or to numeric value.
28042 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28043 Common values include &`throughput`&, &`mincost`&, and on newer systems
28044 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28045
28046 The outbound packets from Exim will be marked with this value in the header
28047 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28048 that these values will have any effect, not be stripped by networking
28049 equipment, or do much of anything without cooperation with your Network
28050 Engineer and those of all network operators between the source and destination.
28051
28052
28053 .vitem &*control&~=&~enforce_sync*& &&&
28054        &*control&~=&~no_enforce_sync*&
28055 .cindex "SMTP" "synchronization checking"
28056 .cindex "synchronization checking in SMTP"
28057 These controls make it possible to be selective about when SMTP synchronization
28058 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28059 state of the switch (it is true by default). See the description of this option
28060 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28061
28062 The effect of these two controls lasts for the remainder of the SMTP
28063 connection. They can appear in any ACL except the one for the non-SMTP
28064 messages. The most straightforward place to put them is in the ACL defined by
28065 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28066 before the first synchronization check. The expected use is to turn off the
28067 synchronization checks for badly-behaved hosts that you nevertheless need to
28068 work with.
28069
28070
28071 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28072 .cindex "fake defer"
28073 .cindex "defer, fake"
28074 This control works in exactly the same way as &%fakereject%& (described below)
28075 except that it causes an SMTP 450 response after the message data instead of a
28076 550 response. You must take care when using &%fakedefer%& because it causes the
28077 messages to be duplicated when the sender retries. Therefore, you should not
28078 use &%fakedefer%& if the message is to be delivered normally.
28079
28080 .vitem &*control&~=&~fakereject/*&<&'message'&>
28081 .cindex "fake rejection"
28082 .cindex "rejection, fake"
28083 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28084 words, only when an SMTP message is being received. If Exim accepts the
28085 message, instead the final 250 response, a 550 rejection message is sent.
28086 However, Exim proceeds to deliver the message as normal. The control applies
28087 only to the current message, not to any subsequent ones that may be received in
28088 the same SMTP connection.
28089
28090 The text for the 550 response is taken from the &%control%& modifier. If no
28091 message is supplied, the following is used:
28092 .code
28093 550-Your message has been rejected but is being
28094 550-kept for evaluation.
28095 550-If it was a legitimate message, it may still be
28096 550 delivered to the target recipient(s).
28097 .endd
28098 This facility should be used with extreme caution.
28099
28100 .vitem &*control&~=&~freeze*&
28101 .cindex "frozen messages" "forcing in ACL"
28102 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28103 other words, only when a message is being received. If the message is accepted,
28104 it is placed on Exim's queue and frozen. The control applies only to the
28105 current message, not to any subsequent ones that may be received in the same
28106 SMTP connection.
28107
28108 This modifier can optionally be followed by &`/no_tell`&. If the global option
28109 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28110 is told about the freezing), provided all the &*control=freeze*& modifiers that
28111 are obeyed for the current message have the &`/no_tell`& option.
28112
28113 .vitem &*control&~=&~no_delay_flush*&
28114 .cindex "SMTP" "output flushing, disabling for delay"
28115 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28116 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28117 use. This control, as long as it is encountered before the &%delay%& modifier,
28118 disables such output flushing.
28119
28120 .vitem &*control&~=&~no_callout_flush*&
28121 .cindex "SMTP" "output flushing, disabling for callout"
28122 Exim normally flushes SMTP output before performing a callout in an ACL, to
28123 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28124 use. This control, as long as it is encountered before the &%verify%& condition
28125 that causes the callout, disables such output flushing.
28126
28127 .vitem &*control&~=&~no_mbox_unspool*&
28128 This control is available when Exim is compiled with the content scanning
28129 extension. Content scanning may require a copy of the current message, or parts
28130 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28131 or spam scanner. Normally, such copies are deleted when they are no longer
28132 needed. If this control is set, the copies are not deleted. The control applies
28133 only to the current message, not to any subsequent ones that may be received in
28134 the same SMTP connection. It is provided for debugging purposes and is unlikely
28135 to be useful in production.
28136
28137 .vitem &*control&~=&~no_multiline_responses*&
28138 .cindex "multiline responses, suppressing"
28139 This control is permitted for any ACL except the one for non-SMTP messages.
28140 It seems that there are broken clients in use that cannot handle multiline
28141 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28142
28143 If this control is set, multiline SMTP responses from ACL rejections are
28144 suppressed. One way of doing this would have been to put out these responses as
28145 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28146 (&"use multiline responses for more"& it says &-- ha!), and some of the
28147 responses might get close to that. So this facility, which is after all only a
28148 sop to broken clients, is implemented by doing two very easy things:
28149
28150 .ilist
28151 Extra information that is normally output as part of a rejection caused by
28152 sender verification failure is omitted. Only the final line (typically &"sender
28153 verification failed"&) is sent.
28154 .next
28155 If a &%message%& modifier supplies a multiline response, only the first
28156 line is output.
28157 .endlist
28158
28159 The setting of the switch can, of course, be made conditional on the
28160 calling host. Its effect lasts until the end of the SMTP connection.
28161
28162 .vitem &*control&~=&~no_pipelining*&
28163 .cindex "PIPELINING" "suppressing advertising"
28164 This control turns off the advertising of the PIPELINING extension to SMTP in
28165 the current session. To be useful, it must be obeyed before Exim sends its
28166 response to an EHLO command. Therefore, it should normally appear in an ACL
28167 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28168 &%pipelining_advertise_hosts%&.
28169
28170 .vitem &*control&~=&~queue_only*&
28171 .oindex "&%queue_only%&"
28172 .cindex "queueing incoming messages"
28173 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28174 other words, only when a message is being received. If the message is accepted,
28175 it is placed on Exim's queue and left there for delivery by a subsequent queue
28176 runner. No immediate delivery process is started. In other words, it has the
28177 effect as the &%queue_only%& global option. However, the control applies only
28178 to the current message, not to any subsequent ones that may be received in the
28179 same SMTP connection.
28180
28181 .vitem &*control&~=&~submission/*&<&'options'&>
28182 .cindex "message" "submission"
28183 .cindex "submission mode"
28184 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28185 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28186 the current message is a submission from a local MUA. In this case, Exim
28187 operates in &"submission mode"&, and applies certain fixups to the message if
28188 necessary. For example, it adds a &'Date:'& header line if one is not present.
28189 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28190 late (the message has already been created).
28191
28192 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28193 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28194 submission mode; the available options for this control are described there.
28195 The control applies only to the current message, not to any subsequent ones
28196 that may be received in the same SMTP connection.
28197
28198 .vitem &*control&~=&~suppress_local_fixups*&
28199 .cindex "submission fixups, suppressing"
28200 This control applies to locally submitted (non TCP/IP) messages, and is the
28201 complement of &`control = submission`&. It disables the fixups that are
28202 normally applied to locally-submitted messages. Specifically:
28203
28204 .ilist
28205 Any &'Sender:'& header line is left alone (in this respect, it is a
28206 dynamic version of &%local_sender_retain%&).
28207 .next
28208 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28209 .next
28210 There is no check that &'From:'& corresponds to the actual sender.
28211 .endlist ilist
28212
28213 This control may be useful when a remotely-originated message is accepted,
28214 passed to some scanning program, and then re-submitted for delivery. It can be
28215 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28216 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28217 data is read.
28218
28219 &*Note:*& This control applies only to the current message, not to any others
28220 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28221 .endlist vlist
28222
28223
28224 .section "Summary of message fixup control" "SECTsummesfix"
28225 All four possibilities for message fixups can be specified:
28226
28227 .ilist
28228 Locally submitted, fixups applied: the default.
28229 .next
28230 Locally submitted, no fixups applied: use
28231 &`control = suppress_local_fixups`&.
28232 .next
28233 Remotely submitted, no fixups applied: the default.
28234 .next
28235 Remotely submitted, fixups applied: use &`control = submission`&.
28236 .endlist
28237
28238
28239
28240 .section "Adding header lines in ACLs" "SECTaddheadacl"
28241 .cindex "header lines" "adding in an ACL"
28242 .cindex "header lines" "position of added lines"
28243 .cindex "&%add_header%& ACL modifier"
28244 The &%add_header%& modifier can be used to add one or more extra header lines
28245 to an incoming message, as in this example:
28246 .code
28247 warn dnslists = sbl.spamhaus.org : \
28248                 dialup.mail-abuse.org
28249      add_header = X-blacklisted-at: $dnslist_domain
28250 .endd
28251 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28252 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28253 receiving a message). The message must ultimately be accepted for
28254 &%add_header%& to have any significant effect. You can use &%add_header%& with
28255 any ACL verb, including &%deny%& (though this is potentially useful only in a
28256 RCPT ACL).
28257
28258 Headers will not be added to the message if the modifier is used in
28259 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28260
28261 Leading and trailing newlines are removed from
28262 the data for the &%add_header%& modifier; if it then
28263 contains one or more newlines that
28264 are not followed by a space or a tab, it is assumed to contain multiple header
28265 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28266 front of any line that is not a valid header line.
28267
28268 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28269 They are added to the message before processing the DATA and MIME ACLs.
28270 However, if an identical header line is requested more than once, only one copy
28271 is actually added to the message. Further header lines may be accumulated
28272 during the DATA and MIME ACLs, after which they are added to the message, again
28273 with duplicates suppressed. Thus, it is possible to add two identical header
28274 lines to an SMTP message, but only if one is added before DATA and one after.
28275 In the case of non-SMTP messages, new headers are accumulated during the
28276 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28277 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28278 are included in the entry that is written to the reject log.
28279
28280 .cindex "header lines" "added; visibility of"
28281 Header lines are not visible in string expansions
28282 of message headers
28283 until they are added to the
28284 message. It follows that header lines defined in the MAIL, RCPT, and predata
28285 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28286 header lines that are added by the DATA or MIME ACLs are not visible in those
28287 ACLs. Because of this restriction, you cannot use header lines as a way of
28288 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28289 this, you can use ACL variables, as described in section
28290 &<<SECTaclvariables>>&.
28291
28292 The list of headers yet to be added is given by the &%$headers_added%& variable.
28293
28294 The &%add_header%& modifier acts immediately as it is encountered during the
28295 processing of an ACL. Notice the difference between these two cases:
28296 .display
28297 &`accept add_header = ADDED: some text`&
28298 &`       `&<&'some condition'&>
28299
28300 &`accept `&<&'some condition'&>
28301 &`       add_header = ADDED: some text`&
28302 .endd
28303 In the first case, the header line is always added, whether or not the
28304 condition is true. In the second case, the header line is added only if the
28305 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28306 ACL statement. All those that are encountered before a condition fails are
28307 honoured.
28308
28309 .cindex "&%warn%& ACL verb"
28310 For compatibility with previous versions of Exim, a &%message%& modifier for a
28311 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28312 effect only if all the conditions are true, even if it appears before some of
28313 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28314 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28315 are present on a &%warn%& verb, both are processed according to their
28316 specifications.
28317
28318 By default, new header lines are added to a message at the end of the existing
28319 header lines. However, you can specify that any particular header line should
28320 be added right at the start (before all the &'Received:'& lines), immediately
28321 after the first block of &'Received:'& lines, or immediately before any line
28322 that is not a &'Received:'& or &'Resent-something:'& header.
28323
28324 This is done by specifying &":at_start:"&, &":after_received:"&, or
28325 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28326 header line, respectively. (Header text cannot start with a colon, as there has
28327 to be a header name first.) For example:
28328 .code
28329 warn add_header = \
28330        :after_received:X-My-Header: something or other...
28331 .endd
28332 If more than one header line is supplied in a single &%add_header%& modifier,
28333 each one is treated independently and can therefore be placed differently. If
28334 you add more than one line at the start, or after the Received: block, they end
28335 up in reverse order.
28336
28337 &*Warning*&: This facility currently applies only to header lines that are
28338 added in an ACL. It does NOT work for header lines that are added in a
28339 system filter or in a router or transport.
28340
28341
28342
28343 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28344 .cindex "header lines" "removing in an ACL"
28345 .cindex "header lines" "position of removed lines"
28346 .cindex "&%remove_header%& ACL modifier"
28347 The &%remove_header%& modifier can be used to remove one or more header lines
28348 from an incoming message, as in this example:
28349 .code
28350 warn   message        = Remove internal headers
28351        remove_header  = x-route-mail1 : x-route-mail2
28352 .endd
28353 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28354 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28355 receiving a message). The message must ultimately be accepted for
28356 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28357 with any ACL verb, including &%deny%&, though this is really not useful for
28358 any verb that doesn't result in a delivered message.
28359
28360 Headers will not be removed to the message if the modifier is used in
28361 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28362
28363 More than one header can be removed at the same time by using a colon separated
28364 list of header names. The header matching is case insensitive. Wildcards are
28365 not permitted, nor is list expansion performed, so you cannot use hostlists to
28366 create a list of headers, however both connection and message variable expansion
28367 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28368 .code
28369 warn   hosts           = +internal_hosts
28370        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28371 warn   message         = Remove internal headers
28372        remove_header   = $acl_c_ihdrs
28373 .endd
28374 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28375 They are removed from the message before processing the DATA and MIME ACLs.
28376 There is no harm in attempting to remove the same header twice nor is removing
28377 a non-existent header. Further header lines to be removed may be accumulated
28378 during the DATA and MIME ACLs, after which they are removed from the message,
28379 if present. In the case of non-SMTP messages, headers to be removed are
28380 accumulated during the non-SMTP ACLs, and are removed from the message after
28381 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28382 ACL, there really is no effect because there is no logging of what headers
28383 would have been removed.
28384
28385 .cindex "header lines" "removed; visibility of"
28386 Header lines are not visible in string expansions until the DATA phase when it
28387 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28388 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28389 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28390 this restriction, you cannot use header lines as a way of controlling data
28391 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28392 you should instead use ACL variables, as described in section
28393 &<<SECTaclvariables>>&.
28394
28395 The &%remove_header%& modifier acts immediately as it is encountered during the
28396 processing of an ACL. Notice the difference between these two cases:
28397 .display
28398 &`accept remove_header = X-Internal`&
28399 &`       `&<&'some condition'&>
28400
28401 &`accept `&<&'some condition'&>
28402 &`       remove_header = X-Internal`&
28403 .endd
28404 In the first case, the header line is always removed, whether or not the
28405 condition is true. In the second case, the header line is removed only if the
28406 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28407 same ACL statement. All those that are encountered before a condition fails
28408 are honoured.
28409
28410 &*Warning*&: This facility currently applies only to header lines that are
28411 present during ACL processing. It does NOT remove header lines that are added
28412 in a system filter or in a router or transport.
28413
28414
28415
28416
28417 .section "ACL conditions" "SECTaclconditions"
28418 .cindex "&ACL;" "conditions; list of"
28419 Some of the conditions listed in this section are available only when Exim is
28420 compiled with the content-scanning extension. They are included here briefly
28421 for completeness. More detailed descriptions can be found in the discussion on
28422 content scanning in chapter &<<CHAPexiscan>>&.
28423
28424 Not all conditions are relevant in all circumstances. For example, testing
28425 senders and recipients does not make sense in an ACL that is being run as the
28426 result of the arrival of an ETRN command, and checks on message headers can be
28427 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28428 can use the same condition (with different parameters) more than once in the
28429 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28430 The conditions are as follows:
28431
28432
28433 .vlist
28434 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28435 .cindex "&ACL;" "nested"
28436 .cindex "&ACL;" "indirect"
28437 .cindex "&ACL;" "arguments"
28438 .cindex "&%acl%& ACL condition"
28439 The possible values of the argument are the same as for the
28440 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28441 &"accept"& the condition is true; if it returns &"deny"& the condition is
28442 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28443 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28444 condition false. This means that further processing of the &%warn%& verb
28445 ceases, but processing of the ACL continues.
28446
28447 If the argument is a named ACL, up to nine space-separated optional values
28448 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28449 and $acl_narg is set to the count of values.
28450 Previous values of these variables are restored after the call returns.
28451 The name and values are expanded separately.
28452 Note that spaces in complex expansions which are used as arguments
28453 will act as argument separators.
28454
28455 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28456 the connection is dropped. If it returns &"discard"&, the verb must be
28457 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28458 conditions are tested.
28459
28460 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28461 loops. This condition allows you to use different ACLs in different
28462 circumstances. For example, different ACLs can be used to handle RCPT commands
28463 for different local users or different local domains.
28464
28465 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28466 .cindex "&%authenticated%& ACL condition"
28467 .cindex "authentication" "ACL checking"
28468 .cindex "&ACL;" "testing for authentication"
28469 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28470 the name of the authenticator is tested against the list. To test for
28471 authentication by any authenticator, you can set
28472 .code
28473 authenticated = *
28474 .endd
28475
28476 .vitem &*condition&~=&~*&<&'string'&>
28477 .cindex "&%condition%& ACL condition"
28478 .cindex "customizing" "ACL condition"
28479 .cindex "&ACL;" "customized test"
28480 .cindex "&ACL;" "testing, customized"
28481 This feature allows you to make up custom conditions. If the result of
28482 expanding the string is an empty string, the number zero, or one of the strings
28483 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28484 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28485 any other value, some error is assumed to have occurred, and the ACL returns
28486 &"defer"&. However, if the expansion is forced to fail, the condition is
28487 ignored. The effect is to treat it as true, whether it is positive or
28488 negative.
28489
28490 .vitem &*decode&~=&~*&<&'location'&>
28491 .cindex "&%decode%& ACL condition"
28492 This condition is available only when Exim is compiled with the
28493 content-scanning extension, and it is allowed only in the ACL defined by
28494 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28495 If all goes well, the condition is true. It is false only if there are
28496 problems such as a syntax error or a memory shortage. For more details, see
28497 chapter &<<CHAPexiscan>>&.
28498
28499 .vitem &*demime&~=&~*&<&'extension&~list'&>
28500 .cindex "&%demime%& ACL condition"
28501 This condition is available only when Exim is compiled with the
28502 content-scanning extension. Its use is described in section
28503 &<<SECTdemimecond>>&.
28504
28505 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28506 .cindex "&%dnslists%& ACL condition"
28507 .cindex "DNS list" "in ACL"
28508 .cindex "black list (DNS)"
28509 .cindex "&ACL;" "testing a DNS list"
28510 This condition checks for entries in DNS black lists. These are also known as
28511 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28512 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28513 different variants of this condition to describe briefly here. See sections
28514 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28515
28516 .vitem &*domains&~=&~*&<&'domain&~list'&>
28517 .cindex "&%domains%& ACL condition"
28518 .cindex "domain" "ACL checking"
28519 .cindex "&ACL;" "testing a recipient domain"
28520 .vindex "&$domain_data$&"
28521 This condition is relevant only after a RCPT command. It checks that the domain
28522 of the recipient address is in the domain list. If percent-hack processing is
28523 enabled, it is done before this test is done. If the check succeeds with a
28524 lookup, the result of the lookup is placed in &$domain_data$& until the next
28525 &%domains%& test.
28526
28527 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28528 use &%domains%& in a DATA ACL.
28529
28530
28531 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28532 .cindex "&%encrypted%& ACL condition"
28533 .cindex "encryption" "checking in an ACL"
28534 .cindex "&ACL;" "testing for encryption"
28535 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28536 name of the cipher suite in use is tested against the list. To test for
28537 encryption without testing for any specific cipher suite(s), set
28538 .code
28539 encrypted = *
28540 .endd
28541
28542
28543 .vitem &*hosts&~=&~*&<&'host&~list'&>
28544 .cindex "&%hosts%& ACL condition"
28545 .cindex "host" "ACL checking"
28546 .cindex "&ACL;" "testing the client host"
28547 This condition tests that the calling host matches the host list. If you have
28548 name lookups or wildcarded host names and IP addresses in the same host list,
28549 you should normally put the IP addresses first. For example, you could have:
28550 .code
28551 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28552 .endd
28553 The lookup in this example uses the host name for its key. This is implied by
28554 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28555 and it wouldn't matter which way round you had these two items.)
28556
28557 The reason for the problem with host names lies in the left-to-right way that
28558 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28559 but when it reaches an item that requires a host name, it fails if it cannot
28560 find a host name to compare with the pattern. If the above list is given in the
28561 opposite order, the &%accept%& statement fails for a host whose name cannot be
28562 found, even if its IP address is 10.9.8.7.
28563
28564 If you really do want to do the name check first, and still recognize the IP
28565 address even if the name lookup fails, you can rewrite the ACL like this:
28566 .code
28567 accept hosts = dbm;/etc/friendly/hosts
28568 accept hosts = 10.9.8.7
28569 .endd
28570 The default action on failing to find the host name is to assume that the host
28571 is not in the list, so the first &%accept%& statement fails. The second
28572 statement can then check the IP address.
28573
28574 .vindex "&$host_data$&"
28575 If a &%hosts%& condition is satisfied by means of a lookup, the result
28576 of the lookup is made available in the &$host_data$& variable. This
28577 allows you, for example, to set up a statement like this:
28578 .code
28579 deny  hosts = net-lsearch;/some/file
28580 message = $host_data
28581 .endd
28582 which gives a custom error message for each denied host.
28583
28584 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28585 .cindex "&%local_parts%& ACL condition"
28586 .cindex "local part" "ACL checking"
28587 .cindex "&ACL;" "testing a local part"
28588 .vindex "&$local_part_data$&"
28589 This condition is relevant only after a RCPT command. It checks that the local
28590 part of the recipient address is in the list. If percent-hack processing is
28591 enabled, it is done before this test. If the check succeeds with a lookup, the
28592 result of the lookup is placed in &$local_part_data$&, which remains set until
28593 the next &%local_parts%& test.
28594
28595 .vitem &*malware&~=&~*&<&'option'&>
28596 .cindex "&%malware%& ACL condition"
28597 .cindex "&ACL;" "virus scanning"
28598 .cindex "&ACL;" "scanning for viruses"
28599 This condition is available only when Exim is compiled with the
28600 content-scanning extension. It causes the incoming message to be scanned for
28601 viruses. For details, see chapter &<<CHAPexiscan>>&.
28602
28603 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28604 .cindex "&%mime_regex%& ACL condition"
28605 .cindex "&ACL;" "testing by regex matching"
28606 This condition is available only when Exim is compiled with the
28607 content-scanning extension, and it is allowed only in the ACL defined by
28608 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28609 with any of the regular expressions. For details, see chapter
28610 &<<CHAPexiscan>>&.
28611
28612 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28613 .cindex "rate limiting"
28614 This condition can be used to limit the rate at which a user or host submits
28615 messages. Details are given in section &<<SECTratelimiting>>&.
28616
28617 .vitem &*recipients&~=&~*&<&'address&~list'&>
28618 .cindex "&%recipients%& ACL condition"
28619 .cindex "recipient" "ACL checking"
28620 .cindex "&ACL;" "testing a recipient"
28621 This condition is relevant only after a RCPT command. It checks the entire
28622 recipient address against a list of recipients.
28623
28624 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28625 .cindex "&%regex%& ACL condition"
28626 .cindex "&ACL;" "testing by regex matching"
28627 This condition is available only when Exim is compiled with the
28628 content-scanning extension, and is available only in the DATA, MIME, and
28629 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28630 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28631
28632 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28633 .cindex "&%sender_domains%& ACL condition"
28634 .cindex "sender" "ACL checking"
28635 .cindex "&ACL;" "testing a sender domain"
28636 .vindex "&$domain$&"
28637 .vindex "&$sender_address_domain$&"
28638 This condition tests the domain of the sender of the message against the given
28639 domain list. &*Note*&: The domain of the sender address is in
28640 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28641 of this condition. This is an exception to the general rule for testing domain
28642 lists. It is done this way so that, if this condition is used in an ACL for a
28643 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28644 influence the sender checking.
28645
28646 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28647 relaying, because sender addresses are easily, and commonly, forged.
28648
28649 .vitem &*senders&~=&~*&<&'address&~list'&>
28650 .cindex "&%senders%& ACL condition"
28651 .cindex "sender" "ACL checking"
28652 .cindex "&ACL;" "testing a sender"
28653 This condition tests the sender of the message against the given list. To test
28654 for a bounce message, which has an empty sender, set
28655 .code
28656 senders = :
28657 .endd
28658 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28659 relaying, because sender addresses are easily, and commonly, forged.
28660
28661 .vitem &*spam&~=&~*&<&'username'&>
28662 .cindex "&%spam%& ACL condition"
28663 .cindex "&ACL;" "scanning for spam"
28664 This condition is available only when Exim is compiled with the
28665 content-scanning extension. It causes the incoming message to be scanned by
28666 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28667
28668 .vitem &*verify&~=&~certificate*&
28669 .cindex "&%verify%& ACL condition"
28670 .cindex "TLS" "client certificate verification"
28671 .cindex "certificate" "verification of client"
28672 .cindex "&ACL;" "certificate verification"
28673 .cindex "&ACL;" "testing a TLS certificate"
28674 This condition is true in an SMTP session if the session is encrypted, and a
28675 certificate was received from the client, and the certificate was verified. The
28676 server requests a certificate only if the client matches &%tls_verify_hosts%&
28677 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28678
28679 .vitem &*verify&~=&~csa*&
28680 .cindex "CSA verification"
28681 This condition checks whether the sending host (the client) is authorized to
28682 send email. Details of how this works are given in section
28683 &<<SECTverifyCSA>>&.
28684
28685 .vitem &*verify&~=&~header_names_ascii*&
28686 .cindex "&%verify%& ACL condition"
28687 .cindex "&ACL;" "verifying header names only ASCII"
28688 .cindex "header lines" "verifying header names only ASCII"
28689 .cindex "verifying" "header names only ASCII"
28690 This condition is relevant only in an ACL that is run after a message has been
28691 received, that is, in an ACL specified by &%acl_smtp_data%& or
28692 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28693 there are no non-ASCII characters, also excluding control characters.  The
28694 allowable characters are decimal ASCII values 33 through 126.
28695
28696 Exim itself will handle headers with non-ASCII characters, but it can cause
28697 problems for downstream applications, so this option will allow their
28698 detection and rejection in the DATA ACL's.
28699
28700 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28701 .cindex "&%verify%& ACL condition"
28702 .cindex "&ACL;" "verifying sender in the header"
28703 .cindex "header lines" "verifying the sender in"
28704 .cindex "sender" "verifying in header"
28705 .cindex "verifying" "sender in header"
28706 This condition is relevant only in an ACL that is run after a message has been
28707 received, that is, in an ACL specified by &%acl_smtp_data%& or
28708 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28709 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28710 is loosely thought of as a &"sender"& address (hence the name of the test).
28711 However, an address that appears in one of these headers need not be an address
28712 that accepts bounce messages; only sender addresses in envelopes are required
28713 to accept bounces. Therefore, if you use the callout option on this check, you
28714 might want to arrange for a non-empty address in the MAIL command.
28715
28716 Details of address verification and the options are given later, starting at
28717 section &<<SECTaddressverification>>& (callouts are described in section
28718 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28719 condition to restrict it to bounce messages only:
28720 .code
28721 deny    senders = :
28722         message = A valid sender header is required for bounces
28723        !verify  = header_sender
28724 .endd
28725
28726 .vitem &*verify&~=&~header_syntax*&
28727 .cindex "&%verify%& ACL condition"
28728 .cindex "&ACL;" "verifying header syntax"
28729 .cindex "header lines" "verifying syntax"
28730 .cindex "verifying" "header syntax"
28731 This condition is relevant only in an ACL that is run after a message has been
28732 received, that is, in an ACL specified by &%acl_smtp_data%& or
28733 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28734 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28735 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28736 permitted only in locally generated messages and from hosts that match
28737 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28738 appropriate.
28739
28740 Note that this condition is a syntax check only. However, a common spamming
28741 ploy used to be to send syntactically invalid headers such as
28742 .code
28743 To: @
28744 .endd
28745 and this condition can be used to reject such messages, though they are not as
28746 common as they used to be.
28747
28748 .vitem &*verify&~=&~helo*&
28749 .cindex "&%verify%& ACL condition"
28750 .cindex "&ACL;" "verifying HELO/EHLO"
28751 .cindex "HELO" "verifying"
28752 .cindex "EHLO" "verifying"
28753 .cindex "verifying" "EHLO"
28754 .cindex "verifying" "HELO"
28755 This condition is true if a HELO or EHLO command has been received from the
28756 client host, and its contents have been verified. If there has been no previous
28757 attempt to verify the HELO/EHLO contents, it is carried out when this
28758 condition is encountered. See the description of the &%helo_verify_hosts%& and
28759 &%helo_try_verify_hosts%& options for details of how to request verification
28760 independently of this condition.
28761
28762 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28763 option), this condition is always true.
28764
28765
28766 .vitem &*verify&~=&~not_blind*&
28767 .cindex "verifying" "not blind"
28768 .cindex "bcc recipients, verifying none"
28769 This condition checks that there are no blind (bcc) recipients in the message.
28770 Every envelope recipient must appear either in a &'To:'& header line or in a
28771 &'Cc:'& header line for this condition to be true. Local parts are checked
28772 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28773 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28774 used only in a DATA or non-SMTP ACL.
28775
28776 There are, of course, many legitimate messages that make use of blind (bcc)
28777 recipients. This check should not be used on its own for blocking messages.
28778
28779
28780 .vitem &*verify&~=&~recipient/*&<&'options'&>
28781 .cindex "&%verify%& ACL condition"
28782 .cindex "&ACL;" "verifying recipient"
28783 .cindex "recipient" "verifying"
28784 .cindex "verifying" "recipient"
28785 .vindex "&$address_data$&"
28786 This condition is relevant only after a RCPT command. It verifies the current
28787 recipient. Details of address verification are given later, starting at section
28788 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28789 of &$address_data$& is the last value that was set while routing the address.
28790 This applies even if the verification fails. When an address that is being
28791 verified is redirected to a single address, verification continues with the new
28792 address, and in that case, the subsequent value of &$address_data$& is the
28793 value for the child address.
28794
28795 .vitem &*verify&~=&~reverse_host_lookup*&
28796 .cindex "&%verify%& ACL condition"
28797 .cindex "&ACL;" "verifying host reverse lookup"
28798 .cindex "host" "verifying reverse lookup"
28799 This condition ensures that a verified host name has been looked up from the IP
28800 address of the client host. (This may have happened already if the host name
28801 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28802 Verification ensures that the host name obtained from a reverse DNS lookup, or
28803 one of its aliases, does, when it is itself looked up in the DNS, yield the
28804 original IP address.
28805
28806 If this condition is used for a locally generated message (that is, when there
28807 is no client host involved), it always succeeds.
28808
28809 .vitem &*verify&~=&~sender/*&<&'options'&>
28810 .cindex "&%verify%& ACL condition"
28811 .cindex "&ACL;" "verifying sender"
28812 .cindex "sender" "verifying"
28813 .cindex "verifying" "sender"
28814 This condition is relevant only after a MAIL or RCPT command, or after a
28815 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28816 the message's sender is empty (that is, this is a bounce message), the
28817 condition is true. Otherwise, the sender address is verified.
28818
28819 .vindex "&$address_data$&"
28820 .vindex "&$sender_address_data$&"
28821 If there is data in the &$address_data$& variable at the end of routing, its
28822 value is placed in &$sender_address_data$& at the end of verification. This
28823 value can be used in subsequent conditions and modifiers in the same ACL
28824 statement. It does not persist after the end of the current statement. If you
28825 want to preserve the value for longer, you can save it in an ACL variable.
28826
28827 Details of verification are given later, starting at section
28828 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28829 to avoid doing it more than once per message.
28830
28831 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28832 .cindex "&%verify%& ACL condition"
28833 This is a variation of the previous option, in which a modified address is
28834 verified as a sender.
28835 .endlist
28836
28837
28838
28839 .section "Using DNS lists" "SECTmorednslists"
28840 .cindex "DNS list" "in ACL"
28841 .cindex "black list (DNS)"
28842 .cindex "&ACL;" "testing a DNS list"
28843 In its simplest form, the &%dnslists%& condition tests whether the calling host
28844 is on at least one of a number of DNS lists by looking up the inverted IP
28845 address in one or more DNS domains. (Note that DNS list domains are not mail
28846 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28847 special options instead.) For example, if the calling host's IP
28848 address is 192.168.62.43, and the ACL statement is
28849 .code
28850 deny dnslists = blackholes.mail-abuse.org : \
28851                 dialups.mail-abuse.org
28852 .endd
28853 the following records are looked up:
28854 .code
28855 43.62.168.192.blackholes.mail-abuse.org
28856 43.62.168.192.dialups.mail-abuse.org
28857 .endd
28858 As soon as Exim finds an existing DNS record, processing of the list stops.
28859 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28860 to test that a host is on more than one list (an &"and"& conjunction), you can
28861 use two separate conditions:
28862 .code
28863 deny dnslists = blackholes.mail-abuse.org
28864      dnslists = dialups.mail-abuse.org
28865 .endd
28866 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28867 behaves as if the host does not match the list item, that is, as if the DNS
28868 record does not exist. If there are further items in the DNS list, they are
28869 processed.
28870
28871 This is usually the required action when &%dnslists%& is used with &%deny%&
28872 (which is the most common usage), because it prevents a DNS failure from
28873 blocking mail. However, you can change this behaviour by putting one of the
28874 following special items in the list:
28875 .display
28876 &`+include_unknown `&   behave as if the item is on the list
28877 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28878 &`+defer_unknown   `&   give a temporary error
28879 .endd
28880 .cindex "&`+include_unknown`&"
28881 .cindex "&`+exclude_unknown`&"
28882 .cindex "&`+defer_unknown`&"
28883 Each of these applies to any subsequent items on the list. For example:
28884 .code
28885 deny dnslists = +defer_unknown : foo.bar.example
28886 .endd
28887 Testing the list of domains stops as soon as a match is found. If you want to
28888 warn for one list and block for another, you can use two different statements:
28889 .code
28890 deny  dnslists = blackholes.mail-abuse.org
28891 warn  message  = X-Warn: sending host is on dialups list
28892       dnslists = dialups.mail-abuse.org
28893 .endd
28894 DNS list lookups are cached by Exim for the duration of the SMTP session,
28895 so a lookup based on the IP address is done at most once for any incoming
28896 connection. Exim does not share information between multiple incoming
28897 connections (but your local name server cache should be active).
28898
28899
28900
28901 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28902 .cindex "DNS list" "keyed by explicit IP address"
28903 By default, the IP address that is used in a DNS list lookup is the IP address
28904 of the calling host. However, you can specify another IP address by listing it
28905 after the domain name, introduced by a slash. For example:
28906 .code
28907 deny dnslists = black.list.tld/192.168.1.2
28908 .endd
28909 This feature is not very helpful with explicit IP addresses; it is intended for
28910 use with IP addresses that are looked up, for example, the IP addresses of the
28911 MX hosts or nameservers of an email sender address. For an example, see section
28912 &<<SECTmulkeyfor>>& below.
28913
28914
28915
28916
28917 .section "DNS lists keyed on domain names" "SECID202"
28918 .cindex "DNS list" "keyed by domain name"
28919 There are some lists that are keyed on domain names rather than inverted IP
28920 addresses (see for example the &'domain based zones'& link at
28921 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28922 with these lists. You can change the name that is looked up in a DNS list by
28923 listing it after the domain name, introduced by a slash. For example,
28924 .code
28925 deny  message  = Sender's domain is listed at $dnslist_domain
28926       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28927 .endd
28928 This particular example is useful only in ACLs that are obeyed after the
28929 RCPT or DATA commands, when a sender address is available. If (for
28930 example) the message's sender is &'user@tld.example'& the name that is looked
28931 up by this example is
28932 .code
28933 tld.example.dsn.rfc-ignorant.org
28934 .endd
28935 A single &%dnslists%& condition can contain entries for both names and IP
28936 addresses. For example:
28937 .code
28938 deny dnslists = sbl.spamhaus.org : \
28939                 dsn.rfc-ignorant.org/$sender_address_domain
28940 .endd
28941 The first item checks the sending host's IP address; the second checks a domain
28942 name. The whole condition is true if either of the DNS lookups succeeds.
28943
28944
28945
28946
28947 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28948 .cindex "DNS list" "multiple keys for"
28949 The syntax described above for looking up explicitly-defined values (either
28950 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28951 name for the DNS list, what follows the slash can in fact be a list of items.
28952 As with all lists in Exim, the default separator is a colon. However, because
28953 this is a sublist within the list of DNS blacklist domains, it is necessary
28954 either to double the separators like this:
28955 .code
28956 dnslists = black.list.tld/name.1::name.2
28957 .endd
28958 or to change the separator character, like this:
28959 .code
28960 dnslists = black.list.tld/<;name.1;name.2
28961 .endd
28962 If an item in the list is an IP address, it is inverted before the DNS
28963 blacklist domain is appended. If it is not an IP address, no inversion
28964 occurs. Consider this condition:
28965 .code
28966 dnslists = black.list.tld/<;192.168.1.2;a.domain
28967 .endd
28968 The DNS lookups that occur are:
28969 .code
28970 2.1.168.192.black.list.tld
28971 a.domain.black.list.tld
28972 .endd
28973 Once a DNS record has been found (that matches a specific IP return
28974 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28975 are done. If there is a temporary DNS error, the rest of the sublist of domains
28976 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28977 only if no other DNS lookup in this sublist succeeds. In other words, a
28978 successful lookup for any of the items in the sublist overrides a temporary
28979 error for a previous item.
28980
28981 The ability to supply a list of items after the slash is in some sense just a
28982 syntactic convenience. These two examples have the same effect:
28983 .code
28984 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28985 dnslists = black.list.tld/a.domain::b.domain
28986 .endd
28987 However, when the data for the list is obtained from a lookup, the second form
28988 is usually much more convenient. Consider this example:
28989 .code
28990 deny message  = The mail servers for the domain \
28991                 $sender_address_domain \
28992                 are listed at $dnslist_domain ($dnslist_value); \
28993                 see $dnslist_text.
28994      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28995                                    ${lookup dnsdb {>|mxh=\
28996                                    $sender_address_domain} }} }
28997 .endd
28998 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28999 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29000 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29001 of expanding the condition might be something like this:
29002 .code
29003 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29004 .endd
29005 Thus, this example checks whether or not the IP addresses of the sender
29006 domain's mail servers are on the Spamhaus black list.
29007
29008 The key that was used for a successful DNS list lookup is put into the variable
29009 &$dnslist_matched$& (see section &<<SECID204>>&).
29010
29011
29012
29013
29014 .section "Data returned by DNS lists" "SECID203"
29015 .cindex "DNS list" "data returned from"
29016 DNS lists are constructed using address records in the DNS. The original RBL
29017 just used the address 127.0.0.1 on the right hand side of each record, but the
29018 RBL+ list and some other lists use a number of values with different meanings.
29019 The values used on the RBL+ list are:
29020 .display
29021 127.1.0.1  RBL
29022 127.1.0.2  DUL
29023 127.1.0.3  DUL and RBL
29024 127.1.0.4  RSS
29025 127.1.0.5  RSS and RBL
29026 127.1.0.6  RSS and DUL
29027 127.1.0.7  RSS and DUL and RBL
29028 .endd
29029 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29030 different values. Some DNS lists may return more than one address record;
29031 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29032
29033
29034 .section "Variables set from DNS lists" "SECID204"
29035 .cindex "expansion" "variables, set from DNS list"
29036 .cindex "DNS list" "variables set from"
29037 .vindex "&$dnslist_domain$&"
29038 .vindex "&$dnslist_matched$&"
29039 .vindex "&$dnslist_text$&"
29040 .vindex "&$dnslist_value$&"
29041 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29042 the name of the overall domain that matched (for example,
29043 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29044 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29045 the DNS record. When the key is an IP address, it is not reversed in
29046 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29047 cases, for example:
29048 .code
29049 deny dnslists = spamhaus.example
29050 .endd
29051 the key is also available in another variable (in this case,
29052 &$sender_host_address$&). In more complicated cases, however, this is not true.
29053 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29054 might generate a dnslists lookup like this:
29055 .code
29056 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29057 .endd
29058 If this condition succeeds, the value in &$dnslist_matched$& might be
29059 &`192.168.6.7`& (for example).
29060
29061 If more than one address record is returned by the DNS lookup, all the IP
29062 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29063 The variable &$dnslist_text$& contains the contents of any associated TXT
29064 record. For lists such as RBL+ the TXT record for a merged entry is often not
29065 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29066 information.
29067
29068 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29069 &-- although these appear before the condition in the ACL, they are not
29070 expanded until after it has failed. For example:
29071 .code
29072 deny    hosts = !+local_networks
29073         message = $sender_host_address is listed \
29074                   at $dnslist_domain
29075         dnslists = rbl-plus.mail-abuse.example
29076 .endd
29077
29078
29079
29080 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29081 .cindex "DNS list" "matching specific returned data"
29082 You can add an equals sign and an IP address after a &%dnslists%& domain name
29083 in order to restrict its action to DNS records with a matching right hand side.
29084 For example,
29085 .code
29086 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29087 .endd
29088 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29089 any address record is considered to be a match. For the moment, we assume
29090 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29091 describes how multiple records are handled.
29092
29093 More than one IP address may be given for checking, using a comma as a
29094 separator. These are alternatives &-- if any one of them matches, the
29095 &%dnslists%& condition is true. For example:
29096 .code
29097 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29098 .endd
29099 If you want to specify a constraining address list and also specify names or IP
29100 addresses to be looked up, the constraining address list must be specified
29101 first. For example:
29102 .code
29103 deny dnslists = dsn.rfc-ignorant.org\
29104                 =127.0.0.2/$sender_address_domain
29105 .endd
29106
29107 If the character &`&&`& is used instead of &`=`&, the comparison for each
29108 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29109 In other words, the listed addresses are used as bit masks. The comparison is
29110 true if all the bits in the mask are present in the address that is being
29111 tested. For example:
29112 .code
29113 dnslists = a.b.c&0.0.0.3
29114 .endd
29115 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29116 want to test whether one bit or another bit is present (as opposed to both
29117 being present), you must use multiple values. For example:
29118 .code
29119 dnslists = a.b.c&0.0.0.1,0.0.0.2
29120 .endd
29121 matches if the final component of the address is an odd number or two times
29122 an odd number.
29123
29124
29125
29126 .section "Negated DNS matching conditions" "SECID205"
29127 You can supply a negative list of IP addresses as part of a &%dnslists%&
29128 condition. Whereas
29129 .code
29130 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29131 .endd
29132 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29133 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29134 .code
29135 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29136 .endd
29137 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29138 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29139 words, the result of the test is inverted if an exclamation mark appears before
29140 the &`=`& (or the &`&&`&) sign.
29141
29142 &*Note*&: This kind of negation is not the same as negation in a domain,
29143 host, or address list (which is why the syntax is different).
29144
29145 If you are using just one list, the negation syntax does not gain you much. The
29146 previous example is precisely equivalent to
29147 .code
29148 deny  dnslists = a.b.c
29149      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29150 .endd
29151 However, if you are using multiple lists, the negation syntax is clearer.
29152 Consider this example:
29153 .code
29154 deny  dnslists = sbl.spamhaus.org : \
29155                  list.dsbl.org : \
29156                  dnsbl.njabl.org!=127.0.0.3 : \
29157                  relays.ordb.org
29158 .endd
29159 Using only positive lists, this would have to be:
29160 .code
29161 deny  dnslists = sbl.spamhaus.org : \
29162                  list.dsbl.org
29163 deny  dnslists = dnsbl.njabl.org
29164      !dnslists = dnsbl.njabl.org=127.0.0.3
29165 deny  dnslists = relays.ordb.org
29166 .endd
29167 which is less clear, and harder to maintain.
29168
29169
29170
29171
29172 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29173 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29174 thereby providing more than one IP address. When an item in a &%dnslists%& list
29175 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29176 the match to specific results from the DNS lookup, there are two ways in which
29177 the checking can be handled. For example, consider the condition:
29178 .code
29179 dnslists = a.b.c=127.0.0.1
29180 .endd
29181 What happens if the DNS lookup for the incoming IP address yields both
29182 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29183 condition true because at least one given value was found, or is it false
29184 because at least one of the found values was not listed? And how does this
29185 affect negated conditions? Both possibilities are provided for with the help of
29186 additional separators &`==`& and &`=&&`&.
29187
29188 .ilist
29189 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29190 IP addresses matches one of the listed addresses. For the example above, the
29191 condition is true because 127.0.0.1 matches.
29192 .next
29193 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29194 looked up IP addresses matches one of the listed addresses. If the condition is
29195 changed to:
29196 .code
29197 dnslists = a.b.c==127.0.0.1
29198 .endd
29199 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29200 false because 127.0.0.2 is not listed. You would need to have:
29201 .code
29202 dnslists = a.b.c==127.0.0.1,127.0.0.2
29203 .endd
29204 for the condition to be true.
29205 .endlist
29206
29207 When &`!`& is used to negate IP address matching, it inverts the result, giving
29208 the precise opposite of the behaviour above. Thus:
29209 .ilist
29210 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29211 addresses matches one of the listed addresses. Consider:
29212 .code
29213 dnslists = a.b.c!&0.0.0.1
29214 .endd
29215 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29216 false because 127.0.0.1 matches.
29217 .next
29218 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29219 looked up IP address that does not match. Consider:
29220 .code
29221 dnslists = a.b.c!=&0.0.0.1
29222 .endd
29223 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29224 true, because 127.0.0.2 does not match. You would need to have:
29225 .code
29226 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29227 .endd
29228 for the condition to be false.
29229 .endlist
29230 When the DNS lookup yields only a single IP address, there is no difference
29231 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29232
29233
29234
29235
29236 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29237 .cindex "DNS list" "information from merged"
29238 When the facility for restricting the matching IP values in a DNS list is used,
29239 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29240 the true reason for rejection. This happens when lists are merged and the IP
29241 address in the A record is used to distinguish them; unfortunately there is
29242 only one TXT record. One way round this is not to use merged lists, but that
29243 can be inefficient because it requires multiple DNS lookups where one would do
29244 in the vast majority of cases when the host of interest is not on any of the
29245 lists.
29246
29247 A less inefficient way of solving this problem is available. If
29248 two domain names, comma-separated, are given, the second is used first to
29249 do an initial check, making use of any IP value restrictions that are set.
29250 If there is a match, the first domain is used, without any IP value
29251 restrictions, to get the TXT record. As a byproduct of this, there is also
29252 a check that the IP being tested is indeed on the first list. The first
29253 domain is the one that is put in &$dnslist_domain$&. For example:
29254 .code
29255 reject message  = \
29256          rejected because $sender_host_address is blacklisted \
29257          at $dnslist_domain\n$dnslist_text
29258        dnslists = \
29259          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29260          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29261 .endd
29262 For the first blacklist item, this starts by doing a lookup in
29263 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29264 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29265 value, and as long as something is found, it looks for the corresponding TXT
29266 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29267 The second blacklist item is processed similarly.
29268
29269 If you are interested in more than one merged list, the same list must be
29270 given several times, but because the results of the DNS lookups are cached,
29271 the DNS calls themselves are not repeated. For example:
29272 .code
29273 reject dnslists = \
29274          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29275          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29276          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29277          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29278 .endd
29279 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29280 values matches (or if no record is found), this is the only lookup that is
29281 done. Only if there is a match is one of the more specific lists consulted.
29282
29283
29284
29285 .section "DNS lists and IPv6" "SECTmorednslistslast"
29286 .cindex "IPv6" "DNS black lists"
29287 .cindex "DNS list" "IPv6 usage"
29288 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29289 nibble by nibble. For example, if the calling host's IP address is
29290 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29291 .code
29292 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29293   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29294 .endd
29295 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29296 lists contain wildcard records, intended for IPv4, that interact badly with
29297 IPv6. For example, the DNS entry
29298 .code
29299 *.3.some.list.example.    A    127.0.0.1
29300 .endd
29301 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29302 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29303
29304 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29305 &%condition%& condition, as in this example:
29306 .code
29307 deny   condition = ${if isip4{$sender_host_address}}
29308        dnslists  = some.list.example
29309 .endd
29310
29311 If an explicit key is being used for a DNS lookup and it may be an IPv6
29312 address you should specify alternate list separators for both the outer
29313 (DNS list name) list and inner (lookup keys) list:
29314 .code
29315        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29316 .endd
29317
29318 .section "Rate limiting incoming messages" "SECTratelimiting"
29319 .cindex "rate limiting" "client sending"
29320 .cindex "limiting client sending rates"
29321 .oindex "&%smtp_ratelimit_*%&"
29322 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29323 which clients can send email. This is more powerful than the
29324 &%smtp_ratelimit_*%& options, because those options control the rate of
29325 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29326 works across all connections (concurrent and sequential) from the same client
29327 host. The syntax of the &%ratelimit%& condition is:
29328 .display
29329 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29330 .endd
29331 If the average client sending rate is less than &'m'& messages per time
29332 period &'p'& then the condition is false; otherwise it is true.
29333
29334 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29335 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29336 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29337 of &'p'&.
29338
29339 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29340 time interval, for example, &`8h`& for eight hours. A larger time constant
29341 means that it takes Exim longer to forget a client's past behaviour. The
29342 parameter &'m'& is the maximum number of messages that a client is permitted to
29343 send in each time interval. It also specifies the number of messages permitted
29344 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29345 constant, you can allow a client to send more messages in a burst without
29346 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29347 both small, messages must be sent at an even rate.
29348
29349 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29350 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29351 when deploying the &%ratelimit%& ACL condition. The script prints usage
29352 instructions when it is run with no arguments.
29353
29354 The key is used to look up the data for calculating the client's average
29355 sending rate. This data is stored in Exim's spool directory, alongside the
29356 retry and other hints databases. The default key is &$sender_host_address$&,
29357 which means Exim computes the sending rate of each client host IP address.
29358 By changing the key you can change how Exim identifies clients for the purpose
29359 of ratelimiting. For example, to limit the sending rate of each authenticated
29360 user, independent of the computer they are sending from, set the key to
29361 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29362 example, &$authenticated_id$& is only meaningful if the client has
29363 authenticated (which you can check with the &%authenticated%& ACL condition).
29364
29365 The lookup key does not have to identify clients: If you want to limit the
29366 rate at which a recipient receives messages, you can use the key
29367 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29368 ACL.
29369
29370 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29371 specifies what Exim measures the rate of, for example messages or recipients
29372 or bytes. You can adjust the measurement using the &%unique=%& and/or
29373 &%count=%& options. You can also control when Exim updates the recorded rate
29374 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29375 separated by a slash, like the other parameters. They may appear in any order.
29376
29377 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29378 any options that alter the meaning of the stored data. The limit &'m'& is not
29379 stored, so you can alter the configured maximum rate and Exim will still
29380 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29381 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29382 behaviour. The lookup key is not affected by changes to the update mode and
29383 the &%count=%& option.
29384
29385
29386 .section "Ratelimit options for what is being measured" "ratoptmea"
29387 .cindex "rate limiting" "per_* options"
29388 The &%per_conn%& option limits the client's connection rate. It is not
29389 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29390 &%acl_not_smtp_start%& ACLs.
29391
29392 The &%per_mail%& option limits the client's rate of sending messages. This is
29393 the default if none of the &%per_*%& options is specified. It can be used in
29394 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29395 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29396
29397 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29398 the same ACLs as the &%per_mail%& option, though it is best to use this option
29399 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29400 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29401 in its MAIL command, which may be inaccurate or completely missing. You can
29402 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29403 in kilobytes, megabytes, or gigabytes, respectively.
29404
29405 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29406 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29407 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29408 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29409 ACLs the rate is updated with the total recipient count in one go. Note that
29410 in either case the rate limiting engine will see a message with many
29411 recipients as a large high-speed burst.
29412
29413 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29414 number of different recipients that the client has sent messages to in the
29415 last time period. That is, if the client repeatedly sends messages to the same
29416 recipient, its measured rate is not increased. This option can only be used in
29417 &%acl_smtp_rcpt%&.
29418
29419 The &%per_cmd%& option causes Exim to recompute the rate every time the
29420 condition is processed. This can be used to limit the rate of any SMTP
29421 command. If it is used in multiple ACLs it can limit the aggregate rate of
29422 multiple different commands.
29423
29424 The &%count=%& option can be used to alter how much Exim adds to the client's
29425 measured rate. For example, the &%per_byte%& option is equivalent to
29426 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29427 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29428 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29429
29430 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29431
29432
29433 .section "Ratelimit update modes" "ratoptupd"
29434 .cindex "rate limiting" "reading data without updating"
29435 You can specify one of three options with the &%ratelimit%& condition to
29436 control when its database is updated. This section describes the &%readonly%&
29437 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29438
29439 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29440 previously-computed rate to check against the limit.
29441
29442 For example, you can test the client's sending rate and deny it access (when
29443 it is too fast) in the connect ACL. If the client passes this check then it
29444 can go on to send a message, in which case its recorded rate will be updated
29445 in the MAIL ACL. Subsequent connections from the same client will check this
29446 new rate.
29447 .code
29448 acl_check_connect:
29449  deny ratelimit = 100 / 5m / readonly
29450     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29451                   (max $sender_rate_limit)
29452 # ...
29453 acl_check_mail:
29454  warn ratelimit = 100 / 5m / strict
29455     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29456                   (max $sender_rate_limit)
29457 .endd
29458
29459 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29460 processing a message then it may increase the client's measured rate more than
29461 it should. For example, this will happen if you check the &%per_rcpt%& option
29462 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29463 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29464 multiple update problems by using the &%readonly%& option on later ratelimit
29465 checks.
29466
29467 The &%per_*%& options described above do not make sense in some ACLs. If you
29468 use a &%per_*%& option in an ACL where it is not normally permitted then the
29469 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29470 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29471 next section) so you must specify the &%readonly%& option explicitly.
29472
29473
29474 .section "Ratelimit options for handling fast clients" "ratoptfast"
29475 .cindex "rate limiting" "strict and leaky modes"
29476 If a client's average rate is greater than the maximum, the rate limiting
29477 engine can react in two possible ways, depending on the presence of the
29478 &%strict%& or &%leaky%& update modes. This is independent of the other
29479 counter-measures (such as rejecting the message) that may be specified by the
29480 rest of the ACL.
29481
29482 The &%leaky%& (default) option means that the client's recorded rate is not
29483 updated if it is above the limit. The effect of this is that Exim measures the
29484 client's average rate of successfully sent email, which cannot be greater than
29485 the maximum allowed. If the client is over the limit it may suffer some
29486 counter-measures (as specified in the ACL), but it will still be able to send
29487 email at the configured maximum rate, whatever the rate of its attempts. This
29488 is generally the better choice if you have clients that retry automatically.
29489 For example, it does not prevent a sender with an over-aggressive retry rate
29490 from getting any email through.
29491
29492 The &%strict%& option means that the client's recorded rate is always
29493 updated. The effect of this is that Exim measures the client's average rate
29494 of attempts to send email, which can be much higher than the maximum it is
29495 actually allowed. If the client is over the limit it may be subjected to
29496 counter-measures by the ACL. It must slow down and allow sufficient time to
29497 pass that its computed rate falls below the maximum before it can send email
29498 again. The time (the number of smoothing periods) it must wait and not
29499 attempt to send mail can be calculated with this formula:
29500 .code
29501         ln(peakrate/maxrate)
29502 .endd
29503
29504
29505 .section "Limiting the rate of different events" "ratoptuniq"
29506 .cindex "rate limiting" "counting unique events"
29507 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29508 rate of different events. For example, the &%per_addr%& option uses this
29509 mechanism to count the number of different recipients that the client has
29510 sent messages to in the last time period; it is equivalent to
29511 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29512 measure the rate that a client uses different sender addresses with the
29513 options &`per_mail/unique=$sender_address`&.
29514
29515 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29516 has seen for that key. The whole set is thrown away when it is older than the
29517 rate smoothing period &'p'&, so each different event is counted at most once
29518 per period. In the &%leaky%& update mode, an event that causes the client to
29519 go over the limit is not added to the set, in the same way that the client's
29520 recorded rate is not updated in the same situation.
29521
29522 When you combine the &%unique=%& and &%readonly%& options, the specific
29523 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29524 rate.
29525
29526 The &%unique=%& mechanism needs more space in the ratelimit database than the
29527 other &%ratelimit%& options in order to store the event set. The number of
29528 unique values is potentially as large as the rate limit, so the extra space
29529 required increases with larger limits.
29530
29531 The uniqueification is not perfect: there is a small probability that Exim
29532 will think a new event has happened before. If the sender's rate is less than
29533 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29534 the measured rate can go above the limit, in which case Exim may under-count
29535 events by a significant margin. Fortunately, if the rate is high enough (2.7
29536 times the limit) that the false positive rate goes above 9%, then Exim will
29537 throw away the over-full event set before the measured rate falls below the
29538 limit. Therefore the only harm should be that exceptionally high sending rates
29539 are logged incorrectly; any countermeasures you configure will be as effective
29540 as intended.
29541
29542
29543 .section "Using rate limiting" "useratlim"
29544 Exim's other ACL facilities are used to define what counter-measures are taken
29545 when the rate limit is exceeded. This might be anything from logging a warning
29546 (for example, while measuring existing sending rates in order to define
29547 policy), through time delays to slow down fast senders, up to rejecting the
29548 message. For example:
29549 .code
29550 # Log all senders' rates
29551 warn ratelimit = 0 / 1h / strict
29552      log_message = Sender rate $sender_rate / $sender_rate_period
29553
29554 # Slow down fast senders; note the need to truncate $sender_rate
29555 # at the decimal point.
29556 warn ratelimit = 100 / 1h / per_rcpt / strict
29557      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29558                    $sender_rate_limit }s
29559
29560 # Keep authenticated users under control
29561 deny authenticated = *
29562      ratelimit = 100 / 1d / strict / $authenticated_id
29563
29564 # System-wide rate limit
29565 defer message = Sorry, too busy. Try again later.
29566      ratelimit = 10 / 1s / $primary_hostname
29567
29568 # Restrict incoming rate from each host, with a default
29569 # set using a macro and special cases looked up in a table.
29570 defer message = Sender rate exceeds $sender_rate_limit \
29571                messages per $sender_rate_period
29572      ratelimit = ${lookup {$sender_host_address} \
29573                    cdb {DB/ratelimits.cdb} \
29574                    {$value} {RATELIMIT} }
29575 .endd
29576 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29577 especially with the &%per_rcpt%& option, you may suffer from a performance
29578 bottleneck caused by locking on the ratelimit hints database. Apart from
29579 making your ACLs less complicated, you can reduce the problem by using a
29580 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29581 this means that Exim will lose its hints data after a reboot (including retry
29582 hints, the callout cache, and ratelimit data).
29583
29584
29585
29586 .section "Address verification" "SECTaddressverification"
29587 .cindex "verifying address" "options for"
29588 .cindex "policy control" "address verification"
29589 Several of the &%verify%& conditions described in section
29590 &<<SECTaclconditions>>& cause addresses to be verified. Section
29591 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29592 The verification conditions can be followed by options that modify the
29593 verification process. The options are separated from the keyword and from each
29594 other by slashes, and some of them contain parameters. For example:
29595 .code
29596 verify = sender/callout
29597 verify = recipient/defer_ok/callout=10s,defer_ok
29598 .endd
29599 The first stage of address verification, which always happens, is to run the
29600 address through the routers, in &"verify mode"&. Routers can detect the
29601 difference between verification and routing for delivery, and their actions can
29602 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29603 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29604 The available options are as follows:
29605
29606 .ilist
29607 If the &%callout%& option is specified, successful routing to one or more
29608 remote hosts is followed by a &"callout"& to those hosts as an additional
29609 check. Callouts and their sub-options are discussed in the next section.
29610 .next
29611 If there is a defer error while doing verification routing, the ACL
29612 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29613 options, the condition is forced to be true instead. Note that this is a main
29614 verification option as well as a suboption for callouts.
29615 .next
29616 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29617 discusses the reporting of sender address verification failures.
29618 .next
29619 The &%success_on_redirect%& option causes verification always to succeed
29620 immediately after a successful redirection. By default, if a redirection
29621 generates just one address, that address is also verified. See further
29622 discussion in section &<<SECTredirwhilveri>>&.
29623 .endlist
29624
29625 .cindex "verifying address" "differentiating failures"
29626 .vindex "&$recipient_verify_failure$&"
29627 .vindex "&$sender_verify_failure$&"
29628 .vindex "&$acl_verify_message$&"
29629 After an address verification failure, &$acl_verify_message$& contains the
29630 error message that is associated with the failure. It can be preserved by
29631 coding like this:
29632 .code
29633 warn  !verify = sender
29634        set acl_m0 = $acl_verify_message
29635 .endd
29636 If you are writing your own custom rejection message or log message when
29637 denying access, you can use this variable to include information about the
29638 verification failure.
29639
29640 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29641 appropriate) contains one of the following words:
29642
29643 .ilist
29644 &%qualify%&: The address was unqualified (no domain), and the message
29645 was neither local nor came from an exempted host.
29646 .next
29647 &%route%&: Routing failed.
29648 .next
29649 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29650 occurred at or before the MAIL command (that is, on initial
29651 connection, HELO, or MAIL).
29652 .next
29653 &%recipient%&: The RCPT command in a callout was rejected.
29654 .next
29655 &%postmaster%&: The postmaster check in a callout was rejected.
29656 .endlist
29657
29658 The main use of these variables is expected to be to distinguish between
29659 rejections of MAIL and rejections of RCPT in callouts.
29660
29661
29662
29663
29664 .section "Callout verification" "SECTcallver"
29665 .cindex "verifying address" "by callout"
29666 .cindex "callout" "verification"
29667 .cindex "SMTP" "callout verification"
29668 For non-local addresses, routing verifies the domain, but is unable to do any
29669 checking of the local part. There are situations where some means of verifying
29670 the local part is desirable. One way this can be done is to make an SMTP
29671 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29672 a subsequent host for a recipient address, to see if the host accepts the
29673 address. We use the term &'callout'& to cover both cases. Note that for a
29674 sender address, the callback is not to the client host that is trying to
29675 deliver the message, but to one of the hosts that accepts incoming mail for the
29676 sender's domain.
29677
29678 Exim does not do callouts by default. If you want them to happen, you must
29679 request them by setting appropriate options on the &%verify%& condition, as
29680 described below. This facility should be used with care, because it can add a
29681 lot of resource usage to the cost of verifying an address. However, Exim does
29682 cache the results of callouts, which helps to reduce the cost. Details of
29683 caching are in section &<<SECTcallvercache>>&.
29684
29685 Recipient callouts are usually used only between hosts that are controlled by
29686 the same administration. For example, a corporate gateway host could use
29687 callouts to check for valid recipients on an internal mailserver. A successful
29688 callout does not guarantee that a real delivery to the address would succeed;
29689 on the other hand, a failing callout does guarantee that a delivery would fail.
29690
29691 If the &%callout%& option is present on a condition that verifies an address, a
29692 second stage of verification occurs if the address is successfully routed to
29693 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29694 &(manualroute)& router, where the router specifies the hosts. However, if a
29695 router that does not set up hosts routes to an &(smtp)& transport with a
29696 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29697 &%hosts_override%& set, its hosts are always used, whether or not the router
29698 supplies a host list.
29699 Callouts are only supported on &(smtp)& transports.
29700
29701 The port that is used is taken from the transport, if it is specified and is a
29702 remote transport. (For routers that do verification only, no transport need be
29703 specified.) Otherwise, the default SMTP port is used. If a remote transport
29704 specifies an outgoing interface, this is used; otherwise the interface is not
29705 specified. Likewise, the text that is used for the HELO command is taken from
29706 the transport's &%helo_data%& option; if there is no transport, the value of
29707 &$smtp_active_hostname$& is used.
29708
29709 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29710 test whether a bounce message could be delivered to the sender address. The
29711 following SMTP commands are sent:
29712 .display
29713 &`HELO `&<&'local host name'&>
29714 &`MAIL FROM:<>`&
29715 &`RCPT TO:`&<&'the address to be tested'&>
29716 &`QUIT`&
29717 .endd
29718 LHLO is used instead of HELO if the transport's &%protocol%& option is
29719 set to &"lmtp"&.
29720
29721 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29722 settings.
29723
29724 A recipient callout check is similar. By default, it also uses an empty address
29725 for the sender. This default is chosen because most hosts do not make use of
29726 the sender address when verifying a recipient. Using the same address means
29727 that a single cache entry can be used for each recipient. Some sites, however,
29728 do make use of the sender address when verifying. These are catered for by the
29729 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29730
29731 If the response to the RCPT command is a 2&'xx'& code, the verification
29732 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29733 Exim tries the next host, if any. If there is a problem with all the remote
29734 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29735 &%callout%& option is given, in which case the condition is forced to succeed.
29736
29737 .cindex "SMTP" "output flushing, disabling for callout"
29738 A callout may take a little time. For this reason, Exim normally flushes SMTP
29739 output before performing a callout in an ACL, to avoid unexpected timeouts in
29740 clients when the SMTP PIPELINING extension is in use. The flushing can be
29741 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29742
29743
29744
29745
29746 .section "Additional parameters for callouts" "CALLaddparcall"
29747 .cindex "callout" "additional parameters for"
29748 The &%callout%& option can be followed by an equals sign and a number of
29749 optional parameters, separated by commas. For example:
29750 .code
29751 verify = recipient/callout=10s,defer_ok
29752 .endd
29753 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29754 separate verify options, is retained for backwards compatibility, but is now
29755 deprecated. The additional parameters for &%callout%& are as follows:
29756
29757
29758 .vlist
29759 .vitem <&'a&~time&~interval'&>
29760 .cindex "callout" "timeout, specifying"
29761 This specifies the timeout that applies for the callout attempt to each host.
29762 For example:
29763 .code
29764 verify = sender/callout=5s
29765 .endd
29766 The default is 30 seconds. The timeout is used for each response from the
29767 remote host. It is also used for the initial connection, unless overridden by
29768 the &%connect%& parameter.
29769
29770
29771 .vitem &*connect&~=&~*&<&'time&~interval'&>
29772 .cindex "callout" "connection timeout, specifying"
29773 This parameter makes it possible to set a different (usually smaller) timeout
29774 for making the SMTP connection. For example:
29775 .code
29776 verify = sender/callout=5s,connect=1s
29777 .endd
29778 If not specified, this timeout defaults to the general timeout value.
29779
29780 .vitem &*defer_ok*&
29781 .cindex "callout" "defer, action on"
29782 When this parameter is present, failure to contact any host, or any other kind
29783 of temporary error, is treated as success by the ACL. However, the cache is not
29784 updated in this circumstance.
29785
29786 .vitem &*fullpostmaster*&
29787 .cindex "callout" "full postmaster check"
29788 This operates like the &%postmaster%& option (see below), but if the check for
29789 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29790 accordance with the specification in RFC 2821. The RFC states that the
29791 unqualified address &'postmaster'& should be accepted.
29792
29793
29794 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29795 .cindex "callout" "sender when verifying header"
29796 When verifying addresses in header lines using the &%header_sender%&
29797 verification option, Exim behaves by default as if the addresses are envelope
29798 sender addresses from a message. Callout verification therefore tests to see
29799 whether a bounce message could be delivered, by using an empty address in the
29800 MAIL command. However, it is arguable that these addresses might never be used
29801 as envelope senders, and could therefore justifiably reject bounce messages
29802 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29803 address to use in the MAIL command. For example:
29804 .code
29805 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29806 .endd
29807 This parameter is available only for the &%header_sender%& verification option.
29808
29809
29810 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29811 .cindex "callout" "overall timeout, specifying"
29812 This parameter sets an overall timeout for performing a callout verification.
29813 For example:
29814 .code
29815 verify = sender/callout=5s,maxwait=30s
29816 .endd
29817 This timeout defaults to four times the callout timeout for individual SMTP
29818 commands. The overall timeout applies when there is more than one host that can
29819 be tried. The timeout is checked before trying the next host. This prevents
29820 very long delays if there are a large number of hosts and all are timing out
29821 (for example, when network connections are timing out).
29822
29823
29824 .vitem &*no_cache*&
29825 .cindex "callout" "cache, suppressing"
29826 .cindex "caching callout, suppressing"
29827 When this parameter is given, the callout cache is neither read nor updated.
29828
29829 .vitem &*postmaster*&
29830 .cindex "callout" "postmaster; checking"
29831 When this parameter is set, a successful callout check is followed by a similar
29832 check for the local part &'postmaster'& at the same domain. If this address is
29833 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29834 the postmaster check is recorded in a cache record; if it is a failure, this is
29835 used to fail subsequent callouts for the domain without a connection being
29836 made, until the cache record expires.
29837
29838 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29839 The postmaster check uses an empty sender in the MAIL command by default.
29840 You can use this parameter to do a postmaster check using a different address.
29841 For example:
29842 .code
29843 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29844 .endd
29845 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29846 one overrides. The &%postmaster%& parameter is equivalent to this example:
29847 .code
29848 require  verify = sender/callout=postmaster_mailfrom=
29849 .endd
29850 &*Warning*&: The caching arrangements for postmaster checking do not take
29851 account of the sender address. It is assumed that either the empty address or
29852 a fixed non-empty address will be used. All that Exim remembers is that the
29853 postmaster check for the domain succeeded or failed.
29854
29855
29856 .vitem &*random*&
29857 .cindex "callout" "&""random""& check"
29858 When this parameter is set, before doing the normal callout check, Exim does a
29859 check for a &"random"& local part at the same domain. The local part is not
29860 really random &-- it is defined by the expansion of the option
29861 &%callout_random_local_part%&, which defaults to
29862 .code
29863 $primary_hostname-$tod_epoch-testing
29864 .endd
29865 The idea here is to try to determine whether the remote host accepts all local
29866 parts without checking. If it does, there is no point in doing callouts for
29867 specific local parts. If the &"random"& check succeeds, the result is saved in
29868 a cache record, and used to force the current and subsequent callout checks to
29869 succeed without a connection being made, until the cache record expires.
29870
29871 .vitem &*use_postmaster*&
29872 .cindex "callout" "sender for recipient check"
29873 This parameter applies to recipient callouts only. For example:
29874 .code
29875 deny  !verify = recipient/callout=use_postmaster
29876 .endd
29877 .vindex "&$qualify_domain$&"
29878 It causes a non-empty postmaster address to be used in the MAIL command when
29879 performing the callout for the recipient, and also for a &"random"& check if
29880 that is configured. The local part of the address is &`postmaster`& and the
29881 domain is the contents of &$qualify_domain$&.
29882
29883 .vitem &*use_sender*&
29884 This option applies to recipient callouts only. For example:
29885 .code
29886 require  verify = recipient/callout=use_sender
29887 .endd
29888 It causes the message's actual sender address to be used in the MAIL
29889 command when performing the callout, instead of an empty address. There is no
29890 need to use this option unless you know that the called hosts make use of the
29891 sender when checking recipients. If used indiscriminately, it reduces the
29892 usefulness of callout caching.
29893 .endlist
29894
29895 If you use any of the parameters that set a non-empty sender for the MAIL
29896 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29897 &%use_sender%&), you should think about possible loops. Recipient checking is
29898 usually done between two hosts that are under the same management, and the host
29899 that receives the callouts is not normally configured to do callouts itself.
29900 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29901 these circumstances.
29902
29903 However, if you use a non-empty sender address for a callout to an arbitrary
29904 host, there is the likelihood that the remote host will itself initiate a
29905 callout check back to your host. As it is checking what appears to be a message
29906 sender, it is likely to use an empty address in MAIL, thus avoiding a
29907 callout loop. However, to be on the safe side it would be best to set up your
29908 own ACLs so that they do not do sender verification checks when the recipient
29909 is the address you use for header sender or postmaster callout checking.
29910
29911 Another issue to think about when using non-empty senders for callouts is
29912 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29913 by the sender/recipient combination; thus, for any given recipient, many more
29914 actual callouts are performed than when an empty sender or postmaster is used.
29915
29916
29917
29918
29919 .section "Callout caching" "SECTcallvercache"
29920 .cindex "hints database" "callout cache"
29921 .cindex "callout" "cache, description of"
29922 .cindex "caching" "callout"
29923 Exim caches the results of callouts in order to reduce the amount of resources
29924 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29925 option. A hints database called &"callout"& is used for the cache. Two
29926 different record types are used: one records the result of a callout check for
29927 a specific address, and the other records information that applies to the
29928 entire domain (for example, that it accepts the local part &'postmaster'&).
29929
29930 When an original callout fails, a detailed SMTP error message is given about
29931 the failure. However, for subsequent failures use the cache data, this message
29932 is not available.
29933
29934 The expiry times for negative and positive address cache records are
29935 independent, and can be set by the global options &%callout_negative_expire%&
29936 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29937
29938 If a host gives a negative response to an SMTP connection, or rejects any
29939 commands up to and including
29940 .code
29941 MAIL FROM:<>
29942 .endd
29943 (but not including the MAIL command with a non-empty address),
29944 any callout attempt is bound to fail. Exim remembers such failures in a
29945 domain cache record, which it uses to fail callouts for the domain without
29946 making new connections, until the domain record times out. There are two
29947 separate expiry times for domain cache records:
29948 &%callout_domain_negative_expire%& (default 3h) and
29949 &%callout_domain_positive_expire%& (default 7d).
29950
29951 Domain records expire when the negative expiry time is reached if callouts
29952 cannot be made for the domain, or if the postmaster check failed.
29953 Otherwise, they expire when the positive expiry time is reached. This
29954 ensures that, for example, a host that stops accepting &"random"& local parts
29955 will eventually be noticed.
29956
29957 The callout caching mechanism is based on the domain of the address that is
29958 being tested. If the domain routes to several hosts, it is assumed that their
29959 behaviour will be the same.
29960
29961
29962
29963 .section "Sender address verification reporting" "SECTsenaddver"
29964 .cindex "verifying" "suppressing error details"
29965 See section &<<SECTaddressverification>>& for a general discussion of
29966 verification. When sender verification fails in an ACL, the details of the
29967 failure are given as additional output lines before the 550 response to the
29968 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29969 you might see:
29970 .code
29971 MAIL FROM:<xyz@abc.example>
29972 250 OK
29973 RCPT TO:<pqr@def.example>
29974 550-Verification failed for <xyz@abc.example>
29975 550-Called:   192.168.34.43
29976 550-Sent:     RCPT TO:<xyz@abc.example>
29977 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29978 550 Sender verification failed
29979 .endd
29980 If more than one RCPT command fails in the same way, the details are given
29981 only for the first of them. However, some administrators do not want to send
29982 out this much information. You can suppress the details by adding
29983 &`/no_details`& to the ACL statement that requests sender verification. For
29984 example:
29985 .code
29986 verify = sender/no_details
29987 .endd
29988
29989 .section "Redirection while verifying" "SECTredirwhilveri"
29990 .cindex "verifying" "redirection while"
29991 .cindex "address redirection" "while verifying"
29992 A dilemma arises when a local address is redirected by aliasing or forwarding
29993 during verification: should the generated addresses themselves be verified,
29994 or should the successful expansion of the original address be enough to verify
29995 it? By default, Exim takes the following pragmatic approach:
29996
29997 .ilist
29998 When an incoming address is redirected to just one child address, verification
29999 continues with the child address, and if that fails to verify, the original
30000 verification also fails.
30001 .next
30002 When an incoming address is redirected to more than one child address,
30003 verification does not continue. A success result is returned.
30004 .endlist
30005
30006 This seems the most reasonable behaviour for the common use of aliasing as a
30007 way of redirecting different local parts to the same mailbox. It means, for
30008 example, that a pair of alias entries of the form
30009 .code
30010 A.Wol:   aw123
30011 aw123:   :fail: Gone away, no forwarding address
30012 .endd
30013 work as expected, with both local parts causing verification failure. When a
30014 redirection generates more than one address, the behaviour is more like a
30015 mailing list, where the existence of the alias itself is sufficient for
30016 verification to succeed.
30017
30018 It is possible, however, to change the default behaviour so that all successful
30019 redirections count as successful verifications, however many new addresses are
30020 generated. This is specified by the &%success_on_redirect%& verification
30021 option. For example:
30022 .code
30023 require verify = recipient/success_on_redirect/callout=10s
30024 .endd
30025 In this example, verification succeeds if a router generates a new address, and
30026 the callout does not occur, because no address was routed to a remote host.
30027
30028 When verification is being tested via the &%-bv%& option, the treatment of
30029 redirections is as just described, unless the &%-v%& or any debugging option is
30030 also specified. In that case, full verification is done for every generated
30031 address and a report is output for each of them.
30032
30033
30034
30035 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30036 .cindex "CSA" "verifying"
30037 Client SMTP Authorization is a system that allows a site to advertise
30038 which machines are and are not permitted to send email. This is done by placing
30039 special SRV records in the DNS; these are looked up using the client's HELO
30040 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30041 Authorization checks in Exim are performed by the ACL condition:
30042 .code
30043 verify = csa
30044 .endd
30045 This fails if the client is not authorized. If there is a DNS problem, or if no
30046 valid CSA SRV record is found, or if the client is authorized, the condition
30047 succeeds. These three cases can be distinguished using the expansion variable
30048 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30049 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30050 be likely to cause problems for legitimate email.
30051
30052 The error messages produced by the CSA code include slightly more
30053 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30054 looking up the CSA SRV record, or problems looking up the CSA target
30055 address record. There are four reasons for &$csa_status$& being &"fail"&:
30056
30057 .ilist
30058 The client's host name is explicitly not authorized.
30059 .next
30060 The client's IP address does not match any of the CSA target IP addresses.
30061 .next
30062 The client's host name is authorized but it has no valid target IP addresses
30063 (for example, the target's addresses are IPv6 and the client is using IPv4).
30064 .next
30065 The client's host name has no CSA SRV record but a parent domain has asserted
30066 that all subdomains must be explicitly authorized.
30067 .endlist
30068
30069 The &%csa%& verification condition can take an argument which is the domain to
30070 use for the DNS query. The default is:
30071 .code
30072 verify = csa/$sender_helo_name
30073 .endd
30074 This implementation includes an extension to CSA. If the query domain
30075 is an address literal such as [192.0.2.95], or if it is a bare IP
30076 address, Exim searches for CSA SRV records in the reverse DNS as if
30077 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30078 meaningful to say:
30079 .code
30080 verify = csa/$sender_host_address
30081 .endd
30082 In fact, this is the check that Exim performs if the client does not say HELO.
30083 This extension can be turned off by setting the main configuration option
30084 &%dns_csa_use_reverse%& to be false.
30085
30086 If a CSA SRV record is not found for the domain itself, a search
30087 is performed through its parent domains for a record which might be
30088 making assertions about subdomains. The maximum depth of this search is limited
30089 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30090 default. Exim does not look for CSA SRV records in a top level domain, so the
30091 default settings handle HELO domains as long as seven
30092 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30093 of legitimate HELO domains.
30094
30095 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30096 direct SRV lookups, this is not sufficient because of the extra parent domain
30097 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30098 addresses into lookups in the reverse DNS space. The result of a successful
30099 lookup such as:
30100 .code
30101 ${lookup dnsdb {csa=$sender_helo_name}}
30102 .endd
30103 has two space-separated fields: an authorization code and a target host name.
30104 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30105 authorization required but absent, or &"?"& for unknown.
30106
30107
30108
30109
30110 .section "Bounce address tag validation" "SECTverifyPRVS"
30111 .cindex "BATV, verifying"
30112 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30113 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30114 Genuine incoming bounce messages should therefore always be addressed to
30115 recipients that have a valid tag. This scheme is a way of detecting unwanted
30116 bounce messages caused by sender address forgeries (often called &"collateral
30117 spam"&), because the recipients of such messages do not include valid tags.
30118
30119 There are two expansion items to help with the implementation of the BATV
30120 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30121 the original envelope sender address by using a simple key to add a hash of the
30122 address and some time-based randomizing information. The &%prvs%& expansion
30123 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30124 The syntax of these expansion items is described in section
30125 &<<SECTexpansionitems>>&.
30126
30127 As an example, suppose the secret per-address keys are stored in an MySQL
30128 database. A query to look up the key for an address could be defined as a macro
30129 like this:
30130 .code
30131 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30132                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30133                 }{$value}}
30134 .endd
30135 Suppose also that the senders who make use of BATV are defined by an address
30136 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30137 use this:
30138 .code
30139 # Bounces: drop unsigned addresses for BATV senders
30140 deny message = This address does not send an unsigned reverse path
30141      senders = :
30142      recipients = +batv_senders
30143
30144 # Bounces: In case of prvs-signed address, check signature.
30145 deny message = Invalid reverse path signature.
30146      senders = :
30147      condition  = ${prvscheck {$local_part@$domain}\
30148                   {PRVSCHECK_SQL}{1}}
30149      !condition = $prvscheck_result
30150 .endd
30151 The first statement rejects recipients for bounce messages that are addressed
30152 to plain BATV sender addresses, because it is known that BATV senders do not
30153 send out messages with plain sender addresses. The second statement rejects
30154 recipients that are prvs-signed, but with invalid signatures (either because
30155 the key is wrong, or the signature has timed out).
30156
30157 A non-prvs-signed address is not rejected by the second statement, because the
30158 &%prvscheck%& expansion yields an empty string if its first argument is not a
30159 prvs-signed address, thus causing the &%condition%& condition to be false. If
30160 the first argument is a syntactically valid prvs-signed address, the yield is
30161 the third string (in this case &"1"&), whether or not the cryptographic and
30162 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30163 of the checks (empty for failure, &"1"& for success).
30164
30165 There is one more issue you must consider when implementing prvs-signing:
30166 you have to ensure that the routers accept prvs-signed addresses and
30167 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30168 router to remove the signature with a configuration along these lines:
30169 .code
30170 batv_redirect:
30171   driver = redirect
30172   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30173 .endd
30174 This works because, if the third argument of &%prvscheck%& is empty, the result
30175 of the expansion of a prvs-signed address is the decoded value of the original
30176 address. This router should probably be the first of your routers that handles
30177 local addresses.
30178
30179 To create BATV-signed addresses in the first place, a transport of this form
30180 can be used:
30181 .code
30182 external_smtp_batv:
30183   driver = smtp
30184   return_path = ${prvs {$return_path} \
30185                        {${lookup mysql{SELECT \
30186                        secret FROM batv_prvs WHERE \
30187                        sender='${quote_mysql:$sender_address}'} \
30188                        {$value}fail}}}
30189 .endd
30190 If no key can be found for the existing return path, no signing takes place.
30191
30192
30193
30194 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30195 .cindex "&ACL;" "relay control"
30196 .cindex "relaying" "control by ACL"
30197 .cindex "policy control" "relay control"
30198 An MTA is said to &'relay'& a message if it receives it from some host and
30199 delivers it directly to another host as a result of a remote address contained
30200 within it. Redirecting a local address via an alias or forward file and then
30201 passing the message on to another host is not relaying,
30202 .cindex "&""percent hack""&"
30203 but a redirection as a result of the &"percent hack"& is.
30204
30205 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30206 A host which is acting as a gateway or an MX backup is concerned with incoming
30207 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30208 a host which is acting as a smart host for a number of clients is concerned
30209 with outgoing relaying from those clients to the Internet at large. Often the
30210 same host is fulfilling both functions,
30211 . ///
30212 . as illustrated in the diagram below,
30213 . ///
30214 but in principle these two kinds of relaying are entirely independent. What is
30215 not wanted is the transmission of mail from arbitrary remote hosts through your
30216 system to arbitrary domains.
30217
30218
30219 You can implement relay control by means of suitable statements in the ACL that
30220 runs for each RCPT command. For convenience, it is often easiest to use
30221 Exim's named list facility to define the domains and hosts involved. For
30222 example, suppose you want to do the following:
30223
30224 .ilist
30225 Deliver a number of domains to mailboxes on the local host (or process them
30226 locally in some other way). Let's say these are &'my.dom1.example'& and
30227 &'my.dom2.example'&.
30228 .next
30229 Relay mail for a number of other domains for which you are the secondary MX.
30230 These might be &'friend1.example'& and &'friend2.example'&.
30231 .next
30232 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30233 Suppose your LAN is 192.168.45.0/24.
30234 .endlist
30235
30236
30237 In the main part of the configuration, you put the following definitions:
30238 .code
30239 domainlist local_domains    = my.dom1.example : my.dom2.example
30240 domainlist relay_to_domains = friend1.example : friend2.example
30241 hostlist   relay_from_hosts = 192.168.45.0/24
30242 .endd
30243 Now you can use these definitions in the ACL that is run for every RCPT
30244 command:
30245 .code
30246 acl_check_rcpt:
30247   accept domains = +local_domains : +relay_to_domains
30248   accept hosts   = +relay_from_hosts
30249 .endd
30250 The first statement accepts any RCPT command that contains an address in
30251 the local or relay domains. For any other domain, control passes to the second
30252 statement, which accepts the command only if it comes from one of the relay
30253 hosts. In practice, you will probably want to make your ACL more sophisticated
30254 than this, for example, by including sender and recipient verification. The
30255 default configuration includes a more comprehensive example, which is described
30256 in chapter &<<CHAPdefconfil>>&.
30257
30258
30259
30260 .section "Checking a relay configuration" "SECTcheralcon"
30261 .cindex "relaying" "checking control of"
30262 You can check the relay characteristics of your configuration in the same way
30263 that you can test any ACL behaviour for an incoming SMTP connection, by using
30264 the &%-bh%& option to run a fake SMTP session with which you interact.
30265
30266 For specifically testing for unwanted relaying, the host
30267 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30268 host from the host on which Exim is running, using the normal telnet port, you
30269 will see a normal telnet connection message and then quite a long delay. Be
30270 patient. The remote host is making an SMTP connection back to your host, and
30271 trying a number of common probes to test for open relay vulnerability. The
30272 results of the tests will eventually appear on your terminal.
30273 .ecindex IIDacl
30274
30275
30276
30277 . ////////////////////////////////////////////////////////////////////////////
30278 . ////////////////////////////////////////////////////////////////////////////
30279
30280 .chapter "Content scanning at ACL time" "CHAPexiscan"
30281 .scindex IIDcosca "content scanning" "at ACL time"
30282 The extension of Exim to include content scanning at ACL time, formerly known
30283 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30284 was integrated into the main source for Exim release 4.50, and Tom continues to
30285 maintain it. Most of the wording of this chapter is taken from Tom's
30286 specification.
30287
30288 It is also possible to scan the content of messages at other times. The
30289 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30290 scanning after all the ACLs have run. A transport filter can be used to scan
30291 messages at delivery time (see the &%transport_filter%& option, described in
30292 chapter &<<CHAPtransportgeneric>>&).
30293
30294 If you want to include the ACL-time content-scanning features when you compile
30295 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30296 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30297
30298 .ilist
30299 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30300 for all MIME parts for SMTP and non-SMTP messages, respectively.
30301 .next
30302 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30303 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30304 run at the end of message reception (the &%acl_smtp_data%& ACL).
30305 .next
30306 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30307 of messages, or parts of messages, for debugging purposes.
30308 .next
30309 Additional expansion variables that are set in the new ACL and by the new
30310 conditions.
30311 .next
30312 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30313 .endlist
30314
30315 There is another content-scanning configuration option for &_Local/Makefile_&,
30316 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30317 condition is compiled, in addition to all the other content-scanning features.
30318
30319 Content-scanning is continually evolving, and new features are still being
30320 added. While such features are still unstable and liable to incompatible
30321 changes, they are made available in Exim by setting options whose names begin
30322 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30323 this manual. You can find out about them by reading the file called
30324 &_doc/experimental.txt_&.
30325
30326 All the content-scanning facilities work on a MBOX copy of the message that is
30327 temporarily created in a file called:
30328 .display
30329 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30330 .endd
30331 The &_.eml_& extension is a friendly hint to virus scanners that they can
30332 expect an MBOX-like structure inside that file. The file is created when the
30333 first content scanning facility is called. Subsequent calls to content
30334 scanning conditions open the same file again. The directory is recursively
30335 removed when the &%acl_smtp_data%& ACL has finished running, unless
30336 .code
30337 control = no_mbox_unspool
30338 .endd
30339 has been encountered. When the MIME ACL decodes files, they are put into the
30340 same directory by default.
30341
30342
30343
30344 .section "Scanning for viruses" "SECTscanvirus"
30345 .cindex "virus scanning"
30346 .cindex "content scanning" "for viruses"
30347 .cindex "content scanning" "the &%malware%& condition"
30348 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30349 It supports a &"generic"& interface to scanners called via the shell, and
30350 specialized interfaces for &"daemon"& type virus scanners, which are resident
30351 in memory and thus are much faster.
30352
30353 A timeout of 2 minutes is applied to a scanner call (by default);
30354 if it expires then a defer action is taken.
30355
30356 .oindex "&%av_scanner%&"
30357 You can set the &%av_scanner%& option in the main part of the configuration
30358 to specify which scanner to use, together with any additional options that
30359 are needed. The basic syntax is as follows:
30360 .display
30361 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30362 .endd
30363 If you do not set &%av_scanner%&, it defaults to
30364 .code
30365 av_scanner = sophie:/var/run/sophie
30366 .endd
30367 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30368 before use.
30369 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30370 The following scanner types are supported in this release:
30371
30372 .vlist
30373 .vitem &%avast%&
30374 .cindex "virus scanners" "avast"
30375 This is the scanner daemon of Avast. It has been tested with Avast Core
30376 Security (currenty at version 1.1.7).
30377 You can get a trial version at &url(http://www.avast.com) or for Linux
30378 at &url(http://www.avast.com/linux-server-antivirus).
30379 This scanner type takes one option,
30380 which can be either a full path to a UNIX socket,
30381 or host and port specifiers separated by white space.
30382 The host may be a name or an IP address; the port is either a
30383 single number or a pair of numbers with a dash between.
30384 Any further options are given, on separate lines,
30385 to the daemon as options before the main scan command.
30386 For example:
30387 .code
30388 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
30389 av_scanner = avast:192.168.2.22 5036
30390 .endd
30391 If you omit the argument, the default path
30392 &_/var/run/avast/scan.sock_&
30393 is used.
30394 If you use a remote host,
30395 you need to make Exim's spool directory available to it,
30396 as the scanner is passed a file path, not file contents.
30397 For information about available commands and their options you may use 
30398 .code
30399 $ socat UNIX:/var/run/avast/scan.sock STDIO:
30400     FLAGS
30401     SENSITIVITY
30402     PACK
30403 .endd
30404
30405
30406 .vitem &%aveserver%&
30407 .cindex "virus scanners" "Kaspersky"
30408 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30409 at &url(http://www.kaspersky.com). This scanner type takes one option,
30410 which is the path to the daemon's UNIX socket. The default is shown in this
30411 example:
30412 .code
30413 av_scanner = aveserver:/var/run/aveserver
30414 .endd
30415
30416
30417 .vitem &%clamd%&
30418 .cindex "virus scanners" "clamd"
30419 This daemon-type scanner is GPL and free. You can get it at
30420 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30421 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30422 in the MIME ACL. This no longer believed to be necessary. One option is
30423 required: either the path and name of a UNIX socket file, or a hostname or IP
30424 number, and a port, separated by space, as in the second of these examples:
30425 .code
30426 av_scanner = clamd:/opt/clamd/socket
30427 av_scanner = clamd:192.0.2.3 1234
30428 av_scanner = clamd:192.0.2.3 1234:local
30429 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30430 .endd
30431 If the value of av_scanner points to a UNIX socket file or contains the local
30432 keyword, then the ClamAV interface will pass a filename containing the data
30433 to be scanned, which will should normally result in less I/O happening and be
30434 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30435 Exim does not assume that there is a common filesystem with the remote host.
30436 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30437 you be running a version of ClamAV prior to 0.95.
30438
30439 The final example shows that multiple TCP targets can be specified.  Exim will
30440 randomly use one for each incoming email (i.e. it load balances them).  Note
30441 that only TCP targets may be used if specifying a list of scanners; a UNIX
30442 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30443 unavailable, Exim will try the remaining one(s) until it finds one that works.
30444 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30445 not keep track of scanner state between multiple messages, and the scanner
30446 selection is random, so the message will get logged in the mainlog for each
30447 email that the down scanner gets chosen first (message wrapped to be readable):
30448 .code
30449 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30450    clamd: connection to localhost, port 3310 failed
30451    (Connection refused)
30452 .endd
30453
30454 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30455 contributing the code for this scanner.
30456
30457 .vitem &%cmdline%&
30458 .cindex "virus scanners" "command line interface"
30459 This is the keyword for the generic command line scanner interface. It can be
30460 used to attach virus scanners that are invoked from the shell. This scanner
30461 type takes 3 mandatory options:
30462
30463 .olist
30464 The full path and name of the scanner binary, with all command line options,
30465 and a placeholder (&`%s`&) for the directory to scan.
30466
30467 .next
30468 A regular expression to match against the STDOUT and STDERR output of the
30469 virus scanner. If the expression matches, a virus was found. You must make
30470 absolutely sure that this expression matches on &"virus found"&. This is called
30471 the &"trigger"& expression.
30472
30473 .next
30474 Another regular expression, containing exactly one pair of parentheses, to
30475 match the name of the virus found in the scanners output. This is called the
30476 &"name"& expression.
30477 .endlist olist
30478
30479 For example, Sophos Sweep reports a virus on a line like this:
30480 .code
30481 Virus 'W32/Magistr-B' found in file ./those.bat
30482 .endd
30483 For the trigger expression, we can match the phrase &"found in file"&. For the
30484 name expression, we want to extract the W32/Magistr-B string, so we can match
30485 for the single quotes left and right of it. Altogether, this makes the
30486 configuration setting:
30487 .code
30488 av_scanner = cmdline:\
30489              /path/to/sweep -ss -all -rec -archive %s:\
30490              found in file:'(.+)'
30491 .endd
30492 .vitem &%drweb%&
30493 .cindex "virus scanners" "DrWeb"
30494 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30495 takes one option,
30496 either a full path to a UNIX socket,
30497 or host and port specifiers separated by white space.
30498 The host may be a name or an IP address; the port is either a
30499 single number or a pair of numbers with a dash between.
30500 For example:
30501 .code
30502 av_scanner = drweb:/var/run/drwebd.sock
30503 av_scanner = drweb:192.168.2.20 31337
30504 .endd
30505 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30506 is used. Thanks to Alex Miller for contributing the code for this scanner.
30507
30508 .vitem &%fsecure%&
30509 .cindex "virus scanners" "F-Secure"
30510 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30511 argument which is the path to a UNIX socket. For example:
30512 .code
30513 av_scanner = fsecure:/path/to/.fsav
30514 .endd
30515 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30516 Thelmen for contributing the code for this scanner.
30517
30518 .vitem &%kavdaemon%&
30519 .cindex "virus scanners" "Kaspersky"
30520 This is the scanner daemon of Kaspersky Version 4. This version of the
30521 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30522 scanner type takes one option, which is the path to the daemon's UNIX socket.
30523 For example:
30524 .code
30525 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30526 .endd
30527 The default path is &_/var/run/AvpCtl_&.
30528
30529 .vitem &%mksd%&
30530 .cindex "virus scanners" "mksd"
30531 This is a daemon type scanner that is aimed mainly at Polish users, though some
30532 parts of documentation are now available in English. You can get it at
30533 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30534 the maximum number of processes used simultaneously to scan the attachments,
30535 provided that the demime facility is employed and also provided that mksd has
30536 been run with at least the same number of child processes. For example:
30537 .code
30538 av_scanner = mksd:2
30539 .endd
30540 You can safely omit this option (the default value is 1).
30541
30542 .vitem &%sock%&
30543 .cindex "virus scanners" "simple socket-connected"
30544 This is a general-purpose way of talking to simple scanner daemons
30545 running on the local machine.
30546 There are four options:
30547 an address (which may be an IP addres and port, or the path of a Unix socket),
30548 a commandline to send (may include a single %s which will be replaced with
30549 the path to the mail file to be scanned),
30550 an RE to trigger on from the returned data,
30551 an RE to extract malware_name from the returned data.
30552 For example:
30553 .code
30554 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30555 .endd
30556 Default for the socket specifier is &_/tmp/malware.sock_&.
30557 Default for the commandline is &_%s\n_&.
30558 Both regular-expressions are required.
30559
30560 .vitem &%sophie%&
30561 .cindex "virus scanners" "Sophos and Sophie"
30562 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30563 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30564 for this scanner type is the path to the UNIX socket that Sophie uses for
30565 client communication. For example:
30566 .code
30567 av_scanner = sophie:/tmp/sophie
30568 .endd
30569 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30570 the option.
30571 .endlist
30572
30573 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30574 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30575 ACL.
30576
30577 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30578 makes it possible to use different scanners. See further below for an example.
30579 The &%malware%& condition caches its results, so when you use it multiple times
30580 for the same message, the actual scanning process is only carried out once.
30581 However, using expandable items in &%av_scanner%& disables this caching, in
30582 which case each use of the &%malware%& condition causes a new scan of the
30583 message.
30584
30585 The &%malware%& condition takes a right-hand argument that is expanded before
30586 use and taken as a list, slash-separated by default.
30587 The first element can then be one of
30588
30589 .ilist
30590 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30591 The condition succeeds if a virus was found, and fail otherwise. This is the
30592 recommended usage.
30593 .next
30594 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30595 the condition fails immediately.
30596 .next
30597 A regular expression, in which case the message is scanned for viruses. The
30598 condition succeeds if a virus is found and its name matches the regular
30599 expression. This allows you to take special actions on certain types of virus.
30600 Note that &"/"& characters in the RE must be doubled due to the list-processing,
30601 unless the separator is changed (in the usual way).
30602 .endlist
30603
30604 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
30605 messages even if there is a problem with the virus scanner.
30606 Otherwise, such a problem causes the ACL to defer.
30607
30608 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
30609 specify a non-default timeout.  The default is two minutes.
30610 For example:
30611 .code
30612 malware = * / defer_ok / tmo=10s
30613 .endd
30614 A timeout causes the ACL to defer.
30615
30616 .vindex "&$malware_name$&"
30617 When a virus is found, the condition sets up an expansion variable called
30618 &$malware_name$& that contains the name of the virus. You can use it in a
30619 &%message%& modifier that specifies the error returned to the sender, and/or in
30620 logging data.
30621
30622 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30623 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30624 &%malware%& condition.
30625
30626 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30627 imposed by your anti-virus scanner.
30628
30629 Here is a very simple scanning example:
30630 .code
30631 deny message = This message contains malware ($malware_name)
30632      demime = *
30633      malware = *
30634 .endd
30635 The next example accepts messages when there is a problem with the scanner:
30636 .code
30637 deny message = This message contains malware ($malware_name)
30638      demime = *
30639      malware = */defer_ok
30640 .endd
30641 The next example shows how to use an ACL variable to scan with both sophie and
30642 aveserver. It assumes you have set:
30643 .code
30644 av_scanner = $acl_m0
30645 .endd
30646 in the main Exim configuration.
30647 .code
30648 deny message = This message contains malware ($malware_name)
30649      set acl_m0 = sophie
30650      malware = *
30651
30652 deny message = This message contains malware ($malware_name)
30653      set acl_m0 = aveserver
30654      malware = *
30655 .endd
30656
30657
30658 .section "Scanning with SpamAssassin" "SECTscanspamass"
30659 .cindex "content scanning" "for spam"
30660 .cindex "spam scanning"
30661 .cindex "SpamAssassin"
30662 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30663 score and a report for the message. You can get SpamAssassin at
30664 &url(http://www.spamassassin.org), or, if you have a working Perl
30665 installation, you can use CPAN by running:
30666 .code
30667 perl -MCPAN -e 'install Mail::SpamAssassin'
30668 .endd
30669 SpamAssassin has its own set of configuration files. Please review its
30670 documentation to see how you can tweak it. The default installation should work
30671 nicely, however.
30672
30673 .oindex "&%spamd_address%&"
30674 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
30675 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
30676 port for &%spamd%&, you must set the &%spamd_address%& option in the global
30677 part of the Exim configuration as follows (example):
30678 .code
30679 spamd_address = 192.168.99.45 387
30680 .endd
30681 You do not need to set this option if you use the default. As of version 2.60,
30682 &%spamd%& also supports communication over UNIX sockets. If you want to use
30683 these, supply &%spamd_address%& with an absolute file name instead of a
30684 address/port pair:
30685 .code
30686 spamd_address = /var/run/spamd_socket
30687 .endd
30688 You can have multiple &%spamd%& servers to improve scalability. These can
30689 reside on other hardware reachable over the network. To specify multiple
30690 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30691 option, separated with colons:
30692 .code
30693 spamd_address = 192.168.2.10 783 : \
30694                 192.168.2.11 783 : \
30695                 192.168.2.12 783
30696 .endd
30697 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
30698 fashion. When a server fails to respond to the connection attempt, all other
30699 servers are tried until one succeeds. If no server responds, the &%spam%&
30700 condition defers.
30701
30702 &*Warning*&: It is not possible to use the UNIX socket connection method with
30703 multiple &%spamd%& servers.
30704
30705 The &%spamd_address%& variable is expanded before use if it starts with
30706 a dollar sign. In this case, the expansion may return a string that is
30707 used as the list so that multiple spamd servers can be the result of an
30708 expansion.
30709
30710 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30711 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30712 .code
30713 deny message = This message was classified as SPAM
30714      spam = joe
30715 .endd
30716 The right-hand side of the &%spam%& condition specifies a name. This is
30717 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30718 to scan using a specific profile, but rather use the SpamAssassin system-wide
30719 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30720 However, you must put something on the right-hand side.
30721
30722 The name allows you to use per-domain or per-user antispam profiles in
30723 principle, but this is not straightforward in practice, because a message may
30724 have multiple recipients, not necessarily all in the same domain. Because the
30725 &%spam%& condition has to be called from a DATA ACL in order to be able to
30726 read the contents of the message, the variables &$local_part$& and &$domain$&
30727 are not set.
30728
30729 The right-hand side of the &%spam%& condition is expanded before being used, so
30730 you can put lookups or conditions there. When the right-hand side evaluates to
30731 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30732
30733
30734 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30735 large ones may cause significant performance degradation. As most spam messages
30736 are quite small, it is recommended that you do not scan the big ones. For
30737 example:
30738 .code
30739 deny message = This message was classified as SPAM
30740      condition = ${if < {$message_size}{10K}}
30741      spam = nobody
30742 .endd
30743
30744 The &%spam%& condition returns true if the threshold specified in the user's
30745 SpamAssassin profile has been matched or exceeded. If you want to use the
30746 &%spam%& condition for its side effects (see the variables below), you can make
30747 it always return &"true"& by appending &`:true`& to the username.
30748
30749 .cindex "spam scanning" "returned variables"
30750 When the &%spam%& condition is run, it sets up a number of expansion
30751 variables. These variables are saved with the received message, thus they are
30752 available for use at delivery time.
30753
30754 .vlist
30755 .vitem &$spam_score$&
30756 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30757 for inclusion in log or reject messages.
30758
30759 .vitem &$spam_score_int$&
30760 The spam score of the message, multiplied by ten, as an integer value. For
30761 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30762 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30763 The integer value is useful for numeric comparisons in conditions.
30764
30765 .vitem &$spam_bar$&
30766 A string consisting of a number of &"+"& or &"-"& characters, representing the
30767 integer part of the spam score value. A spam score of 4.4 would have a
30768 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30769 headers, since MUAs can match on such strings.
30770
30771 .vitem &$spam_report$&
30772 A multiline text table, containing the full SpamAssassin report for the
30773 message. Useful for inclusion in headers or reject messages.
30774 .endlist
30775
30776 The &%spam%& condition caches its results unless expansion in
30777 spamd_address was used. If you call it again with the same user name, it
30778 does not scan again, but rather returns the same values as before.
30779
30780 The &%spam%& condition returns DEFER if there is any error while running
30781 the message through SpamAssassin or if the expansion of spamd_address
30782 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30783 statement block), append &`/defer_ok`& to the right-hand side of the
30784 spam condition, like this:
30785 .code
30786 deny message = This message was classified as SPAM
30787      spam    = joe/defer_ok
30788 .endd
30789 This causes messages to be accepted even if there is a problem with &%spamd%&.
30790
30791 Here is a longer, commented example of the use of the &%spam%&
30792 condition:
30793 .code
30794 # put headers in all messages (no matter if spam or not)
30795 warn  spam = nobody:true
30796       add_header = X-Spam-Score: $spam_score ($spam_bar)
30797       add_header = X-Spam-Report: $spam_report
30798
30799 # add second subject line with *SPAM* marker when message
30800 # is over threshold
30801 warn  spam = nobody
30802       add_header = Subject: *SPAM* $h_Subject:
30803
30804 # reject spam at high scores (> 12)
30805 deny  message = This message scored $spam_score spam points.
30806       spam = nobody:true
30807       condition = ${if >{$spam_score_int}{120}{1}{0}}
30808 .endd
30809
30810
30811
30812 .section "Scanning MIME parts" "SECTscanmimepart"
30813 .cindex "content scanning" "MIME parts"
30814 .cindex "MIME content scanning"
30815 .oindex "&%acl_smtp_mime%&"
30816 .oindex "&%acl_not_smtp_mime%&"
30817 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30818 each MIME part of an SMTP message, including multipart types, in the sequence
30819 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30820 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30821 options may both refer to the same ACL if you want the same processing in both
30822 cases.
30823
30824 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30825 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30826 the case of a non-SMTP message. However, a MIME ACL is called only if the
30827 message contains a &'Content-Type:'& header line. When a call to a MIME
30828 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30829 result code is sent to the client. In the case of an SMTP message, the
30830 &%acl_smtp_data%& ACL is not called when this happens.
30831
30832 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30833 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30834 condition to match against the raw MIME part. You can also use the
30835 &%mime_regex%& condition to match against the decoded MIME part (see section
30836 &<<SECTscanregex>>&).
30837
30838 At the start of a MIME ACL, a number of variables are set from the header
30839 information for the relevant MIME part. These are described below. The contents
30840 of the MIME part are not by default decoded into a disk file except for MIME
30841 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30842 part into a disk file, you can use the &%decode%& condition. The general
30843 syntax is:
30844 .display
30845 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30846 .endd
30847 The right hand side is expanded before use. After expansion,
30848 the value can be:
30849
30850 .olist
30851 &"0"& or &"false"&, in which case no decoding is done.
30852 .next
30853 The string &"default"&. In that case, the file is put in the temporary
30854 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30855 a sequential file name consisting of the message id and a sequence number. The
30856 full path and name is available in &$mime_decoded_filename$& after decoding.
30857 .next
30858 A full path name starting with a slash. If the full name is an existing
30859 directory, it is used as a replacement for the default directory. The filename
30860 is then sequentially assigned. If the path does not exist, it is used as
30861 the full path and file name.
30862 .next
30863 If the string does not start with a slash, it is used as the
30864 filename, and the default path is then used.
30865 .endlist
30866 The &%decode%& condition normally succeeds. It is only false for syntax
30867 errors or unusual circumstances such as memory shortages. You can easily decode
30868 a file with its original, proposed filename using
30869 .code
30870 decode = $mime_filename
30871 .endd
30872 However, you should keep in mind that &$mime_filename$& might contain
30873 anything. If you place files outside of the default path, they are not
30874 automatically unlinked.
30875
30876 For RFC822 attachments (these are messages attached to messages, with a
30877 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30878 as for the primary message, only that the &$mime_is_rfc822$& expansion
30879 variable is set (see below). Attached messages are always decoded to disk
30880 before being checked, and the files are unlinked once the check is done.
30881
30882 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30883 used to match regular expressions against raw and decoded MIME parts,
30884 respectively. They are described in section &<<SECTscanregex>>&.
30885
30886 .cindex "MIME content scanning" "returned variables"
30887 The following list describes all expansion variables that are
30888 available in the MIME ACL:
30889
30890 .vlist
30891 .vitem &$mime_boundary$&
30892 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30893 have a boundary string, which is stored in this variable. If the current part
30894 has no boundary parameter in the &'Content-Type:'& header, this variable
30895 contains the empty string.
30896
30897 .vitem &$mime_charset$&
30898 This variable contains the character set identifier, if one was found in the
30899 &'Content-Type:'& header. Examples for charset identifiers are:
30900 .code
30901 us-ascii
30902 gb2312 (Chinese)
30903 iso-8859-1
30904 .endd
30905 Please note that this value is not normalized, so you should do matches
30906 case-insensitively.
30907
30908 .vitem &$mime_content_description$&
30909 This variable contains the normalized content of the &'Content-Description:'&
30910 header. It can contain a human-readable description of the parts content. Some
30911 implementations repeat the filename for attachments here, but they are usually
30912 only used for display purposes.
30913
30914 .vitem &$mime_content_disposition$&
30915 This variable contains the normalized content of the &'Content-Disposition:'&
30916 header. You can expect strings like &"attachment"& or &"inline"& here.
30917
30918 .vitem &$mime_content_id$&
30919 This variable contains the normalized content of the &'Content-ID:'& header.
30920 This is a unique ID that can be used to reference a part from another part.
30921
30922 .vitem &$mime_content_size$&
30923 This variable is set only after the &%decode%& modifier (see above) has been
30924 successfully run. It contains the size of the decoded part in kilobytes. The
30925 size is always rounded up to full kilobytes, so only a completely empty part
30926 has a &$mime_content_size$& of zero.
30927
30928 .vitem &$mime_content_transfer_encoding$&
30929 This variable contains the normalized content of the
30930 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30931 type. Typical values are &"base64"& and &"quoted-printable"&.
30932
30933 .vitem &$mime_content_type$&
30934 If the MIME part has a &'Content-Type:'& header, this variable contains its
30935 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30936 are some examples of popular MIME types, as they may appear in this variable:
30937 .code
30938 text/plain
30939 text/html
30940 application/octet-stream
30941 image/jpeg
30942 audio/midi
30943 .endd
30944 If the MIME part has no &'Content-Type:'& header, this variable contains the
30945 empty string.
30946
30947 .vitem &$mime_decoded_filename$&
30948 This variable is set only after the &%decode%& modifier (see above) has been
30949 successfully run. It contains the full path and file name of the file
30950 containing the decoded data.
30951 .endlist
30952
30953 .cindex "RFC 2047"
30954 .vlist
30955 .vitem &$mime_filename$&
30956 This is perhaps the most important of the MIME variables. It contains a
30957 proposed filename for an attachment, if one was found in either the
30958 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30959 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30960 found, this variable contains the empty string.
30961
30962 .vitem &$mime_is_coverletter$&
30963 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30964 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30965 content in the cover letter, while not restricting attachments at all.
30966
30967 The variable contains 1 (true) for a MIME part believed to be part of the
30968 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30969 follows:
30970
30971 .olist
30972 The outermost MIME part of a message is always a cover letter.
30973
30974 .next
30975 If a multipart/alternative or multipart/related MIME part is a cover letter,
30976 so are all MIME subparts within that multipart.
30977
30978 .next
30979 If any other multipart is a cover letter, the first subpart is a cover letter,
30980 and the rest are attachments.
30981
30982 .next
30983 All parts contained within an attachment multipart are attachments.
30984 .endlist olist
30985
30986 As an example, the following will ban &"HTML mail"& (including that sent with
30987 alternative plain text), while allowing HTML files to be attached. HTML
30988 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30989 .code
30990 deny message = HTML mail is not accepted here
30991 !condition = $mime_is_rfc822
30992 condition = $mime_is_coverletter
30993 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30994 .endd
30995 .vitem &$mime_is_multipart$&
30996 This variable has the value 1 (true) when the current part has the main type
30997 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30998 Since multipart entities only serve as containers for other parts, you may not
30999 want to carry out specific actions on them.
31000
31001 .vitem &$mime_is_rfc822$&
31002 This variable has the value 1 (true) if the current part is not a part of the
31003 checked message itself, but part of an attached message. Attached message
31004 decoding is fully recursive.
31005
31006 .vitem &$mime_part_count$&
31007 This variable is a counter that is raised for each processed MIME part. It
31008 starts at zero for the very first part (which is usually a multipart). The
31009 counter is per-message, so it is reset when processing RFC822 attachments (see
31010 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31011 complete, so you can use it in the DATA ACL to determine the number of MIME
31012 parts of a message. For non-MIME messages, this variable contains the value -1.
31013 .endlist
31014
31015
31016
31017 .section "Scanning with regular expressions" "SECTscanregex"
31018 .cindex "content scanning" "with regular expressions"
31019 .cindex "regular expressions" "content scanning with"
31020 You can specify your own custom regular expression matches on the full body of
31021 the message, or on individual MIME parts.
31022
31023 The &%regex%& condition takes one or more regular expressions as arguments and
31024 matches them against the full message (when called in the DATA ACL) or a raw
31025 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31026 linewise, with a maximum line length of 32K characters. That means you cannot
31027 have multiline matches with the &%regex%& condition.
31028
31029 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31030 to 32K of decoded content (the whole content at once, not linewise). If the
31031 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31032 is decoded automatically when &%mime_regex%& is executed (using default path
31033 and filename values). If the decoded data is larger than  32K, only the first
31034 32K characters are checked.
31035
31036 The regular expressions are passed as a colon-separated list. To include a
31037 literal colon, you must double it. Since the whole right-hand side string is
31038 expanded before being used, you must also escape dollar signs and backslashes
31039 with more backslashes, or use the &`\N`& facility to disable expansion.
31040 Here is a simple example that contains two regular expressions:
31041 .code
31042 deny message = contains blacklisted regex ($regex_match_string)
31043      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31044 .endd
31045 The conditions returns true if any one of the regular expressions matches. The
31046 &$regex_match_string$& expansion variable is then set up and contains the
31047 matching regular expression.
31048
31049 &*Warning*&: With large messages, these conditions can be fairly
31050 CPU-intensive.
31051
31052
31053
31054
31055 .section "The demime condition" "SECTdemimecond"
31056 .cindex "content scanning" "MIME checking"
31057 .cindex "MIME content scanning"
31058 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31059 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31060 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31061 ACL functionality, but provides no additional facilities. Please note that this
31062 condition is deprecated and kept only for backward compatibility. You must set
31063 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31064 use the &%demime%& condition.
31065
31066 The &%demime%& condition unpacks MIME containers in the message. It detects
31067 errors in MIME containers and can match file extensions found in the message
31068 against a list. Using this facility produces files containing the unpacked MIME
31069 parts of the message in the temporary scan directory. If you do antivirus
31070 scanning, it is recommended that you use the &%demime%& condition before the
31071 antivirus (&%malware%&) condition.
31072
31073 On the right-hand side of the &%demime%& condition you can pass a
31074 colon-separated list of file extensions that it should match against. For
31075 example:
31076 .code
31077 deny message = Found blacklisted file attachment
31078      demime  = vbs:com:bat:pif:prf:lnk
31079 .endd
31080 If one of the file extensions is found, the condition is true, otherwise it is
31081 false. If there is a temporary error while demimeing (for example, &"disk
31082 full"&), the condition defers, and the message is temporarily rejected (unless
31083 the condition is on a &%warn%& verb).
31084
31085 The right-hand side is expanded before being treated as a list, so you can have
31086 conditions and lookups there. If it expands to an empty string, &"false"&, or
31087 zero (&"0"&), no demimeing is done and the condition is false.
31088
31089 The &%demime%& condition set the following variables:
31090
31091 .vlist
31092 .vitem &$demime_errorlevel$&
31093 .vindex "&$demime_errorlevel$&"
31094 When an error is detected in a MIME container, this variable contains the
31095 severity of the error, as an integer number. The higher the value, the more
31096 severe the error (the current maximum value is 3). If this variable is unset or
31097 zero, no error occurred.
31098
31099 .vitem &$demime_reason$&
31100 .vindex "&$demime_reason$&"
31101 When &$demime_errorlevel$& is greater than zero, this variable contains a
31102 human-readable text string describing the MIME error that occurred.
31103 .endlist
31104
31105 .vlist
31106 .vitem &$found_extension$&
31107 .vindex "&$found_extension$&"
31108 When the &%demime%& condition is true, this variable contains the file
31109 extension it found.
31110 .endlist
31111
31112 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31113 the &%demime%& condition, and are not changed on subsequent calls.
31114
31115 If you do not want to check for file extensions, but rather use the &%demime%&
31116 condition for unpacking or error checking purposes, pass &"*"& as the
31117 right-hand side value. Here is a more elaborate example of how to use this
31118 facility:
31119 .code
31120 # Reject messages with serious MIME container errors
31121 deny  message = Found MIME error ($demime_reason).
31122       demime = *
31123       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31124
31125 # Reject known virus spreading file extensions.
31126 # Accepting these is pretty much braindead.
31127 deny  message = contains $found_extension file (blacklisted).
31128       demime  = com:vbs:bat:pif:scr
31129
31130 # Freeze .exe and .doc files. Postmaster can
31131 # examine them and eventually thaw them.
31132 deny  log_message = Another $found_extension file.
31133       demime = exe:doc
31134       control = freeze
31135 .endd
31136 .ecindex IIDcosca
31137
31138
31139
31140
31141 . ////////////////////////////////////////////////////////////////////////////
31142 . ////////////////////////////////////////////////////////////////////////////
31143
31144 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31145          "Local scan function"
31146 .scindex IIDlosca "&[local_scan()]& function" "description of"
31147 .cindex "customizing" "input scan using C function"
31148 .cindex "policy control" "by local scan function"
31149 In these days of email worms, viruses, and ever-increasing spam, some sites
31150 want to apply a lot of checking to messages before accepting them.
31151
31152 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31153 passing messages to external virus and spam scanning software. You can also do
31154 a certain amount in Exim itself through string expansions and the &%condition%&
31155 condition in the ACL that runs after the SMTP DATA command or the ACL for
31156 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31157
31158 To allow for further customization to a site's own requirements, there is the
31159 possibility of linking Exim with a private message scanning function, written
31160 in C. If you want to run code that is written in something other than C, you
31161 can of course use a little C stub to call it.
31162
31163 The local scan function is run once for every incoming message, at the point
31164 when Exim is just about to accept the message.
31165 It can therefore be used to control non-SMTP messages from local processes as
31166 well as messages arriving via SMTP.
31167
31168 Exim applies a timeout to calls of the local scan function, and there is an
31169 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31170 Zero means &"no timeout"&.
31171 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31172 before calling the local scan function, so that the most common types of crash
31173 are caught. If the timeout is exceeded or one of those signals is caught, the
31174 incoming message is rejected with a temporary error if it is an SMTP message.
31175 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31176 code. The incident is logged on the main and reject logs.
31177
31178
31179
31180 .section "Building Exim to use a local scan function" "SECID207"
31181 .cindex "&[local_scan()]& function" "building Exim to use"
31182 To make use of the local scan function feature, you must tell Exim where your
31183 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31184 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31185 directory, so you might set
31186 .code
31187 LOCAL_SCAN_SOURCE=Local/local_scan.c
31188 .endd
31189 for example. The function must be called &[local_scan()]&. It is called by
31190 Exim after it has received a message, when the success return code is about to
31191 be sent. This is after all the ACLs have been run. The return code from your
31192 function controls whether the message is actually accepted or not. There is a
31193 commented template function (that just accepts the message) in the file
31194 _src/local_scan.c_.
31195
31196 If you want to make use of Exim's run time configuration file to set options
31197 for your &[local_scan()]& function, you must also set
31198 .code
31199 LOCAL_SCAN_HAS_OPTIONS=yes
31200 .endd
31201 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31202
31203
31204
31205
31206 .section "API for local_scan()" "SECTapiforloc"
31207 .cindex "&[local_scan()]& function" "API description"
31208 You must include this line near the start of your code:
31209 .code
31210 #include "local_scan.h"
31211 .endd
31212 This header file defines a number of variables and other values, and the
31213 prototype for the function itself. Exim is coded to use unsigned char values
31214 almost exclusively, and one of the things this header defines is a shorthand
31215 for &`unsigned char`& called &`uschar`&.
31216 It also contains the following macro definitions, to simplify casting character
31217 strings and pointers to character strings:
31218 .code
31219 #define CS   (char *)
31220 #define CCS  (const char *)
31221 #define CSS  (char **)
31222 #define US   (unsigned char *)
31223 #define CUS  (const unsigned char *)
31224 #define USS  (unsigned char **)
31225 .endd
31226 The function prototype for &[local_scan()]& is:
31227 .code
31228 extern int local_scan(int fd, uschar **return_text);
31229 .endd
31230 The arguments are as follows:
31231
31232 .ilist
31233 &%fd%& is a file descriptor for the file that contains the body of the message
31234 (the -D file). The file is open for reading and writing, but updating it is not
31235 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31236
31237 The descriptor is positioned at character 19 of the file, which is the first
31238 character of the body itself, because the first 19 characters are the message
31239 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31240 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31241 case this changes in some future version.
31242 .next
31243 &%return_text%& is an address which you can use to return a pointer to a text
31244 string at the end of the function. The value it points to on entry is NULL.
31245 .endlist
31246
31247 The function must return an &%int%& value which is one of the following macros:
31248
31249 .vlist
31250 .vitem &`LOCAL_SCAN_ACCEPT`&
31251 .vindex "&$local_scan_data$&"
31252 The message is accepted. If you pass back a string of text, it is saved with
31253 the message, and made available in the variable &$local_scan_data$&. No
31254 newlines are permitted (if there are any, they are turned into spaces) and the
31255 maximum length of text is 1000 characters.
31256
31257 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31258 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31259 queued without immediate delivery, and is frozen.
31260
31261 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31262 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31263 queued without immediate delivery.
31264
31265 .vitem &`LOCAL_SCAN_REJECT`&
31266 The message is rejected; the returned text is used as an error message which is
31267 passed back to the sender and which is also logged. Newlines are permitted &--
31268 they cause a multiline response for SMTP rejections, but are converted to
31269 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31270 used.
31271
31272 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31273 The message is temporarily rejected; the returned text is used as an error
31274 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31275 problem"& is used.
31276
31277 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31278 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31279 message is not written to the reject log. It has the effect of unsetting the
31280 &%rejected_header%& log selector for just this rejection. If
31281 &%rejected_header%& is already unset (see the discussion of the
31282 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31283 same as LOCAL_SCAN_REJECT.
31284
31285 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31286 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31287 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31288 .endlist
31289
31290 If the message is not being received by interactive SMTP, rejections are
31291 reported by writing to &%stderr%& or by sending an email, as configured by the
31292 &%-oe%& command line options.
31293
31294
31295
31296 .section "Configuration options for local_scan()" "SECTconoptloc"
31297 .cindex "&[local_scan()]& function" "configuration options"
31298 It is possible to have option settings in the main configuration file
31299 that set values in static variables in the &[local_scan()]& module. If you
31300 want to do this, you must have the line
31301 .code
31302 LOCAL_SCAN_HAS_OPTIONS=yes
31303 .endd
31304 in your &_Local/Makefile_& when you build Exim. (This line is in
31305 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31306 file, you must define static variables to hold the option values, and a table
31307 to define them.
31308
31309 The table must be a vector called &%local_scan_options%&, of type
31310 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31311 and a pointer to the variable that holds the value. The entries must appear in
31312 alphabetical order. Following &%local_scan_options%& you must also define a
31313 variable called &%local_scan_options_count%& that contains the number of
31314 entries in the table. Here is a short example, showing two kinds of option:
31315 .code
31316 static int my_integer_option = 42;
31317 static uschar *my_string_option = US"a default string";
31318
31319 optionlist local_scan_options[] = {
31320   { "my_integer", opt_int,       &my_integer_option },
31321   { "my_string",  opt_stringptr, &my_string_option }
31322 };
31323
31324 int local_scan_options_count =
31325   sizeof(local_scan_options)/sizeof(optionlist);
31326 .endd
31327 The values of the variables can now be changed from Exim's runtime
31328 configuration file by including a local scan section as in this example:
31329 .code
31330 begin local_scan
31331 my_integer = 99
31332 my_string = some string of text...
31333 .endd
31334 The available types of option data are as follows:
31335
31336 .vlist
31337 .vitem &*opt_bool*&
31338 This specifies a boolean (true/false) option. The address should point to a
31339 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31340 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31341 whether such a variable has been set at all, you can initialize it to
31342 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31343 values.)
31344
31345 .vitem &*opt_fixed*&
31346 This specifies a fixed point number, such as is used for load averages.
31347 The address should point to a variable of type &`int`&. The value is stored
31348 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31349
31350 .vitem &*opt_int*&
31351 This specifies an integer; the address should point to a variable of type
31352 &`int`&. The value may be specified in any of the integer formats accepted by
31353 Exim.
31354
31355 .vitem &*opt_mkint*&
31356 This is the same as &%opt_int%&, except that when such a value is output in a
31357 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31358 printed with the suffix K or M.
31359
31360 .vitem &*opt_octint*&
31361 This also specifies an integer, but the value is always interpreted as an
31362 octal integer, whether or not it starts with the digit zero, and it is
31363 always output in octal.
31364
31365 .vitem &*opt_stringptr*&
31366 This specifies a string value; the address must be a pointer to a
31367 variable that points to a string (for example, of type &`uschar *`&).
31368
31369 .vitem &*opt_time*&
31370 This specifies a time interval value. The address must point to a variable of
31371 type &`int`&. The value that is placed there is a number of seconds.
31372 .endlist
31373
31374 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31375 out the values of all the &[local_scan()]& options.
31376
31377
31378
31379 .section "Available Exim variables" "SECID208"
31380 .cindex "&[local_scan()]& function" "available Exim variables"
31381 The header &_local_scan.h_& gives you access to a number of C variables. These
31382 are the only ones that are guaranteed to be maintained from release to release.
31383 Note, however, that you can obtain the value of any Exim expansion variable,
31384 including &$recipients$&, by calling &'expand_string()'&. The exported
31385 C variables are as follows:
31386
31387 .vlist
31388 .vitem &*int&~body_linecount*&
31389 This variable contains the number of lines in the message's body.
31390
31391 .vitem &*int&~body_zerocount*&
31392 This variable contains the number of binary zero bytes in the message's body.
31393
31394 .vitem &*unsigned&~int&~debug_selector*&
31395 This variable is set to zero when no debugging is taking place. Otherwise, it
31396 is a bitmap of debugging selectors. Two bits are identified for use in
31397 &[local_scan()]&; they are defined as macros:
31398
31399 .ilist
31400 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31401 testing option that is not privileged &-- any caller may set it. All the
31402 other selector bits can be set only by admin users.
31403
31404 .next
31405 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31406 by the &`+local_scan`& debug selector. It is not included in the default set
31407 of debugging bits.
31408 .endlist ilist
31409
31410 Thus, to write to the debugging output only when &`+local_scan`& has been
31411 selected, you should use code like this:
31412 .code
31413 if ((debug_selector & D_local_scan) != 0)
31414   debug_printf("xxx", ...);
31415 .endd
31416 .vitem &*uschar&~*expand_string_message*&
31417 After a failing call to &'expand_string()'& (returned value NULL), the
31418 variable &%expand_string_message%& contains the error message, zero-terminated.
31419
31420 .vitem &*header_line&~*header_list*&
31421 A pointer to a chain of header lines. The &%header_line%& structure is
31422 discussed below.
31423
31424 .vitem &*header_line&~*header_last*&
31425 A pointer to the last of the header lines.
31426
31427 .vitem &*uschar&~*headers_charset*&
31428 The value of the &%headers_charset%& configuration option.
31429
31430 .vitem &*BOOL&~host_checking*&
31431 This variable is TRUE during a host checking session that is initiated by the
31432 &%-bh%& command line option.
31433
31434 .vitem &*uschar&~*interface_address*&
31435 The IP address of the interface that received the message, as a string. This
31436 is NULL for locally submitted messages.
31437
31438 .vitem &*int&~interface_port*&
31439 The port on which this message was received. When testing with the &%-bh%&
31440 command line option, the value of this variable is -1 unless a port has been
31441 specified via the &%-oMi%& option.
31442
31443 .vitem &*uschar&~*message_id*&
31444 This variable contains Exim's message id for the incoming message (the value of
31445 &$message_exim_id$&) as a zero-terminated string.
31446
31447 .vitem &*uschar&~*received_protocol*&
31448 The name of the protocol by which the message was received.
31449
31450 .vitem &*int&~recipients_count*&
31451 The number of accepted recipients.
31452
31453 .vitem &*recipient_item&~*recipients_list*&
31454 .cindex "recipient" "adding in local scan"
31455 .cindex "recipient" "removing in local scan"
31456 The list of accepted recipients, held in a vector of length
31457 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31458 can add additional recipients by calling &'receive_add_recipient()'& (see
31459 below). You can delete recipients by removing them from the vector and
31460 adjusting the value in &%recipients_count%&. In particular, by setting
31461 &%recipients_count%& to zero you remove all recipients. If you then return the
31462 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31463 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31464 and then call &'receive_add_recipient()'& as often as needed.
31465
31466 .vitem &*uschar&~*sender_address*&
31467 The envelope sender address. For bounce messages this is the empty string.
31468
31469 .vitem &*uschar&~*sender_host_address*&
31470 The IP address of the sending host, as a string. This is NULL for
31471 locally-submitted messages.
31472
31473 .vitem &*uschar&~*sender_host_authenticated*&
31474 The name of the authentication mechanism that was used, or NULL if the message
31475 was not received over an authenticated SMTP connection.
31476
31477 .vitem &*uschar&~*sender_host_name*&
31478 The name of the sending host, if known.
31479
31480 .vitem &*int&~sender_host_port*&
31481 The port on the sending host.
31482
31483 .vitem &*BOOL&~smtp_input*&
31484 This variable is TRUE for all SMTP input, including BSMTP.
31485
31486 .vitem &*BOOL&~smtp_batched_input*&
31487 This variable is TRUE for BSMTP input.
31488
31489 .vitem &*int&~store_pool*&
31490 The contents of this variable control which pool of memory is used for new
31491 requests. See section &<<SECTmemhanloc>>& for details.
31492 .endlist
31493
31494
31495 .section "Structure of header lines" "SECID209"
31496 The &%header_line%& structure contains the members listed below.
31497 You can add additional header lines by calling the &'header_add()'& function
31498 (see below). You can cause header lines to be ignored (deleted) by setting
31499 their type to *.
31500
31501
31502 .vlist
31503 .vitem &*struct&~header_line&~*next*&
31504 A pointer to the next header line, or NULL for the last line.
31505
31506 .vitem &*int&~type*&
31507 A code identifying certain headers that Exim recognizes. The codes are printing
31508 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31509 Notice in particular that any header line whose type is * is not transmitted
31510 with the message. This flagging is used for header lines that have been
31511 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31512 lines.) Effectively, * means &"deleted"&.
31513
31514 .vitem &*int&~slen*&
31515 The number of characters in the header line, including the terminating and any
31516 internal newlines.
31517
31518 .vitem &*uschar&~*text*&
31519 A pointer to the text of the header. It always ends with a newline, followed by
31520 a zero byte. Internal newlines are preserved.
31521 .endlist
31522
31523
31524
31525 .section "Structure of recipient items" "SECID210"
31526 The &%recipient_item%& structure contains these members:
31527
31528 .vlist
31529 .vitem &*uschar&~*address*&
31530 This is a pointer to the recipient address as it was received.
31531
31532 .vitem &*int&~pno*&
31533 This is used in later Exim processing when top level addresses are created by
31534 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31535 and must always contain -1 at this stage.
31536
31537 .vitem &*uschar&~*errors_to*&
31538 If this value is not NULL, bounce messages caused by failing to deliver to the
31539 recipient are sent to the address it contains. In other words, it overrides the
31540 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31541 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31542 an unqualified address, Exim qualifies it using the domain from
31543 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31544 is NULL for all recipients.
31545 .endlist
31546
31547
31548
31549 .section "Available Exim functions" "SECID211"
31550 .cindex "&[local_scan()]& function" "available Exim functions"
31551 The header &_local_scan.h_& gives you access to a number of Exim functions.
31552 These are the only ones that are guaranteed to be maintained from release to
31553 release:
31554
31555 .vlist
31556 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31557        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31558
31559 This function creates a child process that runs the command specified by
31560 &%argv%&. The environment for the process is specified by &%envp%&, which can
31561 be NULL if no environment variables are to be passed. A new umask is supplied
31562 for the process in &%newumask%&.
31563
31564 Pipes to the standard input and output of the new process are set up
31565 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31566 standard error is cloned to the standard output. If there are any file
31567 descriptors &"in the way"& in the new process, they are closed. If the final
31568 argument is TRUE, the new process is made into a process group leader.
31569
31570 The function returns the pid of the new process, or -1 if things go wrong.
31571
31572 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31573 This function waits for a child process to terminate, or for a timeout (in
31574 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31575 return value is as follows:
31576
31577 .ilist
31578 >= 0
31579
31580 The process terminated by a normal exit and the value is the process
31581 ending status.
31582
31583 .next
31584 < 0 and > &--256
31585
31586 The process was terminated by a signal and the value is the negation of the
31587 signal number.
31588
31589 .next
31590 &--256
31591
31592 The process timed out.
31593 .next
31594 &--257
31595
31596 The was some other error in wait(); &%errno%& is still set.
31597 .endlist
31598
31599 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31600 This function provide you with a means of submitting a new message to
31601 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31602 want, but this packages it all up for you.) The function creates a pipe,
31603 forks a subprocess that is running
31604 .code
31605 exim -t -oem -oi -f <>
31606 .endd
31607 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31608 that is connected to the standard input. The yield of the function is the PID
31609 of the subprocess. You can then write a message to the file descriptor, with
31610 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31611
31612 When you have finished, call &'child_close()'& to wait for the process to
31613 finish and to collect its ending status. A timeout value of zero is usually
31614 fine in this circumstance. Unless you have made a mistake with the recipient
31615 addresses, you should get a return code of zero.
31616
31617
31618 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31619        *sender_authentication)*&
31620 This function is a more sophisticated version of &'child_open()'&. The command
31621 that it runs is:
31622 .display
31623 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31624 .endd
31625 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31626
31627
31628 .vitem &*void&~debug_printf(char&~*,&~...)*&
31629 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31630 output is written to the standard error stream. If no debugging is selected,
31631 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31632 conditional on the &`local_scan`& debug selector by coding like this:
31633 .code
31634 if ((debug_selector & D_local_scan) != 0)
31635   debug_printf("xxx", ...);
31636 .endd
31637
31638 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31639 This is an interface to Exim's string expansion code. The return value is the
31640 expanded string, or NULL if there was an expansion failure.
31641 The C variable &%expand_string_message%& contains an error message after an
31642 expansion failure. If expansion does not change the string, the return value is
31643 the pointer to the input string. Otherwise, the return value points to a new
31644 block of memory that was obtained by a call to &'store_get()'&. See section
31645 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31646
31647 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31648 This function allows you to an add additional header line at the end of the
31649 existing ones. The first argument is the type, and should normally be a space
31650 character. The second argument is a format string and any number of
31651 substitution arguments as for &[sprintf()]&. You may include internal newlines
31652 if you want, and you must ensure that the string ends with a newline.
31653
31654 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31655         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31656 This function adds a new header line at a specified point in the header
31657 chain. The header itself is specified as for &'header_add()'&.
31658
31659 If &%name%& is NULL, the new header is added at the end of the chain if
31660 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31661 NULL, the header lines are searched for the first non-deleted header that
31662 matches the name. If one is found, the new header is added before it if
31663 &%after%& is false. If &%after%& is true, the new header is added after the
31664 found header and any adjacent subsequent ones with the same name (even if
31665 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31666 option controls where the header is added. If it is true, addition is at the
31667 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31668 headers, or at the top if there are no &'Received:'& headers, you could use
31669 .code
31670 header_add_at_position(TRUE, US"Received", TRUE,
31671   ' ', "X-xxx: ...");
31672 .endd
31673 Normally, there is always at least one non-deleted &'Received:'& header, but
31674 there may not be if &%received_header_text%& expands to an empty string.
31675
31676
31677 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31678 This function removes header lines. If &%occurrence%& is zero or negative, all
31679 occurrences of the header are removed. If occurrence is greater than zero, that
31680 particular instance of the header is removed. If no header(s) can be found that
31681 match the specification, the function does nothing.
31682
31683
31684 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31685         int&~length,&~BOOL&~notdel)*&"
31686 This function tests whether the given header has the given name. It is not just
31687 a string comparison, because white space is permitted between the name and the
31688 colon. If the &%notdel%& argument is true, a false return is forced for all
31689 &"deleted"& headers; otherwise they are not treated specially. For example:
31690 .code
31691 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31692 .endd
31693 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31694 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31695 This function base64-encodes a string, which is passed by address and length.
31696 The text may contain bytes of any value, including zero. The result is passed
31697 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31698 zero-terminated.
31699
31700 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31701 This function decodes a base64-encoded string. Its arguments are a
31702 zero-terminated base64-encoded string and the address of a variable that is set
31703 to point to the result, which is in dynamic memory. The length of the decoded
31704 string is the yield of the function. If the input is invalid base64 data, the
31705 yield is -1. A zero byte is added to the end of the output string to make it
31706 easy to interpret as a C string (assuming it contains no zeros of its own). The
31707 added zero byte is not included in the returned count.
31708
31709 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31710 This function checks for a match in a domain list. Domains are always
31711 matched caselessly. The return value is one of the following:
31712 .display
31713 &`OK     `& match succeeded
31714 &`FAIL   `& match failed
31715 &`DEFER  `& match deferred
31716 .endd
31717 DEFER is usually caused by some kind of lookup defer, such as the
31718 inability to contact a database.
31719
31720 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31721         BOOL&~caseless)*&"
31722 This function checks for a match in a local part list. The third argument
31723 controls case-sensitivity. The return values are as for
31724 &'lss_match_domain()'&.
31725
31726 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31727         BOOL&~caseless)*&"
31728 This function checks for a match in an address list. The third argument
31729 controls the case-sensitivity of the local part match. The domain is always
31730 matched caselessly. The return values are as for &'lss_match_domain()'&.
31731
31732 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31733         uschar&~*list)*&"
31734 This function checks for a match in a host list. The most common usage is
31735 expected to be
31736 .code
31737 lss_match_host(sender_host_name, sender_host_address, ...)
31738 .endd
31739 .vindex "&$sender_host_address$&"
31740 An empty address field matches an empty item in the host list. If the host name
31741 is NULL, the name corresponding to &$sender_host_address$& is automatically
31742 looked up if a host name is required to match an item in the list. The return
31743 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31744 returns ERROR in the case when it had to look up a host name, but the lookup
31745 failed.
31746
31747 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31748         *format,&~...)*&"
31749 This function writes to Exim's log files. The first argument should be zero (it
31750 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31751 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31752 them. It specifies to which log or logs the message is written. The remaining
31753 arguments are a format and relevant insertion arguments. The string should not
31754 contain any newlines, not even at the end.
31755
31756
31757 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31758 This function adds an additional recipient to the message. The first argument
31759 is the recipient address. If it is unqualified (has no domain), it is qualified
31760 with the &%qualify_recipient%& domain. The second argument must always be -1.
31761
31762 This function does not allow you to specify a private &%errors_to%& address (as
31763 described with the structure of &%recipient_item%& above), because it pre-dates
31764 the addition of that field to the structure. However, it is easy to add such a
31765 value afterwards. For example:
31766 .code
31767  receive_add_recipient(US"monitor@mydom.example", -1);
31768  recipients_list[recipients_count-1].errors_to =
31769    US"postmaster@mydom.example";
31770 .endd
31771
31772 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31773 This is a convenience function to remove a named recipient from the list of
31774 recipients. It returns true if a recipient was removed, and false if no
31775 matching recipient could be found. The argument must be a complete email
31776 address.
31777 .endlist
31778
31779
31780 .cindex "RFC 2047"
31781 .vlist
31782 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31783   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31784 This function decodes strings that are encoded according to RFC 2047. Typically
31785 these are the contents of header lines. First, each &"encoded word"& is decoded
31786 from the Q or B encoding into a byte-string. Then, if provided with the name of
31787 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31788 made  to translate the result to the named character set. If this fails, the
31789 binary string is returned with an error message.
31790
31791 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31792 maximum MIME word length is enforced. The third argument is the target
31793 encoding, or NULL if no translation is wanted.
31794
31795 .cindex "binary zero" "in RFC 2047 decoding"
31796 .cindex "RFC 2047" "binary zero in"
31797 If a binary zero is encountered in the decoded string, it is replaced by the
31798 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31799 not be 0 because header lines are handled as zero-terminated strings.
31800
31801 The function returns the result of processing the string, zero-terminated; if
31802 &%lenptr%& is not NULL, the length of the result is set in the variable to
31803 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31804
31805 If an error is encountered, the function returns NULL and uses the &%error%&
31806 argument to return an error message. The variable pointed to by &%error%& is
31807 set to NULL if there is no error; it may be set non-NULL even when the function
31808 returns a non-NULL value if decoding was successful, but there was a problem
31809 with translation.
31810
31811
31812 .vitem &*int&~smtp_fflush(void)*&
31813 This function is used in conjunction with &'smtp_printf()'&, as described
31814 below.
31815
31816 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31817 The arguments of this function are like &[printf()]&; it writes to the SMTP
31818 output stream. You should use this function only when there is an SMTP output
31819 stream, that is, when the incoming message is being received via interactive
31820 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31821 is FALSE. If you want to test for an incoming message from another host (as
31822 opposed to a local process that used the &%-bs%& command line option), you can
31823 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31824 is involved.
31825
31826 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31827 output function, so it can be used for all forms of SMTP connection.
31828
31829 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31830 must start with an appropriate response code: 550 if you are going to return
31831 LOCAL_SCAN_REJECT, 451 if you are going to return
31832 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31833 initial lines of a multi-line response, the code must be followed by a hyphen
31834 to indicate that the line is not the final response line. You must also ensure
31835 that the lines you write terminate with CRLF. For example:
31836 .code
31837 smtp_printf("550-this is some extra info\r\n");
31838 return LOCAL_SCAN_REJECT;
31839 .endd
31840 Note that you can also create multi-line responses by including newlines in
31841 the data returned via the &%return_text%& argument. The added value of using
31842 &'smtp_printf()'& is that, for instance, you could introduce delays between
31843 multiple output lines.
31844
31845 The &'smtp_printf()'& function does not return any error indication, because it
31846 does not automatically flush pending output, and therefore does not test
31847 the state of the stream. (In the main code of Exim, flushing and error
31848 detection is done when Exim is ready for the next SMTP input command.) If
31849 you want to flush the output and check for an error (for example, the
31850 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31851 arguments. It flushes the output stream, and returns a non-zero value if there
31852 is an error.
31853
31854 .vitem &*void&~*store_get(int)*&
31855 This function accesses Exim's internal store (memory) manager. It gets a new
31856 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31857 runs out of memory. See the next section for a discussion of memory handling.
31858
31859 .vitem &*void&~*store_get_perm(int)*&
31860 This function is like &'store_get()'&, but it always gets memory from the
31861 permanent pool. See the next section for a discussion of memory handling.
31862
31863 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31864 See below.
31865
31866 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31867 See below.
31868
31869 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31870 These three functions create strings using Exim's dynamic memory facilities.
31871 The first makes a copy of an entire string. The second copies up to a maximum
31872 number of characters, indicated by the second argument. The third uses a format
31873 and insertion arguments to create a new string. In each case, the result is a
31874 pointer to a new string in the current memory pool. See the next section for
31875 more discussion.
31876 .endlist
31877
31878
31879
31880 .section "More about Exim's memory handling" "SECTmemhanloc"
31881 .cindex "&[local_scan()]& function" "memory handling"
31882 No function is provided for freeing memory, because that is never needed.
31883 The dynamic memory that Exim uses when receiving a message is automatically
31884 recycled if another message is received by the same process (this applies only
31885 to incoming SMTP connections &-- other input methods can supply only one
31886 message at a time). After receiving the last message, a reception process
31887 terminates.
31888
31889 Because it is recycled, the normal dynamic memory cannot be used for holding
31890 data that must be preserved over a number of incoming messages on the same SMTP
31891 connection. However, Exim in fact uses two pools of dynamic memory; the second
31892 one is not recycled, and can be used for this purpose.
31893
31894 If you want to allocate memory that remains available for subsequent messages
31895 in the same SMTP connection, you should set
31896 .code
31897 store_pool = POOL_PERM
31898 .endd
31899 before calling the function that does the allocation. There is no need to
31900 restore the value if you do not need to; however, if you do want to revert to
31901 the normal pool, you can either restore the previous value of &%store_pool%& or
31902 set it explicitly to POOL_MAIN.
31903
31904 The pool setting applies to all functions that get dynamic memory, including
31905 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31906 There is also a convenience function called &'store_get_perm()'& that gets a
31907 block of memory from the permanent pool while preserving the value of
31908 &%store_pool%&.
31909 .ecindex IIDlosca
31910
31911
31912
31913
31914 . ////////////////////////////////////////////////////////////////////////////
31915 . ////////////////////////////////////////////////////////////////////////////
31916
31917 .chapter "System-wide message filtering" "CHAPsystemfilter"
31918 .scindex IIDsysfil1 "filter" "system filter"
31919 .scindex IIDsysfil2 "filtering all mail"
31920 .scindex IIDsysfil3 "system filter"
31921 The previous chapters (on ACLs and the local scan function) describe checks
31922 that can be applied to messages before they are accepted by a host. There is
31923 also a mechanism for checking messages once they have been received, but before
31924 they are delivered. This is called the &'system filter'&.
31925
31926 The system filter operates in a similar manner to users' filter files, but it
31927 is run just once per message (however many recipients the message has).
31928 It should not normally be used as a substitute for routing, because &%deliver%&
31929 commands in a system router provide new envelope recipient addresses.
31930 The system filter must be an Exim filter. It cannot be a Sieve filter.
31931
31932 The system filter is run at the start of a delivery attempt, before any routing
31933 is done. If a message fails to be completely delivered at the first attempt,
31934 the system filter is run again at the start of every retry.
31935 If you want your filter to do something only once per message, you can make use
31936 of the &%first_delivery%& condition in an &%if%& command in the filter to
31937 prevent it happening on retries.
31938
31939 .vindex "&$domain$&"
31940 .vindex "&$local_part$&"
31941 &*Warning*&: Because the system filter runs just once, variables that are
31942 specific to individual recipient addresses, such as &$local_part$& and
31943 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31944 you want to run a centrally-specified filter for each recipient address
31945 independently, you can do so by setting up a suitable &(redirect)& router, as
31946 described in section &<<SECTperaddfil>>& below.
31947
31948
31949 .section "Specifying a system filter" "SECID212"
31950 .cindex "uid (user id)" "system filter"
31951 .cindex "gid (group id)" "system filter"
31952 The name of the file that contains the system filter must be specified by
31953 setting &%system_filter%&. If you want the filter to run under a uid and gid
31954 other than root, you must also set &%system_filter_user%& and
31955 &%system_filter_group%& as appropriate. For example:
31956 .code
31957 system_filter = /etc/mail/exim.filter
31958 system_filter_user = exim
31959 .endd
31960 If a system filter generates any deliveries directly to files or pipes (via the
31961 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31962 specified by setting &%system_filter_file_transport%& and
31963 &%system_filter_pipe_transport%&, respectively. Similarly,
31964 &%system_filter_reply_transport%& must be set to handle any messages generated
31965 by the &%reply%& command.
31966
31967
31968 .section "Testing a system filter" "SECID213"
31969 You can run simple tests of a system filter in the same way as for a user
31970 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31971 are permitted only in system filters are recognized.
31972
31973 If you want to test the combined effect of a system filter and a user filter,
31974 you can use both &%-bF%& and &%-bf%& on the same command line.
31975
31976
31977
31978 .section "Contents of a system filter" "SECID214"
31979 The language used to specify system filters is the same as for users' filter
31980 files. It is described in the separate end-user document &'Exim's interface to
31981 mail filtering'&. However, there are some additional features that are
31982 available only in system filters; these are described in subsequent sections.
31983 If they are encountered in a user's filter file or when testing with &%-bf%&,
31984 they cause errors.
31985
31986 .cindex "frozen messages" "manual thaw; testing in filter"
31987 There are two special conditions which, though available in users' filter
31988 files, are designed for use in system filters. The condition &%first_delivery%&
31989 is true only for the first attempt at delivering a message, and
31990 &%manually_thawed%& is true only if the message has been frozen, and
31991 subsequently thawed by an admin user. An explicit forced delivery counts as a
31992 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31993
31994 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31995 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31996 succeed, it will not be tried again.
31997 If you want Exim to retry an unseen delivery until it succeeds, you should
31998 arrange to set it up every time the filter runs.
31999
32000 When a system filter finishes running, the values of the variables &$n0$& &--
32001 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32002 users' filter files. Thus a system filter can, for example, set up &"scores"&
32003 to which users' filter files can refer.
32004
32005
32006
32007 .section "Additional variable for system filters" "SECID215"
32008 .vindex "&$recipients$&"
32009 The expansion variable &$recipients$&, containing a list of all the recipients
32010 of the message (separated by commas and white space), is available in system
32011 filters. It is not available in users' filters for privacy reasons.
32012
32013
32014
32015 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32016 .cindex "freezing messages"
32017 .cindex "message" "freezing"
32018 .cindex "message" "forced failure"
32019 .cindex "&%fail%&" "in system filter"
32020 .cindex "&%freeze%& in system filter"
32021 .cindex "&%defer%& in system filter"
32022 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32023 always available in system filters, but are not normally enabled in users'
32024 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32025 for the &(redirect)& router.) These commands can optionally be followed by the
32026 word &%text%& and a string containing an error message, for example:
32027 .code
32028 fail text "this message looks like spam to me"
32029 .endd
32030 The keyword &%text%& is optional if the next character is a double quote.
32031
32032 The &%defer%& command defers delivery of the original recipients of the
32033 message. The &%fail%& command causes all the original recipients to be failed,
32034 and a bounce message to be created. The &%freeze%& command suspends all
32035 delivery attempts for the original recipients. In all cases, any new deliveries
32036 that are specified by the filter are attempted as normal after the filter has
32037 run.
32038
32039 The &%freeze%& command is ignored if the message has been manually unfrozen and
32040 not manually frozen since. This means that automatic freezing by a system
32041 filter can be used as a way of checking out suspicious messages. If a message
32042 is found to be all right, manually unfreezing it allows it to be delivered.
32043
32044 .cindex "log" "&%fail%& command log line"
32045 .cindex "&%fail%&" "log line; reducing"
32046 The text given with a fail command is used as part of the bounce message as
32047 well as being written to the log. If the message is quite long, this can fill
32048 up a lot of log space when such failures are common. To reduce the size of the
32049 log message, Exim interprets the text in a special way if it starts with the
32050 two characters &`<<`& and contains &`>>`& later. The text between these two
32051 strings is written to the log, and the rest of the text is used in the bounce
32052 message. For example:
32053 .code
32054 fail "<<filter test 1>>Your message is rejected \
32055      because it contains attachments that we are \
32056      not prepared to receive."
32057 .endd
32058
32059 .cindex "loop" "caused by &%fail%&"
32060 Take great care with the &%fail%& command when basing the decision to fail on
32061 the contents of the message, because the bounce message will of course include
32062 the contents of the original message and will therefore trigger the &%fail%&
32063 command again (causing a mail loop) unless steps are taken to prevent this.
32064 Testing the &%error_message%& condition is one way to prevent this. You could
32065 use, for example
32066 .code
32067 if $message_body contains "this is spam" and not error_message
32068 then fail text "spam is not wanted here" endif
32069 .endd
32070 though of course that might let through unwanted bounce messages. The
32071 alternative is clever checking of the body and/or headers to detect bounces
32072 generated by the filter.
32073
32074 The interpretation of a system filter file ceases after a
32075 &%defer%&,
32076 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32077 set up earlier in the filter file are honoured, so you can use a sequence such
32078 as
32079 .code
32080 mail ...
32081 freeze
32082 .endd
32083 to send a specified message when the system filter is freezing (or deferring or
32084 failing) a message. The normal deliveries for the message do not, of course,
32085 take place.
32086
32087
32088
32089 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32090 .cindex "header lines" "adding; in system filter"
32091 .cindex "header lines" "removing; in system filter"
32092 .cindex "filter" "header lines; adding/removing"
32093 Two filter commands that are available only in system filters are:
32094 .code
32095 headers add <string>
32096 headers remove <string>
32097 .endd
32098 The argument for the &%headers add%& is a string that is expanded and then
32099 added to the end of the message's headers. It is the responsibility of the
32100 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32101 space is ignored, and if the string is otherwise empty, or if the expansion is
32102 forced to fail, the command has no effect.
32103
32104 You can use &"\n"& within the string, followed by white space, to specify
32105 continued header lines. More than one header may be added in one command by
32106 including &"\n"& within the string without any following white space. For
32107 example:
32108 .code
32109 headers add "X-header-1: ....\n  \
32110              continuation of X-header-1 ...\n\
32111              X-header-2: ...."
32112 .endd
32113 Note that the header line continuation white space after the first newline must
32114 be placed before the backslash that continues the input string, because white
32115 space after input continuations is ignored.
32116
32117 The argument for &%headers remove%& is a colon-separated list of header names.
32118 This command applies only to those headers that are stored with the message;
32119 those that are added at delivery time (such as &'Envelope-To:'& and
32120 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32121 header with the same name, they are all removed.
32122
32123 The &%headers%& command in a system filter makes an immediate change to the set
32124 of header lines that was received with the message (with possible additions
32125 from ACL processing). Subsequent commands in the system filter operate on the
32126 modified set, which also forms the basis for subsequent message delivery.
32127 Unless further modified during routing or transporting, this set of headers is
32128 used for all recipients of the message.
32129
32130 During routing and transporting, the variables that refer to the contents of
32131 header lines refer only to those lines that are in this set. Thus, header lines
32132 that are added by a system filter are visible to users' filter files and to all
32133 routers and transports. This contrasts with the manipulation of header lines by
32134 routers and transports, which is not immediate, but which instead is saved up
32135 until the message is actually being written (see section
32136 &<<SECTheadersaddrem>>&).
32137
32138 If the message is not delivered at the first attempt, header lines that were
32139 added by the system filter are stored with the message, and so are still
32140 present at the next delivery attempt. Header lines that were removed are still
32141 present, but marked &"deleted"& so that they are not transported with the
32142 message. For this reason, it is usual to make the &%headers%& command
32143 conditional on &%first_delivery%& so that the set of header lines is not
32144 modified more than once.
32145
32146 Because header modification in a system filter acts immediately, you have to
32147 use an indirect approach if you want to modify the contents of a header line.
32148 For example:
32149 .code
32150 headers add "Old-Subject: $h_subject:"
32151 headers remove "Subject"
32152 headers add "Subject: new subject (was: $h_old-subject:)"
32153 headers remove "Old-Subject"
32154 .endd
32155
32156
32157
32158 .section "Setting an errors address in a system filter" "SECID217"
32159 .cindex "envelope sender"
32160 In a system filter, if a &%deliver%& command is followed by
32161 .code
32162 errors_to <some address>
32163 .endd
32164 in order to change the envelope sender (and hence the error reporting) for that
32165 delivery, any address may be specified. (In a user filter, only the current
32166 user's address can be set.) For example, if some mail is being monitored, you
32167 might use
32168 .code
32169 unseen deliver monitor@spying.example errors_to root@local.example
32170 .endd
32171 to take a copy which would not be sent back to the normal error reporting
32172 address if its delivery failed.
32173
32174
32175
32176 .section "Per-address filtering" "SECTperaddfil"
32177 .vindex "&$domain$&"
32178 .vindex "&$local_part$&"
32179 In contrast to the system filter, which is run just once per message for each
32180 delivery attempt, it is also possible to set up a system-wide filtering
32181 operation that runs once for each recipient address. In this case, variables
32182 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32183 filter file could be made dependent on them. This is an example of a router
32184 which implements such a filter:
32185 .code
32186 central_filter:
32187   check_local_user
32188   driver = redirect
32189   domains = +local_domains
32190   file = /central/filters/$local_part
32191   no_verify
32192   allow_filter
32193   allow_freeze
32194 .endd
32195 The filter is run in a separate process under its own uid. Therefore, either
32196 &%check_local_user%& must be set (as above), in which case the filter is run as
32197 the local user, or the &%user%& option must be used to specify which user to
32198 use. If both are set, &%user%& overrides.
32199
32200 Care should be taken to ensure that none of the commands in the filter file
32201 specify a significant delivery if the message is to go on to be delivered to
32202 its intended recipient. The router will not then claim to have dealt with the
32203 address, so it will be passed on to subsequent routers to be delivered in the
32204 normal way.
32205 .ecindex IIDsysfil1
32206 .ecindex IIDsysfil2
32207 .ecindex IIDsysfil3
32208
32209
32210
32211
32212
32213
32214 . ////////////////////////////////////////////////////////////////////////////
32215 . ////////////////////////////////////////////////////////////////////////////
32216
32217 .chapter "Message processing" "CHAPmsgproc"
32218 .scindex IIDmesproc "message" "general processing"
32219 Exim performs various transformations on the sender and recipient addresses of
32220 all messages that it handles, and also on the messages' header lines. Some of
32221 these are optional and configurable, while others always take place. All of
32222 this processing, except rewriting as a result of routing, and the addition or
32223 removal of header lines while delivering, happens when a message is received,
32224 before it is placed on Exim's queue.
32225
32226 Some of the automatic processing takes place by default only for
32227 &"locally-originated"& messages. This adjective is used to describe messages
32228 that are not received over TCP/IP, but instead are passed to an Exim process on
32229 its standard input. This includes the interactive &"local SMTP"& case that is
32230 set up by the &%-bs%& command line option.
32231
32232 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32233 or ::1) are not considered to be locally-originated. Exim does not treat the
32234 loopback interface specially in any way.
32235
32236 If you want the loopback interface to be treated specially, you must ensure
32237 that there are appropriate entries in your ACLs.
32238
32239
32240
32241
32242 .section "Submission mode for non-local messages" "SECTsubmodnon"
32243 .cindex "message" "submission"
32244 .cindex "submission mode"
32245 Processing that happens automatically for locally-originated messages (unless
32246 &%suppress_local_fixups%& is set) can also be requested for messages that are
32247 received over TCP/IP. The term &"submission mode"& is used to describe this
32248 state. Submission mode is set by the modifier
32249 .code
32250 control = submission
32251 .endd
32252 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32253 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32254 a local submission, and is normally used when the source of the message is
32255 known to be an MUA running on a client host (as opposed to an MTA). For
32256 example, to set submission mode for messages originating on the IPv4 loopback
32257 interface, you could include the following in the MAIL ACL:
32258 .code
32259 warn  hosts = 127.0.0.1
32260       control = submission
32261 .endd
32262 .cindex "&%sender_retain%& submission option"
32263 There are some options that can be used when setting submission mode. A slash
32264 is used to separate options. For example:
32265 .code
32266 control = submission/sender_retain
32267 .endd
32268 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32269 true and &%local_from_check%& false for the current incoming message. The first
32270 of these allows an existing &'Sender:'& header in the message to remain, and
32271 the second suppresses the check to ensure that &'From:'& matches the
32272 authenticated sender. With this setting, Exim still fixes up messages by adding
32273 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32274 attempt to check sender authenticity in header lines.
32275
32276 When &%sender_retain%& is not set, a submission mode setting may specify a
32277 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32278 example:
32279 .code
32280 control = submission/domain=some.domain
32281 .endd
32282 The domain may be empty. How this value is used is described in sections
32283 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32284 that allows you to specify the user's full name for inclusion in a created
32285 &'Sender:'& or &'From:'& header line. For example:
32286 .code
32287 accept authenticated = *
32288        control = submission/domain=wonderland.example/\
32289                             name=${lookup {$authenticated_id} \
32290                                    lsearch {/etc/exim/namelist}}
32291 .endd
32292 Because the name may contain any characters, including slashes, the &%name%&
32293 option must be given last. The remainder of the string is used as the name. For
32294 the example above, if &_/etc/exim/namelist_& contains:
32295 .code
32296 bigegg:  Humpty Dumpty
32297 .endd
32298 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32299 line would be:
32300 .code
32301 Sender: Humpty Dumpty <bigegg@wonderland.example>
32302 .endd
32303 .cindex "return path" "in submission mode"
32304 By default, submission mode forces the return path to the same address as is
32305 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32306 specified, the return path is also left unchanged.
32307
32308 &*Note*&: The changes caused by submission mode take effect after the predata
32309 ACL. This means that any sender checks performed before the fix-ups use the
32310 untrusted sender address specified by the user, not the trusted sender address
32311 specified by submission mode. Although this might be slightly unexpected, it
32312 does mean that you can configure ACL checks to spot that a user is trying to
32313 spoof another's address.
32314
32315 .section "Line endings" "SECTlineendings"
32316 .cindex "line endings"
32317 .cindex "carriage return"
32318 .cindex "linefeed"
32319 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32320 linefeed) is the line ending for messages transmitted over the Internet using
32321 SMTP over TCP/IP. However, within individual operating systems, different
32322 conventions are used. For example, Unix-like systems use just LF, but others
32323 use CRLF or just CR.
32324
32325 Exim was designed for Unix-like systems, and internally, it stores messages
32326 using the system's convention of a single LF as a line terminator. When
32327 receiving a message, all line endings are translated to this standard format.
32328 Originally, it was thought that programs that passed messages directly to an
32329 MTA within an operating system would use that system's convention. Experience
32330 has shown that this is not the case; for example, there are Unix applications
32331 that use CRLF in this circumstance. For this reason, and for compatibility with
32332 other MTAs, the way Exim handles line endings for all messages is now as
32333 follows:
32334
32335 .ilist
32336 LF not preceded by CR is treated as a line ending.
32337 .next
32338 CR is treated as a line ending; if it is immediately followed by LF, the LF
32339 is ignored.
32340 .next
32341 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32342 nor a local message in the state where a line containing only a dot is a
32343 terminator.
32344 .next
32345 If a bare CR is encountered within a header line, an extra space is added after
32346 the line terminator so as not to end the header line. The reasoning behind this
32347 is that bare CRs in header lines are most likely either to be mistakes, or
32348 people trying to play silly games.
32349 .next
32350 If the first header line received in a message ends with CRLF, a subsequent
32351 bare LF in a header line is treated in the same way as a bare CR in a header
32352 line.
32353 .endlist
32354
32355
32356
32357
32358
32359 .section "Unqualified addresses" "SECID218"
32360 .cindex "unqualified addresses"
32361 .cindex "address" "qualification"
32362 By default, Exim expects every envelope address it receives from an external
32363 host to be fully qualified. Unqualified addresses cause negative responses to
32364 SMTP commands. However, because SMTP is used as a means of transporting
32365 messages from MUAs running on personal workstations, there is sometimes a
32366 requirement to accept unqualified addresses from specific hosts or IP networks.
32367
32368 Exim has two options that separately control which hosts may send unqualified
32369 sender or recipient addresses in SMTP commands, namely
32370 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32371 cases, if an unqualified address is accepted, it is qualified by adding the
32372 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32373
32374 .oindex "&%qualify_domain%&"
32375 .oindex "&%qualify_recipient%&"
32376 Unqualified addresses in header lines are automatically qualified for messages
32377 that are locally originated, unless the &%-bnq%& option is given on the command
32378 line. For messages received over SMTP, unqualified addresses in header lines
32379 are qualified only if unqualified addresses are permitted in SMTP commands. In
32380 other words, such qualification is also controlled by
32381 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32382
32383
32384
32385
32386 .section "The UUCP From line" "SECID219"
32387 .cindex "&""From""& line"
32388 .cindex "UUCP" "&""From""& line"
32389 .cindex "sender" "address"
32390 .oindex "&%uucp_from_pattern%&"
32391 .oindex "&%uucp_from_sender%&"
32392 .cindex "envelope sender"
32393 .cindex "Sendmail compatibility" "&""From""& line"
32394 Messages that have come from UUCP (and some other applications) often begin
32395 with a line containing the envelope sender and a timestamp, following the word
32396 &"From"&. Examples of two common formats are:
32397 .code
32398 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32399 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32400 .endd
32401 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32402 Exim recognizes such lines at the start of messages that are submitted to it
32403 via the command line (that is, on the standard input). It does not recognize
32404 such lines in incoming SMTP messages, unless the sending host matches
32405 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32406 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32407 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32408 default value matches the two common cases shown above and puts the address
32409 that follows &"From"& into &$1$&.
32410
32411 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32412 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32413 a trusted user, the message's sender address is constructed by expanding the
32414 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32415 then parsed as an RFC 2822 address. If there is no domain, the local part is
32416 qualified with &%qualify_domain%& unless it is the empty string. However, if
32417 the command line &%-f%& option is used, it overrides the &"From"& line.
32418
32419 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32420 sender address is not changed. This is also the case for incoming SMTP messages
32421 that are permitted to contain &"From"& lines.
32422
32423 Only one &"From"& line is recognized. If there is more than one, the second is
32424 treated as a data line that starts the body of the message, as it is not valid
32425 as a header line. This also happens if a &"From"& line is present in an
32426 incoming SMTP message from a source that is not permitted to send them.
32427
32428
32429
32430 .section "Resent- header lines" "SECID220"
32431 .cindex "&%Resent-%& header lines"
32432 RFC 2822 makes provision for sets of header lines starting with the string
32433 &`Resent-`& to be added to a message when it is resent by the original
32434 recipient to somebody else. These headers are &'Resent-Date:'&,
32435 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32436 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32437
32438 .blockquote
32439 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32440 processing of replies or other such automatic actions on messages.'&
32441 .endblockquote
32442
32443 This leaves things a bit vague as far as other processing actions such as
32444 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32445 follows:
32446
32447 .ilist
32448 A &'Resent-From:'& line that just contains the login id of the submitting user
32449 is automatically rewritten in the same way as &'From:'& (see below).
32450 .next
32451 If there's a rewriting rule for a particular header line, it is also applied to
32452 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32453 &'From:'& also rewrites &'Resent-From:'&.
32454 .next
32455 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32456 also removed.
32457 .next
32458 For a locally-submitted message,
32459 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32460 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32461 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32462 included in log lines in this case.
32463 .next
32464 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32465 &%Resent-%& header lines are present.
32466 .endlist
32467
32468
32469
32470
32471 .section "The Auto-Submitted: header line" "SECID221"
32472 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32473 includes the header line:
32474 .code
32475 Auto-Submitted: auto-replied
32476 .endd
32477
32478 .section "The Bcc: header line" "SECID222"
32479 .cindex "&'Bcc:'& header line"
32480 If Exim is called with the &%-t%& option, to take recipient addresses from a
32481 message's header, it removes any &'Bcc:'& header line that may exist (after
32482 extracting its addresses). If &%-t%& is not present on the command line, any
32483 existing &'Bcc:'& is not removed.
32484
32485
32486 .section "The Date: header line" "SECID223"
32487 .cindex "&'Date:'& header line"
32488 If a locally-generated or submission-mode message has no &'Date:'& header line,
32489 Exim adds one, using the current date and time, unless the
32490 &%suppress_local_fixups%& control has been specified.
32491
32492 .section "The Delivery-date: header line" "SECID224"
32493 .cindex "&'Delivery-date:'& header line"
32494 .oindex "&%delivery_date_remove%&"
32495 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32496 set. Exim can be configured to add them to the final delivery of messages. (See
32497 the generic &%delivery_date_add%& transport option.) They should not be present
32498 in messages in transit. If the &%delivery_date_remove%& configuration option is
32499 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32500 messages.
32501
32502
32503 .section "The Envelope-to: header line" "SECID225"
32504 .cindex "&'Envelope-to:'& header line"
32505 .oindex "&%envelope_to_remove%&"
32506 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32507 Exim can be configured to add them to the final delivery of messages. (See the
32508 generic &%envelope_to_add%& transport option.) They should not be present in
32509 messages in transit. If the &%envelope_to_remove%& configuration option is set
32510 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32511 messages.
32512
32513
32514 .section "The From: header line" "SECTthefrohea"
32515 .cindex "&'From:'& header line"
32516 .cindex "Sendmail compatibility" "&""From""& line"
32517 .cindex "message" "submission"
32518 .cindex "submission mode"
32519 If a submission-mode message does not contain a &'From:'& header line, Exim
32520 adds one if either of the following conditions is true:
32521
32522 .ilist
32523 The envelope sender address is not empty (that is, this is not a bounce
32524 message). The added header line copies the envelope sender address.
32525 .next
32526 .vindex "&$authenticated_id$&"
32527 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32528 .olist
32529 .vindex "&$qualify_domain$&"
32530 If no domain is specified by the submission control, the local part is
32531 &$authenticated_id$& and the domain is &$qualify_domain$&.
32532 .next
32533 If a non-empty domain is specified by the submission control, the local
32534 part is &$authenticated_id$&, and the domain is the specified domain.
32535 .next
32536 If an empty domain is specified by the submission control,
32537 &$authenticated_id$& is assumed to be the complete address.
32538 .endlist
32539 .endlist
32540
32541 A non-empty envelope sender takes precedence.
32542
32543 If a locally-generated incoming message does not contain a &'From:'& header
32544 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32545 containing the sender's address. The calling user's login name and full name
32546 are used to construct the address, as described in section &<<SECTconstr>>&.
32547 They are obtained from the password data by calling &[getpwuid()]& (but see the
32548 &%unknown_login%& configuration option). The address is qualified with
32549 &%qualify_domain%&.
32550
32551 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32552 &'From:'& header line containing just the unqualified login name of the calling
32553 user, this is replaced by an address containing the user's login name and full
32554 name as described in section &<<SECTconstr>>&.
32555
32556
32557 .section "The Message-ID: header line" "SECID226"
32558 .cindex "&'Message-ID:'& header line"
32559 .cindex "message" "submission"
32560 .oindex "&%message_id_header_text%&"
32561 If a locally-generated or submission-mode incoming message does not contain a
32562 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32563 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32564 to the message. If there are any &'Resent-:'& headers in the message, it
32565 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32566 message id, preceded by the letter E to ensure it starts with a letter, and
32567 followed by @ and the primary host name. Additional information can be included
32568 in this header line by setting the &%message_id_header_text%& and/or
32569 &%message_id_header_domain%& options.
32570
32571
32572 .section "The Received: header line" "SECID227"
32573 .cindex "&'Received:'& header line"
32574 A &'Received:'& header line is added at the start of every message. The
32575 contents are defined by the &%received_header_text%& configuration option, and
32576 Exim automatically adds a semicolon and a timestamp to the configured string.
32577
32578 The &'Received:'& header is generated as soon as the message's header lines
32579 have been received. At this stage, the timestamp in the &'Received:'& header
32580 line is the time that the message started to be received. This is the value
32581 that is seen by the DATA ACL and by the &[local_scan()]& function.
32582
32583 Once a message is accepted, the timestamp in the &'Received:'& header line is
32584 changed to the time of acceptance, which is (apart from a small delay while the
32585 -H spool file is written) the earliest time at which delivery could start.
32586
32587
32588 .section "The References: header line" "SECID228"
32589 .cindex "&'References:'& header line"
32590 Messages created by the &(autoreply)& transport include a &'References:'&
32591 header line. This is constructed according to the rules that are described in
32592 section 3.64 of RFC 2822 (which states that replies should contain such a
32593 header line), and section 3.14 of RFC 3834 (which states that automatic
32594 responses are not different in this respect). However, because some mail
32595 processing software does not cope well with very long header lines, no more
32596 than 12 message IDs are copied from the &'References:'& header line in the
32597 incoming message. If there are more than 12, the first one and then the final
32598 11 are copied, before adding the message ID of the incoming message.
32599
32600
32601
32602 .section "The Return-path: header line" "SECID229"
32603 .cindex "&'Return-path:'& header line"
32604 .oindex "&%return_path_remove%&"
32605 &'Return-path:'& header lines are defined as something an MTA may insert when
32606 it does the final delivery of messages. (See the generic &%return_path_add%&
32607 transport option.) Therefore, they should not be present in messages in
32608 transit. If the &%return_path_remove%& configuration option is set (the
32609 default), Exim removes &'Return-path:'& header lines from incoming messages.
32610
32611
32612
32613 .section "The Sender: header line" "SECTthesenhea"
32614 .cindex "&'Sender:'& header line"
32615 .cindex "message" "submission"
32616 For a locally-originated message from an untrusted user, Exim may remove an
32617 existing &'Sender:'& header line, and it may add a new one. You can modify
32618 these actions by setting the &%local_sender_retain%& option true, the
32619 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32620 control setting.
32621
32622 When a local message is received from an untrusted user and
32623 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32624 control has not been set, a check is made to see if the address given in the
32625 &'From:'& header line is the correct (local) sender of the message. The address
32626 that is expected has the login name as the local part and the value of
32627 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32628 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32629 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32630 line is added to the message.
32631
32632 If you set &%local_from_check%& false, this checking does not occur. However,
32633 the removal of an existing &'Sender:'& line still happens, unless you also set
32634 &%local_sender_retain%& to be true. It is not possible to set both of these
32635 options true at the same time.
32636
32637 .cindex "submission mode"
32638 By default, no processing of &'Sender:'& header lines is done for messages
32639 received over TCP/IP or for messages submitted by trusted users. However, when
32640 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32641 not specified on the submission control, the following processing takes place:
32642
32643 .vindex "&$authenticated_id$&"
32644 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32645 authenticated, and &$authenticated_id$& is not empty, a sender address is
32646 created as follows:
32647
32648 .ilist
32649 .vindex "&$qualify_domain$&"
32650 If no domain is specified by the submission control, the local part is
32651 &$authenticated_id$& and the domain is &$qualify_domain$&.
32652 .next
32653 If a non-empty domain is specified by the submission control, the local part
32654 is &$authenticated_id$&, and the domain is the specified domain.
32655 .next
32656 If an empty domain is specified by the submission control,
32657 &$authenticated_id$& is assumed to be the complete address.
32658 .endlist
32659
32660 This address is compared with the address in the &'From:'& header line. If they
32661 are different, a &'Sender:'& header line containing the created address is
32662 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32663 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32664
32665 .cindex "return path" "created from &'Sender:'&"
32666 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32667 the message (the envelope sender address) is changed to be the same address,
32668 except in the case of submission mode when &%sender_retain%& is specified.
32669
32670
32671
32672 .section "Adding and removing header lines in routers and transports" &&&
32673          "SECTheadersaddrem"
32674 .cindex "header lines" "adding; in router or transport"
32675 .cindex "header lines" "removing; in router or transport"
32676 When a message is delivered, the addition and removal of header lines can be
32677 specified in a system filter, or on any of the routers and transports that
32678 process the message. Section &<<SECTaddremheasys>>& contains details about
32679 modifying headers in a system filter. Header lines can also be added in an ACL
32680 as a message is received (see section &<<SECTaddheadacl>>&).
32681
32682 In contrast to what happens in a system filter, header modifications that are
32683 specified on routers and transports apply only to the particular recipient
32684 addresses that are being processed by those routers and transports. These
32685 changes do not actually take place until a copy of the message is being
32686 transported. Therefore, they do not affect the basic set of header lines, and
32687 they do not affect the values of the variables that refer to header lines.
32688
32689 &*Note*&: In particular, this means that any expansions in the configuration of
32690 the transport cannot refer to the modified header lines, because such
32691 expansions all occur before the message is actually transported.
32692
32693 For both routers and transports, the argument of a &%headers_add%&
32694 option must be in the form of one or more RFC 2822 header lines, separated by
32695 newlines (coded as &"\n"&). For example:
32696 .code
32697 headers_add = X-added-header: added by $primary_hostname\n\
32698               X-added-second: another added header line
32699 .endd
32700 Exim does not check the syntax of these added header lines.
32701
32702 Multiple &%headers_add%& options for a single router or transport can be
32703 specified; the values will append to a single list of header lines.
32704 Each header-line is separately expanded.
32705
32706 The argument of a &%headers_remove%& option must consist of a colon-separated
32707 list of header names. This is confusing, because header names themselves are
32708 often terminated by colons. In this case, the colons are the list separators,
32709 not part of the names. For example:
32710 .code
32711 headers_remove = return-receipt-to:acknowledge-to
32712 .endd
32713
32714 Multiple &%headers_remove%& options for a single router or transport can be
32715 specified; the arguments will append to a single header-names list.
32716 Each item is separately expanded.
32717 Note that colons in complex expansions which are used to
32718 form all or part of a &%headers_remove%& list
32719 will act as list separators.
32720
32721 When &%headers_add%& or &%headers_remove%& is specified on a router,
32722 items are expanded at routing time,
32723 and then associated with all addresses that are
32724 accepted by that router, and also with any new addresses that it generates. If
32725 an address passes through several routers as a result of aliasing or
32726 forwarding, the changes are cumulative.
32727
32728 .oindex "&%unseen%&"
32729 However, this does not apply to multiple routers that result from the use of
32730 the &%unseen%& option. Any header modifications that were specified by the
32731 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32732
32733 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32734 settings cannot be delivered together in a batch, so a transport is always
32735 dealing with a set of addresses that have the same header-processing
32736 requirements.
32737
32738 The transport starts by writing the original set of header lines that arrived
32739 with the message, possibly modified by the system filter. As it writes out
32740 these lines, it consults the list of header names that were attached to the
32741 recipient address(es) by &%headers_remove%& options in routers, and it also
32742 consults the transport's own &%headers_remove%& option. Header lines whose
32743 names are on either of these lists are not written out. If there are multiple
32744 instances of any listed header, they are all skipped.
32745
32746 After the remaining original header lines have been written, new header
32747 lines that were specified by routers' &%headers_add%& options are written, in
32748 the order in which they were attached to the address. These are followed by any
32749 header lines specified by the transport's &%headers_add%& option.
32750
32751 This way of handling header line modifications in routers and transports has
32752 the following consequences:
32753
32754 .ilist
32755 The original set of header lines, possibly modified by the system filter,
32756 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32757 to it, at all times.
32758 .next
32759 Header lines that are added by a router's
32760 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32761 expansion syntax in subsequent routers or the transport.
32762 .next
32763 Conversely, header lines that are specified for removal by &%headers_remove%&
32764 in a router remain visible to subsequent routers and the transport.
32765 .next
32766 Headers added to an address by &%headers_add%& in a router cannot be removed by
32767 a later router or by a transport.
32768 .next
32769 An added header can refer to the contents of an original header that is to be
32770 removed, even it has the same name as the added header. For example:
32771 .code
32772 headers_remove = subject
32773 headers_add = Subject: new subject (was: $h_subject:)
32774 .endd
32775 .endlist
32776
32777 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32778 for a &(redirect)& router that has the &%one_time%& option set.
32779
32780
32781
32782
32783
32784 .section "Constructed addresses" "SECTconstr"
32785 .cindex "address" "constructed"
32786 .cindex "constructed address"
32787 When Exim constructs a sender address for a locally-generated message, it uses
32788 the form
32789 .display
32790 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32791 .endd
32792 For example:
32793 .code
32794 Zaphod Beeblebrox <zaphod@end.univ.example>
32795 .endd
32796 The user name is obtained from the &%-F%& command line option if set, or
32797 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32798 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32799 ampersand character, this is replaced by the login name with the first letter
32800 upper cased, as is conventional in a number of operating systems. See the
32801 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32802 The &%unknown_username%& option can be used to specify user names in cases when
32803 there is no password file entry.
32804
32805 .cindex "RFC 2047"
32806 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32807 parts of it if necessary. In addition, if it contains any non-printing
32808 characters, it is encoded as described in RFC 2047, which defines a way of
32809 including non-ASCII characters in header lines. The value of the
32810 &%headers_charset%& option specifies the name of the encoding that is used (the
32811 characters are assumed to be in this encoding). The setting of
32812 &%print_topbitchars%& controls whether characters with the top bit set (that
32813 is, with codes greater than 127) count as printing characters or not.
32814
32815
32816
32817 .section "Case of local parts" "SECID230"
32818 .cindex "case of local parts"
32819 .cindex "local part" "case of"
32820 RFC 2822 states that the case of letters in the local parts of addresses cannot
32821 be assumed to be non-significant. Exim preserves the case of local parts of
32822 addresses, but by default it uses a lower-cased form when it is routing,
32823 because on most Unix systems, usernames are in lower case and case-insensitive
32824 routing is required. However, any particular router can be made to use the
32825 original case for local parts by setting the &%caseful_local_part%& generic
32826 router option.
32827
32828 .cindex "mixed-case login names"
32829 If you must have mixed-case user names on your system, the best way to proceed,
32830 assuming you want case-independent handling of incoming email, is to set up
32831 your first router to convert incoming local parts in your domains to the
32832 correct case by means of a file lookup. For example:
32833 .code
32834 correct_case:
32835   driver = redirect
32836   domains = +local_domains
32837   data = ${lookup{$local_part}cdb\
32838               {/etc/usercased.cdb}{$value}fail}\
32839               @$domain
32840 .endd
32841 For this router, the local part is forced to lower case by the default action
32842 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32843 up a new local part in the correct case. If you then set &%caseful_local_part%&
32844 on any subsequent routers which process your domains, they will operate on
32845 local parts with the correct case in a case-sensitive manner.
32846
32847
32848
32849 .section "Dots in local parts" "SECID231"
32850 .cindex "dot" "in local part"
32851 .cindex "local part" "dots in"
32852 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32853 part may not begin or end with a dot, nor have two consecutive dots in the
32854 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32855 empty components for compatibility.
32856
32857
32858
32859 .section "Rewriting addresses" "SECID232"
32860 .cindex "rewriting" "addresses"
32861 Rewriting of sender and recipient addresses, and addresses in headers, can
32862 happen automatically, or as the result of configuration options, as described
32863 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32864 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32865
32866 Automatic rewriting includes qualification, as mentioned above. The other case
32867 in which it can happen is when an incomplete non-local domain is given. The
32868 routing process may cause this to be expanded into the full domain name. For
32869 example, a header such as
32870 .code
32871 To: hare@teaparty
32872 .endd
32873 might get rewritten as
32874 .code
32875 To: hare@teaparty.wonderland.fict.example
32876 .endd
32877 Rewriting as a result of routing is the one kind of message processing that
32878 does not happen at input time, as it cannot be done until the address has
32879 been routed.
32880
32881 Strictly, one should not do &'any'& deliveries of a message until all its
32882 addresses have been routed, in case any of the headers get changed as a
32883 result of routing. However, doing this in practice would hold up many
32884 deliveries for unreasonable amounts of time, just because one address could not
32885 immediately be routed. Exim therefore does not delay other deliveries when
32886 routing of one or more addresses is deferred.
32887 .ecindex IIDmesproc
32888
32889
32890
32891 . ////////////////////////////////////////////////////////////////////////////
32892 . ////////////////////////////////////////////////////////////////////////////
32893
32894 .chapter "SMTP processing" "CHAPSMTP"
32895 .scindex IIDsmtpproc1 "SMTP" "processing details"
32896 .scindex IIDsmtpproc2 "LMTP" "processing details"
32897 Exim supports a number of different ways of using the SMTP protocol, and its
32898 LMTP variant, which is an interactive protocol for transferring messages into a
32899 closed mail store application. This chapter contains details of how SMTP is
32900 processed. For incoming mail, the following are available:
32901
32902 .ilist
32903 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32904 .next
32905 SMTP over the standard input and output (the &%-bs%& option);
32906 .next
32907 Batched SMTP on the standard input (the &%-bS%& option).
32908 .endlist
32909
32910 For mail delivery, the following are available:
32911
32912 .ilist
32913 SMTP over TCP/IP (the &(smtp)& transport);
32914 .next
32915 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32916 &"lmtp"&);
32917 .next
32918 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32919 transport);
32920 .next
32921 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32922 the &%use_bsmtp%& option set).
32923 .endlist
32924
32925 &'Batched SMTP'& is the name for a process in which batches of messages are
32926 stored in or read from files (or pipes), in a format in which SMTP commands are
32927 used to contain the envelope information.
32928
32929
32930
32931 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32932 .cindex "SMTP" "outgoing over TCP/IP"
32933 .cindex "outgoing SMTP over TCP/IP"
32934 .cindex "LMTP" "over TCP/IP"
32935 .cindex "outgoing LMTP over TCP/IP"
32936 .cindex "EHLO"
32937 .cindex "HELO"
32938 .cindex "SIZE option on MAIL command"
32939 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32940 The &%protocol%& option selects which protocol is to be used, but the actual
32941 processing is the same in both cases.
32942
32943 If, in response to its EHLO command, Exim is told that the SIZE
32944 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32945 command. The value of <&'n'&> is the message size plus the value of the
32946 &%size_addition%& option (default 1024) to allow for additions to the message
32947 such as per-transport header lines, or changes made in a
32948 .cindex "transport" "filter"
32949 .cindex "filter" "transport filter"
32950 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32951 suppressed.
32952
32953 If the remote server advertises support for PIPELINING, Exim uses the
32954 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32955 required for the transaction.
32956
32957 If the remote server advertises support for the STARTTLS command, and Exim
32958 was built to support TLS encryption, it tries to start a TLS session unless the
32959 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32960 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32961 is called for verification.
32962
32963 If the remote server advertises support for the AUTH command, Exim scans
32964 the authenticators configuration for any suitable client settings, as described
32965 in chapter &<<CHAPSMTPAUTH>>&.
32966
32967 .cindex "carriage return"
32968 .cindex "linefeed"
32969 Responses from the remote host are supposed to be terminated by CR followed by
32970 LF. However, there are known to be hosts that do not send CR characters, so in
32971 order to be able to interwork with such hosts, Exim treats LF on its own as a
32972 line terminator.
32973
32974 If a message contains a number of different addresses, all those with the same
32975 characteristics (for example, the same envelope sender) that resolve to the
32976 same set of hosts, in the same order, are sent in a single SMTP transaction,
32977 even if they are for different domains, unless there are more than the setting
32978 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32979 they are split into groups containing no more than &%max_rcpt%&s addresses
32980 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32981 in parallel sessions. The order of hosts with identical MX values is not
32982 significant when checking whether addresses can be batched in this way.
32983
32984 When the &(smtp)& transport suffers a temporary failure that is not
32985 message-related, Exim updates its transport-specific database, which contains
32986 records indexed by host name that remember which messages are waiting for each
32987 particular host. It also updates the retry database with new retry times.
32988
32989 .cindex "hints database" "retry keys"
32990 Exim's retry hints are based on host name plus IP address, so if one address of
32991 a multi-homed host is broken, it will soon be skipped most of the time.
32992 See the next section for more detail about error handling.
32993
32994 .cindex "SMTP" "passed connection"
32995 .cindex "SMTP" "batching over TCP/IP"
32996 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32997 looks in the hints database for the transport to see if there are any queued
32998 messages waiting for the host to which it is connected. If it finds one, it
32999 creates a new Exim process using the &%-MC%& option (which can only be used by
33000 a process running as root or the Exim user) and passes the TCP/IP socket to it
33001 so that it can deliver another message using the same socket. The new process
33002 does only those deliveries that are routed to the connected host, and may in
33003 turn pass the socket on to a third process, and so on.
33004
33005 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33006 limit the number of messages sent down a single TCP/IP connection.
33007
33008 .cindex "asterisk" "after IP address"
33009 The second and subsequent messages delivered down an existing connection are
33010 identified in the main log by the addition of an asterisk after the closing
33011 square bracket of the IP address.
33012
33013
33014
33015
33016 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33017 .cindex "error" "in outgoing SMTP"
33018 .cindex "SMTP" "errors in outgoing"
33019 .cindex "host" "error"
33020 Three different kinds of error are recognized for outgoing SMTP: host errors,
33021 message errors, and recipient errors.
33022
33023 .vlist
33024 .vitem "&*Host errors*&"
33025 A host error is not associated with a particular message or with a
33026 particular recipient of a message. The host errors are:
33027
33028 .ilist
33029 Connection refused or timed out,
33030 .next
33031 Any error response code on connection,
33032 .next
33033 Any error response code to EHLO or HELO,
33034 .next
33035 Loss of connection at any time, except after &"."&,
33036 .next
33037 I/O errors at any time,
33038 .next
33039 Timeouts during the session, other than in response to MAIL, RCPT or
33040 the &"."& at the end of the data.
33041 .endlist ilist
33042
33043 For a host error, a permanent error response on connection, or in response to
33044 EHLO, causes all addresses routed to the host to be failed. Any other host
33045 error causes all addresses to be deferred, and retry data to be created for the
33046 host. It is not tried again, for any message, until its retry time arrives. If
33047 the current set of addresses are not all delivered in this run (to some
33048 alternative host), the message is added to the list of those waiting for this
33049 host, so if it is still undelivered when a subsequent successful delivery is
33050 made to the host, it will be sent down the same SMTP connection.
33051
33052 .vitem "&*Message errors*&"
33053 .cindex "message" "error"
33054 A message error is associated with a particular message when sent to a
33055 particular host, but not with a particular recipient of the message. The
33056 message errors are:
33057
33058 .ilist
33059 Any error response code to MAIL, DATA, or the &"."& that terminates
33060 the data,
33061 .next
33062 Timeout after MAIL,
33063 .next
33064 Timeout or loss of connection after the &"."& that terminates the data. A
33065 timeout after the DATA command itself is treated as a host error, as is loss of
33066 connection at any other time.
33067 .endlist ilist
33068
33069 For a message error, a permanent error response (5&'xx'&) causes all addresses
33070 to be failed, and a delivery error report to be returned to the sender. A
33071 temporary error response (4&'xx'&), or one of the timeouts, causes all
33072 addresses to be deferred. Retry data is not created for the host, but instead,
33073 a retry record for the combination of host plus message id is created. The
33074 message is not added to the list of those waiting for this host. This ensures
33075 that the failing message will not be sent to this host again until the retry
33076 time arrives. However, other messages that are routed to the host are not
33077 affected, so if it is some property of the message that is causing the error,
33078 it will not stop the delivery of other mail.
33079
33080 If the remote host specified support for the SIZE parameter in its response
33081 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33082 over-large message will cause a message error because the error arrives as a
33083 response to MAIL.
33084
33085 .vitem "&*Recipient errors*&"
33086 .cindex "recipient" "error"
33087 A recipient error is associated with a particular recipient of a message. The
33088 recipient errors are:
33089
33090 .ilist
33091 Any error response to RCPT,
33092 .next
33093 Timeout after RCPT.
33094 .endlist
33095
33096 For a recipient error, a permanent error response (5&'xx'&) causes the
33097 recipient address to be failed, and a bounce message to be returned to the
33098 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33099 address to be deferred, and routing retry data to be created for it. This is
33100 used to delay processing of the address in subsequent queue runs, until its
33101 routing retry time arrives. This applies to all messages, but because it
33102 operates only in queue runs, one attempt will be made to deliver a new message
33103 to the failing address before the delay starts to operate. This ensures that,
33104 if the failure is really related to the message rather than the recipient
33105 (&"message too big for this recipient"& is a possible example), other messages
33106 have a chance of getting delivered. If a delivery to the address does succeed,
33107 the retry information gets cleared, so all stuck messages get tried again, and
33108 the retry clock is reset.
33109
33110 The message is not added to the list of those waiting for this host. Use of the
33111 host for other messages is unaffected, and except in the case of a timeout,
33112 other recipients are processed independently, and may be successfully delivered
33113 in the current SMTP session. After a timeout it is of course impossible to
33114 proceed with the session, so all addresses get deferred. However, those other
33115 than the one that failed do not suffer any subsequent retry delays. Therefore,
33116 if one recipient is causing trouble, the others have a chance of getting
33117 through when a subsequent delivery attempt occurs before the failing
33118 recipient's retry time.
33119 .endlist
33120
33121 In all cases, if there are other hosts (or IP addresses) available for the
33122 current set of addresses (for example, from multiple MX records), they are
33123 tried in this run for any undelivered addresses, subject of course to their
33124 own retry data. In other words, recipient error retry data does not take effect
33125 until the next delivery attempt.
33126
33127 Some hosts have been observed to give temporary error responses to every
33128 MAIL command at certain times (&"insufficient space"& has been seen). It
33129 would be nice if such circumstances could be recognized, and defer data for the
33130 host itself created, but this is not possible within the current Exim design.
33131 What actually happens is that retry data for every (host, message) combination
33132 is created.
33133
33134 The reason that timeouts after MAIL and RCPT are treated specially is that
33135 these can sometimes arise as a result of the remote host's verification
33136 procedures. Exim makes this assumption, and treats them as if a temporary error
33137 response had been received. A timeout after &"."& is treated specially because
33138 it is known that some broken implementations fail to recognize the end of the
33139 message if the last character of the last line is a binary zero. Thus, it is
33140 helpful to treat this case as a message error.
33141
33142 Timeouts at other times are treated as host errors, assuming a problem with the
33143 host, or the connection to it. If a timeout after MAIL, RCPT,
33144 or &"."& is really a connection problem, the assumption is that at the next try
33145 the timeout is likely to occur at some other point in the dialogue, causing it
33146 then to be treated as a host error.
33147
33148 There is experimental evidence that some MTAs drop the connection after the
33149 terminating &"."& if they do not like the contents of the message for some
33150 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33151 should be given. That is why Exim treats this case as a message rather than a
33152 host error, in order not to delay other messages to the same host.
33153
33154
33155
33156
33157 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33158 .cindex "SMTP" "incoming over TCP/IP"
33159 .cindex "incoming SMTP over TCP/IP"
33160 .cindex "inetd"
33161 .cindex "daemon"
33162 Incoming SMTP messages can be accepted in one of two ways: by running a
33163 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33164 &_/etc/inetd.conf_& should be like this:
33165 .code
33166 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33167 .endd
33168 Exim distinguishes between this case and the case of a locally running user
33169 agent using the &%-bs%& option by checking whether or not the standard input is
33170 a socket. When it is, either the port must be privileged (less than 1024), or
33171 the caller must be root or the Exim user. If any other user passes a socket
33172 with an unprivileged port number, Exim prints a message on the standard error
33173 stream and exits with an error code.
33174
33175 By default, Exim does not make a log entry when a remote host connects or
33176 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33177 unexpected. It can be made to write such log entries by setting the
33178 &%smtp_connection%& log selector.
33179
33180 .cindex "carriage return"
33181 .cindex "linefeed"
33182 Commands from the remote host are supposed to be terminated by CR followed by
33183 LF. However, there are known to be hosts that do not send CR characters. In
33184 order to be able to interwork with such hosts, Exim treats LF on its own as a
33185 line terminator.
33186 Furthermore, because common code is used for receiving messages from all
33187 sources, a CR on its own is also interpreted as a line terminator. However, the
33188 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33189
33190 .cindex "EHLO" "invalid data"
33191 .cindex "HELO" "invalid data"
33192 One area that sometimes gives rise to problems concerns the EHLO or
33193 HELO commands. Some clients send syntactically invalid versions of these
33194 commands, which Exim rejects by default. (This is nothing to do with verifying
33195 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33196 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33197 match the broken hosts that send invalid commands.
33198
33199 .cindex "SIZE option on MAIL command"
33200 .cindex "MAIL" "SIZE option"
33201 The amount of disk space available is checked whenever SIZE is received on
33202 a MAIL command, independently of whether &%message_size_limit%& or
33203 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33204 false. A temporary error is given if there is not enough space. If
33205 &%check_spool_space%& is set, the check is for that amount of space plus the
33206 value given with SIZE, that is, it checks that the addition of the incoming
33207 message will not reduce the space below the threshold.
33208
33209 When a message is successfully received, Exim includes the local message id in
33210 its response to the final &"."& that terminates the data. If the remote host
33211 logs this text it can help with tracing what has happened to a message.
33212
33213 The Exim daemon can limit the number of simultaneous incoming connections it is
33214 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33215 number of simultaneous incoming connections from a single remote host (see the
33216 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33217 rejected using the SMTP temporary error code 421.
33218
33219 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33220 subprocess has finished, as this can get lost at busy times. Instead, it looks
33221 for completed subprocesses every time it wakes up. Provided there are other
33222 things happening (new incoming calls, starts of queue runs), completed
33223 processes will be noticed and tidied away. On very quiet systems you may
33224 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33225 it will be noticed when the daemon next wakes up.
33226
33227 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33228 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33229 high system load &-- for details see the &%smtp_accept_reserve%&,
33230 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33231 applies in both the daemon and &'inetd'& cases.
33232
33233 Exim normally starts a delivery process for each message received, though this
33234 can be varied by means of the &%-odq%& command line option and the
33235 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33236 number of simultaneously running delivery processes started in this way from
33237 SMTP input can be limited by the &%smtp_accept_queue%& and
33238 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33239 subsequently received messages are just put on the input queue without starting
33240 a delivery process.
33241
33242 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33243 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33244 started up from the &'inetd'& daemon, because in that case each connection is
33245 handled by an entirely independent Exim process. Control by load average is,
33246 however, available with &'inetd'&.
33247
33248 Exim can be configured to verify addresses in incoming SMTP commands as they
33249 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33250 to rewrite addresses at this time &-- before any syntax checking is done. See
33251 section &<<SECTrewriteS>>&.
33252
33253 Exim can also be configured to limit the rate at which a client host submits
33254 MAIL and RCPT commands in a single SMTP session. See the
33255 &%smtp_ratelimit_hosts%& option.
33256
33257
33258
33259 .section "Unrecognized SMTP commands" "SECID234"
33260 .cindex "SMTP" "unrecognized commands"
33261 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33262 commands during a single SMTP connection, it drops the connection after sending
33263 the error response to the last command. The default value for
33264 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33265 abuse that subvert web servers into making connections to SMTP ports; in these
33266 circumstances, a number of non-SMTP lines are sent first.
33267
33268
33269 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33270 .cindex "SMTP" "syntax errors"
33271 .cindex "SMTP" "protocol errors"
33272 A syntax error is detected if an SMTP command is recognized, but there is
33273 something syntactically wrong with its data, for example, a malformed email
33274 address in a RCPT command. Protocol errors include invalid command
33275 sequencing such as RCPT before MAIL. If Exim receives more than
33276 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33277 drops the connection after sending the error response to the last command. The
33278 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33279 broken clients that loop sending bad commands (yes, it has been seen).
33280
33281
33282
33283 .section "Use of non-mail SMTP commands" "SECID236"
33284 .cindex "SMTP" "non-mail commands"
33285 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33286 DATA. Exim counts such commands, and drops the connection if there are too
33287 many of them in a single SMTP session. This action catches some
33288 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33289 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33290 defines what &"too many"& means. Its default value is 10.
33291
33292 When a new message is expected, one occurrence of RSET is not counted. This
33293 allows a client to send one RSET between messages (this is not necessary,
33294 but some clients do it). Exim also allows one uncounted occurrence of HELO
33295 or EHLO, and one occurrence of STARTTLS between messages. After
33296 starting up a TLS session, another EHLO is expected, and so it too is not
33297 counted.
33298
33299 The first occurrence of AUTH in a connection, or immediately following
33300 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33301 RCPT, DATA, and QUIT are counted.
33302
33303 You can control which hosts are subject to the limit set by
33304 &%smtp_accept_max_nonmail%& by setting
33305 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33306 the limit apply to all hosts. This option means that you can exclude any
33307 specific badly-behaved hosts that you have to live with.
33308
33309
33310
33311
33312 .section "The VRFY and EXPN commands" "SECID237"
33313 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33314 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33315 appropriate) in order to decide whether the command should be accepted or not.
33316 If no ACL is defined, the command is rejected.
33317
33318 .cindex "VRFY" "processing"
33319 When VRFY is accepted, it runs exactly the same code as when Exim is
33320 called with the &%-bv%& option.
33321
33322 .cindex "EXPN" "processing"
33323 When EXPN is accepted, a single-level expansion of the address is done.
33324 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33325 than a verification (the &%-bv%& option). If an unqualified local part is given
33326 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33327 of VRFY and EXPN commands are logged on the main and reject logs, and
33328 VRFY verification failures are logged on the main log for consistency with
33329 RCPT failures.
33330
33331
33332
33333 .section "The ETRN command" "SECTETRN"
33334 .cindex "ETRN" "processing"
33335 RFC 1985 describes an SMTP command called ETRN that is designed to
33336 overcome the security problems of the TURN command (which has fallen into
33337 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33338 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33339 should be accepted or not. If no ACL is defined, the command is rejected.
33340
33341 The ETRN command is concerned with &"releasing"& messages that are awaiting
33342 delivery to certain hosts. As Exim does not organize its message queue by host,
33343 the only form of ETRN that is supported by default is the one where the
33344 text starts with the &"#"& prefix, in which case the remainder of the text is
33345 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33346 the &%-R%& option to happen, with the remainder of the ETRN text as its
33347 argument. For example,
33348 .code
33349 ETRN #brigadoon
33350 .endd
33351 runs the command
33352 .code
33353 exim -R brigadoon
33354 .endd
33355 which causes a delivery attempt on all messages with undelivered addresses
33356 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33357 default), Exim prevents the simultaneous execution of more than one queue run
33358 for the same argument string as a result of an ETRN command. This stops
33359 a misbehaving client from starting more than one queue runner at once.
33360
33361 .cindex "hints database" "ETRN serialization"
33362 Exim implements the serialization by means of a hints database in which a
33363 record is written whenever a process is started by ETRN, and deleted when
33364 the process completes. However, Exim does not keep the SMTP session waiting for
33365 the ETRN process to complete. Once ETRN is accepted, the client is sent
33366 a &"success"& return code. Obviously there is scope for hints records to get
33367 left lying around if there is a system or program crash. To guard against this,
33368 Exim ignores any records that are more than six hours old.
33369
33370 .oindex "&%smtp_etrn_command%&"
33371 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33372 used. This specifies a command that is run whenever ETRN is received,
33373 whatever the form of its argument. For
33374 example:
33375 .code
33376 smtp_etrn_command = /etc/etrn_command $domain \
33377                     $sender_host_address
33378 .endd
33379 .vindex "&$domain$&"
33380 The string is split up into arguments which are independently expanded. The
33381 expansion variable &$domain$& is set to the argument of the ETRN command,
33382 and no syntax checking is done on the contents of this argument. Exim does not
33383 wait for the command to complete, so its status code is not checked. Exim runs
33384 under its own uid and gid when receiving incoming SMTP, so it is not possible
33385 for it to change them before running the command.
33386
33387
33388
33389 .section "Incoming local SMTP" "SECID238"
33390 .cindex "SMTP" "local incoming"
33391 Some user agents use SMTP to pass messages to their local MTA using the
33392 standard input and output, as opposed to passing the envelope on the command
33393 line and writing the message to the standard input. This is supported by the
33394 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33395 messages over TCP/IP (including the use of ACLs), except that the envelope
33396 sender given in a MAIL command is ignored unless the caller is trusted. In
33397 an ACL you can detect this form of SMTP input by testing for an empty host
33398 identification. It is common to have this as the first line in the ACL that
33399 runs for RCPT commands:
33400 .code
33401 accept hosts = :
33402 .endd
33403 This accepts SMTP messages from local processes without doing any other tests.
33404
33405
33406
33407 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33408 .cindex "SMTP" "batched outgoing"
33409 .cindex "batched SMTP output"
33410 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33411 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33412 be output in BSMTP format. No SMTP responses are possible for this form of
33413 delivery. All it is doing is using SMTP commands as a way of transmitting the
33414 envelope along with the message.
33415
33416 The message is written to the file or pipe preceded by the SMTP commands
33417 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33418 the message that start with a dot have an extra dot added. The SMTP command
33419 HELO is not normally used. If it is required, the &%message_prefix%& option
33420 can be used to specify it.
33421
33422 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33423 one recipient address at a time by default. However, you can arrange for them
33424 to handle several addresses at once by setting the &%batch_max%& option. When
33425 this is done for BSMTP, messages may contain multiple RCPT commands. See
33426 chapter &<<CHAPbatching>>& for more details.
33427
33428 .vindex "&$host$&"
33429 When one or more addresses are routed to a BSMTP transport by a router that
33430 sets up a host list, the name of the first host on the list is available to the
33431 transport in the variable &$host$&. Here is an example of such a transport and
33432 router:
33433 .code
33434 begin routers
33435 route_append:
33436   driver = manualroute
33437   transport = smtp_appendfile
33438   route_list = domain.example  batch.host.example
33439
33440 begin transports
33441 smtp_appendfile:
33442   driver = appendfile
33443   directory = /var/bsmtp/$host
33444   batch_max = 1000
33445   use_bsmtp
33446   user = exim
33447 .endd
33448 This causes messages addressed to &'domain.example'& to be written in BSMTP
33449 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33450 message (unless there are more than 1000 recipients).
33451
33452
33453
33454 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33455 .cindex "SMTP" "batched incoming"
33456 .cindex "batched SMTP input"
33457 The &%-bS%& command line option causes Exim to accept one or more messages by
33458 reading SMTP on the standard input, but to generate no responses. If the caller
33459 is trusted, the senders in the MAIL commands are believed; otherwise the
33460 sender is always the caller of Exim. Unqualified senders and receivers are not
33461 rejected (there seems little point) but instead just get qualified. HELO
33462 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33463 as NOOP; QUIT quits.
33464
33465 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33466 ACL is run in the same way as for non-SMTP local input.
33467
33468 If an error is detected while reading a message, including a missing &"."& at
33469 the end, Exim gives up immediately. It writes details of the error to the
33470 standard output in a stylized way that the calling program should be able to
33471 make some use of automatically, for example:
33472 .code
33473 554 Unexpected end of file
33474 Transaction started in line 10
33475 Error detected in line 14
33476 .endd
33477 It writes a more verbose version, for human consumption, to the standard error
33478 file, for example:
33479 .code
33480 An error was detected while processing a file of BSMTP input.
33481 The error message was:
33482
33483 501 '>' missing at end of address
33484
33485 The SMTP transaction started in line 10.
33486 The error was detected in line 12.
33487 The SMTP command at fault was:
33488
33489 rcpt to:<malformed@in.com.plete
33490
33491 1 previous message was successfully processed.
33492 The rest of the batch was abandoned.
33493 .endd
33494 The return code from Exim is zero only if there were no errors. It is 1 if some
33495 messages were accepted before an error was detected, and 2 if no messages were
33496 accepted.
33497 .ecindex IIDsmtpproc1
33498 .ecindex IIDsmtpproc2
33499
33500
33501
33502 . ////////////////////////////////////////////////////////////////////////////
33503 . ////////////////////////////////////////////////////////////////////////////
33504
33505 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33506          "Customizing messages"
33507 When a message fails to be delivered, or remains on the queue for more than a
33508 configured amount of time, Exim sends a message to the original sender, or
33509 to an alternative configured address. The text of these messages is built into
33510 the code of Exim, but it is possible to change it, either by adding a single
33511 string, or by replacing each of the paragraphs by text supplied in a file.
33512
33513 The &'From:'& and &'To:'& header lines are automatically generated; you can
33514 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33515 option. Exim also adds the line
33516 .code
33517 Auto-Submitted: auto-generated
33518 .endd
33519 to all warning and bounce messages,
33520
33521
33522 .section "Customizing bounce messages" "SECID239"
33523 .cindex "customizing" "bounce message"
33524 .cindex "bounce message" "customizing"
33525 If &%bounce_message_text%& is set, its contents are included in the default
33526 message immediately after &"This message was created automatically by mail
33527 delivery software."& The string is not expanded. It is not used if
33528 &%bounce_message_file%& is set.
33529
33530 When &%bounce_message_file%& is set, it must point to a template file for
33531 constructing error messages. The file consists of a series of text items,
33532 separated by lines consisting of exactly four asterisks. If the file cannot be
33533 opened, default text is used and a message is written to the main and panic
33534 logs. If any text item in the file is empty, default text is used for that
33535 item.
33536
33537 .vindex "&$bounce_recipient$&"
33538 .vindex "&$bounce_return_size_limit$&"
33539 Each item of text that is read from the file is expanded, and there are two
33540 expansion variables which can be of use here: &$bounce_recipient$& is set to
33541 the recipient of an error message while it is being created, and
33542 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33543 option, rounded to a whole number.
33544
33545 The items must appear in the file in the following order:
33546
33547 .ilist
33548 The first item is included in the headers, and should include at least a
33549 &'Subject:'& header. Exim does not check the syntax of these headers.
33550 .next
33551 The second item forms the start of the error message. After it, Exim lists the
33552 failing addresses with their error messages.
33553 .next
33554 The third item is used to introduce any text from pipe transports that is to be
33555 returned to the sender. It is omitted if there is no such text.
33556 .next
33557 The fourth, fifth and sixth items will be ignored and may be empty.
33558 The fields exist for back-compatibility
33559 .endlist
33560
33561 The default state (&%bounce_message_file%& unset) is equivalent to the
33562 following file, in which the sixth item is empty. The &'Subject:'& and some
33563 other lines have been split in order to fit them on the page:
33564 .code
33565 Subject: Mail delivery failed
33566   ${if eq{$sender_address}{$bounce_recipient}
33567   {: returning message to sender}}
33568 ****
33569 This message was created automatically by mail delivery software.
33570
33571 A message ${if eq{$sender_address}{$bounce_recipient}
33572   {that you sent }{sent by
33573
33574 <$sender_address>
33575
33576 }}could not be delivered to all of its recipients.
33577 This is a permanent error. The following address(es) failed:
33578 ****
33579 The following text was generated during the delivery attempt(s):
33580 ****
33581 ------ This is a copy of the message, including all the headers.
33582   ------
33583 ****
33584 ------ The body of the message is $message_size characters long;
33585   only the first
33586 ------ $bounce_return_size_limit or so are included here.
33587 ****
33588 .endd
33589 .section "Customizing warning messages" "SECTcustwarn"
33590 .cindex "customizing" "warning message"
33591 .cindex "warning of delay" "customizing the message"
33592 The option &%warn_message_file%& can be pointed at a template file for use when
33593 warnings about message delays are created. In this case there are only three
33594 text sections:
33595
33596 .ilist
33597 The first item is included in the headers, and should include at least a
33598 &'Subject:'& header. Exim does not check the syntax of these headers.
33599 .next
33600 The second item forms the start of the warning message. After it, Exim lists
33601 the delayed addresses.
33602 .next
33603 The third item then ends the message.
33604 .endlist
33605
33606 The default state is equivalent to the following file, except that some lines
33607 have been split here, in order to fit them on the page:
33608 .code
33609 Subject: Warning: message $message_exim_id delayed
33610   $warn_message_delay
33611 ****
33612 This message was created automatically by mail delivery software.
33613
33614 A message ${if eq{$sender_address}{$warn_message_recipients}
33615 {that you sent }{sent by
33616
33617 <$sender_address>
33618
33619 }}has not been delivered to all of its recipients after
33620 more than $warn_message_delay on the queue on $primary_hostname.
33621
33622 The message identifier is:     $message_exim_id
33623 The subject of the message is: $h_subject
33624 The date of the message is:    $h_date
33625
33626 The following address(es) have not yet been delivered:
33627 ****
33628 No action is required on your part. Delivery attempts will
33629 continue for some time, and this warning may be repeated at
33630 intervals if the message remains undelivered. Eventually the
33631 mail delivery software will give up, and when that happens,
33632 the message will be returned to you.
33633 .endd
33634 .vindex "&$warn_message_delay$&"
33635 .vindex "&$warn_message_recipients$&"
33636 However, in the default state the subject and date lines are omitted if no
33637 appropriate headers exist. During the expansion of this file,
33638 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33639 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33640 of recipients for the warning message. There may be more than one if there are
33641 multiple addresses with different &%errors_to%& settings on the routers that
33642 handled them.
33643
33644
33645
33646
33647 . ////////////////////////////////////////////////////////////////////////////
33648 . ////////////////////////////////////////////////////////////////////////////
33649
33650 .chapter "Some common configuration settings" "CHAPcomconreq"
33651 This chapter discusses some configuration settings that seem to be fairly
33652 common. More examples and discussion can be found in the Exim book.
33653
33654
33655
33656 .section "Sending mail to a smart host" "SECID240"
33657 .cindex "smart host" "example router"
33658 If you want to send all mail for non-local domains to a &"smart host"&, you
33659 should replace the default &(dnslookup)& router with a router which does the
33660 routing explicitly:
33661 .code
33662 send_to_smart_host:
33663   driver = manualroute
33664   route_list = !+local_domains smart.host.name
33665   transport = remote_smtp
33666 .endd
33667 You can use the smart host's IP address instead of the name if you wish.
33668 If you are using Exim only to submit messages to a smart host, and not for
33669 receiving incoming messages, you can arrange for it to do the submission
33670 synchronously by setting the &%mua_wrapper%& option (see chapter
33671 &<<CHAPnonqueueing>>&).
33672
33673
33674
33675
33676 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33677 .cindex "mailing lists"
33678 Exim can be used to run simple mailing lists, but for large and/or complicated
33679 requirements, the use of additional specialized mailing list software such as
33680 Majordomo or Mailman is recommended.
33681
33682 The &(redirect)& router can be used to handle mailing lists where each list
33683 is maintained in a separate file, which can therefore be managed by an
33684 independent manager. The &%domains%& router option can be used to run these
33685 lists in a separate domain from normal mail. For example:
33686 .code
33687 lists:
33688   driver = redirect
33689   domains = lists.example
33690   file = /usr/lists/$local_part
33691   forbid_pipe
33692   forbid_file
33693   errors_to = $local_part-request@lists.example
33694   no_more
33695 .endd
33696 This router is skipped for domains other than &'lists.example'&. For addresses
33697 in that domain, it looks for a file that matches the local part. If there is no
33698 such file, the router declines, but because &%no_more%& is set, no subsequent
33699 routers are tried, and so the whole delivery fails.
33700
33701 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33702 expanded into a file name or a pipe delivery, which is usually inappropriate in
33703 a mailing list.
33704
33705 .oindex "&%errors_to%&"
33706 The &%errors_to%& option specifies that any delivery errors caused by addresses
33707 taken from a mailing list are to be sent to the given address rather than the
33708 original sender of the message. However, before acting on this, Exim verifies
33709 the error address, and ignores it if verification fails.
33710
33711 For example, using the configuration above, mail sent to
33712 &'dicts@lists.example'& is passed on to those addresses contained in
33713 &_/usr/lists/dicts_&, with error reports directed to
33714 &'dicts-request@lists.example'&, provided that this address can be verified.
33715 There could be a file called &_/usr/lists/dicts-request_& containing
33716 the address(es) of this particular list's manager(s), but other approaches,
33717 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33718 or &%local_part_suffix%& options) to handle addresses of the form
33719 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33720
33721
33722
33723 .section "Syntax errors in mailing lists" "SECID241"
33724 .cindex "mailing lists" "syntax errors in"
33725 If an entry in redirection data contains a syntax error, Exim normally defers
33726 delivery of the original address. That means that a syntax error in a mailing
33727 list holds up all deliveries to the list. This may not be appropriate when a
33728 list is being maintained automatically from data supplied by users, and the
33729 addresses are not rigorously checked.
33730
33731 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33732 entries that fail to parse, noting the incident in the log. If in addition
33733 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33734 whenever a broken address is skipped. It is usually appropriate to set
33735 &%syntax_errors_to%& to the same address as &%errors_to%&.
33736
33737
33738
33739 .section "Re-expansion of mailing lists" "SECID242"
33740 .cindex "mailing lists" "re-expansion of"
33741 Exim remembers every individual address to which a message has been delivered,
33742 in order to avoid duplication, but it normally stores only the original
33743 recipient addresses with a message. If all the deliveries to a mailing list
33744 cannot be done at the first attempt, the mailing list is re-expanded when the
33745 delivery is next tried. This means that alterations to the list are taken into
33746 account at each delivery attempt, so addresses that have been added to
33747 the list since the message arrived will therefore receive a copy of the
33748 message, even though it pre-dates their subscription.
33749
33750 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33751 on the &(redirect)& router. If this is done, any addresses generated by the
33752 router that fail to deliver at the first attempt are added to the message as
33753 &"top level"& addresses, and the parent address that generated them is marked
33754 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33755 subsequent delivery attempts. The disadvantage of this is that if any of the
33756 failing addresses are incorrect, correcting them in the file has no effect on
33757 pre-existing messages.
33758
33759 The original top-level address is remembered with each of the generated
33760 addresses, and is output in any log messages. However, any intermediate parent
33761 addresses are not recorded. This makes a difference to the log only if the
33762 &%all_parents%& selector is set, but for mailing lists there is normally only
33763 one level of expansion anyway.
33764
33765
33766
33767 .section "Closed mailing lists" "SECID243"
33768 .cindex "mailing lists" "closed"
33769 The examples so far have assumed open mailing lists, to which anybody may
33770 send mail. It is also possible to set up closed lists, where mail is accepted
33771 from specified senders only. This is done by making use of the generic
33772 &%senders%& option to restrict the router that handles the list.
33773
33774 The following example uses the same file as a list of recipients and as a list
33775 of permitted senders. It requires three routers:
33776 .code
33777 lists_request:
33778   driver = redirect
33779   domains = lists.example
33780   local_part_suffix = -request
33781   file = /usr/lists/$local_part$local_part_suffix
33782   no_more
33783
33784 lists_post:
33785   driver = redirect
33786   domains = lists.example
33787   senders = ${if exists {/usr/lists/$local_part}\
33788              {lsearch;/usr/lists/$local_part}{*}}
33789   file = /usr/lists/$local_part
33790   forbid_pipe
33791   forbid_file
33792   errors_to = $local_part-request@lists.example
33793   no_more
33794
33795 lists_closed:
33796   driver = redirect
33797   domains = lists.example
33798   allow_fail
33799   data = :fail: $local_part@lists.example is a closed mailing list
33800 .endd
33801 All three routers have the same &%domains%& setting, so for any other domains,
33802 they are all skipped. The first router runs only if the local part ends in
33803 &%-request%&. It handles messages to the list manager(s) by means of an open
33804 mailing list.
33805
33806 The second router runs only if the &%senders%& precondition is satisfied. It
33807 checks for the existence of a list that corresponds to the local part, and then
33808 checks that the sender is on the list by means of a linear search. It is
33809 necessary to check for the existence of the file before trying to search it,
33810 because otherwise Exim thinks there is a configuration error. If the file does
33811 not exist, the expansion of &%senders%& is *, which matches all senders. This
33812 means that the router runs, but because there is no list, declines, and
33813 &%no_more%& ensures that no further routers are run. The address fails with an
33814 &"unrouteable address"& error.
33815
33816 The third router runs only if the second router is skipped, which happens when
33817 a mailing list exists, but the sender is not on it. This router forcibly fails
33818 the address, giving a suitable error message.
33819
33820
33821
33822
33823 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33824 .cindex "VERP"
33825 .cindex "Variable Envelope Return Paths"
33826 .cindex "envelope sender"
33827 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33828 are a way of helping mailing list administrators discover which subscription
33829 address is the cause of a particular delivery failure. The idea is to encode
33830 the original recipient address in the outgoing envelope sender address, so that
33831 if the message is forwarded by another host and then subsequently bounces, the
33832 original recipient can be extracted from the recipient address of the bounce.
33833
33834 .oindex &%errors_to%&
33835 .oindex &%return_path%&
33836 Envelope sender addresses can be modified by Exim using two different
33837 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33838 list examples), or the &%return_path%& option on a transport. The second of
33839 these is effective only if the message is successfully delivered to another
33840 host; it is not used for errors detected on the local host (see the description
33841 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33842 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33843 .code
33844 verp_smtp:
33845   driver = smtp
33846   max_rcpt = 1
33847   return_path = \
33848     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33849       {$1-request+$local_part=$domain@your.dom.example}fail}
33850 .endd
33851 This has the effect of rewriting the return path (envelope sender) on outgoing
33852 SMTP messages, if the local part of the original return path ends in
33853 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33854 local part and domain of the recipient into the return path. Suppose, for
33855 example, that a message whose return path has been set to
33856 &'somelist-request@your.dom.example'& is sent to
33857 &'subscriber@other.dom.example'&. In the transport, the return path is
33858 rewritten as
33859 .code
33860 somelist-request+subscriber=other.dom.example@your.dom.example
33861 .endd
33862 .vindex "&$local_part$&"
33863 For this to work, you must tell Exim to send multiple copies of messages that
33864 have more than one recipient, so that each copy has just one recipient. This is
33865 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33866 might be sent to several different recipients in the same domain, in which case
33867 &$local_part$& is not available in the transport, because it is not unique.
33868
33869 Unless your host is doing nothing but mailing list deliveries, you should
33870 probably use a separate transport for the VERP deliveries, so as not to use
33871 extra resources in making one-per-recipient copies for other deliveries. This
33872 can easily be done by expanding the &%transport%& option in the router:
33873 .code
33874 dnslookup:
33875   driver = dnslookup
33876   domains = ! +local_domains
33877   transport = \
33878     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33879       {verp_smtp}{remote_smtp}}
33880   no_more
33881 .endd
33882 If you want to change the return path using &%errors_to%& in a router instead
33883 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33884 routers that handle mailing list addresses. This will ensure that all delivery
33885 errors, including those detected on the local host, are sent to the VERP
33886 address.
33887
33888 On a host that does no local deliveries and has no manual routing, only the
33889 &(dnslookup)& router needs to be changed. A special transport is not needed for
33890 SMTP deliveries. Every mailing list recipient has its own return path value,
33891 and so Exim must hand them to the transport one at a time. Here is an example
33892 of a &(dnslookup)& router that implements VERP:
33893 .code
33894 verp_dnslookup:
33895   driver = dnslookup
33896   domains = ! +local_domains
33897   transport = remote_smtp
33898   errors_to = \
33899     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33900      {$1-request+$local_part=$domain@your.dom.example}fail}
33901   no_more
33902 .endd
33903 Before you start sending out messages with VERPed return paths, you must also
33904 configure Exim to accept the bounce messages that come back to those paths.
33905 Typically this is done by setting a &%local_part_suffix%& option for a
33906 router, and using this to route the messages to wherever you want to handle
33907 them.
33908
33909 The overhead incurred in using VERP depends very much on the size of the
33910 message, the number of recipient addresses that resolve to the same remote
33911 host, and the speed of the connection over which the message is being sent. If
33912 a lot of addresses resolve to the same host and the connection is slow, sending
33913 a separate copy of the message for each address may take substantially longer
33914 than sending a single copy with many recipients (for which VERP cannot be
33915 used).
33916
33917
33918
33919
33920
33921
33922 .section "Virtual domains" "SECTvirtualdomains"
33923 .cindex "virtual domains"
33924 .cindex "domain" "virtual"
33925 The phrase &'virtual domain'& is unfortunately used with two rather different
33926 meanings:
33927
33928 .ilist
33929 A domain for which there are no real mailboxes; all valid local parts are
33930 aliases for other email addresses. Common examples are organizational
33931 top-level domains and &"vanity"& domains.
33932 .next
33933 One of a number of independent domains that are all handled by the same host,
33934 with mailboxes on that host, but where the mailbox owners do not necessarily
33935 have login accounts on that host.
33936 .endlist
33937
33938 The first usage is probably more common, and does seem more &"virtual"& than
33939 the second. This kind of domain can be handled in Exim with a straightforward
33940 aliasing router. One approach is to create a separate alias file for each
33941 virtual domain. Exim can test for the existence of the alias file to determine
33942 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33943 to a router of this form:
33944 .code
33945 virtual:
33946   driver = redirect
33947   domains = dsearch;/etc/mail/virtual
33948   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33949   no_more
33950 .endd
33951 The &%domains%& option specifies that the router is to be skipped, unless there
33952 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33953 domain that is being processed. When the router runs, it looks up the local
33954 part in the file to find a new address (or list of addresses). The &%no_more%&
33955 setting ensures that if the lookup fails (leading to &%data%& being an empty
33956 string), Exim gives up on the address without trying any subsequent routers.
33957
33958 This one router can handle all the virtual domains because the alias file names
33959 follow a fixed pattern. Permissions can be arranged so that appropriate people
33960 can edit the different alias files. A successful aliasing operation results in
33961 a new envelope recipient address, which is then routed from scratch.
33962
33963 The other kind of &"virtual"& domain can also be handled in a straightforward
33964 way. One approach is to create a file for each domain containing a list of
33965 valid local parts, and use it in a router like this:
33966 .code
33967 my_domains:
33968   driver = accept
33969   domains = dsearch;/etc/mail/domains
33970   local_parts = lsearch;/etc/mail/domains/$domain
33971   transport = my_mailboxes
33972 .endd
33973 The address is accepted if there is a file for the domain, and the local part
33974 can be found in the file. The &%domains%& option is used to check for the
33975 file's existence because &%domains%& is tested before the &%local_parts%&
33976 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33977 because that option is tested after &%local_parts%&. The transport is as
33978 follows:
33979 .code
33980 my_mailboxes:
33981   driver = appendfile
33982   file = /var/mail/$domain/$local_part
33983   user = mail
33984 .endd
33985 This uses a directory of mailboxes for each domain. The &%user%& setting is
33986 required, to specify which uid is to be used for writing to the mailboxes.
33987
33988 The configuration shown here is just one example of how you might support this
33989 requirement. There are many other ways this kind of configuration can be set
33990 up, for example, by using a database instead of separate files to hold all the
33991 information about the domains.
33992
33993
33994
33995 .section "Multiple user mailboxes" "SECTmulbox"
33996 .cindex "multiple mailboxes"
33997 .cindex "mailbox" "multiple"
33998 .cindex "local part" "prefix"
33999 .cindex "local part" "suffix"
34000 Heavy email users often want to operate with multiple mailboxes, into which
34001 incoming mail is automatically sorted. A popular way of handling this is to
34002 allow users to use multiple sender addresses, so that replies can easily be
34003 identified. Users are permitted to add prefixes or suffixes to their local
34004 parts for this purpose. The wildcard facility of the generic router options
34005 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34006 example, consider this router:
34007 .code
34008 userforward:
34009   driver = redirect
34010   check_local_user
34011   file = $home/.forward
34012   local_part_suffix = -*
34013   local_part_suffix_optional
34014   allow_filter
34015 .endd
34016 .vindex "&$local_part_suffix$&"
34017 It runs a user's &_.forward_& file for all local parts of the form
34018 &'username-*'&. Within the filter file the user can distinguish different
34019 cases by testing the variable &$local_part_suffix$&. For example:
34020 .code
34021 if $local_part_suffix contains -special then
34022 save /home/$local_part/Mail/special
34023 endif
34024 .endd
34025 If the filter file does not exist, or does not deal with such addresses, they
34026 fall through to subsequent routers, and, assuming no subsequent use of the
34027 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34028 control over which suffixes are valid.
34029
34030 Alternatively, a suffix can be used to trigger the use of a different
34031 &_.forward_& file &-- which is the way a similar facility is implemented in
34032 another MTA:
34033 .code
34034 userforward:
34035   driver = redirect
34036   check_local_user
34037   file = $home/.forward$local_part_suffix
34038   local_part_suffix = -*
34039   local_part_suffix_optional
34040   allow_filter
34041 .endd
34042 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34043 example, &_.forward-special_& is used. Once again, if the appropriate file
34044 does not exist, or does not deal with the address, it is passed on to
34045 subsequent routers, which could, if required, look for an unqualified
34046 &_.forward_& file to use as a default.
34047
34048
34049
34050 .section "Simplified vacation processing" "SECID244"
34051 .cindex "vacation processing"
34052 The traditional way of running the &'vacation'& program is for a user to set up
34053 a pipe command in a &_.forward_& file
34054 (see section &<<SECTspecitredli>>& for syntax details).
34055 This is prone to error by inexperienced users. There are two features of Exim
34056 that can be used to make this process simpler for users:
34057
34058 .ilist
34059 A local part prefix such as &"vacation-"& can be specified on a router which
34060 can cause the message to be delivered directly to the &'vacation'& program, or
34061 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34062 &_.forward_& file are then much simpler. For example:
34063 .code
34064 spqr, vacation-spqr
34065 .endd
34066 .next
34067 The &%require_files%& generic router option can be used to trigger a
34068 vacation delivery by checking for the existence of a certain file in the
34069 user's home directory. The &%unseen%& generic option should also be used, to
34070 ensure that the original delivery also proceeds. In this case, all the user has
34071 to do is to create a file called, say, &_.vacation_&, containing a vacation
34072 message.
34073 .endlist
34074
34075 Another advantage of both these methods is that they both work even when the
34076 use of arbitrary pipes by users is locked out.
34077
34078
34079
34080 .section "Taking copies of mail" "SECID245"
34081 .cindex "message" "copying every"
34082 Some installations have policies that require archive copies of all messages to
34083 be made. A single copy of each message can easily be taken by an appropriate
34084 command in a system filter, which could, for example, use a different file for
34085 each day's messages.
34086
34087 There is also a shadow transport mechanism that can be used to take copies of
34088 messages that are successfully delivered by local transports, one copy per
34089 delivery. This could be used, &'inter alia'&, to implement automatic
34090 notification of delivery by sites that insist on doing such things.
34091
34092
34093
34094 .section "Intermittently connected hosts" "SECID246"
34095 .cindex "intermittently connected hosts"
34096 It has become quite common (because it is cheaper) for hosts to connect to the
34097 Internet periodically rather than remain connected all the time. The normal
34098 arrangement is that mail for such hosts accumulates on a system that is
34099 permanently connected.
34100
34101 Exim was designed for use on permanently connected hosts, and so it is not
34102 particularly well-suited to use in an intermittently connected environment.
34103 Nevertheless there are some features that can be used.
34104
34105
34106 .section "Exim on the upstream server host" "SECID247"
34107 It is tempting to arrange for incoming mail for the intermittently connected
34108 host to remain on Exim's queue until the client connects. However, this
34109 approach does not scale very well. Two different kinds of waiting message are
34110 being mixed up in the same queue &-- those that cannot be delivered because of
34111 some temporary problem, and those that are waiting for their destination host
34112 to connect. This makes it hard to manage the queue, as well as wasting
34113 resources, because each queue runner scans the entire queue.
34114
34115 A better approach is to separate off those messages that are waiting for an
34116 intermittently connected host. This can be done by delivering these messages
34117 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34118 format, from where they are transmitted by other software when their
34119 destination connects. This makes it easy to collect all the mail for one host
34120 in a single directory, and to apply local timeout rules on a per-message basis
34121 if required.
34122
34123 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34124 you are doing this, you should configure Exim with a long retry period for the
34125 intermittent host. For example:
34126 .code
34127 cheshire.wonderland.fict.example    *   F,5d,24h
34128 .endd
34129 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34130 which messages it has queued up for that host. Once the intermittent host comes
34131 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34132 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34133 causes all the queued up messages to be delivered, often down a single SMTP
34134 connection. While the host remains connected, any new messages get delivered
34135 immediately.
34136
34137 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34138 issued with a different IP address each time it connects, Exim's retry
34139 mechanisms on the holding host get confused, because the IP address is normally
34140 used as part of the key string for holding retry information. This can be
34141 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34142 Since this has disadvantages for permanently connected hosts, it is best to
34143 arrange a separate transport for the intermittently connected ones.
34144
34145
34146
34147 .section "Exim on the intermittently connected client host" "SECID248"
34148 The value of &%smtp_accept_queue_per_connection%& should probably be
34149 increased, or even set to zero (that is, disabled) on the intermittently
34150 connected host, so that all incoming messages down a single connection get
34151 delivered immediately.
34152
34153 .cindex "SMTP" "passed connection"
34154 .cindex "SMTP" "multiple deliveries"
34155 .cindex "multiple SMTP deliveries"
34156 Mail waiting to be sent from an intermittently connected host will probably
34157 not have been routed, because without a connection DNS lookups are not
34158 possible. This means that if a normal queue run is done at connection time,
34159 each message is likely to be sent in a separate SMTP session. This can be
34160 avoided by starting the queue run with a command line option beginning with
34161 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34162 first pass, routing is done but no deliveries take place. The second pass is a
34163 normal queue run; since all the messages have been previously routed, those
34164 destined for the same host are likely to get sent as multiple deliveries in a
34165 single SMTP connection.
34166
34167
34168
34169 . ////////////////////////////////////////////////////////////////////////////
34170 . ////////////////////////////////////////////////////////////////////////////
34171
34172 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34173          "Exim as a non-queueing client"
34174 .cindex "client, non-queueing"
34175 .cindex "smart host" "suppressing queueing"
34176 On a personal computer, it is a common requirement for all
34177 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34178 configured to operate that way, for all the popular operating systems.
34179 However, there are some MUAs for Unix-like systems that cannot be so
34180 configured: they submit messages using the command line interface of
34181 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34182 messages this way.
34183
34184 If the personal computer runs continuously, there is no problem, because it can
34185 run a conventional MTA that handles delivery to the smart host, and deal with
34186 any delays via its queueing mechanism. However, if the computer does not run
34187 continuously or runs different operating systems at different times, queueing
34188 email is not desirable.
34189
34190 There is therefore a requirement for something that can provide the
34191 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34192 any queueing or retrying facilities. Furthermore, the delivery to the smart
34193 host should be synchronous, so that if it fails, the sending MUA is immediately
34194 informed. In other words, we want something that extends an MUA that submits
34195 to a local MTA via the command line so that it behaves like one that submits
34196 to a remote smart host using TCP/SMTP.
34197
34198 There are a number of applications (for example, there is one called &'ssmtp'&)
34199 that do this job. However, people have found them to be lacking in various
34200 ways. For instance, you might want to allow aliasing and forwarding to be done
34201 before sending a message to the smart host.
34202
34203 Exim already had the necessary infrastructure for doing this job. Just a few
34204 tweaks were needed to make it behave as required, though it is somewhat of an
34205 overkill to use a fully-featured MTA for this purpose.
34206
34207 .oindex "&%mua_wrapper%&"
34208 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34209 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34210 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34211 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34212 compatible router and transport configuration. Typically there will be just one
34213 router and one transport, sending everything to a smart host.
34214
34215 When run in MUA wrapping mode, the behaviour of Exim changes in the
34216 following ways:
34217
34218 .ilist
34219 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34220 In other words, the only way to submit messages is via the command line.
34221 .next
34222 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34223 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34224 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34225 does not finish until the delivery attempt is complete. If the delivery is
34226 successful, a zero return code is given.
34227 .next
34228 Address redirection is permitted, but the final routing for all addresses must
34229 be to the same remote transport, and to the same list of hosts. Furthermore,
34230 the return address (envelope sender) must be the same for all recipients, as
34231 must any added or deleted header lines. In other words, it must be possible to
34232 deliver the message in a single SMTP transaction, however many recipients there
34233 are.
34234 .next
34235 If these conditions are not met, or if routing any address results in a
34236 failure or defer status, or if Exim is unable to deliver all the recipients
34237 successfully to one of the smart hosts, delivery of the entire message fails.
34238 .next
34239 Because no queueing is allowed, all failures are treated as permanent; there
34240 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34241 smart host. Furthermore, because only a single yes/no response can be given to
34242 the caller, it is not possible to deliver to some recipients and not others. If
34243 there is an error (temporary or permanent) for any recipient, all are failed.
34244 .next
34245 If more than one smart host is listed, Exim will try another host after a
34246 connection failure or a timeout, in the normal way. However, if this kind of
34247 failure happens for all the hosts, the delivery fails.
34248 .next
34249 When delivery fails, an error message is written to the standard error stream
34250 (as well as to Exim's log), and Exim exits to the caller with a return code
34251 value 1. The message is expunged from Exim's spool files. No bounce messages
34252 are ever generated.
34253 .next
34254 No retry data is maintained, and any retry rules are ignored.
34255 .next
34256 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34257 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34258 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34259 .endlist
34260
34261 The overall effect is that Exim makes a single synchronous attempt to deliver
34262 the message, failing if there is any kind of problem. Because no local
34263 deliveries are done and no daemon can be run, Exim does not need root
34264 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34265 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34266 the advantages and disadvantages of running without root privilege.
34267
34268
34269
34270
34271 . ////////////////////////////////////////////////////////////////////////////
34272 . ////////////////////////////////////////////////////////////////////////////
34273
34274 .chapter "Log files" "CHAPlog"
34275 .scindex IIDloggen "log" "general description"
34276 .cindex "log" "types of"
34277 Exim writes three different logs, referred to as the main log, the reject log,
34278 and the panic log:
34279
34280 .ilist
34281 .cindex "main log"
34282 The main log records the arrival of each message and each delivery in a single
34283 line in each case. The format is as compact as possible, in an attempt to keep
34284 down the size of log files. Two-character flag sequences make it easy to pick
34285 out these lines. A number of other events are recorded in the main log. Some of
34286 them are optional, in which case the &%log_selector%& option controls whether
34287 they are included or not. A Perl script called &'eximstats'&, which does simple
34288 analysis of main log files, is provided in the Exim distribution (see section
34289 &<<SECTmailstat>>&).
34290 .next
34291 .cindex "reject log"
34292 The reject log records information from messages that are rejected as a result
34293 of a configuration option (that is, for policy reasons).
34294 The first line of each rejection is a copy of the line that is also written to
34295 the main log. Then, if the message's header has been read at the time the log
34296 is written, its contents are written to this log. Only the original header
34297 lines are available; header lines added by ACLs are not logged. You can use the
34298 reject log to check that your policy controls are working correctly; on a busy
34299 host this may be easier than scanning the main log for rejection messages. You
34300 can suppress the writing of the reject log by setting &%write_rejectlog%&
34301 false.
34302 .next
34303 .cindex "panic log"
34304 .cindex "system log"
34305 When certain serious errors occur, Exim writes entries to its panic log. If the
34306 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34307 are usually written to the main log as well, but can get lost amid the mass of
34308 other entries. The panic log should be empty under normal circumstances. It is
34309 therefore a good idea to check it (or to have a &'cron'& script check it)
34310 regularly, in order to become aware of any problems. When Exim cannot open its
34311 panic log, it tries as a last resort to write to the system log (syslog). This
34312 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34313 message itself is written at priority LOG_CRIT.
34314 .endlist
34315
34316 Every log line starts with a timestamp, in the format shown in the following
34317 example. Note that many of the examples shown in this chapter are line-wrapped.
34318 In the log file, this would be all on one line:
34319 .code
34320 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34321   by QUIT
34322 .endd
34323 By default, the timestamps are in the local timezone. There are two
34324 ways of changing this:
34325
34326 .ilist
34327 You can set the &%timezone%& option to a different time zone; in particular, if
34328 you set
34329 .code
34330 timezone = UTC
34331 .endd
34332 the timestamps will be in UTC (aka GMT).
34333 .next
34334 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34335 example:
34336 .code
34337 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34338 .endd
34339 .endlist
34340
34341 .cindex "log" "process ids in"
34342 .cindex "pid (process id)" "in log lines"
34343 Exim does not include its process id in log lines by default, but you can
34344 request that it does so by specifying the &`pid`& log selector (see section
34345 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34346 brackets, immediately after the time and date.
34347
34348
34349
34350
34351 .section "Where the logs are written" "SECTwhelogwri"
34352 .cindex "log" "destination"
34353 .cindex "log" "to file"
34354 .cindex "log" "to syslog"
34355 .cindex "syslog"
34356 The logs may be written to local files, or to syslog, or both. However, it
34357 should be noted that many syslog implementations use UDP as a transport, and
34358 are therefore unreliable in the sense that messages are not guaranteed to
34359 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34360 It has also been reported that on large log files (tens of megabytes) you may
34361 need to tweak syslog to prevent it syncing the file with each write &-- on
34362 Linux this has been seen to make syslog take 90% plus of CPU time.
34363
34364 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34365 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34366 configuration. This latter string is expanded, so it can contain, for example,
34367 references to the host name:
34368 .code
34369 log_file_path = /var/log/$primary_hostname/exim_%slog
34370 .endd
34371 It is generally advisable, however, to set the string in &_Local/Makefile_&
34372 rather than at run time, because then the setting is available right from the
34373 start of Exim's execution. Otherwise, if there's something it wants to log
34374 before it has read the configuration file (for example, an error in the
34375 configuration file) it will not use the path you want, and may not be able to
34376 log at all.
34377
34378 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34379 list, currently limited to at most two items. This is one option where the
34380 facility for changing a list separator may not be used. The list must always be
34381 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34382 otherwise the item must either be an absolute path, containing &`%s`& at the
34383 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34384 implying the use of a default path.
34385
34386 When Exim encounters an empty item in the list, it searches the list defined by
34387 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34388 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34389 mean &"use the path specified at build time"&. It no such item exists, log
34390 files are written in the &_log_& subdirectory of the spool directory. This is
34391 equivalent to the setting:
34392 .code
34393 log_file_path = $spool_directory/log/%slog
34394 .endd
34395 If you do not specify anything at build time or run time, that is where the
34396 logs are written.
34397
34398 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34399 are in use &-- see section &<<SECTdatlogfil>>& below.
34400
34401 Here are some examples of possible settings:
34402 .display
34403 &`LOG_FILE_PATH=syslog                    `& syslog only
34404 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34405 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34406 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34407 .endd
34408 If there are more than two paths in the list, the first is used and a panic
34409 error is logged.
34410
34411
34412
34413 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34414 .cindex "log" "cycling local files"
34415 .cindex "cycling logs"
34416 .cindex "&'exicyclog'&"
34417 .cindex "log" "local files; writing to"
34418 Some operating systems provide centralized and standardized methods for cycling
34419 log files. For those that do not, a utility script called &'exicyclog'& is
34420 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34421 main and reject logs each time it is called. The maximum number of old logs to
34422 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34423
34424 An Exim delivery process opens the main log when it first needs to write to it,
34425 and it keeps the file open in case subsequent entries are required &-- for
34426 example, if a number of different deliveries are being done for the same
34427 message. However, remote SMTP deliveries can take a long time, and this means
34428 that the file may be kept open long after it is renamed if &'exicyclog'& or
34429 something similar is being used to rename log files on a regular basis. To
34430 ensure that a switch of log files is noticed as soon as possible, Exim calls
34431 &[stat()]& on the main log's name before reusing an open file, and if the file
34432 does not exist, or its inode has changed, the old file is closed and Exim
34433 tries to open the main log from scratch. Thus, an old log file may remain open
34434 for quite some time, but no Exim processes should write to it once it has been
34435 renamed.
34436
34437
34438
34439 .section "Datestamped log files" "SECTdatlogfil"
34440 .cindex "log" "datestamped files"
34441 Instead of cycling the main and reject log files by renaming them
34442 periodically, some sites like to use files whose names contain a datestamp,
34443 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34444 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34445 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34446 point where the datestamp is required. For example:
34447 .code
34448 log_file_path = /var/spool/exim/log/%slog-%D
34449 log_file_path = /var/log/exim-%s-%D.log
34450 log_file_path = /var/spool/exim/log/%D-%slog
34451 log_file_path = /var/log/exim/%s.%M
34452 .endd
34453 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34454 examples of names generated by the above examples:
34455 .code
34456 /var/spool/exim/log/mainlog-20021225
34457 /var/log/exim-reject-20021225.log
34458 /var/spool/exim/log/20021225-mainlog
34459 /var/log/exim/main.200212
34460 .endd
34461 When this form of log file is specified, Exim automatically switches to new
34462 files at midnight. It does not make any attempt to compress old logs; you
34463 will need to write your own script if you require this. You should not
34464 run &'exicyclog'& with this form of logging.
34465
34466 The location of the panic log is also determined by &%log_file_path%&, but it
34467 is not datestamped, because rotation of the panic log does not make sense.
34468 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34469 the string. In addition, if it immediately follows a slash, a following
34470 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34471 character is removed. Thus, the four examples above would give these panic
34472 log names:
34473 .code
34474 /var/spool/exim/log/paniclog
34475 /var/log/exim-panic.log
34476 /var/spool/exim/log/paniclog
34477 /var/log/exim/panic
34478 .endd
34479
34480
34481 .section "Logging to syslog" "SECID249"
34482 .cindex "log" "syslog; writing to"
34483 The use of syslog does not change what Exim logs or the format of its messages,
34484 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34485 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34486 that, the same strings are written to syslog as to log files. The syslog
34487 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34488 by default, but you can change these by setting the &%syslog_facility%& and
34489 &%syslog_processname%& options, respectively. If Exim was compiled with
34490 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34491 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34492 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34493 the time and host name to each line.
34494 The three log streams are mapped onto syslog priorities as follows:
34495
34496 .ilist
34497 &'mainlog'& is mapped to LOG_INFO
34498 .next
34499 &'rejectlog'& is mapped to LOG_NOTICE
34500 .next
34501 &'paniclog'& is mapped to LOG_ALERT
34502 .endlist
34503
34504 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34505 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34506 these are routed by syslog to the same place. You can suppress this duplication
34507 by setting &%syslog_duplication%& false.
34508
34509 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34510 entries contain multiple lines when headers are included. To cope with both
34511 these cases, entries written to syslog are split into separate &[syslog()]&
34512 calls at each internal newline, and also after a maximum of
34513 870 data characters. (This allows for a total syslog line length of 1024, when
34514 additions such as timestamps are added.) If you are running a syslog
34515 replacement that can handle lines longer than the 1024 characters allowed by
34516 RFC 3164, you should set
34517 .code
34518 SYSLOG_LONG_LINES=yes
34519 .endd
34520 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34521 lines, but it still splits at internal newlines in &'reject'& log entries.
34522
34523 To make it easy to re-assemble split lines later, each component of a split
34524 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34525 where <&'n'&> is the component number and <&'m'&> is the total number of
34526 components in the entry. The / delimiter is used when the line was split
34527 because it was too long; if it was split because of an internal newline, the \
34528 delimiter is used. For example, supposing the length limit to be 50 instead of
34529 870, the following would be the result of a typical rejection message to
34530 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34531 name, and pid as added by syslog:
34532 .code
34533 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34534 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34535 [3/5]  when scanning for sender: missing or malformed lo
34536 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34537 [5/5] mple>)
34538 .endd
34539 The same error might cause the following lines to be written to &"rejectlog"&
34540 (LOG_NOTICE):
34541 .code
34542 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34543 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34544 [3/18] er when scanning for sender: missing or malformed
34545 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34546 [5\18] .example>)
34547 [6\18] Recipients: ph10@some.domain.cam.example
34548 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34549 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34550 [9\18]        id 16RdAL-0006pc-00
34551 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34552 [11\18] 09:43 +0100
34553 [12\18] F From: <>
34554 [13\18]   Subject: this is a test header
34555 [18\18]   X-something: this is another header
34556 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34557 [16\18] le>
34558 [17\18] B Bcc:
34559 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34560 .endd
34561 Log lines that are neither too long nor contain newlines are written to syslog
34562 without modification.
34563
34564 If only syslog is being used, the Exim monitor is unable to provide a log tail
34565 display, unless syslog is routing &'mainlog'& to a file on the local host and
34566 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34567 where it is.
34568
34569
34570
34571 .section "Log line flags" "SECID250"
34572 One line is written to the main log for each message received, and for each
34573 successful, unsuccessful, and delayed delivery. These lines can readily be
34574 picked out by the distinctive two-character flags that immediately follow the
34575 timestamp. The flags are:
34576 .display
34577 &`<=`&     message arrival
34578 &`=>`&     normal message delivery
34579 &`->`&     additional address in same delivery
34580 &`>>`&     cutthrough message delivery
34581 &`*>`&     delivery suppressed by &%-N%&
34582 &`**`&     delivery failed; address bounced
34583 &`==`&     delivery deferred; temporary problem
34584 .endd
34585
34586
34587 .section "Logging message reception" "SECID251"
34588 .cindex "log" "reception line"
34589 The format of the single-line entry in the main log that is written for every
34590 message received is shown in the basic example below, which is split over
34591 several lines in order to fit it on the page:
34592 .code
34593 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34594   H=mailer.fict.example [192.168.123.123] U=exim
34595   P=smtp S=5678 id=<incoming message id>
34596 .endd
34597 The address immediately following &"<="& is the envelope sender address. A
34598 bounce message is shown with the sender address &"<>"&, and if it is locally
34599 generated, this is followed by an item of the form
34600 .code
34601 R=<message id>
34602 .endd
34603 which is a reference to the message that caused the bounce to be sent.
34604
34605 .cindex "HELO"
34606 .cindex "EHLO"
34607 For messages from other hosts, the H and U fields identify the remote host and
34608 record the RFC 1413 identity of the user that sent the message, if one was
34609 received. The number given in square brackets is the IP address of the sending
34610 host. If there is a single, unparenthesized  host name in the H field, as
34611 above, it has been verified to correspond to the IP address (see the
34612 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34613 by the remote host in the SMTP HELO or EHLO command, and has not been
34614 verified. If verification yields a different name to that given for HELO or
34615 EHLO, the verified name appears first, followed by the HELO or EHLO
34616 name in parentheses.
34617
34618 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34619 without brackets, in the HELO or EHLO command, leading to entries in
34620 the log containing text like these examples:
34621 .code
34622 H=(10.21.32.43) [192.168.8.34]
34623 H=([10.21.32.43]) [192.168.8.34]
34624 .endd
34625 This can be confusing. Only the final address in square brackets can be relied
34626 on.
34627
34628 For locally generated messages (that is, messages not received over TCP/IP),
34629 the H field is omitted, and the U field contains the login name of the caller
34630 of Exim.
34631
34632 .cindex "authentication" "logging"
34633 .cindex "AUTH" "logging"
34634 For all messages, the P field specifies the protocol used to receive the
34635 message. This is the value that is stored in &$received_protocol$&. In the case
34636 of incoming SMTP messages, the value indicates whether or not any SMTP
34637 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34638 session was encrypted, there is an additional X field that records the cipher
34639 suite that was used.
34640
34641 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34642 hosts that have authenticated themselves using the SMTP AUTH command. The first
34643 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34644 there is an additional item A= followed by the name of the authenticator that
34645 was used. If an authenticated identification was set up by the authenticator's
34646 &%server_set_id%& option, this is logged too, separated by a colon from the
34647 authenticator name.
34648
34649 .cindex "size" "of message"
34650 The id field records the existing message id, if present. The size of the
34651 received message is given by the S field. When the message is delivered,
34652 headers may be removed or added, so that the size of delivered copies of the
34653 message may not correspond with this value (and indeed may be different to each
34654 other).
34655
34656 The &%log_selector%& option can be used to request the logging of additional
34657 data when a message is received. See section &<<SECTlogselector>>& below.
34658
34659
34660
34661 .section "Logging deliveries" "SECID252"
34662 .cindex "log" "delivery line"
34663 The format of the single-line entry in the main log that is written for every
34664 delivery is shown in one of the examples below, for local and remote
34665 deliveries, respectively. Each example has been split into two lines in order
34666 to fit it on the page:
34667 .code
34668 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34669   <marv@hitch.fict.example> R=localuser T=local_delivery
34670 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34671   monk@holistic.fict.example R=dnslookup T=remote_smtp
34672   H=holistic.fict.example [192.168.234.234]
34673 .endd
34674 For ordinary local deliveries, the original address is given in angle brackets
34675 after the final delivery address, which might be a pipe or a file. If
34676 intermediate address(es) exist between the original and the final address, the
34677 last of these is given in parentheses after the final address. The R and T
34678 fields record the router and transport that were used to process the address.
34679
34680 If SMTP AUTH was used for the delivery there is an additional item A=
34681 followed by the name of the authenticator that was used.
34682 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34683 option, this is logged too, separated by a colon from the authenticator name.
34684
34685 If a shadow transport was run after a successful local delivery, the log line
34686 for the successful delivery has an item added on the end, of the form
34687 .display
34688 &`ST=<`&&'shadow transport name'&&`>`&
34689 .endd
34690 If the shadow transport did not succeed, the error message is put in
34691 parentheses afterwards.
34692
34693 .cindex "asterisk" "after IP address"
34694 When more than one address is included in a single delivery (for example, two
34695 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34696 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34697 down a single SMTP connection, an asterisk follows the IP address in the log
34698 lines for the second and subsequent messages.
34699
34700 .cindex "delivery" "cutthrough; logging"
34701 .cindex "cutthrough" "logging"
34702 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34703 line precedes the reception line, since cutthrough waits for a possible
34704 rejection from the destination in case it can reject the sourced item.
34705
34706 The generation of a reply message by a filter file gets logged as a
34707 &"delivery"& to the addressee, preceded by &">"&.
34708
34709 The &%log_selector%& option can be used to request the logging of additional
34710 data when a message is delivered. See section &<<SECTlogselector>>& below.
34711
34712
34713 .section "Discarded deliveries" "SECID253"
34714 .cindex "discarded messages"
34715 .cindex "message" "discarded"
34716 .cindex "delivery" "discarded; logging"
34717 When a message is discarded as a result of the command &"seen finish"& being
34718 obeyed in a filter file which generates no deliveries, a log entry of the form
34719 .code
34720 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34721   <low.club@bridge.example> R=userforward
34722 .endd
34723 is written, to record why no deliveries are logged. When a message is discarded
34724 because it is aliased to &":blackhole:"& the log line is like this:
34725 .code
34726 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34727   <hole@nowhere.example> R=blackhole_router
34728 .endd
34729
34730
34731 .section "Deferred deliveries" "SECID254"
34732 When a delivery is deferred, a line of the following form is logged:
34733 .code
34734 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34735   R=dnslookup T=smtp defer (146): Connection refused
34736 .endd
34737 In the case of remote deliveries, the error is the one that was given for the
34738 last IP address that was tried. Details of individual SMTP failures are also
34739 written to the log, so the above line would be preceded by something like
34740 .code
34741 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34742   mail1.endrest.example [192.168.239.239]: Connection refused
34743 .endd
34744 When a deferred address is skipped because its retry time has not been reached,
34745 a message is written to the log, but this can be suppressed by setting an
34746 appropriate value in &%log_selector%&.
34747
34748
34749
34750 .section "Delivery failures" "SECID255"
34751 .cindex "delivery" "failure; logging"
34752 If a delivery fails because an address cannot be routed, a line of the
34753 following form is logged:
34754 .code
34755 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34756   <jim@trek99.example>: unknown mail domain
34757 .endd
34758 If a delivery fails at transport time, the router and transport are shown, and
34759 the response from the remote host is included, as in this example:
34760 .code
34761 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34762   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34763   after pipelined RCPT TO:<ace400@pb.example>: host
34764   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34765   <ace400@pb.example>...Addressee unknown
34766 .endd
34767 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34768 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34769 disabling PIPELINING. The log lines for all forms of delivery failure are
34770 flagged with &`**`&.
34771
34772
34773
34774 .section "Fake deliveries" "SECID256"
34775 .cindex "delivery" "fake; logging"
34776 If a delivery does not actually take place because the &%-N%& option has been
34777 used to suppress it, a normal delivery line is written to the log, except that
34778 &"=>"& is replaced by &"*>"&.
34779
34780
34781
34782 .section "Completion" "SECID257"
34783 A line of the form
34784 .code
34785 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34786 .endd
34787 is written to the main log when a message is about to be removed from the spool
34788 at the end of its processing.
34789
34790
34791
34792
34793 .section "Summary of Fields in Log Lines" "SECID258"
34794 .cindex "log" "summary of fields"
34795 A summary of the field identifiers that are used in log lines is shown in
34796 the following table:
34797 .display
34798 &`A   `&        authenticator name (and optional id and sender)
34799 &`C   `&        SMTP confirmation on delivery
34800 &`    `&        command list for &"no mail in SMTP session"&
34801 &`CV  `&        certificate verification status
34802 &`D   `&        duration of &"no mail in SMTP session"&
34803 &`DN  `&        distinguished name from peer certificate
34804 &`DT  `&        on &`=>`& lines: time taken for a delivery
34805 &`F   `&        sender address (on delivery lines)
34806 &`H   `&        host name and IP address
34807 &`I   `&        local interface used
34808 &`id  `&        message id for incoming message
34809 &`P   `&        on &`<=`& lines: protocol used
34810 &`    `&        on &`=>`& and &`**`& lines: return path
34811 &`QT  `&        on &`=>`& lines: time spent on queue so far
34812 &`    `&        on &"Completed"& lines: time spent on queue
34813 &`R   `&        on &`<=`& lines: reference for local bounce
34814 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34815 &`S   `&        size of message
34816 &`SNI `&        server name indication from TLS client hello
34817 &`ST  `&        shadow transport name
34818 &`T   `&        on &`<=`& lines: message subject (topic)
34819 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34820 &`U   `&        local user or RFC 1413 identity
34821 &`X   `&        TLS cipher suite
34822 .endd
34823
34824
34825 .section "Other log entries" "SECID259"
34826 Various other types of log entry are written from time to time. Most should be
34827 self-explanatory. Among the more common are:
34828
34829 .ilist
34830 .cindex "retry" "time not reached"
34831 &'retry time not reached'&&~&~An address previously suffered a temporary error
34832 during routing or local delivery, and the time to retry has not yet arrived.
34833 This message is not written to an individual message log file unless it happens
34834 during the first delivery attempt.
34835 .next
34836 &'retry time not reached for any host'&&~&~An address previously suffered
34837 temporary errors during remote delivery, and the retry time has not yet arrived
34838 for any of the hosts to which it is routed.
34839 .next
34840 .cindex "spool directory" "file locked"
34841 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34842 some other Exim process is already working on the message. This can be quite
34843 common if queue running processes are started at frequent intervals. The
34844 &'exiwhat'& utility script can be used to find out what Exim processes are
34845 doing.
34846 .next
34847 .cindex "error" "ignored"
34848 &'error ignored'&&~&~There are several circumstances that give rise to this
34849 message:
34850 .olist
34851 Exim failed to deliver a bounce message whose age was greater than
34852 &%ignore_bounce_errors_after%&. The bounce was discarded.
34853 .next
34854 A filter file set up a delivery using the &"noerror"& option, and the delivery
34855 failed. The delivery was discarded.
34856 .next
34857 A delivery set up by a router configured with
34858 . ==== As this is a nested list, any displays it contains must be indented
34859 . ==== as otherwise they are too far to the left.
34860 .code
34861     errors_to = <>
34862 .endd
34863 failed. The delivery was discarded.
34864 .endlist olist
34865 .endlist ilist
34866
34867
34868
34869
34870
34871 .section "Reducing or increasing what is logged" "SECTlogselector"
34872 .cindex "log" "selectors"
34873 By setting the &%log_selector%& global option, you can disable some of Exim's
34874 default logging, or you can request additional logging. The value of
34875 &%log_selector%& is made up of names preceded by plus or minus characters. For
34876 example:
34877 .code
34878 log_selector = +arguments -retry_defer
34879 .endd
34880 The list of optional log items is in the following table, with the default
34881 selection marked by asterisks:
34882 .display
34883 &` 8bitmime                   `&  received 8BITMIME status
34884 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34885 &` address_rewrite            `&  address rewriting
34886 &` all_parents                `&  all parents in => lines
34887 &` arguments                  `&  command line arguments
34888 &`*connection_reject          `&  connection rejections
34889 &`*delay_delivery             `&  immediate delivery delayed
34890 &` deliver_time               `&  time taken to perform delivery
34891 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34892 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34893 &`*etrn                       `&  ETRN commands
34894 &`*host_lookup_failed         `&  as it says
34895 &` ident_timeout              `&  timeout for ident connection
34896 &` incoming_interface         `&  incoming interface on <= lines
34897 &` incoming_port              `&  incoming port on <= lines
34898 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34899 &` outgoing_port              `&  add remote port to => lines
34900 &`*queue_run                  `&  start and end queue runs
34901 &` queue_time                 `&  time on queue for one recipient
34902 &` queue_time_overall         `&  time on queue for whole message
34903 &` pid                        `&  Exim process id
34904 &` received_recipients        `&  recipients on <= lines
34905 &` received_sender            `&  sender on <= lines
34906 &`*rejected_header            `&  header contents on reject log
34907 &`*retry_defer                `&  &"retry time not reached"&
34908 &` return_path_on_delivery    `&  put return path on => and ** lines
34909 &` sender_on_delivery         `&  add sender to => lines
34910 &`*sender_verify_fail         `&  sender verification failures
34911 &`*size_reject                `&  rejection because too big
34912 &`*skip_delivery              `&  delivery skipped in a queue run
34913 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34914 &` smtp_connection            `&  SMTP connections
34915 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34916 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34917 &` smtp_no_mail               `&  session with no MAIL commands
34918 &` smtp_protocol_error        `&  SMTP protocol errors
34919 &` smtp_syntax_error          `&  SMTP syntax errors
34920 &` subject                    `&  contents of &'Subject:'& on <= lines
34921 &`*tls_certificate_verified   `&  certificate verification status
34922 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34923 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34924 &` tls_sni                    `&  TLS SNI on <= lines
34925 &` unknown_in_list            `&  DNS lookup failed in list match
34926
34927 &` all                        `&  all of the above
34928 .endd
34929 More details on each of these items follows:
34930
34931 .ilist
34932 .cindex "8BITMIME"
34933 .cindex "log" "8BITMIME"
34934 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34935 which may help in tracking down interoperability issues with ancient MTAs
34936 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34937 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34938 &`7BIT`& and &`8BITMIME`& respectively.
34939 .next
34940 .cindex "&%warn%& ACL verb" "log when skipping"
34941 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34942 its conditions cannot be evaluated, a log line to this effect is written if
34943 this log selector is set.
34944 .next
34945 .cindex "log" "rewriting"
34946 .cindex "rewriting" "logging"
34947 &%address_rewrite%&: This applies both to global rewrites and per-transport
34948 rewrites, but not to rewrites in filters run as an unprivileged user (because
34949 such users cannot access the log).
34950 .next
34951 .cindex "log" "full parentage"
34952 &%all_parents%&: Normally only the original and final addresses are logged on
34953 delivery lines; with this selector, intermediate parents are given in
34954 parentheses between them.
34955 .next
34956 .cindex "log" "Exim arguments"
34957 .cindex "Exim arguments, logging"
34958 &%arguments%&: This causes Exim to write the arguments with which it was called
34959 to the main log, preceded by the current working directory. This is a debugging
34960 feature, added to make it easier to find out how certain MUAs call
34961 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34962 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34963 that are empty or that contain white space are quoted. Non-printing characters
34964 are shown as escape sequences. This facility cannot log unrecognized arguments,
34965 because the arguments are checked before the configuration file is read. The
34966 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34967 between the caller and Exim.
34968 .next
34969 .cindex "log" "connection rejections"
34970 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34971 connection is rejected, for whatever reason.
34972 .next
34973 .cindex "log" "delayed delivery"
34974 .cindex "delayed delivery, logging"
34975 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34976 started for an incoming message because the load is too high or too many
34977 messages were received on one connection. Logging does not occur if no delivery
34978 process is started because &%queue_only%& is set or &%-odq%& was used.
34979 .next
34980 .cindex "log" "delivery duration"
34981 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34982 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34983 .next
34984 .cindex "log" "message size on delivery"
34985 .cindex "size" "of message"
34986 &%delivery_size%&: For each delivery, the size of message delivered is added to
34987 the &"=>"& line, tagged with S=.
34988 .next
34989 .cindex "log" "dnslist defer"
34990 .cindex "DNS list" "logging defer"
34991 .cindex "black list (DNS)"
34992 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34993 DNS black list suffers a temporary error.
34994 .next
34995 .cindex "log" "ETRN commands"
34996 .cindex "ETRN" "logging"
34997 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34998 is run to determine whether or not it is actually accepted. An invalid ETRN
34999 command, or one received within a message transaction is not logged by this
35000 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35001 .next
35002 .cindex "log" "host lookup failure"
35003 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35004 any addresses, or when a lookup of an IP address fails to find a host name, a
35005 log line is written. This logging does not apply to direct DNS lookups when
35006 routing email addresses, but it does apply to &"byname"& lookups.
35007 .next
35008 .cindex "log" "ident timeout"
35009 .cindex "RFC 1413" "logging timeout"
35010 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35011 client's ident port times out.
35012 .next
35013 .cindex "log" "incoming interface"
35014 .cindex "interface" "logging"
35015 &%incoming_interface%&: The interface on which a message was received is added
35016 to the &"<="& line as an IP address in square brackets, tagged by I= and
35017 followed by a colon and the port number. The local interface and port are also
35018 added to other SMTP log lines, for example &"SMTP connection from"&, and to
35019 rejection lines.
35020 .next
35021 .cindex "log" "incoming remote port"
35022 .cindex "port" "logging remote"
35023 .cindex "TCP/IP" "logging incoming remote port"
35024 .vindex "&$sender_fullhost$&"
35025 .vindex "&$sender_rcvhost$&"
35026 &%incoming_port%&: The remote port number from which a message was received is
35027 added to log entries and &'Received:'& header lines, following the IP address
35028 in square brackets, and separated from it by a colon. This is implemented by
35029 changing the value that is put in the &$sender_fullhost$& and
35030 &$sender_rcvhost$& variables. Recording the remote port number has become more
35031 important with the widening use of NAT (see RFC 2505).
35032 .next
35033 .cindex "log" "dropped connection"
35034 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35035 connection is unexpectedly dropped.
35036 .next
35037 .cindex "log" "outgoing remote port"
35038 .cindex "port" "logging outgoint remote"
35039 .cindex "TCP/IP" "logging ougtoing remote port"
35040 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35041 containing => tags) following the IP address. This option is not included in
35042 the default setting, because for most ordinary configurations, the remote port
35043 number is always 25 (the SMTP port).
35044 .next
35045 .cindex "log" "process ids in"
35046 .cindex "pid (process id)" "in log lines"
35047 &%pid%&: The current process id is added to every log line, in square brackets,
35048 immediately after the time and date.
35049 .next
35050 .cindex "log" "queue run"
35051 .cindex "queue runner" "logging"
35052 &%queue_run%&: The start and end of every queue run are logged.
35053 .next
35054 .cindex "log" "queue time"
35055 &%queue_time%&: The amount of time the message has been in the queue on the
35056 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35057 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35058 includes reception time as well as the delivery time for the current address.
35059 This means that it may be longer than the difference between the arrival and
35060 delivery log line times, because the arrival log line is not written until the
35061 message has been successfully received.
35062 .next
35063 &%queue_time_overall%&: The amount of time the message has been in the queue on
35064 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35065 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35066 message, so it includes reception time as well as the total delivery time.
35067 .next
35068 .cindex "log" "recipients"
35069 &%received_recipients%&: The recipients of a message are listed in the main log
35070 as soon as the message is received. The list appears at the end of the log line
35071 that is written when a message is received, preceded by the word &"for"&. The
35072 addresses are listed after they have been qualified, but before any rewriting
35073 has taken place.
35074 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35075 in the list.
35076 .next
35077 .cindex "log" "sender reception"
35078 &%received_sender%&: The unrewritten original sender of a message is added to
35079 the end of the log line that records the message's arrival, after the word
35080 &"from"& (before the recipients if &%received_recipients%& is also set).
35081 .next
35082 .cindex "log" "header lines for rejection"
35083 &%rejected_header%&: If a message's header has been received at the time a
35084 rejection is written to the reject log, the complete header is added to the
35085 log. Header logging can be turned off individually for messages that are
35086 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35087 .next
35088 .cindex "log" "retry defer"
35089 &%retry_defer%&: A log line is written if a delivery is deferred because a
35090 retry time has not yet been reached. However, this &"retry time not reached"&
35091 message is always omitted from individual message logs after the first delivery
35092 attempt.
35093 .next
35094 .cindex "log" "return path"
35095 &%return_path_on_delivery%&: The return path that is being transmitted with
35096 the message is included in delivery and bounce lines, using the tag P=.
35097 This is omitted if no delivery actually happens, for example, if routing fails,
35098 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35099 .next
35100 .cindex "log" "sender on delivery"
35101 &%sender_on_delivery%&: The message's sender address is added to every delivery
35102 and bounce line, tagged by F= (for &"from"&).
35103 This is the original sender that was received with the message; it is not
35104 necessarily the same as the outgoing return path.
35105 .next
35106 .cindex "log" "sender verify failure"
35107 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35108 gives details of a sender verification failure is not written. Log lines for
35109 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35110 detail is lost.
35111 .next
35112 .cindex "log" "size rejection"
35113 &%size_reject%&: A log line is written whenever a message is rejected because
35114 it is too big.
35115 .next
35116 .cindex "log" "frozen messages; skipped"
35117 .cindex "frozen messages" "logging skipping"
35118 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35119 queue run because it is frozen or because another process is already delivering
35120 it.
35121 .cindex "&""spool file is locked""&"
35122 The message that is written is &"spool file is locked"&.
35123 .next
35124 .cindex "log" "smtp confirmation"
35125 .cindex "SMTP" "logging confirmation"
35126 .cindex "LMTP" "logging confirmation"
35127 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35128 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35129 A number of MTAs (including Exim) return an identifying string in this
35130 response.
35131 .next
35132 .cindex "log" "SMTP connections"
35133 .cindex "SMTP" "logging connections"
35134 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35135 established or closed, unless the connection is from a host that matches
35136 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35137 only when the closure is unexpected.) This applies to connections from local
35138 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35139 dropped in the middle of a message, a log line is always written, whether or
35140 not this selector is set, but otherwise nothing is written at the start and end
35141 of connections unless this selector is enabled.
35142
35143 For TCP/IP connections to an Exim daemon, the current number of connections is
35144 included in the log message for each new connection, but note that the count is
35145 reset if the daemon is restarted.
35146 Also, because connections are closed (and the closure is logged) in
35147 subprocesses, the count may not include connections that have been closed but
35148 whose termination the daemon has not yet noticed. Thus, while it is possible to
35149 match up the opening and closing of connections in the log, the value of the
35150 logged counts may not be entirely accurate.
35151 .next
35152 .cindex "log" "SMTP transaction; incomplete"
35153 .cindex "SMTP" "logging incomplete transactions"
35154 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35155 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35156 and the message sender plus any accepted recipients are included in the log
35157 line. This can provide evidence of dictionary attacks.
35158 .next
35159 .cindex "log" "non-MAIL SMTP sessions"
35160 .cindex "MAIL" "logging session without"
35161 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35162 connection terminates without having issued a MAIL command. This includes both
35163 the case when the connection is dropped, and the case when QUIT is used. It
35164 does not include cases where the connection is rejected right at the start (by
35165 an ACL, or because there are too many connections, or whatever). These cases
35166 already have their own log lines.
35167
35168 The log line that is written contains the identity of the client in the usual
35169 way, followed by D= and a time, which records the duration of the connection.
35170 If the connection was authenticated, this fact is logged exactly as it is for
35171 an incoming message, with an A= item. If the connection was encrypted, CV=,
35172 DN=, and X= items may appear as they do for an incoming message, controlled by
35173 the same logging options.
35174
35175 Finally, if any SMTP commands were issued during the connection, a C= item
35176 is added to the line, listing the commands that were used. For example,
35177 .code
35178 C=EHLO,QUIT
35179 .endd
35180 shows that the client issued QUIT straight after EHLO. If there were fewer
35181 than 20 commands, they are all listed. If there were more than 20 commands,
35182 the last 20 are listed, preceded by &"..."&. However, with the default
35183 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35184 have been aborted before 20 non-mail commands are processed.
35185 .next
35186 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35187 colon-separated, is appended to the A= item for a message arrival or delivery
35188 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35189 was accepted or used.
35190 .next
35191 .cindex "log" "SMTP protocol error"
35192 .cindex "SMTP" "logging protocol error"
35193 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35194 encountered. Exim does not have perfect detection of all protocol errors
35195 because of transmission delays and the use of pipelining. If PIPELINING has
35196 been advertised to a client, an Exim server assumes that the client will use
35197 it, and therefore it does not count &"expected"& errors (for example, RCPT
35198 received after rejecting MAIL) as protocol errors.
35199 .next
35200 .cindex "SMTP" "logging syntax errors"
35201 .cindex "SMTP" "syntax errors; logging"
35202 .cindex "SMTP" "unknown command; logging"
35203 .cindex "log" "unknown SMTP command"
35204 .cindex "log" "SMTP syntax error"
35205 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35206 encountered. An unrecognized command is treated as a syntax error. For an
35207 external connection, the host identity is given; for an internal connection
35208 using &%-bs%& the sender identification (normally the calling user) is given.
35209 .next
35210 .cindex "log" "subject"
35211 .cindex "subject, logging"
35212 &%subject%&: The subject of the message is added to the arrival log line,
35213 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35214 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35215 specifies whether characters with values greater than 127 should be logged
35216 unchanged, or whether they should be rendered as escape sequences.
35217 .next
35218 .cindex "log" "certificate verification"
35219 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35220 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35221 verified, and &`CV=no`& if not.
35222 .next
35223 .cindex "log" "TLS cipher"
35224 .cindex "TLS" "logging cipher"
35225 &%tls_cipher%&: When a message is sent or received over an encrypted
35226 connection, the cipher suite used is added to the log line, preceded by X=.
35227 .next
35228 .cindex "log" "TLS peer DN"
35229 .cindex "TLS" "logging peer DN"
35230 &%tls_peerdn%&: When a message is sent or received over an encrypted
35231 connection, and a certificate is supplied by the remote host, the peer DN is
35232 added to the log line, preceded by DN=.
35233 .next
35234 .cindex "log" "TLS SNI"
35235 .cindex "TLS" "logging SNI"
35236 &%tls_sni%&: When a message is received over an encrypted connection, and
35237 the remote host provided the Server Name Indication extension, the SNI is
35238 added to the log line, preceded by SNI=.
35239 .next
35240 .cindex "log" "DNS failure in list"
35241 &%unknown_in_list%&: This setting causes a log entry to be written when the
35242 result of a list match is failure because a DNS lookup failed.
35243 .endlist
35244
35245
35246 .section "Message log" "SECID260"
35247 .cindex "message" "log file for"
35248 .cindex "log" "message log; description of"
35249 .cindex "&_msglog_& directory"
35250 .oindex "&%preserve_message_logs%&"
35251 In addition to the general log files, Exim writes a log file for each message
35252 that it handles. The names of these per-message logs are the message ids, and
35253 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35254 message log contains copies of the log lines that apply to the message. This
35255 makes it easier to inspect the status of an individual message without having
35256 to search the main log. A message log is deleted when processing of the message
35257 is complete, unless &%preserve_message_logs%& is set, but this should be used
35258 only with great care because they can fill up your disk very quickly.
35259
35260 On a heavily loaded system, it may be desirable to disable the use of
35261 per-message logs, in order to reduce disk I/O. This can be done by setting the
35262 &%message_logs%& option false.
35263 .ecindex IIDloggen
35264
35265
35266
35267
35268 . ////////////////////////////////////////////////////////////////////////////
35269 . ////////////////////////////////////////////////////////////////////////////
35270
35271 .chapter "Exim utilities" "CHAPutils"
35272 .scindex IIDutils "utilities"
35273 A number of utility scripts and programs are supplied with Exim and are
35274 described in this chapter. There is also the Exim Monitor, which is covered in
35275 the next chapter. The utilities described here are:
35276
35277 .itable none 0 0 3  7* left  15* left  40* left
35278 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35279   "list what Exim processes are doing"
35280 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35281 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35282 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35283 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35284                                                 various criteria"
35285 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35286 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35287   "extract statistics from the log"
35288 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35289   "check address acceptance from given IP"
35290 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35291 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35292 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35293 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35294 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35295 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35296 .endtable
35297
35298 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35299 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35300 &url(http://duncanthrax.net/exilog/) for details.
35301
35302
35303
35304
35305 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35306 .cindex "&'exiwhat'&"
35307 .cindex "process, querying"
35308 .cindex "SIGUSR1"
35309 On operating systems that can restart a system call after receiving a signal
35310 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35311 a line describing what it is doing to the file &_exim-process.info_& in the
35312 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35313 processes it can find, having first emptied the file. It then waits for one
35314 second to allow the Exim processes to react before displaying the results. In
35315 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35316 send the signal to the Exim processes, so it is normally run as root.
35317
35318 &*Warning*&: This is not an efficient process. It is intended for occasional
35319 use by system administrators. It is not sensible, for example, to set up a
35320 script that sends SIGUSR1 signals to Exim processes at short intervals.
35321
35322
35323 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35324 varies in different operating systems. Not only are different options used,
35325 but the format of the output is different. For this reason, there are some
35326 system configuration options that configure exactly how &'exiwhat'& works. If
35327 it doesn't seem to be working for you, check the following compile-time
35328 options:
35329 .display
35330 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35331 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35332 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35333 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35334 .endd
35335 An example of typical output from &'exiwhat'& is
35336 .code
35337 164 daemon: -q1h, listening on port 25
35338 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35339 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35340   [10.19.42.42] (editor@ref.example)
35341 10592 handling incoming call from [192.168.243.242]
35342 10628 accepting a local non-SMTP message
35343 .endd
35344 The first number in the output line is the process number. The third line has
35345 been split here, in order to fit it on the page.
35346
35347
35348
35349 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35350 .cindex "&'exiqgrep'&"
35351 .cindex "queue" "grepping"
35352 This utility is a Perl script contributed by Matt Hubbard. It runs
35353 .code
35354 exim -bpu
35355 .endd
35356 or (in case &*-a*& switch is specified)
35357 .code
35358 exim -bp
35359 .endd
35360 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35361 contain alternate exim configuration the queue management might be using.
35362
35363 to obtain a queue listing, and then greps the output to select messages 
35364 that match given criteria. The following selection options are available:
35365
35366 .vlist
35367 .vitem &*-f*&&~<&'regex'&>
35368 Match the sender address using a case-insensitive search. The field that is
35369 tested is enclosed in angle brackets, so you can test for bounce messages with
35370 .code
35371 exiqgrep -f '^<>$'
35372 .endd
35373 .vitem &*-r*&&~<&'regex'&>
35374 Match a recipient address using a case-insensitve search. The field that is
35375 tested is not enclosed in angle brackets.
35376
35377 .vitem &*-s*&&~<&'regex'&>
35378 Match against the size field.
35379
35380 .vitem &*-y*&&~<&'seconds'&>
35381 Match messages that are younger than the given time.
35382
35383 .vitem &*-o*&&~<&'seconds'&>
35384 Match messages that are older than the given time.
35385
35386 .vitem &*-z*&
35387 Match only frozen messages.
35388
35389 .vitem &*-x*&
35390 Match only non-frozen messages.
35391 .endlist
35392
35393 The following options control the format of the output:
35394
35395 .vlist
35396 .vitem &*-c*&
35397 Display only the count of matching messages.
35398
35399 .vitem &*-l*&
35400 Long format &-- display the full message information as output by Exim. This is
35401 the default.
35402
35403 .vitem &*-i*&
35404 Display message ids only.
35405
35406 .vitem &*-b*&
35407 Brief format &-- one line per message.
35408
35409 .vitem &*-R*&
35410 Display messages in reverse order.
35411
35412 .vitem &*-a*&
35413 Include delivered recipients in queue listing.
35414 .endlist
35415
35416 There is one more option, &%-h%&, which outputs a list of options.
35417
35418
35419
35420 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35421 .cindex "&'exiqsumm'&"
35422 .cindex "queue" "summary"
35423 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35424 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35425 running a command such as
35426 .code
35427 exim -bp | exiqsumm
35428 .endd
35429 The output consists of one line for each domain that has messages waiting for
35430 it, as in the following example:
35431 .code
35432 3   2322   74m   66m  msn.com.example
35433 .endd
35434 Each line lists the number of pending deliveries for a domain, their total
35435 volume, and the length of time that the oldest and the newest messages have
35436 been waiting. Note that the number of pending deliveries is greater than the
35437 number of messages when messages have more than one recipient.
35438
35439 A summary line is output at the end. By default the output is sorted on the
35440 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35441 the output to be sorted by oldest message and by count of messages,
35442 respectively. There are also three options that split the messages for each
35443 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35444 separates frozen messages, and &%-s%& separates messages according to their
35445 sender.
35446
35447 The output of &'exim -bp'& contains the original addresses in the message, so
35448 this also applies to the output from &'exiqsumm'&. No domains from addresses
35449 generated by aliasing or forwarding are included (unless the &%one_time%&
35450 option of the &(redirect)& router has been used to convert them into &"top
35451 level"& addresses).
35452
35453
35454
35455
35456 .section "Extracting specific information from the log (exigrep)" &&&
35457          "SECTextspeinf"
35458 .cindex "&'exigrep'&"
35459 .cindex "log" "extracts; grepping for"
35460 The &'exigrep'& utility is a Perl script that searches one or more main log
35461 files for entries that match a given pattern. When it finds a match, it
35462 extracts all the log entries for the relevant message, not just those that
35463 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35464 given message, or all mail for a given user, or for a given host, for example.
35465 The input files can be in Exim log format or syslog format.
35466 If a matching log line is not associated with a specific message, it is
35467 included in &'exigrep'&'s output without any additional lines. The usage is:
35468 .new
35469 .display
35470 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35471 .endd
35472 .wen
35473 If no log file names are given on the command line, the standard input is read.
35474
35475 The &%-t%& argument specifies a number of seconds. It adds an additional
35476 condition for message selection. Messages that are complete are shown only if
35477 they spent more than <&'n'&> seconds on the queue.
35478
35479 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35480 makes it case-sensitive. This may give a performance improvement when searching
35481 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35482 option; with &%-I%& they do not. In both cases it is possible to change the
35483 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35484
35485 The &%-l%& option means &"literal"&, that is, treat all characters in the
35486 pattern as standing for themselves. Otherwise the pattern must be a Perl
35487 regular expression.
35488
35489 The &%-v%& option inverts the matching condition. That is, a line is selected
35490 if it does &'not'& match the pattern.
35491
35492 .new
35493 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35494 that are generated as a result/response to a message that &'exigrep'& matched
35495 normally.
35496
35497 Example of &%-M%&:
35498 user_a sends a message to user_b, which generates a bounce back to user_b. If
35499 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35500 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35501 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35502 when searching for &"user_a"& will show both messages since the bounce is
35503 &"related"& to or a &"result"& of the first message that was found by the
35504 search term.
35505 .wen
35506
35507 If the location of a &'zcat'& command is known from the definition of
35508 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35509 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35510
35511
35512 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35513 .cindex "&'exipick'&"
35514 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35515 lists messages from the queue according to a variety of criteria. For details
35516 of &'exipick'&'s facilities, visit the web page at
35517 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35518 the &%--help%& option.
35519
35520
35521 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35522 .cindex "log" "cycling local files"
35523 .cindex "cycling logs"
35524 .cindex "&'exicyclog'&"
35525 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35526 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35527 you are using log files with datestamps in their names (see section
35528 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35529 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35530 There are two command line options for &'exicyclog'&:
35531 .ilist
35532 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35533 default that is set when Exim is built. The default default is 10.
35534 .next
35535 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35536 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35537 overriding the script's default, which is to find the setting from Exim's
35538 configuration.
35539 .endlist
35540
35541 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35542 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35543 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35544 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35545 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35546 logs are handled similarly.
35547
35548 If the limit is greater than 99, the script uses 3-digit numbers such as
35549 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35550 to one that is greater, or &'vice versa'&, you will have to fix the names of
35551 any existing log files.
35552
35553 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35554 the end are deleted. All files with numbers greater than 01 are compressed,
35555 using a compression command which is configured by the COMPRESS_COMMAND
35556 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35557 root &%crontab%& entry of the form
35558 .code
35559 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35560 .endd
35561 assuming you have used the name &"exim"& for the Exim user. You can run
35562 &'exicyclog'& as root if you wish, but there is no need.
35563
35564
35565
35566 .section "Mail statistics (eximstats)" "SECTmailstat"
35567 .cindex "statistics"
35568 .cindex "&'eximstats'&"
35569 A Perl script called &'eximstats'& is provided for extracting statistical
35570 information from log files. The output is either plain text, or HTML.
35571 Exim log files are also supported by the &'Lire'& system produced by the
35572 LogReport Foundation &url(http://www.logreport.org).
35573
35574 The &'eximstats'& script has been hacked about quite a bit over time. The
35575 latest version is the result of some extensive revision by Steve Campbell. A
35576 lot of information is given by default, but there are options for suppressing
35577 various parts of it. Following any options, the arguments to the script are a
35578 list of files, which should be main log files. For example:
35579 .code
35580 eximstats -nr /var/spool/exim/log/mainlog.01
35581 .endd
35582 By default, &'eximstats'& extracts information about the number and volume of
35583 messages received from or delivered to various hosts. The information is sorted
35584 both by message count and by volume, and the top fifty hosts in each category
35585 are listed on the standard output. Similar information, based on email
35586 addresses or domains instead of hosts can be requested by means of various
35587 options. For messages delivered and received locally, similar statistics are
35588 also produced per user.
35589
35590 The output also includes total counts and statistics about delivery errors, and
35591 histograms showing the number of messages received and deliveries made in each
35592 hour of the day. A delivery with more than one address in its envelope (for
35593 example, an SMTP transaction with more than one RCPT command) is counted
35594 as a single delivery by &'eximstats'&.
35595
35596 Though normally more deliveries than receipts are reported (as messages may
35597 have multiple recipients), it is possible for &'eximstats'& to report more
35598 messages received than delivered, even though the queue is empty at the start
35599 and end of the period in question. If an incoming message contains no valid
35600 recipients, no deliveries are recorded for it. A bounce message is handled as
35601 an entirely separate message.
35602
35603 &'eximstats'& always outputs a grand total summary giving the volume and number
35604 of messages received and deliveries made, and the number of hosts involved in
35605 each case. It also outputs the number of messages that were delayed (that is,
35606 not completely delivered at the first attempt), and the number that had at
35607 least one address that failed.
35608
35609 The remainder of the output is in sections that can be independently disabled
35610 or modified by various options. It consists of a summary of deliveries by
35611 transport, histograms of messages received and delivered per time interval
35612 (default per hour), information about the time messages spent on the queue,
35613 a list of relayed messages, lists of the top fifty sending hosts, local
35614 senders, destination hosts, and destination local users by count and by volume,
35615 and a list of delivery errors that occurred.
35616
35617 The relay information lists messages that were actually relayed, that is, they
35618 came from a remote host and were directly delivered to some other remote host,
35619 without being processed (for example, for aliasing or forwarding) locally.
35620
35621 There are quite a few options for &'eximstats'& to control exactly what it
35622 outputs. These are documented in the Perl script itself, and can be extracted
35623 by running the command &(perldoc)& on the script. For example:
35624 .code
35625 perldoc /usr/exim/bin/eximstats
35626 .endd
35627
35628 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35629 .cindex "&'exim_checkaccess'&"
35630 .cindex "policy control" "checking access"
35631 .cindex "checking access"
35632 The &%-bh%& command line argument allows you to run a fake SMTP session with
35633 debugging output, in order to check what Exim is doing when it is applying
35634 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35635 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35636 sometimes you just want to answer the question &"Does this address have
35637 access?"& without bothering with any further details.
35638
35639 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35640 two arguments, an IP address and an email address:
35641 .code
35642 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35643 .endd
35644 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35645 given email address would be accepted in a RCPT command in a TCP/IP
35646 connection from the host with the given IP address. The output of the utility
35647 is either the word &"accepted"&, or the SMTP error response, for example:
35648 .code
35649 Rejected:
35650 550 Relay not permitted
35651 .endd
35652 When running this test, the utility uses &`<>`& as the envelope sender address
35653 for the MAIL command, but you can change this by providing additional
35654 options. These are passed directly to the Exim command. For example, to specify
35655 that the test is to be run with the sender address &'himself@there.example'&
35656 you can use:
35657 .code
35658 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35659                  -f himself@there.example
35660 .endd
35661 Note that these additional Exim command line items must be given after the two
35662 mandatory arguments.
35663
35664 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35665 while running its checks. You can run checks that include callouts by using
35666 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35667
35668
35669
35670 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35671 .cindex "DBM" "building dbm files"
35672 .cindex "building DBM files"
35673 .cindex "&'exim_dbmbuild'&"
35674 .cindex "lower casing"
35675 .cindex "binary zero" "in lookup key"
35676 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35677 the format used by the &(lsearch)& lookup (see section
35678 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35679 names as keys and the remainder of the information as data. The lower-casing
35680 can be prevented by calling the program with the &%-nolc%& option.
35681
35682 A terminating zero is included as part of the key string. This is expected by
35683 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35684 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35685 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35686 files.
35687
35688 The program requires two arguments: the name of the input file (which can be a
35689 single hyphen to indicate the standard input), and the name of the output file.
35690 It creates the output under a temporary name, and then renames it if all went
35691 well.
35692
35693 .cindex "USE_DB"
35694 If the native DB interface is in use (USE_DB is set in a compile-time
35695 configuration file &-- this is common in free versions of Unix) the two file
35696 names must be different, because in this mode the Berkeley DB functions create
35697 a single output file using exactly the name given. For example,
35698 .code
35699 exim_dbmbuild /etc/aliases /etc/aliases.db
35700 .endd
35701 reads the system alias file and creates a DBM version of it in
35702 &_/etc/aliases.db_&.
35703
35704 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35705 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35706 environment, the suffixes are added to the second argument of
35707 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35708 when the Berkeley functions are used in compatibility mode (though this is not
35709 recommended), because in that case it adds a &_.db_& suffix to the file name.
35710
35711 If a duplicate key is encountered, the program outputs a warning, and when it
35712 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35713 option is used. By default, only the first of a set of duplicates is used &--
35714 this makes it compatible with &(lsearch)& lookups. There is an option
35715 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35716 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35717 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35718 return code is 2.
35719
35720
35721
35722
35723 .section "Finding individual retry times (exinext)" "SECTfinindret"
35724 .cindex "retry" "times"
35725 .cindex "&'exinext'&"
35726 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35727 fish specific information out of the retry database. Given a mail domain (or a
35728 complete address), it looks up the hosts for that domain, and outputs any retry
35729 information for the hosts or for the domain. At present, the retry information
35730 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35731 output. For example:
35732 .code
35733 $ exinext piglet@milne.fict.example
35734 kanga.milne.example:192.168.8.1 error 146: Connection refused
35735   first failed: 21-Feb-1996 14:57:34
35736   last tried:   21-Feb-1996 14:57:34
35737   next try at:  21-Feb-1996 15:02:34
35738 roo.milne.example:192.168.8.3 error 146: Connection refused
35739   first failed: 20-Jan-1996 13:12:08
35740   last tried:   21-Feb-1996 11:42:03
35741   next try at:  21-Feb-1996 19:42:03
35742   past final cutoff time
35743 .endd
35744 You can also give &'exinext'& a local part, without a domain, and it
35745 will give any retry information for that local part in your default domain.
35746 A message id can be used to obtain retry information pertaining to a specific
35747 message. This exists only when an attempt to deliver a message to a remote host
35748 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35749 &'exinext'& is not particularly efficient, but then it is not expected to be
35750 run very often.
35751
35752 The &'exinext'& utility calls Exim to find out information such as the location
35753 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35754 passed on to the &'exim'& commands. The first specifies an alternate Exim
35755 configuration file, and the second sets macros for use within the configuration
35756 file. These features are mainly to help in testing, but might also be useful in
35757 environments where more than one configuration file is in use.
35758
35759
35760
35761 .section "Hints database maintenance" "SECThindatmai"
35762 .cindex "hints database" "maintenance"
35763 .cindex "maintaining Exim's hints database"
35764 Three utility programs are provided for maintaining the DBM files that Exim
35765 uses to contain its delivery hint information. Each program requires two
35766 arguments. The first specifies the name of Exim's spool directory, and the
35767 second is the name of the database it is to operate on. These are as follows:
35768
35769 .ilist
35770 &'retry'&: the database of retry information
35771 .next
35772 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35773 for remote hosts
35774 .next
35775 &'callout'&: the callout cache
35776 .next
35777 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35778 .next
35779 &'misc'&: other hints data
35780 .endlist
35781
35782 The &'misc'& database is used for
35783
35784 .ilist
35785 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35786 .next
35787 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35788 &(smtp)& transport)
35789 .endlist
35790
35791
35792
35793 .section "exim_dumpdb" "SECID261"
35794 .cindex "&'exim_dumpdb'&"
35795 The entire contents of a database are written to the standard output by the
35796 &'exim_dumpdb'& program, which has no options or arguments other than the
35797 spool and database names. For example, to dump the retry database:
35798 .code
35799 exim_dumpdb /var/spool/exim retry
35800 .endd
35801 Two lines of output are produced for each entry:
35802 .code
35803 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35804 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35805 .endd
35806 The first item on the first line is the key of the record. It starts with one
35807 of the letters R, or T, depending on whether it refers to a routing or
35808 transport retry. For a local delivery, the next part is the local address; for
35809 a remote delivery it is the name of the remote host, followed by its failing IP
35810 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35811 transport). If the remote port is not the standard one (port 25), it is added
35812 to the IP address. Then there follows an error code, an additional error code,
35813 and a textual description of the error.
35814
35815 The three times on the second line are the time of first failure, the time of
35816 the last delivery attempt, and the computed time for the next attempt. The line
35817 ends with an asterisk if the cutoff time for the last retry rule has been
35818 exceeded.
35819
35820 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35821 consists of a host name followed by a list of ids for messages that are or were
35822 waiting to be delivered to that host. If there are a very large number for any
35823 one host, continuation records, with a sequence number added to the host name,
35824 may be seen. The data in these records is often out of date, because a message
35825 may be routed to several alternative hosts, and Exim makes no effort to keep
35826 cross-references.
35827
35828
35829
35830 .section "exim_tidydb" "SECID262"
35831 .cindex "&'exim_tidydb'&"
35832 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35833 database. If run with no options, it removes all records that are more than 30
35834 days old. The age is calculated from the date and time that the record was last
35835 updated. Note that, in the case of the retry database, it is &'not'& the time
35836 since the first delivery failure. Information about a host that has been down
35837 for more than 30 days will remain in the database, provided that the record is
35838 updated sufficiently often.
35839
35840 The cutoff date can be altered by means of the &%-t%& option, which must be
35841 followed by a time. For example, to remove all records older than a week from
35842 the retry database:
35843 .code
35844 exim_tidydb -t 7d /var/spool/exim retry
35845 .endd
35846 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35847 message ids. In the former these appear as data in records keyed by host &--
35848 they were messages that were waiting for that host &-- and in the latter they
35849 are the keys for retry information for messages that have suffered certain
35850 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35851 message ids in database records are those of messages that are still on the
35852 queue. Message ids for messages that no longer exist are removed from
35853 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35854 For the &'retry'& database, records whose keys are non-existent message ids are
35855 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35856 whenever it removes information from the database.
35857
35858 Certain records are automatically removed by Exim when they are no longer
35859 needed, but others are not. For example, if all the MX hosts for a domain are
35860 down, a retry record is created for each one. If the primary MX host comes back
35861 first, its record is removed when Exim successfully delivers to it, but the
35862 records for the others remain because Exim has not tried to use those hosts.
35863
35864 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35865 hints databases. You should do this at a quiet time of day, because it requires
35866 a database to be locked (and therefore inaccessible to Exim) while it does its
35867 work. Removing records from a DBM file does not normally make the file smaller,
35868 but all the common DBM libraries are able to re-use the space that is released.
35869 After an initial phase of increasing in size, the databases normally reach a
35870 point at which they no longer get any bigger, as long as they are regularly
35871 tidied.
35872
35873 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35874 databases is likely to keep on increasing.
35875
35876
35877
35878
35879 .section "exim_fixdb" "SECID263"
35880 .cindex "&'exim_fixdb'&"
35881 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35882 Its main use is for testing Exim, but it might also be occasionally useful for
35883 getting round problems in a live system. It has no options, and its interface
35884 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35885 key of a database record can then be entered, and the data for that record is
35886 displayed.
35887
35888 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35889 except the &'retry'& database, that is the only operation that can be carried
35890 out. For the &'retry'& database, each field is output preceded by a number, and
35891 data for individual fields can be changed by typing the field number followed
35892 by new data, for example:
35893 .code
35894 > 4 951102:1000
35895 .endd
35896 resets the time of the next delivery attempt. Time values are given as a
35897 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35898 used as optional separators.
35899
35900
35901
35902
35903 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35904 .cindex "mailbox" "maintenance"
35905 .cindex "&'exim_lock'&"
35906 .cindex "locking mailboxes"
35907 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35908 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35909 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35910 a user agent while investigating a problem. The utility requires the name of
35911 the file as its first argument. If the locking is successful, the second
35912 argument is run as a command (using C's &[system()]& function); if there is no
35913 second argument, the value of the SHELL environment variable is used; if this
35914 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35915 is unlocked and the utility ends. The following options are available:
35916
35917 .vlist
35918 .vitem &%-fcntl%&
35919 Use &[fcntl()]& locking on the open mailbox.
35920
35921 .vitem &%-flock%&
35922 Use &[flock()]& locking on the open mailbox, provided the operating system
35923 supports it.
35924
35925 .vitem &%-interval%&
35926 This must be followed by a number, which is a number of seconds; it sets the
35927 interval to sleep between retries (default 3).
35928
35929 .vitem &%-lockfile%&
35930 Create a lock file before opening the mailbox.
35931
35932 .vitem &%-mbx%&
35933 Lock the mailbox using MBX rules.
35934
35935 .vitem &%-q%&
35936 Suppress verification output.
35937
35938 .vitem &%-retries%&
35939 This must be followed by a number; it sets the number of times to try to get
35940 the lock (default 10).
35941
35942 .vitem &%-restore_time%&
35943 This option causes &%exim_lock%& to restore the modified and read times to the
35944 locked file before exiting. This allows you to access a locked mailbox (for
35945 example, to take a backup copy) without disturbing the times that the user
35946 subsequently sees.
35947
35948 .vitem &%-timeout%&
35949 This must be followed by a number, which is a number of seconds; it sets a
35950 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35951 default), a non-blocking call is used.
35952
35953 .vitem &%-v%&
35954 Generate verbose output.
35955 .endlist
35956
35957 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35958 default is to create a lock file and also to use &[fcntl()]& locking on the
35959 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35960 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35961 requires that the directory containing the file be writeable. Locking by lock
35962 file does not last for ever; Exim assumes that a lock file is expired if it is
35963 more than 30 minutes old.
35964
35965 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35966 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35967 to be taken out on the open mailbox, and an exclusive lock on the file
35968 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35969 number of the mailbox file. When the locking is released, if an exclusive lock
35970 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35971
35972 The default output contains verification of the locking that takes place. The
35973 &%-v%& option causes some additional information to be given. The &%-q%& option
35974 suppresses all output except error messages.
35975
35976 A command such as
35977 .code
35978 exim_lock /var/spool/mail/spqr
35979 .endd
35980 runs an interactive shell while the file is locked, whereas
35981 .display
35982 &`exim_lock -q /var/spool/mail/spqr <<End`&
35983 <&'some commands'&>
35984 &`End`&
35985 .endd
35986 runs a specific non-interactive sequence of commands while the file is locked,
35987 suppressing all verification output. A single command can be run by a command
35988 such as
35989 .code
35990 exim_lock -q /var/spool/mail/spqr \
35991   "cp /var/spool/mail/spqr /some/where"
35992 .endd
35993 Note that if a command is supplied, it must be entirely contained within the
35994 second argument &-- hence the quotes.
35995 .ecindex IIDutils
35996
35997
35998 . ////////////////////////////////////////////////////////////////////////////
35999 . ////////////////////////////////////////////////////////////////////////////
36000
36001 .chapter "The Exim monitor" "CHAPeximon"
36002 .scindex IIDeximon "Exim monitor" "description"
36003 .cindex "X-windows"
36004 .cindex "&'eximon'&"
36005 .cindex "Local/eximon.conf"
36006 .cindex "&_exim_monitor/EDITME_&"
36007 The Exim monitor is an application which displays in an X window information
36008 about the state of Exim's queue and what Exim is doing. An admin user can
36009 perform certain operations on messages from this GUI interface; however all
36010 such facilities are also available from the command line, and indeed, the
36011 monitor itself makes use of the command line to perform any actions requested.
36012
36013
36014
36015 .section "Running the monitor" "SECID264"
36016 The monitor is started by running the script called &'eximon'&. This is a shell
36017 script that sets up a number of environment variables, and then runs the
36018 binary called &_eximon.bin_&. The default appearance of the monitor window can
36019 be changed by editing the &_Local/eximon.conf_& file created by editing
36020 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36021 parameters are for.
36022
36023 The parameters that get built into the &'eximon'& script can be overridden for
36024 a particular invocation by setting up environment variables of the same names,
36025 preceded by &`EXIMON_`&. For example, a shell command such as
36026 .code
36027 EXIMON_LOG_DEPTH=400 eximon
36028 .endd
36029 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36030 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36031 overrides the Exim log file configuration. This makes it possible to have
36032 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36033 syslog messages are routed to a file on the local host.
36034
36035 X resources can be used to change the appearance of the window in the normal
36036 way. For example, a resource setting of the form
36037 .code
36038 Eximon*background: gray94
36039 .endd
36040 changes the colour of the background to light grey rather than white. The
36041 stripcharts are drawn with both the data lines and the reference lines in
36042 black. This means that the reference lines are not visible when on top of the
36043 data. However, their colour can be changed by setting a resource called
36044 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36045 For example, if your X server is running Unix, you could set up lighter
36046 reference lines in the stripcharts by obeying
36047 .code
36048 xrdb -merge <<End
36049 Eximon*highlight: gray
36050 End
36051 .endd
36052 .cindex "admin user"
36053 In order to see the contents of messages on the queue, and to operate on them,
36054 &'eximon'& must either be run as root or by an admin user.
36055
36056 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36057 contain X11 resource parameters interpreted by the X11 library.  In addition,
36058 if the first parameter starts with the string "gdb" then it is removed and the
36059 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36060 versioned variants of gdb can be invoked).
36061
36062 The monitor's window is divided into three parts. The first contains one or
36063 more stripcharts and two action buttons, the second contains a &"tail"& of the
36064 main log file, and the third is a display of the queue of messages awaiting
36065 delivery, with two more action buttons. The following sections describe these
36066 different parts of the display.
36067
36068
36069
36070
36071 .section "The stripcharts" "SECID265"
36072 .cindex "stripchart"
36073 The first stripchart is always a count of messages on the queue. Its name can
36074 be configured by setting QUEUE_STRIPCHART_NAME in the
36075 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36076 configuration script by regular expression matches on log file entries, making
36077 it possible to display, for example, counts of messages delivered to certain
36078 hosts or using certain transports. The supplied defaults display counts of
36079 received and delivered messages, and of local and SMTP deliveries. The default
36080 period between stripchart updates is one minute; this can be adjusted by a
36081 parameter in the &_Local/eximon.conf_& file.
36082
36083 The stripchart displays rescale themselves automatically as the value they are
36084 displaying changes. There are always 10 horizontal lines in each chart; the
36085 title string indicates the value of each division when it is greater than one.
36086 For example, &"x2"& means that each division represents a value of 2.
36087
36088 It is also possible to have a stripchart which shows the percentage fullness of
36089 a particular disk partition, which is useful when local deliveries are confined
36090 to a single partition.
36091
36092 .cindex "&%statvfs%& function"
36093 This relies on the availability of the &[statvfs()]& function or equivalent in
36094 the operating system. Most, but not all versions of Unix that support Exim have
36095 this. For this particular stripchart, the top of the chart always represents
36096 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36097 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36098 &_Local/eximon.conf_& file.
36099
36100
36101
36102
36103 .section "Main action buttons" "SECID266"
36104 .cindex "size" "of monitor window"
36105 .cindex "Exim monitor" "window size"
36106 .cindex "window size"
36107 Below the stripcharts there is an action button for quitting the monitor. Next
36108 to this is another button marked &"Size"&. They are placed here so that
36109 shrinking the window to its default minimum size leaves just the queue count
36110 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36111 the window to expand to its maximum size, unless it is already at the maximum,
36112 in which case it is reduced to its minimum.
36113
36114 When expanding to the maximum, if the window cannot be fully seen where it
36115 currently is, it is moved back to where it was the last time it was at full
36116 size. When it is expanding from its minimum size, the old position is
36117 remembered, and next time it is reduced to the minimum it is moved back there.
36118
36119 The idea is that you can keep a reduced window just showing one or two
36120 stripcharts at a convenient place on your screen, easily expand it to show
36121 the full window when required, and just as easily put it back to what it was.
36122 The idea is copied from what the &'twm'& window manager does for its
36123 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36124 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36125
36126 Normally, the monitor starts up with the window at its full size, but it can be
36127 built so that it starts up with the window at its smallest size, by setting
36128 START_SMALL=yes in &_Local/eximon.conf_&.
36129
36130
36131
36132 .section "The log display" "SECID267"
36133 .cindex "log" "tail of; in monitor"
36134 The second section of the window is an area in which a display of the tail of
36135 the main log is maintained.
36136 To save space on the screen, the timestamp on each log line is shortened by
36137 removing the date and, if &%log_timezone%& is set, the timezone.
36138 The log tail is not available when the only destination for logging data is
36139 syslog, unless the syslog lines are routed to a local file whose name is passed
36140 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36141
36142 The log sub-window has a scroll bar at its lefthand side which can be used to
36143 move back to look at earlier text, and the up and down arrow keys also have a
36144 scrolling effect. The amount of log that is kept depends on the setting of
36145 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36146 to use. When this is full, the earlier 50% of data is discarded &-- this is
36147 much more efficient than throwing it away line by line. The sub-window also has
36148 a horizontal scroll bar for accessing the ends of long log lines. This is the
36149 only means of horizontal scrolling; the right and left arrow keys are not
36150 available. Text can be cut from this part of the window using the mouse in the
36151 normal way. The size of this subwindow is controlled by parameters in the
36152 configuration file &_Local/eximon.conf_&.
36153
36154 Searches of the text in the log window can be carried out by means of the ^R
36155 and ^S keystrokes, which default to a reverse and a forward search,
36156 respectively. The search covers only the text that is displayed in the window.
36157 It cannot go further back up the log.
36158
36159 The point from which the search starts is indicated by a caret marker. This is
36160 normally at the end of the text in the window, but can be positioned explicitly
36161 by pointing and clicking with the left mouse button, and is moved automatically
36162 by a successful search. If new text arrives in the window when it is scrolled
36163 back, the caret remains where it is, but if the window is not scrolled back,
36164 the caret is moved to the end of the new text.
36165
36166 Pressing ^R or ^S pops up a window into which the search text can be typed.
36167 There are buttons for selecting forward or reverse searching, for carrying out
36168 the search, and for cancelling. If the &"Search"& button is pressed, the search
36169 happens and the window remains so that further searches can be done. If the
36170 &"Return"& key is pressed, a single search is done and the window is closed. If
36171 ^C is typed the search is cancelled.
36172
36173 The searching facility is implemented using the facilities of the Athena text
36174 widget. By default this pops up a window containing both &"search"& and
36175 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36176 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36177 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36178 provided version of &%TextPop%& when the remaining parts of the text widget
36179 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36180 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36181 on these systems, at the expense of having unwanted items in the search popup
36182 window.
36183
36184
36185
36186 .section "The queue display" "SECID268"
36187 .cindex "queue" "display in monitor"
36188 The bottom section of the monitor window contains a list of all messages that
36189 are on the queue, which includes those currently being received or delivered,
36190 as well as those awaiting delivery. The size of this subwindow is controlled by
36191 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36192 at which it is updated is controlled by another parameter in the same file &--
36193 the default is 5 minutes, since queue scans can be quite expensive. However,
36194 there is an &"Update"& action button just above the display which can be used
36195 to force an update of the queue display at any time.
36196
36197 When a host is down for some time, a lot of pending mail can build up for it,
36198 and this can make it hard to deal with other messages on the queue. To help
36199 with this situation there is a button next to &"Update"& called &"Hide"&. If
36200 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36201 type anything in here and press &"Return"&, the text is added to a chain of
36202 such texts, and if every undelivered address in a message matches at least one
36203 of the texts, the message is not displayed.
36204
36205 If there is an address that does not match any of the texts, all the addresses
36206 are displayed as normal. The matching happens on the ends of addresses so, for
36207 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36208 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36209 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36210 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36211 a hide request is automatically cancelled after one hour.
36212
36213 While the dialogue box is displayed, you can't press any buttons or do anything
36214 else to the monitor window. For this reason, if you want to cut text from the
36215 queue display to use in the dialogue box, you have to do the cutting before
36216 pressing the &"Hide"& button.
36217
36218 The queue display contains, for each unhidden queued message, the length of
36219 time it has been on the queue, the size of the message, the message id, the
36220 message sender, and the first undelivered recipient, all on one line. If it is
36221 a bounce message, the sender is shown as &"<>"&. If there is more than one
36222 recipient to which the message has not yet been delivered, subsequent ones are
36223 listed on additional lines, up to a maximum configured number, following which
36224 an ellipsis is displayed. Recipients that have already received the message are
36225 not shown.
36226
36227 .cindex "frozen messages" "display"
36228 If a message is frozen, an asterisk is displayed at the left-hand side.
36229
36230 The queue display has a vertical scroll bar, and can also be scrolled by means
36231 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36232 The text searching facilities, as described above for the log window, are also
36233 available, but the caret is always moved to the end of the text when the queue
36234 display is updated.
36235
36236
36237
36238 .section "The queue menu" "SECID269"
36239 .cindex "queue" "menu in monitor"
36240 If the &%shift%& key is held down and the left button is clicked when the mouse
36241 pointer is over the text for any message, an action menu pops up, and the first
36242 line of the queue display for the message is highlighted. This does not affect
36243 any selected text.
36244
36245 If you want to use some other event for popping up the menu, you can set the
36246 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36247 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36248 value set in this parameter is a standard X event description. For example, to
36249 run eximon using &%ctrl%& rather than &%shift%& you could use
36250 .code
36251 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36252 .endd
36253 The title of the menu is the message id, and it contains entries which act as
36254 follows:
36255
36256 .ilist
36257 &'message log'&: The contents of the message log for the message are displayed
36258 in a new text window.
36259 .next
36260 &'headers'&: Information from the spool file that contains the envelope
36261 information and headers is displayed in a new text window. See chapter
36262 &<<CHAPspool>>& for a description of the format of spool files.
36263 .next
36264 &'body'&: The contents of the spool file containing the body of the message are
36265 displayed in a new text window. There is a default limit of 20,000 bytes to the
36266 amount of data displayed. This can be changed by setting the BODY_MAX
36267 option at compile time, or the EXIMON_BODY_MAX option at run time.
36268 .next
36269 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36270 delivery of the message. This causes an automatic thaw if the message is
36271 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36272 a new text window. The delivery is run in a separate process, to avoid holding
36273 up the monitor while the delivery proceeds.
36274 .next
36275 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36276 that the message be frozen.
36277 .next
36278 .cindex "thawing messages"
36279 .cindex "unfreezing messages"
36280 .cindex "frozen messages" "thawing"
36281 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36282 that the message be thawed.
36283 .next
36284 .cindex "delivery" "forcing failure"
36285 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36286 that Exim gives up trying to deliver the message. A bounce message is generated
36287 for any remaining undelivered addresses.
36288 .next
36289 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36290 that the message be deleted from the system without generating a bounce
36291 message.
36292 .next
36293 &'add recipient'&: A dialog box is displayed into which a recipient address can
36294 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36295 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36296 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36297 causes a call to Exim to be made using the &%-Mar%& option to request that an
36298 additional recipient be added to the message, unless the entry box is empty, in
36299 which case no action is taken.
36300 .next
36301 &'mark delivered'&: A dialog box is displayed into which a recipient address
36302 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36303 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36304 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36305 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36306 recipient address as already delivered, unless the entry box is empty, in which
36307 case no action is taken.
36308 .next
36309 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36310 mark all recipient addresses as already delivered.
36311 .next
36312 &'edit sender'&: A dialog box is displayed initialized with the current
36313 sender's address. Pressing RETURN causes a call to Exim to be made using the
36314 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36315 in which case no action is taken. If you want to set an empty sender (as in
36316 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36317 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36318 the address is qualified with that domain.
36319 .endlist
36320
36321 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36322 other cases when a call to Exim is made, if there is any output from Exim (in
36323 particular, if the command fails) a window containing the command and the
36324 output is displayed. Otherwise, the results of the action are normally apparent
36325 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36326 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36327 if no output is generated.
36328
36329 The queue display is automatically updated for actions such as freezing and
36330 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36331 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36332 force an update of the display after one of these actions.
36333
36334 In any text window that is displayed as result of a menu action, the normal
36335 cut-and-paste facility is available, and searching can be carried out using ^R
36336 and ^S, as described above for the log tail window.
36337 .ecindex IIDeximon
36338
36339
36340
36341
36342
36343 . ////////////////////////////////////////////////////////////////////////////
36344 . ////////////////////////////////////////////////////////////////////////////
36345
36346 .chapter "Security considerations" "CHAPsecurity"
36347 .scindex IIDsecurcon "security" "discussion of"
36348 This chapter discusses a number of issues concerned with security, some of
36349 which are also covered in other parts of this manual.
36350
36351 For reasons that this author does not understand, some people have promoted
36352 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36353 existence of this chapter in the documentation. However, the intent of the
36354 chapter is simply to describe the way Exim works in relation to certain
36355 security concerns, not to make any specific claims about the effectiveness of
36356 its security as compared with other MTAs.
36357
36358 What follows is a description of the way Exim is supposed to be. Best efforts
36359 have been made to try to ensure that the code agrees with the theory, but an
36360 absence of bugs can never be guaranteed. Any that are reported will get fixed
36361 as soon as possible.
36362
36363
36364 .section "Building a more &""hardened""& Exim" "SECID286"
36365 .cindex "security" "build-time features"
36366 There are a number of build-time options that can be set in &_Local/Makefile_&
36367 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36368 Exim administrator who does not have the root password, or by someone who has
36369 penetrated the Exim (but not the root) account. These options are as follows:
36370
36371 .ilist
36372 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36373 start of any file names used with the &%-C%& option. When it is set, these file
36374 names are also not allowed to contain the sequence &"/../"&. (However, if the
36375 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36376 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36377 default setting for &%ALT_CONFIG_PREFIX%&.
36378
36379 If the permitted configuration files are confined to a directory to
36380 which only root has access, this guards against someone who has broken
36381 into the Exim account from running a privileged Exim with an arbitrary
36382 configuration file, and using it to break into other accounts.
36383 .next
36384
36385 If a non-trusted configuration file (i.e. not the default configuration file
36386 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36387 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36388 the next item), then root privilege is retained only if the caller of Exim is
36389 root. This locks out the possibility of testing a configuration using &%-C%&
36390 right through message reception and delivery, even if the caller is root. The
36391 reception works, but by that time, Exim is running as the Exim user, so when
36392 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36393 privilege to be lost. However, root can test reception and delivery using two
36394 separate commands.
36395
36396 .next
36397 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36398 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36399 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36400 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36401 the restrictive side.  Requiring build-time selection of safe macros is onerous
36402 but this option is intended solely as a transition mechanism to permit
36403 previously-working configurations to continue to work after release 4.73.
36404 .next
36405 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36406 is disabled.
36407 .next
36408 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36409 never to be used for any deliveries. This is like the &%never_users%& runtime
36410 option, but it cannot be overridden; the runtime option adds additional users
36411 to the list. The default setting is &"root"&; this prevents a non-root user who
36412 is permitted to modify the runtime file from using Exim as a way to get root.
36413 .endlist
36414
36415
36416
36417 .section "Root privilege" "SECID270"
36418 .cindex "setuid"
36419 .cindex "root privilege"
36420 The Exim binary is normally setuid to root, which means that it gains root
36421 privilege (runs as root) when it starts execution. In some special cases (for
36422 example, when the daemon is not in use and there are no local deliveries), it
36423 may be possible to run Exim setuid to some user other than root. This is
36424 discussed in the next section. However, in most installations, root privilege
36425 is required for two things:
36426
36427 .ilist
36428 To set up a socket connected to the standard SMTP port (25) when initialising
36429 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36430 not required.
36431 .next
36432 To be able to change uid and gid in order to read users' &_.forward_& files and
36433 perform local deliveries as the receiving user or as specified in the
36434 configuration.
36435 .endlist
36436
36437 It is not necessary to be root to do any of the other things Exim does, such as
36438 receiving messages and delivering them externally over SMTP, and it is
36439 obviously more secure if Exim does not run as root except when necessary.
36440 For this reason, a user and group for Exim to use must be defined in
36441 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36442 group"&. Their values can be changed by the run time configuration, though this
36443 is not recommended. Often a user called &'exim'& is used, but some sites use
36444 &'mail'& or another user name altogether.
36445
36446 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36447 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36448 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36449
36450 After a new Exim process has interpreted its command line options, it changes
36451 uid and gid in the following cases:
36452
36453 .ilist
36454 .oindex "&%-C%&"
36455 .oindex "&%-D%&"
36456 If the &%-C%& option is used to specify an alternate configuration file, or if
36457 the &%-D%& option is used to define macro values for the configuration, and the
36458 calling process is not running as root, the uid and gid are changed to those of
36459 the calling process.
36460 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36461 option may not be used at all.
36462 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36463 can be supplied if the calling process is running as root, the Exim run-time
36464 user or CONFIGURE_OWNER, if defined.
36465 .next
36466 .oindex "&%-be%&"
36467 .oindex "&%-bf%&"
36468 .oindex "&%-bF%&"
36469 If the expansion test option (&%-be%&) or one of the filter testing options
36470 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36471 calling process.
36472 .next
36473 If the process is not a daemon process or a queue runner process or a delivery
36474 process or a process for testing address routing (started with &%-bt%&), the
36475 uid and gid are changed to the Exim user and group. This means that Exim always
36476 runs under its own uid and gid when receiving messages. This also applies when
36477 testing address verification
36478 .oindex "&%-bv%&"
36479 .oindex "&%-bh%&"
36480 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36481 option).
36482 .next
36483 For a daemon, queue runner, delivery, or address testing process, the uid
36484 remains as root at this stage, but the gid is changed to the Exim group.
36485 .endlist
36486
36487 The processes that initially retain root privilege behave as follows:
36488
36489 .ilist
36490 A daemon process changes the gid to the Exim group and the uid to the Exim
36491 user after setting up one or more listening sockets. The &[initgroups()]&
36492 function is called, so that if the Exim user is in any additional groups, they
36493 will be used during message reception.
36494 .next
36495 A queue runner process retains root privilege throughout its execution. Its
36496 job is to fork a controlled sequence of delivery processes.
36497 .next
36498 A delivery process retains root privilege throughout most of its execution,
36499 but any actual deliveries (that is, the transports themselves) are run in
36500 subprocesses which always change to a non-root uid and gid. For local
36501 deliveries this is typically the uid and gid of the owner of the mailbox; for
36502 remote deliveries, the Exim uid and gid are used. Once all the delivery
36503 subprocesses have been run, a delivery process changes to the Exim uid and gid
36504 while doing post-delivery tidying up such as updating the retry database and
36505 generating bounce and warning messages.
36506
36507 While the recipient addresses in a message are being routed, the delivery
36508 process runs as root. However, if a user's filter file has to be processed,
36509 this is done in a subprocess that runs under the individual user's uid and
36510 gid. A system filter is run as root unless &%system_filter_user%& is set.
36511 .next
36512 A process that is testing addresses (the &%-bt%& option) runs as root so that
36513 the routing is done in the same environment as a message delivery.
36514 .endlist
36515
36516
36517
36518
36519 .section "Running Exim without privilege" "SECTrunexiwitpri"
36520 .cindex "privilege, running without"
36521 .cindex "unprivileged running"
36522 .cindex "root privilege" "running without"
36523 Some installations like to run Exim in an unprivileged state for more of its
36524 operation, for added security. Support for this mode of operation is provided
36525 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36526 gid are changed to the Exim user and group at the start of a delivery process
36527 (and also queue runner and address testing processes). This means that address
36528 routing is no longer run as root, and the deliveries themselves cannot change
36529 to any other uid.
36530
36531 .cindex SIGHUP
36532 .cindex "daemon" "restarting"
36533 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36534 that the daemon can still be started in the usual way, and it can respond
36535 correctly to SIGHUP because the re-invocation regains root privilege.
36536
36537 An alternative approach is to make Exim setuid to the Exim user and also setgid
36538 to the Exim group. If you do this, the daemon must be started from a root
36539 process. (Calling Exim from a root process makes it behave in the way it does
36540 when it is setuid root.) However, the daemon cannot restart itself after a
36541 SIGHUP signal because it cannot regain privilege.
36542
36543 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36544 stops Exim from trying to re-invoke itself to do a delivery after a message has
36545 been received. Such a re-invocation is a waste of resources because it has no
36546 effect.
36547
36548 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36549 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36550 to the Exim user seems a clean approach, but there is one complication:
36551
36552 In this style of operation, Exim is running with the real uid and gid set to
36553 those of the calling process, and the effective uid/gid set to Exim's values.
36554 Ideally, any association with the calling process' uid/gid should be dropped,
36555 that is, the real uid/gid should be reset to the effective values so as to
36556 discard any privileges that the caller may have. While some operating systems
36557 have a function that permits this action for a non-root effective uid, quite a
36558 number of them do not. Because of this lack of standardization, Exim does not
36559 address this problem at this time.
36560
36561 For this reason, the recommended approach for &"mostly unprivileged"& running
36562 is to keep the Exim binary setuid to root, and to set
36563 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36564 be used in the most straightforward way.
36565
36566 If you configure Exim not to run delivery processes as root, there are a
36567 number of restrictions on what you can do:
36568
36569 .ilist
36570 You can deliver only as the Exim user/group. You should  explicitly use the
36571 &%user%& and &%group%& options to override routers or local transports that
36572 normally deliver as the recipient. This makes sure that configurations that
36573 work in this mode function the same way in normal mode. Any implicit or
36574 explicit specification of another user causes an error.
36575 .next
36576 Use of &_.forward_& files is severely restricted, such that it is usually
36577 not worthwhile to include them in the configuration.
36578 .next
36579 Users who wish to use &_.forward_& would have to make their home directory and
36580 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36581 and their equivalents in Exim filters, cannot be used. While they could be
36582 enabled in the Exim user's name, that would be insecure and not very useful.
36583 .next
36584 Unless the local user mailboxes are all owned by the Exim user (possible in
36585 some POP3 or IMAP-only environments):
36586
36587 .olist
36588 They must be owned by the Exim group and be writeable by that group. This
36589 implies you must set &%mode%& in the appendfile configuration, as well as the
36590 mode of the mailbox files themselves.
36591 .next
36592 You must set &%no_check_owner%&, since most or all of the files will not be
36593 owned by the Exim user.
36594 .next
36595 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36596 on a newly created mailbox when unprivileged. This also implies that new
36597 mailboxes need to be created manually.
36598 .endlist olist
36599 .endlist ilist
36600
36601
36602 These restrictions severely restrict what can be done in local deliveries.
36603 However, there are no restrictions on remote deliveries. If you are running a
36604 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36605 gives more security at essentially no cost.
36606
36607 If you are using the &%mua_wrapper%& facility (see chapter
36608 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36609
36610
36611
36612
36613 .section "Delivering to local files" "SECID271"
36614 Full details of the checks applied by &(appendfile)& before it writes to a file
36615 are given in chapter &<<CHAPappendfile>>&.
36616
36617
36618
36619 .section "Running local commands" "SECTsecconslocalcmds"
36620 .cindex "security" "local commands"
36621 .cindex "security" "command injection attacks"
36622 There are a number of ways in which an administrator can configure Exim to run
36623 commands based upon received, untrustworthy, data. Further, in some
36624 configurations a user who can control a &_.forward_& file can also arrange to
36625 run commands. Configuration to check includes, but is not limited to:
36626
36627 .ilist
36628 Use of &%use_shell%& in the pipe transport: various forms of shell command
36629 injection may be possible with this option present. It is dangerous and should
36630 be used only with considerable caution. Consider constraints which whitelist
36631 allowed characters in a variable which is to be used in a pipe transport that
36632 has &%use_shell%& enabled.
36633 .next
36634 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36635 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36636 &_.forward_& files in a redirect router. If Exim is running on a central mail
36637 hub to which ordinary users do not have shell access, but home directories are
36638 NFS mounted (for instance) then administrators should review the list of these
36639 forbid options available, and should bear in mind that the options that may
36640 need forbidding can change as new features are added between releases.
36641 .next
36642 The &%${run...}%& expansion item does not use a shell by default, but
36643 administrators can configure use of &_/bin/sh_& as part of the command.
36644 Such invocations should be viewed with prejudicial suspicion.
36645 .next
36646 Administrators who use embedded Perl are advised to explore how Perl's
36647 taint checking might apply to their usage.
36648 .next
36649 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36650 administrators are well advised to view its use with suspicion, in case (for
36651 instance) it allows a local-part to contain embedded Exim directives.
36652 .next
36653 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36654 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36655 each can reference arbitrary lists and files, rather than just being a list
36656 of opaque strings.
36657 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36658 real-world security vulnerabilities caused by its use with untrustworthy data
36659 injected in, for SQL injection attacks.
36660 Consider the use of the &%inlisti%& expansion condition instead.
36661 .endlist
36662
36663
36664
36665
36666 .section "Trust in configuration data" "SECTsecconfdata"
36667 .cindex "security" "data sources"
36668 .cindex "security" "regular expressions"
36669 .cindex "regular expressions" "security"
36670 .cindex "PCRE" "security"
36671 If configuration data for Exim can come from untrustworthy sources, there
36672 are some issues to be aware of:
36673
36674 .ilist
36675 Use of &%${expand...}%& may provide a path for shell injection attacks.
36676 .next
36677 Letting untrusted data provide a regular expression is unwise.
36678 .next
36679 Using &%${match...}%& to apply a fixed regular expression against untrusted
36680 data may result in pathological behaviour within PCRE.  Be aware of what
36681 "backtracking" means and consider options for being more strict with a regular
36682 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36683 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36684 possessive quantifiers or just not using regular expressions against untrusted
36685 data.
36686 .next
36687 It can be important to correctly use &%${quote:...}%&,
36688 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36689 items to ensure that data is correctly constructed.
36690 .next
36691 Some lookups might return multiple results, even though normal usage is only
36692 expected to yield one result.
36693 .endlist
36694
36695
36696
36697
36698 .section "IPv4 source routing" "SECID272"
36699 .cindex "source routing" "in IP packets"
36700 .cindex "IP source routing"
36701 Many operating systems suppress IP source-routed packets in the kernel, but
36702 some cannot be made to do this, so Exim does its own check. It logs incoming
36703 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36704 IPv6. No special checking is currently done.
36705
36706
36707
36708 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36709 Support for these SMTP commands is disabled by default. If required, they can
36710 be enabled by defining suitable ACLs.
36711
36712
36713
36714
36715 .section "Privileged users" "SECID274"
36716 .cindex "trusted users"
36717 .cindex "admin user"
36718 .cindex "privileged user"
36719 .cindex "user" "trusted"
36720 .cindex "user" "admin"
36721 Exim recognizes two sets of users with special privileges. Trusted users are
36722 able to submit new messages to Exim locally, but supply their own sender
36723 addresses and information about a sending host. For other users submitting
36724 local messages, Exim sets up the sender address from the uid, and doesn't
36725 permit a remote host to be specified.
36726
36727 .oindex "&%-f%&"
36728 However, an untrusted user is permitted to use the &%-f%& command line option
36729 in the special form &%-f <>%& to indicate that a delivery failure for the
36730 message should not cause an error report. This affects the message's envelope,
36731 but it does not affect the &'Sender:'& header. Untrusted users may also be
36732 permitted to use specific forms of address with the &%-f%& option by setting
36733 the &%untrusted_set_sender%& option.
36734
36735 Trusted users are used to run processes that receive mail messages from some
36736 other mail domain and pass them on to Exim for delivery either locally, or over
36737 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36738 as any user listed in the &%trusted_users%& configuration option, or under any
36739 group listed in the &%trusted_groups%& option.
36740
36741 Admin users are permitted to do things to the messages on Exim's queue. They
36742 can freeze or thaw messages, cause them to be returned to their senders, remove
36743 them entirely, or modify them in various ways. In addition, admin users can run
36744 the Exim monitor and see all the information it is capable of providing, which
36745 includes the contents of files on the spool.
36746
36747 .oindex "&%-M%&"
36748 .oindex "&%-q%&"
36749 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36750 delivery of messages on its queue is restricted to admin users. This
36751 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36752 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36753 queue is also restricted to admin users. This restriction can be relaxed by
36754 setting &%no_queue_list_requires_admin%&.
36755
36756 Exim recognizes an admin user if the calling process is running as root or as
36757 the Exim user or if any of the groups associated with the calling process is
36758 the Exim group. It is not necessary actually to be running under the Exim
36759 group. However, if admin users who are not root or the Exim user are to access
36760 the contents of files on the spool via the Exim monitor (which runs
36761 unprivileged), Exim must be built to allow group read access to its spool
36762 files.
36763
36764
36765
36766 .section "Spool files" "SECID275"
36767 .cindex "spool directory" "files"
36768 Exim's spool directory and everything it contains is owned by the Exim user and
36769 set to the Exim group. The mode for spool files is defined in the
36770 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36771 any user who is a member of the Exim group can access these files.
36772
36773
36774
36775 .section "Use of argv[0]" "SECID276"
36776 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36777 of specific strings, Exim assumes certain options. For example, calling Exim
36778 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36779 to calling it with the option &%-bS%&. There are no security implications in
36780 this.
36781
36782
36783
36784 .section "Use of %f formatting" "SECID277"
36785 The only use made of &"%f"& by Exim is in formatting load average values. These
36786 are actually stored in integer variables as 1000 times the load average.
36787 Consequently, their range is limited and so therefore is the length of the
36788 converted output.
36789
36790
36791
36792 .section "Embedded Exim path" "SECID278"
36793 Exim uses its own path name, which is embedded in the code, only when it needs
36794 to re-exec in order to regain root privilege. Therefore, it is not root when it
36795 does so. If some bug allowed the path to get overwritten, it would lead to an
36796 arbitrary program's being run as exim, not as root.
36797
36798
36799
36800 .section "Dynamic module directory" "SECTdynmoddir"
36801 Any dynamically loadable modules must be installed into the directory
36802 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36803 loading it.
36804
36805
36806 .section "Use of sprintf()" "SECID279"
36807 .cindex "&[sprintf()]&"
36808 A large number of occurrences of &"sprintf"& in the code are actually calls to
36809 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36810 The intermediate formatting is done into a large fixed buffer by a function
36811 that runs through the format string itself, and checks the length of each
36812 conversion before performing it, thus preventing buffer overruns.
36813
36814 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36815 the output buffer is known to be sufficiently long to contain the converted
36816 string.
36817
36818
36819
36820 .section "Use of debug_printf() and log_write()" "SECID280"
36821 Arbitrary strings are passed to both these functions, but they do their
36822 formatting by calling the function &'string_vformat()'&, which runs through
36823 the format string itself, and checks the length of each conversion.
36824
36825
36826
36827 .section "Use of strcat() and strcpy()" "SECID281"
36828 These are used only in cases where the output buffer is known to be large
36829 enough to hold the result.
36830 .ecindex IIDsecurcon
36831
36832
36833
36834
36835 . ////////////////////////////////////////////////////////////////////////////
36836 . ////////////////////////////////////////////////////////////////////////////
36837
36838 .chapter "Format of spool files" "CHAPspool"
36839 .scindex IIDforspo1 "format" "spool files"
36840 .scindex IIDforspo2 "spool directory" "format of files"
36841 .scindex IIDforspo3 "spool files" "format of"
36842 .cindex "spool files" "editing"
36843 A message on Exim's queue consists of two files, whose names are the message id
36844 followed by -D and -H, respectively. The data portion of the message is kept in
36845 the -D file on its own. The message's envelope, status, and headers are all
36846 kept in the -H file, whose format is described in this chapter. Each of these
36847 two files contains the final component of its own name as its first line. This
36848 is insurance against disk crashes where the directory is lost but the files
36849 themselves are recoverable.
36850
36851 Some people are tempted into editing -D files in order to modify messages. You
36852 need to be extremely careful if you do this; it is not recommended and you are
36853 on your own if you do it. Here are some of the pitfalls:
36854
36855 .ilist
36856 You must ensure that Exim does not try to deliver the message while you are
36857 fiddling with it. The safest way is to take out a write lock on the -D file,
36858 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36859 place, the lock will be retained. If you write a new file and rename it, the
36860 lock will be lost at the instant of rename.
36861 .next
36862 .vindex "&$body_linecount$&"
36863 If you change the number of lines in the file, the value of
36864 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36865 present, this value is not used by Exim, but there is no guarantee that this
36866 will always be the case.
36867 .next
36868 If the message is in MIME format, you must take care not to break it.
36869 .next
36870 If the message is cryptographically signed, any change will invalidate the
36871 signature.
36872 .endlist
36873 All in all, modifying -D files is fraught with danger.
36874
36875 Files whose names end with -J may also be seen in the &_input_& directory (or
36876 its subdirectories when &%split_spool_directory%& is set). These are journal
36877 files, used to record addresses to which the message has been delivered during
36878 the course of a delivery attempt. If there are still undelivered recipients at
36879 the end, the -H file is updated, and the -J file is deleted. If, however, there
36880 is some kind of crash (for example, a power outage) before this happens, the -J
36881 file remains in existence. When Exim next processes the message, it notices the
36882 -J file and uses it to update the -H file before starting the next delivery
36883 attempt.
36884
36885 .section "Format of the -H file" "SECID282"
36886 .cindex "uid (user id)" "in spool file"
36887 .cindex "gid (group id)" "in spool file"
36888 The second line of the -H file contains the login name for the uid of the
36889 process that called Exim to read the message, followed by the numerical uid and
36890 gid. For a locally generated message, this is normally the user who sent the
36891 message. For a message received over TCP/IP via the daemon, it is
36892 normally the Exim user.
36893
36894 The third line of the file contains the address of the message's sender as
36895 transmitted in the envelope, contained in angle brackets. The sender address is
36896 empty for bounce messages. For incoming SMTP mail, the sender address is given
36897 in the MAIL command. For locally generated mail, the sender address is
36898 created by Exim from the login name of the current user and the configured
36899 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36900 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36901 &"<>"& or an address that matches &%untrusted_set_senders%&.
36902
36903 The fourth line contains two numbers. The first is the time that the message
36904 was received, in the conventional Unix form &-- the number of seconds since the
36905 start of the epoch. The second number is a count of the number of messages
36906 warning of delayed delivery that have been sent to the sender.
36907
36908 There follow a number of lines starting with a hyphen. These can appear in any
36909 order, and are omitted when not relevant:
36910
36911 .vlist
36912 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36913 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36914 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36915 recognized, to provide backward compatibility. In the old format, a line of
36916 this form is present for every ACL variable that is not empty. The number
36917 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36918 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36919 the data string for the variable. The string itself starts at the beginning of
36920 the next line, and is followed by a newline character. It may contain internal
36921 newlines.
36922
36923 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36924 A line of this form is present for every ACL connection variable that is
36925 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36926 The length is the length of the data string for the variable. The string itself
36927 starts at the beginning of the next line, and is followed by a newline
36928 character. It may contain internal newlines.
36929
36930 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36931 A line of this form is present for every ACL message variable that is defined.
36932 Note that there is a space between &%-aclm%& and the rest of the name. The
36933 length is the length of the data string for the variable. The string itself
36934 starts at the beginning of the next line, and is followed by a newline
36935 character. It may contain internal newlines.
36936
36937 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36938 This is present if, when the message was received over SMTP, the value of
36939 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36940
36941 .vitem &%-allow_unqualified_recipient%&
36942 This is present if unqualified recipient addresses are permitted in header
36943 lines (to stop such addresses from being qualified if rewriting occurs at
36944 transport time). Local messages that were input using &%-bnq%& and remote
36945 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36946
36947 .vitem &%-allow_unqualified_sender%&
36948 This is present if unqualified sender addresses are permitted in header lines
36949 (to stop such addresses from being qualified if rewriting occurs at transport
36950 time). Local messages that were input using &%-bnq%& and remote messages from
36951 hosts that match &%sender_unqualified_hosts%& set this flag.
36952
36953 .vitem "&%-auth_id%&&~<&'text'&>"
36954 The id information for a message received on an authenticated SMTP connection
36955 &-- the value of the &$authenticated_id$& variable.
36956
36957 .vitem "&%-auth_sender%&&~<&'address'&>"
36958 The address of an authenticated sender &-- the value of the
36959 &$authenticated_sender$& variable.
36960
36961 .vitem "&%-body_linecount%&&~<&'number'&>"
36962 This records the number of lines in the body of the message, and is always
36963 present.
36964
36965 .vitem "&%-body_zerocount%&&~<&'number'&>"
36966 This records the number of binary zero bytes in the body of the message, and is
36967 present if the number is greater than zero.
36968
36969 .vitem &%-deliver_firsttime%&
36970 This is written when a new message is first added to the spool. When the spool
36971 file is updated after a deferral, it is omitted.
36972
36973 .vitem "&%-frozen%&&~<&'time'&>"
36974 .cindex "frozen messages" "spool data"
36975 The message is frozen, and the freezing happened at <&'time'&>.
36976
36977 .vitem "&%-helo_name%&&~<&'text'&>"
36978 This records the host name as specified by a remote host in a HELO or EHLO
36979 command.
36980
36981 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36982 This records the IP address of the host from which the message was received and
36983 the remote port number that was used. It is omitted for locally generated
36984 messages.
36985
36986 .vitem "&%-host_auth%&&~<&'text'&>"
36987 If the message was received on an authenticated SMTP connection, this records
36988 the name of the authenticator &-- the value of the
36989 &$sender_host_authenticated$& variable.
36990
36991 .vitem &%-host_lookup_failed%&
36992 This is present if an attempt to look up the sending host's name from its IP
36993 address failed. It corresponds to the &$host_lookup_failed$& variable.
36994
36995 .vitem "&%-host_name%&&~<&'text'&>"
36996 .cindex "reverse DNS lookup"
36997 .cindex "DNS" "reverse lookup"
36998 This records the name of the remote host from which the message was received,
36999 if the host name was looked up from the IP address when the message was being
37000 received. It is not present if no reverse lookup was done.
37001
37002 .vitem "&%-ident%&&~<&'text'&>"
37003 For locally submitted messages, this records the login of the originating user,
37004 unless it was a trusted user and the &%-oMt%& option was used to specify an
37005 ident value. For messages received over TCP/IP, this records the ident string
37006 supplied by the remote host, if any.
37007
37008 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37009 This records the IP address of the local interface and the port number through
37010 which a message was received from a remote host. It is omitted for locally
37011 generated messages.
37012
37013 .vitem &%-local%&
37014 The message is from a local sender.
37015
37016 .vitem &%-localerror%&
37017 The message is a locally-generated bounce message.
37018
37019 .vitem "&%-local_scan%&&~<&'string'&>"
37020 This records the data string that was returned by the &[local_scan()]& function
37021 when the message was received &-- the value of the &$local_scan_data$&
37022 variable. It is omitted if no data was returned.
37023
37024 .vitem &%-manual_thaw%&
37025 The message was frozen but has been thawed manually, that is, by an explicit
37026 Exim command rather than via the auto-thaw process.
37027
37028 .vitem &%-N%&
37029 A testing delivery process was started using the &%-N%& option to suppress any
37030 actual deliveries, but delivery was deferred. At any further delivery attempts,
37031 &%-N%& is assumed.
37032
37033 .vitem &%-received_protocol%&
37034 This records the value of the &$received_protocol$& variable, which contains
37035 the name of the protocol by which the message was received.
37036
37037 .vitem &%-sender_set_untrusted%&
37038 The envelope sender of this message was set by an untrusted local caller (used
37039 to ensure that the caller is displayed in queue listings).
37040
37041 .vitem "&%-spam_score_int%&&~<&'number'&>"
37042 If a message was scanned by SpamAssassin, this is present. It records the value
37043 of &$spam_score_int$&.
37044
37045 .vitem &%-tls_certificate_verified%&
37046 A TLS certificate was received from the client that sent this message, and the
37047 certificate was verified by the server.
37048
37049 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37050 When the message was received over an encrypted connection, this records the
37051 name of the cipher suite that was used.
37052
37053 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37054 When the message was received over an encrypted connection, and a certificate
37055 was received from the client, this records the Distinguished Name from that
37056 certificate.
37057 .endlist
37058
37059 Following the options there is a list of those addresses to which the message
37060 is not to be delivered. This set of addresses is initialized from the command
37061 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37062 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37063 the address is added to this set. The addresses are kept internally as a
37064 balanced binary tree, and it is a representation of that tree which is written
37065 to the spool file. If an address is expanded via an alias or forward file, the
37066 original address is added to the tree when deliveries to all its child
37067 addresses are complete.
37068
37069 If the tree is empty, there is a single line in the spool file containing just
37070 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37071 Y or N, followed by an address. The address is the value for the node of the
37072 tree, and the letters indicate whether the node has a left branch and/or a
37073 right branch attached to it, respectively. If branches exist, they immediately
37074 follow. Here is an example of a three-node tree:
37075 .code
37076 YY darcy@austen.fict.example
37077 NN alice@wonderland.fict.example
37078 NN editor@thesaurus.ref.example
37079 .endd
37080 After the non-recipients tree, there is a list of the message's recipients.
37081 This is a simple list, preceded by a count. It includes all the original
37082 recipients of the message, including those to whom the message has already been
37083 delivered. In the simplest case, the list contains one address per line. For
37084 example:
37085 .code
37086 4
37087 editor@thesaurus.ref.example
37088 darcy@austen.fict.example
37089 rdo@foundation
37090 alice@wonderland.fict.example
37091 .endd
37092 However, when a child address has been added to the top-level addresses as a
37093 result of the use of the &%one_time%& option on a &(redirect)& router, each
37094 line is of the following form:
37095 .display
37096 <&'top-level address'&> <&'errors_to address'&> &&&
37097   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37098 .endd
37099 The 01 flag bit indicates the presence of the three other fields that follow
37100 the top-level address. Other bits may be used in future to support additional
37101 fields. The <&'parent number'&> is the offset in the recipients list of the
37102 original parent of the &"one time"& address. The first two fields are the
37103 envelope sender that is associated with this address and its length. If the
37104 length is zero, there is no special envelope sender (there are then two space
37105 characters in the line). A non-empty field can arise from a &(redirect)& router
37106 that has an &%errors_to%& setting.
37107
37108
37109 A blank line separates the envelope and status information from the headers
37110 which follow. A header may occupy several lines of the file, and to save effort
37111 when reading it in, each header is preceded by a number and an identifying
37112 character. The number is the number of characters in the header, including any
37113 embedded newlines and the terminating newline. The character is one of the
37114 following:
37115
37116 .table2 50pt
37117 .row <&'blank'&>         "header in which Exim has no special interest"
37118 .row &`B`&               "&'Bcc:'& header"
37119 .row &`C`&               "&'Cc:'& header"
37120 .row &`F`&               "&'From:'& header"
37121 .row &`I`&               "&'Message-id:'& header"
37122 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37123 .row &`R`&               "&'Reply-To:'& header"
37124 .row &`S`&               "&'Sender:'& header"
37125 .row &`T`&               "&'To:'& header"
37126 .row &`*`&               "replaced or deleted header"
37127 .endtable
37128
37129 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37130 purposes. They are not transmitted when the message is delivered. Here is a
37131 typical set of headers:
37132 .code
37133 111P Received: by hobbit.fict.example with local (Exim 4.00)
37134 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37135 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37136 038* X-rewrote-sender: bb@hobbit.fict.example
37137 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37138 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37139 099* To: alice@wonderland.fict.example, rdo@foundation,
37140 darcy@austen.fict.example, editor@thesaurus.ref.example
37141 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37142 darcy@austen.fict.example, editor@thesaurus.ref.example
37143 038  Date: Fri, 11 May 2001 10:28:59 +0100
37144 .endd
37145 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37146 &'To:'& header have been rewritten, the last one because routing expanded the
37147 unqualified domain &'foundation'&.
37148 .ecindex IIDforspo1
37149 .ecindex IIDforspo2
37150 .ecindex IIDforspo3
37151
37152 . ////////////////////////////////////////////////////////////////////////////
37153 . ////////////////////////////////////////////////////////////////////////////
37154
37155 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37156          "DKIM Support"
37157 .cindex "DKIM"
37158
37159 DKIM is a mechanism by which messages sent by some entity can be provably
37160 linked to a domain which that entity controls.  It permits reputation to
37161 be tracked on a per-domain basis, rather than merely upon source IP address.
37162 DKIM is documented in RFC 4871.
37163
37164 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37165 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37166
37167 Exim's DKIM implementation allows to
37168 .olist
37169 Sign outgoing messages: This function is implemented in the SMTP transport.
37170 It can co-exist with all other Exim features
37171 (including transport filters)
37172 except cutthrough delivery.
37173 .next
37174 Verify signatures in incoming messages: This is implemented by an additional
37175 ACL (acl_smtp_dkim), which can be called several times per message, with
37176 different signature contexts.
37177 .endlist
37178
37179 In typical Exim style, the verification implementation does not include any
37180 default "policy". Instead it enables you to build your own policy using
37181 Exim's standard controls.
37182
37183 Please note that verification of DKIM signatures in incoming mail is turned
37184 on by default for logging purposes. For each signature in incoming email,
37185 exim will log a line displaying the most important signature details, and the
37186 signature status. Here is an example (with line-breaks added for clarity):
37187 .code
37188 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37189     d=facebookmail.com s=q1-2009b
37190     c=relaxed/relaxed a=rsa-sha1
37191     i=@facebookmail.com t=1252484542 [verification succeeded]
37192 .endd
37193 You might want to turn off DKIM verification processing entirely for internal
37194 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37195 control modifier. This should typically be done in the RCPT ACL, at points
37196 where you accept mail from relay sources (internal hosts or authenticated
37197 senders).
37198
37199
37200 .section "Signing outgoing messages" "SECID513"
37201 .cindex "DKIM" "signing"
37202
37203 Signing is implemented by setting private options on the SMTP transport.
37204 These options take (expandable) strings as arguments.
37205
37206 .option dkim_domain smtp string&!! unset
37207 MANDATORY:
37208 The domain you want to sign with. The result of this expanded
37209 option is put into the &%$dkim_domain%& expansion variable.
37210
37211 .option dkim_selector smtp string&!! unset
37212 MANDATORY:
37213 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37214 variable to look up a matching selector. The result is put in the expansion
37215 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37216 option along with &%$dkim_domain%&.
37217
37218 .option dkim_private_key smtp string&!! unset
37219 MANDATORY:
37220 This sets the private key to use. You can use the &%$dkim_domain%& and
37221 &%$dkim_selector%& expansion variables to determine the private key to use.
37222 The result can either
37223 .ilist
37224 be a valid RSA private key in ASCII armor, including line breaks.
37225 .next
37226 start with a slash, in which case it is treated as a file that contains
37227 the private key.
37228 .next
37229 be "0", "false" or the empty string, in which case the message will not
37230 be signed. This case will not result in an error, even if &%dkim_strict%&
37231 is set.
37232 .endlist
37233
37234 .option dkim_canon smtp string&!! unset
37235 OPTIONAL:
37236 This option sets the canonicalization method used when signing a message.
37237 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37238 The option defaults to "relaxed" when unset. Note: the current implementation
37239 only supports using the same canonicalization method for both headers and body.
37240
37241 .option dkim_strict smtp string&!! unset
37242 OPTIONAL:
37243 This  option  defines  how  Exim  behaves  when  signing a message that
37244 should be signed fails for some reason.  When the expansion evaluates to
37245 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37246 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37247 variables here.
37248
37249 .option dkim_sign_headers smtp string&!! unset
37250 OPTIONAL:
37251 When set, this option must expand to (or be specified as) a colon-separated
37252 list of header names. Headers with these names will be included in the message
37253 signature. When unspecified, the header names recommended in RFC4871 will be
37254 used.
37255
37256
37257 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37258 .cindex "DKIM" "verification"
37259
37260 Verification of DKIM signatures in incoming email is implemented via the
37261 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37262 syntactically(!) correct signature in the incoming message.
37263 A missing ACL definition defaults to accept.
37264 If any ACL call does not acccept, the message is not accepted.
37265 If a cutthrough delivery was in progress for the message it is
37266 summarily dropped (having wasted the transmission effort).
37267
37268 To evaluate the signature in the ACL a large number of expansion variables
37269 containing the signature status and its details are set up during the
37270 runtime of the ACL.
37271
37272 Calling the ACL only for existing signatures is not sufficient to build
37273 more advanced policies. For that reason, the global option
37274 &%dkim_verify_signers%&, and a global expansion variable
37275 &%$dkim_signers%& exist.
37276
37277 The global option &%dkim_verify_signers%& can be set to a colon-separated
37278 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37279 called. It is expanded when the message has been received. At this point,
37280 the expansion variable &%$dkim_signers%& already contains a colon-separated
37281 list of signer domains and identities for the message. When
37282 &%dkim_verify_signers%& is not specified in the main configuration,
37283 it defaults as:
37284 .code
37285 dkim_verify_signers = $dkim_signers
37286 .endd
37287 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37288 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37289 call the ACL for known domains or identities. This would be achieved as follows:
37290 .code
37291 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37292 .endd
37293 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37294 and "ebay.com", plus all domains and identities that have signatures in the message.
37295 You can also be more creative in constructing your policy. For example:
37296 .code
37297 dkim_verify_signers = $sender_address_domain:$dkim_signers
37298 .endd
37299
37300 If a domain or identity is listed several times in the (expanded) value of
37301 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37302
37303
37304 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37305 available (from most to least important):
37306
37307
37308 .vlist
37309 .vitem &%$dkim_cur_signer%&
37310 The signer that is being evaluated in this ACL run. This can be a domain or
37311 an identity. This is one of the list items from the expanded main option
37312 &%dkim_verify_signers%& (see above).
37313 .vitem &%$dkim_verify_status%&
37314 A string describing the general status of the signature. One of
37315 .ilist
37316 &%none%&: There is no signature in the message for the current domain or
37317 identity (as reflected by &%$dkim_cur_signer%&).
37318 .next
37319 &%invalid%&: The signature could not be verified due to a processing error.
37320 More detail is available in &%$dkim_verify_reason%&.
37321 .next
37322 &%fail%&: Verification of the signature failed.  More detail is
37323 available in &%$dkim_verify_reason%&.
37324 .next
37325 &%pass%&: The signature passed verification. It is valid.
37326 .endlist
37327 .vitem &%$dkim_verify_reason%&
37328 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37329 "fail" or "invalid". One of
37330 .ilist
37331 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37332 key for the domain could not be retrieved. This may be a temporary problem.
37333 .next
37334 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37335 record for the domain is syntactically invalid.
37336 .next
37337 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37338 body hash does not match the one specified in the signature header. This
37339 means that the message body was modified in transit.
37340 .next
37341 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37342 could not be verified. This may mean that headers were modified,
37343 re-written or otherwise changed in a way which is incompatible with
37344 DKIM verification. It may of course also mean that the signature is forged.
37345 .endlist
37346 .vitem &%$dkim_domain%&
37347 The signing domain. IMPORTANT: This variable is only populated if there is
37348 an actual signature in the message for the current domain or identity (as
37349 reflected by &%$dkim_cur_signer%&).
37350 .vitem &%$dkim_identity%&
37351 The signing identity, if present. IMPORTANT: This variable is only populated
37352 if there is an actual signature in the message for the current domain or
37353 identity (as reflected by &%$dkim_cur_signer%&).
37354 .vitem &%$dkim_selector%&
37355 The key record selector string.
37356 .vitem &%$dkim_algo%&
37357 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37358 .vitem &%$dkim_canon_body%&
37359 The body canonicalization method. One of 'relaxed' or 'simple'.
37360 .vitem &%dkim_canon_headers%&
37361 The header canonicalization method. One of 'relaxed' or 'simple'.
37362 .vitem &%$dkim_copiedheaders%&
37363 A transcript of headers and their values which are included in the signature
37364 (copied from the 'z=' tag of the signature).
37365 .vitem &%$dkim_bodylength%&
37366 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37367 limit was set by the signer, "9999999999999" is returned. This makes sure
37368 that this variable always expands to an integer value.
37369 .vitem &%$dkim_created%&
37370 UNIX timestamp reflecting the date and time when the signature was created.
37371 When this was not specified by the signer, "0" is returned.
37372 .vitem &%$dkim_expires%&
37373 UNIX timestamp reflecting the date and time when the signer wants the
37374 signature to be treated as "expired". When this was not specified by the
37375 signer, "9999999999999" is returned. This makes it possible to do useful
37376 integer size comparisons against this value.
37377 .vitem &%$dkim_headernames%&
37378 A colon-separated list of names of headers included in the signature.
37379 .vitem &%$dkim_key_testing%&
37380 "1" if the key record has the "testing" flag set, "0" if not.
37381 .vitem &%$dkim_key_nosubdomains%&
37382 "1" if the key record forbids subdomaining, "0" otherwise.
37383 .vitem &%$dkim_key_srvtype%&
37384 Service type (tag s=) from the key record. Defaults to "*" if not specified
37385 in the key record.
37386 .vitem &%$dkim_key_granularity%&
37387 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37388 in the key record.
37389 .vitem &%$dkim_key_notes%&
37390 Notes from the key record (tag n=).
37391 .endlist
37392
37393 In addition, two ACL conditions are provided:
37394
37395 .vlist
37396 .vitem &%dkim_signers%&
37397 ACL condition that checks a colon-separated list of domains or identities
37398 for a match against the domain or identity that the ACL is currently verifying
37399 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37400 verb to a group of domains or identities. For example:
37401
37402 .code
37403 # Warn when Mail purportedly from GMail has no signature at all
37404 warn log_message = GMail sender without DKIM signature
37405      sender_domains = gmail.com
37406      dkim_signers = gmail.com
37407      dkim_status = none
37408 .endd
37409
37410 .vitem &%dkim_status%&
37411 ACL condition that checks a colon-separated list of possible DKIM verification
37412 results against the actual result of verification. This is typically used
37413 to restrict an ACL verb to a list of verification outcomes, for example:
37414
37415 .code
37416 deny message = Mail from Paypal with invalid/missing signature
37417      sender_domains = paypal.com:paypal.de
37418      dkim_signers = paypal.com:paypal.de
37419      dkim_status = none:invalid:fail
37420 .endd
37421
37422 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37423 see the documentation of the &%$dkim_verify_status%& expansion variable above
37424 for more information of what they mean.
37425 .endlist
37426
37427 . ////////////////////////////////////////////////////////////////////////////
37428 . ////////////////////////////////////////////////////////////////////////////
37429
37430 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37431          "Adding drivers or lookups"
37432 .cindex "adding drivers"
37433 .cindex "new drivers, adding"
37434 .cindex "drivers" "adding new"
37435 The following actions have to be taken in order to add a new router, transport,
37436 authenticator, or lookup type to Exim:
37437
37438 .olist
37439 Choose a name for the driver or lookup type that does not conflict with any
37440 existing name; I will use &"newdriver"& in what follows.
37441 .next
37442 Add to &_src/EDITME_& the line:
37443 .display
37444 <&'type'&>&`_NEWDRIVER=yes`&
37445 .endd
37446 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37447 code is not to be included in the binary by default, comment this line out. You
37448 should also add any relevant comments about the driver or lookup type.
37449 .next
37450 Add to &_src/config.h.defaults_& the line:
37451 .code
37452 #define <type>_NEWDRIVER
37453 .endd
37454 .next
37455 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37456 and create a table entry as is done for all the other drivers and lookup types.
37457 .next
37458 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37459 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37460 Add your &`NEWDRIVER`& to that list.
37461 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37462 simple form that most lookups have.
37463 .next
37464 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37465 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37466 driver or lookup type and add it to the definition of OBJ.
37467 .next
37468 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37469 &_src_&.
37470 .next
37471 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37472 as for other drivers and lookups.
37473 .endlist
37474
37475 Then all you need to do is write the code! A good way to start is to make a
37476 proforma by copying an existing module of the same type, globally changing all
37477 occurrences of the name, and cutting out most of the code. Note that any
37478 options you create must be listed in alphabetical order, because the tables are
37479 searched using a binary chop procedure.
37480
37481 There is a &_README_& file in each of the sub-directories of &_src_& describing
37482 the interface that is expected.
37483
37484
37485
37486
37487 . ////////////////////////////////////////////////////////////////////////////
37488 . ////////////////////////////////////////////////////////////////////////////
37489
37490 . /////////////////////////////////////////////////////////////////////////////
37491 . These lines are processing instructions for the Simple DocBook Processor that
37492 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37493 . PDFs than using xmlto and fop. They will be ignored by all other XML
37494 . processors.
37495 . /////////////////////////////////////////////////////////////////////////////
37496
37497 .literal xml
37498 <?sdop
37499   format="newpage"
37500   foot_right_recto="&chaptertitle;"
37501   foot_right_verso="&chaptertitle;"
37502 ?>
37503 .literal off
37504
37505 .makeindex "Options index"   "option"
37506 .makeindex "Variables index" "variable"
37507 .makeindex "Concept index"   "concept"
37508
37509
37510 . /////////////////////////////////////////////////////////////////////////////
37511 . /////////////////////////////////////////////////////////////////////////////