Expanded EXPERIMENTAL_TPDA feature
[users/jgh/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 &%-MCP%&
3815 .oindex "&%-MCP%&"
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 server to
3818 which Exim is connected supports pipelining.
3819
3820 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3821 .oindex "&%-MCQ%&"
3822 This option is not intended for use by external callers. It is used internally
3823 by Exim in conjunction with the &%-MC%& option when the original delivery was
3824 started by a queue runner. It passes on the process id of the queue runner,
3825 together with the file descriptor number of an open pipe. Closure of the pipe
3826 signals the final completion of the sequence of processes that are passing
3827 messages through the same SMTP connection.
3828
3829 .vitem &%-MCS%&
3830 .oindex "&%-MCS%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3833 SMTP SIZE option should be used on messages delivered down the existing
3834 connection.
3835
3836 .vitem &%-MCT%&
3837 .oindex "&%-MCT%&"
3838 This option is not intended for use by external callers. It is used internally
3839 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3840 host to which Exim is connected supports TLS encryption.
3841
3842 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3843 .oindex "&%-Mc%&"
3844 .cindex "hints database" "not overridden by &%-Mc%&"
3845 .cindex "delivery" "manually started &-- not forced"
3846 This option requests Exim to run a delivery attempt on each message in turn,
3847 but unlike the &%-M%& option, it does check for retry hints, and respects any
3848 that are found. This option is not very useful to external callers. It is
3849 provided mainly for internal use by Exim when it needs to re-invoke itself in
3850 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3851 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3852 respects retry times and other options such as &%hold_domains%& that are
3853 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3854 If you want to run a specific delivery as if in a queue run, you should use
3855 &%-q%& with a message id argument. A distinction between queue run deliveries
3856 and other deliveries is made in one or two places.
3857
3858 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3859 .oindex "&%-Mes%&"
3860 .cindex "message" "changing sender"
3861 .cindex "sender" "changing"
3862 This option requests Exim to change the sender address in the message to the
3863 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3864 &"edit sender"&). There must be exactly two arguments. The first argument must
3865 be a message id, and the second one an email address. However, if the message
3866 is active (in the middle of a delivery attempt), its status is not altered.
3867 This option can be used only by an admin user.
3868
3869 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3870 .oindex "&%-Mf%&"
3871 .cindex "freezing messages"
3872 .cindex "message" "manually freezing"
3873 This option requests Exim to mark each listed message as &"frozen"&. This
3874 prevents any delivery attempts taking place until the message is &"thawed"&,
3875 either manually or as a result of the &%auto_thaw%& configuration option.
3876 However, if any of the messages are active (in the middle of a delivery
3877 attempt), their status is not altered. This option can be used only by an admin
3878 user.
3879
3880 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3881 .oindex "&%-Mg%&"
3882 .cindex "giving up on messages"
3883 .cindex "message" "abandoning delivery attempts"
3884 .cindex "delivery" "abandoning further attempts"
3885 This option requests Exim to give up trying to deliver the listed messages,
3886 including any that are frozen. However, if any of the messages are active,
3887 their status is not altered. For non-bounce messages, a delivery error message
3888 is sent to the sender, containing the text &"cancelled by administrator"&.
3889 Bounce messages are just discarded. This option can be used only by an admin
3890 user.
3891
3892 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3893 .oindex "&%-Mmad%&"
3894 .cindex "delivery" "cancelling all"
3895 This option requests Exim to mark all the recipient addresses in the messages
3896 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3897 message is active (in the middle of a delivery attempt), its status is not
3898 altered. This option can be used only by an admin user.
3899
3900 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3901 .oindex "&%-Mmd%&"
3902 .cindex "delivery" "cancelling by address"
3903 .cindex "recipient" "removing"
3904 .cindex "removing recipients"
3905 This option requests Exim to mark the given addresses as already delivered
3906 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3907 the remaining ones must be email addresses. These are matched to recipient
3908 addresses in the message in a case-sensitive manner. If the message is active
3909 (in the middle of a delivery attempt), its status is not altered. This option
3910 can be used only by an admin user.
3911
3912 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3913 .oindex "&%-Mrm%&"
3914 .cindex "removing messages"
3915 .cindex "abandoning mail"
3916 .cindex "message" "manually discarding"
3917 This option requests Exim to remove the given messages from the queue. No
3918 bounce messages are sent; each message is simply forgotten. However, if any of
3919 the messages are active, their status is not altered. This option can be used
3920 only by an admin user or by the user who originally caused the message to be
3921 placed on the queue.
3922
3923 .vitem &%-Mset%&&~<&'message&~id'&>
3924 .oindex "&%-Mset%&
3925 .cindex "testing" "string expansion"
3926 .cindex "expansion" "testing"
3927 This option is useful only in conjunction with &%-be%& (that is, when testing
3928 string expansions). Exim loads the given message from its spool before doing
3929 the test expansions, thus setting message-specific variables such as
3930 &$message_size$& and the header variables. The &$recipients$& variable is made
3931 available. This feature is provided to make it easier to test expansions that
3932 make use of these variables. However, this option can be used only by an admin
3933 user. See also &%-bem%&.
3934
3935 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3936 .oindex "&%-Mt%&"
3937 .cindex "thawing messages"
3938 .cindex "unfreezing messages"
3939 .cindex "frozen messages" "thawing"
3940 .cindex "message" "thawing frozen"
3941 This option requests Exim to &"thaw"& any of the listed messages that are
3942 &"frozen"&, so that delivery attempts can resume. However, if any of the
3943 messages are active, their status is not altered. This option can be used only
3944 by an admin user.
3945
3946 .vitem &%-Mvb%&&~<&'message&~id'&>
3947 .oindex "&%-Mvb%&"
3948 .cindex "listing" "message body"
3949 .cindex "message" "listing body of"
3950 This option causes the contents of the message body (-D) spool file to be
3951 written to the standard output. This option can be used only by an admin user.
3952
3953 .vitem &%-Mvc%&&~<&'message&~id'&>
3954 .oindex "&%-Mvc%&"
3955 .cindex "message" "listing in RFC 2822 format"
3956 .cindex "listing" "message in RFC 2822 format"
3957 This option causes a copy of the complete message (header lines plus body) to
3958 be written to the standard output in RFC 2822 format. This option can be used
3959 only by an admin user.
3960
3961 .vitem &%-Mvh%&&~<&'message&~id'&>
3962 .oindex "&%-Mvh%&"
3963 .cindex "listing" "message headers"
3964 .cindex "header lines" "listing"
3965 .cindex "message" "listing header lines"
3966 This option causes the contents of the message headers (-H) spool file to be
3967 written to the standard output. This option can be used only by an admin user.
3968
3969 .vitem &%-Mvl%&&~<&'message&~id'&>
3970 .oindex "&%-Mvl%&"
3971 .cindex "listing" "message log"
3972 .cindex "message" "listing message log"
3973 This option causes the contents of the message log spool file to be written to
3974 the standard output. This option can be used only by an admin user.
3975
3976 .vitem &%-m%&
3977 .oindex "&%-m%&"
3978 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3979 treats it that way too.
3980
3981 .vitem &%-N%&
3982 .oindex "&%-N%&"
3983 .cindex "debugging" "&%-N%& option"
3984 .cindex "debugging" "suppressing delivery"
3985 This is a debugging option that inhibits delivery of a message at the transport
3986 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3987 it just doesn't actually transport the message, but instead behaves as if it
3988 had successfully done so. However, it does not make any updates to the retry
3989 database, and the log entries for deliveries are flagged with &"*>"& rather
3990 than &"=>"&.
3991
3992 Because &%-N%& discards any message to which it applies, only root or the Exim
3993 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3994 words, an ordinary user can use it only when supplying an incoming message to
3995 which it will apply. Although transportation never fails when &%-N%& is set, an
3996 address may be deferred because of a configuration problem on a transport, or a
3997 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3998 the message, and applies to any subsequent delivery attempts that may happen
3999 for that message.
4000
4001 .vitem &%-n%&
4002 .oindex "&%-n%&"
4003 This option is interpreted by Sendmail to mean &"no aliasing"&.
4004 For normal modes of operation, it is ignored by Exim.
4005 When combined with &%-bP%& it suppresses the name of an option from being output.
4006
4007 .vitem &%-O%&&~<&'data'&>
4008 .oindex "&%-O%&"
4009 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4010 Exim.
4011
4012 .vitem &%-oA%&&~<&'file&~name'&>
4013 .oindex "&%-oA%&"
4014 .cindex "Sendmail compatibility" "&%-oA%& option"
4015 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4016 alternative alias file name. Exim handles &%-bi%& differently; see the
4017 description above.
4018
4019 .vitem &%-oB%&&~<&'n'&>
4020 .oindex "&%-oB%&"
4021 .cindex "SMTP" "passed connection"
4022 .cindex "SMTP" "multiple deliveries"
4023 .cindex "multiple SMTP deliveries"
4024 This is a debugging option which limits the maximum number of messages that can
4025 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4026 transport. If <&'n'&> is omitted, the limit is set to 1.
4027
4028 .vitem &%-odb%&
4029 .oindex "&%-odb%&"
4030 .cindex "background delivery"
4031 .cindex "delivery" "in the background"
4032 This option applies to all modes in which Exim accepts incoming messages,
4033 including the listening daemon. It requests &"background"& delivery of such
4034 messages, which means that the accepting process automatically starts a
4035 delivery process for each message received, but does not wait for the delivery
4036 processes to finish.
4037
4038 When all the messages have been received, the reception process exits,
4039 leaving the delivery processes to finish in their own time. The standard output
4040 and error streams are closed at the start of each delivery process.
4041 This is the default action if none of the &%-od%& options are present.
4042
4043 If one of the queueing options in the configuration file
4044 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4045 overrides it if &%queue_only_override%& is set true, which is the default
4046 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4047
4048 .vitem &%-odf%&
4049 .oindex "&%-odf%&"
4050 .cindex "foreground delivery"
4051 .cindex "delivery" "in the foreground"
4052 This option requests &"foreground"& (synchronous) delivery when Exim has
4053 accepted a locally-generated message. (For the daemon it is exactly the same as
4054 &%-odb%&.) A delivery process is automatically started to deliver the message,
4055 and Exim waits for it to complete before proceeding.
4056
4057 The original Exim reception process does not finish until the delivery
4058 process for the final message has ended. The standard error stream is left open
4059 during deliveries.
4060
4061 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4062 false and one of the queueing options in the configuration file is in effect.
4063
4064 If there is a temporary delivery error during foreground delivery, the
4065 message is left on the queue for later delivery, and the original reception
4066 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4067 restricted configuration that never queues messages.
4068
4069
4070 .vitem &%-odi%&
4071 .oindex "&%-odi%&"
4072 This option is synonymous with &%-odf%&. It is provided for compatibility with
4073 Sendmail.
4074
4075 .vitem &%-odq%&
4076 .oindex "&%-odq%&"
4077 .cindex "non-immediate delivery"
4078 .cindex "delivery" "suppressing immediate"
4079 .cindex "queueing incoming messages"
4080 This option applies to all modes in which Exim accepts incoming messages,
4081 including the listening daemon. It specifies that the accepting process should
4082 not automatically start a delivery process for each message received. Messages
4083 are placed on the queue, and remain there until a subsequent queue runner
4084 process encounters them. There are several configuration options (such as
4085 &%queue_only%&) that can be used to queue incoming messages under certain
4086 conditions. This option overrides all of them and also &%-odqs%&. It always
4087 forces queueing.
4088
4089 .vitem &%-odqs%&
4090 .oindex "&%-odqs%&"
4091 .cindex "SMTP" "delaying delivery"
4092 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4093 However, like &%-odb%& and &%-odi%&, this option has no effect if
4094 &%queue_only_override%& is false and one of the queueing options in the
4095 configuration file is in effect.
4096
4097 When &%-odqs%& does operate, a delivery process is started for each incoming
4098 message, in the background by default, but in the foreground if &%-odi%& is
4099 also present. The recipient addresses are routed, and local deliveries are done
4100 in the normal way. However, if any SMTP deliveries are required, they are not
4101 done at this time, so the message remains on the queue until a subsequent queue
4102 runner process encounters it. Because routing was done, Exim knows which
4103 messages are waiting for which hosts, and so a number of messages for the same
4104 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4105 configuration option has the same effect for specific domains. See also the
4106 &%-qq%& option.
4107
4108 .vitem &%-oee%&
4109 .oindex "&%-oee%&"
4110 .cindex "error" "reporting"
4111 If an error is detected while a non-SMTP message is being received (for
4112 example, a malformed address), the error is reported to the sender in a mail
4113 message.
4114
4115 .cindex "return code" "for &%-oee%&"
4116 Provided
4117 this error message is successfully sent, the Exim receiving process
4118 exits with a return code of zero. If not, the return code is 2 if the problem
4119 is that the original message has no recipients, or 1 for any other error.
4120 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4121
4122 .vitem &%-oem%&
4123 .oindex "&%-oem%&"
4124 .cindex "error" "reporting"
4125 .cindex "return code" "for &%-oem%&"
4126 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4127 return code, whether or not the error message was successfully sent.
4128 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4129
4130 .vitem &%-oep%&
4131 .oindex "&%-oep%&"
4132 .cindex "error" "reporting"
4133 If an error is detected while a non-SMTP message is being received, the
4134 error is reported by writing a message to the standard error file (stderr).
4135 .cindex "return code" "for &%-oep%&"
4136 The return code is 1 for all errors.
4137
4138 .vitem &%-oeq%&
4139 .oindex "&%-oeq%&"
4140 .cindex "error" "reporting"
4141 This option is supported for compatibility with Sendmail, but has the same
4142 effect as &%-oep%&.
4143
4144 .vitem &%-oew%&
4145 .oindex "&%-oew%&"
4146 .cindex "error" "reporting"
4147 This option is supported for compatibility with Sendmail, but has the same
4148 effect as &%-oem%&.
4149
4150 .vitem &%-oi%&
4151 .oindex "&%-oi%&"
4152 .cindex "dot" "in incoming non-SMTP message"
4153 This option, which has the same effect as &%-i%&, specifies that a dot on a
4154 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4155 single dot does terminate, though Exim does no special processing for other
4156 lines that start with a dot. This option is set by default if Exim is called as
4157 &'rmail'&. See also &%-ti%&.
4158
4159 .vitem &%-oitrue%&
4160 .oindex "&%-oitrue%&"
4161 This option is treated as synonymous with &%-oi%&.
4162
4163 .vitem &%-oMa%&&~<&'host&~address'&>
4164 .oindex "&%-oMa%&"
4165 .cindex "sender" "host address, specifying for local message"
4166 A number of options starting with &%-oM%& can be used to set values associated
4167 with remote hosts on locally-submitted messages (that is, messages not received
4168 over TCP/IP). These options can be used by any caller in conjunction with the
4169 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4170 other circumstances, they are ignored unless the caller is trusted.
4171
4172 The &%-oMa%& option sets the sender host address. This may include a port
4173 number at the end, after a full stop (period). For example:
4174 .code
4175 exim -bs -oMa 10.9.8.7.1234
4176 .endd
4177 An alternative syntax is to enclose the IP address in square brackets,
4178 followed by a colon and the port number:
4179 .code
4180 exim -bs -oMa [10.9.8.7]:1234
4181 .endd
4182 The IP address is placed in the &$sender_host_address$& variable, and the
4183 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4184 are present on the command line, the sender host IP address is taken from
4185 whichever one is last.
4186
4187 .vitem &%-oMaa%&&~<&'name'&>
4188 .oindex "&%-oMaa%&"
4189 .cindex "authentication" "name, specifying for local message"
4190 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4191 option sets the value of &$sender_host_authenticated$& (the authenticator
4192 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4193 This option can be used with &%-bh%& and &%-bs%& to set up an
4194 authenticated SMTP session without actually using the SMTP AUTH command.
4195
4196 .vitem &%-oMai%&&~<&'string'&>
4197 .oindex "&%-oMai%&"
4198 .cindex "authentication" "id, specifying for local message"
4199 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4200 option sets the value of &$authenticated_id$& (the id that was authenticated).
4201 This overrides the default value (the caller's login id, except with &%-bh%&,
4202 where there is no default) for messages from local sources. See chapter
4203 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4204
4205 .vitem &%-oMas%&&~<&'address'&>
4206 .oindex "&%-oMas%&"
4207 .cindex "authentication" "sender, specifying for local message"
4208 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4209 option sets the authenticated sender value in &$authenticated_sender$&. It
4210 overrides the sender address that is created from the caller's login id for
4211 messages from local sources, except when &%-bh%& is used, when there is no
4212 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4213 specified on a MAIL command overrides this value. See chapter
4214 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4215
4216 .vitem &%-oMi%&&~<&'interface&~address'&>
4217 .oindex "&%-oMi%&"
4218 .cindex "interface" "address, specifying for local message"
4219 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4220 option sets the IP interface address value. A port number may be included,
4221 using the same syntax as for &%-oMa%&. The interface address is placed in
4222 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4223
4224 .vitem &%-oMm%&&~<&'message&~reference'&>
4225 .oindex "&%-oMm%&"
4226 .cindex "message reference" "message reference, specifying for local message"
4227 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4228 option sets the message reference, e.g. message-id, and is logged during
4229 delivery. This is useful when some kind of audit trail is required to tie
4230 messages together. The format of the message reference is checked and will
4231 abort if the format is invalid. The option will only be accepted if exim is
4232 running in trusted mode, not as any regular user.
4233
4234 The best example of a message reference is when Exim sends a bounce message.
4235 The message reference is the message-id of the original message for which Exim
4236 is sending the bounce.
4237
4238 .vitem &%-oMr%&&~<&'protocol&~name'&>
4239 .oindex "&%-oMr%&"
4240 .cindex "protocol, specifying for local message"
4241 .vindex "&$received_protocol$&"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4243 option sets the received protocol value that is stored in
4244 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4245 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4246 SMTP protocol names (see the description of &$received_protocol$& in section
4247 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4248 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4249 be set by &%-oMr%&.
4250
4251 .vitem &%-oMs%&&~<&'host&~name'&>
4252 .oindex "&%-oMs%&"
4253 .cindex "sender" "host name, specifying for local message"
4254 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4255 option sets the sender host name in &$sender_host_name$&. When this option is
4256 present, Exim does not attempt to look up a host name from an IP address; it
4257 uses the name it is given.
4258
4259 .vitem &%-oMt%&&~<&'ident&~string'&>
4260 .oindex "&%-oMt%&"
4261 .cindex "sender" "ident string, specifying for local message"
4262 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4263 option sets the sender ident value in &$sender_ident$&. The default setting for
4264 local callers is the login id of the calling process, except when &%-bh%& is
4265 used, when there is no default.
4266
4267 .vitem &%-om%&
4268 .oindex "&%-om%&"
4269 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4270 In Sendmail, this option means &"me too"&, indicating that the sender of a
4271 message should receive a copy of the message if the sender appears in an alias
4272 expansion. Exim always does this, so the option does nothing.
4273
4274 .vitem &%-oo%&
4275 .oindex "&%-oo%&"
4276 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4277 This option is ignored. In Sendmail it specifies &"old style headers"&,
4278 whatever that means.
4279
4280 .vitem &%-oP%&&~<&'path'&>
4281 .oindex "&%-oP%&"
4282 .cindex "pid (process id)" "of daemon"
4283 .cindex "daemon" "process id (pid)"
4284 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4285 value. The option specifies the file to which the process id of the daemon is
4286 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4287 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4288 because in those cases, the normal pid file is not used.
4289
4290 .vitem &%-or%&&~<&'time'&>
4291 .oindex "&%-or%&"
4292 .cindex "timeout" "for non-SMTP input"
4293 This option sets a timeout value for incoming non-SMTP messages. If it is not
4294 set, Exim will wait forever for the standard input. The value can also be set
4295 by the &%receive_timeout%& option. The format used for specifying times is
4296 described in section &<<SECTtimeformat>>&.
4297
4298 .vitem &%-os%&&~<&'time'&>
4299 .oindex "&%-os%&"
4300 .cindex "timeout" "for SMTP input"
4301 .cindex "SMTP" "input timeout"
4302 This option sets a timeout value for incoming SMTP messages. The timeout
4303 applies to each SMTP command and block of data. The value can also be set by
4304 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4305 for specifying times is described in section &<<SECTtimeformat>>&.
4306
4307 .vitem &%-ov%&
4308 .oindex "&%-ov%&"
4309 This option has exactly the same effect as &%-v%&.
4310
4311 .vitem &%-oX%&&~<&'number&~or&~string'&>
4312 .oindex "&%-oX%&"
4313 .cindex "TCP/IP" "setting listening ports"
4314 .cindex "TCP/IP" "setting listening interfaces"
4315 .cindex "port" "receiving TCP/IP"
4316 This option is relevant only when the &%-bd%& (start listening daemon) option
4317 is also given. It controls which ports and interfaces the daemon uses. Details
4318 of the syntax, and how it interacts with configuration file options, are given
4319 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4320 file is written unless &%-oP%& is also present to specify a pid file name.
4321
4322 .vitem &%-pd%&
4323 .oindex "&%-pd%&"
4324 .cindex "Perl" "starting the interpreter"
4325 This option applies when an embedded Perl interpreter is linked with Exim (see
4326 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4327 option, forcing the starting of the interpreter to be delayed until it is
4328 needed.
4329
4330 .vitem &%-ps%&
4331 .oindex "&%-ps%&"
4332 .cindex "Perl" "starting the interpreter"
4333 This option applies when an embedded Perl interpreter is linked with Exim (see
4334 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4335 option, forcing the starting of the interpreter to occur as soon as Exim is
4336 started.
4337
4338 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4339 .oindex "&%-p%&"
4340 For compatibility with Sendmail, this option is equivalent to
4341 .display
4342 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4343 .endd
4344 It sets the incoming protocol and host name (for trusted callers). The
4345 host name and its colon can be omitted when only the protocol is to be set.
4346 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4347 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4348 or &`s`& using this option (but that does not seem a real limitation).
4349
4350 .vitem &%-q%&
4351 .oindex "&%-q%&"
4352 .cindex "queue runner" "starting manually"
4353 This option is normally restricted to admin users. However, there is a
4354 configuration option called &%prod_requires_admin%& which can be set false to
4355 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4356 and &%-S%& options).
4357
4358 .cindex "queue runner" "description of operation"
4359 The &%-q%& option starts one queue runner process. This scans the queue of
4360 waiting messages, and runs a delivery process for each one in turn. It waits
4361 for each delivery process to finish before starting the next one. A delivery
4362 process may not actually do any deliveries if the retry times for the addresses
4363 have not been reached. Use &%-qf%& (see below) if you want to override this.
4364
4365 If
4366 .cindex "SMTP" "passed connection"
4367 .cindex "SMTP" "multiple deliveries"
4368 .cindex "multiple SMTP deliveries"
4369 the delivery process spawns other processes to deliver other messages down
4370 passed SMTP connections, the queue runner waits for these to finish before
4371 proceeding.
4372
4373 When all the queued messages have been considered, the original queue runner
4374 process terminates. In other words, a single pass is made over the waiting
4375 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4376 this to be repeated periodically.
4377
4378 Exim processes the waiting messages in an unpredictable order. It isn't very
4379 random, but it is likely to be different each time, which is all that matters.
4380 If one particular message screws up a remote MTA, other messages to the same
4381 MTA have a chance of getting through if they get tried first.
4382
4383 It is possible to cause the messages to be processed in lexical message id
4384 order, which is essentially the order in which they arrived, by setting the
4385 &%queue_run_in_order%& option, but this is not recommended for normal use.
4386
4387 .vitem &%-q%&<&'qflags'&>
4388 The &%-q%& option may be followed by one or more flag letters that change its
4389 behaviour. They are all optional, but if more than one is present, they must
4390 appear in the correct order. Each flag is described in a separate item below.
4391
4392 .vitem &%-qq...%&
4393 .oindex "&%-qq%&"
4394 .cindex "queue" "double scanning"
4395 .cindex "queue" "routing"
4396 .cindex "routing" "whole queue before delivery"
4397 An option starting with &%-qq%& requests a two-stage queue run. In the first
4398 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4399 every domain. Addresses are routed, local deliveries happen, but no remote
4400 transports are run.
4401
4402 .cindex "hints database" "remembering routing"
4403 The hints database that remembers which messages are waiting for specific hosts
4404 is updated, as if delivery to those hosts had been deferred. After this is
4405 complete, a second, normal queue scan happens, with routing and delivery taking
4406 place as normal. Messages that are routed to the same host should mostly be
4407 delivered down a single SMTP
4408 .cindex "SMTP" "passed connection"
4409 .cindex "SMTP" "multiple deliveries"
4410 .cindex "multiple SMTP deliveries"
4411 connection because of the hints that were set up during the first queue scan.
4412 This option may be useful for hosts that are connected to the Internet
4413 intermittently.
4414
4415 .vitem &%-q[q]i...%&
4416 .oindex "&%-qi%&"
4417 .cindex "queue" "initial delivery"
4418 If the &'i'& flag is present, the queue runner runs delivery processes only for
4419 those messages that haven't previously been tried. (&'i'& stands for &"initial
4420 delivery"&.) This can be helpful if you are putting messages on the queue using
4421 &%-odq%& and want a queue runner just to process the new messages.
4422
4423 .vitem &%-q[q][i]f...%&
4424 .oindex "&%-qf%&"
4425 .cindex "queue" "forcing delivery"
4426 .cindex "delivery" "forcing in queue run"
4427 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4428 message, whereas without &'f'& only those non-frozen addresses that have passed
4429 their retry times are tried.
4430
4431 .vitem &%-q[q][i]ff...%&
4432 .oindex "&%-qff%&"
4433 .cindex "frozen messages" "forcing delivery"
4434 If &'ff'& is present, a delivery attempt is forced for every message, whether
4435 frozen or not.
4436
4437 .vitem &%-q[q][i][f[f]]l%&
4438 .oindex "&%-ql%&"
4439 .cindex "queue" "local deliveries only"
4440 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4441 be done. If a message requires any remote deliveries, it remains on the queue
4442 for later delivery.
4443
4444 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4445 .cindex "queue" "delivering specific messages"
4446 When scanning the queue, Exim can be made to skip over messages whose ids are
4447 lexically less than a given value by following the &%-q%& option with a
4448 starting message id. For example:
4449 .code
4450 exim -q 0t5C6f-0000c8-00
4451 .endd
4452 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4453 second message id is given, messages whose ids are lexically greater than it
4454 are also skipped. If the same id is given twice, for example,
4455 .code
4456 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4457 .endd
4458 just one delivery process is started, for that message. This differs from
4459 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4460 that it counts as a delivery from a queue run. Note that the selection
4461 mechanism does not affect the order in which the messages are scanned. There
4462 are also other ways of selecting specific sets of messages for delivery in a
4463 queue run &-- see &%-R%& and &%-S%&.
4464
4465 .vitem &%-q%&<&'qflags'&><&'time'&>
4466 .cindex "queue runner" "starting periodically"
4467 .cindex "periodic queue running"
4468 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4469 starting a queue runner process at intervals specified by the given time value
4470 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4471 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4472 single daemon process handles both functions. A common way of starting up a
4473 combined daemon at system boot time is to use a command such as
4474 .code
4475 /usr/exim/bin/exim -bd -q30m
4476 .endd
4477 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4478 process every 30 minutes.
4479
4480 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4481 pid file is written unless one is explicitly requested by the &%-oP%& option.
4482
4483 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4484 .oindex "&%-qR%&"
4485 This option is synonymous with &%-R%&. It is provided for Sendmail
4486 compatibility.
4487
4488 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4489 .oindex "&%-qS%&"
4490 This option is synonymous with &%-S%&.
4491
4492 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4493 .oindex "&%-R%&"
4494 .cindex "queue runner" "for specific recipients"
4495 .cindex "delivery" "to given domain"
4496 .cindex "domain" "delivery to"
4497 The <&'rsflags'&> may be empty, in which case the white space before the string
4498 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4499 which are the possible values for <&'rsflags'&>. White space is required if
4500 <&'rsflags'&> is not empty.
4501
4502 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4503 perform a single queue run, except that, when scanning the messages on the
4504 queue, Exim processes only those that have at least one undelivered recipient
4505 address containing the given string, which is checked in a case-independent
4506 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4507 regular expression; otherwise it is a literal string.
4508
4509 If you want to do periodic queue runs for messages with specific recipients,
4510 you can combine &%-R%& with &%-q%& and a time value. For example:
4511 .code
4512 exim -q25m -R @special.domain.example
4513 .endd
4514 This example does a queue run for messages with recipients in the given domain
4515 every 25 minutes. Any additional flags that are specified with &%-q%& are
4516 applied to each queue run.
4517
4518 Once a message is selected for delivery by this mechanism, all its addresses
4519 are processed. For the first selected message, Exim overrides any retry
4520 information and forces a delivery attempt for each undelivered address. This
4521 means that if delivery of any address in the first message is successful, any
4522 existing retry information is deleted, and so delivery attempts for that
4523 address in subsequently selected messages (which are processed without forcing)
4524 will run. However, if delivery of any address does not succeed, the retry
4525 information is updated, and in subsequently selected messages, the failing
4526 address will be skipped.
4527
4528 .cindex "frozen messages" "forcing delivery"
4529 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4530 all selected messages, not just the first; frozen messages are included when
4531 &'ff'& is present.
4532
4533 The &%-R%& option makes it straightforward to initiate delivery of all messages
4534 to a given domain after a host has been down for some time. When the SMTP
4535 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4536 effect is to run Exim with the &%-R%& option, but it can be configured to run
4537 an arbitrary command instead.
4538
4539 .vitem &%-r%&
4540 .oindex "&%-r%&"
4541 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4542
4543 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4544 .oindex "&%-S%&"
4545 .cindex "delivery" "from given sender"
4546 .cindex "queue runner" "for specific senders"
4547 This option acts like &%-R%& except that it checks the string against each
4548 message's sender instead of against the recipients. If &%-R%& is also set, both
4549 conditions must be met for a message to be selected. If either of the options
4550 has &'f'& or &'ff'& in its flags, the associated action is taken.
4551
4552 .vitem &%-Tqt%&&~<&'times'&>
4553 .oindex "&%-Tqt%&"
4554 This is an option that is exclusively for use by the Exim testing suite. It is not
4555 recognized when Exim is run normally. It allows for the setting up of explicit
4556 &"queue times"& so that various warning/retry features can be tested.
4557
4558 .vitem &%-t%&
4559 .oindex "&%-t%&"
4560 .cindex "recipient" "extracting from header lines"
4561 .cindex "&'Bcc:'& header line"
4562 .cindex "&'Cc:'& header line"
4563 .cindex "&'To:'& header line"
4564 When Exim is receiving a locally-generated, non-SMTP message on its standard
4565 input, the &%-t%& option causes the recipients of the message to be obtained
4566 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4567 from the command arguments. The addresses are extracted before any rewriting
4568 takes place and the &'Bcc:'& header line, if present, is then removed.
4569
4570 .cindex "Sendmail compatibility" "&%-t%& option"
4571 If the command has any arguments, they specify addresses to which the message
4572 is &'not'& to be delivered. That is, the argument addresses are removed from
4573 the recipients list obtained from the headers. This is compatible with Smail 3
4574 and in accordance with the documented behaviour of several versions of
4575 Sendmail, as described in man pages on a number of operating systems (e.g.
4576 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4577 argument addresses to those obtained from the headers, and the O'Reilly
4578 Sendmail book documents it that way. Exim can be made to add argument addresses
4579 instead of subtracting them by setting the option
4580 &%extract_addresses_remove_arguments%& false.
4581
4582 .cindex "&%Resent-%& header lines" "with &%-t%&"
4583 If there are any &%Resent-%& header lines in the message, Exim extracts
4584 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4585 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4586 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4587 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4588
4589 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4590 message is resent several times). The RFC also specifies that they should be
4591 added at the front of the message, and separated by &'Received:'& lines. It is
4592 not at all clear how &%-t%& should operate in the present of multiple sets,
4593 nor indeed exactly what constitutes a &"set"&.
4594 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4595 are often added at the end of the header, and if a message is resent more than
4596 once, it is common for the original set of &%Resent-%& headers to be renamed as
4597 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4598
4599 .vitem &%-ti%&
4600 .oindex "&%-ti%&"
4601 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4602 compatibility with Sendmail.
4603
4604 .vitem &%-tls-on-connect%&
4605 .oindex "&%-tls-on-connect%&"
4606 .cindex "TLS" "use without STARTTLS"
4607 .cindex "TLS" "automatic start"
4608 This option is available when Exim is compiled with TLS support. It forces all
4609 incoming SMTP connections to behave as if the incoming port is listed in the
4610 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4611 &<<CHAPTLS>>& for further details.
4612
4613
4614 .vitem &%-U%&
4615 .oindex "&%-U%&"
4616 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4617 Sendmail uses this option for &"initial message submission"&, and its
4618 documentation states that in future releases, it may complain about
4619 syntactically invalid messages rather than fixing them when this flag is not
4620 set. Exim ignores this option.
4621
4622 .vitem &%-v%&
4623 .oindex "&%-v%&"
4624 This option causes Exim to write information to the standard error stream,
4625 describing what it is doing. In particular, it shows the log lines for
4626 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4627 dialogue is shown. Some of the log lines shown may not actually be written to
4628 the log if the setting of &%log_selector%& discards them. Any relevant
4629 selectors are shown with each log line. If none are shown, the logging is
4630 unconditional.
4631
4632 .vitem &%-x%&
4633 .oindex "&%-x%&"
4634 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4635 National Language Support extended characters in the body of the mail item"&).
4636 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4637 this option.
4638
4639 .vitem &%-X%&&~<&'logfile'&>
4640 .oindex "&%-X%&"
4641 This option is interpreted by Sendmail to cause debug information to be sent
4642 to the named file.  It is ignored by Exim.
4643 .endlist
4644
4645 .ecindex IIDclo1
4646 .ecindex IIDclo2
4647
4648
4649 . ////////////////////////////////////////////////////////////////////////////
4650 . Insert a stylized DocBook comment here, to identify the end of the command
4651 . line options. This is for the benefit of the Perl script that automatically
4652 . creates a man page for the options.
4653 . ////////////////////////////////////////////////////////////////////////////
4654
4655 .literal xml
4656 <!-- === End of command line options === -->
4657 .literal off
4658
4659
4660
4661
4662
4663 . ////////////////////////////////////////////////////////////////////////////
4664 . ////////////////////////////////////////////////////////////////////////////
4665
4666
4667 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4668          "The runtime configuration file"
4669
4670 .cindex "run time configuration"
4671 .cindex "configuration file" "general description"
4672 .cindex "CONFIGURE_FILE"
4673 .cindex "configuration file" "errors in"
4674 .cindex "error" "in configuration file"
4675 .cindex "return code" "for bad configuration"
4676 Exim uses a single run time configuration file that is read whenever an Exim
4677 binary is executed. Note that in normal operation, this happens frequently,
4678 because Exim is designed to operate in a distributed manner, without central
4679 control.
4680
4681 If a syntax error is detected while reading the configuration file, Exim
4682 writes a message on the standard error, and exits with a non-zero return code.
4683 The message is also written to the panic log. &*Note*&: Only simple syntax
4684 errors can be detected at this time. The values of any expanded options are
4685 not checked until the expansion happens, even when the expansion does not
4686 actually alter the string.
4687
4688 The name of the configuration file is compiled into the binary for security
4689 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4690 most configurations, this specifies a single file. However, it is permitted to
4691 give a colon-separated list of file names, in which case Exim uses the first
4692 existing file in the list.
4693
4694 .cindex "EXIM_USER"
4695 .cindex "EXIM_GROUP"
4696 .cindex "CONFIGURE_OWNER"
4697 .cindex "CONFIGURE_GROUP"
4698 .cindex "configuration file" "ownership"
4699 .cindex "ownership" "configuration file"
4700 The run time configuration file must be owned by root or by the user that is
4701 specified at compile time by the CONFIGURE_OWNER option (if set). The
4702 configuration file must not be world-writeable, or group-writeable unless its
4703 group is the root group or the one specified at compile time by the
4704 CONFIGURE_GROUP option.
4705
4706 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4707 to root, anybody who is able to edit the run time configuration file has an
4708 easy way to run commands as root. If you specify a user or group in the
4709 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4710 who are members of that group will trivially be able to obtain root privileges.
4711
4712 Up to Exim version 4.72, the run time configuration file was also permitted to
4713 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4714 since it offered a simple privilege escalation for any attacker who managed to
4715 compromise the Exim user account.
4716
4717 A default configuration file, which will work correctly in simple situations,
4718 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4719 defines just one file name, the installation process copies the default
4720 configuration to a new file of that name if it did not previously exist. If
4721 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4722 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4723 configuration.
4724
4725
4726
4727 .section "Using a different configuration file" "SECID40"
4728 .cindex "configuration file" "alternate"
4729 A one-off alternate configuration can be specified by the &%-C%& command line
4730 option, which may specify a single file or a list of files. However, when
4731 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4732 unless the argument for &%-C%& is identical to the built-in value from
4733 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4734 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4735 is useful mainly for checking the syntax of configuration files before
4736 installing them. No owner or group checks are done on a configuration file
4737 specified by &%-C%&, if root privilege has been dropped.
4738
4739 Even the Exim user is not trusted to specify an arbitrary configuration file
4740 with the &%-C%& option to be used with root privileges, unless that file is
4741 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4742 testing a configuration using &%-C%& right through message reception and
4743 delivery, even if the caller is root. The reception works, but by that time,
4744 Exim is running as the Exim user, so when it re-execs to regain privilege for
4745 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4746 can test reception and delivery using two separate commands (one to put a
4747 message on the queue, using &%-odq%&, and another to do the delivery, using
4748 &%-M%&).
4749
4750 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4751 prefix string with which any file named in a &%-C%& command line option must
4752 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4753 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4754 name can be used with &%-C%&.
4755
4756 One-off changes to a configuration can be specified by the &%-D%& command line
4757 option, which defines and overrides values for macros used inside the
4758 configuration file. However, like &%-C%&, the use of this option by a
4759 non-privileged user causes Exim to discard its root privilege.
4760 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4761 completely disabled, and its use causes an immediate error exit.
4762
4763 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4764 to declare certain macro names trusted, such that root privilege will not
4765 necessarily be discarded.
4766 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4767 considered safe and, if &%-D%& only supplies macros from this list, and the
4768 values are acceptable, then Exim will not give up root privilege if the caller
4769 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4770 transition mechanism and is expected to be removed in the future.  Acceptable
4771 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4772
4773 Some sites may wish to use the same Exim binary on different machines that
4774 share a file system, but to use different configuration files on each machine.
4775 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4776 looks for a file whose name is the configuration file name followed by a dot
4777 and the machine's node name, as obtained from the &[uname()]& function. If this
4778 file does not exist, the standard name is tried. This processing occurs for
4779 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4780
4781 In some esoteric situations different versions of Exim may be run under
4782 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4783 help with this. See the comments in &_src/EDITME_& for details.
4784
4785
4786
4787 .section "Configuration file format" "SECTconffilfor"
4788 .cindex "configuration file" "format of"
4789 .cindex "format" "configuration file"
4790 Exim's configuration file is divided into a number of different parts. General
4791 option settings must always appear at the start of the file. The other parts
4792 are all optional, and may appear in any order. Each part other than the first
4793 is introduced by the word &"begin"& followed by the name of the part. The
4794 optional parts are:
4795
4796 .ilist
4797 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4798 &<<CHAPACL>>&).
4799 .next
4800 .cindex "AUTH" "configuration"
4801 &'authenticators'&: Configuration settings for the authenticator drivers. These
4802 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4803 .next
4804 &'routers'&: Configuration settings for the router drivers. Routers process
4805 addresses and determine how the message is to be delivered (see chapters
4806 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4807 .next
4808 &'transports'&: Configuration settings for the transport drivers. Transports
4809 define mechanisms for copying messages to destinations (see chapters
4810 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4811 .next
4812 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4813 If there is no retry section, or if it is empty (that is, no retry rules are
4814 defined), Exim will not retry deliveries. In this situation, temporary errors
4815 are treated the same as permanent errors. Retry rules are discussed in chapter
4816 &<<CHAPretry>>&.
4817 .next
4818 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4819 when new addresses are generated during delivery. Rewriting is discussed in
4820 chapter &<<CHAPrewrite>>&.
4821 .next
4822 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4823 want to use this feature, you must set
4824 .code
4825 LOCAL_SCAN_HAS_OPTIONS=yes
4826 .endd
4827 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4828 facility are given in chapter &<<CHAPlocalscan>>&.
4829 .endlist
4830
4831 .cindex "configuration file" "leading white space in"
4832 .cindex "configuration file" "trailing white space in"
4833 .cindex "white space" "in configuration file"
4834 Leading and trailing white space in configuration lines is always ignored.
4835
4836 Blank lines in the file, and lines starting with a # character (ignoring
4837 leading white space) are treated as comments and are ignored. &*Note*&: A
4838 # character other than at the beginning of a line is not treated specially,
4839 and does not introduce a comment.
4840
4841 Any non-comment line can be continued by ending it with a backslash. Note that
4842 the general rule for white space means that trailing white space after the
4843 backslash and leading white space at the start of continuation
4844 lines is ignored. Comment lines beginning with # (but not empty lines) may
4845 appear in the middle of a sequence of continuation lines.
4846
4847 A convenient way to create a configuration file is to start from the
4848 default, which is supplied in &_src/configure.default_&, and add, delete, or
4849 change settings as required.
4850
4851 The ACLs, retry rules, and rewriting rules have their own syntax which is
4852 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4853 respectively. The other parts of the configuration file have some syntactic
4854 items in common, and these are described below, from section &<<SECTcos>>&
4855 onwards. Before that, the inclusion, macro, and conditional facilities are
4856 described.
4857
4858
4859
4860 .section "File inclusions in the configuration file" "SECID41"
4861 .cindex "inclusions in configuration file"
4862 .cindex "configuration file" "including other files"
4863 .cindex "&`.include`& in configuration file"
4864 .cindex "&`.include_if_exists`& in configuration file"
4865 You can include other files inside Exim's run time configuration file by
4866 using this syntax:
4867 .display
4868 &`.include`& <&'file name'&>
4869 &`.include_if_exists`& <&'file name'&>
4870 .endd
4871 on a line by itself. Double quotes round the file name are optional. If you use
4872 the first form, a configuration error occurs if the file does not exist; the
4873 second form does nothing for non-existent files. In all cases, an absolute file
4874 name is required.
4875
4876 Includes may be nested to any depth, but remember that Exim reads its
4877 configuration file often, so it is a good idea to keep them to a minimum.
4878 If you change the contents of an included file, you must HUP the daemon,
4879 because an included file is read only when the configuration itself is read.
4880
4881 The processing of inclusions happens early, at a physical line level, so, like
4882 comment lines, an inclusion can be used in the middle of an option setting,
4883 for example:
4884 .code
4885 hosts_lookup = a.b.c \
4886                .include /some/file
4887 .endd
4888 Include processing happens after macro processing (see below). Its effect is to
4889 process the lines of the included file as if they occurred inline where the
4890 inclusion appears.
4891
4892
4893
4894 .section "Macros in the configuration file" "SECTmacrodefs"
4895 .cindex "macro" "description of"
4896 .cindex "configuration file" "macros"
4897 If a line in the main part of the configuration (that is, before the first
4898 &"begin"& line) begins with an upper case letter, it is taken as a macro
4899 definition, and must be of the form
4900 .display
4901 <&'name'&> = <&'rest of line'&>
4902 .endd
4903 The name must consist of letters, digits, and underscores, and need not all be
4904 in upper case, though that is recommended. The rest of the line, including any
4905 continuations, is the replacement text, and has leading and trailing white
4906 space removed. Quotes are not removed. The replacement text can never end with
4907 a backslash character, but this doesn't seem to be a serious limitation.
4908
4909 Macros may also be defined between router, transport, authenticator, or ACL
4910 definitions. They may not, however, be defined within an individual driver or
4911 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4912
4913 .section "Macro substitution" "SECID42"
4914 Once a macro is defined, all subsequent lines in the file (and any included
4915 files) are scanned for the macro name; if there are several macros, the line is
4916 scanned for each in turn, in the order in which the macros are defined. The
4917 replacement text is not re-scanned for the current macro, though it is scanned
4918 for subsequently defined macros. For this reason, a macro name may not contain
4919 the name of a previously defined macro as a substring. You could, for example,
4920 define
4921 .display
4922 &`ABCD_XYZ = `&<&'something'&>
4923 &`ABCD = `&<&'something else'&>
4924 .endd
4925 but putting the definitions in the opposite order would provoke a configuration
4926 error. Macro expansion is applied to individual physical lines from the file,
4927 before checking for line continuation or file inclusion (see above). If a line
4928 consists solely of a macro name, and the expansion of the macro is empty, the
4929 line is ignored. A macro at the start of a line may turn the line into a
4930 comment line or a &`.include`& line.
4931
4932
4933 .section "Redefining macros" "SECID43"
4934 Once defined, the value of a macro can be redefined later in the configuration
4935 (or in an included file). Redefinition is specified by using &'=='& instead of
4936 &'='&. For example:
4937 .code
4938 MAC =  initial value
4939 ...
4940 MAC == updated value
4941 .endd
4942 Redefinition does not alter the order in which the macros are applied to the
4943 subsequent lines of the configuration file. It is still the same order in which
4944 the macros were originally defined. All that changes is the macro's value.
4945 Redefinition makes it possible to accumulate values. For example:
4946 .code
4947 MAC =  initial value
4948 ...
4949 MAC == MAC and something added
4950 .endd
4951 This can be helpful in situations where the configuration file is built
4952 from a number of other files.
4953
4954 .section "Overriding macro values" "SECID44"
4955 The values set for macros in the configuration file can be overridden by the
4956 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4957 used, unless called by root or the Exim user. A definition on the command line
4958 using the &%-D%& option causes all definitions and redefinitions within the
4959 file to be ignored.
4960
4961
4962
4963 .section "Example of macro usage" "SECID45"
4964 As an example of macro usage, consider a configuration where aliases are looked
4965 up in a MySQL database. It helps to keep the file less cluttered if long
4966 strings such as SQL statements are defined separately as macros, for example:
4967 .code
4968 ALIAS_QUERY = select mailbox from user where \
4969               login='${quote_mysql:$local_part}';
4970 .endd
4971 This can then be used in a &(redirect)& router setting like this:
4972 .code
4973 data = ${lookup mysql{ALIAS_QUERY}}
4974 .endd
4975 In earlier versions of Exim macros were sometimes used for domain, host, or
4976 address lists. In Exim 4 these are handled better by named lists &-- see
4977 section &<<SECTnamedlists>>&.
4978
4979
4980 .section "Conditional skips in the configuration file" "SECID46"
4981 .cindex "configuration file" "conditional skips"
4982 .cindex "&`.ifdef`&"
4983 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4984 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4985 portions of the configuration file. The processing happens whenever the file is
4986 read (that is, when an Exim binary starts to run).
4987
4988 The implementation is very simple. Instances of the first four directives must
4989 be followed by text that includes the names of one or macros. The condition
4990 that is tested is whether or not any macro substitution has taken place in the
4991 line. Thus:
4992 .code
4993 .ifdef AAA
4994 message_size_limit = 50M
4995 .else
4996 message_size_limit = 100M
4997 .endif
4998 .endd
4999 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5000 otherwise. If there is more than one macro named on the line, the condition
5001 is true if any of them are defined. That is, it is an &"or"& condition. To
5002 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5003
5004 Although you can use a macro expansion to generate one of these directives,
5005 it is not very useful, because the condition &"there was a macro substitution
5006 in this line"& will always be true.
5007
5008 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5009 to clarify complicated nestings.
5010
5011
5012
5013 .section "Common option syntax" "SECTcos"
5014 .cindex "common option syntax"
5015 .cindex "syntax of common options"
5016 .cindex "configuration file" "common option syntax"
5017 For the main set of options, driver options, and &[local_scan()]& options,
5018 each setting is on a line by itself, and starts with a name consisting of
5019 lower-case letters and underscores. Many options require a data value, and in
5020 these cases the name must be followed by an equals sign (with optional white
5021 space) and then the value. For example:
5022 .code
5023 qualify_domain = mydomain.example.com
5024 .endd
5025 .cindex "hiding configuration option values"
5026 .cindex "configuration options" "hiding value of"
5027 .cindex "options" "hiding value of"
5028 Some option settings may contain sensitive data, for example, passwords for
5029 accessing databases. To stop non-admin users from using the &%-bP%& command
5030 line option to read these values, you can precede the option settings with the
5031 word &"hide"&. For example:
5032 .code
5033 hide mysql_servers = localhost/users/admin/secret-password
5034 .endd
5035 For non-admin users, such options are displayed like this:
5036 .code
5037 mysql_servers = <value not displayable>
5038 .endd
5039 If &"hide"& is used on a driver option, it hides the value of that option on
5040 all instances of the same driver.
5041
5042 The following sections describe the syntax used for the different data types
5043 that are found in option settings.
5044
5045
5046 .section "Boolean options" "SECID47"
5047 .cindex "format" "boolean"
5048 .cindex "boolean configuration values"
5049 .oindex "&%no_%&&'xxx'&"
5050 .oindex "&%not_%&&'xxx'&"
5051 Options whose type is given as boolean are on/off switches. There are two
5052 different ways of specifying such options: with and without a data value. If
5053 the option name is specified on its own without data, the switch is turned on;
5054 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5055 boolean options may be followed by an equals sign and one of the words
5056 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5057 the following two settings have exactly the same effect:
5058 .code
5059 queue_only
5060 queue_only = true
5061 .endd
5062 The following two lines also have the same (opposite) effect:
5063 .code
5064 no_queue_only
5065 queue_only = false
5066 .endd
5067 You can use whichever syntax you prefer.
5068
5069
5070
5071
5072 .section "Integer values" "SECID48"
5073 .cindex "integer configuration values"
5074 .cindex "format" "integer"
5075 If an option's type is given as &"integer"&, the value can be given in decimal,
5076 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5077 number is assumed. Otherwise, it is treated as an octal number unless it starts
5078 with the characters &"0x"&, in which case the remainder is interpreted as a
5079 hexadecimal number.
5080
5081 If an integer value is followed by the letter K, it is multiplied by 1024; if
5082 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5083 of integer option settings are output, values which are an exact multiple of
5084 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5085 and M. The printing style is independent of the actual input format that was
5086 used.
5087
5088
5089 .section "Octal integer values" "SECID49"
5090 .cindex "integer format"
5091 .cindex "format" "octal integer"
5092 If an option's type is given as &"octal integer"&, its value is always
5093 interpreted as an octal number, whether or not it starts with the digit zero.
5094 Such options are always output in octal.
5095
5096
5097 .section "Fixed point numbers" "SECID50"
5098 .cindex "fixed point configuration values"
5099 .cindex "format" "fixed point"
5100 If an option's type is given as &"fixed-point"&, its value must be a decimal
5101 integer, optionally followed by a decimal point and up to three further digits.
5102
5103
5104
5105 .section "Time intervals" "SECTtimeformat"
5106 .cindex "time interval" "specifying in configuration"
5107 .cindex "format" "time interval"
5108 A time interval is specified as a sequence of numbers, each followed by one of
5109 the following letters, with no intervening white space:
5110
5111 .table2 30pt
5112 .irow &%s%& seconds
5113 .irow &%m%& minutes
5114 .irow &%h%& hours
5115 .irow &%d%& days
5116 .irow &%w%& weeks
5117 .endtable
5118
5119 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5120 intervals are output in the same format. Exim does not restrict the values; it
5121 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5122
5123
5124
5125 .section "String values" "SECTstrings"
5126 .cindex "string" "format of configuration values"
5127 .cindex "format" "string"
5128 If an option's type is specified as &"string"&, the value can be specified with
5129 or without double-quotes. If it does not start with a double-quote, the value
5130 consists of the remainder of the line plus any continuation lines, starting at
5131 the first character after any leading white space, with trailing white space
5132 removed, and with no interpretation of the characters in the string. Because
5133 Exim removes comment lines (those beginning with #) at an early stage, they can
5134 appear in the middle of a multi-line string. The following two settings are
5135 therefore equivalent:
5136 .code
5137 trusted_users = uucp:mail
5138 trusted_users = uucp:\
5139                 # This comment line is ignored
5140                 mail
5141 .endd
5142 .cindex "string" "quoted"
5143 .cindex "escape characters in quoted strings"
5144 If a string does start with a double-quote, it must end with a closing
5145 double-quote, and any backslash characters other than those used for line
5146 continuation are interpreted as escape characters, as follows:
5147
5148 .table2 100pt
5149 .irow &`\\`&                     "single backslash"
5150 .irow &`\n`&                     "newline"
5151 .irow &`\r`&                     "carriage return"
5152 .irow &`\t`&                     "tab"
5153 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5154 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5155                                    character"
5156 .endtable
5157
5158 If a backslash is followed by some other character, including a double-quote
5159 character, that character replaces the pair.
5160
5161 Quoting is necessary only if you want to make use of the backslash escapes to
5162 insert special characters, or if you need to specify a value with leading or
5163 trailing spaces. These cases are rare, so quoting is almost never needed in
5164 current versions of Exim. In versions of Exim before 3.14, quoting was required
5165 in order to continue lines, so you may come across older configuration files
5166 and examples that apparently quote unnecessarily.
5167
5168
5169 .section "Expanded strings" "SECID51"
5170 .cindex "expansion" "definition of"
5171 Some strings in the configuration file are subjected to &'string expansion'&,
5172 by which means various parts of the string may be changed according to the
5173 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5174 is as just described; in particular, the handling of backslashes in quoted
5175 strings is done as part of the input process, before expansion takes place.
5176 However, backslash is also an escape character for the expander, so any
5177 backslashes that are required for that reason must be doubled if they are
5178 within a quoted configuration string.
5179
5180
5181 .section "User and group names" "SECID52"
5182 .cindex "user name" "format of"
5183 .cindex "format" "user name"
5184 .cindex "groups" "name format"
5185 .cindex "format" "group name"
5186 User and group names are specified as strings, using the syntax described
5187 above, but the strings are interpreted specially. A user or group name must
5188 either consist entirely of digits, or be a name that can be looked up using the
5189 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5190
5191
5192 .section "List construction" "SECTlistconstruct"
5193 .cindex "list" "syntax of in configuration"
5194 .cindex "format" "list item in configuration"
5195 .cindex "string" "list, definition of"
5196 The data for some configuration options is a list of items, with colon as the
5197 default separator. Many of these options are shown with type &"string list"& in
5198 the descriptions later in this document. Others are listed as &"domain list"&,
5199 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5200 are all the same; however, those other than &"string list"& are subject to
5201 particular kinds of interpretation, as described in chapter
5202 &<<CHAPdomhosaddlists>>&.
5203
5204 In all these cases, the entire list is treated as a single string as far as the
5205 input syntax is concerned. The &%trusted_users%& setting in section
5206 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5207 in a list, it must be entered as two colons. Leading and trailing white space
5208 on each item in a list is ignored. This makes it possible to include items that
5209 start with a colon, and in particular, certain forms of IPv6 address. For
5210 example, the list
5211 .code
5212 local_interfaces = 127.0.0.1 : ::::1
5213 .endd
5214 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5215
5216 &*Note*&: Although leading and trailing white space is ignored in individual
5217 list items, it is not ignored when parsing the list. The space after the first
5218 colon in the example above is necessary. If it were not there, the list would
5219 be interpreted as the two items 127.0.0.1:: and 1.
5220
5221 .section "Changing list separators" "SECID53"
5222 .cindex "list separator" "changing"
5223 .cindex "IPv6" "addresses in lists"
5224 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5225 introduced to allow the separator character to be changed. If a list begins
5226 with a left angle bracket, followed by any punctuation character, that
5227 character is used instead of colon as the list separator. For example, the list
5228 above can be rewritten to use a semicolon separator like this:
5229 .code
5230 local_interfaces = <; 127.0.0.1 ; ::1
5231 .endd
5232 This facility applies to all lists, with the exception of the list in
5233 &%log_file_path%&. It is recommended that the use of non-colon separators be
5234 confined to circumstances where they really are needed.
5235
5236 .cindex "list separator" "newline as"
5237 .cindex "newline" "as list separator"
5238 It is also possible to use newline and other control characters (those with
5239 code values less than 32, plus DEL) as separators in lists. Such separators
5240 must be provided literally at the time the list is processed. For options that
5241 are string-expanded, you can write the separator using a normal escape
5242 sequence. This will be processed by the expander before the string is
5243 interpreted as a list. For example, if a newline-separated list of domains is
5244 generated by a lookup, you can process it directly by a line such as this:
5245 .code
5246 domains = <\n ${lookup mysql{.....}}
5247 .endd
5248 This avoids having to change the list separator in such data. You are unlikely
5249 to want to use a control character as a separator in an option that is not
5250 expanded, because the value is literal text. However, it can be done by giving
5251 the value in quotes. For example:
5252 .code
5253 local_interfaces = "<\n 127.0.0.1 \n ::1"
5254 .endd
5255 Unlike printing character separators, which can be included in list items by
5256 doubling, it is not possible to include a control character as data when it is
5257 set as the separator. Two such characters in succession are interpreted as
5258 enclosing an empty list item.
5259
5260
5261
5262 .section "Empty items in lists" "SECTempitelis"
5263 .cindex "list" "empty item in"
5264 An empty item at the end of a list is always ignored. In other words, trailing
5265 separator characters are ignored. Thus, the list in
5266 .code
5267 senders = user@domain :
5268 .endd
5269 contains only a single item. If you want to include an empty string as one item
5270 in a list, it must not be the last item. For example, this list contains three
5271 items, the second of which is empty:
5272 .code
5273 senders = user1@domain : : user2@domain
5274 .endd
5275 &*Note*&: There must be white space between the two colons, as otherwise they
5276 are interpreted as representing a single colon data character (and the list
5277 would then contain just one item). If you want to specify a list that contains
5278 just one, empty item, you can do it as in this example:
5279 .code
5280 senders = :
5281 .endd
5282 In this case, the first item is empty, and the second is discarded because it
5283 is at the end of the list.
5284
5285
5286
5287
5288 .section "Format of driver configurations" "SECTfordricon"
5289 .cindex "drivers" "configuration format"
5290 There are separate parts in the configuration for defining routers, transports,
5291 and authenticators. In each part, you are defining a number of driver
5292 instances, each with its own set of options. Each driver instance is defined by
5293 a sequence of lines like this:
5294 .display
5295 <&'instance name'&>:
5296   <&'option'&>
5297   ...
5298   <&'option'&>
5299 .endd
5300 In the following example, the instance name is &(localuser)&, and it is
5301 followed by three options settings:
5302 .code
5303 localuser:
5304   driver = accept
5305   check_local_user
5306   transport = local_delivery
5307 .endd
5308 For each driver instance, you specify which Exim code module it uses &-- by the
5309 setting of the &%driver%& option &-- and (optionally) some configuration
5310 settings. For example, in the case of transports, if you want a transport to
5311 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5312 a local file you would use the &(appendfile)& driver. Each of the drivers is
5313 described in detail in its own separate chapter later in this manual.
5314
5315 You can have several routers, transports, or authenticators that are based on
5316 the same underlying driver (each must have a different instance name).
5317
5318 The order in which routers are defined is important, because addresses are
5319 passed to individual routers one by one, in order. The order in which
5320 transports are defined does not matter at all. The order in which
5321 authenticators are defined is used only when Exim, as a client, is searching
5322 them to find one that matches an authentication mechanism offered by the
5323 server.
5324
5325 .cindex "generic options"
5326 .cindex "options" "generic &-- definition of"
5327 Within a driver instance definition, there are two kinds of option: &'generic'&
5328 and &'private'&. The generic options are those that apply to all drivers of the
5329 same type (that is, all routers, all transports or all authenticators). The
5330 &%driver%& option is a generic option that must appear in every definition.
5331 .cindex "private options"
5332 The private options are special for each driver, and none need appear, because
5333 they all have default values.
5334
5335 The options may appear in any order, except that the &%driver%& option must
5336 precede any private options, since these depend on the particular driver. For
5337 this reason, it is recommended that &%driver%& always be the first option.
5338
5339 Driver instance names, which are used for reference in log entries and
5340 elsewhere, can be any sequence of letters, digits, and underscores (starting
5341 with a letter) and must be unique among drivers of the same type. A router and
5342 a transport (for example) can each have the same name, but no two router
5343 instances can have the same name. The name of a driver instance should not be
5344 confused with the name of the underlying driver module. For example, the
5345 configuration lines:
5346 .code
5347 remote_smtp:
5348   driver = smtp
5349 .endd
5350 create an instance of the &(smtp)& transport driver whose name is
5351 &(remote_smtp)&. The same driver code can be used more than once, with
5352 different instance names and different option settings each time. A second
5353 instance of the &(smtp)& transport, with different options, might be defined
5354 thus:
5355 .code
5356 special_smtp:
5357   driver = smtp
5358   port = 1234
5359   command_timeout = 10s
5360 .endd
5361 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5362 these transport instances from routers, and these names would appear in log
5363 lines.
5364
5365 Comment lines may be present in the middle of driver specifications. The full
5366 list of option settings for any particular driver instance, including all the
5367 defaulted values, can be extracted by making use of the &%-bP%& command line
5368 option.
5369
5370
5371
5372
5373
5374
5375 . ////////////////////////////////////////////////////////////////////////////
5376 . ////////////////////////////////////////////////////////////////////////////
5377
5378 .chapter "The default configuration file" "CHAPdefconfil"
5379 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5380 .cindex "default" "configuration file &""walk through""&"
5381 The default configuration file supplied with Exim as &_src/configure.default_&
5382 is sufficient for a host with simple mail requirements. As an introduction to
5383 the way Exim is configured, this chapter &"walks through"& the default
5384 configuration, giving brief explanations of the settings. Detailed descriptions
5385 of the options are given in subsequent chapters. The default configuration file
5386 itself contains extensive comments about ways you might want to modify the
5387 initial settings. However, note that there are many options that are not
5388 mentioned at all in the default configuration.
5389
5390
5391
5392 .section "Main configuration settings" "SECTdefconfmain"
5393 The main (global) configuration option settings must always come first in the
5394 file. The first thing you'll see in the file, after some initial comments, is
5395 the line
5396 .code
5397 # primary_hostname =
5398 .endd
5399 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5400 to know the official, fully qualified name of your host, and this is where you
5401 can specify it. However, in most cases you do not need to set this option. When
5402 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5403
5404 The first three non-comment configuration lines are as follows:
5405 .code
5406 domainlist local_domains    = @
5407 domainlist relay_to_domains =
5408 hostlist   relay_from_hosts = 127.0.0.1
5409 .endd
5410 These are not, in fact, option settings. They are definitions of two named
5411 domain lists and one named host list. Exim allows you to give names to lists of
5412 domains, hosts, and email addresses, in order to make it easier to manage the
5413 configuration file (see section &<<SECTnamedlists>>&).
5414
5415 The first line defines a domain list called &'local_domains'&; this is used
5416 later in the configuration to identify domains that are to be delivered
5417 on the local host.
5418
5419 .cindex "@ in a domain list"
5420 There is just one item in this list, the string &"@"&. This is a special form
5421 of entry which means &"the name of the local host"&. Thus, if the local host is
5422 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5423 be delivered locally. Because the local host's name is referenced indirectly,
5424 the same configuration file can be used on different hosts.
5425
5426 The second line defines a domain list called &'relay_to_domains'&, but the
5427 list itself is empty. Later in the configuration we will come to the part that
5428 controls mail relaying through the local host; it allows relaying to any
5429 domains in this list. By default, therefore, no relaying on the basis of a mail
5430 domain is permitted.
5431
5432 The third line defines a host list called &'relay_from_hosts'&. This list is
5433 used later in the configuration to permit relaying from any host or IP address
5434 that matches the list. The default contains just the IP address of the IPv4
5435 loopback interface, which means that processes on the local host are able to
5436 submit mail for relaying by sending it over TCP/IP to that interface. No other
5437 hosts are permitted to submit messages for relaying.
5438
5439 Just to be sure there's no misunderstanding: at this point in the configuration
5440 we aren't actually setting up any controls. We are just defining some domains
5441 and hosts that will be used in the controls that are specified later.
5442
5443 The next two configuration lines are genuine option settings:
5444 .code
5445 acl_smtp_rcpt = acl_check_rcpt
5446 acl_smtp_data = acl_check_data
5447 .endd
5448 These options specify &'Access Control Lists'& (ACLs) that are to be used
5449 during an incoming SMTP session for every recipient of a message (every RCPT
5450 command), and after the contents of the message have been received,
5451 respectively. The names of the lists are &'acl_check_rcpt'& and
5452 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5453 section of the configuration. The RCPT ACL controls which recipients are
5454 accepted for an incoming message &-- if a configuration does not provide an ACL
5455 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5456 contents of a message to be checked.
5457
5458 Two commented-out option settings are next:
5459 .code
5460 # av_scanner = clamd:/tmp/clamd
5461 # spamd_address = 127.0.0.1 783
5462 .endd
5463 These are example settings that can be used when Exim is compiled with the
5464 content-scanning extension. The first specifies the interface to the virus
5465 scanner, and the second specifies the interface to SpamAssassin. Further
5466 details are given in chapter &<<CHAPexiscan>>&.
5467
5468 Three more commented-out option settings follow:
5469 .code
5470 # tls_advertise_hosts = *
5471 # tls_certificate = /etc/ssl/exim.crt
5472 # tls_privatekey = /etc/ssl/exim.pem
5473 .endd
5474 These are example settings that can be used when Exim is compiled with
5475 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5476 first one specifies the list of clients that are allowed to use TLS when
5477 connecting to this server; in this case the wildcard means all clients. The
5478 other options specify where Exim should find its TLS certificate and private
5479 key, which together prove the server's identity to any clients that connect.
5480 More details are given in chapter &<<CHAPTLS>>&.
5481
5482 Another two commented-out option settings follow:
5483 .code
5484 # daemon_smtp_ports = 25 : 465 : 587
5485 # tls_on_connect_ports = 465
5486 .endd
5487 .cindex "port" "465 and 587"
5488 .cindex "port" "for message submission"
5489 .cindex "message" "submission, ports for"
5490 .cindex "ssmtp protocol"
5491 .cindex "smtps protocol"
5492 .cindex "SMTP" "ssmtp protocol"
5493 .cindex "SMTP" "smtps protocol"
5494 These options provide better support for roaming users who wish to use this
5495 server for message submission. They are not much use unless you have turned on
5496 TLS (as described in the previous paragraph) and authentication (about which
5497 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5498 on end-user networks, so RFC 4409 specifies that message submission should use
5499 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5500 configured to use port 587 correctly, so these settings also enable the
5501 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5502 &<<SECTsupobssmt>>&).
5503
5504 Two more commented-out options settings follow:
5505 .code
5506 # qualify_domain =
5507 # qualify_recipient =
5508 .endd
5509 The first of these specifies a domain that Exim uses when it constructs a
5510 complete email address from a local login name. This is often needed when Exim
5511 receives a message from a local process. If you do not set &%qualify_domain%&,
5512 the value of &%primary_hostname%& is used. If you set both of these options,
5513 you can have different qualification domains for sender and recipient
5514 addresses. If you set only the first one, its value is used in both cases.
5515
5516 .cindex "domain literal" "recognizing format"
5517 The following line must be uncommented if you want Exim to recognize
5518 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5519 (an IP address within square brackets) instead of a named domain.
5520 .code
5521 # allow_domain_literals
5522 .endd
5523 The RFCs still require this form, but many people think that in the modern
5524 Internet it makes little sense to permit mail to be sent to specific hosts by
5525 quoting their IP addresses. This ancient format has been used by people who
5526 try to abuse hosts by using them for unwanted relaying. However, some
5527 people believe there are circumstances (for example, messages addressed to
5528 &'postmaster'&) where domain literals are still useful.
5529
5530 The next configuration line is a kind of trigger guard:
5531 .code
5532 never_users = root
5533 .endd
5534 It specifies that no delivery must ever be run as the root user. The normal
5535 convention is to set up &'root'& as an alias for the system administrator. This
5536 setting is a guard against slips in the configuration.
5537 The list of users specified by &%never_users%& is not, however, the complete
5538 list; the build-time configuration in &_Local/Makefile_& has an option called
5539 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5540 contents of &%never_users%& are added to this list. By default
5541 FIXED_NEVER_USERS also specifies root.
5542
5543 When a remote host connects to Exim in order to send mail, the only information
5544 Exim has about the host's identity is its IP address. The next configuration
5545 line,
5546 .code
5547 host_lookup = *
5548 .endd
5549 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5550 in order to get a host name. This improves the quality of the logging
5551 information, but if you feel it is too expensive, you can remove it entirely,
5552 or restrict the lookup to hosts on &"nearby"& networks.
5553 Note that it is not always possible to find a host name from an IP address,
5554 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5555 unreachable.
5556
5557 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5558 1413 (hence their names):
5559 .code
5560 rfc1413_hosts = *
5561 rfc1413_query_timeout = 0s
5562 .endd
5563 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5564 Few hosts offer RFC1413 service these days; calls have to be
5565 terminated by a timeout and this needlessly delays the startup
5566 of an incoming SMTP connection.
5567 If you have hosts for which you trust RFC1413 and need this
5568 information, you can change this.
5569
5570 This line enables an efficiency SMTP option.  It is negociated by clients
5571 and not expected to cause problems but can be disabled if needed.
5572 .code
5573 prdr_enable = true
5574 .endd
5575
5576 When Exim receives messages over SMTP connections, it expects all addresses to
5577 be fully qualified with a domain, as required by the SMTP definition. However,
5578 if you are running a server to which simple clients submit messages, you may
5579 find that they send unqualified addresses. The two commented-out options:
5580 .code
5581 # sender_unqualified_hosts =
5582 # recipient_unqualified_hosts =
5583 .endd
5584 show how you can specify hosts that are permitted to send unqualified sender
5585 and recipient addresses, respectively.
5586
5587 The &%percent_hack_domains%& option is also commented out:
5588 .code
5589 # percent_hack_domains =
5590 .endd
5591 It provides a list of domains for which the &"percent hack"& is to operate.
5592 This is an almost obsolete form of explicit email routing. If you do not know
5593 anything about it, you can safely ignore this topic.
5594
5595 The last two settings in the main part of the default configuration are
5596 concerned with messages that have been &"frozen"& on Exim's queue. When a
5597 message is frozen, Exim no longer continues to try to deliver it. Freezing
5598 occurs when a bounce message encounters a permanent failure because the sender
5599 address of the original message that caused the bounce is invalid, so the
5600 bounce cannot be delivered. This is probably the most common case, but there
5601 are also other conditions that cause freezing, and frozen messages are not
5602 always bounce messages.
5603 .code
5604 ignore_bounce_errors_after = 2d
5605 timeout_frozen_after = 7d
5606 .endd
5607 The first of these options specifies that failing bounce messages are to be
5608 discarded after 2 days on the queue. The second specifies that any frozen
5609 message (whether a bounce message or not) is to be timed out (and discarded)
5610 after a week. In this configuration, the first setting ensures that no failing
5611 bounce message ever lasts a week.
5612
5613
5614
5615 .section "ACL configuration" "SECID54"
5616 .cindex "default" "ACLs"
5617 .cindex "&ACL;" "default configuration"
5618 In the default configuration, the ACL section follows the main configuration.
5619 It starts with the line
5620 .code
5621 begin acl
5622 .endd
5623 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5624 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5625 and &%acl_smtp_data%& above.
5626
5627 .cindex "RCPT" "ACL for"
5628 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5629 RCPT command specifies one of the message's recipients. The ACL statements
5630 are considered in order, until the recipient address is either accepted or
5631 rejected. The RCPT command is then accepted or rejected, according to the
5632 result of the ACL processing.
5633 .code
5634 acl_check_rcpt:
5635 .endd
5636 This line, consisting of a name terminated by a colon, marks the start of the
5637 ACL, and names it.
5638 .code
5639 accept  hosts = :
5640 .endd
5641 This ACL statement accepts the recipient if the sending host matches the list.
5642 But what does that strange list mean? It doesn't actually contain any host
5643 names or IP addresses. The presence of the colon puts an empty item in the
5644 list; Exim matches this only if the incoming message did not come from a remote
5645 host, because in that case, the remote hostname is empty. The colon is
5646 important. Without it, the list itself is empty, and can never match anything.
5647
5648 What this statement is doing is to accept unconditionally all recipients in
5649 messages that are submitted by SMTP from local processes using the standard
5650 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5651 manner.
5652 .code
5653 deny    message       = Restricted characters in address
5654         domains       = +local_domains
5655         local_parts   = ^[.] : ^.*[@%!/|]
5656
5657 deny    message       = Restricted characters in address
5658         domains       = !+local_domains
5659         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5660 .endd
5661 These statements are concerned with local parts that contain any of the
5662 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5663 Although these characters are entirely legal in local parts (in the case of
5664 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5665 in Internet mail addresses.
5666
5667 The first three have in the past been associated with explicitly routed
5668 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5669 option). Addresses containing these characters are regularly tried by spammers
5670 in an attempt to bypass relaying restrictions, and also by open relay testing
5671 programs. Unless you really need them it is safest to reject these characters
5672 at this early stage. This configuration is heavy-handed in rejecting these
5673 characters for all messages it accepts from remote hosts. This is a deliberate
5674 policy of being as safe as possible.
5675
5676 The first rule above is stricter, and is applied to messages that are addressed
5677 to one of the local domains handled by this host. This is implemented by the
5678 first condition, which restricts it to domains that are listed in the
5679 &'local_domains'& domain list. The &"+"& character is used to indicate a
5680 reference to a named list. In this configuration, there is just one domain in
5681 &'local_domains'&, but in general there may be many.
5682
5683 The second condition on the first statement uses two regular expressions to
5684 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5685 or &"|"&. If you have local accounts that include these characters, you will
5686 have to modify this rule.
5687
5688 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5689 allows them because they have been encountered in practice. (Consider the
5690 common convention of local parts constructed as
5691 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5692 the author of Exim, who has no second initial.) However, a local part starting
5693 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5694 file name (for example, for a mailing list). This is also true for local parts
5695 that contain slashes. A pipe symbol can also be troublesome if the local part
5696 is incorporated unthinkingly into a shell command line.
5697
5698 The second rule above applies to all other domains, and is less strict. This
5699 allows your own users to send outgoing messages to sites that use slashes
5700 and vertical bars in their local parts. It blocks local parts that begin
5701 with a dot, slash, or vertical bar, but allows these characters within the
5702 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5703 and &"!"& is blocked, as before. The motivation here is to prevent your users
5704 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5705 .code
5706 accept  local_parts   = postmaster
5707         domains       = +local_domains
5708 .endd
5709 This statement, which has two conditions, accepts an incoming address if the
5710 local part is &'postmaster'& and the domain is one of those listed in the
5711 &'local_domains'& domain list. The &"+"& character is used to indicate a
5712 reference to a named list. In this configuration, there is just one domain in
5713 &'local_domains'&, but in general there may be many.
5714
5715 The presence of this statement means that mail to postmaster is never blocked
5716 by any of the subsequent tests. This can be helpful while sorting out problems
5717 in cases where the subsequent tests are incorrectly denying access.
5718 .code
5719 require verify        = sender
5720 .endd
5721 This statement requires the sender address to be verified before any subsequent
5722 ACL statement can be used. If verification fails, the incoming recipient
5723 address is refused. Verification consists of trying to route the address, to
5724 see if a bounce message could be delivered to it. In the case of remote
5725 addresses, basic verification checks only the domain, but &'callouts'& can be
5726 used for more verification if required. Section &<<SECTaddressverification>>&
5727 discusses the details of address verification.
5728 .code
5729 accept  hosts         = +relay_from_hosts
5730         control       = submission
5731 .endd
5732 This statement accepts the address if the message is coming from one of the
5733 hosts that are defined as being allowed to relay through this host. Recipient
5734 verification is omitted here, because in many cases the clients are dumb MUAs
5735 that do not cope well with SMTP error responses. For the same reason, the
5736 second line specifies &"submission mode"& for messages that are accepted. This
5737 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5738 messages that are deficient in some way, for example, because they lack a
5739 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5740 probably add recipient verification here, and disable submission mode.
5741 .code
5742 accept  authenticated = *
5743         control       = submission
5744 .endd
5745 This statement accepts the address if the client host has authenticated itself.
5746 Submission mode is again specified, on the grounds that such messages are most
5747 likely to come from MUAs. The default configuration does not define any
5748 authenticators, though it does include some nearly complete commented-out
5749 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5750 fact authenticate until you complete the authenticator definitions.
5751 .code
5752 require message = relay not permitted
5753         domains = +local_domains : +relay_to_domains
5754 .endd
5755 This statement rejects the address if its domain is neither a local domain nor
5756 one of the domains for which this host is a relay.
5757 .code
5758 require verify = recipient
5759 .endd
5760 This statement requires the recipient address to be verified; if verification
5761 fails, the address is rejected.
5762 .code
5763 # deny    message     = rejected because $sender_host_address \
5764 #                       is in a black list at $dnslist_domain\n\
5765 #                       $dnslist_text
5766 #         dnslists    = black.list.example
5767 #
5768 # warn    dnslists    = black.list.example
5769 #         add_header  = X-Warning: $sender_host_address is in \
5770 #                       a black list at $dnslist_domain
5771 #         log_message = found in $dnslist_domain
5772 .endd
5773 These commented-out lines are examples of how you could configure Exim to check
5774 sending hosts against a DNS black list. The first statement rejects messages
5775 from blacklisted hosts, whereas the second just inserts a warning header
5776 line.
5777 .code
5778 # require verify = csa
5779 .endd
5780 This commented-out line is an example of how you could turn on client SMTP
5781 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5782 records.
5783 .code
5784 accept
5785 .endd
5786 The final statement in the first ACL unconditionally accepts any recipient
5787 address that has successfully passed all the previous tests.
5788 .code
5789 acl_check_data:
5790 .endd
5791 This line marks the start of the second ACL, and names it. Most of the contents
5792 of this ACL are commented out:
5793 .code
5794 # deny    malware   = *
5795 #         message   = This message contains a virus \
5796 #                     ($malware_name).
5797 .endd
5798 These lines are examples of how to arrange for messages to be scanned for
5799 viruses when Exim has been compiled with the content-scanning extension, and a
5800 suitable virus scanner is installed. If the message is found to contain a
5801 virus, it is rejected with the given custom error message.
5802 .code
5803 # warn    spam      = nobody
5804 #         message   = X-Spam_score: $spam_score\n\
5805 #                     X-Spam_score_int: $spam_score_int\n\
5806 #                     X-Spam_bar: $spam_bar\n\
5807 #                     X-Spam_report: $spam_report
5808 .endd
5809 These lines are an example of how to arrange for messages to be scanned by
5810 SpamAssassin when Exim has been compiled with the content-scanning extension,
5811 and SpamAssassin has been installed. The SpamAssassin check is run with
5812 &`nobody`& as its user parameter, and the results are added to the message as a
5813 series of extra header line. In this case, the message is not rejected,
5814 whatever the spam score.
5815 .code
5816 accept
5817 .endd
5818 This final line in the DATA ACL accepts the message unconditionally.
5819
5820
5821 .section "Router configuration" "SECID55"
5822 .cindex "default" "routers"
5823 .cindex "routers" "default"
5824 The router configuration comes next in the default configuration, introduced
5825 by the line
5826 .code
5827 begin routers
5828 .endd
5829 Routers are the modules in Exim that make decisions about where to send
5830 messages. An address is passed to each router in turn, until it is either
5831 accepted, or failed. This means that the order in which you define the routers
5832 matters. Each router is fully described in its own chapter later in this
5833 manual. Here we give only brief overviews.
5834 .code
5835 # domain_literal:
5836 #   driver = ipliteral
5837 #   domains = !+local_domains
5838 #   transport = remote_smtp
5839 .endd
5840 .cindex "domain literal" "default router"
5841 This router is commented out because the majority of sites do not want to
5842 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5843 you uncomment this router, you also need to uncomment the setting of
5844 &%allow_domain_literals%& in the main part of the configuration.
5845 .code
5846 dnslookup:
5847   driver = dnslookup
5848   domains = ! +local_domains
5849   transport = remote_smtp
5850   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5851   no_more
5852 .endd
5853 The first uncommented router handles addresses that do not involve any local
5854 domains. This is specified by the line
5855 .code
5856 domains = ! +local_domains
5857 .endd
5858 The &%domains%& option lists the domains to which this router applies, but the
5859 exclamation mark is a negation sign, so the router is used only for domains
5860 that are not in the domain list called &'local_domains'& (which was defined at
5861 the start of the configuration). The plus sign before &'local_domains'&
5862 indicates that it is referring to a named list. Addresses in other domains are
5863 passed on to the following routers.
5864
5865 The name of the router driver is &(dnslookup)&,
5866 and is specified by the &%driver%& option. Do not be confused by the fact that
5867 the name of this router instance is the same as the name of the driver. The
5868 instance name is arbitrary, but the name set in the &%driver%& option must be
5869 one of the driver modules that is in the Exim binary.
5870
5871 The &(dnslookup)& router routes addresses by looking up their domains in the
5872 DNS in order to obtain a list of hosts to which the address is routed. If the
5873 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5874 specified by the &%transport%& option. If the router does not find the domain
5875 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5876 the address fails and is bounced.
5877
5878 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5879 be entirely ignored. This option is present because a number of cases have been
5880 encountered where MX records in the DNS point to host names
5881 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5882 Completely ignoring these IP addresses causes Exim to fail to route the
5883 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5884 continue to try to deliver the message periodically until the address timed
5885 out.
5886 .code
5887 system_aliases:
5888   driver = redirect
5889   allow_fail
5890   allow_defer
5891   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5892 # user = exim
5893   file_transport = address_file
5894   pipe_transport = address_pipe
5895 .endd
5896 Control reaches this and subsequent routers only for addresses in the local
5897 domains. This router checks to see whether the local part is defined as an
5898 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5899 data that it looks up from that file. If no data is found for the local part,
5900 the value of the &%data%& option is empty, causing the address to be passed to
5901 the next router.
5902
5903 &_/etc/aliases_& is a conventional name for the system aliases file that is
5904 often used. That is why it is referenced by from the default configuration
5905 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5906 &_Local/Makefile_& before building Exim.
5907 .code
5908 userforward:
5909   driver = redirect
5910   check_local_user
5911 # local_part_suffix = +* : -*
5912 # local_part_suffix_optional
5913   file = $home/.forward
5914 # allow_filter
5915   no_verify
5916   no_expn
5917   check_ancestor
5918   file_transport = address_file
5919   pipe_transport = address_pipe
5920   reply_transport = address_reply
5921 .endd
5922 This is the most complicated router in the default configuration. It is another
5923 redirection router, but this time it is looking for forwarding data set up by
5924 individual users. The &%check_local_user%& setting specifies a check that the
5925 local part of the address is the login name of a local user. If it is not, the
5926 router is skipped. The two commented options that follow &%check_local_user%&,
5927 namely:
5928 .code
5929 # local_part_suffix = +* : -*
5930 # local_part_suffix_optional
5931 .endd
5932 .vindex "&$local_part_suffix$&"
5933 show how you can specify the recognition of local part suffixes. If the first
5934 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5935 by any sequence of characters, is removed from the local part and placed in the
5936 variable &$local_part_suffix$&. The second suffix option specifies that the
5937 presence of a suffix in the local part is optional. When a suffix is present,
5938 the check for a local login uses the local part with the suffix removed.
5939
5940 When a local user account is found, the file called &_.forward_& in the user's
5941 home directory is consulted. If it does not exist, or is empty, the router
5942 declines. Otherwise, the contents of &_.forward_& are interpreted as
5943 redirection data (see chapter &<<CHAPredirect>>& for more details).
5944
5945 .cindex "Sieve filter" "enabling in default router"
5946 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5947 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5948 is commented out by default), the contents of the file are interpreted as a set
5949 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5950 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5951 separate document entitled &'Exim's interfaces to mail filtering'&.
5952
5953 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5954 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5955 There are two reasons for doing this:
5956
5957 .olist
5958 Whether or not a local user has a &_.forward_& file is not really relevant when
5959 checking an address for validity; it makes sense not to waste resources doing
5960 unnecessary work.
5961 .next
5962 More importantly, when Exim is verifying addresses or handling an EXPN
5963 command during an SMTP session, it is running as the Exim user, not as root.
5964 The group is the Exim group, and no additional groups are set up.
5965 It may therefore not be possible for Exim to read users' &_.forward_& files at
5966 this time.
5967 .endlist
5968
5969 The setting of &%check_ancestor%& prevents the router from generating a new
5970 address that is the same as any previous address that was redirected. (This
5971 works round a problem concerning a bad interaction between aliasing and
5972 forwarding &-- see section &<<SECTredlocmai>>&).
5973
5974 The final three option settings specify the transports that are to be used when
5975 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5976 auto-reply, respectively. For example, if a &_.forward_& file contains
5977 .code
5978 a.nother@elsewhere.example, /home/spqr/archive
5979 .endd
5980 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5981 transport.
5982 .code
5983 localuser:
5984   driver = accept
5985   check_local_user
5986 # local_part_suffix = +* : -*
5987 # local_part_suffix_optional
5988   transport = local_delivery
5989 .endd
5990 The final router sets up delivery into local mailboxes, provided that the local
5991 part is the name of a local login, by accepting the address and assigning it to
5992 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5993 routers, so the address is bounced. The commented suffix settings fulfil the
5994 same purpose as they do for the &(userforward)& router.
5995
5996
5997 .section "Transport configuration" "SECID56"
5998 .cindex "default" "transports"
5999 .cindex "transports" "default"
6000 Transports define mechanisms for actually delivering messages. They operate
6001 only when referenced from routers, so the order in which they are defined does
6002 not matter. The transports section of the configuration starts with
6003 .code
6004 begin transports
6005 .endd
6006 One remote transport and four local transports are defined.
6007 .code
6008 remote_smtp:
6009   driver = smtp
6010   hosts_try_prdr = *
6011 .endd
6012 This transport is used for delivering messages over SMTP connections.
6013 The list of remote hosts comes from the router.
6014 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6015 It is negotiated between client and server
6016 and not expected to cause problems but can be disabled if needed.
6017 All other options are defaulted.
6018 .code
6019 local_delivery:
6020   driver = appendfile
6021   file = /var/mail/$local_part
6022   delivery_date_add
6023   envelope_to_add
6024   return_path_add
6025 # group = mail
6026 # mode = 0660
6027 .endd
6028 This &(appendfile)& transport is used for local delivery to user mailboxes in
6029 traditional BSD mailbox format. By default it runs under the uid and gid of the
6030 local user, which requires the sticky bit to be set on the &_/var/mail_&
6031 directory. Some systems use the alternative approach of running mail deliveries
6032 under a particular group instead of using the sticky bit. The commented options
6033 show how this can be done.
6034
6035 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6036 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6037 similarly-named options above.
6038 .code
6039 address_pipe:
6040   driver = pipe
6041   return_output
6042 .endd
6043 This transport is used for handling deliveries to pipes that are generated by
6044 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6045 option specifies that any output generated by the pipe is to be returned to the
6046 sender.
6047 .code
6048 address_file:
6049   driver = appendfile
6050   delivery_date_add
6051   envelope_to_add
6052   return_path_add
6053 .endd
6054 This transport is used for handling deliveries to files that are generated by
6055 redirection. The name of the file is not specified in this instance of
6056 &(appendfile)&, because it comes from the &(redirect)& router.
6057 .code
6058 address_reply:
6059   driver = autoreply
6060 .endd
6061 This transport is used for handling automatic replies generated by users'
6062 filter files.
6063
6064
6065
6066 .section "Default retry rule" "SECID57"
6067 .cindex "retry" "default rule"
6068 .cindex "default" "retry rule"
6069 The retry section of the configuration file contains rules which affect the way
6070 Exim retries deliveries that cannot be completed at the first attempt. It is
6071 introduced by the line
6072 .code
6073 begin retry
6074 .endd
6075 In the default configuration, there is just one rule, which applies to all
6076 errors:
6077 .code
6078 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6079 .endd
6080 This causes any temporarily failing address to be retried every 15 minutes for
6081 2 hours, then at intervals starting at one hour and increasing by a factor of
6082 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6083 is not delivered after 4 days of temporary failure, it is bounced.
6084
6085 If the retry section is removed from the configuration, or is empty (that is,
6086 if no retry rules are defined), Exim will not retry deliveries. This turns
6087 temporary errors into permanent errors.
6088
6089
6090 .section "Rewriting configuration" "SECID58"
6091 The rewriting section of the configuration, introduced by
6092 .code
6093 begin rewrite
6094 .endd
6095 contains rules for rewriting addresses in messages as they arrive. There are no
6096 rewriting rules in the default configuration file.
6097
6098
6099
6100 .section "Authenticators configuration" "SECTdefconfauth"
6101 .cindex "AUTH" "configuration"
6102 The authenticators section of the configuration, introduced by
6103 .code
6104 begin authenticators
6105 .endd
6106 defines mechanisms for the use of the SMTP AUTH command. The default
6107 configuration file contains two commented-out example authenticators
6108 which support plaintext username/password authentication using the
6109 standard PLAIN mechanism and the traditional but non-standard LOGIN
6110 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6111 to support most MUA software.
6112
6113 The example PLAIN authenticator looks like this:
6114 .code
6115 #PLAIN:
6116 #  driver                  = plaintext
6117 #  server_set_id           = $auth2
6118 #  server_prompts          = :
6119 #  server_condition        = Authentication is not yet configured
6120 #  server_advertise_condition = ${if def:tls_in_cipher }
6121 .endd
6122 And the example LOGIN authenticator looks like this:
6123 .code
6124 #LOGIN:
6125 #  driver                  = plaintext
6126 #  server_set_id           = $auth1
6127 #  server_prompts          = <| Username: | Password:
6128 #  server_condition        = Authentication is not yet configured
6129 #  server_advertise_condition = ${if def:tls_in_cipher }
6130 .endd
6131
6132 The &%server_set_id%& option makes Exim remember the authenticated username
6133 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6134 &%server_prompts%& option configures the &(plaintext)& authenticator so
6135 that it implements the details of the specific authentication mechanism,
6136 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6137 when Exim offers authentication to clients; in the examples, this is only
6138 when TLS or SSL has been started, so to enable the authenticators you also
6139 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6140
6141 The &%server_condition%& setting defines how to verify that the username and
6142 password are correct. In the examples it just produces an error message.
6143 To make the authenticators work, you can use a string expansion
6144 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6145
6146 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6147 usercode and password are in different positions.
6148 Chapter &<<CHAPplaintext>>& covers both.
6149
6150 .ecindex IIDconfiwal
6151
6152
6153
6154 . ////////////////////////////////////////////////////////////////////////////
6155 . ////////////////////////////////////////////////////////////////////////////
6156
6157 .chapter "Regular expressions" "CHAPregexp"
6158
6159 .cindex "regular expressions" "library"
6160 .cindex "PCRE"
6161 Exim supports the use of regular expressions in many of its options. It
6162 uses the PCRE regular expression library; this provides regular expression
6163 matching that is compatible with Perl 5. The syntax and semantics of
6164 regular expressions is discussed in many Perl reference books, and also in
6165 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6166 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6167
6168 The documentation for the syntax and semantics of the regular expressions that
6169 are supported by PCRE is included in the PCRE distribution, and no further
6170 description is included here. The PCRE functions are called from Exim using
6171 the default option settings (that is, with no PCRE options set), except that
6172 the PCRE_CASELESS option is set when the matching is required to be
6173 case-insensitive.
6174
6175 In most cases, when a regular expression is required in an Exim configuration,
6176 it has to start with a circumflex, in order to distinguish it from plain text
6177 or an &"ends with"& wildcard. In this example of a configuration setting, the
6178 second item in the colon-separated list is a regular expression.
6179 .code
6180 domains = a.b.c : ^\\d{3} : *.y.z : ...
6181 .endd
6182 The doubling of the backslash is required because of string expansion that
6183 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6184 of this issue, and a way of avoiding the need for doubling backslashes. The
6185 regular expression that is eventually used in this example contains just one
6186 backslash. The circumflex is included in the regular expression, and has the
6187 normal effect of &"anchoring"& it to the start of the string that is being
6188 matched.
6189
6190 There are, however, two cases where a circumflex is not required for the
6191 recognition of a regular expression: these are the &%match%& condition in a
6192 string expansion, and the &%matches%& condition in an Exim filter file. In
6193 these cases, the relevant string is always treated as a regular expression; if
6194 it does not start with a circumflex, the expression is not anchored, and can
6195 match anywhere in the subject string.
6196
6197 In all cases, if you want a regular expression to match at the end of a string,
6198 you must code the $ metacharacter to indicate this. For example:
6199 .code
6200 domains = ^\\d{3}\\.example
6201 .endd
6202 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6203 You need to use:
6204 .code
6205 domains = ^\\d{3}\\.example\$
6206 .endd
6207 if you want &'example'& to be the top-level domain. The backslash before the
6208 $ is needed because string expansion also interprets dollar characters.
6209
6210
6211
6212 . ////////////////////////////////////////////////////////////////////////////
6213 . ////////////////////////////////////////////////////////////////////////////
6214
6215 .chapter "File and database lookups" "CHAPfdlookup"
6216 .scindex IIDfidalo1 "file" "lookups"
6217 .scindex IIDfidalo2 "database" "lookups"
6218 .cindex "lookup" "description of"
6219 Exim can be configured to look up data in files or databases as it processes
6220 messages. Two different kinds of syntax are used:
6221
6222 .olist
6223 A string that is to be expanded may contain explicit lookup requests. These
6224 cause parts of the string to be replaced by data that is obtained from the
6225 lookup. Lookups of this type are conditional expansion items. Different results
6226 can be defined for the cases of lookup success and failure. See chapter
6227 &<<CHAPexpand>>&, where string expansions are described in detail.
6228 .next
6229 Lists of domains, hosts, and email addresses can contain lookup requests as a
6230 way of avoiding excessively long linear lists. In this case, the data that is
6231 returned by the lookup is often (but not always) discarded; whether the lookup
6232 succeeds or fails is what really counts. These kinds of list are described in
6233 chapter &<<CHAPdomhosaddlists>>&.
6234 .endlist
6235
6236 String expansions, lists, and lookups interact with each other in such a way
6237 that there is no order in which to describe any one of them that does not
6238 involve references to the others. Each of these three chapters makes more sense
6239 if you have read the other two first. If you are reading this for the first
6240 time, be aware that some of it will make a lot more sense after you have read
6241 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6242
6243 .section "Examples of different lookup syntax" "SECID60"
6244 It is easy to confuse the two different kinds of lookup, especially as the
6245 lists that may contain the second kind are always expanded before being
6246 processed as lists. Therefore, they may also contain lookups of the first kind.
6247 Be careful to distinguish between the following two examples:
6248 .code
6249 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6250 domains = lsearch;/some/file
6251 .endd
6252 The first uses a string expansion, the result of which must be a domain list.
6253 No strings have been specified for a successful or a failing lookup; the
6254 defaults in this case are the looked-up data and an empty string, respectively.
6255 The expansion takes place before the string is processed as a list, and the
6256 file that is searched could contain lines like this:
6257 .code
6258 192.168.3.4: domain1:domain2:...
6259 192.168.1.9: domain3:domain4:...
6260 .endd
6261 When the lookup succeeds, the result of the expansion is a list of domains (and
6262 possibly other types of item that are allowed in domain lists).
6263
6264 In the second example, the lookup is a single item in a domain list. It causes
6265 Exim to use a lookup to see if the domain that is being processed can be found
6266 in the file. The file could contains lines like this:
6267 .code
6268 domain1:
6269 domain2:
6270 .endd
6271 Any data that follows the keys is not relevant when checking that the domain
6272 matches the list item.
6273
6274 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6275 Consider a file containing lines like this:
6276 .code
6277 192.168.5.6: lsearch;/another/file
6278 .endd
6279 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6280 first &%domains%& setting above generates the second setting, which therefore
6281 causes a second lookup to occur.
6282
6283 The rest of this chapter describes the different lookup types that are
6284 available. Any of them can be used in any part of the configuration where a
6285 lookup is permitted.
6286
6287
6288 .section "Lookup types" "SECID61"
6289 .cindex "lookup" "types of"
6290 .cindex "single-key lookup" "definition of"
6291 Two different types of data lookup are implemented:
6292
6293 .ilist
6294 The &'single-key'& type requires the specification of a file in which to look,
6295 and a single key to search for. The key must be a non-empty string for the
6296 lookup to succeed. The lookup type determines how the file is searched.
6297 .next
6298 .cindex "query-style lookup" "definition of"
6299 The &'query-style'& type accepts a generalized database query. No particular
6300 key value is assumed by Exim for query-style lookups. You can use whichever
6301 Exim variables you need to construct the database query.
6302 .endlist
6303
6304 The code for each lookup type is in a separate source file that is included in
6305 the binary of Exim only if the corresponding compile-time option is set. The
6306 default settings in &_src/EDITME_& are:
6307 .code
6308 LOOKUP_DBM=yes
6309 LOOKUP_LSEARCH=yes
6310 .endd
6311 which means that only linear searching and DBM lookups are included by default.
6312 For some types of lookup (e.g. SQL databases), you need to install appropriate
6313 libraries and header files before building Exim.
6314
6315
6316
6317
6318 .section "Single-key lookup types" "SECTsinglekeylookups"
6319 .cindex "lookup" "single-key types"
6320 .cindex "single-key lookup" "list of types"
6321 The following single-key lookup types are implemented:
6322
6323 .ilist
6324 .cindex "cdb" "description of"
6325 .cindex "lookup" "cdb"
6326 .cindex "binary zero" "in lookup key"
6327 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6328 string without a terminating binary zero. The cdb format is designed for
6329 indexed files that are read frequently and never updated, except by total
6330 re-creation. As such, it is particularly suitable for large files containing
6331 aliases or other indexed data referenced by an MTA. Information about cdb can
6332 be found in several places:
6333 .display
6334 &url(http://www.pobox.com/~djb/cdb.html)
6335 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6336 &url(http://packages.debian.org/stable/utils/freecdb.html)
6337 .endd
6338 A cdb distribution is not needed in order to build Exim with cdb support,
6339 because the code for reading cdb files is included directly in Exim itself.
6340 However, no means of building or testing cdb files is provided with Exim, so
6341 you need to obtain a cdb distribution in order to do this.
6342 .next
6343 .cindex "DBM" "lookup type"
6344 .cindex "lookup" "dbm"
6345 .cindex "binary zero" "in lookup key"
6346 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6347 DBM file by looking up the record with the given key. A terminating binary
6348 zero is included in the key that is passed to the DBM library. See section
6349 &<<SECTdb>>& for a discussion of DBM libraries.
6350
6351 .cindex "Berkeley DB library" "file format"
6352 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6353 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6354 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6355 the DB_UNKNOWN option. This enables it to handle any of the types of database
6356 that the library supports, and can be useful for accessing DBM files created by
6357 other applications. (For earlier DB versions, DB_HASH is always used.)
6358 .next
6359 .cindex "lookup" "dbmjz"
6360 .cindex "lookup" "dbm &-- embedded NULs"
6361 .cindex "sasldb2"
6362 .cindex "dbmjz lookup type"
6363 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6364 interpreted as an Exim list; the elements of the list are joined together with
6365 ASCII NUL characters to form the lookup key.  An example usage would be to
6366 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6367 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6368 &(cram_md5)& authenticator.
6369 .next
6370 .cindex "lookup" "dbmnz"
6371 .cindex "lookup" "dbm &-- terminating zero"
6372 .cindex "binary zero" "in lookup key"
6373 .cindex "Courier"
6374 .cindex "&_/etc/userdbshadow.dat_&"
6375 .cindex "dbmnz lookup type"
6376 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6377 is not included in the key that is passed to the DBM library. You may need this
6378 if you want to look up data in files that are created by or shared with some
6379 other application that does not use terminating zeros. For example, you need to
6380 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6381 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6382 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6383 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6384 .next
6385 .cindex "lookup" "dsearch"
6386 .cindex "dsearch lookup type"
6387 &(dsearch)&: The given file must be a directory; this is searched for an entry
6388 whose name is the key by calling the &[lstat()]& function. The key may not
6389 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6390 the lookup is the name of the entry, which may be a file, directory,
6391 symbolic link, or any other kind of directory entry. An example of how this
6392 lookup can be used to support virtual domains is given in section
6393 &<<SECTvirtualdomains>>&.
6394 .next
6395 .cindex "lookup" "iplsearch"
6396 .cindex "iplsearch lookup type"
6397 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6398 terminated by a colon or white space or the end of the line. The keys in the
6399 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6400 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6401 being interpreted as a key terminator. For example:
6402 .code
6403 1.2.3.4:           data for 1.2.3.4
6404 192.168.0.0/16:    data for 192.168.0.0/16
6405 "abcd::cdab":      data for abcd::cdab
6406 "abcd:abcd::/32"   data for abcd:abcd::/32
6407 .endd
6408 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6409 file is searched linearly, using the CIDR masks where present, until a matching
6410 key is found. The first key that matches is used; there is no attempt to find a
6411 &"best"& match. Apart from the way the keys are matched, the processing for
6412 &(iplsearch)& is the same as for &(lsearch)&.
6413
6414 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6415 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6416 lookup types support only literal keys.
6417
6418 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6419 the implicit key is the host's IP address rather than its name (see section
6420 &<<SECThoslispatsikey>>&).
6421 .next
6422 .cindex "linear search"
6423 .cindex "lookup" "lsearch"
6424 .cindex "lsearch lookup type"
6425 .cindex "case sensitivity" "in lsearch lookup"
6426 &(lsearch)&: The given file is a text file that is searched linearly for a
6427 line beginning with the search key, terminated by a colon or white space or the
6428 end of the line. The search is case-insensitive; that is, upper and lower case
6429 letters are treated as the same. The first occurrence of the key that is found
6430 in the file is used.
6431
6432 White space between the key and the colon is permitted. The remainder of the
6433 line, with leading and trailing white space removed, is the data. This can be
6434 continued onto subsequent lines by starting them with any amount of white
6435 space, but only a single space character is included in the data at such a
6436 junction. If the data begins with a colon, the key must be terminated by a
6437 colon, for example:
6438 .code
6439 baduser:  :fail:
6440 .endd
6441 Empty lines and lines beginning with # are ignored, even if they occur in the
6442 middle of an item. This is the traditional textual format of alias files. Note
6443 that the keys in an &(lsearch)& file are literal strings. There is no
6444 wildcarding of any kind.
6445
6446 .cindex "lookup" "lsearch &-- colons in keys"
6447 .cindex "white space" "in lsearch key"
6448 In most &(lsearch)& files, keys are not required to contain colons or #
6449 characters, or white space. However, if you need this feature, it is available.
6450 If a key begins with a doublequote character, it is terminated only by a
6451 matching quote (or end of line), and the normal escaping rules apply to its
6452 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6453 quoted keys (exactly as for unquoted keys). There is no special handling of
6454 quotes for the data part of an &(lsearch)& line.
6455
6456 .next
6457 .cindex "NIS lookup type"
6458 .cindex "lookup" "NIS"
6459 .cindex "binary zero" "in lookup key"
6460 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6461 the given key, without a terminating binary zero. There is a variant called
6462 &(nis0)& which does include the terminating binary zero in the key. This is
6463 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6464 aliases; the full map names must be used.
6465
6466 .next
6467 .cindex "wildlsearch lookup type"
6468 .cindex "lookup" "wildlsearch"
6469 .cindex "nwildlsearch lookup type"
6470 .cindex "lookup" "nwildlsearch"
6471 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6472 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6473 the file may be wildcarded. The difference between these two lookup types is
6474 that for &(wildlsearch)&, each key in the file is string-expanded before being
6475 used, whereas for &(nwildlsearch)&, no expansion takes place.
6476
6477 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6478 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6479 file that are regular expressions can be made case-sensitive by the use of
6480 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6481
6482 . ==== As this is a nested list, any displays it contains must be indented
6483 . ==== as otherwise they are too far to the left.
6484
6485 .olist
6486 The string may begin with an asterisk to mean &"ends with"&. For example:
6487 .code
6488     *.a.b.c       data for anything.a.b.c
6489     *fish         data for anythingfish
6490 .endd
6491 .next
6492 The string may begin with a circumflex to indicate a regular expression. For
6493 example, for &(wildlsearch)&:
6494 .code
6495     ^\N\d+\.a\.b\N    data for <digits>.a.b
6496 .endd
6497 Note the use of &`\N`& to disable expansion of the contents of the regular
6498 expression. If you are using &(nwildlsearch)&, where the keys are not
6499 string-expanded, the equivalent entry is:
6500 .code
6501     ^\d+\.a\.b        data for <digits>.a.b
6502 .endd
6503 The case-insensitive flag is set at the start of compiling the regular
6504 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6505 For example, to make the entire pattern case-sensitive:
6506 .code
6507     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6508 .endd
6509
6510 If the regular expression contains white space or colon characters, you must
6511 either quote it (see &(lsearch)& above), or represent these characters in other
6512 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6513 colon. This may be easier than quoting, because if you quote, you have to
6514 escape all the backslashes inside the quotes.
6515
6516 &*Note*&: It is not possible to capture substrings in a regular expression
6517 match for later use, because the results of all lookups are cached. If a lookup
6518 is repeated, the result is taken from the cache, and no actual pattern matching
6519 takes place. The values of all the numeric variables are unset after a
6520 &((n)wildlsearch)& match.
6521
6522 .next
6523 Although I cannot see it being of much use, the general matching function that
6524 is used to implement &((n)wildlsearch)& means that the string may begin with a
6525 lookup name terminated by a semicolon, and followed by lookup data. For
6526 example:
6527 .code
6528     cdb;/some/file  data for keys that match the file
6529 .endd
6530 The data that is obtained from the nested lookup is discarded.
6531 .endlist olist
6532
6533 Keys that do not match any of these patterns are interpreted literally. The
6534 continuation rules for the data are the same as for &(lsearch)&, and keys may
6535 be followed by optional colons.
6536
6537 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6538 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6539 lookup types support only literal keys.
6540 .endlist ilist
6541
6542
6543 .section "Query-style lookup types" "SECID62"
6544 .cindex "lookup" "query-style types"
6545 .cindex "query-style lookup" "list of types"
6546 The supported query-style lookup types are listed below. Further details about
6547 many of them are given in later sections.
6548
6549 .ilist
6550 .cindex "DNS" "as a lookup type"
6551 .cindex "lookup" "DNS"
6552 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6553 are given in the supplied query. The resulting data is the contents of the
6554 records. See section &<<SECTdnsdb>>&.
6555 .next
6556 .cindex "InterBase lookup type"
6557 .cindex "lookup" "InterBase"
6558 &(ibase)&: This does a lookup in an InterBase database.
6559 .next
6560 .cindex "LDAP" "lookup type"
6561 .cindex "lookup" "LDAP"
6562 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6563 returns attributes from a single entry. There is a variant called &(ldapm)&
6564 that permits values from multiple entries to be returned. A third variant
6565 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6566 any attribute values. See section &<<SECTldap>>&.
6567 .next
6568 .cindex "MySQL" "lookup type"
6569 .cindex "lookup" "MySQL"
6570 &(mysql)&: The format of the query is an SQL statement that is passed to a
6571 MySQL database. See section &<<SECTsql>>&.
6572 .next
6573 .cindex "NIS+ lookup type"
6574 .cindex "lookup" "NIS+"
6575 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6576 the field to be returned. See section &<<SECTnisplus>>&.
6577 .next
6578 .cindex "Oracle" "lookup type"
6579 .cindex "lookup" "Oracle"
6580 &(oracle)&: The format of the query is an SQL statement that is passed to an
6581 Oracle database. See section &<<SECTsql>>&.
6582 .next
6583 .cindex "lookup" "passwd"
6584 .cindex "passwd lookup type"
6585 .cindex "&_/etc/passwd_&"
6586 &(passwd)& is a query-style lookup with queries that are just user names. The
6587 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6588 success, the result string is the same as you would get from an &(lsearch)&
6589 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6590 password value. For example:
6591 .code
6592 *:42:42:King Rat:/home/kr:/bin/bash
6593 .endd
6594 .next
6595 .cindex "PostgreSQL lookup type"
6596 .cindex "lookup" "PostgreSQL"
6597 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6598 PostgreSQL database. See section &<<SECTsql>>&.
6599
6600 .next
6601 .cindex "sqlite lookup type"
6602 .cindex "lookup" "sqlite"
6603 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6604 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6605
6606 .next
6607 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6608 not likely to be useful in normal operation.
6609 .next
6610 .cindex "whoson lookup type"
6611 .cindex "lookup" "whoson"
6612 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6613 allows a server to check whether a particular (dynamically allocated) IP
6614 address is currently allocated to a known (trusted) user and, optionally, to
6615 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6616 at one time for &"POP before SMTP"& authentication, but that approach has been
6617 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6618 &"POP before SMTP"& checking using ACL statements such as
6619 .code
6620 require condition = \
6621   ${lookup whoson {$sender_host_address}{yes}{no}}
6622 .endd
6623 The query consists of a single IP address. The value returned is the name of
6624 the authenticated user, which is stored in the variable &$value$&. However, in
6625 this example, the data in &$value$& is not used; the result of the lookup is
6626 one of the fixed strings &"yes"& or &"no"&.
6627 .endlist
6628
6629
6630
6631 .section "Temporary errors in lookups" "SECID63"
6632 .cindex "lookup" "temporary error in"
6633 Lookup functions can return temporary error codes if the lookup cannot be
6634 completed. For example, an SQL or LDAP database might be unavailable. For this
6635 reason, it is not advisable to use a lookup that might do this for critical
6636 options such as a list of local domains.
6637
6638 When a lookup cannot be completed in a router or transport, delivery
6639 of the message (to the relevant address) is deferred, as for any other
6640 temporary error. In other circumstances Exim may assume the lookup has failed,
6641 or may give up altogether.
6642
6643
6644
6645 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6646 .cindex "wildcard lookups"
6647 .cindex "lookup" "default values"
6648 .cindex "lookup" "wildcard"
6649 .cindex "lookup" "* added to type"
6650 .cindex "default" "in single-key lookups"
6651 In this context, a &"default value"& is a value specified by the administrator
6652 that is to be used if a lookup fails.
6653
6654 &*Note:*& This section applies only to single-key lookups. For query-style
6655 lookups, the facilities of the query language must be used. An attempt to
6656 specify a default for a query-style lookup provokes an error.
6657
6658 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6659 and the initial lookup fails, the key &"*"& is looked up in the file to
6660 provide a default value. See also the section on partial matching below.
6661
6662 .cindex "*@ with single-key lookup"
6663 .cindex "lookup" "*@ added to type"
6664 .cindex "alias file" "per-domain default"
6665 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6666 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6667 character, a second lookup is done with everything before the last @ replaced
6668 by *. This makes it possible to provide per-domain defaults in alias files
6669 that include the domains in the keys. If the second lookup fails (or doesn't
6670 take place because there is no @ in the key), &"*"& is looked up.
6671 For example, a &(redirect)& router might contain:
6672 .code
6673 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6674 .endd
6675 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6676 looks up these keys, in this order:
6677 .code
6678 jane@eyre.example
6679 *@eyre.example
6680 *
6681 .endd
6682 The data is taken from whichever key it finds first. &*Note*&: In an
6683 &(lsearch)& file, this does not mean the first of these keys in the file. A
6684 complete scan is done for each key, and only if it is not found at all does
6685 Exim move on to try the next key.
6686
6687
6688
6689 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6690 .cindex "partial matching"
6691 .cindex "wildcard lookups"
6692 .cindex "lookup" "partial matching"
6693 .cindex "lookup" "wildcard"
6694 .cindex "asterisk" "in search type"
6695 The normal operation of a single-key lookup is to search the file for an exact
6696 match with the given key. However, in a number of situations where domains are
6697 being looked up, it is useful to be able to do partial matching. In this case,
6698 information in the file that has a key starting with &"*."& is matched by any
6699 domain that ends with the components that follow the full stop. For example, if
6700 a key in a DBM file is
6701 .code
6702 *.dates.fict.example
6703 .endd
6704 then when partial matching is enabled this is matched by (amongst others)
6705 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6706 by &'dates.fict.example'&, if that does not appear as a separate key in the
6707 file.
6708
6709 &*Note*&: Partial matching is not available for query-style lookups. It is
6710 also not available for any lookup items in address lists (see section
6711 &<<SECTaddresslist>>&).
6712
6713 Partial matching is implemented by doing a series of separate lookups using
6714 keys constructed by modifying the original subject key. This means that it can
6715 be used with any of the single-key lookup types, provided that
6716 partial matching keys
6717 beginning with a special prefix (default &"*."&) are included in the data file.
6718 Keys in the file that do not begin with the prefix are matched only by
6719 unmodified subject keys when partial matching is in use.
6720
6721 Partial matching is requested by adding the string &"partial-"& to the front of
6722 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6723 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6724 is added at the start of the subject key, and it is looked up again. If that
6725 fails, further lookups are tried with dot-separated components removed from the
6726 start of the subject key, one-by-one, and &"*."& added on the front of what
6727 remains.
6728
6729 A minimum number of two non-* components are required. This can be adjusted
6730 by including a number before the hyphen in the search type. For example,
6731 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6732 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6733 subject key is &'2250.dates.fict.example'& then the following keys are looked
6734 up when the minimum number of non-* components is two:
6735 .code
6736 2250.dates.fict.example
6737 *.2250.dates.fict.example
6738 *.dates.fict.example
6739 *.fict.example
6740 .endd
6741 As soon as one key in the sequence is successfully looked up, the lookup
6742 finishes.
6743
6744 .cindex "lookup" "partial matching &-- changing prefix"
6745 .cindex "prefix" "for partial matching"
6746 The use of &"*."& as the partial matching prefix is a default that can be
6747 changed. The motivation for this feature is to allow Exim to operate with file
6748 formats that are used by other MTAs. A different prefix can be supplied in
6749 parentheses instead of the hyphen after &"partial"&. For example:
6750 .code
6751 domains = partial(.)lsearch;/some/file
6752 .endd
6753 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6754 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6755 components is unchanged). The prefix may consist of any punctuation characters
6756 other than a closing parenthesis. It may be empty, for example:
6757 .code
6758 domains = partial1()cdb;/some/file
6759 .endd
6760 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6761 &`a.b.c`&, &`b.c`&, and &`c`&.
6762
6763 If &"partial0"& is specified, what happens at the end (when the lookup with
6764 just one non-wild component has failed, and the original key is shortened right
6765 down to the null string) depends on the prefix:
6766
6767 .ilist
6768 If the prefix has zero length, the whole lookup fails.
6769 .next
6770 If the prefix has length 1, a lookup for just the prefix is done. For
6771 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6772 .next
6773 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6774 remainder is looked up. With the default prefix, therefore, the final lookup is
6775 for &"*"& on its own.
6776 .next
6777 Otherwise, the whole prefix is looked up.
6778 .endlist
6779
6780
6781 If the search type ends in &"*"& or &"*@"& (see section
6782 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6783 this implies happens after all partial lookups have failed. If &"partial0"& is
6784 specified, adding &"*"& to the search type has no effect with the default
6785 prefix, because the &"*"& key is already included in the sequence of partial
6786 lookups. However, there might be a use for lookup types such as
6787 &"partial0(.)lsearch*"&.
6788
6789 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6790 in domain lists and the like. Partial matching works only in terms of
6791 dot-separated components; a key such as &`*fict.example`&
6792 in a database file is useless, because the asterisk in a partial matching
6793 subject key is always followed by a dot.
6794
6795
6796
6797
6798 .section "Lookup caching" "SECID64"
6799 .cindex "lookup" "caching"
6800 .cindex "caching" "lookup data"
6801 Exim caches all lookup results in order to avoid needless repetition of
6802 lookups. However, because (apart from the daemon) Exim operates as a collection
6803 of independent, short-lived processes, this caching applies only within a
6804 single Exim process. There is no inter-process lookup caching facility.
6805
6806 For single-key lookups, Exim keeps the relevant files open in case there is
6807 another lookup that needs them. In some types of configuration this can lead to
6808 many files being kept open for messages with many recipients. To avoid hitting
6809 the operating system limit on the number of simultaneously open files, Exim
6810 closes the least recently used file when it needs to open more files than its
6811 own internal limit, which can be changed via the &%lookup_open_max%& option.
6812
6813 The single-key lookup files are closed and the lookup caches are flushed at
6814 strategic points during delivery &-- for example, after all routing is
6815 complete.
6816
6817
6818
6819
6820 .section "Quoting lookup data" "SECID65"
6821 .cindex "lookup" "quoting"
6822 .cindex "quoting" "in lookups"
6823 When data from an incoming message is included in a query-style lookup, there
6824 is the possibility of special characters in the data messing up the syntax of
6825 the query. For example, a NIS+ query that contains
6826 .code
6827 [name=$local_part]
6828 .endd
6829 will be broken if the local part happens to contain a closing square bracket.
6830 For NIS+, data can be enclosed in double quotes like this:
6831 .code
6832 [name="$local_part"]
6833 .endd
6834 but this still leaves the problem of a double quote in the data. The rule for
6835 NIS+ is that double quotes must be doubled. Other lookup types have different
6836 rules, and to cope with the differing requirements, an expansion operator
6837 of the following form is provided:
6838 .code
6839 ${quote_<lookup-type>:<string>}
6840 .endd
6841 For example, the safest way to write the NIS+ query is
6842 .code
6843 [name="${quote_nisplus:$local_part}"]
6844 .endd
6845 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6846 operator can be used for all lookup types, but has no effect for single-key
6847 lookups, since no quoting is ever needed in their key strings.
6848
6849
6850
6851
6852 .section "More about dnsdb" "SECTdnsdb"
6853 .cindex "dnsdb lookup"
6854 .cindex "lookup" "dnsdb"
6855 .cindex "DNS" "as a lookup type"
6856 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6857 of a record type and a domain name, separated by an equals sign. For example,
6858 an expansion string could contain:
6859 .code
6860 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6861 .endd
6862 If the lookup succeeds, the result is placed in &$value$&, which in this case
6863 is used on its own as the result. If the lookup does not succeed, the
6864 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6865 &<<SECTforexpfai>>& for an explanation of what this means.
6866
6867 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
6868 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6869 configured). If no type is given, TXT is assumed. When the type is PTR,
6870 the data can be an IP address, written as normal; inversion and the addition of
6871 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6872 .code
6873 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6874 .endd
6875 If the data for a PTR record is not a syntactically valid IP address, it is not
6876 altered and nothing is added.
6877
6878 .cindex "MX record" "in &(dnsdb)& lookup"
6879 .cindex "SRV record" "in &(dnsdb)& lookup"
6880 For an MX lookup, both the preference value and the host name are returned for
6881 each record, separated by a space. For an SRV lookup, the priority, weight,
6882 port, and host name are returned for each record, separated by spaces.
6883
6884 For any record type, if multiple records are found (or, for A6 lookups, if a
6885 single record leads to multiple addresses), the data is returned as a
6886 concatenation, with newline as the default separator. The order, of course,
6887 depends on the DNS resolver. You can specify a different separator character
6888 between multiple records by putting a right angle-bracket followed immediately
6889 by the new separator at the start of the query. For example:
6890 .code
6891 ${lookup dnsdb{>: a=host1.example}}
6892 .endd
6893 It is permitted to specify a space as the separator character. Further
6894 white space is ignored.
6895
6896 .cindex "TXT record" "in &(dnsdb)& lookup"
6897 .cindex "SPF record" "in &(dnsdb)& lookup"
6898 For TXT records with multiple items of data, only the first item is returned,
6899 unless a separator for them is specified using a comma after the separator
6900 character followed immediately by the TXT record item separator. To concatenate
6901 items without a separator, use a semicolon instead. For SPF records the
6902 default behaviour is to concatenate multiple items without using a separator.
6903 .code
6904 ${lookup dnsdb{>\n,: txt=a.b.example}}
6905 ${lookup dnsdb{>\n; txt=a.b.example}}
6906 ${lookup dnsdb{spf=example.org}}
6907 .endd
6908 It is permitted to specify a space as the separator character. Further
6909 white space is ignored.
6910
6911 .section "Pseudo dnsdb record types" "SECID66"
6912 .cindex "MX record" "in &(dnsdb)& lookup"
6913 By default, both the preference value and the host name are returned for
6914 each MX record, separated by a space. If you want only host names, you can use
6915 the pseudo-type MXH:
6916 .code
6917 ${lookup dnsdb{mxh=a.b.example}}
6918 .endd
6919 In this case, the preference values are omitted, and just the host names are
6920 returned.
6921
6922 .cindex "name server for enclosing domain"
6923 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6924 records on the given domain, but if none are found, it removes the first
6925 component of the domain name, and tries again. This process continues until NS
6926 records are found or there are no more components left (or there is a DNS
6927 error). In other words, it may return the name servers for a top-level domain,
6928 but it never returns the root name servers. If there are no NS records for the
6929 top-level domain, the lookup fails. Consider these examples:
6930 .code
6931 ${lookup dnsdb{zns=xxx.quercite.com}}
6932 ${lookup dnsdb{zns=xxx.edu}}
6933 .endd
6934 Assuming that in each case there are no NS records for the full domain name,
6935 the first returns the name servers for &%quercite.com%&, and the second returns
6936 the name servers for &%edu%&.
6937
6938 You should be careful about how you use this lookup because, unless the
6939 top-level domain does not exist, the lookup always returns some host names. The
6940 sort of use to which this might be put is for seeing if the name servers for a
6941 given domain are on a blacklist. You can probably assume that the name servers
6942 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6943 such a list.
6944
6945 .cindex "CSA" "in &(dnsdb)& lookup"
6946 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6947 records according to the CSA rules, which are described in section
6948 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6949 not sufficient because of the extra parent domain search behaviour of CSA. The
6950 result of a successful lookup such as:
6951 .code
6952 ${lookup dnsdb {csa=$sender_helo_name}}
6953 .endd
6954 has two space-separated fields: an authorization code and a target host name.
6955 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6956 authorization required but absent, or &"?"& for unknown.
6957
6958 .cindex "A+" "in &(dnsdb)& lookup"
6959 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6960 and then an A lookup.  All results are returned; defer processing
6961 (see below) is handled separately for each lookup.  Example:
6962 .code
6963 ${lookup dnsdb {>; a+=$sender_helo_name}}
6964 .endd
6965
6966
6967 .section "Multiple dnsdb lookups" "SECID67"
6968 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6969 However, you can specify a list of domains or IP addresses in a single
6970 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6971 the default separator, but with the ability to change this. For example:
6972 .code
6973 ${lookup dnsdb{one.domain.com:two.domain.com}}
6974 ${lookup dnsdb{a=one.host.com:two.host.com}}
6975 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6976 .endd
6977 In order to retain backwards compatibility, there is one special case: if
6978 the lookup type is PTR and no change of separator is specified, Exim looks
6979 to see if the rest of the string is precisely one IPv6 address. In this
6980 case, it does not treat it as a list.
6981
6982 The data from each lookup is concatenated, with newline separators by default,
6983 in the same way that multiple DNS records for a single item are handled. A
6984 different separator can be specified, as described above.
6985
6986 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6987 each followed by a comma,
6988 that may appear before the record type.
6989
6990 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6991 temporary DNS error for any of them, the behaviour is controlled by
6992 a defer-option modifier.
6993 The possible keywords are
6994 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6995 With &"strict"& behaviour, any temporary DNS error causes the
6996 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6997 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6998 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6999 error causes the whole lookup to defer only if none of the other lookups
7000 succeed. The default is &"lax"&, so the following lookups are equivalent:
7001 .code
7002 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7003 ${lookup dnsdb{a=one.host.com:two.host.com}}
7004 .endd
7005 Thus, in the default case, as long as at least one of the DNS lookups
7006 yields some data, the lookup succeeds.
7007
7008 .cindex "DNSSEC" "dns lookup"
7009 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7010 The possible keywords are
7011 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7012 With &"strict"& or &"lax"& DNSSEC information is requested
7013 with the lookup.
7014 With &"strict"& a response from the DNS resolver that
7015 is not labelled as authenticated data
7016 is treated as equivalent to a temporary DNS error.
7017 The default is &"never"&.
7018
7019 See also the &$lookup_dnssec_authenticated$& variable.
7020
7021
7022
7023
7024 .section "More about LDAP" "SECTldap"
7025 .cindex "LDAP" "lookup, more about"
7026 .cindex "lookup" "LDAP"
7027 .cindex "Solaris" "LDAP"
7028 The original LDAP implementation came from the University of Michigan; this has
7029 become &"Open LDAP"&, and there are now two different releases. Another
7030 implementation comes from Netscape, and Solaris 7 and subsequent releases
7031 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7032 the lookup function level, their error handling is different. For this reason
7033 it is necessary to set a compile-time variable when building Exim with LDAP, to
7034 indicate which LDAP library is in use. One of the following should appear in
7035 your &_Local/Makefile_&:
7036 .code
7037 LDAP_LIB_TYPE=UMICHIGAN
7038 LDAP_LIB_TYPE=OPENLDAP1
7039 LDAP_LIB_TYPE=OPENLDAP2
7040 LDAP_LIB_TYPE=NETSCAPE
7041 LDAP_LIB_TYPE=SOLARIS
7042 .endd
7043 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7044 same interface as the University of Michigan version.
7045
7046 There are three LDAP lookup types in Exim. These behave slightly differently in
7047 the way they handle the results of a query:
7048
7049 .ilist
7050 &(ldap)& requires the result to contain just one entry; if there are more, it
7051 gives an error.
7052 .next
7053 &(ldapdn)& also requires the result to contain just one entry, but it is the
7054 Distinguished Name that is returned rather than any attribute values.
7055 .next
7056 &(ldapm)& permits the result to contain more than one entry; the attributes
7057 from all of them are returned.
7058 .endlist
7059
7060
7061 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7062 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7063 the data returned by a successful lookup is described in the next section.
7064 First we explain how LDAP queries are coded.
7065
7066
7067 .section "Format of LDAP queries" "SECTforldaque"
7068 .cindex "LDAP" "query format"
7069 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7070 the configuration of a &(redirect)& router one might have this setting:
7071 .code
7072 data = ${lookup ldap \
7073   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7074   c=UK?mailbox?base?}}
7075 .endd
7076 .cindex "LDAP" "with TLS"
7077 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7078 secure (encrypted) LDAP connections. The second of these ensures that an
7079 encrypted TLS connection is used.
7080
7081 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7082 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7083 See the &%ldap_start_tls%& option.
7084
7085 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7086 controlled. Every part of the TLS configuration can be configured by settings in
7087 &_exim.conf_&. Depending on the version of the client libraries installed on
7088 your system, some of the initialization may have required setting options in
7089 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7090 certificates. This revealed a nuance where the current UID that exim was
7091 running as could affect which config files it read. With Exim 4.83, these
7092 methods become optional, only taking effect if not specifically set in
7093 &_exim.conf_&.
7094
7095
7096 .section "LDAP quoting" "SECID68"
7097 .cindex "LDAP" "quoting"
7098 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7099 and the second because the LDAP query is represented as a URL. Furthermore,
7100 within an LDAP query, two different kinds of quoting are required. For this
7101 reason, there are two different LDAP-specific quoting operators.
7102
7103 The &%quote_ldap%& operator is designed for use on strings that are part of
7104 filter specifications. Conceptually, it first does the following conversions on
7105 the string:
7106 .code
7107 *   =>   \2A
7108 (   =>   \28
7109 )   =>   \29
7110 \   =>   \5C
7111 .endd
7112 in accordance with RFC 2254. The resulting string is then quoted according
7113 to the rules for URLs, that is, all non-alphanumeric characters except
7114 .code
7115 ! $ ' - . _ ( ) * +
7116 .endd
7117 are converted to their hex values, preceded by a percent sign. For example:
7118 .code
7119 ${quote_ldap: a(bc)*, a<yz>; }
7120 .endd
7121 yields
7122 .code
7123 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7124 .endd
7125 Removing the URL quoting, this is (with a leading and a trailing space):
7126 .code
7127 a\28bc\29\2A, a<yz>;
7128 .endd
7129 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7130 base DN specifications in queries. Conceptually, it first converts the string
7131 by inserting a backslash in front of any of the following characters:
7132 .code
7133 , + " \ < > ;
7134 .endd
7135 It also inserts a backslash before any leading spaces or # characters, and
7136 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7137 is then quoted according to the rules for URLs. For example:
7138 .code
7139 ${quote_ldap_dn: a(bc)*, a<yz>; }
7140 .endd
7141 yields
7142 .code
7143 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7144 .endd
7145 Removing the URL quoting, this is (with a trailing space):
7146 .code
7147 \ a(bc)*\, a\<yz\>\;\
7148 .endd
7149 There are some further comments about quoting in the section on LDAP
7150 authentication below.
7151
7152
7153 .section "LDAP connections" "SECID69"
7154 .cindex "LDAP" "connections"
7155 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7156 is in use, via a Unix domain socket. The example given above does not specify
7157 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7158 by starting it with
7159 .code
7160 ldap://<hostname>:<port>/...
7161 .endd
7162 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7163 used. When no server is specified in a query, a list of default servers is
7164 taken from the &%ldap_default_servers%& configuration option. This supplies a
7165 colon-separated list of servers which are tried in turn until one successfully
7166 handles a query, or there is a serious error. Successful handling either
7167 returns the requested data, or indicates that it does not exist. Serious errors
7168 are syntactical, or multiple values when only a single value is expected.
7169 Errors which cause the next server to be tried are connection failures, bind
7170 failures, and timeouts.
7171
7172 For each server name in the list, a port number can be given. The standard way
7173 of specifying a host and port is to use a colon separator (RFC 1738). Because
7174 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7175 doubled. For example
7176 .code
7177 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7178 .endd
7179 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7180 to the LDAP library with no server name, and the library's default (normally
7181 the local host) is used.
7182
7183 If you are using the OpenLDAP library, you can connect to an LDAP server using
7184 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7185 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7186 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7187 not available.
7188
7189 For this type of connection, instead of a host name for the server, a pathname
7190 for the socket is required, and the port number is not relevant. The pathname
7191 can be specified either as an item in &%ldap_default_servers%&, or inline in
7192 the query. In the former case, you can have settings such as
7193 .code
7194 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7195 .endd
7196 When the pathname is given in the query, you have to escape the slashes as
7197 &`%2F`& to fit in with the LDAP URL syntax. For example:
7198 .code
7199 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7200 .endd
7201 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7202 a pathname, it uses the Unix domain socket code, even if the query actually
7203 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7204 socket connection. This behaviour means that you can use a setting of
7205 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7206 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7207 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7208 backup host.
7209
7210 If an explicit &`ldapi`& type is given in a query when a host name is
7211 specified, an error is diagnosed. However, if there are more items in
7212 &%ldap_default_servers%&, they are tried. In other words:
7213
7214 .ilist
7215 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7216 interface.
7217 .next
7218 Using &`ldapi`& with a host name causes an error.
7219 .endlist
7220
7221
7222 Using &`ldapi`& with no host or path in the query, and no setting of
7223 &%ldap_default_servers%&, does whatever the library does by default.
7224
7225
7226
7227 .section "LDAP authentication and control information" "SECID70"
7228 .cindex "LDAP" "authentication"
7229 The LDAP URL syntax provides no way of passing authentication and other control
7230 information to the server. To make this possible, the URL in an LDAP query may
7231 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7232 spaces. If a value contains spaces it must be enclosed in double quotes, and
7233 when double quotes are used, backslash is interpreted in the usual way inside
7234 them. The following names are recognized:
7235 .display
7236 &`DEREFERENCE`&  set the dereferencing parameter
7237 &`NETTIME    `&  set a timeout for a network operation
7238 &`USER       `&  set the DN, for authenticating the LDAP bind
7239 &`PASS       `&  set the password, likewise
7240 &`REFERRALS  `&  set the referrals parameter
7241 &`SERVERS    `&  set alternate server list for this query only
7242 &`SIZE       `&  set the limit for the number of entries returned
7243 &`TIME       `&  set the maximum waiting time for a query
7244 .endd
7245 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7246 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7247 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7248 library from trying to follow referrals issued by the LDAP server.
7249
7250 The name CONNECT is an obsolete name for NETTIME, retained for
7251 backwards compatibility. This timeout (specified as a number of seconds) is
7252 enforced from the client end for operations that can be carried out over a
7253 network. Specifically, it applies to network connections and calls to the
7254 &'ldap_result()'& function. If the value is greater than zero, it is used if
7255 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7256 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7257 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7258 Netscape SDK; for OpenLDAP no action is taken.
7259
7260 The TIME parameter (also a number of seconds) is passed to the server to
7261 set a server-side limit on the time taken to complete a search.
7262
7263 The SERVERS parameter allows you to specify an alternate list of ldap servers
7264 to use for an individual lookup.  The global ldap_servers option provides a
7265 default list of ldap servers, and a single lookup can specify a single ldap
7266 server to use.  But when you need to do a lookup with a list of servers that is
7267 different than the default list (maybe different order, maybe a completely
7268 different set of servers), the SERVERS parameter allows you to specify this
7269 alternate list (colon-separated).
7270
7271 Here is an example of an LDAP query in an Exim lookup that uses some of these
7272 values. This is a single line, folded to fit on the page:
7273 .code
7274 ${lookup ldap
7275   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7276   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7277   {$value}fail}
7278 .endd
7279 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7280 any of the auxiliary data. Exim configuration settings that include lookups
7281 which contain password information should be preceded by &"hide"& to prevent
7282 non-admin users from using the &%-bP%& option to see their values.
7283
7284 The auxiliary data items may be given in any order. The default is no
7285 connection timeout (the system timeout is used), no user or password, no limit
7286 on the number of entries returned, and no time limit on queries.
7287
7288 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7289 removes any URL quoting that it may contain before passing it LDAP. Apparently
7290 some libraries do this for themselves, but some do not. Removing the URL
7291 quoting has two advantages:
7292
7293 .ilist
7294 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7295 DNs as with DNs inside actual queries.
7296 .next
7297 It permits spaces inside USER= DNs.
7298 .endlist
7299
7300 For example, a setting such as
7301 .code
7302 USER=cn=${quote_ldap_dn:$1}
7303 .endd
7304 should work even if &$1$& contains spaces.
7305
7306 Expanded data for the PASS= value should be quoted using the &%quote%&
7307 expansion operator, rather than the LDAP quote operators. The only reason this
7308 field needs quoting is to ensure that it conforms to the Exim syntax, which
7309 does not allow unquoted spaces. For example:
7310 .code
7311 PASS=${quote:$3}
7312 .endd
7313 The LDAP authentication mechanism can be used to check passwords as part of
7314 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7315 &<<CHAPexpand>>&.
7316
7317
7318
7319 .section "Format of data returned by LDAP" "SECID71"
7320 .cindex "LDAP" "returned data formats"
7321 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7322 as a sequence of values, for example
7323 .code
7324 cn=manager, o=University of Cambridge, c=UK
7325 .endd
7326 The &(ldap)& lookup type generates an error if more than one entry matches the
7327 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7328 the result between the data from different entries. It is possible for multiple
7329 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7330 you know that whatever values are returned all came from a single entry in the
7331 directory.
7332
7333 In the common case where you specify a single attribute in your LDAP query, the
7334 result is not quoted, and does not contain the attribute name. If the attribute
7335 has multiple values, they are separated by commas.
7336
7337 If you specify multiple attributes, the result contains space-separated, quoted
7338 strings, each preceded by the attribute name and an equals sign. Within the
7339 quotes, the quote character, backslash, and newline are escaped with
7340 backslashes, and commas are used to separate multiple values for the attribute.
7341 Apart from the escaping, the string within quotes takes the same form as the
7342 output when a single attribute is requested. Specifying no attributes is the
7343 same as specifying all of an entry's attributes.
7344
7345 Here are some examples of the output format. The first line of each pair is an
7346 LDAP query, and the second is the data that is returned. The attribute called
7347 &%attr1%& has two values, whereas &%attr2%& has only one value:
7348 .code
7349 ldap:///o=base?attr1?sub?(uid=fred)
7350 value1.1, value1.2
7351
7352 ldap:///o=base?attr2?sub?(uid=fred)
7353 value two
7354
7355 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7356 attr1="value1.1, value1.2" attr2="value two"
7357
7358 ldap:///o=base??sub?(uid=fred)
7359 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7360 .endd
7361 The &%extract%& operator in string expansions can be used to pick out
7362 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7363 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7364 results of LDAP lookups.
7365
7366
7367
7368
7369 .section "More about NIS+" "SECTnisplus"
7370 .cindex "NIS+ lookup type"
7371 .cindex "lookup" "NIS+"
7372 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7373 and field name. If this is given, the result of a successful query is the
7374 contents of the named field; otherwise the result consists of a concatenation
7375 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7376 values containing spaces are quoted. For example, the query
7377 .code
7378 [name=mg1456],passwd.org_dir
7379 .endd
7380 might return the string
7381 .code
7382 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7383 home=/home/mg1456 shell=/bin/bash shadow=""
7384 .endd
7385 (split over two lines here to fit on the page), whereas
7386 .code
7387 [name=mg1456],passwd.org_dir:gcos
7388 .endd
7389 would just return
7390 .code
7391 Martin Guerre
7392 .endd
7393 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7394 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7395 operator is to double any quote characters within the text.
7396
7397
7398
7399 .section "SQL lookups" "SECTsql"
7400 .cindex "SQL lookup types"
7401 .cindex "MySQL" "lookup type"
7402 .cindex "PostgreSQL lookup type"
7403 .cindex "lookup" "MySQL"
7404 .cindex "lookup" "PostgreSQL"
7405 .cindex "Oracle" "lookup type"
7406 .cindex "lookup" "Oracle"
7407 .cindex "InterBase lookup type"
7408 .cindex "lookup" "InterBase"
7409 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7410 databases. Queries for these databases contain SQL statements, so an example
7411 might be
7412 .code
7413 ${lookup mysql{select mailbox from users where id='userx'}\
7414   {$value}fail}
7415 .endd
7416 If the result of the query contains more than one field, the data for each
7417 field in the row is returned, preceded by its name, so the result of
7418 .code
7419 ${lookup pgsql{select home,name from users where id='userx'}\
7420   {$value}}
7421 .endd
7422 might be
7423 .code
7424 home=/home/userx name="Mister X"
7425 .endd
7426 Empty values and values containing spaces are double quoted, with embedded
7427 quotes escaped by a backslash. If the result of the query contains just one
7428 field, the value is passed back verbatim, without a field name, for example:
7429 .code
7430 Mister X
7431 .endd
7432 If the result of the query yields more than one row, it is all concatenated,
7433 with a newline between the data for each row.
7434
7435
7436 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7437 .cindex "MySQL" "lookup type"
7438 .cindex "PostgreSQL lookup type"
7439 .cindex "lookup" "MySQL"
7440 .cindex "lookup" "PostgreSQL"
7441 .cindex "Oracle" "lookup type"
7442 .cindex "lookup" "Oracle"
7443 .cindex "InterBase lookup type"
7444 .cindex "lookup" "InterBase"
7445 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7446 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7447 option (as appropriate) must be set to a colon-separated list of server
7448 information.
7449 (For MySQL and PostgreSQL only, the global option need not be set if all
7450 queries contain their own server information &-- see section
7451 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7452 items: host name, database name, user name, and password. In the case of
7453 Oracle, the host name field is used for the &"service name"&, and the database
7454 name field is not used and should be empty. For example:
7455 .code
7456 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7457 .endd
7458 Because password data is sensitive, you should always precede the setting with
7459 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7460 option. Here is an example where two MySQL servers are listed:
7461 .code
7462 hide mysql_servers = localhost/users/root/secret:\
7463                      otherhost/users/root/othersecret
7464 .endd
7465 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7466 because this is a colon-separated list, the colon has to be doubled. For each
7467 query, these parameter groups are tried in order until a connection is made and
7468 a query is successfully processed. The result of a query may be that no data is
7469 found, but that is still a successful query. In other words, the list of
7470 servers provides a backup facility, not a list of different places to look.
7471
7472 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7473 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7474 respectively, and the characters single-quote, double-quote, and backslash
7475 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7476 addition, escapes the percent and underscore characters. This cannot be done
7477 for MySQL because these escapes are not recognized in contexts where these
7478 characters are not special.
7479
7480 .section "Specifying the server in the query" "SECTspeserque"
7481 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7482 it is possible to specify a list of servers with an individual query. This is
7483 done by starting the query with
7484 .display
7485 &`servers=`&&'server1:server2:server3:...'&&`;`&
7486 .endd
7487 Each item in the list may take one of two forms:
7488 .olist
7489 If it contains no slashes it is assumed to be just a host name. The appropriate
7490 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7491 of the same name, and the remaining parameters (database, user, password) are
7492 taken from there.
7493 .next
7494 If it contains any slashes, it is taken as a complete parameter set.
7495 .endlist
7496 The list of servers is used in exactly the same way as the global list.
7497 Once a connection to a server has happened and a query has been
7498 successfully executed, processing of the lookup ceases.
7499
7500 This feature is intended for use in master/slave situations where updates
7501 are occurring and you want to update the master rather than a slave. If the
7502 master is in the list as a backup for reading, you might have a global setting
7503 like this:
7504 .code
7505 mysql_servers = slave1/db/name/pw:\
7506                 slave2/db/name/pw:\
7507                 master/db/name/pw
7508 .endd
7509 In an updating lookup, you could then write:
7510 .code
7511 ${lookup mysql{servers=master; UPDATE ...} }
7512 .endd
7513 That query would then be sent only to the master server. If, on the other hand,
7514 the master is not to be used for reading, and so is not present in the global
7515 option, you can still update it by a query of this form:
7516 .code
7517 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7518 .endd
7519
7520
7521 .section "Special MySQL features" "SECID73"
7522 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7523 causes a connection to the server on the local host by means of a Unix domain
7524 socket. An alternate socket can be specified in parentheses. The full syntax of
7525 each item in &%mysql_servers%& is:
7526 .display
7527 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7528   <&'user'&>/<&'password'&>
7529 .endd
7530 Any of the three sub-parts of the first field can be omitted. For normal use on
7531 the local host it can be left blank or set to just &"localhost"&.
7532
7533 No database need be supplied &-- but if it is absent here, it must be given in
7534 the queries.
7535
7536 If a MySQL query is issued that does not request any data (an insert, update,
7537 or delete command), the result of the lookup is the number of rows affected.
7538
7539 &*Warning*&: This can be misleading. If an update does not actually change
7540 anything (for example, setting a field to the value it already has), the result
7541 is zero because no rows are affected.
7542
7543
7544 .section "Special PostgreSQL features" "SECID74"
7545 PostgreSQL lookups can also use Unix domain socket connections to the database.
7546 This is usually faster and costs less CPU time than a TCP/IP connection.
7547 However it can be used only if the mail server runs on the same machine as the
7548 database server. A configuration line for PostgreSQL via Unix domain sockets
7549 looks like this:
7550 .code
7551 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7552 .endd
7553 In other words, instead of supplying a host name, a path to the socket is
7554 given. The path name is enclosed in parentheses so that its slashes aren't
7555 visually confused with the delimiters for the other server parameters.
7556
7557 If a PostgreSQL query is issued that does not request any data (an insert,
7558 update, or delete command), the result of the lookup is the number of rows
7559 affected.
7560
7561 .section "More about SQLite" "SECTsqlite"
7562 .cindex "lookup" "SQLite"
7563 .cindex "sqlite lookup type"
7564 SQLite is different to the other SQL lookups because a file name is required in
7565 addition to the SQL query. An SQLite database is a single file, and there is no
7566 daemon as in the other SQL databases. The interface to Exim requires the name
7567 of the file, as an absolute path, to be given at the start of the query. It is
7568 separated from the query by white space. This means that the path name cannot
7569 contain white space. Here is a lookup expansion example:
7570 .code
7571 ${lookup sqlite {/some/thing/sqlitedb \
7572   select name from aliases where id='userx';}}
7573 .endd
7574 In a list, the syntax is similar. For example:
7575 .code
7576 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7577    select * from relays where ip='$sender_host_address';
7578 .endd
7579 The only character affected by the &%quote_sqlite%& operator is a single
7580 quote, which it doubles.
7581
7582 The SQLite library handles multiple simultaneous accesses to the database
7583 internally. Multiple readers are permitted, but only one process can
7584 update at once. Attempts to access the database while it is being updated
7585 are rejected after a timeout period, during which the SQLite library
7586 waits for the lock to be released. In Exim, the default timeout is set
7587 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7588 option.
7589 .ecindex IIDfidalo1
7590 .ecindex IIDfidalo2
7591
7592
7593 . ////////////////////////////////////////////////////////////////////////////
7594 . ////////////////////////////////////////////////////////////////////////////
7595
7596 .chapter "Domain, host, address, and local part lists" &&&
7597          "CHAPdomhosaddlists" &&&
7598          "Domain, host, and address lists"
7599 .scindex IIDdohoadli "lists of domains; hosts; etc."
7600 A number of Exim configuration options contain lists of domains, hosts,
7601 email addresses, or local parts. For example, the &%hold_domains%& option
7602 contains a list of domains whose delivery is currently suspended. These lists
7603 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7604 arguments to expansion conditions such as &%match_domain%&.
7605
7606 Each item in one of these lists is a pattern to be matched against a domain,
7607 host, email address, or local part, respectively. In the sections below, the
7608 different types of pattern for each case are described, but first we cover some
7609 general facilities that apply to all four kinds of list.
7610
7611
7612
7613 .section "Expansion of lists" "SECID75"
7614 .cindex "expansion" "of lists"
7615 Each list is expanded as a single string before it is used. The result of
7616 expansion must be a list, possibly containing empty items, which is split up
7617 into separate items for matching. By default, colon is the separator character,
7618 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7619 &<<SECTempitelis>>& for details of the list syntax; the second of these
7620 discusses the way to specify empty list items.
7621
7622
7623 If the string expansion is forced to fail, Exim behaves as if the item it is
7624 testing (domain, host, address, or local part) is not in the list. Other
7625 expansion failures cause temporary errors.
7626
7627 If an item in a list is a regular expression, backslashes, dollars and possibly
7628 other special characters in the expression must be protected against
7629 misinterpretation by the string expander. The easiest way to do this is to use
7630 the &`\N`& expansion feature to indicate that the contents of the regular
7631 expression should not be expanded. For example, in an ACL you might have:
7632 .code
7633 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7634                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7635 .endd
7636 The first item is a regular expression that is protected from expansion by
7637 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7638 senders based on the receiving domain.
7639
7640
7641
7642
7643 .section "Negated items in lists" "SECID76"
7644 .cindex "list" "negation"
7645 .cindex "negation" "in lists"
7646 Items in a list may be positive or negative. Negative items are indicated by a
7647 leading exclamation mark, which may be followed by optional white space. A list
7648 defines a set of items (domains, etc). When Exim processes one of these lists,
7649 it is trying to find out whether a domain, host, address, or local part
7650 (respectively) is in the set that is defined by the list. It works like this:
7651
7652 The list is scanned from left to right. If a positive item is matched, the
7653 subject that is being checked is in the set; if a negative item is matched, the
7654 subject is not in the set. If the end of the list is reached without the
7655 subject having matched any of the patterns, it is in the set if the last item
7656 was a negative one, but not if it was a positive one. For example, the list in
7657 .code
7658 domainlist relay_to_domains = !a.b.c : *.b.c
7659 .endd
7660 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7661 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7662 list is positive. However, if the setting were
7663 .code
7664 domainlist relay_to_domains = !a.b.c
7665 .endd
7666 then all domains other than &'a.b.c'& would match because the last item in the
7667 list is negative. In other words, a list that ends with a negative item behaves
7668 as if it had an extra item &`:*`& on the end.
7669
7670 Another way of thinking about positive and negative items in lists is to read
7671 the connector as &"or"& after a positive item and as &"and"& after a negative
7672 item.
7673
7674
7675
7676 .section "File names in lists" "SECTfilnamlis"
7677 .cindex "list" "file name in"
7678 If an item in a domain, host, address, or local part list is an absolute file
7679 name (beginning with a slash character), each line of the file is read and
7680 processed as if it were an independent item in the list, except that further
7681 file names are not allowed,
7682 and no expansion of the data from the file takes place.
7683 Empty lines in the file are ignored, and the file may also contain comment
7684 lines:
7685
7686 .ilist
7687 For domain and host lists, if a # character appears anywhere in a line of the
7688 file, it and all following characters are ignored.
7689 .next
7690 Because local parts may legitimately contain # characters, a comment in an
7691 address list or local part list file is recognized only if # is preceded by
7692 white space or the start of the line. For example:
7693 .code
7694 not#comment@x.y.z   # but this is a comment
7695 .endd
7696 .endlist
7697
7698 Putting a file name in a list has the same effect as inserting each line of the
7699 file as an item in the list (blank lines and comments excepted). However, there
7700 is one important difference: the file is read each time the list is processed,
7701 so if its contents vary over time, Exim's behaviour changes.
7702
7703 If a file name is preceded by an exclamation mark, the sense of any match
7704 within the file is inverted. For example, if
7705 .code
7706 hold_domains = !/etc/nohold-domains
7707 .endd
7708 and the file contains the lines
7709 .code
7710 !a.b.c
7711 *.b.c
7712 .endd
7713 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7714 any domain matching &`*.b.c`& is not.
7715
7716
7717
7718 .section "An lsearch file is not an out-of-line list" "SECID77"
7719 As will be described in the sections that follow, lookups can be used in lists
7720 to provide indexed methods of checking list membership. There has been some
7721 confusion about the way &(lsearch)& lookups work in lists. Because
7722 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7723 sometimes thought that it is allowed to contain wild cards and other kinds of
7724 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7725 always fixed strings, just as for any other single-key lookup type.
7726
7727 If you want to use a file to contain wild-card patterns that form part of a
7728 list, just give the file name on its own, without a search type, as described
7729 in the previous section. You could also use the &(wildlsearch)& or
7730 &(nwildlsearch)&, but there is no advantage in doing this.
7731
7732
7733
7734
7735 .section "Named lists" "SECTnamedlists"
7736 .cindex "named lists"
7737 .cindex "list" "named"
7738 A list of domains, hosts, email addresses, or local parts can be given a name
7739 which is then used to refer to the list elsewhere in the configuration. This is
7740 particularly convenient if the same list is required in several different
7741 places. It also allows lists to be given meaningful names, which can improve
7742 the readability of the configuration. For example, it is conventional to define
7743 a domain list called &'local_domains'& for all the domains that are handled
7744 locally on a host, using a configuration line such as
7745 .code
7746 domainlist local_domains = localhost:my.dom.example
7747 .endd
7748 Named lists are referenced by giving their name preceded by a plus sign, so,
7749 for example, a router that is intended to handle local domains would be
7750 configured with the line
7751 .code
7752 domains = +local_domains
7753 .endd
7754 The first router in a configuration is often one that handles all domains
7755 except the local ones, using a configuration with a negated item like this:
7756 .code
7757 dnslookup:
7758   driver = dnslookup
7759   domains = ! +local_domains
7760   transport = remote_smtp
7761   no_more
7762 .endd
7763 The four kinds of named list are created by configuration lines starting with
7764 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7765 respectively. Then there follows the name that you are defining, followed by an
7766 equals sign and the list itself. For example:
7767 .code
7768 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7769 addresslist bad_senders = cdb;/etc/badsenders
7770 .endd
7771 A named list may refer to other named lists:
7772 .code
7773 domainlist  dom1 = first.example : second.example
7774 domainlist  dom2 = +dom1 : third.example
7775 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7776 .endd
7777 &*Warning*&: If the last item in a referenced list is a negative one, the
7778 effect may not be what you intended, because the negation does not propagate
7779 out to the higher level. For example, consider:
7780 .code
7781 domainlist  dom1 = !a.b
7782 domainlist  dom2 = +dom1 : *.b
7783 .endd
7784 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7785 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7786 means it matches the second list as well. The effect is not the same as
7787 .code
7788 domainlist  dom2 = !a.b : *.b
7789 .endd
7790 where &'x.y'& does not match. It's best to avoid negation altogether in
7791 referenced lists if you can.
7792
7793 Named lists may have a performance advantage. When Exim is routing an
7794 address or checking an incoming message, it caches the result of tests on named
7795 lists. So, if you have a setting such as
7796 .code
7797 domains = +local_domains
7798 .endd
7799 on several of your routers
7800 or in several ACL statements,
7801 the actual test is done only for the first one. However, the caching works only
7802 if there are no expansions within the list itself or any sublists that it
7803 references. In other words, caching happens only for lists that are known to be
7804 the same each time they are referenced.
7805
7806 By default, there may be up to 16 named lists of each type. This limit can be
7807 extended by changing a compile-time variable. The use of domain and host lists
7808 is recommended for concepts such as local domains, relay domains, and relay
7809 hosts. The default configuration is set up like this.
7810
7811
7812
7813 .section "Named lists compared with macros" "SECID78"
7814 .cindex "list" "named compared with macro"
7815 .cindex "macro" "compared with named list"
7816 At first sight, named lists might seem to be no different from macros in the
7817 configuration file. However, macros are just textual substitutions. If you
7818 write
7819 .code
7820 ALIST = host1 : host2
7821 auth_advertise_hosts = !ALIST
7822 .endd
7823 it probably won't do what you want, because that is exactly the same as
7824 .code
7825 auth_advertise_hosts = !host1 : host2
7826 .endd
7827 Notice that the second host name is not negated. However, if you use a host
7828 list, and write
7829 .code
7830 hostlist alist = host1 : host2
7831 auth_advertise_hosts = ! +alist
7832 .endd
7833 the negation applies to the whole list, and so that is equivalent to
7834 .code
7835 auth_advertise_hosts = !host1 : !host2
7836 .endd
7837
7838
7839 .section "Named list caching" "SECID79"
7840 .cindex "list" "caching of named"
7841 .cindex "caching" "named lists"
7842 While processing a message, Exim caches the result of checking a named list if
7843 it is sure that the list is the same each time. In practice, this means that
7844 the cache operates only if the list contains no $ characters, which guarantees
7845 that it will not change when it is expanded. Sometimes, however, you may have
7846 an expanded list that you know will be the same each time within a given
7847 message. For example:
7848 .code
7849 domainlist special_domains = \
7850            ${lookup{$sender_host_address}cdb{/some/file}}
7851 .endd
7852 This provides a list of domains that depends only on the sending host's IP
7853 address. If this domain list is referenced a number of times (for example,
7854 in several ACL lines, or in several routers) the result of the check is not
7855 cached by default, because Exim does not know that it is going to be the
7856 same list each time.
7857
7858 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7859 cache the result anyway. For example:
7860 .code
7861 domainlist_cache special_domains = ${lookup{...
7862 .endd
7863 If you do this, you should be absolutely sure that caching is going to do
7864 the right thing in all cases. When in doubt, leave it out.
7865
7866
7867
7868 .section "Domain lists" "SECTdomainlist"
7869 .cindex "domain list" "patterns for"
7870 .cindex "list" "domain list"
7871 Domain lists contain patterns that are to be matched against a mail domain.
7872 The following types of item may appear in domain lists:
7873
7874 .ilist
7875 .cindex "primary host name"
7876 .cindex "host name" "matched in domain list"
7877 .oindex "&%primary_hostname%&"
7878 .cindex "domain list" "matching primary host name"
7879 .cindex "@ in a domain list"
7880 If a pattern consists of a single @ character, it matches the local host name,
7881 as set by the &%primary_hostname%& option (or defaulted). This makes it
7882 possible to use the same configuration file on several different hosts that
7883 differ only in their names.
7884 .next
7885 .cindex "@[] in a domain list"
7886 .cindex "domain list" "matching local IP interfaces"
7887 .cindex "domain literal"
7888 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7889 in square brackets (as in an email address that contains a domain literal), but
7890 only if that IP address is recognized as local for email routing purposes. The
7891 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7892 control which of a host's several IP addresses are treated as local.
7893 In today's Internet, the use of domain literals is controversial.
7894 .next
7895 .cindex "@mx_any"
7896 .cindex "@mx_primary"
7897 .cindex "@mx_secondary"
7898 .cindex "domain list" "matching MX pointers to local host"
7899 If a pattern consists of the string &`@mx_any`& it matches any domain that
7900 has an MX record pointing to the local host or to any host that is listed in
7901 .oindex "&%hosts_treat_as_local%&"
7902 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7903 are similar, except that the first matches only when a primary MX target is the
7904 local host, and the second only when no primary MX target is the local host,
7905 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7906 preference value &-- there may of course be more than one of them.
7907
7908 The MX lookup that takes place when matching a pattern of this type is
7909 performed with the resolver options for widening names turned off. Thus, for
7910 example, a single-component domain will &'not'& be expanded by adding the
7911 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7912 options of the &(dnslookup)& router for a discussion of domain widening.
7913
7914 Sometimes you may want to ignore certain IP addresses when using one of these
7915 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7916 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7917 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7918 on a router). For example:
7919 .code
7920 domains = @mx_any/ignore=127.0.0.1
7921 .endd
7922 This example matches any domain that has an MX record pointing to one of
7923 the local host's IP addresses other than 127.0.0.1.
7924
7925 The list of IP addresses is in fact processed by the same code that processes
7926 host lists, so it may contain CIDR-coded network specifications and it may also
7927 contain negative items.
7928
7929 Because the list of IP addresses is a sublist within a domain list, you have to
7930 be careful about delimiters if there is more than one address. Like any other
7931 list, the default delimiter can be changed. Thus, you might have:
7932 .code
7933 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7934           an.other.domain : ...
7935 .endd
7936 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7937 involved, it is easiest to change the delimiter for the main list as well:
7938 .code
7939 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7940           an.other.domain ? ...
7941 .endd
7942 .next
7943 .cindex "asterisk" "in domain list"
7944 .cindex "domain list" "asterisk in"
7945 .cindex "domain list" "matching &""ends with""&"
7946 If a pattern starts with an asterisk, the remaining characters of the pattern
7947 are compared with the terminating characters of the domain. The use of &"*"& in
7948 domain lists differs from its use in partial matching lookups. In a domain
7949 list, the character following the asterisk need not be a dot, whereas partial
7950 matching works only in terms of dot-separated components. For example, a domain
7951 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7952 &'cipher.key.ex'&.
7953
7954 .next
7955 .cindex "regular expressions" "in domain list"
7956 .cindex "domain list" "matching regular expression"
7957 If a pattern starts with a circumflex character, it is treated as a regular
7958 expression, and matched against the domain using a regular expression matching
7959 function. The circumflex is treated as part of the regular expression.
7960 Email domains are case-independent, so this regular expression match is by
7961 default case-independent, but you can make it case-dependent by starting it
7962 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7963 are given in chapter &<<CHAPregexp>>&.
7964
7965 &*Warning*&: Because domain lists are expanded before being processed, you
7966 must escape any backslash and dollar characters in the regular expression, or
7967 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7968 it is not to be expanded (unless you really do want to build a regular
7969 expression by expansion, of course).
7970 .next
7971 .cindex "lookup" "in domain list"
7972 .cindex "domain list" "matching by lookup"
7973 If a pattern starts with the name of a single-key lookup type followed by a
7974 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7975 must be a file name in a suitable format for the lookup type. For example, for
7976 &"cdb;"& it must be an absolute path:
7977 .code
7978 domains = cdb;/etc/mail/local_domains.cdb
7979 .endd
7980 The appropriate type of lookup is done on the file using the domain name as the
7981 key. In most cases, the data that is looked up is not used; Exim is interested
7982 only in whether or not the key is present in the file. However, when a lookup
7983 is used for the &%domains%& option on a router
7984 or a &%domains%& condition in an ACL statement, the data is preserved in the
7985 &$domain_data$& variable and can be referred to in other router options or
7986 other statements in the same ACL.
7987
7988 .next
7989 Any of the single-key lookup type names may be preceded by
7990 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7991 .code
7992 domains = partial-dbm;/partial/domains
7993 .endd
7994 This causes partial matching logic to be invoked; a description of how this
7995 works is given in section &<<SECTpartiallookup>>&.
7996
7997 .next
7998 .cindex "asterisk" "in lookup type"
7999 Any of the single-key lookup types may be followed by an asterisk. This causes
8000 a default lookup for a key consisting of a single asterisk to be done if the
8001 original lookup fails. This is not a useful feature when using a domain list to
8002 select particular domains (because any domain would match), but it might have
8003 value if the result of the lookup is being used via the &$domain_data$&
8004 expansion variable.
8005 .next
8006 If the pattern starts with the name of a query-style lookup type followed by a
8007 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8008 pattern must be an appropriate query for the lookup type, as described in
8009 chapter &<<CHAPfdlookup>>&. For example:
8010 .code
8011 hold_domains = mysql;select domain from holdlist \
8012   where domain = '${quote_mysql:$domain}';
8013 .endd
8014 In most cases, the data that is looked up is not used (so for an SQL query, for
8015 example, it doesn't matter what field you select). Exim is interested only in
8016 whether or not the query succeeds. However, when a lookup is used for the
8017 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8018 variable and can be referred to in other options.
8019 .next
8020 .cindex "domain list" "matching literal domain name"
8021 If none of the above cases apply, a caseless textual comparison is made
8022 between the pattern and the domain.
8023 .endlist
8024
8025 Here is an example that uses several different kinds of pattern:
8026 .code
8027 domainlist funny_domains = \
8028   @ : \
8029   lib.unseen.edu : \
8030   *.foundation.fict.example : \
8031   \N^[1-2]\d{3}\.fict\.example$\N : \
8032   partial-dbm;/opt/data/penguin/book : \
8033   nis;domains.byname : \
8034   nisplus;[name=$domain,status=local],domains.org_dir
8035 .endd
8036 There are obvious processing trade-offs among the various matching modes. Using
8037 an asterisk is faster than a regular expression, and listing a few names
8038 explicitly probably is too. The use of a file or database lookup is expensive,
8039 but may be the only option if hundreds of names are required. Because the
8040 patterns are tested in order, it makes sense to put the most commonly matched
8041 patterns earlier.
8042
8043
8044
8045 .section "Host lists" "SECThostlist"
8046 .cindex "host list" "patterns in"
8047 .cindex "list" "host list"
8048 Host lists are used to control what remote hosts are allowed to do. For
8049 example, some hosts may be allowed to use the local host as a relay, and some
8050 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8051 two different ways, by name or by IP address. In a host list, some types of
8052 pattern are matched to a host name, and some are matched to an IP address.
8053 You need to be particularly careful with this when single-key lookups are
8054 involved, to ensure that the right value is being used as the key.
8055
8056
8057 .section "Special host list patterns" "SECID80"
8058 .cindex "empty item in hosts list"
8059 .cindex "host list" "empty string in"
8060 If a host list item is the empty string, it matches only when no remote host is
8061 involved. This is the case when a message is being received from a local
8062 process using SMTP on the standard input, that is, when a TCP/IP connection is
8063 not used.
8064
8065 .cindex "asterisk" "in host list"
8066 The special pattern &"*"& in a host list matches any host or no host. Neither
8067 the IP address nor the name is actually inspected.
8068
8069
8070
8071 .section "Host list patterns that match by IP address" "SECThoslispatip"
8072 .cindex "host list" "matching IP addresses"
8073 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8074 the incoming address actually appears in the IPv6 host as
8075 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8076 list, it is converted into a traditional IPv4 address first. (Not all operating
8077 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8078 concerns.)
8079
8080 The following types of pattern in a host list check the remote host by
8081 inspecting its IP address:
8082
8083 .ilist
8084 If the pattern is a plain domain name (not a regular expression, not starting
8085 with *, not a lookup of any kind), Exim calls the operating system function
8086 to find the associated IP address(es). Exim uses the newer
8087 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8088 This typically causes a forward DNS lookup of the name. The result is compared
8089 with the IP address of the subject host.
8090
8091 If there is a temporary problem (such as a DNS timeout) with the host name
8092 lookup, a temporary error occurs. For example, if the list is being used in an
8093 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8094 temporary SMTP error code. If no IP address can be found for the host name,
8095 what happens is described in section &<<SECTbehipnot>>& below.
8096
8097 .next
8098 .cindex "@ in a host list"
8099 If the pattern is &"@"&, the primary host name is substituted and used as a
8100 domain name, as just described.
8101
8102 .next
8103 If the pattern is an IP address, it is matched against the IP address of the
8104 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8105 IPv6 addresses can be given in colon-separated format, but the colons have to
8106 be doubled so as not to be taken as item separators when the default list
8107 separator is used. IPv6 addresses are recognized even when Exim is compiled
8108 without IPv6 support. This means that if they appear in a host list on an
8109 IPv4-only host, Exim will not treat them as host names. They are just addresses
8110 that can never match a client host.
8111
8112 .next
8113 .cindex "@[] in a host list"
8114 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8115 the local host. For example, if the local host is an IPv4 host with one
8116 interface address 10.45.23.56, these two ACL statements have the same effect:
8117 .code
8118 accept hosts = 127.0.0.1 : 10.45.23.56
8119 accept hosts = @[]
8120 .endd
8121 .next
8122 .cindex "CIDR notation"
8123 If the pattern is an IP address followed by a slash and a mask length (for
8124 example 10.11.42.0/24), it is matched against the IP address of the subject
8125 host under the given mask. This allows, an entire network of hosts to be
8126 included (or excluded) by a single item. The mask uses CIDR notation; it
8127 specifies the number of address bits that must match, starting from the most
8128 significant end of the address.
8129
8130 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8131 of a range of addresses. It is the number of bits in the network portion of the
8132 address. The above example specifies a 24-bit netmask, so it matches all 256
8133 addresses in the 10.11.42.0 network. An item such as
8134 .code
8135 192.168.23.236/31
8136 .endd
8137 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8138 32 for an IPv4 address is the same as no mask at all; just a single address
8139 matches.
8140
8141 Here is another example which shows an IPv4 and an IPv6 network:
8142 .code
8143 recipient_unqualified_hosts = 192.168.0.0/16: \
8144                               3ffe::ffff::836f::::/48
8145 .endd
8146 The doubling of list separator characters applies only when these items
8147 appear inline in a host list. It is not required when indirecting via a file.
8148 For example:
8149 .code
8150 recipient_unqualified_hosts = /opt/exim/unqualnets
8151 .endd
8152 could make use of a file containing
8153 .code
8154 172.16.0.0/12
8155 3ffe:ffff:836f::/48
8156 .endd
8157 to have exactly the same effect as the previous example. When listing IPv6
8158 addresses inline, it is usually more convenient to use the facility for
8159 changing separator characters. This list contains the same two networks:
8160 .code
8161 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8162                                  3ffe:ffff:836f::/48
8163 .endd
8164 The separator is changed to semicolon by the leading &"<;"& at the start of the
8165 list.
8166 .endlist
8167
8168
8169
8170 .section "Host list patterns for single-key lookups by host address" &&&
8171          "SECThoslispatsikey"
8172 .cindex "host list" "lookup of IP address"
8173 When a host is to be identified by a single-key lookup of its complete IP
8174 address, the pattern takes this form:
8175 .display
8176 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8177 .endd
8178 For example:
8179 .code
8180 hosts_lookup = net-cdb;/hosts-by-ip.db
8181 .endd
8182 The text form of the IP address of the subject host is used as the lookup key.
8183 IPv6 addresses are converted to an unabbreviated form, using lower case
8184 letters, with dots as separators because colon is the key terminator in
8185 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8186 quoting the keys, but this is a facility that was added later.] The data
8187 returned by the lookup is not used.
8188
8189 .cindex "IP address" "masking"
8190 .cindex "host list" "masked IP address"
8191 Single-key lookups can also be performed using masked IP addresses, using
8192 patterns of this form:
8193 .display
8194 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8195 .endd
8196 For example:
8197 .code
8198 net24-dbm;/networks.db
8199 .endd
8200 The IP address of the subject host is masked using <&'number'&> as the mask
8201 length. A textual string is constructed from the masked value, followed by the
8202 mask, and this is used as the lookup key. For example, if the host's IP address
8203 is 192.168.34.6, the key that is looked up for the above example is
8204 &"192.168.34.0/24"&.
8205
8206 When an IPv6 address is converted to a string, dots are normally used instead
8207 of colons, so that keys in &(lsearch)& files need not contain colons (which
8208 terminate &(lsearch)& keys). This was implemented some time before the ability
8209 to quote keys was made available in &(lsearch)& files. However, the more
8210 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8211 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8212 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8213 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8214 addresses are always used.
8215
8216 Ideally, it would be nice to tidy up this anomalous situation by changing to
8217 colons in all cases, given that quoting is now available for &(lsearch)&.
8218 However, this would be an incompatible change that might break some existing
8219 configurations.
8220
8221 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8222 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8223 the former case the key strings include the mask value, whereas in the latter
8224 case the IP address is used on its own.
8225
8226
8227
8228 .section "Host list patterns that match by host name" "SECThoslispatnam"
8229 .cindex "host" "lookup failures"
8230 .cindex "unknown host name"
8231 .cindex "host list" "matching host name"
8232 There are several types of pattern that require Exim to know the name of the
8233 remote host. These are either wildcard patterns or lookups by name. (If a
8234 complete hostname is given without any wildcarding, it is used to find an IP
8235 address to match against, as described in section &<<SECThoslispatip>>&
8236 above.)
8237
8238 If the remote host name is not already known when Exim encounters one of these
8239 patterns, it has to be found from the IP address.
8240 Although many sites on the Internet are conscientious about maintaining reverse
8241 DNS data for their hosts, there are also many that do not do this.
8242 Consequently, a name cannot always be found, and this may lead to unwanted
8243 effects. Take care when configuring host lists with wildcarded name patterns.
8244 Consider what will happen if a name cannot be found.
8245
8246 Because of the problems of determining host names from IP addresses, matching
8247 against host names is not as common as matching against IP addresses.
8248
8249 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8250 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8251 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8252 are done can be changed by setting the &%host_lookup_order%& option. For
8253 security, once Exim has found one or more names, it looks up the IP addresses
8254 for these names and compares them with the IP address that it started with.
8255 Only those names whose IP addresses match are accepted. Any other names are
8256 discarded. If no names are left, Exim behaves as if the host name cannot be
8257 found. In the most common case there is only one name and one IP address.
8258
8259 There are some options that control what happens if a host name cannot be
8260 found. These are described in section &<<SECTbehipnot>>& below.
8261
8262 .cindex "host" "alias for"
8263 .cindex "alias for host"
8264 As a result of aliasing, hosts may have more than one name. When processing any
8265 of the following types of pattern, all the host's names are checked:
8266
8267 .ilist
8268 .cindex "asterisk" "in host list"
8269 If a pattern starts with &"*"& the remainder of the item must match the end of
8270 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8271 &'.b.c'&. This special simple form is provided because this is a very common
8272 requirement. Other kinds of wildcarding require the use of a regular
8273 expression.
8274 .next
8275 .cindex "regular expressions" "in host list"
8276 .cindex "host list" "regular expression in"
8277 If the item starts with &"^"& it is taken to be a regular expression which is
8278 matched against the host name. Host names are case-independent, so this regular
8279 expression match is by default case-independent, but you can make it
8280 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8281 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8282 example,
8283 .code
8284 ^(a|b)\.c\.d$
8285 .endd
8286 is a regular expression that matches either of the two hosts &'a.c.d'& or
8287 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8288 that backslash and dollar characters are not misinterpreted as part of the
8289 string expansion. The simplest way to do this is to use &`\N`& to mark that
8290 part of the string as non-expandable. For example:
8291 .code
8292 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8293 .endd
8294 &*Warning*&: If you want to match a complete host name, you must include the
8295 &`$`& terminating metacharacter in the regular expression, as in the above
8296 example. Without it, a match at the start of the host name is all that is
8297 required.
8298 .endlist
8299
8300
8301
8302
8303 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8304 .cindex "host" "lookup failures, permanent"
8305 While processing a host list, Exim may need to look up an IP address from a
8306 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8307 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8308 behaviour when it fails to find the information it is seeking is the same.
8309
8310 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8311 apply to temporary DNS errors, whose handling is described in the next section.
8312
8313 .cindex "&`+include_unknown`&"
8314 .cindex "&`+ignore_unknown`&"
8315 Exim parses a host list from left to right. If it encounters a permanent
8316 lookup failure in any item in the host list before it has found a match,
8317 Exim treats it as a failure and the default behavior is as if the host
8318 does not match the list. This may not always be what you want to happen.
8319 To change Exim's behaviour, the special items &`+include_unknown`& or
8320 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8321 not recognized in an indirected file).
8322
8323 .ilist
8324 If any item that follows &`+include_unknown`& requires information that
8325 cannot found, Exim behaves as if the host does match the list. For example,
8326 .code
8327 host_reject_connection = +include_unknown:*.enemy.ex
8328 .endd
8329 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8330 any hosts whose name it cannot find.
8331
8332 .next
8333 If any item that follows &`+ignore_unknown`& requires information that cannot
8334 be found, Exim ignores that item and proceeds to the rest of the list. For
8335 example:
8336 .code
8337 accept hosts = +ignore_unknown : friend.example : \
8338                192.168.4.5
8339 .endd
8340 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8341 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8342 name can be found for 192.168.4.5, it is rejected.
8343 .endlist
8344
8345 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8346 list. The effect of each one lasts until the next, or until the end of the
8347 list.
8348
8349 .section "Mixing wildcarded host names and addresses in host lists" &&&
8350          "SECTmixwilhos"
8351 .cindex "host list" "mixing names and addresses in"
8352
8353 This section explains the host/ip processing logic with the same concepts
8354 as the previous section, but specifically addresses what happens when a
8355 wildcarded hostname is one of the items in the hostlist.
8356
8357 .ilist
8358 If you have name lookups or wildcarded host names and
8359 IP addresses in the same host list, you should normally put the IP
8360 addresses first. For example, in an ACL you could have:
8361 .code
8362 accept hosts = 10.9.8.7 : *.friend.example
8363 .endd
8364 The reason you normally would order it this way lies in the
8365 left-to-right way that Exim processes lists.  It can test IP addresses
8366 without doing any DNS lookups, but when it reaches an item that requires
8367 a host name, it fails if it cannot find a host name to compare with the
8368 pattern. If the above list is given in the opposite order, the
8369 &%accept%& statement fails for a host whose name cannot be found, even
8370 if its IP address is 10.9.8.7.
8371
8372 .next
8373 If you really do want to do the name check first, and still recognize the IP
8374 address, you can rewrite the ACL like this:
8375 .code
8376 accept hosts = *.friend.example
8377 accept hosts = 10.9.8.7
8378 .endd
8379 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8380 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8381 &`+ignore_unknown`&, which was discussed in depth in the first example in
8382 this section.
8383 .endlist
8384
8385
8386 .section "Temporary DNS errors when looking up host information" &&&
8387          "SECTtemdnserr"
8388 .cindex "host" "lookup failures, temporary"
8389 .cindex "&`+include_defer`&"
8390 .cindex "&`+ignore_defer`&"
8391 A temporary DNS lookup failure normally causes a defer action (except when
8392 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8393 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8394 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8395 section. These options should be used with care, probably only in non-critical
8396 host lists such as whitelists.
8397
8398
8399
8400 .section "Host list patterns for single-key lookups by host name" &&&
8401          "SECThoslispatnamsk"
8402 .cindex "unknown host name"
8403 .cindex "host list" "matching host name"
8404 If a pattern is of the form
8405 .display
8406 <&'single-key-search-type'&>;<&'search-data'&>
8407 .endd
8408 for example
8409 .code
8410 dbm;/host/accept/list
8411 .endd
8412 a single-key lookup is performed, using the host name as its key. If the
8413 lookup succeeds, the host matches the item. The actual data that is looked up
8414 is not used.
8415
8416 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8417 keys in the file, not IP addresses. If you want to do lookups based on IP
8418 addresses, you must precede the search type with &"net-"& (see section
8419 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8420 two items in the same list, one doing an address lookup and one doing a name
8421 lookup, both using the same file.
8422
8423
8424
8425 .section "Host list patterns for query-style lookups" "SECID81"
8426 If a pattern is of the form
8427 .display
8428 <&'query-style-search-type'&>;<&'query'&>
8429 .endd
8430 the query is obeyed, and if it succeeds, the host matches the item. The actual
8431 data that is looked up is not used. The variables &$sender_host_address$& and
8432 &$sender_host_name$& can be used in the query. For example:
8433 .code
8434 hosts_lookup = pgsql;\
8435   select ip from hostlist where ip='$sender_host_address'
8436 .endd
8437 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8438 can use the &%sg%& expansion item to change this if you need to. If you want to
8439 use masked IP addresses in database queries, you can use the &%mask%& expansion
8440 operator.
8441
8442 If the query contains a reference to &$sender_host_name$&, Exim automatically
8443 looks up the host name if it has not already done so. (See section
8444 &<<SECThoslispatnam>>& for comments on finding host names.)
8445
8446 Historical note: prior to release 4.30, Exim would always attempt to find a
8447 host name before running the query, unless the search type was preceded by
8448 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8449 still recognized for query-style lookups, but its presence or absence has no
8450 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8451 See section &<<SECThoslispatsikey>>&.)
8452
8453
8454
8455
8456
8457 .section "Address lists" "SECTaddresslist"
8458 .cindex "list" "address list"
8459 .cindex "address list" "empty item"
8460 .cindex "address list" "patterns"
8461 Address lists contain patterns that are matched against mail addresses. There
8462 is one special case to be considered: the sender address of a bounce message is
8463 always empty. You can test for this by providing an empty item in an address
8464 list. For example, you can set up a router to process bounce messages by
8465 using this option setting:
8466 .code
8467 senders = :
8468 .endd
8469 The presence of the colon creates an empty item. If you do not provide any
8470 data, the list is empty and matches nothing. The empty sender can also be
8471 detected by a regular expression that matches an empty string,
8472 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8473
8474 Non-empty items in an address list can be straightforward email addresses. For
8475 example:
8476 .code
8477 senders = jbc@askone.example : hs@anacreon.example
8478 .endd
8479 A certain amount of wildcarding is permitted. If a pattern contains an @
8480 character, but is not a regular expression and does not begin with a
8481 semicolon-terminated lookup type (described below), the local part of the
8482 subject address is compared with the local part of the pattern, which may start
8483 with an asterisk. If the local parts match, the domain is checked in exactly
8484 the same way as for a pattern in a domain list. For example, the domain can be
8485 wildcarded, refer to a named list, or be a lookup:
8486 .code
8487 deny senders = *@*.spamming.site:\
8488                *@+hostile_domains:\
8489                bozo@partial-lsearch;/list/of/dodgy/sites:\
8490                *@dbm;/bad/domains.db
8491 .endd
8492 .cindex "local part" "starting with !"
8493 .cindex "address list" "local part starting with !"
8494 If a local part that begins with an exclamation mark is required, it has to be
8495 specified using a regular expression, because otherwise the exclamation mark is
8496 treated as a sign of negation, as is standard in lists.
8497
8498 If a non-empty pattern that is not a regular expression or a lookup does not
8499 contain an @ character, it is matched against the domain part of the subject
8500 address. The only two formats that are recognized this way are a literal
8501 domain, or a domain pattern that starts with *. In both these cases, the effect
8502 is the same as if &`*@`& preceded the pattern. For example:
8503 .code
8504 deny senders = enemy.domain : *.enemy.domain
8505 .endd
8506
8507 The following kinds of more complicated address list pattern can match any
8508 address, including the empty address that is characteristic of bounce message
8509 senders:
8510
8511 .ilist
8512 .cindex "regular expressions" "in address list"
8513 .cindex "address list" "regular expression in"
8514 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8515 done against the complete address, with the pattern as the regular expression.
8516 You must take care that backslash and dollar characters are not misinterpreted
8517 as part of the string expansion. The simplest way to do this is to use &`\N`&
8518 to mark that part of the string as non-expandable. For example:
8519 .code
8520 deny senders = \N^.*this.*@example\.com$\N : \
8521                \N^\d{8}.+@spamhaus.example$\N : ...
8522 .endd
8523 The &`\N`& sequences are removed by the expansion, so these items do indeed
8524 start with &"^"& by the time they are being interpreted as address patterns.
8525
8526 .next
8527 .cindex "address list" "lookup for complete address"
8528 Complete addresses can be looked up by using a pattern that starts with a
8529 lookup type terminated by a semicolon, followed by the data for the lookup. For
8530 example:
8531 .code
8532 deny senders = cdb;/etc/blocked.senders : \
8533   mysql;select address from blocked where \
8534   address='${quote_mysql:$sender_address}'
8535 .endd
8536 Both query-style and single-key lookup types can be used. For a single-key
8537 lookup type, Exim uses the complete address as the key. However, empty keys are
8538 not supported for single-key lookups, so a match against the empty address
8539 always fails. This restriction does not apply to query-style lookups.
8540
8541 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8542 cannot be used, and is ignored if specified, with an entry being written to the
8543 panic log.
8544 .cindex "*@ with single-key lookup"
8545 However, you can configure lookup defaults, as described in section
8546 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8547 default. For example, with this lookup:
8548 .code
8549 accept senders = lsearch*@;/some/file
8550 .endd
8551 the file could contains lines like this:
8552 .code
8553 user1@domain1.example
8554 *@domain2.example
8555 .endd
8556 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8557 that are tried is:
8558 .code
8559 nimrod@jaeger.example
8560 *@jaeger.example
8561 *
8562 .endd
8563 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8564 would mean that every address matches, thus rendering the test useless.
8565
8566 &*Warning 2*&: Do not confuse these two kinds of item:
8567 .code
8568 deny recipients = dbm*@;/some/file
8569 deny recipients = *@dbm;/some/file
8570 .endd
8571 The first does a whole address lookup, with defaulting, as just described,
8572 because it starts with a lookup type. The second matches the local part and
8573 domain independently, as described in a bullet point below.
8574 .endlist
8575
8576
8577 The following kinds of address list pattern can match only non-empty addresses.
8578 If the subject address is empty, a match against any of these pattern types
8579 always fails.
8580
8581
8582 .ilist
8583 .cindex "@@ with single-key lookup"
8584 .cindex "address list" "@@ lookup type"
8585 .cindex "address list" "split local part and domain"
8586 If a pattern starts with &"@@"& followed by a single-key lookup item
8587 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8588 split into a local part and a domain. The domain is looked up in the file. If
8589 it is not found, there is no match. If it is found, the data that is looked up
8590 from the file is treated as a colon-separated list of local part patterns, each
8591 of which is matched against the subject local part in turn.
8592
8593 .cindex "asterisk" "in address list"
8594 The lookup may be a partial one, and/or one involving a search for a default
8595 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8596 patterns that are looked up can be regular expressions or begin with &"*"&, or
8597 even be further lookups. They may also be independently negated. For example,
8598 with
8599 .code
8600 deny senders = @@dbm;/etc/reject-by-domain
8601 .endd
8602 the data from which the DBM file is built could contain lines like
8603 .code
8604 baddomain.com:  !postmaster : *
8605 .endd
8606 to reject all senders except &%postmaster%& from that domain.
8607
8608 .cindex "local part" "starting with !"
8609 If a local part that actually begins with an exclamation mark is required, it
8610 has to be specified using a regular expression. In &(lsearch)& files, an entry
8611 may be split over several lines by indenting the second and subsequent lines,
8612 but the separating colon must still be included at line breaks. White space
8613 surrounding the colons is ignored. For example:
8614 .code
8615 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8616   spammer3 : spammer4
8617 .endd
8618 As in all colon-separated lists in Exim, a colon can be included in an item by
8619 doubling.
8620
8621 If the last item in the list starts with a right angle-bracket, the remainder
8622 of the item is taken as a new key to look up in order to obtain a continuation
8623 list of local parts. The new key can be any sequence of characters. Thus one
8624 might have entries like
8625 .code
8626 aol.com: spammer1 : spammer 2 : >*
8627 xyz.com: spammer3 : >*
8628 *:       ^\d{8}$
8629 .endd
8630 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8631 local parts for all domains, in addition to the specific local parts listed for
8632 each domain. Of course, using this feature costs another lookup each time a
8633 chain is followed, but the effort needed to maintain the data is reduced.
8634
8635 .cindex "loop" "in lookups"
8636 It is possible to construct loops using this facility, and in order to catch
8637 them, the chains may be no more than fifty items long.
8638
8639 .next
8640 The @@<&'lookup'&> style of item can also be used with a query-style
8641 lookup, but in this case, the chaining facility is not available. The lookup
8642 can only return a single list of local parts.
8643 .endlist
8644
8645 &*Warning*&: There is an important difference between the address list items
8646 in these two examples:
8647 .code
8648 senders = +my_list
8649 senders = *@+my_list
8650 .endd
8651 In the first one, &`my_list`& is a named address list, whereas in the second
8652 example it is a named domain list.
8653
8654
8655
8656
8657 .section "Case of letters in address lists" "SECTcasletadd"
8658 .cindex "case of local parts"
8659 .cindex "address list" "case forcing"
8660 .cindex "case forcing in address lists"
8661 Domains in email addresses are always handled caselessly, but for local parts
8662 case may be significant on some systems (see &%caseful_local_part%& for how
8663 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8664 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8665 blocking lists should be done in a case-independent manner. Since most address
8666 lists in Exim are used for this kind of control, Exim attempts to do this by
8667 default.
8668
8669 The domain portion of an address is always lowercased before matching it to an
8670 address list. The local part is lowercased by default, and any string
8671 comparisons that take place are done caselessly. This means that the data in
8672 the address list itself, in files included as plain file names, and in any file
8673 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8674 keys in files that are looked up by a search type other than &(lsearch)& (which
8675 works caselessly) must be in lower case, because these lookups are not
8676 case-independent.
8677
8678 .cindex "&`+caseful`&"
8679 To allow for the possibility of caseful address list matching, if an item in
8680 an address list is the string &"+caseful"&, the original case of the local
8681 part is restored for any comparisons that follow, and string comparisons are no
8682 longer case-independent. This does not affect the domain, which remains in
8683 lower case. However, although independent matches on the domain alone are still
8684 performed caselessly, regular expressions that match against an entire address
8685 become case-sensitive after &"+caseful"& has been seen.
8686
8687
8688
8689 .section "Local part lists" "SECTlocparlis"
8690 .cindex "list" "local part list"
8691 .cindex "local part" "list"
8692 Case-sensitivity in local part lists is handled in the same way as for address
8693 lists, as just described. The &"+caseful"& item can be used if required. In a
8694 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8695 set false, the subject is lowercased and the matching is initially
8696 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8697 matching in the local part list, but not elsewhere in the router. If
8698 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8699 option is case-sensitive from the start.
8700
8701 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8702 comments are handled in the same way as address lists &-- they are recognized
8703 only if the # is preceded by white space or the start of the line.
8704 Otherwise, local part lists are matched in the same way as domain lists, except
8705 that the special items that refer to the local host (&`@`&, &`@[]`&,
8706 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8707 Refer to section &<<SECTdomainlist>>& for details of the other available item
8708 types.
8709 .ecindex IIDdohoadli
8710
8711
8712
8713
8714 . ////////////////////////////////////////////////////////////////////////////
8715 . ////////////////////////////////////////////////////////////////////////////
8716
8717 .chapter "String expansions" "CHAPexpand"
8718 .scindex IIDstrexp "expansion" "of strings"
8719 Many strings in Exim's run time configuration are expanded before use. Some of
8720 them are expanded every time they are used; others are expanded only once.
8721
8722 When a string is being expanded it is copied verbatim from left to right except
8723 when a dollar or backslash character is encountered. A dollar specifies the
8724 start of a portion of the string that is interpreted and replaced as described
8725 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8726 escape character, as described in the following section.
8727
8728 Whether a string is expanded depends upon the context.  Usually this is solely
8729 dependent upon the option for which a value is sought; in this documentation,
8730 options for which string expansion is performed are marked with &dagger; after
8731 the data type.  ACL rules always expand strings.  A couple of expansion
8732 conditions do not expand some of the brace-delimited branches, for security
8733 reasons.
8734
8735
8736
8737 .section "Literal text in expanded strings" "SECTlittext"
8738 .cindex "expansion" "including literal text"
8739 An uninterpreted dollar can be included in an expanded string by putting a
8740 backslash in front of it. A backslash can be used to prevent any special
8741 character being treated specially in an expansion, including backslash itself.
8742 If the string appears in quotes in the configuration file, two backslashes are
8743 required because the quotes themselves cause interpretation of backslashes when
8744 the string is read in (see section &<<SECTstrings>>&).
8745
8746 .cindex "expansion" "non-expandable substrings"
8747 A portion of the string can specified as non-expandable by placing it between
8748 two occurrences of &`\N`&. This is particularly useful for protecting regular
8749 expressions, which often contain backslashes and dollar signs. For example:
8750 .code
8751 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8752 .endd
8753 On encountering the first &`\N`&, the expander copies subsequent characters
8754 without interpretation until it reaches the next &`\N`& or the end of the
8755 string.
8756
8757
8758
8759 .section "Character escape sequences in expanded strings" "SECID82"
8760 .cindex "expansion" "escape sequences"
8761 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8762 expanded string is recognized as an escape sequence for the character newline,
8763 carriage return, or tab, respectively. A backslash followed by up to three
8764 octal digits is recognized as an octal encoding for a single character, and a
8765 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8766 encoding.
8767
8768 These escape sequences are also recognized in quoted strings when they are read
8769 in. Their interpretation in expansions as well is useful for unquoted strings,
8770 and for other cases such as looked-up strings that are then expanded.
8771
8772
8773 .section "Testing string expansions" "SECID83"
8774 .cindex "expansion" "testing"
8775 .cindex "testing" "string expansion"
8776 .oindex "&%-be%&"
8777 Many expansions can be tested by calling Exim with the &%-be%& option. This
8778 takes the command arguments, or lines from the standard input if there are no
8779 arguments, runs them through the string expansion code, and writes the results
8780 to the standard output. Variables based on configuration values are set up, but
8781 since no message is being processed, variables such as &$local_part$& have no
8782 value. Nevertheless the &%-be%& option can be useful for checking out file and
8783 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8784 and &%nhash%&.
8785
8786 Exim gives up its root privilege when it is called with the &%-be%& option, and
8787 instead runs under the uid and gid it was called with, to prevent users from
8788 using &%-be%& for reading files to which they do not have access.
8789
8790 .oindex "&%-bem%&"
8791 If you want to test expansions that include variables whose values are taken
8792 from a message, there are two other options that can be used. The &%-bem%&
8793 option is like &%-be%& except that it is followed by a file name. The file is
8794 read as a message before doing the test expansions. For example:
8795 .code
8796 exim -bem /tmp/test.message '$h_subject:'
8797 .endd
8798 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8799 Exim message identifier. For example:
8800 .code
8801 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8802 .endd
8803 This loads the message from Exim's spool before doing the test expansions, and
8804 is therefore restricted to admin users.
8805
8806
8807 .section "Forced expansion failure" "SECTforexpfai"
8808 .cindex "expansion" "forced failure"
8809 A number of expansions that are described in the following section have
8810 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8811 (which are sometimes called &"curly brackets"&). Which of the two strings is
8812 used depends on some condition that is evaluated as part of the expansion. If,
8813 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8814 the entire string expansion fails in a way that can be detected by the code
8815 that requested the expansion. This is called &"forced expansion failure"&, and
8816 its consequences depend on the circumstances. In some cases it is no different
8817 from any other expansion failure, but in others a different action may be
8818 taken. Such variations are mentioned in the documentation of the option that is
8819 being expanded.
8820
8821
8822
8823
8824 .section "Expansion items" "SECTexpansionitems"
8825 The following items are recognized in expanded strings. White space may be used
8826 between sub-items that are keywords or substrings enclosed in braces inside an
8827 outer set of braces, to improve readability. &*Warning*&: Within braces,
8828 white space is significant.
8829
8830 .vlist
8831 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8832 .cindex "expansion" "variables"
8833 Substitute the contents of the named variable, for example:
8834 .code
8835 $local_part
8836 ${domain}
8837 .endd
8838 The second form can be used to separate the name from subsequent alphanumeric
8839 characters. This form (using braces) is available only for variables; it does
8840 &'not'& apply to message headers. The names of the variables are given in
8841 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8842 given, the expansion fails.
8843
8844 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8845 .cindex "expansion" "operators"
8846 The string is first itself expanded, and then the operation specified by
8847 <&'op'&> is applied to it. For example:
8848 .code
8849 ${lc:$local_part}
8850 .endd
8851 The string starts with the first character after the colon, which may be
8852 leading white space. A list of operators is given in section &<<SECTexpop>>&
8853 below. The operator notation is used for simple expansion items that have just
8854 one argument, because it reduces the number of braces and therefore makes the
8855 string easier to understand.
8856
8857 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8858 This item inserts &"basic"& header lines. It is described with the &%header%&
8859 expansion item below.
8860
8861
8862 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8863 .cindex "expansion" "calling an acl"
8864 .cindex "&%acl%&" "call from expansion"
8865 The name and zero to nine argument strings are first expanded separately.  The expanded
8866 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8867 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8868 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8869 and may use the variables; if another acl expansion is used the values
8870 are restored after it returns.  If the ACL sets
8871 a value using a "message =" modifier and returns accept or deny, the value becomes
8872 the result of the expansion.
8873 If no message is set and the ACL returns accept or deny
8874 the expansion result is an empty string.
8875 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8876
8877
8878 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8879        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8880 .cindex "expansion" "extracting cerificate fields"
8881 .cindex "&%certextract%&" "certificate fields"
8882 .cindex "certificate" "extracting fields"
8883 The <&'certificate'&> must be a variable of type certificate.
8884 The field name is expanded and used to retrive the relevant field from
8885 the certificate.  Supported fields are:
8886 .display
8887 &`version        `&
8888 &`serial_number  `&
8889 &`subject        `& RFC4514 DN
8890 &`issuer         `& RFC4514 DN
8891 &`notbefore      `& time
8892 &`notafter       `& time
8893 &`sig_algorithm  `&
8894 &`signature      `&
8895 &`subj_altname   `& tagged list
8896 &`ocsp_uri       `& list
8897 &`crl_uri        `& list
8898 .endd
8899 If the field is found,
8900 <&'string2'&> is expanded, and replaces the whole item;
8901 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8902 variable &$value$& contains the value that has been extracted. Afterwards, it
8903 is restored to any previous value it might have had.
8904
8905 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8906 key is not found. If {<&'string2'&>} is also omitted, the value that was
8907 extracted is used.
8908
8909 Some field names take optional modifiers, appended and separated by commas.
8910
8911 The field selectors marked as "RFC4514" above
8912 output a Distinguished Name string which is
8913 not quite
8914 parseable by Exim as a comma-separated tagged list
8915 (the exceptions being elements containin commas).
8916 RDN elements of a single type may be selected by
8917 a modifier of the type label; if so the expansion
8918 result is a list (newline-separated by default).
8919 The separator may be changed by another modifer of
8920 a right angle-bracket followed immediately by the new separator.
8921 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8922
8923 The field selectors marked as "time" above
8924 may output a number of seconds since epoch
8925 if the modifier "int" is used.
8926
8927 The field selectors marked as "list" above return a list,
8928 newline-separated by default,
8929 (embedded separator characters in elements are doubled).
8930 The separator may be changed by a modifier of
8931 a right angle-bracket followed immediately by the new separator.
8932
8933 The field selectors marked as "tagged" above
8934 prefix each list element with a type string and an equals sign.
8935 Elements of only one type may be selected by a modifier
8936 which is one of "dns", "uri" or "mail";
8937 if so the elenment tags are omitted.
8938
8939 If not otherwise noted field values are presented in human-readable form.
8940
8941 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8942        {*&<&'arg'&>&*}...}*&"
8943 .cindex &%dlfunc%&
8944 This expansion dynamically loads and then calls a locally-written C function.
8945 This functionality is available only if Exim is compiled with
8946 .code
8947 EXPAND_DLFUNC=yes
8948 .endd
8949 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8950 object so that it doesn't reload the same object file in the same Exim process
8951 (but of course Exim does start new processes frequently).
8952
8953 There may be from zero to eight arguments to the function. When compiling
8954 a local function that is to be called in this way, &_local_scan.h_& should be
8955 included. The Exim variables and functions that are defined by that API
8956 are also available for dynamically loaded functions. The function itself
8957 must have the following type:
8958 .code
8959 int dlfunction(uschar **yield, int argc, uschar *argv[])
8960 .endd
8961 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8962 function should return one of the following values:
8963
8964 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8965 into the expanded string that is being built.
8966
8967 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8968 from &'yield'&, if it is set.
8969
8970 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8971 taken from &'yield'& if it is set.
8972
8973 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8974
8975 When compiling a function that is to be used in this way with gcc,
8976 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8977 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8978
8979 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8980        {*&<&'string3'&>&*}}*&"
8981 .cindex "expansion" "extracting substrings by key"
8982 .cindex "&%extract%&" "substrings by key"
8983 The key and <&'string1'&> are first expanded separately. Leading and trailing
8984 white space is removed from the key (but not from any of the strings). The key
8985 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8986 form:
8987 .display
8988 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8989 .endd
8990 .vindex "&$value$&"
8991 where the equals signs and spaces (but not both) are optional. If any of the
8992 values contain white space, they must be enclosed in double quotes, and any
8993 values that are enclosed in double quotes are subject to escape processing as
8994 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8995 for the value that corresponds to the key. The search is case-insensitive. If
8996 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8997 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8998 variable &$value$& contains the value that has been extracted. Afterwards, it
8999 is restored to any previous value it might have had.
9000
9001 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9002 key is not found. If {<&'string2'&>} is also omitted, the value that was
9003 extracted is used. Thus, for example, these two expansions are identical, and
9004 yield &"2001"&:
9005 .code
9006 ${extract{gid}{uid=1984 gid=2001}}
9007 ${extract{gid}{uid=1984 gid=2001}{$value}}
9008 .endd
9009 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9010 appear, for example:
9011 .code
9012 ${extract{Z}{A=... B=...}{$value} fail }
9013 .endd
9014 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9015 {<&'string2'&>} must be present for &"fail"& to be recognized.
9016
9017
9018 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9019         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9020 .cindex "expansion" "extracting substrings by number"
9021 .cindex "&%extract%&" "substrings by number"
9022 The <&'number'&> argument must consist entirely of decimal digits,
9023 apart from leading and trailing white space, which is ignored.
9024 This is what distinguishes this form of &%extract%& from the previous kind. It
9025 behaves in the same way, except that, instead of extracting a named field, it
9026 extracts from <&'string1'&> the field whose number is given as the first
9027 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9028 <&'string3'&> as before.
9029
9030 The fields in the string are separated by any one of the characters in the
9031 separator string. These may include space or tab characters.
9032 The first field is numbered one. If the number is negative, the fields are
9033 counted from the end of the string, with the rightmost one numbered -1. If the
9034 number given is zero, the entire string is returned. If the modulus of the
9035 number is greater than the number of fields in the string, the result is the
9036 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9037 provided. For example:
9038 .code
9039 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9040 .endd
9041 yields &"42"&, and
9042 .code
9043 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9044 .endd
9045 yields &"99"&. Two successive separators mean that the field between them is
9046 empty (for example, the fifth field above).
9047
9048
9049 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9050 .cindex "list" "selecting by condition"
9051 .cindex "expansion" "selecting from list by condition"
9052 .vindex "&$item$&"
9053 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9054 default, but the separator can be changed in the usual way. For each item
9055 in this list, its value is place in &$item$&, and then the condition is
9056 evaluated. If the condition is true, &$item$& is added to the output as an
9057 item in a new list; if the condition is false, the item is discarded. The
9058 separator used for the output list is the same as the one used for the
9059 input, but a separator setting is not included in the output. For example:
9060 .code
9061 ${filter{a:b:c}{!eq{$item}{b}}
9062 .endd
9063 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9064 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9065
9066
9067 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9068 .cindex "hash function" "textual"
9069 .cindex "expansion" "textual hash"
9070 This is a textual hashing function, and was the first to be implemented in
9071 early versions of Exim. In current releases, there are other hashing functions
9072 (numeric, MD5, and SHA-1), which are described below.
9073
9074 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9075 <&'n'&>. If you are using fixed values for these numbers, that is, if
9076 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9077 use the simpler operator notation that avoids some of the braces:
9078 .code
9079 ${hash_<n>_<m>:<string>}
9080 .endd
9081 The second number is optional (in both notations). If <&'n'&> is greater than
9082 or equal to the length of the string, the expansion item returns the string.
9083 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9084 function to the string. The new string consists of characters taken from the
9085 first <&'m'&> characters of the string
9086 .code
9087 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9088 .endd
9089 If <&'m'&> is not present the value 26 is used, so that only lower case
9090 letters appear. For example:
9091 .display
9092 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9093 &`$hash{5}{monty}}           `&   yields  &`monty`&
9094 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9095 .endd
9096
9097 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9098         &*$h_*&<&'header&~name'&>&*:*&" &&&
9099        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9100         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9101        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9102         &*$rh_*&<&'header&~name'&>&*:*&"
9103 .cindex "expansion" "header insertion"
9104 .vindex "&$header_$&"
9105 .vindex "&$bheader_$&"
9106 .vindex "&$rheader_$&"
9107 .cindex "header lines" "in expansion strings"
9108 .cindex "header lines" "character sets"
9109 .cindex "header lines" "decoding"
9110 Substitute the contents of the named message header line, for example
9111 .code
9112 $header_reply-to:
9113 .endd
9114 The newline that terminates a header line is not included in the expansion, but
9115 internal newlines (caused by splitting the header line over several physical
9116 lines) may be present.
9117
9118 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9119 the data in the header line is interpreted.
9120
9121 .ilist
9122 .cindex "white space" "in header lines"
9123 &%rheader%& gives the original &"raw"& content of the header line, with no
9124 processing at all, and without the removal of leading and trailing white space.
9125
9126 .next
9127 .cindex "base64 encoding" "in header lines"
9128 &%bheader%& removes leading and trailing white space, and then decodes base64
9129 or quoted-printable MIME &"words"& within the header text, but does no
9130 character set translation. If decoding of what looks superficially like a MIME
9131 &"word"& fails, the raw string is returned. If decoding
9132 .cindex "binary zero" "in header line"
9133 produces a binary zero character, it is replaced by a question mark &-- this is
9134 what Exim does for binary zeros that are actually received in header lines.
9135
9136 .next
9137 &%header%& tries to translate the string as decoded by &%bheader%& to a
9138 standard character set. This is an attempt to produce the same string as would
9139 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9140 returned. Translation is attempted only on operating systems that support the
9141 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9142 a system Makefile or in &_Local/Makefile_&.
9143 .endlist ilist
9144
9145 In a filter file, the target character set for &%header%& can be specified by a
9146 command of the following form:
9147 .code
9148 headers charset "UTF-8"
9149 .endd
9150 This command affects all references to &$h_$& (or &$header_$&) expansions in
9151 subsequently obeyed filter commands. In the absence of this command, the target
9152 character set in a filter is taken from the setting of the &%headers_charset%&
9153 option in the runtime configuration. The value of this option defaults to the
9154 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9155 ISO-8859-1.
9156
9157 Header names follow the syntax of RFC 2822, which states that they may contain
9158 any printing characters except space and colon. Consequently, curly brackets
9159 &'do not'& terminate header names, and should not be used to enclose them as
9160 if they were variables. Attempting to do so causes a syntax error.
9161
9162 Only header lines that are common to all copies of a message are visible to
9163 this mechanism. These are the original header lines that are received with the
9164 message, and any that are added by an ACL statement or by a system
9165 filter. Header lines that are added to a particular copy of a message by a
9166 router or transport are not accessible.
9167
9168 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9169 before the DATA ACL, because the header structure is not set up until the
9170 message is received. Header lines that are added in a RCPT ACL (for example)
9171 are saved until the message's incoming header lines are available, at which
9172 point they are added. When a DATA ACL is running, however, header lines added
9173 by earlier ACLs are visible.
9174
9175 Upper case and lower case letters are synonymous in header names. If the
9176 following character is white space, the terminating colon may be omitted, but
9177 this is not recommended, because you may then forget it when it is needed. When
9178 white space terminates the header name, it is included in the expanded string.
9179 If the message does not contain the given header, the expansion item is
9180 replaced by an empty string. (See the &%def%& condition in section
9181 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9182
9183 If there is more than one header with the same name, they are all concatenated
9184 to form the substitution string, up to a maximum length of 64K. Unless
9185 &%rheader%& is being used, leading and trailing white space is removed from
9186 each header before concatenation, and a completely empty header is ignored. A
9187 newline character is then inserted between non-empty headers, but there is no
9188 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9189 those headers that contain lists of addresses, a comma is also inserted at the
9190 junctions between headers. This does not happen for the &%rheader%& expansion.
9191
9192
9193 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9194 .cindex "expansion" "hmac hashing"
9195 .cindex &%hmac%&
9196 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9197 shared secret and some text into a message authentication code, as specified in
9198 RFC 2104. This differs from &`${md5:secret_text...}`& or
9199 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9200 cryptographic hash, allowing for authentication that is not possible with MD5
9201 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9202 present. For example:
9203 .code
9204 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9205 .endd
9206 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9207 produces:
9208 .code
9209 dd97e3ba5d1a61b5006108f8c8252953
9210 .endd
9211 As an example of how this might be used, you might put in the main part of
9212 an Exim configuration:
9213 .code
9214 SPAMSCAN_SECRET=cohgheeLei2thahw
9215 .endd
9216 In a router or a transport you could then have:
9217 .code
9218 headers_add = \
9219   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9220   ${hmac{md5}{SPAMSCAN_SECRET}\
9221   {${primary_hostname},${message_exim_id},$h_message-id:}}
9222 .endd
9223 Then given a message, you can check where it was scanned by looking at the
9224 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9225 this header line is authentic by recomputing the authentication code from the
9226 host name, message ID and the &'Message-id:'& header line. This can be done
9227 using Exim's &%-be%& option, or by other means, for example by using the
9228 &'hmac_md5_hex()'& function in Perl.
9229
9230
9231 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9232 .cindex "expansion" "conditional"
9233 .cindex "&%if%&, expansion item"
9234 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9235 item; otherwise <&'string2'&> is used. The available conditions are described
9236 in section &<<SECTexpcond>>& below. For example:
9237 .code
9238 ${if eq {$local_part}{postmaster} {yes}{no} }
9239 .endd
9240 The second string need not be present; if it is not and the condition is not
9241 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9242 be present instead of the second string (without any curly brackets). In this
9243 case, the expansion is forced to fail if the condition is not true (see section
9244 &<<SECTforexpfai>>&).
9245
9246 If both strings are omitted, the result is the string &`true`& if the condition
9247 is true, and the empty string if the condition is false. This makes it less
9248 cumbersome to write custom ACL and router conditions. For example, instead of
9249 .code
9250 condition = ${if >{$acl_m4}{3}{true}{false}}
9251 .endd
9252 you can use
9253 .code
9254 condition = ${if >{$acl_m4}{3}}
9255 .endd
9256
9257 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9258 .cindex "expansion" "string truncation"
9259 .cindex "&%length%& expansion item"
9260 The &%length%& item is used to extract the initial portion of a string. Both
9261 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9262 you are using a fixed value for the number, that is, if <&'string1'&> does not
9263 change when expanded, you can use the simpler operator notation that avoids
9264 some of the braces:
9265 .code
9266 ${length_<n>:<string>}
9267 .endd
9268 The result of this item is either the first <&'n'&> characters or the whole
9269 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9270 &%strlen%&, which gives the length of a string.
9271
9272
9273 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9274         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9275 .cindex "expansion" "extracting list elements by number"
9276 .cindex "&%listextract%&" "extract list elements by number"
9277 .cindex "list" "extracting elements by number"
9278 The <&'number'&> argument must consist entirely of decimal digits,
9279 apart from an optional leading minus,
9280 and leading and trailing white space (which is ignored).
9281
9282 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9283 default, but the separator can be changed in the usual way.
9284
9285 The first field of the list is numbered one.
9286 If the number is negative, the fields are
9287 counted from the end of the list, with the rightmost one numbered -1.
9288 The numbered element of the list is extracted and placed in &$value$&,
9289 then <&'string2'&> is expanded as the result.
9290
9291 If the modulus of the
9292 number is zero or greater than the number of fields in the string,
9293 the result is the expansion of <&'string3'&>.
9294
9295 For example:
9296 .code
9297 ${listextract{2}{x:42:99}}
9298 .endd
9299 yields &"42"&, and
9300 .code
9301 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9302 .endd
9303 yields &"result: 99"&.
9304
9305 If {<&'string3'&>} is omitted, an empty string is used for string3.
9306 If {<&'string2'&>} is also omitted, the value that was
9307 extracted is used.
9308 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9309
9310
9311 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9312         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9313 This is the first of one of two different types of lookup item, which are both
9314 described in the next item.
9315
9316 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9317         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9318 .cindex "expansion" "lookup in"
9319 .cindex "file" "lookups"
9320 .cindex "lookup" "in expanded string"
9321 The two forms of lookup item specify data lookups in files and databases, as
9322 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9323 lookups, and the second is used for query-style lookups. The <&'key'&>,
9324 <&'file'&>, and <&'query'&> strings are expanded before use.
9325
9326 If there is any white space in a lookup item which is part of a filter command,
9327 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9328 other place where white space is significant, the lookup item must be enclosed
9329 in double quotes. The use of data lookups in users' filter files may be locked
9330 out by the system administrator.
9331
9332 .vindex "&$value$&"
9333 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9334 During its expansion, the variable &$value$& contains the data returned by the
9335 lookup. Afterwards it reverts to the value it had previously (at the outer
9336 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9337 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9338 string on failure. If <&'string2'&> is provided, it can itself be a nested
9339 lookup, thus providing a mechanism for looking up a default value when the
9340 original lookup fails.
9341
9342 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9343 data for the outer lookup while the parameters of the second lookup are
9344 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9345 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9346 appear, and in this case, if the lookup fails, the entire expansion is forced
9347 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9348 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9349 successful lookup, and nothing in the case of failure.
9350
9351 For single-key lookups, the string &"partial"& is permitted to precede the
9352 search type in order to do partial matching, and * or *@ may follow a search
9353 type to request default lookups if the key does not match (see sections
9354 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9355
9356 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9357 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9358 and non-wild parts of the key during the expansion of the replacement text.
9359 They return to their previous values at the end of the lookup item.
9360
9361 This example looks up the postmaster alias in the conventional alias file:
9362 .code
9363 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9364 .endd
9365 This example uses NIS+ to look up the full name of the user corresponding to
9366 the local part of an address, forcing the expansion to fail if it is not found:
9367 .code
9368 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9369   {$value}fail}
9370 .endd
9371
9372
9373 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9374 .cindex "expansion" "list creation"
9375 .vindex "&$item$&"
9376 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9377 default, but the separator can be changed in the usual way. For each item
9378 in this list, its value is place in &$item$&, and then <&'string2'&> is
9379 expanded and added to the output as an item in a new list. The separator used
9380 for the output list is the same as the one used for the input, but a separator
9381 setting is not included in the output. For example:
9382 .code
9383 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9384 .endd
9385 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9386 value of &$item$& is restored to what it was before. See also the &*filter*&
9387 and &*reduce*& expansion items.
9388
9389 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9390 .cindex "expansion" "numeric hash"
9391 .cindex "hash function" "numeric"
9392 The three strings are expanded; the first two must yield numbers. Call them
9393 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9394 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9395 can use the simpler operator notation that avoids some of the braces:
9396 .code
9397 ${nhash_<n>_<m>:<string>}
9398 .endd
9399 The second number is optional (in both notations). If there is only one number,
9400 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9401 processed by a div/mod hash function that returns two numbers, separated by a
9402 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9403 example,
9404 .code
9405 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9406 .endd
9407 returns the string &"6/33"&.
9408
9409
9410
9411 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9412 .cindex "Perl" "use in expanded string"
9413 .cindex "expansion" "calling Perl from"
9414 This item is available only if Exim has been built to include an embedded Perl
9415 interpreter. The subroutine name and the arguments are first separately
9416 expanded, and then the Perl subroutine is called with those arguments. No
9417 additional arguments need be given; the maximum number permitted, including the
9418 name of the subroutine, is nine.
9419
9420 The return value of the subroutine is inserted into the expanded string, unless
9421 the return value is &%undef%&. In that case, the expansion fails in the same
9422 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9423 Whatever you return is evaluated in a scalar context. For example, if you
9424 return the name of a Perl vector, the return value is the size of the vector,
9425 not its contents.
9426
9427 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9428 with the error message that was passed to &%die%&. More details of the embedded
9429 Perl facility are given in chapter &<<CHAPperl>>&.
9430
9431 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9432 out the use of this expansion item in filter files.
9433
9434
9435 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9436 .cindex "&%prvs%& expansion item"
9437 The first argument is a complete email address and the second is secret
9438 keystring. The third argument, specifying a key number, is optional. If absent,
9439 it defaults to 0. The result of the expansion is a prvs-signed email address,
9440 to be typically used with the &%return_path%& option on an &(smtp)& transport
9441 as part of a bounce address tag validation (BATV) scheme. For more discussion
9442 and an example, see section &<<SECTverifyPRVS>>&.
9443
9444 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9445         {*&<&'string'&>&*}}*&"
9446 .cindex "&%prvscheck%& expansion item"
9447 This expansion item is the complement of the &%prvs%& item. It is used for
9448 checking prvs-signed addresses. If the expansion of the first argument does not
9449 yield a syntactically valid prvs-signed address, the whole item expands to the
9450 empty string. When the first argument does expand to a syntactically valid
9451 prvs-signed address, the second argument is expanded, with the prvs-decoded
9452 version of the address and the key number extracted from the address in the
9453 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9454
9455 These two variables can be used in the expansion of the second argument to
9456 retrieve the secret. The validity of the prvs-signed address is then checked
9457 against the secret. The result is stored in the variable &$prvscheck_result$&,
9458 which is empty for failure or &"1"& for success.
9459
9460 The third argument is optional; if it is missing, it defaults to an empty
9461 string. This argument is now expanded. If the result is an empty string, the
9462 result of the expansion is the decoded version of the address. This is the case
9463 whether or not the signature was valid. Otherwise, the result of the expansion
9464 is the expansion of the third argument.
9465
9466 All three variables can be used in the expansion of the third argument.
9467 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9468 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9469
9470 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9471 .cindex "expansion" "inserting an entire file"
9472 .cindex "file" "inserting into expansion"
9473 .cindex "&%readfile%& expansion item"
9474 The file name and end-of-line string are first expanded separately. The file is
9475 then read, and its contents replace the entire item. All newline characters in
9476 the file are replaced by the end-of-line string if it is present. Otherwise,
9477 newlines are left in the string.
9478 String expansion is not applied to the contents of the file. If you want this,
9479 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9480 the string expansion fails.
9481
9482 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9483 locks out the use of this expansion item in filter files.
9484
9485
9486
9487 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9488         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9489 .cindex "expansion" "inserting from a socket"
9490 .cindex "socket, use of in expansion"
9491 .cindex "&%readsocket%& expansion item"
9492 This item inserts data from a Unix domain or Internet socket into the expanded
9493 string. The minimal way of using it uses just two arguments, as in these
9494 examples:
9495 .code
9496 ${readsocket{/socket/name}{request string}}
9497 ${readsocket{inet:some.host:1234}{request string}}
9498 .endd
9499 For a Unix domain socket, the first substring must be the path to the socket.
9500 For an Internet socket, the first substring must contain &`inet:`& followed by
9501 a host name or IP address, followed by a colon and a port, which can be a
9502 number or the name of a TCP port in &_/etc/services_&. An IP address may
9503 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9504 example:
9505 .code
9506 ${readsocket{inet:[::1]:1234}{request string}}
9507 .endd
9508 Only a single host name may be given, but if looking it up yields more than
9509 one IP address, they are each tried in turn until a connection is made. For
9510 both kinds of socket, Exim makes a connection, writes the request string
9511 (unless it is an empty string) and reads from the socket until an end-of-file
9512 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9513 extend what can be done. Firstly, you can vary the timeout. For example:
9514 .code
9515 ${readsocket{/socket/name}{request string}{3s}}
9516 .endd
9517 A fourth argument allows you to change any newlines that are in the data
9518 that is read, in the same way as for &%readfile%& (see above). This example
9519 turns them into spaces:
9520 .code
9521 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9522 .endd
9523 As with all expansions, the substrings are expanded before the processing
9524 happens. Errors in these sub-expansions cause the expansion to fail. In
9525 addition, the following errors can occur:
9526
9527 .ilist
9528 Failure to create a socket file descriptor;
9529 .next
9530 Failure to connect the socket;
9531 .next
9532 Failure to write the request string;
9533 .next
9534 Timeout on reading from the socket.
9535 .endlist
9536
9537 By default, any of these errors causes the expansion to fail. However, if
9538 you supply a fifth substring, it is expanded and used when any of the above
9539 errors occurs. For example:
9540 .code
9541 ${readsocket{/socket/name}{request string}{3s}{\n}\
9542   {socket failure}}
9543 .endd
9544 You can test for the existence of a Unix domain socket by wrapping this
9545 expansion in &`${if exists`&, but there is a race condition between that test
9546 and the actual opening of the socket, so it is safer to use the fifth argument
9547 if you want to be absolutely sure of avoiding an expansion error for a
9548 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9549
9550 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9551 locks out the use of this expansion item in filter files.
9552
9553
9554 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9555 .cindex "expansion" "reducing a list to a scalar"
9556 .cindex "list" "reducing to a scalar"
9557 .vindex "&$value$&"
9558 .vindex "&$item$&"
9559 This operation reduces a list to a single, scalar string. After expansion,
9560 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9561 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9562 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9563 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9564 them. The result of that expansion is assigned to &$value$& before the next
9565 iteration. When the end of the list is reached, the final value of &$value$& is
9566 added to the expansion output. The &*reduce*& expansion item can be used in a
9567 number of ways. For example, to add up a list of numbers:
9568 .code
9569 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9570 .endd
9571 The result of that expansion would be &`6`&. The maximum of a list of numbers
9572 can be found:
9573 .code
9574 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9575 .endd
9576 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9577 restored to what they were before. See also the &*filter*& and &*map*&
9578 expansion items.
9579
9580 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9581 This item inserts &"raw"& header lines. It is described with the &%header%&
9582 expansion item above.
9583
9584 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9585         {*&<&'string2'&>&*}}*&"
9586 .cindex "expansion" "running a command"
9587 .cindex "&%run%& expansion item"
9588 The command and its arguments are first expanded as one string. The string is
9589 split apart into individual arguments by spaces, and then the command is run
9590 in a separate process, but under the same uid and gid.  As in other command
9591 executions from Exim, a shell is not used by default. If the command requires
9592 a shell, you must explicitly code it.
9593
9594 Since the arguments are split by spaces, when there is a variable expansion
9595 which has an empty result, it will cause the situation that the argument will
9596 simply be omitted when the program is actually executed by Exim. If the
9597 script/program requires a specific number of arguments and the expanded
9598 variable could possibly result in this empty expansion, the variable must be
9599 quoted. This is more difficult if the expanded variable itself could result
9600 in a string containing quotes, because it would interfere with the quotes
9601 around the command arguments. A possible guard against this is to wrap the
9602 variable in the &%sg%& operator to change any quote marks to some other
9603 character.
9604
9605 The standard input for the command exists, but is empty. The standard output
9606 and standard error are set to the same file descriptor.
9607 .cindex "return code" "from &%run%& expansion"
9608 .vindex "&$value$&"
9609 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9610 and replaces the entire item; during this expansion, the standard output/error
9611 from the command is in the variable &$value$&. If the command fails,
9612 <&'string2'&>, if present, is expanded and used. Once again, during the
9613 expansion, the standard output/error from the command is in the variable
9614 &$value$&.
9615
9616 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9617 can be the word &"fail"& (not in braces) to force expansion failure if the
9618 command does not succeed. If both strings are omitted, the result is contents
9619 of the standard output/error on success, and nothing on failure.
9620
9621 .vindex "&$run_in_acl$&"
9622 The standard output/error of the command is put in the variable &$value$&.
9623 In this ACL example, the output of a command is logged for the admin to
9624 troubleshoot:
9625 .code
9626 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9627       log_message  = Output of id: $value
9628 .endd
9629 If the command requires shell idioms, such as the > redirect operator, the
9630 shell must be invoked directly, such as with:
9631 .code
9632 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9633 .endd
9634
9635 .vindex "&$runrc$&"
9636 The return code from the command is put in the variable &$runrc$&, and this
9637 remains set afterwards, so in a filter file you can do things like this:
9638 .code
9639 if "${run{x y z}{}}$runrc" is 1 then ...
9640   elif $runrc is 2 then ...
9641   ...
9642 endif
9643 .endd
9644 If execution of the command fails (for example, the command does not exist),
9645 the return code is 127 &-- the same code that shells use for non-existent
9646 commands.
9647
9648 &*Warning*&: In a router or transport, you cannot assume the order in which
9649 option values are expanded, except for those preconditions whose order of
9650 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9651 by the expansion of one option, and use it in another.
9652
9653 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9654 out the use of this expansion item in filter files.
9655
9656
9657 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9658 .cindex "expansion" "string substitution"
9659 .cindex "&%sg%& expansion item"
9660 This item works like Perl's substitution operator (s) with the global (/g)
9661 option; hence its name. However, unlike the Perl equivalent, Exim does not
9662 modify the subject string; instead it returns the modified string for insertion
9663 into the overall expansion. The item takes three arguments: the subject string,
9664 a regular expression, and a substitution string. For example:
9665 .code
9666 ${sg{abcdefabcdef}{abc}{xyz}}
9667 .endd
9668 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9669 if any $ or \ characters are required in the regular expression or in the
9670 substitution string, they have to be escaped. For example:
9671 .code
9672 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9673 .endd
9674 yields &"defabc"&, and
9675 .code
9676 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9677 .endd
9678 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9679 the regular expression from string expansion.
9680
9681
9682
9683 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9684 .cindex "&%substr%& expansion item"
9685 .cindex "substring extraction"
9686 .cindex "expansion" "substring extraction"
9687 The three strings are expanded; the first two must yield numbers. Call them
9688 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9689 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9690 can use the simpler operator notation that avoids some of the braces:
9691 .code
9692 ${substr_<n>_<m>:<string>}
9693 .endd
9694 The second number is optional (in both notations).
9695 If it is absent in the simpler format, the preceding underscore must also be
9696 omitted.
9697
9698 The &%substr%& item can be used to extract more general substrings than
9699 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9700 length required. For example
9701 .code
9702 ${substr{3}{2}{$local_part}}
9703 .endd
9704 If the starting offset is greater than the string length the result is the
9705 null string; if the length plus starting offset is greater than the string
9706 length, the result is the right-hand part of the string, starting from the
9707 given offset. The first character in the string has offset zero.
9708
9709 The &%substr%& expansion item can take negative offset values to count
9710 from the right-hand end of its operand. The last character is offset -1, the
9711 second-last is offset -2, and so on. Thus, for example,
9712 .code
9713 ${substr{-5}{2}{1234567}}
9714 .endd
9715 yields &"34"&. If the absolute value of a negative offset is greater than the
9716 length of the string, the substring starts at the beginning of the string, and
9717 the length is reduced by the amount of overshoot. Thus, for example,
9718 .code
9719 ${substr{-5}{2}{12}}
9720 .endd
9721 yields an empty string, but
9722 .code
9723 ${substr{-3}{2}{12}}
9724 .endd
9725 yields &"1"&.
9726
9727 When the second number is omitted from &%substr%&, the remainder of the string
9728 is taken if the offset is positive. If it is negative, all characters in the
9729 string preceding the offset point are taken. For example, an offset of -1 and
9730 no length, as in these semantically identical examples:
9731 .code
9732 ${substr_-1:abcde}
9733 ${substr{-1}{abcde}}
9734 .endd
9735 yields all but the last character of the string, that is, &"abcd"&.
9736
9737
9738
9739 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9740         {*&<&'replacements'&>&*}}*&"
9741 .cindex "expansion" "character translation"
9742 .cindex "&%tr%& expansion item"
9743 This item does single-character translation on its subject string. The second
9744 argument is a list of characters to be translated in the subject string. Each
9745 matching character is replaced by the corresponding character from the
9746 replacement list. For example
9747 .code
9748 ${tr{abcdea}{ac}{13}}
9749 .endd
9750 yields &`1b3de1`&. If there are duplicates in the second character string, the
9751 last occurrence is used. If the third string is shorter than the second, its
9752 last character is replicated. However, if it is empty, no translation takes
9753 place.
9754 .endlist
9755
9756
9757
9758 .section "Expansion operators" "SECTexpop"
9759 .cindex "expansion" "operators"
9760 For expansion items that perform transformations on a single argument string,
9761 the &"operator"& notation is used because it is simpler and uses fewer braces.
9762 The substring is first expanded before the operation is applied to it. The
9763 following operations can be performed:
9764
9765 .vlist
9766 .vitem &*${address:*&<&'string'&>&*}*&
9767 .cindex "expansion" "RFC 2822 address handling"
9768 .cindex "&%address%& expansion item"
9769 The string is interpreted as an RFC 2822 address, as it might appear in a
9770 header line, and the effective address is extracted from it. If the string does
9771 not parse successfully, the result is empty.
9772
9773
9774 .vitem &*${addresses:*&<&'string'&>&*}*&
9775 .cindex "expansion" "RFC 2822 address handling"
9776 .cindex "&%addresses%& expansion item"
9777 The string (after expansion) is interpreted as a list of addresses in RFC
9778 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9779 operative address (&'local-part@domain'&) is extracted from each item, and the
9780 result of the expansion is a colon-separated list, with appropriate
9781 doubling of colons should any happen to be present in the email addresses.
9782 Syntactically invalid RFC2822 address items are omitted from the output.
9783
9784 It is possible to specify a character other than colon for the output
9785 separator by starting the string with > followed by the new separator
9786 character. For example:
9787 .code
9788 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9789 .endd
9790 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9791 expansion item, which extracts the working address from a single RFC2822
9792 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9793 processing lists.
9794
9795 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9796 a strict interpretation of header line formatting.  Exim parses the bare,
9797 unquoted portion of an email address and if it finds a comma, treats it as an
9798 email address seperator. For the example header line:
9799 .code
9800 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9801 .endd
9802 The first example below demonstrates that Q-encoded email addresses are parsed
9803 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9804 It does not see the comma because it's still encoded as "=2C".  The second
9805 example below is passed the contents of &`$header_from:`&, meaning it gets
9806 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9807 The third example shows that the presence of a comma is skipped when it is
9808 quoted.
9809 .code
9810 # exim -be '${addresses:From: \
9811 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9812 user@example.com
9813 # exim -be '${addresses:From: Last, First <user@example.com>}'
9814 Last:user@example.com
9815 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9816 user@example.com
9817 .endd
9818
9819 .vitem &*${base62:*&<&'digits'&>&*}*&
9820 .cindex "&%base62%& expansion item"
9821 .cindex "expansion" "conversion to base 62"
9822 The string must consist entirely of decimal digits. The number is converted to
9823 base 62 and output as a string of six characters, including leading zeros. In
9824 the few operating environments where Exim uses base 36 instead of base 62 for
9825 its message identifiers (because those systems do not have case-sensitive file
9826 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9827 be absolutely clear: this is &'not'& base64 encoding.
9828
9829 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9830 .cindex "&%base62d%& expansion item"
9831 .cindex "expansion" "conversion to base 62"
9832 The string must consist entirely of base-62 digits, or, in operating
9833 environments where Exim uses base 36 instead of base 62 for its message
9834 identifiers, base-36 digits. The number is converted to decimal and output as a
9835 string.
9836
9837
9838 .vitem &*${domain:*&<&'string'&>&*}*&
9839 .cindex "domain" "extraction"
9840 .cindex "expansion" "domain extraction"
9841 The string is interpreted as an RFC 2822 address and the domain is extracted
9842 from it. If the string does not parse successfully, the result is empty.
9843
9844
9845 .vitem &*${escape:*&<&'string'&>&*}*&
9846 .cindex "expansion" "escaping non-printing characters"
9847 .cindex "&%escape%& expansion item"
9848 If the string contains any non-printing characters, they are converted to
9849 escape sequences starting with a backslash. Whether characters with the most
9850 significant bit set (so-called &"8-bit characters"&) count as printing or not
9851 is controlled by the &%print_topbitchars%& option.
9852
9853
9854 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9855 .cindex "expansion" "expression evaluation"
9856 .cindex "expansion" "arithmetic expression"
9857 .cindex "&%eval%& expansion item"
9858 These items supports simple arithmetic and bitwise logical operations in
9859 expansion strings. The string (after expansion) must be a conventional
9860 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9861 logical operators, and parentheses. All operations are carried out using
9862 integer arithmetic. The operator priorities are as follows (the same as in the
9863 C programming language):
9864 .table2 70pt 300pt
9865 .irow &'highest:'& "not (~), negate (-)"
9866 .irow ""   "multiply (*), divide (/), remainder (%)"
9867 .irow ""   "plus (+), minus (-)"
9868 .irow ""   "shift-left (<<), shift-right (>>)"
9869 .irow ""   "and (&&)"
9870 .irow ""   "xor (^)"
9871 .irow &'lowest:'&  "or (|)"
9872 .endtable
9873 Binary operators with the same priority are evaluated from left to right. White
9874 space is permitted before or after operators.
9875
9876 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9877 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9878 decimal, even if they start with a leading zero; hexadecimal numbers are not
9879 permitted. This can be useful when processing numbers extracted from dates or
9880 times, which often do have leading zeros.
9881
9882 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9883 or 1024*1024*1024,
9884 respectively. Negative numbers are supported. The result of the computation is
9885 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9886
9887 .display
9888 &`${eval:1+1}            `&  yields 2
9889 &`${eval:1+2*3}          `&  yields 7
9890 &`${eval:(1+2)*3}        `&  yields 9
9891 &`${eval:2+42%5}         `&  yields 4
9892 &`${eval:0xc&amp;5}          `&  yields 4
9893 &`${eval:0xc|5}          `&  yields 13
9894 &`${eval:0xc^5}          `&  yields 9
9895 &`${eval:0xc>>1}         `&  yields 6
9896 &`${eval:0xc<<1}         `&  yields 24
9897 &`${eval:~255&amp;0x1234}    `&  yields 4608
9898 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9899 .endd
9900
9901 As a more realistic example, in an ACL you might have
9902 .code
9903 deny   message = Too many bad recipients
9904        condition =                    \
9905          ${if and {                   \
9906            {>{$rcpt_count}{10}}       \
9907            {                          \
9908            <                          \
9909              {$recipients_count}      \
9910              {${eval:$rcpt_count/2}}  \
9911            }                          \
9912          }{yes}{no}}
9913 .endd
9914 The condition is true if there have been more than 10 RCPT commands and
9915 fewer than half of them have resulted in a valid recipient.
9916
9917
9918 .vitem &*${expand:*&<&'string'&>&*}*&
9919 .cindex "expansion" "re-expansion of substring"
9920 The &%expand%& operator causes a string to be expanded for a second time. For
9921 example,
9922 .code
9923 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9924 .endd
9925 first looks up a string in a file while expanding the operand for &%expand%&,
9926 and then re-expands what it has found.
9927
9928
9929 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9930 .cindex "Unicode"
9931 .cindex "UTF-8" "conversion from"
9932 .cindex "expansion" "UTF-8 conversion"
9933 .cindex "&%from_utf8%& expansion item"
9934 The world is slowly moving towards Unicode, although there are no standards for
9935 email yet. However, other applications (including some databases) are starting
9936 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9937 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9938 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9939 the result is an undefined sequence of bytes.
9940
9941 Unicode code points with values less than 256 are compatible with ASCII and
9942 ISO-8859-1 (also known as Latin-1).
9943 For example, character 169 is the copyright symbol in both cases, though the
9944 way it is encoded is different. In UTF-8, more than one byte is needed for
9945 characters with code values greater than 127, whereas ISO-8859-1 is a
9946 single-byte encoding (but thereby limited to 256 characters). This makes
9947 translation from UTF-8 to ISO-8859-1 straightforward.
9948
9949
9950 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9951 .cindex "hash function" "textual"
9952 .cindex "expansion" "textual hash"
9953 The &%hash%& operator is a simpler interface to the hashing function that can
9954 be used when the two parameters are fixed numbers (as opposed to strings that
9955 change when expanded). The effect is the same as
9956 .code
9957 ${hash{<n>}{<m>}{<string>}}
9958 .endd
9959 See the description of the general &%hash%& item above for details. The
9960 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9961
9962
9963
9964 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9965 .cindex "base64 encoding" "conversion from hex"
9966 .cindex "expansion" "hex to base64"
9967 .cindex "&%hex2b64%& expansion item"
9968 This operator converts a hex string into one that is base64 encoded. This can
9969 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9970
9971
9972
9973 .vitem &*${hexquote:*&<&'string'&>&*}*&
9974 .cindex "quoting" "hex-encoded unprintable characters"
9975 .cindex "&%hexquote%& expansion item"
9976 This operator converts non-printable characters in a string into a hex
9977 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
9978 as is, and other byte values are converted to &`\xNN`&, for example a
9979 byte value 127 is converted to &`\x7f`&.
9980
9981
9982 .vitem &*${lc:*&<&'string'&>&*}*&
9983 .cindex "case forcing in strings"
9984 .cindex "string" "case forcing"
9985 .cindex "lower casing"
9986 .cindex "expansion" "case forcing"
9987 .cindex "&%lc%& expansion item"
9988 This forces the letters in the string into lower-case, for example:
9989 .code
9990 ${lc:$local_part}
9991 .endd
9992
9993 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9994 .cindex "expansion" "string truncation"
9995 .cindex "&%length%& expansion item"
9996 The &%length%& operator is a simpler interface to the &%length%& function that
9997 can be used when the parameter is a fixed number (as opposed to a string that
9998 changes when expanded). The effect is the same as
9999 .code
10000 ${length{<number>}{<string>}}
10001 .endd
10002 See the description of the general &%length%& item above for details. Note that
10003 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10004 when &%length%& is used as an operator.
10005
10006
10007 .vitem &*${listcount:*&<&'string'&>&*}*&
10008 .cindex "expansion" "list item count"
10009 .cindex "list" "item count"
10010 .cindex "list" "count of items"
10011 .cindex "&%listcount%& expansion item"
10012 The string is interpreted as a list and the number of items is returned.
10013
10014
10015 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10016 .cindex "expansion" "named list"
10017 .cindex "&%listnamed%& expansion item"
10018 The name is interpreted as a named list and the content of the list is returned,
10019 expanding any referenced lists, re-quoting as needed for colon-separation.
10020 If the optional type is given it must be one of "a", "d", "h" or "l"
10021 and selects address-, domain-, host- or localpart- lists to search among respectively.
10022 Otherwise all types are searched in an undefined order and the first
10023 matching list is returned.
10024
10025
10026 .vitem &*${local_part:*&<&'string'&>&*}*&
10027 .cindex "expansion" "local part extraction"
10028 .cindex "&%local_part%& expansion item"
10029 The string is interpreted as an RFC 2822 address and the local part is
10030 extracted from it. If the string does not parse successfully, the result is
10031 empty.
10032
10033
10034 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10035 .cindex "masked IP address"
10036 .cindex "IP address" "masking"
10037 .cindex "CIDR notation"
10038 .cindex "expansion" "IP address masking"
10039 .cindex "&%mask%& expansion item"
10040 If the form of the string to be operated on is not an IP address followed by a
10041 slash and an integer (that is, a network address in CIDR notation), the
10042 expansion fails. Otherwise, this operator converts the IP address to binary,
10043 masks off the least significant bits according to the bit count, and converts
10044 the result back to text, with mask appended. For example,
10045 .code
10046 ${mask:10.111.131.206/28}
10047 .endd
10048 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10049 be mostly used for looking up masked addresses in files, the result for an IPv6
10050 address uses dots to separate components instead of colons, because colon
10051 terminates a key string in lsearch files. So, for example,
10052 .code
10053 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10054 .endd
10055 returns the string
10056 .code
10057 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10058 .endd
10059 Letters in IPv6 addresses are always output in lower case.
10060
10061
10062 .vitem &*${md5:*&<&'string'&>&*}*&
10063 .cindex "MD5 hash"
10064 .cindex "expansion" "MD5 hash"
10065 .cindex "certificate fingerprint"
10066 .cindex "&%md5%& expansion item"
10067 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10068 as a 32-digit hexadecimal number, in which any letters are in lower case.
10069
10070
10071 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10072 .cindex "expansion" "numeric hash"
10073 .cindex "hash function" "numeric"
10074 The &%nhash%& operator is a simpler interface to the numeric hashing function
10075 that can be used when the two parameters are fixed numbers (as opposed to
10076 strings that change when expanded). The effect is the same as
10077 .code
10078 ${nhash{<n>}{<m>}{<string>}}
10079 .endd
10080 See the description of the general &%nhash%& item above for details.
10081
10082
10083 .vitem &*${quote:*&<&'string'&>&*}*&
10084 .cindex "quoting" "in string expansions"
10085 .cindex "expansion" "quoting"
10086 .cindex "&%quote%& expansion item"
10087 The &%quote%& operator puts its argument into double quotes if it
10088 is an empty string or
10089 contains anything other than letters, digits, underscores, dots, and hyphens.
10090 Any occurrences of double quotes and backslashes are escaped with a backslash.
10091 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10092 respectively For example,
10093 .code
10094 ${quote:ab"*"cd}
10095 .endd
10096 becomes
10097 .code
10098 "ab\"*\"cd"
10099 .endd
10100 The place where this is useful is when the argument is a substitution from a
10101 variable or a message header.
10102
10103 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10104 .cindex "&%quote_local_part%& expansion item"
10105 This operator is like &%quote%&, except that it quotes the string only if
10106 required to do so by the rules of RFC 2822 for quoting local parts. For
10107 example, a plus sign would not cause quoting (but it would for &%quote%&).
10108 If you are creating a new email address from the contents of &$local_part$&
10109 (or any other unknown data), you should always use this operator.
10110
10111
10112 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10113 .cindex "quoting" "lookup-specific"
10114 This operator applies lookup-specific quoting rules to the string. Each
10115 query-style lookup type has its own quoting rules which are described with
10116 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10117 .code
10118 ${quote_ldap:two * two}
10119 .endd
10120 returns
10121 .code
10122 two%20%5C2A%20two
10123 .endd
10124 For single-key lookup types, no quoting is ever necessary and this operator
10125 yields an unchanged string.
10126
10127
10128 .vitem &*${randint:*&<&'n'&>&*}*&
10129 .cindex "random number"
10130 This operator returns a somewhat random number which is less than the
10131 supplied number and is at least 0.  The quality of this randomness depends
10132 on how Exim was built; the values are not suitable for keying material.
10133 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10134 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10135 for versions of GnuTLS with that function.
10136 Otherwise, the implementation may be arc4random(), random() seeded by
10137 srandomdev() or srandom(), or a custom implementation even weaker than
10138 random().
10139
10140
10141 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10142 .cindex "expansion" "IP address"
10143 This operator reverses an IP address; for IPv4 addresses, the result is in
10144 dotted-quad decimal form, while for IPv6 addreses the result is in
10145 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10146 for DNS.  For example,
10147 .code
10148 ${reverse_ip:192.0.2.4}
10149 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10150 .endd
10151 returns
10152 .code
10153 4.2.0.192
10154 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
10155 .endd
10156
10157
10158 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10159 .cindex "expansion" "RFC 2047"
10160 .cindex "RFC 2047" "expansion operator"
10161 .cindex "&%rfc2047%& expansion item"
10162 This operator encodes text according to the rules of RFC 2047. This is an
10163 encoding that is used in header lines to encode non-ASCII characters. It is
10164 assumed that the input string is in the encoding specified by the
10165 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10166 contains only characters in the range 33&--126, and no instances of the
10167 characters
10168 .code
10169 ? = ( ) < > @ , ; : \ " . [ ] _
10170 .endd
10171 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10172 string, using as many &"encoded words"& as necessary to encode all the
10173 characters.
10174
10175
10176 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10177 .cindex "expansion" "RFC 2047"
10178 .cindex "RFC 2047" "decoding"
10179 .cindex "&%rfc2047d%& expansion item"
10180 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10181 bytes are replaced by question marks. Characters are converted into the
10182 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10183 not recognized unless &%check_rfc2047_length%& is set false.
10184
10185 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10186 access a header line, RFC 2047 decoding is done automatically. You do not need
10187 to use this operator as well.
10188
10189
10190
10191 .vitem &*${rxquote:*&<&'string'&>&*}*&
10192 .cindex "quoting" "in regular expressions"
10193 .cindex "regular expressions" "quoting"
10194 .cindex "&%rxquote%& expansion item"
10195 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10196 characters in its argument. This is useful when substituting the values of
10197 variables or headers inside regular expressions.
10198
10199
10200 .vitem &*${sha1:*&<&'string'&>&*}*&
10201 .cindex "SHA-1 hash"
10202 .cindex "expansion" "SHA-1 hashing"
10203 .cindex "certificate fingerprint"
10204 .cindex "&%sha2%& expansion item"
10205 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10206 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10207
10208
10209 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10210 .cindex "SHA-256 hash"
10211 .cindex "certificate fingerprint"
10212 .cindex "expansion" "SHA-256 hashing"
10213 .cindex "&%sha256%& expansion item"
10214 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10215 certificate,
10216 and returns
10217 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10218 Only arguments which are a single variable of certificate type are supported.
10219
10220
10221 .vitem &*${stat:*&<&'string'&>&*}*&
10222 .cindex "expansion" "statting a file"
10223 .cindex "file" "extracting characteristics"
10224 .cindex "&%stat%& expansion item"
10225 The string, after expansion, must be a file path. A call to the &[stat()]&
10226 function is made for this path. If &[stat()]& fails, an error occurs and the
10227 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10228 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10229 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10230 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10231 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10232 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10233 can extract individual fields using the &%extract%& expansion item.
10234
10235 The use of the &%stat%& expansion in users' filter files can be locked out by
10236 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10237 systems for files larger than 2GB.
10238
10239 .vitem &*${str2b64:*&<&'string'&>&*}*&
10240 .cindex "expansion" "base64 encoding"
10241 .cindex "base64 encoding" "in string expansion"
10242 .cindex "&%str2b64%& expansion item"
10243 This operator converts a string into one that is base64 encoded.
10244
10245
10246
10247 .vitem &*${strlen:*&<&'string'&>&*}*&
10248 .cindex "expansion" "string length"
10249 .cindex "string" "length in expansion"
10250 .cindex "&%strlen%& expansion item"
10251 The item is replace by the length of the expanded string, expressed as a
10252 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10253
10254
10255 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10256 .cindex "&%substr%& expansion item"
10257 .cindex "substring extraction"
10258 .cindex "expansion" "substring expansion"
10259 The &%substr%& operator is a simpler interface to the &%substr%& function that
10260 can be used when the two parameters are fixed numbers (as opposed to strings
10261 that change when expanded). The effect is the same as
10262 .code
10263 ${substr{<start>}{<length>}{<string>}}
10264 .endd
10265 See the description of the general &%substr%& item above for details. The
10266 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10267
10268 .vitem &*${time_eval:*&<&'string'&>&*}*&
10269 .cindex "&%time_eval%& expansion item"
10270 .cindex "time interval" "decoding"
10271 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10272 seconds.
10273
10274 .vitem &*${time_interval:*&<&'string'&>&*}*&
10275 .cindex "&%time_interval%& expansion item"
10276 .cindex "time interval" "formatting"
10277 The argument (after sub-expansion) must be a sequence of decimal digits that
10278 represents an interval of time as a number of seconds. It is converted into a
10279 number of larger units and output in Exim's normal time format, for example,
10280 &`1w3d4h2m6s`&.
10281
10282 .vitem &*${uc:*&<&'string'&>&*}*&
10283 .cindex "case forcing in strings"
10284 .cindex "string" "case forcing"
10285 .cindex "upper casing"
10286 .cindex "expansion" "case forcing"
10287 .cindex "&%uc%& expansion item"
10288 This forces the letters in the string into upper-case.
10289
10290 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10291 .cindex "correction of invalid utf-8 sequences in strings"
10292 .cindex "utf-8" "utf-8 sequences"
10293 .cindex "incorrect utf-8"
10294 .cindex "expansion" "utf-8 forcing"
10295 .cindex "&%utf8clean%& expansion item"
10296 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10297 .endlist
10298
10299
10300
10301
10302
10303
10304 .section "Expansion conditions" "SECTexpcond"
10305 .scindex IIDexpcond "expansion" "conditions"
10306 The following conditions are available for testing by the &%${if%& construct
10307 while expanding strings:
10308
10309 .vlist
10310 .vitem &*!*&<&'condition'&>
10311 .cindex "expansion" "negating a condition"
10312 .cindex "negation" "in expansion condition"
10313 Preceding any condition with an exclamation mark negates the result of the
10314 condition.
10315
10316 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10317 .cindex "numeric comparison"
10318 .cindex "expansion" "numeric comparison"
10319 There are a number of symbolic operators for doing numeric comparisons. They
10320 are:
10321 .display
10322 &`=   `&   equal
10323 &`==  `&   equal
10324 &`>   `&   greater
10325 &`>=  `&   greater or equal
10326 &`<   `&   less
10327 &`<=  `&   less or equal
10328 .endd
10329 For example:
10330 .code
10331 ${if >{$message_size}{10M} ...
10332 .endd
10333 Note that the general negation operator provides for inequality testing. The
10334 two strings must take the form of optionally signed decimal integers,
10335 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10336 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10337 As a special case, the numerical value of an empty string is taken as
10338 zero.
10339
10340 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10341 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10342 10M, not if 10M is larger than &$message_size$&.
10343
10344
10345 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10346         {*&<&'arg2'&>&*}...}*&
10347 .cindex "expansion" "calling an acl"
10348 .cindex "&%acl%&" "expansion condition"
10349 The name and zero to nine argument strings are first expanded separately.  The expanded
10350 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10351 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10352 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10353 and may use the variables; if another acl expansion is used the values
10354 are restored after it returns.  If the ACL sets
10355 a value using a "message =" modifier the variable $value becomes
10356 the result of the expansion, otherwise it is empty.
10357 If the ACL returns accept the condition is true; if deny, false.
10358 If the ACL returns defer the result is a forced-fail.
10359
10360 .vitem &*bool&~{*&<&'string'&>&*}*&
10361 .cindex "expansion" "boolean parsing"
10362 .cindex "&%bool%& expansion condition"
10363 This condition turns a string holding a true or false representation into
10364 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10365 (case-insensitively); also integer numbers map to true if non-zero,
10366 false if zero.
10367 An empty string is treated as false.
10368 Leading and trailing whitespace is ignored;
10369 thus a string consisting only of whitespace is false.
10370 All other string values will result in expansion failure.
10371
10372 When combined with ACL variables, this expansion condition will let you
10373 make decisions in one place and act on those decisions in another place.
10374 For example:
10375 .code
10376 ${if bool{$acl_m_privileged_sender} ...
10377 .endd
10378
10379
10380 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10381 .cindex "expansion" "boolean parsing"
10382 .cindex "&%bool_lax%& expansion condition"
10383 Like &%bool%&, this condition turns a string into a boolean state.  But
10384 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10385 loose definition that the Router &%condition%& option uses.  The empty string
10386 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10387 true.  Leading and trailing whitespace is ignored.
10388
10389 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10390
10391 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10392 .cindex "expansion" "encrypted comparison"
10393 .cindex "encrypted strings, comparing"
10394 .cindex "&%crypteq%& expansion condition"
10395 This condition is included in the Exim binary if it is built to support any
10396 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10397 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10398 included in the binary.
10399
10400 The &%crypteq%& condition has two arguments. The first is encrypted and
10401 compared against the second, which is already encrypted. The second string may
10402 be in the LDAP form for storing encrypted strings, which starts with the
10403 encryption type in curly brackets, followed by the data. If the second string
10404 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10405 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10406 Typically this will be a field from a password file. An example of an encrypted
10407 string in LDAP form is:
10408 .code
10409 {md5}CY9rzUYh03PK3k6DJie09g==
10410 .endd
10411 If such a string appears directly in an expansion, the curly brackets have to
10412 be quoted, because they are part of the expansion syntax. For example:
10413 .code
10414 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10415 .endd
10416 The following encryption types (whose names are matched case-independently) are
10417 supported:
10418
10419 .ilist
10420 .cindex "MD5 hash"
10421 .cindex "base64 encoding" "in encrypted password"
10422 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10423 printable characters to compare with the remainder of the second string. If the
10424 length of the comparison string is 24, Exim assumes that it is base64 encoded
10425 (as in the above example). If the length is 32, Exim assumes that it is a
10426 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10427 comparison fails.
10428
10429 .next
10430 .cindex "SHA-1 hash"
10431 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10432 printable characters to compare with the remainder of the second string. If the
10433 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10434 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10435 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10436
10437 .next
10438 .cindex "&[crypt()]&"
10439 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10440 only the first eight characters of the password. However, in modern operating
10441 systems this is no longer true, and in many cases the entire password is used,
10442 whatever its length.
10443
10444 .next
10445 .cindex "&[crypt16()]&"
10446 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10447 use up to 16 characters of the password in some operating systems. Again, in
10448 modern operating systems, more characters may be used.
10449 .endlist
10450 Exim has its own version of &[crypt16()]&, which is just a double call to
10451 &[crypt()]&. For operating systems that have their own version, setting
10452 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10453 operating system version instead of its own. This option is set by default in
10454 the OS-dependent &_Makefile_& for those operating systems that are known to
10455 support &[crypt16()]&.
10456
10457 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10458 it was not using the same algorithm as some operating systems' versions. It
10459 turns out that as well as &[crypt16()]& there is a function called
10460 &[bigcrypt()]& in some operating systems. This may or may not use the same
10461 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10462
10463 However, since there is now a move away from the traditional &[crypt()]&
10464 functions towards using SHA1 and other algorithms, tidying up this area of
10465 Exim is seen as very low priority.
10466
10467 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10468 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10469 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10470 default is &`{crypt}`&. Whatever the default, you can always use either
10471 function by specifying it explicitly in curly brackets.
10472
10473 .vitem &*def:*&<&'variable&~name'&>
10474 .cindex "expansion" "checking for empty variable"
10475 .cindex "&%def%& expansion condition"
10476 The &%def%& condition must be followed by the name of one of the expansion
10477 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10478 variable does not contain the empty string. For example:
10479 .code
10480 ${if def:sender_ident {from $sender_ident}}
10481 .endd
10482 Note that the variable name is given without a leading &%$%& character. If the
10483 variable does not exist, the expansion fails.
10484
10485 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10486         &~&*def:h_*&<&'header&~name'&>&*:*&"
10487 .cindex "expansion" "checking header line existence"
10488 This condition is true if a message is being processed and the named header
10489 exists in the message. For example,
10490 .code
10491 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10492 .endd
10493 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10494 the header name must be terminated by a colon if white space does not follow.
10495
10496 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10497        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10498 .cindex "string" "comparison"
10499 .cindex "expansion" "string comparison"
10500 .cindex "&%eq%& expansion condition"
10501 .cindex "&%eqi%& expansion condition"
10502 The two substrings are first expanded. The condition is true if the two
10503 resulting strings are identical. For &%eq%& the comparison includes the case of
10504 letters, whereas for &%eqi%& the comparison is case-independent.
10505
10506 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10507 .cindex "expansion" "file existence test"
10508 .cindex "file" "existence test"
10509 .cindex "&%exists%&, expansion condition"
10510 The substring is first expanded and then interpreted as an absolute path. The
10511 condition is true if the named file (or directory) exists. The existence test
10512 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10513 users' filter files may be locked out by the system administrator.
10514
10515 .vitem &*first_delivery*&
10516 .cindex "delivery" "first"
10517 .cindex "first delivery"
10518 .cindex "expansion" "first delivery test"
10519 .cindex "&%first_delivery%& expansion condition"
10520 This condition, which has no data, is true during a message's first delivery
10521 attempt. It is false during any subsequent delivery attempts.
10522
10523
10524 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10525        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10526 .cindex "list" "iterative conditions"
10527 .cindex "expansion" "&*forall*& condition"
10528 .cindex "expansion" "&*forany*& condition"
10529 .vindex "&$item$&"
10530 These conditions iterate over a list. The first argument is expanded to form
10531 the list. By default, the list separator is a colon, but it can be changed by
10532 the normal method. The second argument is interpreted as a condition that is to
10533 be applied to each item in the list in turn. During the interpretation of the
10534 condition, the current list item is placed in a variable called &$item$&.
10535 .ilist
10536 For &*forany*&, interpretation stops if the condition is true for any item, and
10537 the result of the whole condition is true. If the condition is false for all
10538 items in the list, the overall condition is false.
10539 .next
10540 For &*forall*&, interpretation stops if the condition is false for any item,
10541 and the result of the whole condition is false. If the condition is true for
10542 all items in the list, the overall condition is true.
10543 .endlist
10544 Note that negation of &*forany*& means that the condition must be false for all
10545 items for the overall condition to succeed, and negation of &*forall*& means
10546 that the condition must be false for at least one item. In this example, the
10547 list separator is changed to a comma:
10548 .code
10549 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10550 .endd
10551 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10552 being processed, to enable these expansion items to be nested.
10553
10554 To scan a named list, expand it with the &*listnamed*& operator.
10555
10556
10557 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10558        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10559 .cindex "string" "comparison"
10560 .cindex "expansion" "string comparison"
10561 .cindex "&%ge%& expansion condition"
10562 .cindex "&%gei%& expansion condition"
10563 The two substrings are first expanded. The condition is true if the first
10564 string is lexically greater than or equal to the second string. For &%ge%& the
10565 comparison includes the case of letters, whereas for &%gei%& the comparison is
10566 case-independent.
10567
10568 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10569        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10570 .cindex "string" "comparison"
10571 .cindex "expansion" "string comparison"
10572 .cindex "&%gt%& expansion condition"
10573 .cindex "&%gti%& expansion condition"
10574 The two substrings are first expanded. The condition is true if the first
10575 string is lexically greater than the second string. For &%gt%& the comparison
10576 includes the case of letters, whereas for &%gti%& the comparison is
10577 case-independent.
10578
10579 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10580        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10581 .cindex "string" "comparison"
10582 .cindex "list" "iterative conditions"
10583 Both strings are expanded; the second string is treated as a list of simple
10584 strings; if the first string is a member of the second, then the condition
10585 is true.
10586
10587 These are simpler to use versions of the more powerful &*forany*& condition.
10588 Examples, and the &*forany*& equivalents:
10589 .code
10590 ${if inlist{needle}{foo:needle:bar}}
10591   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10592 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10593   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10594 .endd
10595
10596 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10597        &*isip4&~{*&<&'string'&>&*}*& &&&
10598        &*isip6&~{*&<&'string'&>&*}*&
10599 .cindex "IP address" "testing string format"
10600 .cindex "string" "testing for IP address"
10601 .cindex "&%isip%& expansion condition"
10602 .cindex "&%isip4%& expansion condition"
10603 .cindex "&%isip6%& expansion condition"
10604 The substring is first expanded, and then tested to see if it has the form of
10605 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10606 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10607
10608 For an IPv4 address, the test is for four dot-separated components, each of
10609 which consists of from one to three digits. For an IPv6 address, up to eight
10610 colon-separated components are permitted, each containing from one to four
10611 hexadecimal digits. There may be fewer than eight components if an empty
10612 component (adjacent colons) is present. Only one empty component is permitted.
10613
10614 &*Note*&: The checks are just on the form of the address; actual numerical
10615 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10616 check. The main use of these tests is to distinguish between IP addresses and
10617 host names, or between IPv4 and IPv6 addresses. For example, you could use
10618 .code
10619 ${if isip4{$sender_host_address}...
10620 .endd
10621 to test which IP version an incoming SMTP connection is using.
10622
10623 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10624 .cindex "LDAP" "use for authentication"
10625 .cindex "expansion" "LDAP authentication test"
10626 .cindex "&%ldapauth%& expansion condition"
10627 This condition supports user authentication using LDAP. See section
10628 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10629 queries. For this use, the query must contain a user name and password. The
10630 query itself is not used, and can be empty. The condition is true if the
10631 password is not empty, and the user name and password are accepted by the LDAP
10632 server. An empty password is rejected without calling LDAP because LDAP binds
10633 with an empty password are considered anonymous regardless of the username, and
10634 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10635 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10636 this can be used.
10637
10638
10639 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10640        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10641 .cindex "string" "comparison"
10642 .cindex "expansion" "string comparison"
10643 .cindex "&%le%& expansion condition"
10644 .cindex "&%lei%& expansion condition"
10645 The two substrings are first expanded. The condition is true if the first
10646 string is lexically less than or equal to the second string. For &%le%& the
10647 comparison includes the case of letters, whereas for &%lei%& the comparison is
10648 case-independent.
10649
10650 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10651        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10652 .cindex "string" "comparison"
10653 .cindex "expansion" "string comparison"
10654 .cindex "&%lt%& expansion condition"
10655 .cindex "&%lti%& expansion condition"
10656 The two substrings are first expanded. The condition is true if the first
10657 string is lexically less than the second string. For &%lt%& the comparison
10658 includes the case of letters, whereas for &%lti%& the comparison is
10659 case-independent.
10660
10661
10662 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10663 .cindex "expansion" "regular expression comparison"
10664 .cindex "regular expressions" "match in expanded string"
10665 .cindex "&%match%& expansion condition"
10666 The two substrings are first expanded. The second is then treated as a regular
10667 expression and applied to the first. Because of the pre-expansion, if the
10668 regular expression contains dollar, or backslash characters, they must be
10669 escaped. Care must also be taken if the regular expression contains braces
10670 (curly brackets). A closing brace must be escaped so that it is not taken as a
10671 premature termination of <&'string2'&>. The easiest approach is to use the
10672 &`\N`& feature to disable expansion of the regular expression.
10673 For example,
10674 .code
10675 ${if match {$local_part}{\N^\d{3}\N} ...
10676 .endd
10677 If the whole expansion string is in double quotes, further escaping of
10678 backslashes is also required.
10679
10680 The condition is true if the regular expression match succeeds.
10681 The regular expression is not required to begin with a circumflex
10682 metacharacter, but if there is no circumflex, the expression is not anchored,
10683 and it may match anywhere in the subject, not just at the start. If you want
10684 the pattern to match at the end of the subject, you must include the &`$`&
10685 metacharacter at an appropriate point.
10686
10687 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10688 At the start of an &%if%& expansion the values of the numeric variable
10689 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10690 succeeds causes them to be reset to the substrings of that condition and they
10691 will have these values during the expansion of the success string. At the end
10692 of the &%if%& expansion, the previous values are restored. After testing a
10693 combination of conditions using &%or%&, the subsequent values of the numeric
10694 variables are those of the condition that succeeded.
10695
10696 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10697 .cindex "&%match_address%& expansion condition"
10698 See &*match_local_part*&.
10699
10700 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10701 .cindex "&%match_domain%& expansion condition"
10702 See &*match_local_part*&.
10703
10704 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10705 .cindex "&%match_ip%& expansion condition"
10706 This condition matches an IP address to a list of IP address patterns. It must
10707 be followed by two argument strings. The first (after expansion) must be an IP
10708 address or an empty string. The second (not expanded) is a restricted host
10709 list that can match only an IP address, not a host name. For example:
10710 .code
10711 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10712 .endd
10713 The specific types of host list item that are permitted in the list are:
10714
10715 .ilist
10716 An IP address, optionally with a CIDR mask.
10717 .next
10718 A single asterisk, which matches any IP address.
10719 .next
10720 An empty item, which matches only if the IP address is empty. This could be
10721 useful for testing for a locally submitted message or one from specific hosts
10722 in a single test such as
10723 . ==== As this is a nested list, any displays it contains must be indented
10724 . ==== as otherwise they are too far to the left. This comment applies to
10725 . ==== the use of xmlto plus fop. There's no problem when formatting with
10726 . ==== sdop, with or without the extra indent.
10727 .code
10728   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10729 .endd
10730 where the first item in the list is the empty string.
10731 .next
10732 The item @[] matches any of the local host's interface addresses.
10733 .next
10734 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10735 even if &`net-`& is not specified. There is never any attempt to turn the IP
10736 address into a host name. The most common type of linear search for
10737 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10738 masks. For example:
10739 .code
10740   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10741 .endd
10742 It is of course possible to use other kinds of lookup, and in such a case, you
10743 do need to specify the &`net-`& prefix if you want to specify a specific
10744 address mask, for example:
10745 .code
10746   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10747 .endd
10748 However, unless you are combining a &%match_ip%& condition with others, it is
10749 just as easy to use the fact that a lookup is itself a condition, and write:
10750 .code
10751   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10752 .endd
10753 .endlist ilist
10754
10755 Note that <&'string2'&> is not itself subject to string expansion, unless
10756 Exim was built with the EXPAND_LISTMATCH_RHS option.
10757
10758 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10759
10760 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10761 .cindex "domain list" "in expansion condition"
10762 .cindex "address list" "in expansion condition"
10763 .cindex "local part" "list, in expansion condition"
10764 .cindex "&%match_local_part%& expansion condition"
10765 This condition, together with &%match_address%& and &%match_domain%&, make it
10766 possible to test domain, address, and local part lists within expansions. Each
10767 condition requires two arguments: an item and a list to match. A trivial
10768 example is:
10769 .code
10770 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10771 .endd
10772 In each case, the second argument may contain any of the allowable items for a
10773 list of the appropriate type. Also, because the second argument (after
10774 expansion) is a standard form of list, it is possible to refer to a named list.
10775 Thus, you can use conditions like this:
10776 .code
10777 ${if match_domain{$domain}{+local_domains}{...
10778 .endd
10779 .cindex "&`+caseful`&"
10780 For address lists, the matching starts off caselessly, but the &`+caseful`&
10781 item can be used, as in all address lists, to cause subsequent items to
10782 have their local parts matched casefully. Domains are always matched
10783 caselessly.
10784
10785 Note that <&'string2'&> is not itself subject to string expansion, unless
10786 Exim was built with the EXPAND_LISTMATCH_RHS option.
10787
10788 &*Note*&: Host lists are &'not'& supported in this way. This is because
10789 hosts have two identities: a name and an IP address, and it is not clear
10790 how to specify cleanly how such a test would work. However, IP addresses can be
10791 matched using &%match_ip%&.
10792
10793 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10794 .cindex "PAM authentication"
10795 .cindex "AUTH" "with PAM"
10796 .cindex "Solaris" "PAM support"
10797 .cindex "expansion" "PAM authentication test"
10798 .cindex "&%pam%& expansion condition"
10799 &'Pluggable Authentication Modules'&
10800 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10801 available in the latest releases of Solaris and in some GNU/Linux
10802 distributions. The Exim support, which is intended for use in conjunction with
10803 the SMTP AUTH command, is available only if Exim is compiled with
10804 .code
10805 SUPPORT_PAM=yes
10806 .endd
10807 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10808 in some releases of GNU/Linux &%-ldl%& is also needed.
10809
10810 The argument string is first expanded, and the result must be a
10811 colon-separated list of strings. Leading and trailing white space is ignored.
10812 The PAM module is initialized with the service name &"exim"& and the user name
10813 taken from the first item in the colon-separated data string (<&'string1'&>).
10814 The remaining items in the data string are passed over in response to requests
10815 from the authentication function. In the simple case there will only be one
10816 request, for a password, so the data consists of just two strings.
10817
10818 There can be problems if any of the strings are permitted to contain colon
10819 characters. In the usual way, these have to be doubled to avoid being taken as
10820 separators. If the data is being inserted from a variable, the &%sg%& expansion
10821 item can be used to double any existing colons. For example, the configuration
10822 of a LOGIN authenticator might contain this setting:
10823 .code
10824 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10825 .endd
10826 For a PLAIN authenticator you could use:
10827 .code
10828 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10829 .endd
10830 In some operating systems, PAM authentication can be done only from a process
10831 running as root. Since Exim is running as the Exim user when receiving
10832 messages, this means that PAM cannot be used directly in those systems.
10833 A patched version of the &'pam_unix'& module that comes with the
10834 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10835 The patched module allows one special uid/gid combination, in addition to root,
10836 to authenticate. If you build the patched module to allow the Exim user and
10837 group, PAM can then be used from an Exim authenticator.
10838
10839
10840 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10841 .cindex "&'pwcheck'& daemon"
10842 .cindex "Cyrus"
10843 .cindex "expansion" "&'pwcheck'& authentication test"
10844 .cindex "&%pwcheck%& expansion condition"
10845 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10846 This is one way of making it possible for passwords to be checked by a process
10847 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10848 deprecated. Its replacement is &'saslauthd'& (see below).
10849
10850 The pwcheck support is not included in Exim by default. You need to specify
10851 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10852 building Exim. For example:
10853 .code
10854 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10855 .endd
10856 You do not need to install the full Cyrus software suite in order to use
10857 the pwcheck daemon. You can compile and install just the daemon alone
10858 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10859 access to the &_/var/pwcheck_& directory.
10860
10861 The &%pwcheck%& condition takes one argument, which must be the user name and
10862 password, separated by a colon. For example, in a LOGIN authenticator
10863 configuration, you might have this:
10864 .code
10865 server_condition = ${if pwcheck{$auth1:$auth2}}
10866 .endd
10867 Again, for a PLAIN authenticator configuration, this would be:
10868 .code
10869 server_condition = ${if pwcheck{$auth2:$auth3}}
10870 .endd
10871 .vitem &*queue_running*&
10872 .cindex "queue runner" "detecting when delivering from"
10873 .cindex "expansion" "queue runner test"
10874 .cindex "&%queue_running%& expansion condition"
10875 This condition, which has no data, is true during delivery attempts that are
10876 initiated by queue runner processes, and false otherwise.
10877
10878
10879 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10880 .cindex "Radius"
10881 .cindex "expansion" "Radius authentication"
10882 .cindex "&%radius%& expansion condition"
10883 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10884 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10885 the Radius client configuration file in order to build Exim with Radius
10886 support.
10887
10888 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10889 library, using the original API. If you are using release 0.4.0 or later of
10890 this library, you need to set
10891 .code
10892 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10893 .endd
10894 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10895 &%libradius%& library that comes with FreeBSD. To do this, set
10896 .code
10897 RADIUS_LIB_TYPE=RADLIB
10898 .endd
10899 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10900 You may also have to supply a suitable setting in EXTRALIBS so that the
10901 Radius library can be found when Exim is linked.
10902
10903 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10904 Radius client library, which calls the Radius server. The condition is true if
10905 the authentication is successful. For example:
10906 .code
10907 server_condition = ${if radius{<arguments>}}
10908 .endd
10909
10910
10911 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10912         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10913 .cindex "&'saslauthd'& daemon"
10914 .cindex "Cyrus"
10915 .cindex "expansion" "&'saslauthd'& authentication test"
10916 .cindex "&%saslauthd%& expansion condition"
10917 This condition supports user authentication using the Cyrus &'saslauthd'&
10918 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10919 Using this daemon is one way of making it possible for passwords to be checked
10920 by a process that is not running as root.
10921
10922 The saslauthd support is not included in Exim by default. You need to specify
10923 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10924 building Exim. For example:
10925 .code
10926 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10927 .endd
10928 You do not need to install the full Cyrus software suite in order to use
10929 the saslauthd daemon. You can compile and install just the daemon alone
10930 from the Cyrus SASL library.
10931
10932 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10933 two are mandatory. For example:
10934 .code
10935 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10936 .endd
10937 The service and the realm are optional (which is why the arguments are enclosed
10938 in their own set of braces). For details of the meaning of the service and
10939 realm, and how to run the daemon, consult the Cyrus documentation.
10940 .endlist vlist
10941
10942
10943
10944 .section "Combining expansion conditions" "SECID84"
10945 .cindex "expansion" "combining conditions"
10946 Several conditions can be tested at once by combining them using the &%and%&
10947 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10948 conditions on their own, and precede their lists of sub-conditions. Each
10949 sub-condition must be enclosed in braces within the overall braces that contain
10950 the list. No repetition of &%if%& is used.
10951
10952
10953 .vlist
10954 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10955 .cindex "&""or""& expansion condition"
10956 .cindex "expansion" "&""or""& of conditions"
10957 The sub-conditions are evaluated from left to right. The condition is true if
10958 any one of the sub-conditions is true.
10959 For example,
10960 .code
10961 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10962 .endd
10963 When a true sub-condition is found, the following ones are parsed but not
10964 evaluated. If there are several &"match"& sub-conditions the values of the
10965 numeric variables afterwards are taken from the first one that succeeds.
10966
10967 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10968 .cindex "&""and""& expansion condition"
10969 .cindex "expansion" "&""and""& of conditions"
10970 The sub-conditions are evaluated from left to right. The condition is true if
10971 all of the sub-conditions are true. If there are several &"match"&
10972 sub-conditions, the values of the numeric variables afterwards are taken from
10973 the last one. When a false sub-condition is found, the following ones are
10974 parsed but not evaluated.
10975 .endlist
10976 .ecindex IIDexpcond
10977
10978
10979
10980
10981 .section "Expansion variables" "SECTexpvar"
10982 .cindex "expansion" "variables, list of"
10983 This section contains an alphabetical list of all the expansion variables. Some
10984 of them are available only when Exim is compiled with specific options such as
10985 support for TLS or the content scanning extension.
10986
10987 .vlist
10988 .vitem "&$0$&, &$1$&, etc"
10989 .cindex "numerical variables (&$1$& &$2$& etc)"
10990 When a &%match%& expansion condition succeeds, these variables contain the
10991 captured substrings identified by the regular expression during subsequent
10992 processing of the success string of the containing &%if%& expansion item.
10993 However, they do not retain their values afterwards; in fact, their previous
10994 values are restored at the end of processing an &%if%& item. The numerical
10995 variables may also be set externally by some other matching process which
10996 precedes the expansion of the string. For example, the commands available in
10997 Exim filter files include an &%if%& command with its own regular expression
10998 matching condition.
10999
11000 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11001 Within an acl condition, expansion condition or expansion item
11002 any arguments are copied to these variables,
11003 any unused variables being made empty.
11004
11005 .vitem "&$acl_c...$&"
11006 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11007 can be given any name that starts with &$acl_c$& and is at least six characters
11008 long, but the sixth character must be either a digit or an underscore. For
11009 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11010 variables persist throughout the lifetime of an SMTP connection. They can be
11011 used to pass information between ACLs and between different invocations of the
11012 same ACL. When a message is received, the values of these variables are saved
11013 with the message, and can be accessed by filters, routers, and transports
11014 during subsequent delivery.
11015
11016 .vitem "&$acl_m...$&"
11017 These variables are like the &$acl_c...$& variables, except that their values
11018 are reset after a message has been received. Thus, if several messages are
11019 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11020 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11021 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11022 message is received, the values of these variables are saved with the message,
11023 and can be accessed by filters, routers, and transports during subsequent
11024 delivery.
11025
11026 .vitem &$acl_narg$&
11027 Within an acl condition, expansion condition or expansion item
11028 this variable has the number of arguments.
11029
11030 .vitem &$acl_verify_message$&
11031 .vindex "&$acl_verify_message$&"
11032 After an address verification has failed, this variable contains the failure
11033 message. It retains its value for use in subsequent modifiers. The message can
11034 be preserved by coding like this:
11035 .code
11036 warn !verify = sender
11037      set acl_m0 = $acl_verify_message
11038 .endd
11039 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11040 &%log_message%& modifiers, to include information about the verification
11041 failure.
11042
11043 .vitem &$address_data$&
11044 .vindex "&$address_data$&"
11045 This variable is set by means of the &%address_data%& option in routers. The
11046 value then remains with the address while it is processed by subsequent routers
11047 and eventually a transport. If the transport is handling multiple addresses,
11048 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11049 for more details. &*Note*&: The contents of &$address_data$& are visible in
11050 user filter files.
11051
11052 If &$address_data$& is set when the routers are called from an ACL to verify
11053 a recipient address, the final value is still in the variable for subsequent
11054 conditions and modifiers of the ACL statement. If routing the address caused it
11055 to be redirected to just one address, the child address is also routed as part
11056 of the verification, and in this case the final value of &$address_data$& is
11057 from the child's routing.
11058
11059 If &$address_data$& is set when the routers are called from an ACL to verify a
11060 sender address, the final value is also preserved, but this time in
11061 &$sender_address_data$&, to distinguish it from data from a recipient
11062 address.
11063
11064 In both cases (recipient and sender verification), the value does not persist
11065 after the end of the current ACL statement. If you want to preserve
11066 these values for longer, you can save them in ACL variables.
11067
11068 .vitem &$address_file$&
11069 .vindex "&$address_file$&"
11070 When, as a result of aliasing, forwarding, or filtering, a message is directed
11071 to a specific file, this variable holds the name of the file when the transport
11072 is running. At other times, the variable is empty. For example, using the
11073 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11074 .code
11075 /home/r2d2/savemail
11076 .endd
11077 then when the &(address_file)& transport is running, &$address_file$&
11078 contains the text string &`/home/r2d2/savemail`&.
11079 .cindex "Sieve filter" "value of &$address_file$&"
11080 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11081 then up to the transport configuration to generate an appropriate absolute path
11082 to the relevant file.
11083
11084 .vitem &$address_pipe$&
11085 .vindex "&$address_pipe$&"
11086 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11087 this variable holds the pipe command when the transport is running.
11088
11089 .vitem "&$auth1$& &-- &$auth3$&"
11090 .vindex "&$auth1$&, &$auth2$&, etc"
11091 These variables are used in SMTP authenticators (see chapters
11092 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11093
11094 .vitem &$authenticated_id$&
11095 .cindex "authentication" "id"
11096 .vindex "&$authenticated_id$&"
11097 When a server successfully authenticates a client it may be configured to
11098 preserve some of the authentication information in the variable
11099 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11100 user/password authenticator configuration might preserve the user name for use
11101 in the routers. Note that this is not the same information that is saved in
11102 &$sender_host_authenticated$&.
11103 When a message is submitted locally (that is, not over a TCP connection)
11104 the value of &$authenticated_id$& is normally the login name of the calling
11105 process. However, a trusted user can override this by means of the &%-oMai%&
11106 command line option.
11107
11108 .vitem &$authenticated_fail_id$&
11109 .cindex "authentication" "fail" "id"
11110 .vindex "&$authenticated_fail_id$&"
11111 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11112 will contain the failed authentication id. If more than one authentication
11113 id is attempted, it will contain only the last one. The variable is
11114 available for processing in the ACL's, generally the quit or notquit ACL.
11115 A message to a local recipient could still be accepted without requiring
11116 authentication, which means this variable could also be visible in all of
11117 the ACL's as well.
11118
11119
11120 .vitem &$authenticated_sender$&
11121 .cindex "sender" "authenticated"
11122 .cindex "authentication" "sender"
11123 .cindex "AUTH" "on MAIL command"
11124 .vindex "&$authenticated_sender$&"
11125 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11126 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11127 described in section &<<SECTauthparamail>>&. Unless the data is the string
11128 &"<>"&, it is set as the authenticated sender of the message, and the value is
11129 available during delivery in the &$authenticated_sender$& variable. If the
11130 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11131
11132 .vindex "&$qualify_domain$&"
11133 When a message is submitted locally (that is, not over a TCP connection), the
11134 value of &$authenticated_sender$& is an address constructed from the login
11135 name of the calling process and &$qualify_domain$&, except that a trusted user
11136 can override this by means of the &%-oMas%& command line option.
11137
11138
11139 .vitem &$authentication_failed$&
11140 .cindex "authentication" "failure"
11141 .vindex "&$authentication_failed$&"
11142 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11143 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11144 possible to distinguish between &"did not try to authenticate"&
11145 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11146 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11147 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11148 negative response to an AUTH command, including (for example) an attempt to use
11149 an undefined mechanism.
11150
11151 .vitem &$av_failed$&
11152 .cindex "content scanning" "AV scanner failure"
11153 This variable is available when Exim is compiled with the content-scanning
11154 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11155 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11156 the ACL malware condition.
11157
11158 .vitem &$body_linecount$&
11159 .cindex "message body" "line count"
11160 .cindex "body of message" "line count"
11161 .vindex "&$body_linecount$&"
11162 When a message is being received or delivered, this variable contains the
11163 number of lines in the message's body. See also &$message_linecount$&.
11164
11165 .vitem &$body_zerocount$&
11166 .cindex "message body" "binary zero count"
11167 .cindex "body of message" "binary zero count"
11168 .cindex "binary zero" "in message body"
11169 .vindex "&$body_zerocount$&"
11170 When a message is being received or delivered, this variable contains the
11171 number of binary zero bytes (ASCII NULs) in the message's body.
11172
11173 .vitem &$bounce_recipient$&
11174 .vindex "&$bounce_recipient$&"
11175 This is set to the recipient address of a bounce message while Exim is creating
11176 it. It is useful if a customized bounce message text file is in use (see
11177 chapter &<<CHAPemsgcust>>&).
11178
11179 .vitem &$bounce_return_size_limit$&
11180 .vindex "&$bounce_return_size_limit$&"
11181 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11182 up to a multiple of 1000. It is useful when a customized error message text
11183 file is in use (see chapter &<<CHAPemsgcust>>&).
11184
11185 .vitem &$caller_gid$&
11186 .cindex "gid (group id)" "caller"
11187 .vindex "&$caller_gid$&"
11188 The real group id under which the process that called Exim was running. This is
11189 not the same as the group id of the originator of a message (see
11190 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11191 incarnation normally contains the Exim gid.
11192
11193 .vitem &$caller_uid$&
11194 .cindex "uid (user id)" "caller"
11195 .vindex "&$caller_uid$&"
11196 The real user id under which the process that called Exim was running. This is
11197 not the same as the user id of the originator of a message (see
11198 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11199 incarnation normally contains the Exim uid.
11200
11201 .vitem &$compile_date$&
11202 .vindex "&$compile_date$&"
11203 The date on which the Exim binary was compiled.
11204
11205 .vitem &$compile_number$&
11206 .vindex "&$compile_number$&"
11207 The building process for Exim keeps a count of the number
11208 of times it has been compiled. This serves to distinguish different
11209 compilations of the same version of the program.
11210
11211 .vitem &$demime_errorlevel$&
11212 .vindex "&$demime_errorlevel$&"
11213 This variable is available when Exim is compiled with
11214 the content-scanning extension and the obsolete &%demime%& condition. For
11215 details, see section &<<SECTdemimecond>>&.
11216
11217 .vitem &$demime_reason$&
11218 .vindex "&$demime_reason$&"
11219 This variable is available when Exim is compiled with the
11220 content-scanning extension and the obsolete &%demime%& condition. For details,
11221 see section &<<SECTdemimecond>>&.
11222
11223 .vitem &$dnslist_domain$& &&&
11224        &$dnslist_matched$& &&&
11225        &$dnslist_text$& &&&
11226        &$dnslist_value$&
11227 .vindex "&$dnslist_domain$&"
11228 .vindex "&$dnslist_matched$&"
11229 .vindex "&$dnslist_text$&"
11230 .vindex "&$dnslist_value$&"
11231 .cindex "black list (DNS)"
11232 When a DNS (black) list lookup succeeds, these variables are set to contain
11233 the following data from the lookup: the list's domain name, the key that was
11234 looked up, the contents of any associated TXT record, and the value from the
11235 main A record. See section &<<SECID204>>& for more details.
11236
11237 .vitem &$domain$&
11238 .vindex "&$domain$&"
11239 When an address is being routed, or delivered on its own, this variable
11240 contains the domain. Uppercase letters in the domain are converted into lower
11241 case for &$domain$&.
11242
11243 Global address rewriting happens when a message is received, so the value of
11244 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11245 is set during user filtering, but not during system filtering, because a
11246 message may have many recipients and the system filter is called just once.
11247
11248 When more than one address is being delivered at once (for example, several
11249 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11250 have the same domain. Transports can be restricted to handling only one domain
11251 at a time if the value of &$domain$& is required at transport time &-- this is
11252 the default for local transports. For further details of the environment in
11253 which local transports are run, see chapter &<<CHAPenvironment>>&.
11254
11255 .oindex "&%delay_warning_condition%&"
11256 At the end of a delivery, if all deferred addresses have the same domain, it is
11257 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11258
11259 The &$domain$& variable is also used in some other circumstances:
11260
11261 .ilist
11262 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11263 the recipient address. The domain of the &'sender'& address is in
11264 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11265 normally set during the running of the MAIL ACL. However, if the sender address
11266 is verified with a callout during the MAIL ACL, the sender domain is placed in
11267 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11268 the &(smtp)& transport.
11269
11270 .next
11271 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11272 &$domain$& contains the domain portion of the address that is being rewritten;
11273 it can be used in the expansion of the replacement address, for example, to
11274 rewrite domains by file lookup.
11275
11276 .next
11277 With one important exception, whenever a domain list is being scanned,
11278 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11279 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11280 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11281 that, in a RCPT ACL, the sender domain list can be dependent on the
11282 recipient domain (which is what is in &$domain$& at this time).
11283
11284 .next
11285 .cindex "ETRN" "value of &$domain$&"
11286 .oindex "&%smtp_etrn_command%&"
11287 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11288 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11289 .endlist
11290
11291
11292 .vitem &$domain_data$&
11293 .vindex "&$domain_data$&"
11294 When the &%domains%& option on a router matches a domain by
11295 means of a lookup, the data read by the lookup is available during the running
11296 of the router as &$domain_data$&. In addition, if the driver routes the
11297 address to a transport, the value is available in that transport. If the
11298 transport is handling multiple addresses, the value from the first address is
11299 used.
11300
11301 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11302 domain by means of a lookup. The data read by the lookup is available during
11303 the rest of the ACL statement. In all other situations, this variable expands
11304 to nothing.
11305
11306 .vitem &$exim_gid$&
11307 .vindex "&$exim_gid$&"
11308 This variable contains the numerical value of the Exim group id.
11309
11310 .vitem &$exim_path$&
11311 .vindex "&$exim_path$&"
11312 This variable contains the path to the Exim binary.
11313
11314 .vitem &$exim_uid$&
11315 .vindex "&$exim_uid$&"
11316 This variable contains the numerical value of the Exim user id.
11317
11318 .vitem &$found_extension$&
11319 .vindex "&$found_extension$&"
11320 This variable is available when Exim is compiled with the
11321 content-scanning extension and the obsolete &%demime%& condition. For details,
11322 see section &<<SECTdemimecond>>&.
11323
11324 .vitem &$header_$&<&'name'&>
11325 This is not strictly an expansion variable. It is expansion syntax for
11326 inserting the message header line with the given name. Note that the name must
11327 be terminated by colon or white space, because it may contain a wide variety of
11328 characters. Note also that braces must &'not'& be used.
11329
11330 .vitem &$headers_added$&
11331 .vindex "&$headers_added$&"
11332 Within an ACL this variable contains the headers added so far by
11333 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11334 The headers are a newline-separated list.
11335
11336 .vitem &$home$&
11337 .vindex "&$home$&"
11338 When the &%check_local_user%& option is set for a router, the user's home
11339 directory is placed in &$home$& when the check succeeds. In particular, this
11340 means it is set during the running of users' filter files. A router may also
11341 explicitly set a home directory for use by a transport; this can be overridden
11342 by a setting on the transport itself.
11343
11344 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11345 of the environment variable HOME.
11346
11347 .vitem &$host$&
11348 .vindex "&$host$&"
11349 If a router assigns an address to a transport (any transport), and passes a
11350 list of hosts with the address, the value of &$host$& when the transport starts
11351 to run is the name of the first host on the list. Note that this applies both
11352 to local and remote transports.
11353
11354 .cindex "transport" "filter"
11355 .cindex "filter" "transport filter"
11356 For the &(smtp)& transport, if there is more than one host, the value of
11357 &$host$& changes as the transport works its way through the list. In
11358 particular, when the &(smtp)& transport is expanding its options for encryption
11359 using TLS, or for specifying a transport filter (see chapter
11360 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11361 is connected.
11362
11363 When used in the client part of an authenticator configuration (see chapter
11364 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11365 client is connected.
11366
11367
11368 .vitem &$host_address$&
11369 .vindex "&$host_address$&"
11370 This variable is set to the remote host's IP address whenever &$host$& is set
11371 for a remote connection. It is also set to the IP address that is being checked
11372 when the &%ignore_target_hosts%& option is being processed.
11373
11374 .vitem &$host_data$&
11375 .vindex "&$host_data$&"
11376 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11377 result of the lookup is made available in the &$host_data$& variable. This
11378 allows you, for example, to do things like this:
11379 .code
11380 deny  hosts = net-lsearch;/some/file
11381 message = $host_data
11382 .endd
11383 .vitem &$host_lookup_deferred$&
11384 .cindex "host name" "lookup, failure of"
11385 .vindex "&$host_lookup_deferred$&"
11386 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11387 message comes from a remote host and there is an attempt to look up the host's
11388 name from its IP address, and the attempt is not successful, one of these
11389 variables is set to &"1"&.
11390
11391 .ilist
11392 If the lookup receives a definite negative response (for example, a DNS lookup
11393 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11394
11395 .next
11396 If there is any kind of problem during the lookup, such that Exim cannot
11397 tell whether or not the host name is defined (for example, a timeout for a DNS
11398 lookup), &$host_lookup_deferred$& is set to &"1"&.
11399 .endlist ilist
11400
11401 Looking up a host's name from its IP address consists of more than just a
11402 single reverse lookup. Exim checks that a forward lookup of at least one of the
11403 names it receives from a reverse lookup yields the original IP address. If this
11404 is not the case, Exim does not accept the looked up name(s), and
11405 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11406 IP address (for example, the existence of a PTR record in the DNS) is not
11407 sufficient on its own for the success of a host name lookup. If the reverse
11408 lookup succeeds, but there is a lookup problem such as a timeout when checking
11409 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11410 &"1"&. See also &$sender_host_name$&.
11411
11412 .vitem &$host_lookup_failed$&
11413 .vindex "&$host_lookup_failed$&"
11414 See &$host_lookup_deferred$&.
11415
11416 .vitem &$host_port$&
11417 .vindex "&$host_port$&"
11418 This variable is set to the remote host's TCP port whenever &$host$& is set
11419 for an outbound connection.
11420
11421
11422 .vitem &$inode$&
11423 .vindex "&$inode$&"
11424 The only time this variable is set is while expanding the &%directory_file%&
11425 option in the &(appendfile)& transport. The variable contains the inode number
11426 of the temporary file which is about to be renamed. It can be used to construct
11427 a unique name for the file.
11428
11429 .vitem &$interface_address$&
11430 .vindex "&$interface_address$&"
11431 This is an obsolete name for &$received_ip_address$&.
11432
11433 .vitem &$interface_port$&
11434 .vindex "&$interface_port$&"
11435 This is an obsolete name for &$received_port$&.
11436
11437 .vitem &$item$&
11438 .vindex "&$item$&"
11439 This variable is used during the expansion of &*forall*& and &*forany*&
11440 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11441 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11442 empty.
11443
11444 .vitem &$ldap_dn$&
11445 .vindex "&$ldap_dn$&"
11446 This variable, which is available only when Exim is compiled with LDAP support,
11447 contains the DN from the last entry in the most recently successful LDAP
11448 lookup.
11449
11450 .vitem &$load_average$&
11451 .vindex "&$load_average$&"
11452 This variable contains the system load average, multiplied by 1000 so that it
11453 is an integer. For example, if the load average is 0.21, the value of the
11454 variable is 210. The value is recomputed every time the variable is referenced.
11455
11456 .vitem &$local_part$&
11457 .vindex "&$local_part$&"
11458 When an address is being routed, or delivered on its own, this
11459 variable contains the local part. When a number of addresses are being
11460 delivered together (for example, multiple RCPT commands in an SMTP
11461 session), &$local_part$& is not set.
11462
11463 Global address rewriting happens when a message is received, so the value of
11464 &$local_part$& during routing and delivery is the value after rewriting.
11465 &$local_part$& is set during user filtering, but not during system filtering,
11466 because a message may have many recipients and the system filter is called just
11467 once.
11468
11469 .vindex "&$local_part_prefix$&"
11470 .vindex "&$local_part_suffix$&"
11471 If a local part prefix or suffix has been recognized, it is not included in the
11472 value of &$local_part$& during routing and subsequent delivery. The values of
11473 any prefix or suffix are in &$local_part_prefix$& and
11474 &$local_part_suffix$&, respectively.
11475
11476 When a message is being delivered to a file, pipe, or autoreply transport as a
11477 result of aliasing or forwarding, &$local_part$& is set to the local part of
11478 the parent address, not to the file name or command (see &$address_file$& and
11479 &$address_pipe$&).
11480
11481 When an ACL is running for a RCPT command, &$local_part$& contains the
11482 local part of the recipient address.
11483
11484 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11485 &$local_part$& contains the local part of the address that is being rewritten;
11486 it can be used in the expansion of the replacement address, for example.
11487
11488 In all cases, all quoting is removed from the local part. For example, for both
11489 the addresses
11490 .code
11491 "abc:xyz"@test.example
11492 abc\:xyz@test.example
11493 .endd
11494 the value of &$local_part$& is
11495 .code
11496 abc:xyz
11497 .endd
11498 If you use &$local_part$& to create another address, you should always wrap it
11499 inside a quoting operator. For example, in a &(redirect)& router you could
11500 have:
11501 .code
11502 data = ${quote_local_part:$local_part}@new.domain.example
11503 .endd
11504 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11505 to process local parts in a case-dependent manner in a router, you can set the
11506 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11507
11508 .vitem &$local_part_data$&
11509 .vindex "&$local_part_data$&"
11510 When the &%local_parts%& option on a router matches a local part by means of a
11511 lookup, the data read by the lookup is available during the running of the
11512 router as &$local_part_data$&. In addition, if the driver routes the address
11513 to a transport, the value is available in that transport. If the transport is
11514 handling multiple addresses, the value from the first address is used.
11515
11516 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11517 matches a local part by means of a lookup. The data read by the lookup is
11518 available during the rest of the ACL statement. In all other situations, this
11519 variable expands to nothing.
11520
11521 .vitem &$local_part_prefix$&
11522 .vindex "&$local_part_prefix$&"
11523 When an address is being routed or delivered, and a
11524 specific prefix for the local part was recognized, it is available in this
11525 variable, having been removed from &$local_part$&.
11526
11527 .vitem &$local_part_suffix$&
11528 .vindex "&$local_part_suffix$&"
11529 When an address is being routed or delivered, and a
11530 specific suffix for the local part was recognized, it is available in this
11531 variable, having been removed from &$local_part$&.
11532
11533 .vitem &$local_scan_data$&
11534 .vindex "&$local_scan_data$&"
11535 This variable contains the text returned by the &[local_scan()]& function when
11536 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11537
11538 .vitem &$local_user_gid$&
11539 .vindex "&$local_user_gid$&"
11540 See &$local_user_uid$&.
11541
11542 .vitem &$local_user_uid$&
11543 .vindex "&$local_user_uid$&"
11544 This variable and &$local_user_gid$& are set to the uid and gid after the
11545 &%check_local_user%& router precondition succeeds. This means that their values
11546 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11547 and &%condition%&), for the &%address_data%& expansion, and for any
11548 router-specific expansions. At all other times, the values in these variables
11549 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11550
11551 .vitem &$localhost_number$&
11552 .vindex "&$localhost_number$&"
11553 This contains the expanded value of the
11554 &%localhost_number%& option. The expansion happens after the main options have
11555 been read.
11556
11557 .vitem &$log_inodes$&
11558 .vindex "&$log_inodes$&"
11559 The number of free inodes in the disk partition where Exim's
11560 log files are being written. The value is recalculated whenever the variable is
11561 referenced. If the relevant file system does not have the concept of inodes,
11562 the value of is -1. See also the &%check_log_inodes%& option.
11563
11564 .vitem &$log_space$&
11565 .vindex "&$log_space$&"
11566 The amount of free space (as a number of kilobytes) in the disk
11567 partition where Exim's log files are being written. The value is recalculated
11568 whenever the variable is referenced. If the operating system does not have the
11569 ability to find the amount of free space (only true for experimental systems),
11570 the space value is -1. See also the &%check_log_space%& option.
11571
11572
11573 .vitem &$lookup_dnssec_authenticated$&
11574 .vindex "&$lookup_dnssec_authenticated$&"
11575 This variable is set after a DNS lookup done by
11576 a dnsdb lookup expansion, dnslookup router or smtp transport.
11577 It will be empty if &(DNSSEC)& was not requested,
11578 &"no"& if the result was not labelled as authenticated data
11579 and &"yes"& if it was.
11580
11581 .vitem &$mailstore_basename$&
11582 .vindex "&$mailstore_basename$&"
11583 This variable is set only when doing deliveries in &"mailstore"& format in the
11584 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11585 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11586 contains the basename of the files that are being written, that is, the name
11587 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11588 variable is empty.
11589
11590 .vitem &$malware_name$&
11591 .vindex "&$malware_name$&"
11592 This variable is available when Exim is compiled with the
11593 content-scanning extension. It is set to the name of the virus that was found
11594 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11595
11596 .vitem &$max_received_linelength$&
11597 .vindex "&$max_received_linelength$&"
11598 .cindex "maximum" "line length"
11599 .cindex "line length" "maximum"
11600 This variable contains the number of bytes in the longest line that was
11601 received as part of the message, not counting the line termination
11602 character(s).
11603
11604 .vitem &$message_age$&
11605 .cindex "message" "age of"
11606 .vindex "&$message_age$&"
11607 This variable is set at the start of a delivery attempt to contain the number
11608 of seconds since the message was received. It does not change during a single
11609 delivery attempt.
11610
11611 .vitem &$message_body$&
11612 .cindex "body of message" "expansion variable"
11613 .cindex "message body" "in expansion"
11614 .cindex "binary zero" "in message body"
11615 .vindex "&$message_body$&"
11616 .oindex "&%message_body_visible%&"
11617 This variable contains the initial portion of a message's body while it is
11618 being delivered, and is intended mainly for use in filter files. The maximum
11619 number of characters of the body that are put into the variable is set by the
11620 &%message_body_visible%& configuration option; the default is 500.
11621
11622 .oindex "&%message_body_newlines%&"
11623 By default, newlines are converted into spaces in &$message_body$&, to make it
11624 easier to search for phrases that might be split over a line break. However,
11625 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11626 zeros are always converted into spaces.
11627
11628 .vitem &$message_body_end$&
11629 .cindex "body of message" "expansion variable"
11630 .cindex "message body" "in expansion"
11631 .vindex "&$message_body_end$&"
11632 This variable contains the final portion of a message's
11633 body while it is being delivered. The format and maximum size are as for
11634 &$message_body$&.
11635
11636 .vitem &$message_body_size$&
11637 .cindex "body of message" "size"
11638 .cindex "message body" "size"
11639 .vindex "&$message_body_size$&"
11640 When a message is being delivered, this variable contains the size of the body
11641 in bytes. The count starts from the character after the blank line that
11642 separates the body from the header. Newlines are included in the count. See
11643 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11644
11645 .vitem &$message_exim_id$&
11646 .vindex "&$message_exim_id$&"
11647 When a message is being received or delivered, this variable contains the
11648 unique message id that is generated and used by Exim to identify the message.
11649 An id is not created for a message until after its header has been successfully
11650 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11651 line; it is the local id that Exim assigns to the message, for example:
11652 &`1BXTIK-0001yO-VA`&.
11653
11654 .vitem &$message_headers$&
11655 .vindex &$message_headers$&
11656 This variable contains a concatenation of all the header lines when a message
11657 is being processed, except for lines added by routers or transports. The header
11658 lines are separated by newline characters. Their contents are decoded in the
11659 same way as a header line that is inserted by &%bheader%&.
11660
11661 .vitem &$message_headers_raw$&
11662 .vindex &$message_headers_raw$&
11663 This variable is like &$message_headers$& except that no processing of the
11664 contents of header lines is done.
11665
11666 .vitem &$message_id$&
11667 This is an old name for &$message_exim_id$&, which is now deprecated.
11668
11669 .vitem &$message_linecount$&
11670 .vindex "&$message_linecount$&"
11671 This variable contains the total number of lines in the header and body of the
11672 message. Compare &$body_linecount$&, which is the count for the body only.
11673 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11674 number of lines received. Before delivery happens (that is, before filters,
11675 routers, and transports run) the count is increased to include the
11676 &'Received:'& header line that Exim standardly adds, and also any other header
11677 lines that are added by ACLs. The blank line that separates the message header
11678 from the body is not counted.
11679
11680 As with the special case of &$message_size$&, during the expansion of the
11681 appendfile transport's maildir_tag option in maildir format, the value of
11682 &$message_linecount$& is the precise size of the number of newlines in the
11683 file that has been written (minus one for the blank line between the
11684 header and the body).
11685
11686 Here is an example of the use of this variable in a DATA ACL:
11687 .code
11688 deny message   = Too many lines in message header
11689      condition = \
11690       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11691 .endd
11692 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11693 message has not yet been received.
11694
11695 .vitem &$message_size$&
11696 .cindex "size" "of message"
11697 .cindex "message" "size"
11698 .vindex "&$message_size$&"
11699 When a message is being processed, this variable contains its size in bytes. In
11700 most cases, the size includes those headers that were received with the
11701 message, but not those (such as &'Envelope-to:'&) that are added to individual
11702 deliveries as they are written. However, there is one special case: during the
11703 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11704 doing a delivery in maildir format, the value of &$message_size$& is the
11705 precise size of the file that has been written. See also
11706 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11707
11708 .cindex "RCPT" "value of &$message_size$&"
11709 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11710 contains the size supplied on the MAIL command, or -1 if no size was given. The
11711 value may not, of course, be truthful.
11712
11713 .vitem &$mime_$&&'xxx'&
11714 A number of variables whose names start with &$mime$& are
11715 available when Exim is compiled with the content-scanning extension. For
11716 details, see section &<<SECTscanmimepart>>&.
11717
11718 .vitem "&$n0$& &-- &$n9$&"
11719 These variables are counters that can be incremented by means
11720 of the &%add%& command in filter files.
11721
11722 .vitem &$original_domain$&
11723 .vindex "&$domain$&"
11724 .vindex "&$original_domain$&"
11725 When a top-level address is being processed for delivery, this contains the
11726 same value as &$domain$&. However, if a &"child"& address (for example,
11727 generated by an alias, forward, or filter file) is being processed, this
11728 variable contains the domain of the original address (lower cased). This
11729 differs from &$parent_domain$& only when there is more than one level of
11730 aliasing or forwarding. When more than one address is being delivered in a
11731 single transport run, &$original_domain$& is not set.
11732
11733 If a new address is created by means of a &%deliver%& command in a system
11734 filter, it is set up with an artificial &"parent"& address. This has the local
11735 part &'system-filter'& and the default qualify domain.
11736
11737 .vitem &$original_local_part$&
11738 .vindex "&$local_part$&"
11739 .vindex "&$original_local_part$&"
11740 When a top-level address is being processed for delivery, this contains the
11741 same value as &$local_part$&, unless a prefix or suffix was removed from the
11742 local part, because &$original_local_part$& always contains the full local
11743 part. When a &"child"& address (for example, generated by an alias, forward, or
11744 filter file) is being processed, this variable contains the full local part of
11745 the original address.
11746
11747 If the router that did the redirection processed the local part
11748 case-insensitively, the value in &$original_local_part$& is in lower case.
11749 This variable differs from &$parent_local_part$& only when there is more than
11750 one level of aliasing or forwarding. When more than one address is being
11751 delivered in a single transport run, &$original_local_part$& is not set.
11752
11753 If a new address is created by means of a &%deliver%& command in a system
11754 filter, it is set up with an artificial &"parent"& address. This has the local
11755 part &'system-filter'& and the default qualify domain.
11756
11757 .vitem &$originator_gid$&
11758 .cindex "gid (group id)" "of originating user"
11759 .cindex "sender" "gid"
11760 .vindex "&$caller_gid$&"
11761 .vindex "&$originator_gid$&"
11762 This variable contains the value of &$caller_gid$& that was set when the
11763 message was received. For messages received via the command line, this is the
11764 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11765 normally the gid of the Exim user.
11766
11767 .vitem &$originator_uid$&
11768 .cindex "uid (user id)" "of originating user"
11769 .cindex "sender" "uid"
11770 .vindex "&$caller_uid$&"
11771 .vindex "&$originaltor_uid$&"
11772 The value of &$caller_uid$& that was set when the message was received. For
11773 messages received via the command line, this is the uid of the sending user.
11774 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11775 user.
11776
11777 .vitem &$parent_domain$&
11778 .vindex "&$parent_domain$&"
11779 This variable is similar to &$original_domain$& (see
11780 above), except that it refers to the immediately preceding parent address.
11781
11782 .vitem &$parent_local_part$&
11783 .vindex "&$parent_local_part$&"
11784 This variable is similar to &$original_local_part$&
11785 (see above), except that it refers to the immediately preceding parent address.
11786
11787 .vitem &$pid$&
11788 .cindex "pid (process id)" "of current process"
11789 .vindex "&$pid$&"
11790 This variable contains the current process id.
11791
11792 .vitem &$pipe_addresses$&
11793 .cindex "filter" "transport filter"
11794 .cindex "transport" "filter"
11795 .vindex "&$pipe_addresses$&"
11796 This is not an expansion variable, but is mentioned here because the string
11797 &`$pipe_addresses`& is handled specially in the command specification for the
11798 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11799 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11800 It cannot be used in general expansion strings, and provokes an &"unknown
11801 variable"& error if encountered.
11802
11803 .vitem &$primary_hostname$&
11804 .vindex "&$primary_hostname$&"
11805 This variable contains the value set by &%primary_hostname%& in the
11806 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11807 a single-component name, Exim calls &[gethostbyname()]& (or
11808 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11809 qualified host name. See also &$smtp_active_hostname$&.
11810
11811
11812 .vitem &$prvscheck_address$&
11813 This variable is used in conjunction with the &%prvscheck%& expansion item,
11814 which is described in sections &<<SECTexpansionitems>>& and
11815 &<<SECTverifyPRVS>>&.
11816
11817 .vitem &$prvscheck_keynum$&
11818 This variable is used in conjunction with the &%prvscheck%& expansion item,
11819 which is described in sections &<<SECTexpansionitems>>& and
11820 &<<SECTverifyPRVS>>&.
11821
11822 .vitem &$prvscheck_result$&
11823 This variable is used in conjunction with the &%prvscheck%& expansion item,
11824 which is described in sections &<<SECTexpansionitems>>& and
11825 &<<SECTverifyPRVS>>&.
11826
11827 .vitem &$qualify_domain$&
11828 .vindex "&$qualify_domain$&"
11829 The value set for the &%qualify_domain%& option in the configuration file.
11830
11831 .vitem &$qualify_recipient$&
11832 .vindex "&$qualify_recipient$&"
11833 The value set for the &%qualify_recipient%& option in the configuration file,
11834 or if not set, the value of &$qualify_domain$&.
11835
11836 .vitem &$rcpt_count$&
11837 .vindex "&$rcpt_count$&"
11838 When a message is being received by SMTP, this variable contains the number of
11839 RCPT commands received for the current message. If this variable is used in a
11840 RCPT ACL, its value includes the current command.
11841
11842 .vitem &$rcpt_defer_count$&
11843 .vindex "&$rcpt_defer_count$&"
11844 .cindex "4&'xx'& responses" "count of"
11845 When a message is being received by SMTP, this variable contains the number of
11846 RCPT commands in the current message that have previously been rejected with a
11847 temporary (4&'xx'&) response.
11848
11849 .vitem &$rcpt_fail_count$&
11850 .vindex "&$rcpt_fail_count$&"
11851 When a message is being received by SMTP, this variable contains the number of
11852 RCPT commands in the current message that have previously been rejected with a
11853 permanent (5&'xx'&) response.
11854
11855 .vitem &$received_count$&
11856 .vindex "&$received_count$&"
11857 This variable contains the number of &'Received:'& header lines in the message,
11858 including the one added by Exim (so its value is always greater than zero). It
11859 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11860 delivering.
11861
11862 .vitem &$received_for$&
11863 .vindex "&$received_for$&"
11864 If there is only a single recipient address in an incoming message, this
11865 variable contains that address when the &'Received:'& header line is being
11866 built. The value is copied after recipient rewriting has happened, but before
11867 the &[local_scan()]& function is run.
11868
11869 .vitem &$received_ip_address$&
11870 .vindex "&$received_ip_address$&"
11871 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11872 variable is set to the address of the local IP interface, and &$received_port$&
11873 is set to the local port number. (The remote IP address and port are in
11874 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11875 the port value is -1 unless it has been set using the &%-oMi%& command line
11876 option.
11877
11878 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11879 could be used, for example, to make the file name for a TLS certificate depend
11880 on which interface and/or port is being used for the incoming connection. The
11881 values of &$received_ip_address$& and &$received_port$& are saved with any
11882 messages that are received, thus making these variables available at delivery
11883 time.
11884
11885 &*Note:*& There are no equivalent variables for outgoing connections, because
11886 the values are unknown (unless they are explicitly set by options of the
11887 &(smtp)& transport).
11888
11889 .vitem &$received_port$&
11890 .vindex "&$received_port$&"
11891 See &$received_ip_address$&.
11892
11893 .vitem &$received_protocol$&
11894 .vindex "&$received_protocol$&"
11895 When a message is being processed, this variable contains the name of the
11896 protocol by which it was received. Most of the names used by Exim are defined
11897 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11898 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11899 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11900 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11901 connection and the client was successfully authenticated.
11902
11903 Exim uses the protocol name &"smtps"& for the case when encryption is
11904 automatically set up on connection without the use of STARTTLS (see
11905 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11906 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11907 where the client initially uses EHLO, sets up an encrypted connection using
11908 STARTTLS, and then uses HELO afterwards.
11909
11910 The &%-oMr%& option provides a way of specifying a custom protocol name for
11911 messages that are injected locally by trusted callers. This is commonly used to
11912 identify messages that are being re-injected after some kind of scanning.
11913
11914 .vitem &$received_time$&
11915 .vindex "&$received_time$&"
11916 This variable contains the date and time when the current message was received,
11917 as a number of seconds since the start of the Unix epoch.
11918
11919 .vitem &$recipient_data$&
11920 .vindex "&$recipient_data$&"
11921 This variable is set after an indexing lookup success in an ACL &%recipients%&
11922 condition. It contains the data from the lookup, and the value remains set
11923 until the next &%recipients%& test. Thus, you can do things like this:
11924 .display
11925 &`require recipients  = cdb*@;/some/file`&
11926 &`deny    `&&'some further test involving'& &`$recipient_data`&
11927 .endd
11928 &*Warning*&: This variable is set only when a lookup is used as an indexing
11929 method in the address list, using the semicolon syntax as in the example above.
11930 The variable is not set for a lookup that is used as part of the string
11931 expansion that all such lists undergo before being interpreted.
11932
11933 .vitem &$recipient_verify_failure$&
11934 .vindex "&$recipient_verify_failure$&"
11935 In an ACL, when a recipient verification fails, this variable contains
11936 information about the failure. It is set to one of the following words:
11937
11938 .ilist
11939 &"qualify"&: The address was unqualified (no domain), and the message
11940 was neither local nor came from an exempted host.
11941
11942 .next
11943 &"route"&: Routing failed.
11944
11945 .next
11946 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11947 or before the MAIL command (that is, on initial connection, HELO, or
11948 MAIL).
11949
11950 .next
11951 &"recipient"&: The RCPT command in a callout was rejected.
11952 .next
11953
11954 &"postmaster"&: The postmaster check in a callout was rejected.
11955 .endlist
11956
11957 The main use of this variable is expected to be to distinguish between
11958 rejections of MAIL and rejections of RCPT.
11959
11960 .vitem &$recipients$&
11961 .vindex "&$recipients$&"
11962 This variable contains a list of envelope recipients for a message. A comma and
11963 a space separate the addresses in the replacement text. However, the variable
11964 is not generally available, to prevent exposure of Bcc recipients in
11965 unprivileged users' filter files. You can use &$recipients$& only in these
11966 cases:
11967
11968 .olist
11969 In a system filter file.
11970 .next
11971 In the ACLs associated with the DATA command and with non-SMTP messages, that
11972 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11973 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11974 &%acl_not_smtp_mime%&.
11975 .next
11976 From within a &[local_scan()]& function.
11977 .endlist
11978
11979
11980 .vitem &$recipients_count$&
11981 .vindex "&$recipients_count$&"
11982 When a message is being processed, this variable contains the number of
11983 envelope recipients that came with the message. Duplicates are not excluded
11984 from the count. While a message is being received over SMTP, the number
11985 increases for each accepted recipient. It can be referenced in an ACL.
11986
11987
11988 .vitem &$regex_match_string$&
11989 .vindex "&$regex_match_string$&"
11990 This variable is set to contain the matching regular expression after a
11991 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11992
11993
11994 .vitem &$reply_address$&
11995 .vindex "&$reply_address$&"
11996 When a message is being processed, this variable contains the contents of the
11997 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11998 contents of the &'From:'& header line. Apart from the removal of leading
11999 white space, the value is not processed in any way. In particular, no RFC 2047
12000 decoding or character code translation takes place.
12001
12002 .vitem &$return_path$&
12003 .vindex "&$return_path$&"
12004 When a message is being delivered, this variable contains the return path &--
12005 the sender field that will be sent as part of the envelope. It is not enclosed
12006 in <> characters. At the start of routing an address, &$return_path$& has the
12007 same value as &$sender_address$&, but if, for example, an incoming message to a
12008 mailing list has been expanded by a router which specifies a different address
12009 for bounce messages, &$return_path$& subsequently contains the new bounce
12010 address, whereas &$sender_address$& always contains the original sender address
12011 that was received with the message. In other words, &$sender_address$& contains
12012 the incoming envelope sender, and &$return_path$& contains the outgoing
12013 envelope sender.
12014
12015 .vitem &$return_size_limit$&
12016 .vindex "&$return_size_limit$&"
12017 This is an obsolete name for &$bounce_return_size_limit$&.
12018
12019 .vitem &$router_name$&
12020 .cindex "router" "name"
12021 .cindex "name" "of router"
12022 .vindex "&$router_name$&"
12023 During the running of a router this variable contains its name.
12024
12025 .vitem &$runrc$&
12026 .cindex "return code" "from &%run%& expansion"
12027 .vindex "&$runrc$&"
12028 This variable contains the return code from a command that is run by the
12029 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12030 assume the order in which option values are expanded, except for those
12031 preconditions whose order of testing is documented. Therefore, you cannot
12032 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12033 another.
12034
12035 .vitem &$self_hostname$&
12036 .oindex "&%self%&" "value of host name"
12037 .vindex "&$self_hostname$&"
12038 When an address is routed to a supposedly remote host that turns out to be the
12039 local host, what happens is controlled by the &%self%& generic router option.
12040 One of its values causes the address to be passed to another router. When this
12041 happens, &$self_hostname$& is set to the name of the local host that the
12042 original router encountered. In other circumstances its contents are null.
12043
12044 .vitem &$sender_address$&
12045 .vindex "&$sender_address$&"
12046 When a message is being processed, this variable contains the sender's address
12047 that was received in the message's envelope. The case of letters in the address
12048 is retained, in both the local part and the domain. For bounce messages, the
12049 value of this variable is the empty string. See also &$return_path$&.
12050
12051 .vitem &$sender_address_data$&
12052 .vindex "&$address_data$&"
12053 .vindex "&$sender_address_data$&"
12054 If &$address_data$& is set when the routers are called from an ACL to verify a
12055 sender address, the final value is preserved in &$sender_address_data$&, to
12056 distinguish it from data from a recipient address. The value does not persist
12057 after the end of the current ACL statement. If you want to preserve it for
12058 longer, you can save it in an ACL variable.
12059
12060 .vitem &$sender_address_domain$&
12061 .vindex "&$sender_address_domain$&"
12062 The domain portion of &$sender_address$&.
12063
12064 .vitem &$sender_address_local_part$&
12065 .vindex "&$sender_address_local_part$&"
12066 The local part portion of &$sender_address$&.
12067
12068 .vitem &$sender_data$&
12069 .vindex "&$sender_data$&"
12070 This variable is set after a lookup success in an ACL &%senders%& condition or
12071 in a router &%senders%& option. It contains the data from the lookup, and the
12072 value remains set until the next &%senders%& test. Thus, you can do things like
12073 this:
12074 .display
12075 &`require senders      = cdb*@;/some/file`&
12076 &`deny    `&&'some further test involving'& &`$sender_data`&
12077 .endd
12078 &*Warning*&: This variable is set only when a lookup is used as an indexing
12079 method in the address list, using the semicolon syntax as in the example above.
12080 The variable is not set for a lookup that is used as part of the string
12081 expansion that all such lists undergo before being interpreted.
12082
12083 .vitem &$sender_fullhost$&
12084 .vindex "&$sender_fullhost$&"
12085 When a message is received from a remote host, this variable contains the host
12086 name and IP address in a single string. It ends with the IP address in square
12087 brackets, followed by a colon and a port number if the logging of ports is
12088 enabled. The format of the rest of the string depends on whether the host
12089 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12090 looking up its IP address. (Looking up the IP address can be forced by the
12091 &%host_lookup%& option, independent of verification.) A plain host name at the
12092 start of the string is a verified host name; if this is not present,
12093 verification either failed or was not requested. A host name in parentheses is
12094 the argument of a HELO or EHLO command. This is omitted if it is identical to
12095 the verified host name or to the host's IP address in square brackets.
12096
12097 .vitem &$sender_helo_name$&
12098 .vindex "&$sender_helo_name$&"
12099 When a message is received from a remote host that has issued a HELO or EHLO
12100 command, the argument of that command is placed in this variable. It is also
12101 set if HELO or EHLO is used when a message is received using SMTP locally via
12102 the &%-bs%& or &%-bS%& options.
12103
12104 .vitem &$sender_host_address$&
12105 .vindex "&$sender_host_address$&"
12106 When a message is received from a remote host, this variable contains that
12107 host's IP address. For locally submitted messages, it is empty.
12108
12109 .vitem &$sender_host_authenticated$&
12110 .vindex "&$sender_host_authenticated$&"
12111 This variable contains the name (not the public name) of the authenticator
12112 driver that successfully authenticated the client from which the message was
12113 received. It is empty if there was no successful authentication. See also
12114 &$authenticated_id$&.
12115
12116 .vitem &$sender_host_dnssec$&
12117 .vindex "&$sender_host_dnssec$&"
12118 If an attempt to populate &$sender_host_name$& has been made
12119 (by reference, &%hosts_lookup%& or
12120 otherwise) then this boolean will have been set true if, and only if, the
12121 resolver library states that the reverse DNS was authenticated data.  At all
12122 other times, this variable is false.
12123
12124 It is likely that you will need to coerce DNSSEC support on in the resolver
12125 library, by setting:
12126 .code
12127 dns_dnssec_ok = 1
12128 .endd
12129
12130 Exim does not perform DNSSEC validation itself, instead leaving that to a
12131 validating resolver (eg, unbound, or bind with suitable configuration).
12132
12133 Exim does not (currently) check to see if the forward DNS was also secured
12134 with DNSSEC, only the reverse DNS.
12135
12136 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12137 mechanism in the list, then this variable will be false.
12138
12139
12140 .vitem &$sender_host_name$&
12141 .vindex "&$sender_host_name$&"
12142 When a message is received from a remote host, this variable contains the
12143 host's name as obtained by looking up its IP address. For messages received by
12144 other means, this variable is empty.
12145
12146 .vindex "&$host_lookup_failed$&"
12147 If the host name has not previously been looked up, a reference to
12148 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12149 A looked up name is accepted only if it leads back to the original IP address
12150 via a forward lookup. If either the reverse or the forward lookup fails to find
12151 any data, or if the forward lookup does not yield the original IP address,
12152 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12153
12154 .vindex "&$host_lookup_deferred$&"
12155 However, if either of the lookups cannot be completed (for example, there is a
12156 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12157 &$host_lookup_failed$& remains set to &"0"&.
12158
12159 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12160 host name again if there is a subsequent reference to &$sender_host_name$&
12161 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12162 is set to &"1"&.
12163
12164 Exim does not automatically look up every calling host's name. If you want
12165 maximum efficiency, you should arrange your configuration so that it avoids
12166 these lookups altogether. The lookup happens only if one or more of the
12167 following are true:
12168
12169 .ilist
12170 A string containing &$sender_host_name$& is expanded.
12171 .next
12172 The calling host matches the list in &%host_lookup%&. In the default
12173 configuration, this option is set to *, so it must be changed if lookups are
12174 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12175 .next
12176 Exim needs the host name in order to test an item in a host list. The items
12177 that require this are described in sections &<<SECThoslispatnam>>& and
12178 &<<SECThoslispatnamsk>>&.
12179 .next
12180 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12181 In this case, the host name is required to compare with the name quoted in any
12182 EHLO or HELO commands that the client issues.
12183 .next
12184 The remote host issues a EHLO or HELO command that quotes one of the
12185 domains in &%helo_lookup_domains%&. The default value of this option is
12186 . ==== As this is a nested list, any displays it contains must be indented
12187 . ==== as otherwise they are too far to the left.
12188 .code
12189   helo_lookup_domains = @ : @[]
12190 .endd
12191 which causes a lookup if a remote host (incorrectly) gives the server's name or
12192 IP address in an EHLO or HELO command.
12193 .endlist
12194
12195
12196 .vitem &$sender_host_port$&
12197 .vindex "&$sender_host_port$&"
12198 When a message is received from a remote host, this variable contains the port
12199 number that was used on the remote host.
12200
12201 .vitem &$sender_ident$&
12202 .vindex "&$sender_ident$&"
12203 When a message is received from a remote host, this variable contains the
12204 identification received in response to an RFC 1413 request. When a message has
12205 been received locally, this variable contains the login name of the user that
12206 called Exim.
12207
12208 .vitem &$sender_rate_$&&'xxx'&
12209 A number of variables whose names begin &$sender_rate_$& are set as part of the
12210 &%ratelimit%& ACL condition. Details are given in section
12211 &<<SECTratelimiting>>&.
12212
12213 .vitem &$sender_rcvhost$&
12214 .cindex "DNS" "reverse lookup"
12215 .cindex "reverse DNS lookup"
12216 .vindex "&$sender_rcvhost$&"
12217 This is provided specifically for use in &'Received:'& headers. It starts with
12218 either the verified host name (as obtained from a reverse DNS lookup) or, if
12219 there is no verified host name, the IP address in square brackets. After that
12220 there may be text in parentheses. When the first item is a verified host name,
12221 the first thing in the parentheses is the IP address in square brackets,
12222 followed by a colon and a port number if port logging is enabled. When the
12223 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12224 the parentheses.
12225
12226 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12227 was used and its argument was not identical to the real host name or IP
12228 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12229 all three items are present in the parentheses, a newline and tab are inserted
12230 into the string, to improve the formatting of the &'Received:'& header.
12231
12232 .vitem &$sender_verify_failure$&
12233 .vindex "&$sender_verify_failure$&"
12234 In an ACL, when a sender verification fails, this variable contains information
12235 about the failure. The details are the same as for
12236 &$recipient_verify_failure$&.
12237
12238 .vitem &$sending_ip_address$&
12239 .vindex "&$sending_ip_address$&"
12240 This variable is set whenever an outgoing SMTP connection to another host has
12241 been set up. It contains the IP address of the local interface that is being
12242 used. This is useful if a host that has more than one IP address wants to take
12243 on different personalities depending on which one is being used. For incoming
12244 connections, see &$received_ip_address$&.
12245
12246 .vitem &$sending_port$&
12247 .vindex "&$sending_port$&"
12248 This variable is set whenever an outgoing SMTP connection to another host has
12249 been set up. It contains the local port that is being used. For incoming
12250 connections, see &$received_port$&.
12251
12252 .vitem &$smtp_active_hostname$&
12253 .vindex "&$smtp_active_hostname$&"
12254 During an incoming SMTP session, this variable contains the value of the active
12255 host name, as specified by the &%smtp_active_hostname%& option. The value of
12256 &$smtp_active_hostname$& is saved with any message that is received, so its
12257 value can be consulted during routing and delivery.
12258
12259 .vitem &$smtp_command$&
12260 .vindex "&$smtp_command$&"
12261 During the processing of an incoming SMTP command, this variable contains the
12262 entire command. This makes it possible to distinguish between HELO and EHLO in
12263 the HELO ACL, and also to distinguish between commands such as these:
12264 .code
12265 MAIL FROM:<>
12266 MAIL FROM: <>
12267 .endd
12268 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12269 command, the address in &$smtp_command$& is the original address before any
12270 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12271 the address after SMTP-time rewriting.
12272
12273 .vitem &$smtp_command_argument$&
12274 .cindex "SMTP" "command, argument for"
12275 .vindex "&$smtp_command_argument$&"
12276 While an ACL is running to check an SMTP command, this variable contains the
12277 argument, that is, the text that follows the command name, with leading white
12278 space removed. Following the introduction of &$smtp_command$&, this variable is
12279 somewhat redundant, but is retained for backwards compatibility.
12280
12281 .vitem &$smtp_count_at_connection_start$&
12282 .vindex "&$smtp_count_at_connection_start$&"
12283 This variable is set greater than zero only in processes spawned by the Exim
12284 daemon for handling incoming SMTP connections. The name is deliberately long,
12285 in order to emphasize what the contents are. When the daemon accepts a new
12286 connection, it increments this variable. A copy of the variable is passed to
12287 the child process that handles the connection, but its value is fixed, and
12288 never changes. It is only an approximation of how many incoming connections
12289 there actually are, because many other connections may come and go while a
12290 single connection is being processed. When a child process terminates, the
12291 daemon decrements its copy of the variable.
12292
12293 .vitem "&$sn0$& &-- &$sn9$&"
12294 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12295 that were current at the end of the system filter file. This allows a system
12296 filter file to set values that can be tested in users' filter files. For
12297 example, a system filter could set a value indicating how likely it is that a
12298 message is junk mail.
12299
12300 .vitem &$spam_$&&'xxx'&
12301 A number of variables whose names start with &$spam$& are available when Exim
12302 is compiled with the content-scanning extension. For details, see section
12303 &<<SECTscanspamass>>&.
12304
12305
12306 .vitem &$spool_directory$&
12307 .vindex "&$spool_directory$&"
12308 The name of Exim's spool directory.
12309
12310 .vitem &$spool_inodes$&
12311 .vindex "&$spool_inodes$&"
12312 The number of free inodes in the disk partition where Exim's spool files are
12313 being written. The value is recalculated whenever the variable is referenced.
12314 If the relevant file system does not have the concept of inodes, the value of
12315 is -1. See also the &%check_spool_inodes%& option.
12316
12317 .vitem &$spool_space$&
12318 .vindex "&$spool_space$&"
12319 The amount of free space (as a number of kilobytes) in the disk partition where
12320 Exim's spool files are being written. The value is recalculated whenever the
12321 variable is referenced. If the operating system does not have the ability to
12322 find the amount of free space (only true for experimental systems), the space
12323 value is -1. For example, to check in an ACL that there is at least 50
12324 megabytes free on the spool, you could write:
12325 .code
12326 condition = ${if > {$spool_space}{50000}}
12327 .endd
12328 See also the &%check_spool_space%& option.
12329
12330
12331 .vitem &$thisaddress$&
12332 .vindex "&$thisaddress$&"
12333 This variable is set only during the processing of the &%foranyaddress%&
12334 command in a filter file. Its use is explained in the description of that
12335 command, which can be found in the separate document entitled &'Exim's
12336 interfaces to mail filtering'&.
12337
12338 .vitem &$tls_in_bits$&
12339 .vindex "&$tls_in_bits$&"
12340 Contains an approximation of the TLS cipher's bit-strength
12341 on the inbound connection; the meaning of
12342 this depends upon the TLS implementation used.
12343 If TLS has not been negotiated, the value will be 0.
12344 The value of this is automatically fed into the Cyrus SASL authenticator
12345 when acting as a server, to specify the "external SSF" (a SASL term).
12346
12347 The deprecated &$tls_bits$& variable refers to the inbound side
12348 except when used in the context of an outbound SMTP delivery, when it refers to
12349 the outbound.
12350
12351 .vitem &$tls_out_bits$&
12352 .vindex "&$tls_out_bits$&"
12353 Contains an approximation of the TLS cipher's bit-strength
12354 on an outbound SMTP connection; the meaning of
12355 this depends upon the TLS implementation used.
12356 If TLS has not been negotiated, the value will be 0.
12357
12358 .vitem &$tls_in_ourcert$&
12359 .vindex "&$tls_in_ourcert$&"
12360 This variable refers to the certificate presented to the peer of an
12361 inbound connection when the message was received.
12362 It is only useful as the argument of a
12363 .new
12364 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12365 .wen
12366 or a &%def%& condition.
12367
12368 .vitem &$tls_in_peercert$&
12369 .vindex "&$tls_in_peercert$&"
12370 This variable refers to the certificate presented by the peer of an
12371 inbound connection when the message was received.
12372 It is only useful as the argument of a
12373 .new
12374 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12375 .wen
12376 or a &%def%& condition.
12377
12378 .vitem &$tls_out_ourcert$&
12379 .vindex "&$tls_out_ourcert$&"
12380 This variable refers to the certificate presented to the peer of an
12381 outbound connection.  It is only useful as the argument of a
12382 .new
12383 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12384 .wen
12385 or a &%def%& condition.
12386
12387 .vitem &$tls_out_peercert$&
12388 .vindex "&$tls_out_peercert$&"
12389 This variable refers to the certificate presented by the peer of an
12390 outbound connection.  It is only useful as the argument of a
12391 .new
12392 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12393 .wen
12394 or a &%def%& condition.
12395
12396 .vitem &$tls_in_certificate_verified$&
12397 .vindex "&$tls_in_certificate_verified$&"
12398 This variable is set to &"1"& if a TLS certificate was verified when the
12399 message was received, and &"0"& otherwise.
12400
12401 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12402 except when used in the context of an outbound SMTP delivery, when it refers to
12403 the outbound.
12404
12405 .vitem &$tls_out_certificate_verified$&
12406 .vindex "&$tls_out_certificate_verified$&"
12407 This variable is set to &"1"& if a TLS certificate was verified when an
12408 outbound SMTP connection was made,
12409 and &"0"& otherwise.
12410
12411 .vitem &$tls_in_cipher$&
12412 .vindex "&$tls_in_cipher$&"
12413 .vindex "&$tls_cipher$&"
12414 When a message is received from a remote host over an encrypted SMTP
12415 connection, this variable is set to the cipher suite that was negotiated, for
12416 example DES-CBC3-SHA. In other circumstances, in particular, for message
12417 received over unencrypted connections, the variable is empty. Testing
12418 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12419 non-encrypted connections during ACL processing.
12420
12421 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12422 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12423 becomes the same as &$tls_out_cipher$&.
12424
12425 .vitem &$tls_out_cipher$&
12426 .vindex "&$tls_out_cipher$&"
12427 This variable is
12428 cleared before any outgoing SMTP connection is made,
12429 and then set to the outgoing cipher suite if one is negotiated. See chapter
12430 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12431 details of the &(smtp)& transport.
12432
12433 .vitem &$tls_in_ocsp$&
12434 .vindex "&$tls_in_ocsp$&"
12435 When a message is received from a remote client connection
12436 the result of any OCSP request from the client is encoded in this variable:
12437 .code
12438 0 OCSP proof was not requested (default value)
12439 1 No response to request
12440 2 Response not verified
12441 3 Verification failed
12442 4 Verification succeeded
12443 .endd
12444
12445 .vitem &$tls_out_ocsp$&
12446 .vindex "&$tls_out_ocsp$&"
12447 When a message is sent to a remote host connection
12448 the result of any OCSP request made is encoded in this variable.
12449 See &$tls_in_ocsp$& for values.
12450
12451 .vitem &$tls_in_peerdn$&
12452 .vindex "&$tls_in_peerdn$&"
12453 .vindex "&$tls_peerdn$&"
12454 When a message is received from a remote host over an encrypted SMTP
12455 connection, and Exim is configured to request a certificate from the client,
12456 the value of the Distinguished Name of the certificate is made available in the
12457 &$tls_in_peerdn$& during subsequent processing.
12458
12459 The deprecated &$tls_peerdn$& variable refers to the inbound side
12460 except when used in the context of an outbound SMTP delivery, when it refers to
12461 the outbound.
12462
12463 .vitem &$tls_out_peerdn$&
12464 .vindex "&$tls_out_peerdn$&"
12465 When a message is being delivered to a remote host over an encrypted SMTP
12466 connection, and Exim is configured to request a certificate from the server,
12467 the value of the Distinguished Name of the certificate is made available in the
12468 &$tls_out_peerdn$& during subsequent processing.
12469
12470 .vitem &$tls_in_sni$&
12471 .vindex "&$tls_in_sni$&"
12472 .vindex "&$tls_sni$&"
12473 .cindex "TLS" "Server Name Indication"
12474 When a TLS session is being established, if the client sends the Server
12475 Name Indication extension, the value will be placed in this variable.
12476 If the variable appears in &%tls_certificate%& then this option and
12477 some others, described in &<<SECTtlssni>>&,
12478 will be re-expanded early in the TLS session, to permit
12479 a different certificate to be presented (and optionally a different key to be
12480 used) to the client, based upon the value of the SNI extension.
12481
12482 The deprecated &$tls_sni$& variable refers to the inbound side
12483 except when used in the context of an outbound SMTP delivery, when it refers to
12484 the outbound.
12485
12486 .vitem &$tls_out_sni$&
12487 .vindex "&$tls_out_sni$&"
12488 .cindex "TLS" "Server Name Indication"
12489 During outbound
12490 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12491 the transport.
12492
12493 .vitem &$tod_bsdinbox$&
12494 .vindex "&$tod_bsdinbox$&"
12495 The time of day and the date, in the format required for BSD-style mailbox
12496 files, for example: Thu Oct 17 17:14:09 1995.
12497
12498 .vitem &$tod_epoch$&
12499 .vindex "&$tod_epoch$&"
12500 The time and date as a number of seconds since the start of the Unix epoch.
12501
12502 .vitem &$tod_epoch_l$&
12503 .vindex "&$tod_epoch_l$&"
12504 The time and date as a number of microseconds since the start of the Unix epoch.
12505
12506 .vitem &$tod_full$&
12507 .vindex "&$tod_full$&"
12508 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12509 +0100. The timezone is always given as a numerical offset from UTC, with
12510 positive values used for timezones that are ahead (east) of UTC, and negative
12511 values for those that are behind (west).
12512
12513 .vitem &$tod_log$&
12514 .vindex "&$tod_log$&"
12515 The time and date in the format used for writing Exim's log files, for example:
12516 1995-10-12 15:32:29, but without a timezone.
12517
12518 .vitem &$tod_logfile$&
12519 .vindex "&$tod_logfile$&"
12520 This variable contains the date in the format yyyymmdd. This is the format that
12521 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12522 flag.
12523
12524 .vitem &$tod_zone$&
12525 .vindex "&$tod_zone$&"
12526 This variable contains the numerical value of the local timezone, for example:
12527 -0500.
12528
12529 .vitem &$tod_zulu$&
12530 .vindex "&$tod_zulu$&"
12531 This variable contains the UTC date and time in &"Zulu"& format, as specified
12532 by ISO 8601, for example: 20030221154023Z.
12533
12534 .vitem &$transport_name$&
12535 .cindex "transport" "name"
12536 .cindex "name" "of transport"
12537 .vindex "&$transport_name$&"
12538 During the running of a transport, this variable contains its name.
12539
12540 .vitem &$value$&
12541 .vindex "&$value$&"
12542 This variable contains the result of an expansion lookup, extraction operation,
12543 or external command, as described above. It is also used during a
12544 &*reduce*& expansion.
12545
12546 .vitem &$version_number$&
12547 .vindex "&$version_number$&"
12548 The version number of Exim.
12549
12550 .vitem &$warn_message_delay$&
12551 .vindex "&$warn_message_delay$&"
12552 This variable is set only during the creation of a message warning about a
12553 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12554
12555 .vitem &$warn_message_recipients$&
12556 .vindex "&$warn_message_recipients$&"
12557 This variable is set only during the creation of a message warning about a
12558 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12559 .endlist
12560 .ecindex IIDstrexp
12561
12562
12563
12564 . ////////////////////////////////////////////////////////////////////////////
12565 . ////////////////////////////////////////////////////////////////////////////
12566
12567 .chapter "Embedded Perl" "CHAPperl"
12568 .scindex IIDperl "Perl" "calling from Exim"
12569 Exim can be built to include an embedded Perl interpreter. When this is done,
12570 Perl subroutines can be called as part of the string expansion process. To make
12571 use of the Perl support, you need version 5.004 or later of Perl installed on
12572 your system. To include the embedded interpreter in the Exim binary, include
12573 the line
12574 .code
12575 EXIM_PERL = perl.o
12576 .endd
12577 in your &_Local/Makefile_& and then build Exim in the normal way.
12578
12579
12580 .section "Setting up so Perl can be used" "SECID85"
12581 .oindex "&%perl_startup%&"
12582 Access to Perl subroutines is via a global configuration option called
12583 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12584 no &%perl_startup%& option in the Exim configuration file then no Perl
12585 interpreter is started and there is almost no overhead for Exim (since none of
12586 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12587 option then the associated value is taken to be Perl code which is executed in
12588 a newly created Perl interpreter.
12589
12590 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12591 need backslashes before any characters to escape special meanings. The option
12592 should usually be something like
12593 .code
12594 perl_startup = do '/etc/exim.pl'
12595 .endd
12596 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12597 use from Exim. Exim can be configured either to start up a Perl interpreter as
12598 soon as it is entered, or to wait until the first time it is needed. Starting
12599 the interpreter at the beginning ensures that it is done while Exim still has
12600 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12601 fact used in a particular run. Also, note that this does not mean that Exim is
12602 necessarily running as root when Perl is called at a later time. By default,
12603 the interpreter is started only when it is needed, but this can be changed in
12604 two ways:
12605
12606 .ilist
12607 .oindex "&%perl_at_start%&"
12608 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12609 a startup when Exim is entered.
12610 .next
12611 The command line option &%-ps%& also requests a startup when Exim is entered,
12612 overriding the setting of &%perl_at_start%&.
12613 .endlist
12614
12615 There is also a command line option &%-pd%& (for delay) which suppresses the
12616 initial startup, even if &%perl_at_start%& is set.
12617
12618
12619 .section "Calling Perl subroutines" "SECID86"
12620 When the configuration file includes a &%perl_startup%& option you can make use
12621 of the string expansion item to call the Perl subroutines that are defined
12622 by the &%perl_startup%& code. The operator is used in any of the following
12623 forms:
12624 .code
12625 ${perl{foo}}
12626 ${perl{foo}{argument}}
12627 ${perl{foo}{argument1}{argument2} ... }
12628 .endd
12629 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12630 arguments may be passed. Passing more than this results in an expansion failure
12631 with an error message of the form
12632 .code
12633 Too many arguments passed to Perl subroutine "foo" (max is 8)
12634 .endd
12635 The return value of the Perl subroutine is evaluated in a scalar context before
12636 it is passed back to Exim to be inserted into the expanded string. If the
12637 return value is &'undef'&, the expansion is forced to fail in the same way as
12638 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12639 by obeying Perl's &%die%& function, the expansion fails with the error message
12640 that was passed to &%die%&.
12641
12642
12643 .section "Calling Exim functions from Perl" "SECID87"
12644 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12645 is available to call back into Exim's string expansion function. For example,
12646 the Perl code
12647 .code
12648 my $lp = Exim::expand_string('$local_part');
12649 .endd
12650 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12651 Note those are single quotes and not double quotes to protect against
12652 &$local_part$& being interpolated as a Perl variable.
12653
12654 If the string expansion is forced to fail by a &"fail"& item, the result of
12655 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12656 expansion string, the Perl call from the original expansion string fails with
12657 an appropriate error message, in the same way as if &%die%& were used.
12658
12659 .cindex "debugging" "from embedded Perl"
12660 .cindex "log" "writing from embedded Perl"
12661 Two other Exim functions are available for use from within Perl code.
12662 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12663 debugging is enabled. If you want a newline at the end, you must supply it.
12664 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12665 timestamp. In this case, you should not supply a terminating newline.
12666
12667
12668 .section "Use of standard output and error by Perl" "SECID88"
12669 .cindex "Perl" "standard output and error"
12670 You should not write to the standard error or output streams from within your
12671 Perl code, as it is not defined how these are set up. In versions of Exim
12672 before 4.50, it is possible for the standard output or error to refer to the
12673 SMTP connection during message reception via the daemon. Writing to this stream
12674 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12675 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12676 avoided, but the output is lost.
12677
12678 .cindex "Perl" "use of &%warn%&"
12679 The Perl &%warn%& statement writes to the standard error stream by default.
12680 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12681 you have no control. When Exim starts up the Perl interpreter, it arranges for
12682 output from the &%warn%& statement to be written to the Exim main log. You can
12683 change this by including appropriate Perl magic somewhere in your Perl code.
12684 For example, to discard &%warn%& output completely, you need this:
12685 .code
12686 $SIG{__WARN__} = sub { };
12687 .endd
12688 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12689 example, the code for the subroutine is empty, so it does nothing, but you can
12690 include any Perl code that you like. The text of the &%warn%& message is passed
12691 as the first subroutine argument.
12692 .ecindex IIDperl
12693
12694
12695 . ////////////////////////////////////////////////////////////////////////////
12696 . ////////////////////////////////////////////////////////////////////////////
12697
12698 .chapter "Starting the daemon and the use of network interfaces" &&&
12699          "CHAPinterfaces" &&&
12700          "Starting the daemon"
12701 .cindex "daemon" "starting"
12702 .cindex "interface" "listening"
12703 .cindex "network interface"
12704 .cindex "interface" "network"
12705 .cindex "IP address" "for listening"
12706 .cindex "daemon" "listening IP addresses"
12707 .cindex "TCP/IP" "setting listening interfaces"
12708 .cindex "TCP/IP" "setting listening ports"
12709 A host that is connected to a TCP/IP network may have one or more physical
12710 hardware network interfaces. Each of these interfaces may be configured as one
12711 or more &"logical"& interfaces, which are the entities that a program actually
12712 works with. Each of these logical interfaces is associated with an IP address.
12713 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12714 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12715 knowledge about the host's interfaces for use in three different circumstances:
12716
12717 .olist
12718 When a listening daemon is started, Exim needs to know which interfaces
12719 and ports to listen on.
12720 .next
12721 When Exim is routing an address, it needs to know which IP addresses
12722 are associated with local interfaces. This is required for the correct
12723 processing of MX lists by removing the local host and others with the
12724 same or higher priority values. Also, Exim needs to detect cases
12725 when an address is routed to an IP address that in fact belongs to the
12726 local host. Unless the &%self%& router option or the &%allow_localhost%&
12727 option of the smtp transport is set (as appropriate), this is treated
12728 as an error situation.
12729 .next
12730 When Exim connects to a remote host, it may need to know which interface to use
12731 for the outgoing connection.
12732 .endlist
12733
12734
12735 Exim's default behaviour is likely to be appropriate in the vast majority
12736 of cases. If your host has only one interface, and you want all its IP
12737 addresses to be treated in the same way, and you are using only the
12738 standard SMTP port, you should not need to take any special action. The
12739 rest of this chapter does not apply to you.
12740
12741 In a more complicated situation you may want to listen only on certain
12742 interfaces, or on different ports, and for this reason there are a number of
12743 options that can be used to influence Exim's behaviour. The rest of this
12744 chapter describes how they operate.
12745
12746 When a message is received over TCP/IP, the interface and port that were
12747 actually used are set in &$received_ip_address$& and &$received_port$&.
12748
12749
12750
12751 .section "Starting a listening daemon" "SECID89"
12752 When a listening daemon is started (by means of the &%-bd%& command line
12753 option), the interfaces and ports on which it listens are controlled by the
12754 following options:
12755
12756 .ilist
12757 &%daemon_smtp_ports%& contains a list of default ports
12758 or service names.
12759 (For backward compatibility, this option can also be specified in the singular.)
12760 .next
12761 &%local_interfaces%& contains list of interface IP addresses on which to
12762 listen. Each item may optionally also specify a port.
12763 .endlist
12764
12765 The default list separator in both cases is a colon, but this can be changed as
12766 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12767 it is usually best to change the separator to avoid having to double all the
12768 colons. For example:
12769 .code
12770 local_interfaces = <; 127.0.0.1 ; \
12771                       192.168.23.65 ; \
12772                       ::1 ; \
12773                       3ffe:ffff:836f::fe86:a061
12774 .endd
12775 There are two different formats for specifying a port along with an IP address
12776 in &%local_interfaces%&:
12777
12778 .olist
12779 The port is added onto the address with a dot separator. For example, to listen
12780 on port 1234 on two different IP addresses:
12781 .code
12782 local_interfaces = <; 192.168.23.65.1234 ; \
12783                       3ffe:ffff:836f::fe86:a061.1234
12784 .endd
12785 .next
12786 The IP address is enclosed in square brackets, and the port is added
12787 with a colon separator, for example:
12788 .code
12789 local_interfaces = <; [192.168.23.65]:1234 ; \
12790                       [3ffe:ffff:836f::fe86:a061]:1234
12791 .endd
12792 .endlist
12793
12794 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12795 default setting contains just one port:
12796 .code
12797 daemon_smtp_ports = smtp
12798 .endd
12799 If more than one port is listed, each interface that does not have its own port
12800 specified listens on all of them. Ports that are listed in
12801 &%daemon_smtp_ports%& can be identified either by name (defined in
12802 &_/etc/services_&) or by number. However, when ports are given with individual
12803 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12804
12805
12806
12807 .section "Special IP listening addresses" "SECID90"
12808 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12809 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12810 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12811 instead of setting up separate listening sockets for each interface. The
12812 default value of &%local_interfaces%& is
12813 .code
12814 local_interfaces = 0.0.0.0
12815 .endd
12816 when Exim is built without IPv6 support; otherwise it is:
12817 .code
12818 local_interfaces = <; ::0 ; 0.0.0.0
12819 .endd
12820 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12821
12822
12823
12824 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12825 The &%-oX%& command line option can be used to override the values of
12826 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12827 instance. Another way of doing this would be to use macros and the &%-D%&
12828 option. However, &%-oX%& can be used by any admin user, whereas modification of
12829 the runtime configuration by &%-D%& is allowed only when the caller is root or
12830 exim.
12831
12832 The value of &%-oX%& is a list of items. The default colon separator can be
12833 changed in the usual way if required. If there are any items that do not
12834 contain dots or colons (that is, are not IP addresses), the value of
12835 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12836 items that do contain dots or colons, the value of &%local_interfaces%& is
12837 replaced by those items. Thus, for example,
12838 .code
12839 -oX 1225
12840 .endd
12841 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12842 whereas
12843 .code
12844 -oX 192.168.34.5.1125
12845 .endd
12846 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12847 (However, since &%local_interfaces%& now contains no items without ports, the
12848 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12849
12850
12851
12852 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12853 .cindex "ssmtp protocol"
12854 .cindex "smtps protocol"
12855 .cindex "SMTP" "ssmtp protocol"
12856 .cindex "SMTP" "smtps protocol"
12857 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12858 before the STARTTLS command was standardized for SMTP. Some legacy clients
12859 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12860 list of port numbers or service names,
12861 connections to those ports must use SSMTP. The most
12862 common use of this option is expected to be
12863 .code
12864 tls_on_connect_ports = 465
12865 .endd
12866 because 465 is the usual port number used by the legacy clients. There is also
12867 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12868 this way when a daemon is started.
12869
12870 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12871 daemon to listen on those ports. You must still specify them in
12872 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12873 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12874 connections via the daemon.)
12875
12876
12877
12878
12879 .section "IPv6 address scopes" "SECID92"
12880 .cindex "IPv6" "address scopes"
12881 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12882 can, in principle, have the same link-local IPv6 address on different
12883 interfaces. Thus, additional information is needed, over and above the IP
12884 address, to distinguish individual interfaces. A convention of using a
12885 percent sign followed by something (often the interface name) has been
12886 adopted in some cases, leading to addresses like this:
12887 .code
12888 fe80::202:b3ff:fe03:45c1%eth0
12889 .endd
12890 To accommodate this usage, a percent sign followed by an arbitrary string is
12891 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12892 to convert a textual IPv6 address for actual use. This function recognizes the
12893 percent convention in operating systems that support it, and it processes the
12894 address appropriately. Unfortunately, some older libraries have problems with
12895 &[getaddrinfo()]&. If
12896 .code
12897 IPV6_USE_INET_PTON=yes
12898 .endd
12899 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12900 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12901 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12902 function.) Of course, this means that the additional functionality of
12903 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12904
12905 .section "Disabling IPv6" "SECID93"
12906 .cindex "IPv6" "disabling"
12907 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12908 run on a host whose kernel does not support IPv6. The binary will fall back to
12909 using IPv4, but it may waste resources looking up AAAA records, and trying to
12910 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12911 .oindex "&%disable_ipv6%&"
12912 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12913 activities take place. AAAA records are never looked up, and any IPv6 addresses
12914 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12915 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12916 to handle IPv6 literal addresses.
12917
12918 On the other hand, when IPv6 is in use, there may be times when you want to
12919 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12920 option to globally suppress the lookup of AAAA records for specified domains,
12921 and you can use the &%ignore_target_hosts%& generic router option to ignore
12922 IPv6 addresses in an individual router.
12923
12924
12925
12926 .section "Examples of starting a listening daemon" "SECID94"
12927 The default case in an IPv6 environment is
12928 .code
12929 daemon_smtp_ports = smtp
12930 local_interfaces = <; ::0 ; 0.0.0.0
12931 .endd
12932 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12933 Either one or two sockets may be used, depending on the characteristics of
12934 the TCP/IP stack. (This is complicated and messy; for more information,
12935 read the comments in the &_daemon.c_& source file.)
12936
12937 To specify listening on ports 25 and 26 on all interfaces:
12938 .code
12939 daemon_smtp_ports = 25 : 26
12940 .endd
12941 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12942 .code
12943 local_interfaces = <; ::0.25     ; ::0.26 \
12944                       0.0.0.0.25 ; 0.0.0.0.26
12945 .endd
12946 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12947 IPv4 loopback address only:
12948 .code
12949 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12950 .endd
12951 To specify listening on the default port on specific interfaces only:
12952 .code
12953 local_interfaces = 10.0.0.67 : 192.168.34.67
12954 .endd
12955 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12956
12957
12958
12959 .section "Recognizing the local host" "SECTreclocipadd"
12960 The &%local_interfaces%& option is also used when Exim needs to determine
12961 whether or not an IP address refers to the local host. That is, the IP
12962 addresses of all the interfaces on which a daemon is listening are always
12963 treated as local.
12964
12965 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12966 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12967 available interfaces from the operating system, and extracts the relevant
12968 (that is, IPv4 or IPv6) addresses to use for checking.
12969
12970 Some systems set up large numbers of virtual interfaces in order to provide
12971 many virtual web servers. In this situation, you may want to listen for
12972 email on only a few of the available interfaces, but nevertheless treat all
12973 interfaces as local when routing. You can do this by setting
12974 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12975 &"all"& wildcard values. These addresses are recognized as local, but are not
12976 used for listening. Consider this example:
12977 .code
12978 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12979                       192.168.53.235 ; \
12980                       3ffe:2101:12:1:a00:20ff:fe86:a061
12981
12982 extra_local_interfaces = <; ::0 ; 0.0.0.0
12983 .endd
12984 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12985 address, but all available interface addresses are treated as local when
12986 Exim is routing.
12987
12988 In some environments the local host name may be in an MX list, but with an IP
12989 address that is not assigned to any local interface. In other cases it may be
12990 desirable to treat other host names as if they referred to the local host. Both
12991 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12992 This contains host names rather than IP addresses. When a host is referenced
12993 during routing, either via an MX record or directly, it is treated as the local
12994 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12995 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12996
12997
12998
12999 .section "Delivering to a remote host" "SECID95"
13000 Delivery to a remote host is handled by the smtp transport. By default, it
13001 allows the system's TCP/IP functions to choose which interface to use (if
13002 there is more than one) when connecting to a remote host. However, the
13003 &%interface%& option can be set to specify which interface is used. See the
13004 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13005 details.
13006
13007
13008
13009
13010 . ////////////////////////////////////////////////////////////////////////////
13011 . ////////////////////////////////////////////////////////////////////////////
13012
13013 .chapter "Main configuration" "CHAPmainconfig"
13014 .scindex IIDconfima "configuration file" "main section"
13015 .scindex IIDmaiconf "main configuration"
13016 The first part of the run time configuration file contains three types of item:
13017
13018 .ilist
13019 Macro definitions: These lines start with an upper case letter. See section
13020 &<<SECTmacrodefs>>& for details of macro processing.
13021 .next
13022 Named list definitions: These lines start with one of the words &"domainlist"&,
13023 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13024 section &<<SECTnamedlists>>&.
13025 .next
13026 Main configuration settings: Each setting occupies one line of the file
13027 (with possible continuations). If any setting is preceded by the word
13028 &"hide"&, the &%-bP%& command line option displays its value to admin users
13029 only. See section &<<SECTcos>>& for a description of the syntax of these option
13030 settings.
13031 .endlist
13032
13033 This chapter specifies all the main configuration options, along with their
13034 types and default values. For ease of finding a particular option, they appear
13035 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13036 are now so many options, they are first listed briefly in functional groups, as
13037 an aid to finding the name of the option you are looking for. Some options are
13038 listed in more than one group.
13039
13040 .section "Miscellaneous" "SECID96"
13041 .table2
13042 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13043 .row &%disable_ipv6%&                "do no IPv6 processing"
13044 .row &%keep_malformed%&              "for broken files &-- should not happen"
13045 .row &%localhost_number%&            "for unique message ids in clusters"
13046 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13047 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13048 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13049 .row &%print_topbitchars%&           "top-bit characters are printing"
13050 .row &%timezone%&                    "force time zone"
13051 .endtable
13052
13053
13054 .section "Exim parameters" "SECID97"
13055 .table2
13056 .row &%exim_group%&                  "override compiled-in value"
13057 .row &%exim_path%&                   "override compiled-in value"
13058 .row &%exim_user%&                   "override compiled-in value"
13059 .row &%primary_hostname%&            "default from &[uname()]&"
13060 .row &%split_spool_directory%&       "use multiple directories"
13061 .row &%spool_directory%&             "override compiled-in value"
13062 .endtable
13063
13064
13065
13066 .section "Privilege controls" "SECID98"
13067 .table2
13068 .row &%admin_groups%&                "groups that are Exim admin users"
13069 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13070 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13071 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13072 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13073 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13074 .row &%never_users%&                 "do not run deliveries as these"
13075 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13076 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13077 .row &%trusted_groups%&              "groups that are trusted"
13078 .row &%trusted_users%&               "users that are trusted"
13079 .endtable
13080
13081
13082
13083 .section "Logging" "SECID99"
13084 .table2
13085 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13086 .row &%log_file_path%&               "override compiled-in value"
13087 .row &%log_selector%&                "set/unset optional logging"
13088 .row &%log_timezone%&                "add timezone to log lines"
13089 .row &%message_logs%&                "create per-message logs"
13090 .row &%preserve_message_logs%&       "after message completion"
13091 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13092 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13093 .row &%syslog_facility%&             "set syslog &""facility""& field"
13094 .row &%syslog_processname%&          "set syslog &""ident""& field"
13095 .row &%syslog_timestamp%&            "timestamp syslog lines"
13096 .row &%write_rejectlog%&             "control use of message log"
13097 .endtable
13098
13099
13100
13101 .section "Frozen messages" "SECID100"
13102 .table2
13103 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13104 .row &%freeze_tell%&                 "send message when freezing"
13105 .row &%move_frozen_messages%&        "to another directory"
13106 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13107 .endtable
13108
13109
13110
13111 .section "Data lookups" "SECID101"
13112 .table2
13113 .row &%ibase_servers%&               "InterBase servers"
13114 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13115 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13116 .row &%ldap_cert_file%&              "client cert file for LDAP"
13117 .row &%ldap_cert_key%&               "client key file for LDAP"
13118 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13119 .row &%ldap_default_servers%&        "used if no server in query"
13120 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13121 .row &%ldap_start_tls%&              "require TLS within LDAP"
13122 .row &%ldap_version%&                "set protocol version"
13123 .row &%lookup_open_max%&             "lookup files held open"
13124 .row &%mysql_servers%&               "default MySQL servers"
13125 .row &%oracle_servers%&              "Oracle servers"
13126 .row &%pgsql_servers%&               "default PostgreSQL servers"
13127 .row &%sqlite_lock_timeout%&         "as it says"
13128 .endtable
13129
13130
13131
13132 .section "Message ids" "SECID102"
13133 .table2
13134 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13135 .row &%message_id_header_text%&      "ditto"
13136 .endtable
13137
13138
13139
13140 .section "Embedded Perl Startup" "SECID103"
13141 .table2
13142 .row &%perl_at_start%&               "always start the interpreter"
13143 .row &%perl_startup%&                "code to obey when starting Perl"
13144 .endtable
13145
13146
13147
13148 .section "Daemon" "SECID104"
13149 .table2
13150 .row &%daemon_smtp_ports%&           "default ports"
13151 .row &%daemon_startup_retries%&      "number of times to retry"
13152 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13153 .row &%extra_local_interfaces%&      "not necessarily listened on"
13154 .row &%local_interfaces%&            "on which to listen, with optional ports"
13155 .row &%pid_file_path%&               "override compiled-in value"
13156 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13157 .endtable
13158
13159
13160
13161 .section "Resource control" "SECID105"
13162 .table2
13163 .row &%check_log_inodes%&            "before accepting a message"
13164 .row &%check_log_space%&             "before accepting a message"
13165 .row &%check_spool_inodes%&          "before accepting a message"
13166 .row &%check_spool_space%&           "before accepting a message"
13167 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13168 .row &%queue_only_load%&             "queue incoming if load high"
13169 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13170 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13171 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13172 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13173 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13174 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13175 .row &%smtp_accept_max_per_connection%& "messages per connection"
13176 .row &%smtp_accept_max_per_host%&    "connections from one host"
13177 .row &%smtp_accept_queue%&           "queue mail if more connections"
13178 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13179                                            connection"
13180 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13181 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13182 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13183 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13184 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13185 .endtable
13186
13187
13188
13189 .section "Policy controls" "SECID106"
13190 .table2
13191 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13192 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13193 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13194 .row &%acl_smtp_auth%&               "ACL for AUTH"
13195 .row &%acl_smtp_connect%&            "ACL for connection"
13196 .row &%acl_smtp_data%&               "ACL for DATA"
13197 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13198 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13199 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13200 .row &%acl_smtp_expn%&               "ACL for EXPN"
13201 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13202 .row &%acl_smtp_mail%&               "ACL for MAIL"
13203 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13204 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13205 .row &%acl_smtp_predata%&            "ACL for start of data"
13206 .row &%acl_smtp_quit%&               "ACL for QUIT"
13207 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13208 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13209 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13210 .row &%av_scanner%&                  "specify virus scanner"
13211 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13212                                       words""&"
13213 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13214 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13215 .row &%header_maxsize%&              "total size of message header"
13216 .row &%header_line_maxsize%&         "individual header line limit"
13217 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13218 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13219 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13220 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13221 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13222 .row &%host_lookup%&                 "host name looked up for these hosts"
13223 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13224 .row &%host_reject_connection%&      "reject connection from these hosts"
13225 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13226 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13227 .row &%message_size_limit%&          "for all messages"
13228 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13229 .row &%spamd_address%&               "set interface to SpamAssassin"
13230 .row &%strict_acl_vars%&             "object to unset ACL variables"
13231 .endtable
13232
13233
13234
13235 .section "Callout cache" "SECID107"
13236 .table2
13237 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13238                                          item"
13239 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13240                                          item"
13241 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13242 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13243 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13244 .endtable
13245
13246
13247
13248 .section "TLS" "SECID108"
13249 .table2
13250 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13251 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13252 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13253 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13254 .row &%tls_certificate%&             "location of server certificate"
13255 .row &%tls_crl%&                     "certificate revocation list"
13256 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13257 .row &%tls_dhparam%&                 "DH parameters for server"
13258 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13259 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13260 .row &%tls_privatekey%&              "location of server private key"
13261 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13262 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13263 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13264 .row &%tls_verify_certificates%&     "expected client certificates"
13265 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13266 .endtable
13267
13268
13269
13270 .section "Local user handling" "SECID109"
13271 .table2
13272 .row &%finduser_retries%&            "useful in NIS environments"
13273 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13274 .row &%gecos_pattern%&               "ditto"
13275 .row &%max_username_length%&         "for systems that truncate"
13276 .row &%unknown_login%&               "used when no login name found"
13277 .row &%unknown_username%&            "ditto"
13278 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13279 .row &%uucp_from_sender%&            "ditto"
13280 .endtable
13281
13282
13283
13284 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13285 .table2
13286 .row &%header_maxsize%&              "total size of message header"
13287 .row &%header_line_maxsize%&         "individual header line limit"
13288 .row &%message_size_limit%&          "applies to all messages"
13289 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13290 .row &%received_header_text%&        "expanded to make &'Received:'&"
13291 .row &%received_headers_max%&        "for mail loop detection"
13292 .row &%recipients_max%&              "limit per message"
13293 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13294 .endtable
13295
13296
13297
13298
13299 .section "Non-SMTP incoming messages" "SECID111"
13300 .table2
13301 .row &%receive_timeout%&             "for non-SMTP messages"
13302 .endtable
13303
13304
13305
13306
13307
13308 .section "Incoming SMTP messages" "SECID112"
13309 See also the &'Policy controls'& section above.
13310
13311 .table2
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 &%recipient_unqualified_hosts%& "may send unqualified recipients"
13315 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13316 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13317 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13318 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13319 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13320 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13321 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13322 .row &%smtp_accept_max_per_connection%& "messages per connection"
13323 .row &%smtp_accept_max_per_host%&    "connections from one host"
13324 .row &%smtp_accept_queue%&           "queue mail if more connections"
13325 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13326                                            connection"
13327 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13328 .row &%smtp_active_hostname%&        "host name to use in messages"
13329 .row &%smtp_banner%&                 "text for welcome banner"
13330 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13331 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13332 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13333 .row &%smtp_etrn_command%&           "what to run for ETRN"
13334 .row &%smtp_etrn_serialize%&         "only one at once"
13335 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13336 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13337 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13338 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13339 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13340 .row &%smtp_receive_timeout%&        "per command or data line"
13341 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13342 .row &%smtp_return_error_details%&   "give detail on rejections"
13343 .endtable
13344
13345
13346
13347 .section "SMTP extensions" "SECID113"
13348 .table2
13349 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13350 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13351 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13352 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13353 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13354 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13355 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13356 .endtable
13357
13358
13359
13360 .section "Processing messages" "SECID114"
13361 .table2
13362 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13363 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13364 .row &%allow_utf8_domains%&          "in addresses"
13365 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13366                                       words""&"
13367 .row &%delivery_date_remove%&        "from incoming messages"
13368 .row &%envelope_to_remove%&          "from incoming messages"
13369 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13370 .row &%headers_charset%&             "default for translations"
13371 .row &%qualify_domain%&              "default for senders"
13372 .row &%qualify_recipient%&           "default for recipients"
13373 .row &%return_path_remove%&          "from incoming messages"
13374 .row &%strip_excess_angle_brackets%& "in addresses"
13375 .row &%strip_trailing_dot%&          "at end of addresses"
13376 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13377 .endtable
13378
13379
13380
13381 .section "System filter" "SECID115"
13382 .table2
13383 .row &%system_filter%&               "locate system filter"
13384 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13385                                             directory"
13386 .row &%system_filter_file_transport%& "transport for delivery to a file"
13387 .row &%system_filter_group%&         "group for filter running"
13388 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13389 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13390 .row &%system_filter_user%&          "user for filter running"
13391 .endtable
13392
13393
13394
13395 .section "Routing and delivery" "SECID116"
13396 .table2
13397 .row &%disable_ipv6%&                "do no IPv6 processing"
13398 .row &%dns_again_means_nonexist%&    "for broken domains"
13399 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13400 .row &%dns_dnssec_ok%&               "parameter for resolver"
13401 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13402 .row &%dns_retrans%&                 "parameter for resolver"
13403 .row &%dns_retry%&                   "parameter for resolver"
13404 .row &%dns_use_edns0%&               "parameter for resolver"
13405 .row &%hold_domains%&                "hold delivery for these domains"
13406 .row &%local_interfaces%&            "for routing checks"
13407 .row &%queue_domains%&               "no immediate delivery for these"
13408 .row &%queue_only%&                  "no immediate delivery at all"
13409 .row &%queue_only_file%&             "no immediate delivery if file exists"
13410 .row &%queue_only_load%&             "no immediate delivery if load is high"
13411 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13412 .row &%queue_only_override%&         "allow command line to override"
13413 .row &%queue_run_in_order%&          "order of arrival"
13414 .row &%queue_run_max%&               "of simultaneous queue runners"
13415 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13416 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13417 .row &%remote_sort_domains%&         "order of remote deliveries"
13418 .row &%retry_data_expire%&           "timeout for retry data"
13419 .row &%retry_interval_max%&          "safety net for retry rules"
13420 .endtable
13421
13422
13423
13424 .section "Bounce and warning messages" "SECID117"
13425 .table2
13426 .row &%bounce_message_file%&         "content of bounce"
13427 .row &%bounce_message_text%&         "content of bounce"
13428 .row &%bounce_return_body%&          "include body if returning message"
13429 .row &%bounce_return_message%&       "include original message in bounce"
13430 .row &%bounce_return_size_limit%&    "limit on returned message"
13431 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13432 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13433 .row &%errors_copy%&                 "copy bounce messages"
13434 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13435 .row &%delay_warning%&               "time schedule"
13436 .row &%delay_warning_condition%&     "condition for warning messages"
13437 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13438 .row &%smtp_return_error_details%&   "give detail on rejections"
13439 .row &%warn_message_file%&           "content of warning message"
13440 .endtable
13441
13442
13443
13444 .section "Alphabetical list of main options" "SECTalomo"
13445 Those options that undergo string expansion before use are marked with
13446 &dagger;.
13447
13448 .option accept_8bitmime main boolean true
13449 .cindex "8BITMIME"
13450 .cindex "8-bit characters"
13451 .cindex "log" "selectors"
13452 .cindex "log" "8BITMIME"
13453 This option causes Exim to send 8BITMIME in its response to an SMTP
13454 EHLO command, and to accept the BODY= parameter on MAIL commands.
13455 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13456 takes no steps to do anything special with messages received by this route.
13457
13458 Historically Exim kept this option off by default, but the maintainers
13459 feel that in today's Internet, this causes more problems than it solves.
13460 It now defaults to true.
13461 A more detailed analysis of the issues is provided by Dan Bernstein:
13462 .display
13463 &url(http://cr.yp.to/smtp/8bitmime.html)
13464 .endd
13465
13466 To log received 8BITMIME status use
13467 .code
13468 log_selector = +8bitmime
13469 .endd
13470
13471 .option acl_not_smtp main string&!! unset
13472 .cindex "&ACL;" "for non-SMTP messages"
13473 .cindex "non-SMTP messages" "ACLs for"
13474 This option defines the ACL that is run when a non-SMTP message has been
13475 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13476 further details.
13477
13478 .option acl_not_smtp_mime main string&!! unset
13479 This option defines the ACL that is run for individual MIME parts of non-SMTP
13480 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13481 SMTP messages.
13482
13483 .option acl_not_smtp_start main string&!! unset
13484 .cindex "&ACL;" "at start of non-SMTP message"
13485 .cindex "non-SMTP messages" "ACLs for"
13486 This option defines the ACL that is run before Exim starts reading a
13487 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13488
13489 .option acl_smtp_auth main string&!! unset
13490 .cindex "&ACL;" "setting up for SMTP commands"
13491 .cindex "AUTH" "ACL for"
13492 This option defines the ACL that is run when an SMTP AUTH command is
13493 received. See chapter &<<CHAPACL>>& for further details.
13494
13495 .option acl_smtp_connect main string&!! unset
13496 .cindex "&ACL;" "on SMTP connection"
13497 This option defines the ACL that is run when an SMTP connection is received.
13498 See chapter &<<CHAPACL>>& for further details.
13499
13500 .option acl_smtp_data main string&!! unset
13501 .cindex "DATA" "ACL for"
13502 This option defines the ACL that is run after an SMTP DATA command has been
13503 processed and the message itself has been received, but before the final
13504 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13505
13506 .option acl_smtp_data_prdr main string&!! unset
13507 .cindex "DATA" "ACL for"
13508 .cindex "&ACL;" "PRDR-related"
13509 .cindex "&ACL;" "per-user data processing"
13510 This option defines the ACL that,
13511 if the PRDR feature has been negotiated,
13512 is run for each recipient after an SMTP DATA command has been
13513 processed and the message itself has been received, but before the
13514 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13515
13516 .option acl_smtp_etrn main string&!! unset
13517 .cindex "ETRN" "ACL for"
13518 This option defines the ACL that is run when an SMTP ETRN command is
13519 received. See chapter &<<CHAPACL>>& for further details.
13520
13521 .option acl_smtp_expn main string&!! unset
13522 .cindex "EXPN" "ACL for"
13523 This option defines the ACL that is run when an SMTP EXPN command is
13524 received. See chapter &<<CHAPACL>>& for further details.
13525
13526 .option acl_smtp_helo main string&!! unset
13527 .cindex "EHLO" "ACL for"
13528 .cindex "HELO" "ACL for"
13529 This option defines the ACL that is run when an SMTP EHLO or HELO
13530 command is received. See chapter &<<CHAPACL>>& for further details.
13531
13532
13533 .option acl_smtp_mail main string&!! unset
13534 .cindex "MAIL" "ACL for"
13535 This option defines the ACL that is run when an SMTP MAIL command is
13536 received. See chapter &<<CHAPACL>>& for further details.
13537
13538 .option acl_smtp_mailauth main string&!! unset
13539 .cindex "AUTH" "on MAIL command"
13540 This option defines the ACL that is run when there is an AUTH parameter on
13541 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13542 &<<CHAPSMTPAUTH>>& for details of authentication.
13543
13544 .option acl_smtp_mime main string&!! unset
13545 .cindex "MIME content scanning" "ACL for"
13546 This option is available when Exim is built with the content-scanning
13547 extension. It defines the ACL that is run for each MIME part in a message. See
13548 section &<<SECTscanmimepart>>& for details.
13549
13550 .option acl_smtp_predata main string&!! unset
13551 This option defines the ACL that is run when an SMTP DATA command is
13552 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13553 further details.
13554
13555 .option acl_smtp_quit main string&!! unset
13556 .cindex "QUIT, ACL for"
13557 This option defines the ACL that is run when an SMTP QUIT command is
13558 received. See chapter &<<CHAPACL>>& for further details.
13559
13560 .option acl_smtp_rcpt main string&!! unset
13561 .cindex "RCPT" "ACL for"
13562 This option defines the ACL that is run when an SMTP RCPT command is
13563 received. See chapter &<<CHAPACL>>& for further details.
13564
13565 .option acl_smtp_starttls main string&!! unset
13566 .cindex "STARTTLS, ACL for"
13567 This option defines the ACL that is run when an SMTP STARTTLS command is
13568 received. See chapter &<<CHAPACL>>& for further details.
13569
13570 .option acl_smtp_vrfy main string&!! unset
13571 .cindex "VRFY" "ACL for"
13572 This option defines the ACL that is run when an SMTP VRFY command is
13573 received. See chapter &<<CHAPACL>>& for further details.
13574
13575 .option admin_groups main "string list&!!" unset
13576 .cindex "admin user"
13577 This option is expanded just once, at the start of Exim's processing. If the
13578 current group or any of the supplementary groups of an Exim caller is in this
13579 colon-separated list, the caller has admin privileges. If all your system
13580 programmers are in a specific group, for example, you can give them all Exim
13581 admin privileges by putting that group in &%admin_groups%&. However, this does
13582 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13583 To permit this, you have to add individuals to the Exim group.
13584
13585 .option allow_domain_literals main boolean false
13586 .cindex "domain literal"
13587 If this option is set, the RFC 2822 domain literal format is permitted in
13588 email addresses. The option is not set by default, because the domain literal
13589 format is not normally required these days, and few people know about it. It
13590 has, however, been exploited by mail abusers.
13591
13592 Unfortunately, it seems that some DNS black list maintainers are using this
13593 format to report black listing to postmasters. If you want to accept messages
13594 addressed to your hosts by IP address, you need to set
13595 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13596 domains (defined in the named domain list &%local_domains%& in the default
13597 configuration). This &"magic string"& matches the domain literal form of all
13598 the local host's IP addresses.
13599
13600
13601 .option allow_mx_to_ip main boolean false
13602 .cindex "MX record" "pointing to IP address"
13603 It appears that more and more DNS zone administrators are breaking the rules
13604 and putting domain names that look like IP addresses on the right hand side of
13605 MX records. Exim follows the rules and rejects this, giving an error message
13606 that explains the mis-configuration. However, some other MTAs support this
13607 practice, so to avoid &"Why can't Exim do this?"& complaints,
13608 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13609 recommended, except when you have no other choice.
13610
13611 .option allow_utf8_domains main boolean false
13612 .cindex "domain" "UTF-8 characters in"
13613 .cindex "UTF-8" "in domain name"
13614 Lots of discussion is going on about internationalized domain names. One
13615 camp is strongly in favour of just using UTF-8 characters, and it seems
13616 that at least two other MTAs permit this. This option allows Exim users to
13617 experiment if they wish.
13618
13619 If it is set true, Exim's domain parsing function allows valid
13620 UTF-8 multicharacters to appear in domain name components, in addition to
13621 letters, digits, and hyphens. However, just setting this option is not
13622 enough; if you want to look up these domain names in the DNS, you must also
13623 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13624 suitable setting is:
13625 .code
13626 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13627   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13628 .endd
13629 Alternatively, you can just disable this feature by setting
13630 .code
13631 dns_check_names_pattern =
13632 .endd
13633 That is, set the option to an empty string so that no check is done.
13634
13635
13636 .option auth_advertise_hosts main "host list&!!" *
13637 .cindex "authentication" "advertising"
13638 .cindex "AUTH" "advertising"
13639 If any server authentication mechanisms are configured, Exim advertises them in
13640 response to an EHLO command only if the calling host matches this list.
13641 Otherwise, Exim does not advertise AUTH.
13642 Exim does not accept AUTH commands from clients to which it has not
13643 advertised the availability of AUTH. The advertising of individual
13644 authentication mechanisms can be controlled by the use of the
13645 &%server_advertise_condition%& generic authenticator option on the individual
13646 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13647
13648 Certain mail clients (for example, Netscape) require the user to provide a name
13649 and password for authentication if AUTH is advertised, even though it may
13650 not be needed (the host may accept messages from hosts on its local LAN without
13651 authentication, for example). The &%auth_advertise_hosts%& option can be used
13652 to make these clients more friendly by excluding them from the set of hosts to
13653 which Exim advertises AUTH.
13654
13655 .cindex "AUTH" "advertising when encrypted"
13656 If you want to advertise the availability of AUTH only when the connection
13657 is encrypted using TLS, you can make use of the fact that the value of this
13658 option is expanded, with a setting like this:
13659 .code
13660 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13661 .endd
13662 .vindex "&$tls_in_cipher$&"
13663 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13664 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13665 expansion is *, which matches all hosts.
13666
13667
13668 .option auto_thaw main time 0s
13669 .cindex "thawing messages"
13670 .cindex "unfreezing messages"
13671 If this option is set to a time greater than zero, a queue runner will try a
13672 new delivery attempt on any frozen message, other than a bounce message, if
13673 this much time has passed since it was frozen. This may result in the message
13674 being re-frozen if nothing has changed since the last attempt. It is a way of
13675 saying &"keep on trying, even though there are big problems"&.
13676
13677 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13678 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13679 thought to be very useful any more, and its use should probably be avoided.
13680
13681
13682 .option av_scanner main string "see below"
13683 This option is available if Exim is built with the content-scanning extension.
13684 It specifies which anti-virus scanner to use. The default value is:
13685 .code
13686 sophie:/var/run/sophie
13687 .endd
13688 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13689 before use. See section &<<SECTscanvirus>>& for further details.
13690
13691
13692 .option bi_command main string unset
13693 .oindex "&%-bi%&"
13694 This option supplies the name of a command that is run when Exim is called with
13695 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13696 just the command name, it is not a complete command line. If an argument is
13697 required, it must come from the &%-oA%& command line option.
13698
13699
13700 .option bounce_message_file main string unset
13701 .cindex "bounce message" "customizing"
13702 .cindex "customizing" "bounce message"
13703 This option defines a template file containing paragraphs of text to be used
13704 for constructing bounce messages.  Details of the file's contents are given in
13705 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13706
13707
13708 .option bounce_message_text main string unset
13709 When this option is set, its contents are included in the default bounce
13710 message immediately after &"This message was created automatically by mail
13711 delivery software."& It is not used if &%bounce_message_file%& is set.
13712
13713 .option bounce_return_body main boolean true
13714 .cindex "bounce message" "including body"
13715 This option controls whether the body of an incoming message is included in a
13716 bounce message when &%bounce_return_message%& is true. The default setting
13717 causes the entire message, both header and body, to be returned (subject to the
13718 value of &%bounce_return_size_limit%&). If this option is false, only the
13719 message header is included. In the case of a non-SMTP message containing an
13720 error that is detected during reception, only those header lines preceding the
13721 point at which the error was detected are returned.
13722 .cindex "bounce message" "including original"
13723
13724 .option bounce_return_message main boolean true
13725 If this option is set false, none of the original message is included in
13726 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13727 &%bounce_return_body%&.
13728
13729
13730 .option bounce_return_size_limit main integer 100K
13731 .cindex "size" "of bounce, limit"
13732 .cindex "bounce message" "size limit"
13733 .cindex "limit" "bounce message size"
13734 This option sets a limit in bytes on the size of messages that are returned to
13735 senders as part of bounce messages when &%bounce_return_message%& is true. The
13736 limit should be less than the value of the global &%message_size_limit%& and of
13737 any &%message_size_limit%& settings on transports, to allow for the bounce text
13738 that Exim generates. If this option is set to zero there is no limit.
13739
13740 When the body of any message that is to be included in a bounce message is
13741 greater than the limit, it is truncated, and a comment pointing this out is
13742 added at the top. The actual cutoff may be greater than the value given, owing
13743 to the use of buffering for transferring the message in chunks (typically 8K in
13744 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13745 messages.
13746
13747 .option bounce_sender_authentication main string unset
13748 .cindex "bounce message" "sender authentication"
13749 .cindex "authentication" "bounce message"
13750 .cindex "AUTH" "on bounce message"
13751 This option provides an authenticated sender address that is sent with any
13752 bounce messages generated by Exim that are sent over an authenticated SMTP
13753 connection. A typical setting might be:
13754 .code
13755 bounce_sender_authentication = mailer-daemon@my.domain.example
13756 .endd
13757 which would cause bounce messages to be sent using the SMTP command:
13758 .code
13759 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13760 .endd
13761 The value of &%bounce_sender_authentication%& must always be a complete email
13762 address.
13763
13764 .option callout_domain_negative_expire main time 3h
13765 .cindex "caching" "callout timeouts"
13766 .cindex "callout" "caching timeouts"
13767 This option specifies the expiry time for negative callout cache data for a
13768 domain. See section &<<SECTcallver>>& for details of callout verification, and
13769 section &<<SECTcallvercache>>& for details of the caching.
13770
13771
13772 .option callout_domain_positive_expire main time 7d
13773 This option specifies the expiry time for positive callout cache data for a
13774 domain. See section &<<SECTcallver>>& for details of callout verification, and
13775 section &<<SECTcallvercache>>& for details of the caching.
13776
13777
13778 .option callout_negative_expire main time 2h
13779 This option specifies the expiry time for negative callout cache data for an
13780 address. See section &<<SECTcallver>>& for details of callout verification, and
13781 section &<<SECTcallvercache>>& for details of the caching.
13782
13783
13784 .option callout_positive_expire main time 24h
13785 This option specifies the expiry time for positive callout cache data for an
13786 address. See section &<<SECTcallver>>& for details of callout verification, and
13787 section &<<SECTcallvercache>>& for details of the caching.
13788
13789
13790 .option callout_random_local_part main string&!! "see below"
13791 This option defines the &"random"& local part that can be used as part of
13792 callout verification. The default value is
13793 .code
13794 $primary_hostname-$tod_epoch-testing
13795 .endd
13796 See section &<<CALLaddparcall>>& for details of how this value is used.
13797
13798
13799 .option check_log_inodes main integer 0
13800 See &%check_spool_space%& below.
13801
13802
13803 .option check_log_space main integer 0
13804 See &%check_spool_space%& below.
13805
13806 .oindex "&%check_rfc2047_length%&"
13807 .cindex "RFC 2047" "disabling length check"
13808 .option check_rfc2047_length main boolean true
13809 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13810 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13811 word; strings to be encoded that exceed this length are supposed to use
13812 multiple encoded words. By default, Exim does not recognize encoded words that
13813 exceed the maximum length. However, it seems that some software, in violation
13814 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13815 set false, Exim recognizes encoded words of any length.
13816
13817
13818 .option check_spool_inodes main integer 0
13819 See &%check_spool_space%& below.
13820
13821
13822 .option check_spool_space main integer 0
13823 .cindex "checking disk space"
13824 .cindex "disk space, checking"
13825 .cindex "spool directory" "checking space"
13826 The four &%check_...%& options allow for checking of disk resources before a
13827 message is accepted.
13828
13829 .vindex "&$log_inodes$&"
13830 .vindex "&$log_space$&"
13831 .vindex "&$spool_inodes$&"
13832 .vindex "&$spool_space$&"
13833 When any of these options are set, they apply to all incoming messages. If you
13834 want to apply different checks to different kinds of message, you can do so by
13835 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13836 &$spool_space$& in an ACL with appropriate additional conditions.
13837
13838
13839 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13840 either value is greater than zero, for example:
13841 .code
13842 check_spool_space = 10M
13843 check_spool_inodes = 100
13844 .endd
13845 The spool partition is the one that contains the directory defined by
13846 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13847 transit.
13848
13849 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13850 files are written if either is greater than zero. These should be set only if
13851 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13852
13853 If there is less space or fewer inodes than requested, Exim refuses to accept
13854 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13855 error response to the MAIL command. If ESMTP is in use and there was a
13856 SIZE parameter on the MAIL command, its value is added to the
13857 &%check_spool_space%& value, and the check is performed even if
13858 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13859
13860 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13861 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13862
13863 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13864 failure a message is written to stderr and Exim exits with a non-zero code, as
13865 it obviously cannot send an error message of any kind.
13866
13867 .option daemon_smtp_ports main string &`smtp`&
13868 .cindex "port" "for daemon"
13869 .cindex "TCP/IP" "setting listening ports"
13870 This option specifies one or more default SMTP ports on which the Exim daemon
13871 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13872 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13873
13874 .option daemon_startup_retries main integer 9
13875 .cindex "daemon startup, retrying"
13876 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13877 the daemon at startup when it cannot immediately bind a listening socket
13878 (typically because the socket is already in use): &%daemon_startup_retries%&
13879 defines the number of retries after the first failure, and
13880 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13881
13882 .option daemon_startup_sleep main time 30s
13883 See &%daemon_startup_retries%&.
13884
13885 .option delay_warning main "time list" 24h
13886 .cindex "warning of delay"
13887 .cindex "delay warning, specifying"
13888 When a message is delayed, Exim sends a warning message to the sender at
13889 intervals specified by this option. The data is a colon-separated list of times
13890 after which to send warning messages. If the value of the option is an empty
13891 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13892 message has been on the queue for longer than the last time, the last interval
13893 between the times is used to compute subsequent warning times. For example,
13894 with
13895 .code
13896 delay_warning = 4h:8h:24h
13897 .endd
13898 the first message is sent after 4 hours, the second after 8 hours, and
13899 the third one after 24 hours. After that, messages are sent every 16 hours,
13900 because that is the interval between the last two times on the list. If you set
13901 just one time, it specifies the repeat interval. For example, with:
13902 .code
13903 delay_warning = 6h
13904 .endd
13905 messages are repeated every six hours. To stop warnings after a given time, set
13906 a very large time at the end of the list. For example:
13907 .code
13908 delay_warning = 2h:12h:99d
13909 .endd
13910 Note that the option is only evaluated at the time a delivery attempt fails,
13911 which depends on retry and queue-runner configuration.
13912 Typically retries will be configured more frequently than warning messages.
13913
13914 .option delay_warning_condition main string&!! "see below"
13915 .vindex "&$domain$&"
13916 The string is expanded at the time a warning message might be sent. If all the
13917 deferred addresses have the same domain, it is set in &$domain$& during the
13918 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13919 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13920 &"false"& (the comparison being done caselessly) then the warning message is
13921 not sent. The default is:
13922 .code
13923 delay_warning_condition = ${if or {\
13924   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13925   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13926   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13927   } {no}{yes}}
13928 .endd
13929 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13930 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13931 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13932 &"auto-replied"& in an &'Auto-Submitted:'& header.
13933
13934 .option deliver_drop_privilege main boolean false
13935 .cindex "unprivileged delivery"
13936 .cindex "delivery" "unprivileged"
13937 If this option is set true, Exim drops its root privilege at the start of a
13938 delivery process, and runs as the Exim user throughout. This severely restricts
13939 the kinds of local delivery that are possible, but is viable in certain types
13940 of configuration. There is a discussion about the use of root privilege in
13941 chapter &<<CHAPsecurity>>&.
13942
13943 .option deliver_queue_load_max main fixed-point unset
13944 .cindex "load average"
13945 .cindex "queue runner" "abandoning"
13946 When this option is set, a queue run is abandoned if the system load average
13947 becomes greater than the value of the option. The option has no effect on
13948 ancient operating systems on which Exim cannot determine the load average.
13949 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13950
13951
13952 .option delivery_date_remove main boolean true
13953 .cindex "&'Delivery-date:'& header line"
13954 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13955 message when it is delivered, in exactly the same way as &'Return-path:'& is
13956 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13957 should not be present in incoming messages, and this option causes them to be
13958 removed at the time the message is received, to avoid any problems that might
13959 occur when a delivered message is subsequently sent on to some other recipient.
13960
13961 .option disable_fsync main boolean false
13962 .cindex "&[fsync()]&, disabling"
13963 This option is available only if Exim was built with the compile-time option
13964 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13965 a runtime configuration generates an &"unknown option"& error. You should not
13966 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13967 really, really, really understand what you are doing. &'No pre-compiled
13968 distributions of Exim should ever make this option available.'&
13969
13970 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13971 updated files' data to be written to disc before continuing. Unexpected events
13972 such as crashes and power outages may cause data to be lost or scrambled.
13973 Here be Dragons. &*Beware.*&
13974
13975
13976 .option disable_ipv6 main boolean false
13977 .cindex "IPv6" "disabling"
13978 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13979 activities take place. AAAA records are never looked up, and any IPv6 addresses
13980 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13981 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13982 to handle IPv6 literal addresses.
13983
13984
13985 .option dns_again_means_nonexist main "domain list&!!" unset
13986 .cindex "DNS" "&""try again""& response; overriding"
13987 DNS lookups give a &"try again"& response for the DNS errors
13988 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13989 keep trying to deliver a message, or to give repeated temporary errors to
13990 incoming mail. Sometimes the effect is caused by a badly set up name server and
13991 may persist for a long time. If a domain which exhibits this problem matches
13992 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13993 This option should be used with care. You can make it apply to reverse lookups
13994 by a setting such as this:
13995 .code
13996 dns_again_means_nonexist = *.in-addr.arpa
13997 .endd
13998 This option applies to all DNS lookups that Exim does. It also applies when the
13999 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14000 since these are most likely to be caused by DNS lookup problems. The
14001 &(dnslookup)& router has some options of its own for controlling what happens
14002 when lookups for MX or SRV records give temporary errors. These more specific
14003 options are applied after this global option.
14004
14005 .option dns_check_names_pattern main string "see below"
14006 .cindex "DNS" "pre-check of name syntax"
14007 When this option is set to a non-empty string, it causes Exim to check domain
14008 names for characters that are not allowed in host names before handing them to
14009 the DNS resolver, because some resolvers give temporary errors for names that
14010 contain unusual characters. If a domain name contains any unwanted characters,
14011 a &"not found"& result is forced, and the resolver is not called. The check is
14012 done by matching the domain name against a regular expression, which is the
14013 value of this option. The default pattern is
14014 .code
14015 dns_check_names_pattern = \
14016   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14017 .endd
14018 which permits only letters, digits, slashes, and hyphens in components, but
14019 they must start and end with a letter or digit. Slashes are not, in fact,
14020 permitted in host names, but they are found in certain NS records (which can be
14021 accessed in Exim by using a &%dnsdb%& lookup). If you set
14022 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14023 empty string.
14024
14025 .option dns_csa_search_limit main integer 5
14026 This option controls the depth of parental searching for CSA SRV records in the
14027 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14028
14029 .option dns_csa_use_reverse main boolean true
14030 This option controls whether or not an IP address, given as a CSA domain, is
14031 reversed and looked up in the reverse DNS, as described in more detail in
14032 section &<<SECTverifyCSA>>&.
14033
14034
14035 .option dns_dnssec_ok main integer -1
14036 .cindex "DNS" "resolver options"
14037 .cindex "DNS" "DNSSEC"
14038 If this option is set to a non-negative number then Exim will initialise the
14039 DNS resolver library to either use or not use DNSSEC, overriding the system
14040 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14041
14042 If the resolver library does not support DNSSEC then this option has no effect.
14043
14044
14045 .option dns_ipv4_lookup main "domain list&!!" unset
14046 .cindex "IPv6" "DNS lookup for AAAA records"
14047 .cindex "DNS" "IPv6 lookup for AAAA records"
14048 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14049 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14050 (A records) when trying to find IP addresses for hosts, unless the host's
14051 domain matches this list.
14052
14053 This is a fudge to help with name servers that give big delays or otherwise do
14054 not work for the AAAA record type. In due course, when the world's name
14055 servers have all been upgraded, there should be no need for this option.
14056
14057
14058 .option dns_retrans main time 0s
14059 .cindex "DNS" "resolver options"
14060 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14061 retransmission and retry parameters for DNS lookups. Values of zero (the
14062 defaults) leave the system default settings unchanged. The first value is the
14063 time between retries, and the second is the number of retries. It isn't
14064 totally clear exactly how these settings affect the total time a DNS lookup may
14065 take. I haven't found any documentation about timeouts on DNS lookups; these
14066 parameter values are available in the external resolver interface structure,
14067 but nowhere does it seem to describe how they are used or what you might want
14068 to set in them.
14069
14070
14071 .option dns_retry main integer 0
14072 See &%dns_retrans%& above.
14073
14074
14075 .option dns_use_edns0 main integer -1
14076 .cindex "DNS" "resolver options"
14077 .cindex "DNS" "EDNS0"
14078 If this option is set to a non-negative number then Exim will initialise the
14079 DNS resolver library to either use or not use EDNS0 extensions, overriding
14080 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14081 on.
14082
14083 If the resolver library does not support EDNS0 then this option has no effect.
14084
14085
14086 .option drop_cr main boolean false
14087 This is an obsolete option that is now a no-op. It used to affect the way Exim
14088 handled CR and LF characters in incoming messages. What happens now is
14089 described in section &<<SECTlineendings>>&.
14090
14091 .option dsn_from main "string&!!" "see below"
14092 .cindex "&'From:'& header line" "in bounces"
14093 .cindex "bounce messages" "&'From:'& line, specifying"
14094 This option can be used to vary the contents of &'From:'& header lines in
14095 bounces and other automatically generated messages (&"Delivery Status
14096 Notifications"& &-- hence the name of the option). The default setting is:
14097 .code
14098 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14099 .endd
14100 The value is expanded every time it is needed. If the expansion fails, a
14101 panic is logged, and the default value is used.
14102
14103 .option envelope_to_remove main boolean true
14104 .cindex "&'Envelope-to:'& header line"
14105 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14106 message when it is delivered, in exactly the same way as &'Return-path:'& is
14107 handled. &'Envelope-to:'& records the original recipient address from the
14108 messages's envelope that caused the delivery to happen. Such headers should not
14109 be present in incoming messages, and this option causes them to be removed at
14110 the time the message is received, to avoid any problems that might occur when a
14111 delivered message is subsequently sent on to some other recipient.
14112
14113
14114 .option errors_copy main "string list&!!" unset
14115 .cindex "bounce message" "copy to other address"
14116 .cindex "copy of bounce message"
14117 Setting this option causes Exim to send bcc copies of bounce messages that it
14118 generates to other addresses. &*Note*&: This does not apply to bounce messages
14119 coming from elsewhere. The value of the option is a colon-separated list of
14120 items. Each item consists of a pattern, terminated by white space, followed by
14121 a comma-separated list of email addresses. If a pattern contains spaces, it
14122 must be enclosed in double quotes.
14123
14124 Each pattern is processed in the same way as a single item in an address list
14125 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14126 the bounce message, the message is copied to the addresses on the list. The
14127 items are scanned in order, and once a matching one is found, no further items
14128 are examined. For example:
14129 .code
14130 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14131               rqps@mydomain   hostmaster@mydomain.example,\
14132                               postmaster@mydomain.example
14133 .endd
14134 .vindex "&$domain$&"
14135 .vindex "&$local_part$&"
14136 The address list is expanded before use. The expansion variables &$local_part$&
14137 and &$domain$& are set from the original recipient of the error message, and if
14138 there was any wildcard matching in the pattern, the expansion
14139 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14140 variables &$0$&, &$1$&, etc. are set in the normal way.
14141
14142
14143 .option errors_reply_to main string unset
14144 .cindex "bounce message" "&'Reply-to:'& in"
14145 By default, Exim's bounce and delivery warning messages contain the header line
14146 .display
14147 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14148 .endd
14149 .oindex &%quota_warn_message%&
14150 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14151 A warning message that is generated by the &%quota_warn_message%& option in an
14152 &(appendfile)& transport may contain its own &'From:'& header line that
14153 overrides the default.
14154
14155 Experience shows that people reply to bounce messages. If the
14156 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14157 and warning messages. For example:
14158 .code
14159 errors_reply_to = postmaster@my.domain.example
14160 .endd
14161 The value of the option is not expanded. It must specify a valid RFC 2822
14162 address. However, if a warning message that is generated by the
14163 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14164 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14165 not used.
14166
14167
14168 .option exim_group main string "compile-time configured"
14169 .cindex "gid (group id)" "Exim's own"
14170 .cindex "Exim group"
14171 This option changes the gid under which Exim runs when it gives up root
14172 privilege. The default value is compiled into the binary. The value of this
14173 option is used only when &%exim_user%& is also set. Unless it consists entirely
14174 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14175 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14176 security issues.
14177
14178
14179 .option exim_path main string "see below"
14180 .cindex "Exim binary, path name"
14181 This option specifies the path name of the Exim binary, which is used when Exim
14182 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14183 the directory configured at compile time by the BIN_DIRECTORY setting. It
14184 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14185 other place.
14186 &*Warning*&: Do not use a macro to define the value of this option, because
14187 you will break those Exim utilities that scan the configuration file to find
14188 where the binary is. (They then use the &%-bP%& option to extract option
14189 settings such as the value of &%spool_directory%&.)
14190
14191
14192 .option exim_user main string "compile-time configured"
14193 .cindex "uid (user id)" "Exim's own"
14194 .cindex "Exim user"
14195 This option changes the uid under which Exim runs when it gives up root
14196 privilege. The default value is compiled into the binary. Ownership of the run
14197 time configuration file and the use of the &%-C%& and &%-D%& command line
14198 options is checked against the values in the binary, not what is set here.
14199
14200 Unless it consists entirely of digits, the string is looked up using
14201 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14202 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14203 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14204
14205
14206 .option extra_local_interfaces main "string list" unset
14207 This option defines network interfaces that are to be considered local when
14208 routing, but which are not used for listening by the daemon. See section
14209 &<<SECTreclocipadd>>& for details.
14210
14211
14212 . Allow this long option name to split; give it unsplit as a fifth argument
14213 . for the automatic .oindex that is generated by .option.
14214
14215 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14216          extract_addresses_remove_arguments
14217 .oindex "&%-t%&"
14218 .cindex "command line" "addresses with &%-t%&"
14219 .cindex "Sendmail compatibility" "&%-t%& option"
14220 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14221 are present on the command line when the &%-t%& option is used to build an
14222 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14223 line addresses are removed from the recipients list. This is also how Smail
14224 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14225 command line addresses are added to those obtained from the header lines. When
14226 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14227 argument headers. If it is set false, Exim adds rather than removes argument
14228 addresses.
14229
14230
14231 .option finduser_retries main integer 0
14232 .cindex "NIS, retrying user lookups"
14233 On systems running NIS or other schemes in which user and group information is
14234 distributed from a remote system, there can be times when &[getpwnam()]& and
14235 related functions fail, even when given valid data, because things time out.
14236 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14237 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14238 many extra times to find a user or a group, waiting for one second between
14239 retries.
14240
14241 .cindex "&_/etc/passwd_&" "multiple reading of"
14242 You should not set this option greater than zero if your user information is in
14243 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14244 search the file multiple times for non-existent users, and also cause delay.
14245
14246
14247
14248 .option freeze_tell main "string list, comma separated" unset
14249 .cindex "freezing messages" "sending a message when freezing"
14250 On encountering certain errors, or when configured to do so in a system filter,
14251 ACL, or special router, Exim freezes a message. This means that no further
14252 delivery attempts take place until an administrator thaws the message, or the
14253 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14254 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14255 warning message whenever it freezes something, unless the message it is
14256 freezing is a locally-generated bounce message. (Without this exception there
14257 is the possibility of looping.) The warning message is sent to the addresses
14258 supplied as the comma-separated value of this option. If several of the
14259 message's addresses cause freezing, only a single message is sent. If the
14260 freezing was automatic, the reason(s) for freezing can be found in the message
14261 log. If you configure freezing in a filter or ACL, you must arrange for any
14262 logging that you require.
14263
14264
14265 .option gecos_name main string&!! unset
14266 .cindex "HP-UX"
14267 .cindex "&""gecos""& field, parsing"
14268 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14269 password file to hold other information in addition to users' real names. Exim
14270 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14271 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14272 of the field are used unchanged, except that, if an ampersand is encountered,
14273 it is replaced by the user's login name with the first character forced to
14274 upper case, since this is a convention that is observed on many systems.
14275
14276 When these options are set, &%gecos_pattern%& is treated as a regular
14277 expression that is to be applied to the field (again with && replaced by the
14278 login name), and if it matches, &%gecos_name%& is expanded and used as the
14279 user's name.
14280
14281 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14282 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14283 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14284 name terminates at the first comma, the following can be used:
14285 .code
14286 gecos_pattern = ([^,]*)
14287 gecos_name = $1
14288 .endd
14289
14290 .option gecos_pattern main string unset
14291 See &%gecos_name%& above.
14292
14293
14294 .option gnutls_compat_mode main boolean unset
14295 This option controls whether GnuTLS is used in compatibility mode in an Exim
14296 server. This reduces security slightly, but improves interworking with older
14297 implementations of TLS.
14298
14299
14300 option gnutls_allow_auto_pkcs11 main boolean unset
14301 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14302 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14303
14304 See
14305 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14306 for documentation.
14307
14308
14309
14310 .option headers_charset main string "see below"
14311 This option sets a default character set for translating from encoded MIME
14312 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14313 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14314 ultimate default is ISO-8859-1. For more details see the description of header
14315 insertions in section &<<SECTexpansionitems>>&.
14316
14317
14318
14319 .option header_maxsize main integer "see below"
14320 .cindex "header section" "maximum size of"
14321 .cindex "limit" "size of message header section"
14322 This option controls the overall maximum size of a message's header
14323 section. The default is the value of HEADER_MAXSIZE in
14324 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14325 sections are rejected.
14326
14327
14328 .option header_line_maxsize main integer 0
14329 .cindex "header lines" "maximum size of"
14330 .cindex "limit" "size of one header line"
14331 This option limits the length of any individual header line in a message, after
14332 all the continuations have been joined together. Messages with individual
14333 header lines that are longer than the limit are rejected. The default value of
14334 zero means &"no limit"&.
14335
14336
14337
14338
14339 .option helo_accept_junk_hosts main "host list&!!" unset
14340 .cindex "HELO" "accepting junk data"
14341 .cindex "EHLO" "accepting junk data"
14342 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14343 mail, and gives an error response for invalid data. Unfortunately, there are
14344 some SMTP clients that send syntactic junk. They can be accommodated by setting
14345 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14346 if you want to do semantic checking.
14347 See also &%helo_allow_chars%& for a way of extending the permitted character
14348 set.
14349
14350
14351 .option helo_allow_chars main string unset
14352 .cindex "HELO" "underscores in"
14353 .cindex "EHLO" "underscores in"
14354 .cindex "underscore in EHLO/HELO"
14355 This option can be set to a string of rogue characters that are permitted in
14356 all EHLO and HELO names in addition to the standard letters, digits,
14357 hyphens, and dots. If you really must allow underscores, you can set
14358 .code
14359 helo_allow_chars = _
14360 .endd
14361 Note that the value is one string, not a list.
14362
14363
14364 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14365 .cindex "HELO" "forcing reverse lookup"
14366 .cindex "EHLO" "forcing reverse lookup"
14367 If the domain given by a client in a HELO or EHLO command matches this
14368 list, a reverse lookup is done in order to establish the host's true name. The
14369 default forces a lookup if the client host gives the server's name or any of
14370 its IP addresses (in brackets), something that broken clients have been seen to
14371 do.
14372
14373
14374 .option helo_try_verify_hosts main "host list&!!" unset
14375 .cindex "HELO verifying" "optional"
14376 .cindex "EHLO" "verifying, optional"
14377 By default, Exim just checks the syntax of HELO and EHLO commands (see
14378 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14379 to do more extensive checking of the data supplied by these commands. The ACL
14380 condition &`verify = helo`& is provided to make this possible.
14381 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14382 to force the check to occur. From release 4.53 onwards, this is no longer
14383 necessary. If the check has not been done before &`verify = helo`& is
14384 encountered, it is done at that time. Consequently, this option is obsolete.
14385 Its specification is retained here for backwards compatibility.
14386
14387 When an EHLO or HELO command is received, if the calling host matches
14388 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14389 EHLO command either:
14390
14391 .ilist
14392 is an IP literal matching the calling address of the host, or
14393 .next
14394 .cindex "DNS" "reverse lookup"
14395 .cindex "reverse DNS lookup"
14396 matches the host name that Exim obtains by doing a reverse lookup of the
14397 calling host address, or
14398 .next
14399 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14400 available) yields the calling host address.
14401 .endlist
14402
14403 However, the EHLO or HELO command is not rejected if any of the checks
14404 fail. Processing continues, but the result of the check is remembered, and can
14405 be detected later in an ACL by the &`verify = helo`& condition.
14406
14407 .option helo_verify_hosts main "host list&!!" unset
14408 .cindex "HELO verifying" "mandatory"
14409 .cindex "EHLO" "verifying, mandatory"
14410 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14411 backwards compatibility. For hosts that match this option, Exim checks the host
14412 name given in the HELO or EHLO in the same way as for
14413 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14414 rejected with a 550 error, and entries are written to the main and reject logs.
14415 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14416 error.
14417
14418 .option hold_domains main "domain list&!!" unset
14419 .cindex "domain" "delaying delivery"
14420 .cindex "delivery" "delaying certain domains"
14421 This option allows mail for particular domains to be held on the queue
14422 manually. The option is overridden if a message delivery is forced with the
14423 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14424 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14425 item in &%hold_domains%&, no routing or delivery for that address is done, and
14426 it is deferred every time the message is looked at.
14427
14428 This option is intended as a temporary operational measure for delaying the
14429 delivery of mail while some problem is being sorted out, or some new
14430 configuration tested. If you just want to delay the processing of some
14431 domains until a queue run occurs, you should use &%queue_domains%& or
14432 &%queue_smtp_domains%&, not &%hold_domains%&.
14433
14434 A setting of &%hold_domains%& does not override Exim's code for removing
14435 messages from the queue if they have been there longer than the longest retry
14436 time in any retry rule. If you want to hold messages for longer than the normal
14437 retry times, insert a dummy retry rule with a long retry time.
14438
14439
14440 .option host_lookup main "host list&!!" unset
14441 .cindex "host name" "lookup, forcing"
14442 Exim does not look up the name of a calling host from its IP address unless it
14443 is required to compare against some host list, or the host matches
14444 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14445 option (which normally contains IP addresses rather than host names). The
14446 default configuration file contains
14447 .code
14448 host_lookup = *
14449 .endd
14450 which causes a lookup to happen for all hosts. If the expense of these lookups
14451 is felt to be too great, the setting can be changed or removed.
14452
14453 After a successful reverse lookup, Exim does a forward lookup on the name it
14454 has obtained, to verify that it yields the IP address that it started with. If
14455 this check fails, Exim behaves as if the name lookup failed.
14456
14457 .vindex "&$host_lookup_failed$&"
14458 .vindex "&$sender_host_name$&"
14459 After any kind of failure, the host name (in &$sender_host_name$&) remains
14460 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14461 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14462 &`verify = reverse_host_lookup`& in ACLs.
14463
14464
14465 .option host_lookup_order main "string list" &`bydns:byaddr`&
14466 This option specifies the order of different lookup methods when Exim is trying
14467 to find a host name from an IP address. The default is to do a DNS lookup
14468 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14469 if that fails. You can change the order of these lookups, or omit one entirely,
14470 if you want.
14471
14472 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14473 multiple PTR records in the DNS and the IP address is not listed in
14474 &_/etc/hosts_&. Different operating systems give different results in this
14475 case. That is why the default tries a DNS lookup first.
14476
14477
14478
14479 .option host_reject_connection main "host list&!!" unset
14480 .cindex "host" "rejecting connections from"
14481 If this option is set, incoming SMTP calls from the hosts listed are rejected
14482 as soon as the connection is made.
14483 This option is obsolete, and retained only for backward compatibility, because
14484 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14485 connections immediately.
14486
14487 The ability to give an immediate rejection (either by this option or using an
14488 ACL) is provided for use in unusual cases. Many hosts will just try again,
14489 sometimes without much delay. Normally, it is better to use an ACL to reject
14490 incoming messages at a later stage, such as after RCPT commands. See
14491 chapter &<<CHAPACL>>&.
14492
14493
14494 .option hosts_connection_nolog main "host list&!!" unset
14495 .cindex "host" "not logging connections from"
14496 This option defines a list of hosts for which connection logging does not
14497 happen, even though the &%smtp_connection%& log selector is set. For example,
14498 you might want not to log SMTP connections from local processes, or from
14499 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14500 the daemon; you should therefore strive to restrict its value to a short inline
14501 list of IP addresses and networks. To disable logging SMTP connections from
14502 local processes, you must create a host list with an empty item. For example:
14503 .code
14504 hosts_connection_nolog = :
14505 .endd
14506 If the &%smtp_connection%& log selector is not set, this option has no effect.
14507
14508
14509
14510 .option hosts_treat_as_local main "domain list&!!" unset
14511 .cindex "local host" "domains treated as"
14512 .cindex "host" "treated as local"
14513 If this option is set, any host names that match the domain list are treated as
14514 if they were the local host when Exim is scanning host lists obtained from MX
14515 records
14516 or other sources. Note that the value of this option is a domain list, not a
14517 host list, because it is always used to check host names, not IP addresses.
14518
14519 This option also applies when Exim is matching the special items
14520 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14521 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14522 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14523 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14524 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14525 interfaces and recognizing the local host.
14526
14527
14528 .option ibase_servers main "string list" unset
14529 .cindex "InterBase" "server list"
14530 This option provides a list of InterBase servers and associated connection data,
14531 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14532 The option is available only if Exim has been built with InterBase support.
14533
14534
14535
14536 .option ignore_bounce_errors_after main time 10w
14537 .cindex "bounce message" "discarding"
14538 .cindex "discarding bounce message"
14539 This option affects the processing of bounce messages that cannot be delivered,
14540 that is, those that suffer a permanent delivery failure. (Bounce messages that
14541 suffer temporary delivery failures are of course retried in the usual way.)
14542
14543 After a permanent delivery failure, bounce messages are frozen,
14544 because there is no sender to whom they can be returned. When a frozen bounce
14545 message has been on the queue for more than the given time, it is unfrozen at
14546 the next queue run, and a further delivery is attempted. If delivery fails
14547 again, the bounce message is discarded. This makes it possible to keep failed
14548 bounce messages around for a shorter time than the normal maximum retry time
14549 for frozen messages. For example,
14550 .code
14551 ignore_bounce_errors_after = 12h
14552 .endd
14553 retries failed bounce message deliveries after 12 hours, discarding any further
14554 failures. If the value of this option is set to a zero time period, bounce
14555 failures are discarded immediately. Setting a very long time (as in the default
14556 value) has the effect of disabling this option. For ways of automatically
14557 dealing with other kinds of frozen message, see &%auto_thaw%& and
14558 &%timeout_frozen_after%&.
14559
14560
14561 .option ignore_fromline_hosts main "host list&!!" unset
14562 .cindex "&""From""& line"
14563 .cindex "UUCP" "&""From""& line"
14564 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14565 the headers of a message. By default this is treated as the start of the
14566 message's body, which means that any following headers are not recognized as
14567 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14568 match those hosts that insist on sending it. If the sender is actually a local
14569 process rather than a remote host, and is using &%-bs%& to inject the messages,
14570 &%ignore_fromline_local%& must be set to achieve this effect.
14571
14572
14573 .option ignore_fromline_local main boolean false
14574 See &%ignore_fromline_hosts%& above.
14575
14576
14577 .option keep_malformed main time 4d
14578 This option specifies the length of time to keep messages whose spool files
14579 have been corrupted in some way. This should, of course, never happen. At the
14580 next attempt to deliver such a message, it gets removed. The incident is
14581 logged.
14582
14583
14584 .option ldap_ca_cert_dir main string unset
14585 .cindex "LDAP", "TLS CA certificate directory"
14586 This option indicates which directory contains CA certificates for verifying
14587 a TLS certificate presented by an LDAP server.
14588 While Exim does not provide a default value, your SSL library may.
14589 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14590 and constrained to be a directory.
14591
14592
14593 .option ldap_ca_cert_file main string unset
14594 .cindex "LDAP", "TLS CA certificate file"
14595 This option indicates which file contains CA certificates for verifying
14596 a TLS certificate presented by an LDAP server.
14597 While Exim does not provide a default value, your SSL library may.
14598 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14599 and constrained to be a file.
14600
14601
14602 .option ldap_cert_file main string unset
14603 .cindex "LDAP" "TLS client certificate file"
14604 This option indicates which file contains an TLS client certificate which
14605 Exim should present to the LDAP server during TLS negotiation.
14606 Should be used together with &%ldap_cert_key%&.
14607
14608
14609 .option ldap_cert_key main string unset
14610 .cindex "LDAP" "TLS client key file"
14611 This option indicates which file contains the secret/private key to use
14612 to prove identity to the LDAP server during TLS negotiation.
14613 Should be used together with &%ldap_cert_file%&, which contains the
14614 identity to be proven.
14615
14616
14617 .option ldap_cipher_suite main string unset
14618 .cindex "LDAP" "TLS cipher suite"
14619 This controls the TLS cipher-suite negotiation during TLS negotiation with
14620 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14621 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14622
14623
14624 .option ldap_default_servers main "string list" unset
14625 .cindex "LDAP" "default servers"
14626 This option provides a list of LDAP servers which are tried in turn when an
14627 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14628 details of LDAP queries. This option is available only when Exim has been built
14629 with LDAP support.
14630
14631
14632 .option ldap_require_cert main string unset.
14633 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14634 This should be one of the values "hard", "demand", "allow", "try" or "never".
14635 A value other than one of these is interpreted as "never".
14636 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14637 Although Exim does not set a default, the LDAP library probably defaults
14638 to hard/demand.
14639
14640
14641 .option ldap_start_tls main boolean false
14642 .cindex "LDAP" "whether or not to negotiate TLS"
14643 If set, Exim will attempt to negotiate TLS with the LDAP server when
14644 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14645 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14646 of SSL-on-connect.
14647 In the event of failure to negotiate TLS, the action taken is controlled
14648 by &%ldap_require_cert%&.
14649
14650
14651 .option ldap_version main integer unset
14652 .cindex "LDAP" "protocol version, forcing"
14653 This option can be used to force Exim to set a specific protocol version for
14654 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14655 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14656 the LDAP headers; otherwise it is 2. This option is available only when Exim
14657 has been built with LDAP support.
14658
14659
14660
14661 .option local_from_check main boolean true
14662 .cindex "&'Sender:'& header line" "disabling addition of"
14663 .cindex "&'From:'& header line" "disabling checking of"
14664 When a message is submitted locally (that is, not over a TCP/IP connection) by
14665 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14666 checks that the &'From:'& header line matches the login of the calling user and
14667 the domain specified by &%qualify_domain%&.
14668
14669 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14670 locally submitted message is automatically qualified by Exim, unless the
14671 &%-bnq%& command line option is used.
14672
14673 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14674 on the local part. If the &'From:'& header line does not match, Exim adds a
14675 &'Sender:'& header with an address constructed from the calling user's login
14676 and the default qualify domain.
14677
14678 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14679 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14680 &'Sender:'& header lines supplied by untrusted users, you must also set
14681 &%local_sender_retain%& to be true.
14682
14683 .cindex "envelope sender"
14684 These options affect only the header lines in the message. The envelope sender
14685 is still forced to be the login id at the qualify domain unless
14686 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14687
14688 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14689 request similar header line checking. See section &<<SECTthesenhea>>&, which
14690 has more details about &'Sender:'& processing.
14691
14692
14693
14694
14695 .option local_from_prefix main string unset
14696 When Exim checks the &'From:'& header line of locally submitted messages for
14697 matching the login id (see &%local_from_check%& above), it can be configured to
14698 ignore certain prefixes and suffixes in the local part of the address. This is
14699 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14700 appropriate lists, in the same form as the &%local_part_prefix%& and
14701 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14702 example, if
14703 .code
14704 local_from_prefix = *-
14705 .endd
14706 is set, a &'From:'& line containing
14707 .code
14708 From: anything-user@your.domain.example
14709 .endd
14710 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14711 matches the actual sender address that is constructed from the login name and
14712 qualify domain.
14713
14714
14715 .option local_from_suffix main string unset
14716 See &%local_from_prefix%& above.
14717
14718
14719 .option local_interfaces main "string list" "see below"
14720 This option controls which network interfaces are used by the daemon for
14721 listening; they are also used to identify the local host when routing. Chapter
14722 &<<CHAPinterfaces>>& contains a full description of this option and the related
14723 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14724 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14725 &%local_interfaces%& is
14726 .code
14727 local_interfaces = 0.0.0.0
14728 .endd
14729 when Exim is built without IPv6 support; otherwise it is
14730 .code
14731 local_interfaces = <; ::0 ; 0.0.0.0
14732 .endd
14733
14734 .option local_scan_timeout main time 5m
14735 .cindex "timeout" "for &[local_scan()]& function"
14736 .cindex "&[local_scan()]& function" "timeout"
14737 This timeout applies to the &[local_scan()]& function (see chapter
14738 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14739 the incoming message is rejected with a temporary error if it is an SMTP
14740 message. For a non-SMTP message, the message is dropped and Exim ends with a
14741 non-zero code. The incident is logged on the main and reject logs.
14742
14743
14744
14745 .option local_sender_retain main boolean false
14746 .cindex "&'Sender:'& header line" "retaining from local submission"
14747 When a message is submitted locally (that is, not over a TCP/IP connection) by
14748 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14749 do not want this to happen, you must set &%local_sender_retain%&, and you must
14750 also set &%local_from_check%& to be false (Exim will complain if you do not).
14751 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14752 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14753
14754
14755
14756
14757 .option localhost_number main string&!! unset
14758 .cindex "host" "locally unique number for"
14759 .cindex "message ids" "with multiple hosts"
14760 .vindex "&$localhost_number$&"
14761 Exim's message ids are normally unique only within the local host. If
14762 uniqueness among a set of hosts is required, each host must set a different
14763 value for the &%localhost_number%& option. The string is expanded immediately
14764 after reading the configuration file (so that a number can be computed from the
14765 host name, for example) and the result of the expansion must be a number in the
14766 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14767 systems). This is available in subsequent string expansions via the variable
14768 &$localhost_number$&. When &%localhost_number is set%&, the final two
14769 characters of the message id, instead of just being a fractional part of the
14770 time, are computed from the time and the local host number as described in
14771 section &<<SECTmessiden>>&.
14772
14773
14774
14775 .option log_file_path main "string list&!!" "set at compile time"
14776 .cindex "log" "file path for"
14777 This option sets the path which is used to determine the names of Exim's log
14778 files, or indicates that logging is to be to syslog, or both. It is expanded
14779 when Exim is entered, so it can, for example, contain a reference to the host
14780 name. If no specific path is set for the log files at compile or run time, they
14781 are written in a sub-directory called &_log_& in Exim's spool directory.
14782 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14783 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14784 used. If this string is fixed at your installation (contains no expansion
14785 variables) it is recommended that you do not set this option in the
14786 configuration file, but instead supply the path using LOG_FILE_PATH in
14787 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14788 early on &-- in particular, failure to read the configuration file.
14789
14790
14791 .option log_selector main string unset
14792 .cindex "log" "selectors"
14793 This option can be used to reduce or increase the number of things that Exim
14794 writes to its log files. Its argument is made up of names preceded by plus or
14795 minus characters. For example:
14796 .code
14797 log_selector = +arguments -retry_defer
14798 .endd
14799 A list of possible names and what they control is given in the chapter on
14800 logging, in section &<<SECTlogselector>>&.
14801
14802
14803 .option log_timezone main boolean false
14804 .cindex "log" "timezone for entries"
14805 .vindex "&$tod_log$&"
14806 .vindex "&$tod_zone$&"
14807 By default, the timestamps on log lines are in local time without the
14808 timezone. This means that if your timezone changes twice a year, the timestamps
14809 in log lines are ambiguous for an hour when the clocks go back. One way of
14810 avoiding this problem is to set the timezone to UTC. An alternative is to set
14811 &%log_timezone%& true. This turns on the addition of the timezone offset to
14812 timestamps in log lines. Turning on this option can add quite a lot to the size
14813 of log files because each line is extended by 6 characters. Note that the
14814 &$tod_log$& variable contains the log timestamp without the zone, but there is
14815 another variable called &$tod_zone$& that contains just the timezone offset.
14816
14817
14818 .option lookup_open_max main integer 25
14819 .cindex "too many open files"
14820 .cindex "open files, too many"
14821 .cindex "file" "too many open"
14822 .cindex "lookup" "maximum open files"
14823 .cindex "limit" "open files for lookups"
14824 This option limits the number of simultaneously open files for single-key
14825 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14826 Exim normally keeps these files open during routing, because often the same
14827 file is required several times. If the limit is reached, Exim closes the least
14828 recently used file. Note that if you are using the &'ndbm'& library, it
14829 actually opens two files for each logical DBM database, though it still counts
14830 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14831 open files"& errors with NDBM, you need to reduce the value of
14832 &%lookup_open_max%&.
14833
14834
14835 .option max_username_length main integer 0
14836 .cindex "length of login name"
14837 .cindex "user name" "maximum length"
14838 .cindex "limit" "user name length"
14839 Some operating systems are broken in that they truncate long arguments to
14840 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14841 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14842 an argument that is longer behaves as if &[getpwnam()]& failed.
14843
14844
14845 .option message_body_newlines main bool false
14846 .cindex "message body" "newlines in variables"
14847 .cindex "newline" "in message body variables"
14848 .vindex "&$message_body$&"
14849 .vindex "&$message_body_end$&"
14850 By default, newlines in the message body are replaced by spaces when setting
14851 the &$message_body$& and &$message_body_end$& expansion variables. If this
14852 option is set true, this no longer happens.
14853
14854
14855 .option message_body_visible main integer 500
14856 .cindex "body of message" "visible size"
14857 .cindex "message body" "visible size"
14858 .vindex "&$message_body$&"
14859 .vindex "&$message_body_end$&"
14860 This option specifies how much of a message's body is to be included in the
14861 &$message_body$& and &$message_body_end$& expansion variables.
14862
14863
14864 .option message_id_header_domain main string&!! unset
14865 .cindex "&'Message-ID:'& header line"
14866 If this option is set, the string is expanded and used as the right hand side
14867 (domain) of the &'Message-ID:'& header that Exim creates if a
14868 locally-originated incoming message does not have one. &"Locally-originated"&
14869 means &"not received over TCP/IP."&
14870 Otherwise, the primary host name is used.
14871 Only letters, digits, dot and hyphen are accepted; any other characters are
14872 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14873 empty string, the option is ignored.
14874
14875
14876 .option message_id_header_text main string&!! unset
14877 If this variable is set, the string is expanded and used to augment the text of
14878 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14879 message does not have one. The text of this header is required by RFC 2822 to
14880 take the form of an address. By default, Exim uses its internal message id as
14881 the local part, and the primary host name as the domain. If this option is set,
14882 it is expanded, and provided the expansion is not forced to fail, and does not
14883 yield an empty string, the result is inserted into the header immediately
14884 before the @, separated from the internal message id by a dot. Any characters
14885 that are illegal in an address are automatically converted into hyphens. This
14886 means that variables such as &$tod_log$& can be used, because the spaces and
14887 colons will become hyphens.
14888
14889
14890 .option message_logs main boolean true
14891 .cindex "message logs" "disabling"
14892 .cindex "log" "message log; disabling"
14893 If this option is turned off, per-message log files are not created in the
14894 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14895 Exim, by reducing the number of files involved in handling a message from a
14896 minimum of four (header spool file, body spool file, delivery journal, and
14897 per-message log) to three. The other major I/O activity is Exim's main log,
14898 which is not affected by this option.
14899
14900
14901 .option message_size_limit main string&!! 50M
14902 .cindex "message" "size limit"
14903 .cindex "limit" "message size"
14904 .cindex "size" "of message, limit"
14905 This option limits the maximum size of message that Exim will process. The
14906 value is expanded for each incoming connection so, for example, it can be made
14907 to depend on the IP address of the remote host for messages arriving via
14908 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14909 optionally followed by K or M.
14910
14911 &*Note*&: This limit cannot be made to depend on a message's sender or any
14912 other properties of an individual message, because it has to be advertised in
14913 the server's response to EHLO. String expansion failure causes a temporary
14914 error. A value of zero means no limit, but its use is not recommended. See also
14915 &%bounce_return_size_limit%&.
14916
14917 Incoming SMTP messages are failed with a 552 error if the limit is
14918 exceeded; locally-generated messages either get a stderr message or a delivery
14919 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14920 an oversized message is logged in both the main and the reject logs. See also
14921 the generic transport option &%message_size_limit%&, which limits the size of
14922 message that an individual transport can process.
14923
14924 If you use a virus-scanner and set this option to to a value larger than the
14925 maximum size that your virus-scanner is configured to support, you may get
14926 failures triggered by large mails.  The right size to configure for the
14927 virus-scanner depends upon what data is passed and the options in use but it's
14928 probably safest to just set it to a little larger than this value.  Eg, with a
14929 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14930 some problems may result.
14931
14932 A value of 0 will disable size limit checking; Exim will still advertise the
14933 SIZE extension in an EHLO response, but without a limit, so as to permit
14934 SMTP clients to still indicate the message size along with the MAIL verb.
14935
14936
14937 .option move_frozen_messages main boolean false
14938 .cindex "frozen messages" "moving"
14939 This option, which is available only if Exim has been built with the setting
14940 .code
14941 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14942 .endd
14943 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14944 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14945 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14946 standard utilities for handling such moved messages, and they do not show up in
14947 lists generated by &%-bp%& or by the Exim monitor.
14948
14949
14950 .option mua_wrapper main boolean false
14951 Setting this option true causes Exim to run in a very restrictive mode in which
14952 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14953 contains a full description of this facility.
14954
14955
14956
14957 .option mysql_servers main "string list" unset
14958 .cindex "MySQL" "server list"
14959 This option provides a list of MySQL servers and associated connection data, to
14960 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14961 option is available only if Exim has been built with MySQL support.
14962
14963
14964 .option never_users main "string list&!!" unset
14965 This option is expanded just once, at the start of Exim's processing. Local
14966 message deliveries are normally run in processes that are setuid to the
14967 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14968 It is usually desirable to prevent any deliveries from running as root, as a
14969 safety precaution.
14970
14971 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14972 list of users that must not be used for local deliveries. This list is fixed in
14973 the binary and cannot be overridden by the configuration file. By default, it
14974 contains just the single user name &"root"&. The &%never_users%& runtime option
14975 can be used to add more users to the fixed list.
14976
14977 If a message is to be delivered as one of the users on the fixed list or the
14978 &%never_users%& list, an error occurs, and delivery is deferred. A common
14979 example is
14980 .code
14981 never_users = root:daemon:bin
14982 .endd
14983 Including root is redundant if it is also on the fixed list, but it does no
14984 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14985 transport driver.
14986
14987
14988 .option openssl_options main "string list" "+no_sslv2"
14989 .cindex "OpenSSL "compatibility options"
14990 This option allows an administrator to adjust the SSL options applied
14991 by OpenSSL to connections.  It is given as a space-separated list of items,
14992 each one to be +added or -subtracted from the current value.
14993
14994 This option is only available if Exim is built against OpenSSL.  The values
14995 available for this option vary according to the age of your OpenSSL install.
14996 The &"all"& value controls a subset of flags which are available, typically
14997 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14998 list the values known on your system and Exim should support all the
14999 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15000 names lose the leading &"SSL_OP_"& and are lower-cased.
15001
15002 Note that adjusting the options can have severe impact upon the security of
15003 SSL as used by Exim.  It is possible to disable safety checks and shoot
15004 yourself in the foot in various unpleasant ways.  This option should not be
15005 adjusted lightly.  An unrecognised item will be detected at startup, by
15006 invoking Exim with the &%-bV%& flag.
15007
15008 Historical note: prior to release 4.80, Exim defaulted this value to
15009 "+dont_insert_empty_fragments", which may still be needed for compatibility
15010 with some clients, but which lowers security by increasing exposure to
15011 some now infamous attacks.
15012
15013 An example:
15014 .code
15015 # Make both old MS and old Eudora happy:
15016 openssl_options = -all +microsoft_big_sslv3_buffer \
15017                        +dont_insert_empty_fragments
15018 .endd
15019
15020 Possible options may include:
15021 .ilist
15022 &`all`&
15023 .next
15024 &`allow_unsafe_legacy_renegotiation`&
15025 .next
15026 &`cipher_server_preference`&
15027 .next
15028 &`dont_insert_empty_fragments`&
15029 .next
15030 &`ephemeral_rsa`&
15031 .next
15032 &`legacy_server_connect`&
15033 .next
15034 &`microsoft_big_sslv3_buffer`&
15035 .next
15036 &`microsoft_sess_id_bug`&
15037 .next
15038 &`msie_sslv2_rsa_padding`&
15039 .next
15040 &`netscape_challenge_bug`&
15041 .next
15042 &`netscape_reuse_cipher_change_bug`&
15043 .next
15044 &`no_compression`&
15045 .next
15046 &`no_session_resumption_on_renegotiation`&
15047 .next
15048 &`no_sslv2`&
15049 .next
15050 &`no_sslv3`&
15051 .next
15052 &`no_ticket`&
15053 .next
15054 &`no_tlsv1`&
15055 .next
15056 &`no_tlsv1_1`&
15057 .next
15058 &`no_tlsv1_2`&
15059 .next
15060 &`safari_ecdhe_ecdsa_bug`&
15061 .next
15062 &`single_dh_use`&
15063 .next
15064 &`single_ecdh_use`&
15065 .next
15066 &`ssleay_080_client_dh_bug`&
15067 .next
15068 &`sslref2_reuse_cert_type_bug`&
15069 .next
15070 &`tls_block_padding_bug`&
15071 .next
15072 &`tls_d5_bug`&
15073 .next
15074 &`tls_rollback_bug`&
15075 .endlist
15076
15077 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15078 all clients connecting using the MacOS SecureTransport TLS facility prior
15079 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15080 to negotiate TLS then this option value might help, provided that your OpenSSL
15081 release is new enough to contain this work-around.  This may be a situation
15082 where you have to upgrade OpenSSL to get buggy clients working.
15083
15084
15085 .option oracle_servers main "string list" unset
15086 .cindex "Oracle" "server list"
15087 This option provides a list of Oracle servers and associated connection data,
15088 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15089 The option is available only if Exim has been built with Oracle support.
15090
15091
15092 .option percent_hack_domains main "domain list&!!" unset
15093 .cindex "&""percent hack""&"
15094 .cindex "source routing" "in email address"
15095 .cindex "address" "source-routed"
15096 The &"percent hack"& is the convention whereby a local part containing a
15097 percent sign is re-interpreted as a new email address, with the percent
15098 replaced by @. This is sometimes called &"source routing"&, though that term is
15099 also applied to RFC 2822 addresses that begin with an @ character. If this
15100 option is set, Exim implements the percent facility for those domains listed,
15101 but no others. This happens before an incoming SMTP address is tested against
15102 an ACL.
15103
15104 &*Warning*&: The &"percent hack"& has often been abused by people who are
15105 trying to get round relaying restrictions. For this reason, it is best avoided
15106 if at all possible. Unfortunately, a number of less security-conscious MTAs
15107 implement it unconditionally. If you are running Exim on a gateway host, and
15108 routing mail through to internal MTAs without processing the local parts, it is
15109 a good idea to reject recipient addresses with percent characters in their
15110 local parts. Exim's default configuration does this.
15111
15112
15113 .option perl_at_start main boolean false
15114 This option is available only when Exim is built with an embedded Perl
15115 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15116
15117
15118 .option perl_startup main string unset
15119 This option is available only when Exim is built with an embedded Perl
15120 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15121
15122
15123 .option pgsql_servers main "string list" unset
15124 .cindex "PostgreSQL lookup type" "server list"
15125 This option provides a list of PostgreSQL servers and associated connection
15126 data, to be used in conjunction with &(pgsql)& lookups (see section
15127 &<<SECID72>>&). The option is available only if Exim has been built with
15128 PostgreSQL support.
15129
15130
15131 .option pid_file_path main string&!! "set at compile time"
15132 .cindex "daemon" "pid file path"
15133 .cindex "pid file, path for"
15134 This option sets the name of the file to which the Exim daemon writes its
15135 process id. The string is expanded, so it can contain, for example, references
15136 to the host name:
15137 .code
15138 pid_file_path = /var/log/$primary_hostname/exim.pid
15139 .endd
15140 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15141 spool directory.
15142 The value set by the option can be overridden by the &%-oP%& command line
15143 option. A pid file is not written if a &"non-standard"& daemon is run by means
15144 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15145
15146
15147 .option pipelining_advertise_hosts main "host list&!!" *
15148 .cindex "PIPELINING" "suppressing advertising"
15149 This option can be used to suppress the advertisement of the SMTP
15150 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15151 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15152 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15153 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15154 that clients will use it; &"out of order"& commands that are &"expected"& do
15155 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15156
15157
15158 .option prdr_enable main boolean false
15159 .cindex "PRDR" "enabling on server"
15160 This option can be used to enable the Per-Recipient Data Response extension
15161 to SMTP, defined by Eric Hall.
15162 If the option is set, PRDR is advertised by Exim when operating as a server.
15163 If the client requests PRDR, and more than one recipient, for a message 
15164 an additional ACL is called for each recipient after the message content
15165 is recieved.  See section &<<SECTPRDRACL>>&.
15166
15167 .option preserve_message_logs main boolean false
15168 .cindex "message logs" "preserving"
15169 If this option is set, message log files are not deleted when messages are
15170 completed. Instead, they are moved to a sub-directory of the spool directory
15171 called &_msglog.OLD_&, where they remain available for statistical or debugging
15172 purposes. This is a dangerous option to set on systems with any appreciable
15173 volume of mail. Use with care!
15174
15175
15176 .option primary_hostname main string "see below"
15177 .cindex "name" "of local host"
15178 .cindex "host" "name of local"
15179 .cindex "local host" "name of"
15180 .vindex "&$primary_hostname$&"
15181 This specifies the name of the current host. It is used in the default EHLO or
15182 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15183 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15184 The value is also used by default in some SMTP response messages from an Exim
15185 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15186
15187 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15188 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15189 contains only one component, Exim passes it to &[gethostbyname()]& (or
15190 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15191 version. The variable &$primary_hostname$& contains the host name, whether set
15192 explicitly by this option, or defaulted.
15193
15194
15195 .option print_topbitchars main boolean false
15196 .cindex "printing characters"
15197 .cindex "8-bit characters"
15198 By default, Exim considers only those characters whose codes lie in the range
15199 32&--126 to be printing characters. In a number of circumstances (for example,
15200 when writing log entries) non-printing characters are converted into escape
15201 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15202 is set, code values of 128 and above are also considered to be printing
15203 characters.
15204
15205 This option also affects the header syntax checks performed by the
15206 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15207 the user's full name when constructing From: and Sender: addresses (as
15208 described in section &<<SECTconstr>>&). Setting this option can cause
15209 Exim to generate eight bit message headers that do not conform to the
15210 standards.
15211
15212
15213 .option process_log_path main string unset
15214 .cindex "process log path"
15215 .cindex "log" "process log"
15216 .cindex "&'exiwhat'&"
15217 This option sets the name of the file to which an Exim process writes its
15218 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15219 utility script. If this option is unset, the file called &_exim-process.info_&
15220 in Exim's spool directory is used. The ability to specify the name explicitly
15221 can be useful in environments where two different Exims are running, using
15222 different spool directories.
15223
15224
15225 .option prod_requires_admin main boolean true
15226 .oindex "&%-M%&"
15227 .oindex "&%-R%&"
15228 .oindex "&%-q%&"
15229 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15230 admin user unless &%prod_requires_admin%& is set false. See also
15231 &%queue_list_requires_admin%&.
15232
15233
15234 .option qualify_domain main string "see below"
15235 .cindex "domain" "for qualifying addresses"
15236 .cindex "address" "qualification"
15237 This option specifies the domain name that is added to any envelope sender
15238 addresses that do not have a domain qualification. It also applies to
15239 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15240 are accepted by default only for locally-generated messages. Qualification is
15241 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15242 locally-generated messages, unless the &%-bnq%& command line option is used.
15243
15244 Messages from external sources must always contain fully qualified addresses,
15245 unless the sending host matches &%sender_unqualified_hosts%& or
15246 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15247 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15248 necessary. Internally, Exim always works with fully qualified envelope
15249 addresses. If &%qualify_domain%& is not set, it defaults to the
15250 &%primary_hostname%& value.
15251
15252
15253 .option qualify_recipient main string "see below"
15254 This option allows you to specify a different domain for qualifying recipient
15255 addresses to the one that is used for senders. See &%qualify_domain%& above.
15256
15257
15258
15259 .option queue_domains main "domain list&!!" unset
15260 .cindex "domain" "specifying non-immediate delivery"
15261 .cindex "queueing incoming messages"
15262 .cindex "message" "queueing certain domains"
15263 This option lists domains for which immediate delivery is not required.
15264 A delivery process is started whenever a message is received, but only those
15265 domains that do not match are processed. All other deliveries wait until the
15266 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15267
15268
15269 .option queue_list_requires_admin main boolean true
15270 .oindex "&%-bp%&"
15271 The &%-bp%& command-line option, which lists the messages that are on the
15272 queue, requires the caller to be an admin user unless
15273 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15274
15275
15276 .option queue_only main boolean false
15277 .cindex "queueing incoming messages"
15278 .cindex "message" "queueing unconditionally"
15279 If &%queue_only%& is set, a delivery process is not automatically started
15280 whenever a message is received. Instead, the message waits on the queue for the
15281 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15282 delivered immediately when certain conditions (such as heavy load) occur.
15283
15284 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15285 and &%-odi%& command line options override &%queue_only%& unless
15286 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15287 &%queue_only_load%&, and &%smtp_accept_queue%&.
15288
15289
15290 .option queue_only_file main string unset
15291 .cindex "queueing incoming messages"
15292 .cindex "message" "queueing by file existence"
15293 This option can be set to a colon-separated list of absolute path names, each
15294 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15295 it tests for the existence of each listed path using a call to &[stat()]&. For
15296 each path that exists, the corresponding queueing option is set.
15297 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15298 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15299 .code
15300 queue_only_file = smtp/some/file
15301 .endd
15302 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15303 &_/some/file_& exists.
15304
15305
15306 .option queue_only_load main fixed-point unset
15307 .cindex "load average"
15308 .cindex "queueing incoming messages"
15309 .cindex "message" "queueing by load"
15310 If the system load average is higher than this value, incoming messages from
15311 all sources are queued, and no automatic deliveries are started. If this
15312 happens during local or remote SMTP input, all subsequent messages received on
15313 the same SMTP connection are queued by default, whatever happens to the load in
15314 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15315 false.
15316
15317 Deliveries will subsequently be performed by queue runner processes. This
15318 option has no effect on ancient operating systems on which Exim cannot
15319 determine the load average. See also &%deliver_queue_load_max%& and
15320 &%smtp_load_reserve%&.
15321
15322
15323 .option queue_only_load_latch main boolean true
15324 .cindex "load average" "re-evaluating per message"
15325 When this option is true (the default), once one message has been queued
15326 because the load average is higher than the value set by &%queue_only_load%&,
15327 all subsequent messages received on the same SMTP connection are also queued.
15328 This is a deliberate choice; even though the load average may fall below the
15329 threshold, it doesn't seem right to deliver later messages on the same
15330 connection when not delivering earlier ones. However, there are special
15331 circumstances such as very long-lived connections from scanning appliances
15332 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15333 should be set false. This causes the value of the load average to be
15334 re-evaluated for each message.
15335
15336
15337 .option queue_only_override main boolean true
15338 .cindex "queueing incoming messages"
15339 When this option is true, the &%-od%&&'x'& command line options override the
15340 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15341 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15342 to override; they are accepted, but ignored.
15343
15344
15345 .option queue_run_in_order main boolean false
15346 .cindex "queue runner" "processing messages in order"
15347 If this option is set, queue runs happen in order of message arrival instead of
15348 in an arbitrary order. For this to happen, a complete list of the entire queue
15349 must be set up before the deliveries start. When the queue is all held in a
15350 single directory (the default), a single list is created for both the ordered
15351 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15352 single list is not created when &%queue_run_in_order%& is false. In this case,
15353 the sub-directories are processed one at a time (in a random order), and this
15354 avoids setting up one huge list for the whole queue. Thus, setting
15355 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15356 when the queue is large, because of the extra work in setting up the single,
15357 large list. In most situations, &%queue_run_in_order%& should not be set.
15358
15359
15360
15361 .option queue_run_max main integer 5
15362 .cindex "queue runner" "maximum number of"
15363 This controls the maximum number of queue runner processes that an Exim daemon
15364 can run simultaneously. This does not mean that it starts them all at once,
15365 but rather that if the maximum number are still running when the time comes to
15366 start another one, it refrains from starting another one. This can happen with
15367 very large queues and/or very sluggish deliveries. This option does not,
15368 however, interlock with other processes, so additional queue runners can be
15369 started by other means, or by killing and restarting the daemon.
15370
15371 Setting this option to zero does not suppress queue runs; rather, it disables
15372 the limit, allowing any number of simultaneous queue runner processes to be
15373 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15374 the daemon's command line.
15375
15376 .option queue_smtp_domains main "domain list&!!" unset
15377 .cindex "queueing incoming messages"
15378 .cindex "message" "queueing remote deliveries"
15379 When this option is set, a delivery process is started whenever a message is
15380 received, routing is performed, and local deliveries take place.
15381 However, if any SMTP deliveries are required for domains that match
15382 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15383 message waits on the queue for the next queue run. Since routing of the message
15384 has taken place, Exim knows to which remote hosts it must be delivered, and so
15385 when the queue run happens, multiple messages for the same host are delivered
15386 over a single SMTP connection. The &%-odqs%& command line option causes all
15387 SMTP deliveries to be queued in this way, and is equivalent to setting
15388 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15389 &%queue_domains%&.
15390
15391
15392 .option receive_timeout main time 0s
15393 .cindex "timeout" "for non-SMTP input"
15394 This option sets the timeout for accepting a non-SMTP message, that is, the
15395 maximum time that Exim waits when reading a message on the standard input. If
15396 the value is zero, it will wait for ever. This setting is overridden by the
15397 &%-or%& command line option. The timeout for incoming SMTP messages is
15398 controlled by &%smtp_receive_timeout%&.
15399
15400 .option received_header_text main string&!! "see below"
15401 .cindex "customizing" "&'Received:'& header"
15402 .cindex "&'Received:'& header line" "customizing"
15403 This string defines the contents of the &'Received:'& message header that is
15404 added to each message, except for the timestamp, which is automatically added
15405 on at the end (preceded by a semicolon). The string is expanded each time it is
15406 used. If the expansion yields an empty string, no &'Received:'& header line is
15407 added to the message. Otherwise, the string should start with the text
15408 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15409 header lines. The default setting is:
15410
15411 .code
15412 received_header_text = Received: \
15413   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15414   {${if def:sender_ident \
15415   {from ${quote_local_part:$sender_ident} }}\
15416   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15417   by $primary_hostname \
15418   ${if def:received_protocol {with $received_protocol}} \
15419   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15420   (Exim $version_number)\n\t\
15421   ${if def:sender_address \
15422   {(envelope-from <$sender_address>)\n\t}}\
15423   id $message_exim_id\
15424   ${if def:received_for {\n\tfor $received_for}}
15425 .endd
15426
15427 The reference to the TLS cipher is omitted when Exim is built without TLS
15428 support. The use of conditional expansions ensures that this works for both
15429 locally generated messages and messages received from remote hosts, giving
15430 header lines such as the following:
15431 .code
15432 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15433 by marley.carol.example with esmtp (Exim 4.00)
15434 (envelope-from <bob@carol.example>)
15435 id 16IOWa-00019l-00
15436 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15437 Received: by scrooge.carol.example with local (Exim 4.00)
15438 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15439 .endd
15440 Until the body of the message has been received, the timestamp is the time when
15441 the message started to be received. Once the body has arrived, and all policy
15442 checks have taken place, the timestamp is updated to the time at which the
15443 message was accepted.
15444
15445
15446 .option received_headers_max main integer 30
15447 .cindex "loop" "prevention"
15448 .cindex "mail loop prevention"
15449 .cindex "&'Received:'& header line" "counting"
15450 When a message is to be delivered, the number of &'Received:'& headers is
15451 counted, and if it is greater than this parameter, a mail loop is assumed to
15452 have occurred, the delivery is abandoned, and an error message is generated.
15453 This applies to both local and remote deliveries.
15454
15455
15456 .option recipient_unqualified_hosts main "host list&!!" unset
15457 .cindex "unqualified addresses"
15458 .cindex "host" "unqualified addresses from"
15459 This option lists those hosts from which Exim is prepared to accept unqualified
15460 recipient addresses in message envelopes. The addresses are made fully
15461 qualified by the addition of the &%qualify_recipient%& value. This option also
15462 affects message header lines. Exim does not reject unqualified recipient
15463 addresses in headers, but it qualifies them only if the message came from a
15464 host that matches &%recipient_unqualified_hosts%&,
15465 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15466 option was not set.
15467
15468
15469 .option recipients_max main integer 0
15470 .cindex "limit" "number of recipients"
15471 .cindex "recipient" "maximum number"
15472 If this option is set greater than zero, it specifies the maximum number of
15473 original recipients for any message. Additional recipients that are generated
15474 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15475 all recipients over the limit; earlier recipients are delivered as normal.
15476 Non-SMTP messages with too many recipients are failed, and no deliveries are
15477 done.
15478
15479 .cindex "RCPT" "maximum number of incoming"
15480 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15481 RCPT commands in a single message.
15482
15483
15484 .option recipients_max_reject main boolean false
15485 If this option is set true, Exim rejects SMTP messages containing too many
15486 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15487 error to the eventual DATA command. Otherwise (the default) it gives a 452
15488 error to the surplus RCPT commands and accepts the message on behalf of the
15489 initial set of recipients. The remote server should then re-send the message
15490 for the remaining recipients at a later time.
15491
15492
15493 .option remote_max_parallel main integer 2
15494 .cindex "delivery" "parallelism for remote"
15495 This option controls parallel delivery of one message to a number of remote
15496 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15497 does all the remote deliveries for a message one by one. Otherwise, if a single
15498 message has to be delivered to more than one remote host, or if several copies
15499 have to be sent to the same remote host, up to &%remote_max_parallel%&
15500 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15501 deliveries are required, the maximum number of processes are started, and as
15502 each one finishes, another is begun. The order of starting processes is the
15503 same as if sequential delivery were being done, and can be controlled by the
15504 &%remote_sort_domains%& option. If parallel delivery takes place while running
15505 with debugging turned on, the debugging output from each delivery process is
15506 tagged with its process id.
15507
15508 This option controls only the maximum number of parallel deliveries for one
15509 message in one Exim delivery process. Because Exim has no central queue
15510 manager, there is no way of controlling the total number of simultaneous
15511 deliveries if the configuration allows a delivery attempt as soon as a message
15512 is received.
15513
15514 .cindex "number of deliveries"
15515 .cindex "delivery" "maximum number of"
15516 If you want to control the total number of deliveries on the system, you
15517 need to set the &%queue_only%& option. This ensures that all incoming messages
15518 are added to the queue without starting a delivery process. Then set up an Exim
15519 daemon to start queue runner processes at appropriate intervals (probably
15520 fairly often, for example, every minute), and limit the total number of queue
15521 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15522 delivers only one message at a time, the maximum number of deliveries that can
15523 then take place at once is &%queue_run_max%& multiplied by
15524 &%remote_max_parallel%&.
15525
15526 If it is purely remote deliveries you want to control, use
15527 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15528 doing the SMTP routing before queueing, so that several messages for the same
15529 host will eventually get delivered down the same connection.
15530
15531
15532 .option remote_sort_domains main "domain list&!!" unset
15533 .cindex "sorting remote deliveries"
15534 .cindex "delivery" "sorting remote"
15535 When there are a number of remote deliveries for a message, they are sorted by
15536 domain into the order given by this list. For example,
15537 .code
15538 remote_sort_domains = *.cam.ac.uk:*.uk
15539 .endd
15540 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15541 then to those in the &%uk%& domain, then to any others.
15542
15543
15544 .option retry_data_expire main time 7d
15545 .cindex "hints database" "data expiry"
15546 This option sets a &"use before"& time on retry information in Exim's hints
15547 database. Any older retry data is ignored. This means that, for example, once a
15548 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15549 past failures.
15550
15551
15552 .option retry_interval_max main time 24h
15553 .cindex "retry" "limit on interval"
15554 .cindex "limit" "on retry interval"
15555 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15556 intervals between delivery attempts for messages that cannot be delivered
15557 straight away. This option sets an overall limit to the length of time between
15558 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15559 the default value.
15560
15561
15562 .option return_path_remove main boolean true
15563 .cindex "&'Return-path:'& header line" "removing"
15564 RFC 2821, section 4.4, states that an SMTP server must insert a
15565 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15566 The &'Return-path:'& header preserves the sender address as received in the
15567 MAIL command. This description implies that this header should not be present
15568 in an incoming message. If &%return_path_remove%& is true, any existing
15569 &'Return-path:'& headers are removed from messages at the time they are
15570 received. Exim's transports have options for adding &'Return-path:'& headers at
15571 the time of delivery. They are normally used only for final local deliveries.
15572
15573
15574 .option return_size_limit main integer 100K
15575 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15576
15577
15578 .option rfc1413_hosts main "host list&!!" *
15579 .cindex "RFC 1413"
15580 .cindex "host" "for RFC 1413 calls"
15581 RFC 1413 identification calls are made to any client host which matches an item
15582 in the list.
15583
15584 .option rfc1413_query_timeout main time 5s
15585 .cindex "RFC 1413" "query timeout"
15586 .cindex "timeout" "for RFC 1413 call"
15587 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15588 no RFC 1413 calls are ever made.
15589
15590
15591 .option sender_unqualified_hosts main "host list&!!" unset
15592 .cindex "unqualified addresses"
15593 .cindex "host" "unqualified addresses from"
15594 This option lists those hosts from which Exim is prepared to accept unqualified
15595 sender addresses. The addresses are made fully qualified by the addition of
15596 &%qualify_domain%&. This option also affects message header lines. Exim does
15597 not reject unqualified addresses in headers that contain sender addresses, but
15598 it qualifies them only if the message came from a host that matches
15599 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15600 using TCP/IP), and the &%-bnq%& option was not set.
15601
15602
15603 .option smtp_accept_keepalive main boolean true
15604 .cindex "keepalive" "on incoming connection"
15605 This option controls the setting of the SO_KEEPALIVE option on incoming
15606 TCP/IP socket connections. When set, it causes the kernel to probe idle
15607 connections periodically, by sending packets with &"old"& sequence numbers. The
15608 other end of the connection should send an acknowledgment if the connection is
15609 still okay or a reset if the connection has been aborted. The reason for doing
15610 this is that it has the beneficial effect of freeing up certain types of
15611 connection that can get stuck when the remote host is disconnected without
15612 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15613 hours to detect unreachable hosts.
15614
15615
15616
15617 .option smtp_accept_max main integer 20
15618 .cindex "limit" "incoming SMTP connections"
15619 .cindex "SMTP" "incoming connection count"
15620 .cindex "inetd"
15621 This option specifies the maximum number of simultaneous incoming SMTP calls
15622 that Exim will accept. It applies only to the listening daemon; there is no
15623 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15624 value is set to zero, no limit is applied. However, it is required to be
15625 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15626 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15627
15628 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15629 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15630 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15631 and &%smtp_load_reserve%& are then checked before accepting the connection.
15632
15633
15634 .option smtp_accept_max_nonmail main integer 10
15635 .cindex "limit" "non-mail SMTP commands"
15636 .cindex "SMTP" "limiting non-mail commands"
15637 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15638 the connection if there are too many. This option defines &"too many"&. The
15639 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15640 client looping sending EHLO, for example. The check is applied only if the
15641 client host matches &%smtp_accept_max_nonmail_hosts%&.
15642
15643 When a new message is expected, one occurrence of RSET is not counted. This
15644 allows a client to send one RSET between messages (this is not necessary,
15645 but some clients do it). Exim also allows one uncounted occurrence of HELO
15646 or EHLO, and one occurrence of STARTTLS between messages. After
15647 starting up a TLS session, another EHLO is expected, and so it too is not
15648 counted. The first occurrence of AUTH in a connection, or immediately
15649 following STARTTLS is not counted. Otherwise, all commands other than
15650 MAIL, RCPT, DATA, and QUIT are counted.
15651
15652
15653 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15654 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15655 check by setting this option. The default value makes it apply to all hosts. By
15656 changing the value, you can exclude any badly-behaved hosts that you have to
15657 live with.
15658
15659
15660 . Allow this long option name to split; give it unsplit as a fifth argument
15661 . for the automatic .oindex that is generated by .option.
15662 . We insert " &~&~" which is both pretty nasty visually and results in
15663 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15664 . zero-width-space, which would be nicer visually and results in (at least)
15665 . html that Firefox will split on when it's forced to reflow (rather than
15666 . inserting a horizontal scrollbar).  However, the text is still not
15667 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15668 . the option name to split.
15669
15670 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15671          smtp_accept_max_per_connection
15672 .cindex "SMTP" "limiting incoming message count"
15673 .cindex "limit" "messages per SMTP connection"
15674 The value of this option limits the number of MAIL commands that Exim is
15675 prepared to accept over a single SMTP connection, whether or not each command
15676 results in the transfer of a message. After the limit is reached, a 421
15677 response is given to subsequent MAIL commands. This limit is a safety
15678 precaution against a client that goes mad (incidents of this type have been
15679 seen).
15680
15681
15682 .option smtp_accept_max_per_host main string&!! unset
15683 .cindex "limit" "SMTP connections from one host"
15684 .cindex "host" "limiting SMTP connections from"
15685 This option restricts the number of simultaneous IP connections from a single
15686 host (strictly, from a single IP address) to the Exim daemon. The option is
15687 expanded, to enable different limits to be applied to different hosts by
15688 reference to &$sender_host_address$&. Once the limit is reached, additional
15689 connection attempts from the same host are rejected with error code 421. This
15690 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15691 of zero imposes no limit. If this option is set greater than zero, it is
15692 required that &%smtp_accept_max%& be non-zero.
15693
15694 &*Warning*&: When setting this option you should not use any expansion
15695 constructions that take an appreciable amount of time. The expansion and test
15696 happen in the main daemon loop, in order to reject additional connections
15697 without forking additional processes (otherwise a denial-of-service attack
15698 could cause a vast number or processes to be created). While the daemon is
15699 doing this processing, it cannot accept any other incoming connections.
15700
15701
15702
15703 .option smtp_accept_queue main integer 0
15704 .cindex "SMTP" "incoming connection count"
15705 .cindex "queueing incoming messages"
15706 .cindex "message" "queueing by SMTP connection count"
15707 If the number of simultaneous incoming SMTP connections being handled via the
15708 listening daemon exceeds this value, messages received by SMTP are just placed
15709 on the queue; no delivery processes are started automatically. The count is
15710 fixed at the start of an SMTP connection. It cannot be updated in the
15711 subprocess that receives messages, and so the queueing or not queueing applies
15712 to all messages received in the same connection.
15713
15714 A value of zero implies no limit, and clearly any non-zero value is useful only
15715 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15716 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15717 various &%-od%&&'x'& command line options.
15718
15719
15720 . See the comment on smtp_accept_max_per_connection
15721
15722 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15723          smtp_accept_queue_per_connection
15724 .cindex "queueing incoming messages"
15725 .cindex "message" "queueing by message count"
15726 This option limits the number of delivery processes that Exim starts
15727 automatically when receiving messages via SMTP, whether via the daemon or by
15728 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15729 and the number of messages received in a single SMTP session exceeds this
15730 number, subsequent messages are placed on the queue, but no delivery processes
15731 are started. This helps to limit the number of Exim processes when a server
15732 restarts after downtime and there is a lot of mail waiting for it on other
15733 systems. On large systems, the default should probably be increased, and on
15734 dial-in client systems it should probably be set to zero (that is, disabled).
15735
15736
15737 .option smtp_accept_reserve main integer 0
15738 .cindex "SMTP" "incoming call count"
15739 .cindex "host" "reserved"
15740 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15741 number of SMTP connections that are reserved for connections from the hosts
15742 that are specified in &%smtp_reserve_hosts%&. The value set in
15743 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15744 restricted to this number of connections; the option specifies a minimum number
15745 of connection slots for them, not a maximum. It is a guarantee that this group
15746 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15747 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15748 individual host.
15749
15750 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15751 set to 5, once there are 45 active connections (from any hosts), new
15752 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15753 provided the other criteria for acceptance are met.
15754
15755
15756 .option smtp_active_hostname main string&!! unset
15757 .cindex "host" "name in SMTP responses"
15758 .cindex "SMTP" "host name in responses"
15759 .vindex "&$primary_hostname$&"
15760 This option is provided for multi-homed servers that want to masquerade as
15761 several different hosts. At the start of an incoming SMTP connection, its value
15762 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15763 responses. For example, it is used as domain name in the response to an
15764 incoming HELO or EHLO command.
15765
15766 .vindex "&$smtp_active_hostname$&"
15767 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15768 is saved with any messages that are received. It is therefore available for use
15769 in routers and transports when the message is later delivered.
15770
15771 If this option is unset, or if its expansion is forced to fail, or if the
15772 expansion results in an empty string, the value of &$primary_hostname$& is
15773 used. Other expansion failures cause a message to be written to the main and
15774 panic logs, and the SMTP command receives a temporary error. Typically, the
15775 value of &%smtp_active_hostname%& depends on the incoming interface address.
15776 For example:
15777 .code
15778 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15779   {cox.mydomain}{box.mydomain}}
15780 .endd
15781
15782 Although &$smtp_active_hostname$& is primarily concerned with incoming
15783 messages, it is also used as the default for HELO commands in callout
15784 verification if there is no remote transport from which to obtain a
15785 &%helo_data%& value.
15786
15787 .option smtp_banner main string&!! "see below"
15788 .cindex "SMTP" "welcome banner"
15789 .cindex "banner for SMTP"
15790 .cindex "welcome banner for SMTP"
15791 .cindex "customizing" "SMTP banner"
15792 This string, which is expanded every time it is used, is output as the initial
15793 positive response to an SMTP connection. The default setting is:
15794 .code
15795 smtp_banner = $smtp_active_hostname ESMTP Exim \
15796   $version_number $tod_full
15797 .endd
15798 Failure to expand the string causes a panic error. If you want to create a
15799 multiline response to the initial SMTP connection, use &"\n"& in the string at
15800 appropriate points, but not at the end. Note that the 220 code is not included
15801 in this string. Exim adds it automatically (several times in the case of a
15802 multiline response).
15803
15804
15805 .option smtp_check_spool_space main boolean true
15806 .cindex "checking disk space"
15807 .cindex "disk space, checking"
15808 .cindex "spool directory" "checking space"
15809 When this option is set, if an incoming SMTP session encounters the SIZE
15810 option on a MAIL command, it checks that there is enough space in the
15811 spool directory's partition to accept a message of that size, while still
15812 leaving free the amount specified by &%check_spool_space%& (even if that value
15813 is zero). If there isn't enough space, a temporary error code is returned.
15814
15815
15816 .option smtp_connect_backlog main integer 20
15817 .cindex "connection backlog"
15818 .cindex "SMTP" "connection backlog"
15819 .cindex "backlog of connections"
15820 This option specifies a maximum number of waiting SMTP connections. Exim passes
15821 this value to the TCP/IP system when it sets up its listener. Once this number
15822 of connections are waiting for the daemon's attention, subsequent connection
15823 attempts are refused at the TCP/IP level. At least, that is what the manuals
15824 say; in some circumstances such connection attempts have been observed to time
15825 out instead. For large systems it is probably a good idea to increase the
15826 value (to 50, say). It also gives some protection against denial-of-service
15827 attacks by SYN flooding.
15828
15829
15830 .option smtp_enforce_sync main boolean true
15831 .cindex "SMTP" "synchronization checking"
15832 .cindex "synchronization checking in SMTP"
15833 The SMTP protocol specification requires the client to wait for a response from
15834 the server at certain points in the dialogue. Without PIPELINING these
15835 synchronization points are after every command; with PIPELINING they are
15836 fewer, but they still exist.
15837
15838 Some spamming sites send out a complete set of SMTP commands without waiting
15839 for any response. Exim protects against this by rejecting a message if the
15840 client has sent further input when it should not have. The error response &"554
15841 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15842 for this error cannot be perfect because of transmission delays (unexpected
15843 input may be on its way but not yet received when Exim checks). However, it
15844 does detect many instances.
15845
15846 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15847 If you want to disable the check selectively (for example, only for certain
15848 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15849 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15850
15851
15852
15853 .option smtp_etrn_command main string&!! unset
15854 .cindex "ETRN" "command to be run"
15855 .vindex "&$domain$&"
15856 If this option is set, the given command is run whenever an SMTP ETRN
15857 command is received from a host that is permitted to issue such commands (see
15858 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15859 are independently expanded. The expansion variable &$domain$& is set to the
15860 argument of the ETRN command, and no syntax checking is done on it. For
15861 example:
15862 .code
15863 smtp_etrn_command = /etc/etrn_command $domain \
15864                     $sender_host_address
15865 .endd
15866 A new process is created to run the command, but Exim does not wait for it to
15867 complete. Consequently, its status cannot be checked. If the command cannot be
15868 run, a line is written to the panic log, but the ETRN caller still receives
15869 a 250 success response. Exim is normally running under its own uid when
15870 receiving SMTP, so it is not possible for it to change the uid before running
15871 the command.
15872
15873
15874 .option smtp_etrn_serialize main boolean true
15875 .cindex "ETRN" "serializing"
15876 When this option is set, it prevents the simultaneous execution of more than
15877 one identical command as a result of ETRN in an SMTP connection. See
15878 section &<<SECTETRN>>& for details.
15879
15880
15881 .option smtp_load_reserve main fixed-point unset
15882 .cindex "load average"
15883 If the system load average ever gets higher than this, incoming SMTP calls are
15884 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15885 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15886 the load is over the limit. The option has no effect on ancient operating
15887 systems on which Exim cannot determine the load average. See also
15888 &%deliver_queue_load_max%& and &%queue_only_load%&.
15889
15890
15891
15892 .option smtp_max_synprot_errors main integer 3
15893 .cindex "SMTP" "limiting syntax and protocol errors"
15894 .cindex "limit" "SMTP syntax and protocol errors"
15895 Exim rejects SMTP commands that contain syntax or protocol errors. In
15896 particular, a syntactically invalid email address, as in this command:
15897 .code
15898 RCPT TO:<abc xyz@a.b.c>
15899 .endd
15900 causes immediate rejection of the command, before any other tests are done.
15901 (The ACL cannot be run if there is no valid address to set up for it.) An
15902 example of a protocol error is receiving RCPT before MAIL. If there are
15903 too many syntax or protocol errors in one SMTP session, the connection is
15904 dropped. The limit is set by this option.
15905
15906 .cindex "PIPELINING" "expected errors"
15907 When the PIPELINING extension to SMTP is in use, some protocol errors are
15908 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15909 Exim assumes that PIPELINING will be used if it advertises it (see
15910 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15911 not count towards the limit.
15912
15913
15914
15915 .option smtp_max_unknown_commands main integer 3
15916 .cindex "SMTP" "limiting unknown commands"
15917 .cindex "limit" "unknown SMTP commands"
15918 If there are too many unrecognized commands in an incoming SMTP session, an
15919 Exim server drops the connection. This is a defence against some kinds of abuse
15920 that subvert web
15921 clients
15922 into making connections to SMTP ports; in these circumstances, a number of
15923 non-SMTP command lines are sent first.
15924
15925
15926
15927 .option smtp_ratelimit_hosts main "host list&!!" unset
15928 .cindex "SMTP" "rate limiting"
15929 .cindex "limit" "rate of message arrival"
15930 .cindex "RCPT" "rate limiting"
15931 Some sites find it helpful to be able to limit the rate at which certain hosts
15932 can send them messages, and the rate at which an individual message can specify
15933 recipients.
15934
15935 Exim has two rate-limiting facilities. This section describes the older
15936 facility, which can limit rates within a single connection. The newer
15937 &%ratelimit%& ACL condition can limit rates across all connections. See section
15938 &<<SECTratelimiting>>& for details of the newer facility.
15939
15940 When a host matches &%smtp_ratelimit_hosts%&, the values of
15941 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15942 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15943 respectively. Each option, if set, must contain a set of four comma-separated
15944 values:
15945
15946 .ilist
15947 A threshold, before which there is no rate limiting.
15948 .next
15949 An initial time delay. Unlike other times in Exim, numbers with decimal
15950 fractional parts are allowed here.
15951 .next
15952 A factor by which to increase the delay each time.
15953 .next
15954 A maximum value for the delay. This should normally be less than 5 minutes,
15955 because after that time, the client is liable to timeout the SMTP command.
15956 .endlist
15957
15958 For example, these settings have been used successfully at the site which
15959 first suggested this feature, for controlling mail from their customers:
15960 .code
15961 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15962 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15963 .endd
15964 The first setting specifies delays that are applied to MAIL commands after
15965 two have been received over a single connection. The initial delay is 0.5
15966 seconds, increasing by a factor of 1.05 each time. The second setting applies
15967 delays to RCPT commands when more than four occur in a single message.
15968
15969
15970 .option smtp_ratelimit_mail main string unset
15971 See &%smtp_ratelimit_hosts%& above.
15972
15973
15974 .option smtp_ratelimit_rcpt main string unset
15975 See &%smtp_ratelimit_hosts%& above.
15976
15977
15978 .option smtp_receive_timeout main time 5m
15979 .cindex "timeout" "for SMTP input"
15980 .cindex "SMTP" "input timeout"
15981 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15982 input, including batch SMTP. If a line of input (either an SMTP command or a
15983 data line) is not received within this time, the SMTP connection is dropped and
15984 the message is abandoned.
15985 A line is written to the log containing one of the following messages:
15986 .code
15987 SMTP command timeout on connection from...
15988 SMTP data timeout on connection from...
15989 .endd
15990 The former means that Exim was expecting to read an SMTP command; the latter
15991 means that it was in the DATA phase, reading the contents of a message.
15992
15993
15994 .oindex "&%-os%&"
15995 The value set by this option can be overridden by the
15996 &%-os%& command-line option. A setting of zero time disables the timeout, but
15997 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15998 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15999 timeout is controlled by &%receive_timeout%& and &%-or%&.
16000
16001
16002 .option smtp_reserve_hosts main "host list&!!" unset
16003 This option defines hosts for which SMTP connections are reserved; see
16004 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16005
16006
16007 .option smtp_return_error_details main boolean false
16008 .cindex "SMTP" "details policy failures"
16009 .cindex "policy control" "rejection, returning details"
16010 In the default state, Exim uses bland messages such as
16011 &"Administrative prohibition"& when it rejects SMTP commands for policy
16012 reasons. Many sysadmins like this because it gives away little information
16013 to spammers. However, some other sysadmins who are applying strict checking
16014 policies want to give out much fuller information about failures. Setting
16015 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16016 example, instead of &"Administrative prohibition"&, it might give:
16017 .code
16018 550-Rejected after DATA: '>' missing at end of address:
16019 550 failing address in "From" header is: <user@dom.ain
16020 .endd
16021
16022 .option spamd_address main string "see below"
16023 This option is available when Exim is compiled with the content-scanning
16024 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16025 The default value is
16026 .code
16027 127.0.0.1 783
16028 .endd
16029 See section &<<SECTscanspamass>>& for more details.
16030
16031
16032
16033 .option split_spool_directory main boolean false
16034 .cindex "multiple spool directories"
16035 .cindex "spool directory" "split"
16036 .cindex "directories, multiple"
16037 If this option is set, it causes Exim to split its input directory into 62
16038 subdirectories, each with a single alphanumeric character as its name. The
16039 sixth character of the message id is used to allocate messages to
16040 subdirectories; this is the least significant base-62 digit of the time of
16041 arrival of the message.
16042
16043 Splitting up the spool in this way may provide better performance on systems
16044 where there are long mail queues, by reducing the number of files in any one
16045 directory. The msglog directory is also split up in a similar way to the input
16046 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16047 are still placed in the single directory &_msglog.OLD_&.
16048
16049 It is not necessary to take any special action for existing messages when
16050 changing &%split_spool_directory%&. Exim notices messages that are in the
16051 &"wrong"& place, and continues to process them. If the option is turned off
16052 after a period of being on, the subdirectories will eventually empty and be
16053 automatically deleted.
16054
16055 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16056 changes. Instead of creating a list of all messages in the queue, and then
16057 trying to deliver each one in turn, it constructs a list of those in one
16058 sub-directory and tries to deliver them, before moving on to the next
16059 sub-directory. The sub-directories are processed in a random order. This
16060 spreads out the scanning of the input directories, and uses less memory. It is
16061 particularly beneficial when there are lots of messages on the queue. However,
16062 if &%queue_run_in_order%& is set, none of this new processing happens. The
16063 entire queue has to be scanned and sorted before any deliveries can start.
16064
16065
16066 .option spool_directory main string&!! "set at compile time"
16067 .cindex "spool directory" "path to"
16068 This defines the directory in which Exim keeps its spool, that is, the messages
16069 it is waiting to deliver. The default value is taken from the compile-time
16070 configuration setting, if there is one. If not, this option must be set. The
16071 string is expanded, so it can contain, for example, a reference to
16072 &$primary_hostname$&.
16073
16074 If the spool directory name is fixed on your installation, it is recommended
16075 that you set it at build time rather than from this option, particularly if the
16076 log files are being written to the spool directory (see &%log_file_path%&).
16077 Otherwise log files cannot be used for errors that are detected early on, such
16078 as failures in the configuration file.
16079
16080 By using this option to override the compiled-in path, it is possible to run
16081 tests of Exim without using the standard spool.
16082
16083 .option sqlite_lock_timeout main time 5s
16084 .cindex "sqlite lookup type" "lock timeout"
16085 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16086 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16087
16088 .option strict_acl_vars main boolean false
16089 .cindex "&ACL;" "variables, handling unset"
16090 This option controls what happens if a syntactically valid but undefined ACL
16091 variable is referenced. If it is false (the default), an empty string
16092 is substituted; if it is true, an error is generated. See section
16093 &<<SECTaclvariables>>& for details of ACL variables.
16094
16095 .option strip_excess_angle_brackets main boolean false
16096 .cindex "angle brackets, excess"
16097 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16098 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16099 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16100 passed on to another MTA, the excess angle brackets are not passed on. If this
16101 option is not set, multiple pairs of angle brackets cause a syntax error.
16102
16103
16104 .option strip_trailing_dot main boolean false
16105 .cindex "trailing dot on domain"
16106 .cindex "dot" "trailing on domain"
16107 If this option is set, a trailing dot at the end of a domain in an address is
16108 ignored. If this is in the envelope and the message is passed on to another
16109 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16110 domain causes a syntax error.
16111 However, addresses in header lines are checked only when an ACL requests header
16112 syntax checking.
16113
16114
16115 .option syslog_duplication main boolean true
16116 .cindex "syslog" "duplicate log lines; suppressing"
16117 When Exim is logging to syslog, it writes the log lines for its three
16118 separate logs at different syslog priorities so that they can in principle
16119 be separated on the logging hosts. Some installations do not require this
16120 separation, and in those cases, the duplication of certain log lines is a
16121 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16122 particular log line is written to syslog. For lines that normally go to
16123 both the main log and the reject log, the reject log version (possibly
16124 containing message header lines) is written, at LOG_NOTICE priority.
16125 Lines that normally go to both the main and the panic log are written at
16126 the LOG_ALERT priority.
16127
16128
16129 .option syslog_facility main string unset
16130 .cindex "syslog" "facility; setting"
16131 This option sets the syslog &"facility"& name, used when Exim is logging to
16132 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16133 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16134 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16135 details of Exim's logging.
16136
16137
16138
16139 .option syslog_processname main string &`exim`&
16140 .cindex "syslog" "process name; setting"
16141 This option sets the syslog &"ident"& name, used when Exim is logging to
16142 syslog. The value must be no longer than 32 characters. See chapter
16143 &<<CHAPlog>>& for details of Exim's logging.
16144
16145
16146
16147 .option syslog_timestamp main boolean true
16148 .cindex "syslog" "timestamps"
16149 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16150 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16151 details of Exim's logging.
16152
16153
16154 .option system_filter main string&!! unset
16155 .cindex "filter" "system filter"
16156 .cindex "system filter" "specifying"
16157 .cindex "Sieve filter" "not available for system filter"
16158 This option specifies an Exim filter file that is applied to all messages at
16159 the start of each delivery attempt, before any routing is done. System filters
16160 must be Exim filters; they cannot be Sieve filters. If the system filter
16161 generates any deliveries to files or pipes, or any new mail messages, the
16162 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16163 which transports are to be used. Details of this facility are given in chapter
16164 &<<CHAPsystemfilter>>&.
16165
16166
16167 .option system_filter_directory_transport main string&!! unset
16168 .vindex "&$address_file$&"
16169 This sets the name of the transport driver that is to be used when the
16170 &%save%& command in a system message filter specifies a path ending in &"/"&,
16171 implying delivery of each message into a separate file in some directory.
16172 During the delivery, the variable &$address_file$& contains the path name.
16173
16174
16175 .option system_filter_file_transport main string&!! unset
16176 .cindex "file" "transport for system filter"
16177 This sets the name of the transport driver that is to be used when the &%save%&
16178 command in a system message filter specifies a path not ending in &"/"&. During
16179 the delivery, the variable &$address_file$& contains the path name.
16180
16181 .option system_filter_group main string unset
16182 .cindex "gid (group id)" "system filter"
16183 This option is used only when &%system_filter_user%& is also set. It sets the
16184 gid under which the system filter is run, overriding any gid that is associated
16185 with the user. The value may be numerical or symbolic.
16186
16187 .option system_filter_pipe_transport main string&!! unset
16188 .cindex "&(pipe)& transport" "for system filter"
16189 .vindex "&$address_pipe$&"
16190 This specifies the transport driver that is to be used when a &%pipe%& command
16191 is used in a system filter. During the delivery, the variable &$address_pipe$&
16192 contains the pipe command.
16193
16194
16195 .option system_filter_reply_transport main string&!! unset
16196 .cindex "&(autoreply)& transport" "for system filter"
16197 This specifies the transport driver that is to be used when a &%mail%& command
16198 is used in a system filter.
16199
16200
16201 .option system_filter_user main string unset
16202 .cindex "uid (user id)" "system filter"
16203 If this option is set to root, the system filter is run in the main Exim
16204 delivery process, as root.  Otherwise, the system filter runs in a separate
16205 process, as the given user, defaulting to the Exim run-time user.
16206 Unless the string consists entirely of digits, it
16207 is looked up in the password data. Failure to find the named user causes a
16208 configuration error. The gid is either taken from the password data, or
16209 specified by &%system_filter_group%&. When the uid is specified numerically,
16210 &%system_filter_group%& is required to be set.
16211
16212 If the system filter generates any pipe, file, or reply deliveries, the uid
16213 under which the filter is run is used when transporting them, unless a
16214 transport option overrides.
16215
16216
16217 .option tcp_nodelay main boolean true
16218 .cindex "daemon" "TCP_NODELAY on sockets"
16219 .cindex "Nagle algorithm"
16220 .cindex "TCP_NODELAY on listening sockets"
16221 If this option is set false, it stops the Exim daemon setting the
16222 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16223 turns off the &"Nagle algorithm"&, which is a way of improving network
16224 performance in interactive (character-by-character) situations. Turning it off
16225 should improve Exim's performance a bit, so that is what happens by default.
16226 However, it appears that some broken clients cannot cope, and time out. Hence
16227 this option. It affects only those sockets that are set up for listening by the
16228 daemon. Sockets created by the smtp transport for delivering mail always set
16229 TCP_NODELAY.
16230
16231
16232 .option timeout_frozen_after main time 0s
16233 .cindex "frozen messages" "timing out"
16234 .cindex "timeout" "frozen messages"
16235 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16236 message of any kind that has been on the queue for longer than the given time
16237 is automatically cancelled at the next queue run. If the frozen message is a
16238 bounce message, it is just discarded; otherwise, a bounce is sent to the
16239 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16240 If you want to timeout frozen bounce messages earlier than other kinds of
16241 frozen message, see &%ignore_bounce_errors_after%&.
16242
16243 &*Note:*& the default value of zero means no timeouts; with this setting,
16244 frozen messages remain on the queue forever (except for any frozen bounce
16245 messages that are released by &%ignore_bounce_errors_after%&).
16246
16247
16248 .option timezone main string unset
16249 .cindex "timezone, setting"
16250 The value of &%timezone%& is used to set the environment variable TZ while
16251 running Exim (if it is different on entry). This ensures that all timestamps
16252 created by Exim are in the required timezone. If you want all your timestamps
16253 to be in UTC (aka GMT) you should set
16254 .code
16255 timezone = UTC
16256 .endd
16257 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16258 or, if that is not set, from the value of the TZ environment variable when Exim
16259 is built. If &%timezone%& is set to the empty string, either at build or run
16260 time, any existing TZ variable is removed from the environment when Exim
16261 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16262 unfortunately not all, operating systems.
16263
16264
16265 .option tls_advertise_hosts main "host list&!!" unset
16266 .cindex "TLS" "advertising"
16267 .cindex "encryption" "on SMTP connection"
16268 .cindex "SMTP" "encrypted connection"
16269 When Exim is built with support for TLS encrypted connections, the availability
16270 of the STARTTLS command to set up an encrypted session is advertised in
16271 response to EHLO only to those client hosts that match this option. See
16272 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16273
16274
16275 .option tls_certificate main string&!! unset
16276 .cindex "TLS" "server certificate; location of"
16277 .cindex "certificate" "server, location of"
16278 The value of this option is expanded, and must then be the absolute path to a
16279 file which contains the server's certificates. The server's private key is also
16280 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16281 &<<CHAPTLS>>& for further details.
16282
16283 &*Note*&: The certificates defined by this option are used only when Exim is
16284 receiving incoming messages as a server. If you want to supply certificates for
16285 use when sending messages as a client, you must set the &%tls_certificate%&
16286 option in the relevant &(smtp)& transport.
16287
16288 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16289 if the OpenSSL build supports TLS extensions and the TLS client sends the
16290 Server Name Indication extension, then this option and others documented in
16291 &<<SECTtlssni>>& will be re-expanded.
16292
16293 .option tls_crl main string&!! unset
16294 .cindex "TLS" "server certificate revocation list"
16295 .cindex "certificate" "revocation list for server"
16296 This option specifies a certificate revocation list. The expanded value must
16297 be the name of a file that contains a CRL in PEM format.
16298
16299 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16300
16301
16302 .option tls_dh_max_bits main integer 2236
16303 .cindex "TLS" "D-H bit count"
16304 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16305 the chosen TLS library.  That value might prove to be too high for
16306 interoperability.  This option provides a maximum clamp on the value
16307 suggested, trading off security for interoperability.
16308
16309 The value must be at least 1024.
16310
16311 The value 2236 was chosen because, at time of adding the option, it was the
16312 hard-coded maximum value supported by the NSS cryptographic library, as used
16313 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16314
16315 If you prefer more security and are willing to break some clients, raise this
16316 number.
16317
16318 Note that the value passed to GnuTLS for *generating* a new prime may be a
16319 little less than this figure, because GnuTLS is inexact and may produce a
16320 larger prime than requested.
16321
16322
16323 .option tls_dhparam main string&!! unset
16324 .cindex "TLS" "D-H parameters for server"
16325 The value of this option is expanded and indicates the source of DH parameters
16326 to be used by Exim.
16327
16328 If it is a filename starting with a &`/`&, then it names a file from which DH
16329 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16330 PKCS#3 representation of the DH prime.  If the file does not exist, for
16331 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16332 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16333 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16334 and treated as though the &%tls_dhparam%& were set to "none".
16335
16336 If this option expands to the string "none", then no DH parameters will be
16337 loaded by Exim.
16338
16339 If this option expands to the string "historic" and Exim is using GnuTLS, then
16340 Exim will attempt to load a file from inside the spool directory.  If the file
16341 does not exist, Exim will attempt to create it.
16342 See section &<<SECTgnutlsparam>>& for further details.
16343
16344 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16345 a default DH prime; the default is the 2048 bit prime described in section
16346 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16347 in IKE is assigned number 23.
16348
16349 Otherwise, the option must expand to the name used by Exim for any of a number
16350 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16351 "ike" followed by the number used by IKE, of "default" which corresponds to
16352 "ike23".
16353
16354 The available primes are:
16355 &`ike1`&, &`ike2`&, &`ike5`&,
16356 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16357 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16358
16359 Some of these will be too small to be accepted by clients.
16360 Some may be too large to be accepted by clients.
16361
16362 The TLS protocol does not negotiate an acceptable size for this; clients tend
16363 to hard-drop connections if what is offered by the server is unacceptable,
16364 whether too large or too small, and there's no provision for the client to
16365 tell the server what these constraints are.  Thus, as a server operator, you
16366 need to make an educated guess as to what is most likely to work for your
16367 userbase.
16368
16369 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16370 is most likely to maximise interoperability.  The upper bound comes from
16371 applications using the Mozilla Network Security Services (NSS) library, which
16372 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16373 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16374 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16375 acceptable bound from 1024 to 2048.
16376
16377
16378 .option tls_ocsp_file main string&!! unset
16379 This option
16380 must if set expand to the absolute path to a file which contains a current
16381 status proof for the server's certificate, as obtained from the
16382 Certificate Authority.
16383
16384
16385 .option tls_on_connect_ports main "string list" unset
16386 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16387 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16388 set up without waiting for the client to issue a STARTTLS command. For
16389 further details, see section &<<SECTsupobssmt>>&.
16390
16391
16392
16393 .option tls_privatekey main string&!! unset
16394 .cindex "TLS" "server private key; location of"
16395 The value of this option is expanded, and must then be the absolute path to a
16396 file which contains the server's private key. If this option is unset, or if
16397 the expansion is forced to fail, or the result is an empty string, the private
16398 key is assumed to be in the same file as the server's certificates. See chapter
16399 &<<CHAPTLS>>& for further details.
16400
16401 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16402
16403
16404 .option tls_remember_esmtp main boolean false
16405 .cindex "TLS" "esmtp state; remembering"
16406 .cindex "TLS" "broken clients"
16407 If this option is set true, Exim violates the RFCs by remembering that it is in
16408 &"esmtp"& state after successfully negotiating a TLS session. This provides
16409 support for broken clients that fail to send a new EHLO after starting a
16410 TLS session.
16411
16412
16413 .option tls_require_ciphers main string&!! unset
16414 .cindex "TLS" "requiring specific ciphers"
16415 .cindex "cipher" "requiring specific"
16416 This option controls which ciphers can be used for incoming TLS connections.
16417 The &(smtp)& transport has an option of the same name for controlling outgoing
16418 connections. This option is expanded for each connection, so can be varied for
16419 different clients if required. The value of this option must be a list of
16420 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16421 in somewhat different ways. If GnuTLS is being used, the client controls the
16422 preference order of the available ciphers. Details are given in sections
16423 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16424
16425
16426 .option tls_try_verify_hosts main "host list&!!" unset
16427 .cindex "TLS" "client certificate verification"
16428 .cindex "certificate" "verification of client"
16429 See &%tls_verify_hosts%& below.
16430
16431
16432 .option tls_verify_certificates main string&!! unset
16433 .cindex "TLS" "client certificate verification"
16434 .cindex "certificate" "verification of client"
16435 The value of this option is expanded, and must then be the absolute path to
16436 a file containing permitted certificates for clients that
16437 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16438 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
16439 directory containing certificate files. This does not work with GnuTLS; the
16440 option must be set to the name of a single file if you are using GnuTLS.
16441
16442 These certificates should be for the certificate authorities trusted, rather
16443 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16444 the value is a file then the certificates are sent by Exim as a server to
16445 connecting clients, defining the list of accepted certificate authorities.
16446 Thus the values defined should be considered public data.  To avoid this,
16447 use OpenSSL with a directory.
16448
16449 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16450
16451 A forced expansion failure or setting to an empty string is equivalent to
16452 being unset.
16453
16454
16455 .option tls_verify_hosts main "host list&!!" unset
16456 .cindex "TLS" "client certificate verification"
16457 .cindex "certificate" "verification of client"
16458 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16459 certificates from clients. The expected certificates are defined by
16460 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16461 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16462 &%tls_verify_certificates%& is not set.
16463
16464 Any client that matches &%tls_verify_hosts%& is constrained by
16465 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16466 present one of the listed certificates. If it does not, the connection is
16467 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16468 the host to use TLS. It can still send SMTP commands through unencrypted
16469 connections. Forcing a client to use TLS has to be done separately using an
16470 ACL to reject inappropriate commands when the connection is not encrypted.
16471
16472 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16473 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16474 certificate and checks it against &%tls_verify_certificates%&, but does not
16475 abort the connection if there is no certificate or if it does not match. This
16476 state can be detected in an ACL, which makes it possible to implement policies
16477 such as &"accept for relay only if a verified certificate has been received,
16478 but accept for local delivery if encrypted, even without a verified
16479 certificate"&.
16480
16481 Client hosts that match neither of these lists are not asked to present
16482 certificates.
16483
16484
16485 .option trusted_groups main "string list&!!" unset
16486 .cindex "trusted groups"
16487 .cindex "groups" "trusted"
16488 This option is expanded just once, at the start of Exim's processing. If this
16489 option is set, any process that is running in one of the listed groups, or
16490 which has one of them as a supplementary group, is trusted. The groups can be
16491 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16492 details of what trusted callers are permitted to do. If neither
16493 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16494 are trusted.
16495
16496 .option trusted_users main "string list&!!" unset
16497 .cindex "trusted users"
16498 .cindex "user" "trusted"
16499 This option is expanded just once, at the start of Exim's processing. If this
16500 option is set, any process that is running as one of the listed users is
16501 trusted. The users can be specified numerically or by name. See section
16502 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16503 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16504 Exim user are trusted.
16505
16506 .option unknown_login main string&!! unset
16507 .cindex "uid (user id)" "unknown caller"
16508 .vindex "&$caller_uid$&"
16509 This is a specialized feature for use in unusual configurations. By default, if
16510 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16511 gives up. The &%unknown_login%& option can be used to set a login name to be
16512 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16513 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16514 is used for the user's real name (gecos field), unless this has been set by the
16515 &%-F%& option.
16516
16517 .option unknown_username main string unset
16518 See &%unknown_login%&.
16519
16520 .option untrusted_set_sender main "address list&!!" unset
16521 .cindex "trusted users"
16522 .cindex "sender" "setting by untrusted user"
16523 .cindex "untrusted user setting sender"
16524 .cindex "user" "untrusted setting sender"
16525 .cindex "envelope sender"
16526 When an untrusted user submits a message to Exim using the standard input, Exim
16527 normally creates an envelope sender address from the user's login and the
16528 default qualification domain. Data from the &%-f%& option (for setting envelope
16529 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16530 is used) is ignored.
16531
16532 However, untrusted users are permitted to set an empty envelope sender address,
16533 to declare that a message should never generate any bounces. For example:
16534 .code
16535 exim -f '<>' user@domain.example
16536 .endd
16537 .vindex "&$sender_ident$&"
16538 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16539 other envelope sender addresses in a controlled way. When it is set, untrusted
16540 users are allowed to set envelope sender addresses that match any of the
16541 patterns in the list. Like all address lists, the string is expanded. The
16542 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16543 users to setting senders that start with their login ids
16544 followed by a hyphen
16545 by a setting like this:
16546 .code
16547 untrusted_set_sender = ^$sender_ident-
16548 .endd
16549 If you want to allow untrusted users to set envelope sender addresses without
16550 restriction, you can use
16551 .code
16552 untrusted_set_sender = *
16553 .endd
16554 The &%untrusted_set_sender%& option applies to all forms of local input, but
16555 only to the setting of the envelope sender. It does not permit untrusted users
16556 to use the other options which trusted user can use to override message
16557 parameters. Furthermore, it does not stop Exim from removing an existing
16558 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16559 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16560 overriding these actions. The handling of the &'Sender:'& header is also
16561 described in section &<<SECTthesenhea>>&.
16562
16563 The log line for a message's arrival shows the envelope sender following
16564 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16565 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16566 envelope sender address, the user's login is shown in parentheses after the
16567 sender address.
16568
16569
16570 .option uucp_from_pattern main string "see below"
16571 .cindex "&""From""& line"
16572 .cindex "UUCP" "&""From""& line"
16573 Some applications that pass messages to an MTA via a command line interface use
16574 an initial line starting with &"From&~"& to pass the envelope sender. In
16575 particular, this is used by UUCP software. Exim recognizes such a line by means
16576 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16577 matches, the sender address is constructed by expanding the contents of
16578 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16579 default pattern recognizes lines in the following two forms:
16580 .code
16581 From ph10 Fri Jan  5 12:35 GMT 1996
16582 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16583 .endd
16584 The pattern can be seen by running
16585 .code
16586 exim -bP uucp_from_pattern
16587 .endd
16588 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16589 year in the second case. The first word after &"From&~"& is matched in the
16590 regular expression by a parenthesized subpattern. The default value for
16591 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16592 (&"ph10"& in the example above) as the message's sender. See also
16593 &%ignore_fromline_hosts%&.
16594
16595
16596 .option uucp_from_sender main string&!! &`$1`&
16597 See &%uucp_from_pattern%& above.
16598
16599
16600 .option warn_message_file main string unset
16601 .cindex "warning of delay" "customizing the message"
16602 .cindex "customizing" "warning message"
16603 This option defines a template file containing paragraphs of text to be used
16604 for constructing the warning message which is sent by Exim when a message has
16605 been on the queue for a specified amount of time, as specified by
16606 &%delay_warning%&. Details of the file's contents are given in chapter
16607 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16608
16609
16610 .option write_rejectlog main boolean true
16611 .cindex "reject log" "disabling"
16612 If this option is set false, Exim no longer writes anything to the reject log.
16613 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16614 .ecindex IIDconfima
16615 .ecindex IIDmaiconf
16616
16617
16618
16619
16620 . ////////////////////////////////////////////////////////////////////////////
16621 . ////////////////////////////////////////////////////////////////////////////
16622
16623 .chapter "Generic options for routers" "CHAProutergeneric"
16624 .scindex IIDgenoprou1 "options" "generic; for routers"
16625 .scindex IIDgenoprou2 "generic options" "router"
16626 This chapter describes the generic options that apply to all routers.
16627 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16628
16629 For a general description of how a router operates, see sections
16630 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16631 which the preconditions are tested. The order of expansion of the options that
16632 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16633 &%headers_remove%&, &%transport%&.
16634
16635
16636
16637 .option address_data routers string&!! unset
16638 .cindex "router" "data attached to address"
16639 The string is expanded just before the router is run, that is, after all the
16640 precondition tests have succeeded. If the expansion is forced to fail, the
16641 router declines, the value of &%address_data%& remains unchanged, and the
16642 &%more%& option controls what happens next. Other expansion failures cause
16643 delivery of the address to be deferred.
16644
16645 .vindex "&$address_data$&"
16646 When the expansion succeeds, the value is retained with the address, and can be
16647 accessed using the variable &$address_data$& in the current router, subsequent
16648 routers, and the eventual transport.
16649
16650 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16651 that runs a user's filter file, the contents of &$address_data$& are accessible
16652 in the filter. This is not normally a problem, because such data is usually
16653 either not confidential or it &"belongs"& to the current user, but if you do
16654 put confidential data into &$address_data$& you need to remember this point.
16655
16656 Even if the router declines or passes, the value of &$address_data$& remains
16657 with the address, though it can be changed by another &%address_data%& setting
16658 on a subsequent router. If a router generates child addresses, the value of
16659 &$address_data$& propagates to them. This also applies to the special kind of
16660 &"child"& that is generated by a router with the &%unseen%& option.
16661
16662 The idea of &%address_data%& is that you can use it to look up a lot of data
16663 for the address once, and then pick out parts of the data later. For example,
16664 you could use a single LDAP lookup to return a string of the form
16665 .code
16666 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16667 .endd
16668 In the transport you could pick out the mailbox by a setting such as
16669 .code
16670 file = ${extract{mailbox}{$address_data}}
16671 .endd
16672 This makes the configuration file less messy, and also reduces the number of
16673 lookups (though Exim does cache lookups).
16674
16675 .vindex "&$sender_address_data$&"
16676 .vindex "&$address_data$&"
16677 The &%address_data%& facility is also useful as a means of passing information
16678 from one router to another, and from a router to a transport. In addition, if
16679 &$address_data$& is set by a router when verifying a recipient address from an
16680 ACL, it remains available for use in the rest of the ACL statement. After
16681 verifying a sender, the value is transferred to &$sender_address_data$&.
16682
16683
16684
16685 .option address_test routers&!? boolean true
16686 .oindex "&%-bt%&"
16687 .cindex "router" "skipping when address testing"
16688 If this option is set false, the router is skipped when routing is being tested
16689 by means of the &%-bt%& command line option. This can be a convenience when
16690 your first router sends messages to an external scanner, because it saves you
16691 having to set the &"already scanned"& indicator when testing real address
16692 routing.
16693
16694
16695
16696 .option cannot_route_message routers string&!! unset
16697 .cindex "router" "customizing &""cannot route""& message"
16698 .cindex "customizing" "&""cannot route""& message"
16699 This option specifies a text message that is used when an address cannot be
16700 routed because Exim has run out of routers. The default message is
16701 &"Unrouteable address"&. This option is useful only on routers that have
16702 &%more%& set false, or on the very last router in a configuration, because the
16703 value that is used is taken from the last router that is considered. This
16704 includes a router that is skipped because its preconditions are not met, as
16705 well as a router that declines. For example, using the default configuration,
16706 you could put:
16707 .code
16708 cannot_route_message = Remote domain not found in DNS
16709 .endd
16710 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16711 and
16712 .code
16713 cannot_route_message = Unknown local user
16714 .endd
16715 on the final router that checks for local users. If string expansion fails for
16716 this option, the default message is used. Unless the expansion failure was
16717 explicitly forced, a message about the failure is written to the main and panic
16718 logs, in addition to the normal message about the routing failure.
16719
16720
16721 .option caseful_local_part routers boolean false
16722 .cindex "case of local parts"
16723 .cindex "router" "case of local parts"
16724 By default, routers handle the local parts of addresses in a case-insensitive
16725 manner, though the actual case is preserved for transmission with the message.
16726 If you want the case of letters to be significant in a router, you must set
16727 this option true. For individual router options that contain address or local
16728 part lists (for example, &%local_parts%&), case-sensitive matching can be
16729 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16730 more details.
16731
16732 .vindex "&$local_part$&"
16733 .vindex "&$original_local_part$&"
16734 .vindex "&$parent_local_part$&"
16735 The value of the &$local_part$& variable is forced to lower case while a
16736 router is running unless &%caseful_local_part%& is set. When a router assigns
16737 an address to a transport, the value of &$local_part$& when the transport runs
16738 is the same as it was in the router. Similarly, when a router generates child
16739 addresses by aliasing or forwarding, the values of &$original_local_part$&
16740 and &$parent_local_part$& are those that were used by the redirecting router.
16741
16742 This option applies to the processing of an address by a router. When a
16743 recipient address is being processed in an ACL, there is a separate &%control%&
16744 modifier that can be used to specify case-sensitive processing within the ACL
16745 (see section &<<SECTcontrols>>&).
16746
16747
16748
16749 .option check_local_user routers&!? boolean false
16750 .cindex "local user, checking in router"
16751 .cindex "router" "checking for local user"
16752 .cindex "&_/etc/passwd_&"
16753 .vindex "&$home$&"
16754 When this option is true, Exim checks that the local part of the recipient
16755 address (with affixes removed if relevant) is the name of an account on the
16756 local system. The check is done by calling the &[getpwnam()]& function rather
16757 than trying to read &_/etc/passwd_& directly. This means that other methods of
16758 holding password data (such as NIS) are supported. If the local part is a local
16759 user, &$home$& is set from the password data, and can be tested in other
16760 preconditions that are evaluated after this one (the order of evaluation is
16761 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16762 overridden by &%router_home_directory%&. If the local part is not a local user,
16763 the router is skipped.
16764
16765 If you want to check that the local part is either the name of a local user
16766 or matches something else, you cannot combine &%check_local_user%& with a
16767 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16768 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16769 setting to achieve this. For example:
16770 .code
16771 local_parts = passwd;$local_part : lsearch;/etc/other/users
16772 .endd
16773 Note, however, that the side effects of &%check_local_user%& (such as setting
16774 up a home directory) do not occur when a &(passwd)& lookup is used in a
16775 &%local_parts%& (or any other) precondition.
16776
16777
16778
16779 .option condition routers&!? string&!! unset
16780 .cindex "router" "customized precondition"
16781 This option specifies a general precondition test that has to succeed for the
16782 router to be called. The &%condition%& option is the last precondition to be
16783 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16784 result is a forced failure, or an empty string, or one of the strings &"0"& or
16785 &"no"& or &"false"& (checked without regard to the case of the letters), the
16786 router is skipped, and the address is offered to the next one.
16787
16788 If the result is any other value, the router is run (as this is the last
16789 precondition to be evaluated, all the other preconditions must be true).
16790
16791 This option is unusual in that multiple &%condition%& options may be present.
16792 All &%condition%& options must succeed.
16793
16794 The &%condition%& option provides a means of applying custom conditions to the
16795 running of routers. Note that in the case of a simple conditional expansion,
16796 the default expansion values are exactly what is wanted. For example:
16797 .code
16798 condition = ${if >{$message_age}{600}}
16799 .endd
16800 Because of the default behaviour of the string expansion, this is equivalent to
16801 .code
16802 condition = ${if >{$message_age}{600}{true}{}}
16803 .endd
16804
16805 A multiple condition example, which succeeds:
16806 .code
16807 condition = ${if >{$message_age}{600}}
16808 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16809 condition = foobar
16810 .endd
16811
16812 If the expansion fails (other than forced failure) delivery is deferred. Some
16813 of the other precondition options are common special cases that could in fact
16814 be specified using &%condition%&.
16815
16816
16817 .option debug_print routers string&!! unset
16818 .cindex "testing" "variables in drivers"
16819 If this option is set and debugging is enabled (see the &%-d%& command line
16820 option) or in address-testing mode (see the &%-bt%& command line option),
16821 the string is expanded and included in the debugging output.
16822 If expansion of the string fails, the error message is written to the debugging
16823 output, and Exim carries on processing.
16824 This option is provided to help with checking out the values of variables and
16825 so on when debugging router configurations. For example, if a &%condition%&
16826 option appears not to be working, &%debug_print%& can be used to output the
16827 variables it references. The output happens after checks for &%domains%&,
16828 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16829 are tested. A newline is added to the text if it does not end with one.
16830 The variable &$router_name$& contains the name of the router.
16831
16832
16833
16834 .option disable_logging routers boolean false
16835 If this option is set true, nothing is logged for any routing errors
16836 or for any deliveries caused by this router. You should not set this option
16837 unless you really, really know what you are doing. See also the generic
16838 transport option of the same name.
16839
16840
16841 .option domains routers&!? "domain list&!!" unset
16842 .cindex "router" "restricting to specific domains"
16843 .vindex "&$domain_data$&"
16844 If this option is set, the router is skipped unless the current domain matches
16845 the list. If the match is achieved by means of a file lookup, the data that the
16846 lookup returned for the domain is placed in &$domain_data$& for use in string
16847 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16848 a list of the order in which preconditions are evaluated.
16849
16850
16851
16852 .option driver routers string unset
16853 This option must always be set. It specifies which of the available routers is
16854 to be used.
16855
16856
16857
16858 .option errors_to routers string&!! unset
16859 .cindex "envelope sender"
16860 .cindex "router" "changing address for errors"
16861 If a router successfully handles an address, it may assign the address to a
16862 transport for delivery or it may generate child addresses. In both cases, if
16863 there is a delivery problem during later processing, the resulting bounce
16864 message is sent to the address that results from expanding this string,
16865 provided that the address verifies successfully. The &%errors_to%& option is
16866 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16867
16868 The &%errors_to%& setting associated with an address can be overridden if it
16869 subsequently passes through other routers that have their own &%errors_to%&
16870 settings, or if the message is delivered by a transport with a &%return_path%&
16871 setting.
16872
16873 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16874 the expansion fails to verify, the errors address associated with the incoming
16875 address is used. At top level, this is the envelope sender. A non-forced
16876 expansion failure causes delivery to be deferred.
16877
16878 If an address for which &%errors_to%& has been set ends up being delivered over
16879 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16880 any bounces that are generated by other MTAs on the delivery route are also
16881 sent there. You can set &%errors_to%& to the empty string by either of these
16882 settings:
16883 .code
16884 errors_to =
16885 errors_to = ""
16886 .endd
16887 An expansion item that yields an empty string has the same effect. If you do
16888 this, a locally detected delivery error for addresses processed by this router
16889 no longer gives rise to a bounce message; the error is discarded. If the
16890 address is delivered to a remote host, the return path is set to &`<>`&, unless
16891 overridden by the &%return_path%& option on the transport.
16892
16893 .vindex "&$address_data$&"
16894 If for some reason you want to discard local errors, but use a non-empty
16895 MAIL command for remote delivery, you can preserve the original return
16896 path in &$address_data$& in the router, and reinstate it in the transport by
16897 setting &%return_path%&.
16898
16899 The most common use of &%errors_to%& is to direct mailing list bounces to the
16900 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16901 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16902
16903
16904
16905 .option expn routers&!? boolean true
16906 .cindex "address" "testing"
16907 .cindex "testing" "addresses"
16908 .cindex "EXPN" "router skipping"
16909 .cindex "router" "skipping for EXPN"
16910 If this option is turned off, the router is skipped when testing an address
16911 as a result of processing an SMTP EXPN command. You might, for example,
16912 want to turn it off on a router for users' &_.forward_& files, while leaving it
16913 on for the system alias file.
16914 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16915 are evaluated.
16916
16917 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16918 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16919 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16920
16921
16922
16923 .option fail_verify routers boolean false
16924 .cindex "router" "forcing verification failure"
16925 Setting this option has the effect of setting both &%fail_verify_sender%& and
16926 &%fail_verify_recipient%& to the same value.
16927
16928
16929
16930 .option fail_verify_recipient routers boolean false
16931 If this option is true and an address is accepted by this router when
16932 verifying a recipient, verification fails.
16933
16934
16935
16936 .option fail_verify_sender routers boolean false
16937 If this option is true and an address is accepted by this router when
16938 verifying a sender, verification fails.
16939
16940
16941
16942 .option fallback_hosts routers "string list" unset
16943 .cindex "router" "fallback hosts"
16944 .cindex "fallback" "hosts specified on router"
16945 String expansion is not applied to this option. The argument must be a
16946 colon-separated list of host names or IP addresses. The list separator can be
16947 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16948 each name or address. In fact, the format of each item is exactly the same as
16949 defined for the list of hosts in a &(manualroute)& router (see section
16950 &<<SECTformatonehostitem>>&).
16951
16952 If a router queues an address for a remote transport, this host list is
16953 associated with the address, and used instead of the transport's fallback host
16954 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16955 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16956 transport for further details.
16957
16958
16959 .option group routers string&!! "see below"
16960 .cindex "gid (group id)" "local delivery"
16961 .cindex "local transports" "uid and gid"
16962 .cindex "transport" "local"
16963 .cindex "router" "setting group"
16964 When a router queues an address for a transport, and the transport does not
16965 specify a group, the group given here is used when running the delivery
16966 process.
16967 The group may be specified numerically or by name. If expansion fails, the
16968 error is logged and delivery is deferred.
16969 The default is unset, unless &%check_local_user%& is set, when the default
16970 is taken from the password information. See also &%initgroups%& and &%user%&
16971 and the discussion in chapter &<<CHAPenvironment>>&.
16972
16973
16974
16975 .option headers_add routers list&!! unset
16976 .cindex "header lines" "adding"
16977 .cindex "router" "adding header lines"
16978 This option specifies a list of text headers, newline-separated,
16979 that is associated with any addresses that are accepted by the router.
16980 Each item is separately expanded, at routing time.  However, this
16981 option has no effect when an address is just being verified. The way in which
16982 the text is used to add header lines at transport time is described in section
16983 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16984 message is in the process of being transported. This means that references to
16985 header lines in string expansions in the transport's configuration do not
16986 &"see"& the added header lines.
16987
16988 The &%headers_add%& option is expanded after &%errors_to%&, but before
16989 &%headers_remove%& and &%transport%&. If an item is empty, or if
16990 an item expansion is forced to fail, the item has no effect. Other expansion
16991 failures are treated as configuration errors.
16992
16993 Unlike most options, &%headers_add%& can be specified multiple times
16994 for a router; all listed headers are added.
16995
16996 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16997 router that has the &%one_time%& option set.
16998
16999 .cindex "duplicate addresses"
17000 .oindex "&%unseen%&"
17001 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17002 additions are deleted when the address is passed on to subsequent routers.
17003 For a &%redirect%& router, if a generated address is the same as the incoming
17004 address, this can lead to duplicate addresses with different header
17005 modifications. Exim does not do duplicate deliveries (except, in certain
17006 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17007 which of the duplicates is discarded, so this ambiguous situation should be
17008 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17009
17010
17011
17012 .option headers_remove routers list&!! unset
17013 .cindex "header lines" "removing"
17014 .cindex "router" "removing header lines"
17015 This option specifies a list of text headers, colon-separated,
17016 that is associated with any addresses that are accepted by the router.
17017 Each item is separately expanded, at routing time.  However, this
17018 option has no effect when an address is just being verified. The way in which
17019 the text is used to remove header lines at transport time is described in
17020 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17021 the message is in the process of being transported. This means that references
17022 to header lines in string expansions in the transport's configuration still
17023 &"see"& the original header lines.
17024
17025 The &%headers_remove%& option is expanded after &%errors_to%& and
17026 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17027 the item has no effect. Other expansion failures are treated as configuration
17028 errors.
17029
17030 Unlike most options, &%headers_remove%& can be specified multiple times
17031 for a router; all listed headers are removed.
17032
17033 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17034 router that has the &%one_time%& option set.
17035
17036 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17037 removal requests are deleted when the address is passed on to subsequent
17038 routers, and this can lead to problems with duplicates -- see the similar
17039 warning for &%headers_add%& above.
17040
17041
17042 .option ignore_target_hosts routers "host list&!!" unset
17043 .cindex "IP address" "discarding"
17044 .cindex "router" "discarding IP addresses"
17045 Although this option is a host list, it should normally contain IP address
17046 entries rather than names. If any host that is looked up by the router has an
17047 IP address that matches an item in this list, Exim behaves as if that IP
17048 address did not exist. This option allows you to cope with rogue DNS entries
17049 like
17050 .code
17051 remote.domain.example.  A  127.0.0.1
17052 .endd
17053 by setting
17054 .code
17055 ignore_target_hosts = 127.0.0.1
17056 .endd
17057 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17058 discarded in this way, the router declines. In a conventional configuration, an
17059 attempt to mail to such a domain would normally provoke the &"unrouteable
17060 domain"& error, and an attempt to verify an address in the domain would fail.
17061 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17062 router declines if presented with one of the listed addresses.
17063
17064 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17065 means of the first or the second of the following settings, respectively:
17066 .code
17067 ignore_target_hosts = 0.0.0.0/0
17068 ignore_target_hosts = <; 0::0/0
17069 .endd
17070 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17071 in the second line matches all IPv6 addresses.
17072
17073 This option may also be useful for ignoring link-local and site-local IPv6
17074 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17075 is expanded before use as a list, it is possible to make it dependent on the
17076 domain that is being routed.
17077
17078 .vindex "&$host_address$&"
17079 During its expansion, &$host_address$& is set to the IP address that is being
17080 checked.
17081
17082 .option initgroups routers boolean false
17083 .cindex "additional groups"
17084 .cindex "groups" "additional"
17085 .cindex "local transports" "uid and gid"
17086 .cindex "transport" "local"
17087 If the router queues an address for a transport, and this option is true, and
17088 the uid supplied by the router is not overridden by the transport, the
17089 &[initgroups()]& function is called when running the transport to ensure that
17090 any additional groups associated with the uid are set up. See also &%group%&
17091 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17092
17093
17094
17095 .option local_part_prefix routers&!? "string list" unset
17096 .cindex "router" "prefix for local part"
17097 .cindex "prefix" "for local part, used in router"
17098 If this option is set, the router is skipped unless the local part starts with
17099 one of the given strings, or &%local_part_prefix_optional%& is true. See
17100 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17101 evaluated.
17102
17103 The list is scanned from left to right, and the first prefix that matches is
17104 used. A limited form of wildcard is available; if the prefix begins with an
17105 asterisk, it matches the longest possible sequence of arbitrary characters at
17106 the start of the local part. An asterisk should therefore always be followed by
17107 some character that does not occur in normal local parts.
17108 .cindex "multiple mailboxes"
17109 .cindex "mailbox" "multiple"
17110 Wildcarding can be used to set up multiple user mailboxes, as described in
17111 section &<<SECTmulbox>>&.
17112
17113 .vindex "&$local_part$&"
17114 .vindex "&$local_part_prefix$&"
17115 During the testing of the &%local_parts%& option, and while the router is
17116 running, the prefix is removed from the local part, and is available in the
17117 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17118 the router accepts the address, this remains true during subsequent delivery by
17119 a transport. In particular, the local part that is transmitted in the RCPT
17120 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17121 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17122 the relevant transport.
17123
17124 When an address is being verified, &%local_part_prefix%& affects only the
17125 behaviour of the router. If the callout feature of verification is in use, this
17126 means that the full address, including the prefix, will be used during the
17127 callout.
17128
17129 The prefix facility is commonly used to handle local parts of the form
17130 &%owner-something%&. Another common use is to support local parts of the form
17131 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17132 to tell a user their forwarding is broken &-- by placing a router like this one
17133 immediately before the router that handles &_.forward_& files:
17134 .code
17135 real_localuser:
17136   driver = accept
17137   local_part_prefix = real-
17138   check_local_user
17139   transport = local_delivery
17140 .endd
17141 For security, it would probably be a good idea to restrict the use of this
17142 router to locally-generated messages, using a condition such as this:
17143 .code
17144   condition = ${if match {$sender_host_address}\
17145                          {\N^(|127\.0\.0\.1)$\N}}
17146 .endd
17147
17148 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17149 both conditions must be met if not optional. Care must be taken if wildcards
17150 are used in both a prefix and a suffix on the same router. Different
17151 separator characters must be used to avoid ambiguity.
17152
17153
17154 .option local_part_prefix_optional routers boolean false
17155 See &%local_part_prefix%& above.
17156
17157
17158
17159 .option local_part_suffix routers&!? "string list" unset
17160 .cindex "router" "suffix for local part"
17161 .cindex "suffix for local part" "used in router"
17162 This option operates in the same way as &%local_part_prefix%&, except that the
17163 local part must end (rather than start) with the given string, the
17164 &%local_part_suffix_optional%& option determines whether the suffix is
17165 mandatory, and the wildcard * character, if present, must be the last
17166 character of the suffix. This option facility is commonly used to handle local
17167 parts of the form &%something-request%& and multiple user mailboxes of the form
17168 &%username-foo%&.
17169
17170
17171 .option local_part_suffix_optional routers boolean false
17172 See &%local_part_suffix%& above.
17173
17174
17175
17176 .option local_parts routers&!? "local part list&!!" unset
17177 .cindex "router" "restricting to specific local parts"
17178 .cindex "local part" "checking in router"
17179 The router is run only if the local part of the address matches the list.
17180 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17181 are evaluated, and
17182 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17183 string is expanded, it is possible to make it depend on the domain, for
17184 example:
17185 .code
17186 local_parts = dbm;/usr/local/specials/$domain
17187 .endd
17188 .vindex "&$local_part_data$&"
17189 If the match is achieved by a lookup, the data that the lookup returned
17190 for the local part is placed in the variable &$local_part_data$& for use in
17191 expansions of the router's private options. You might use this option, for
17192 example, if you have a large number of local virtual domains, and you want to
17193 send all postmaster mail to the same place without having to set up an alias in
17194 each virtual domain:
17195 .code
17196 postmaster:
17197   driver = redirect
17198   local_parts = postmaster
17199   data = postmaster@real.domain.example
17200 .endd
17201
17202
17203 .option log_as_local routers boolean "see below"
17204 .cindex "log" "delivery line"
17205 .cindex "delivery" "log line format"
17206 Exim has two logging styles for delivery, the idea being to make local
17207 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17208 recipient address is given just as the local part, without a domain. The use of
17209 this style is controlled by this option. It defaults to true for the &(accept)&
17210 router, and false for all the others. This option applies only when a
17211 router assigns an address to a transport. It has no effect on routers that
17212 redirect addresses.
17213
17214
17215
17216 .option more routers boolean&!! true
17217 The result of string expansion for this option must be a valid boolean value,
17218 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17219 result causes an error, and delivery is deferred. If the expansion is forced to
17220 fail, the default value for the option (true) is used. Other failures cause
17221 delivery to be deferred.
17222
17223 If this option is set false, and the router declines to handle the address, no
17224 further routers are tried, routing fails, and the address is bounced.
17225 .oindex "&%self%&"
17226 However, if the router explicitly passes an address to the following router by
17227 means of the setting
17228 .code
17229 self = pass
17230 .endd
17231 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17232 does not affect the behaviour if one of the precondition tests fails. In that
17233 case, the address is always passed to the next router.
17234
17235 Note that &%address_data%& is not considered to be a precondition. If its
17236 expansion is forced to fail, the router declines, and the value of &%more%&
17237 controls what happens next.
17238
17239
17240 .option pass_on_timeout routers boolean false
17241 .cindex "timeout" "of router"
17242 .cindex "router" "timeout"
17243 If a router times out during a host lookup, it normally causes deferral of the
17244 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17245 router, overriding &%no_more%&. This may be helpful for systems that are
17246 intermittently connected to the Internet, or those that want to pass to a smart
17247 host any messages that cannot immediately be delivered.
17248
17249 There are occasional other temporary errors that can occur while doing DNS
17250 lookups. They are treated in the same way as a timeout, and this option
17251 applies to all of them.
17252
17253
17254
17255 .option pass_router routers string unset
17256 .cindex "router" "go to after &""pass""&"
17257 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17258 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17259 routing to continue, and overriding a false setting of &%more%&. When one of
17260 these routers returns &"pass"&, the address is normally handed on to the next
17261 router in sequence. This can be changed by setting &%pass_router%& to the name
17262 of another router. However (unlike &%redirect_router%&) the named router must
17263 be below the current router, to avoid loops. Note that this option applies only
17264 to the special case of &"pass"&. It does not apply when a router returns
17265 &"decline"& because it cannot handle an address.
17266
17267
17268
17269 .option redirect_router routers string unset
17270 .cindex "router" "start at after redirection"
17271 Sometimes an administrator knows that it is pointless to reprocess addresses
17272 generated from alias or forward files with the same router again. For
17273 example, if an alias file translates real names into login ids there is no
17274 point searching the alias file a second time, especially if it is a large file.
17275
17276 The &%redirect_router%& option can be set to the name of any router instance.
17277 It causes the routing of any generated addresses to start at the named router
17278 instead of at the first router. This option has no effect if the router in
17279 which it is set does not generate new addresses.
17280
17281
17282
17283 .option require_files routers&!? "string list&!!" unset
17284 .cindex "file" "requiring for router"
17285 .cindex "router" "requiring file existence"
17286 This option provides a general mechanism for predicating the running of a
17287 router on the existence or non-existence of certain files or directories.
17288 Before running a router, as one of its precondition tests, Exim works its way
17289 through the &%require_files%& list, expanding each item separately.
17290
17291 Because the list is split before expansion, any colons in expansion items must
17292 be doubled, or the facility for using a different list separator must be used.
17293 If any expansion is forced to fail, the item is ignored. Other expansion
17294 failures cause routing of the address to be deferred.
17295
17296 If any expanded string is empty, it is ignored. Otherwise, except as described
17297 below, each string must be a fully qualified file path, optionally preceded by
17298 &"!"&. The paths are passed to the &[stat()]& function to test for the
17299 existence of the files or directories. The router is skipped if any paths not
17300 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17301
17302 .cindex "NFS"
17303 If &[stat()]& cannot determine whether a file exists or not, delivery of
17304 the message is deferred. This can happen when NFS-mounted filesystems are
17305 unavailable.
17306
17307 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17308 options, so you cannot use it to check for the existence of a file in which to
17309 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17310 full list of the order in which preconditions are evaluated.) However, as
17311 these options are all expanded, you can use the &%exists%& expansion condition
17312 to make such tests. The &%require_files%& option is intended for checking files
17313 that the router may be going to use internally, or which are needed by a
17314 transport (for example &_.procmailrc_&).
17315
17316 During delivery, the &[stat()]& function is run as root, but there is a
17317 facility for some checking of the accessibility of a file by another user.
17318 This is not a proper permissions check, but just a &"rough"& check that
17319 operates as follows:
17320
17321 If an item in a &%require_files%& list does not contain any forward slash
17322 characters, it is taken to be the user (and optional group, separated by a
17323 comma) to be checked for subsequent files in the list. If no group is specified
17324 but the user is specified symbolically, the gid associated with the uid is
17325 used. For example:
17326 .code
17327 require_files = mail:/some/file
17328 require_files = $local_part:$home/.procmailrc
17329 .endd
17330 If a user or group name in a &%require_files%& list does not exist, the
17331 &%require_files%& condition fails.
17332
17333 Exim performs the check by scanning along the components of the file path, and
17334 checking the access for the given uid and gid. It checks for &"x"& access on
17335 directories, and &"r"& access on the final file. Note that this means that file
17336 access control lists, if the operating system has them, are ignored.
17337
17338 &*Warning 1*&: When the router is being run to verify addresses for an
17339 incoming SMTP message, Exim is not running as root, but under its own uid. This
17340 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17341 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17342 user is not permitted to read one of the directories on the file's path.
17343
17344 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17345 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17346 without root access. In this case, if a check for access by a particular user
17347 is requested, Exim creates a subprocess that runs as that user, and tries the
17348 check again in that process.
17349
17350 The default action for handling an unresolved EACCES is to consider it to
17351 be caused by a configuration error, and routing is deferred because the
17352 existence or non-existence of the file cannot be determined. However, in some
17353 circumstances it may be desirable to treat this condition as if the file did
17354 not exist. If the file name (or the exclamation mark that precedes the file
17355 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17356 as if the file did not exist. For example:
17357 .code
17358 require_files = +/some/file
17359 .endd
17360 If the router is not an essential part of verification (for example, it
17361 handles users' &_.forward_& files), another solution is to set the &%verify%&
17362 option false so that the router is skipped when verifying.
17363
17364
17365
17366 .option retry_use_local_part routers boolean "see below"
17367 .cindex "hints database" "retry keys"
17368 .cindex "local part" "in retry keys"
17369 When a delivery suffers a temporary routing failure, a retry record is created
17370 in Exim's hints database. For addresses whose routing depends only on the
17371 domain, the key for the retry record should not involve the local part, but for
17372 other addresses, both the domain and the local part should be included.
17373 Usually, remote routing is of the former kind, and local routing is of the
17374 latter kind.
17375
17376 This option controls whether the local part is used to form the key for retry
17377 hints for addresses that suffer temporary errors while being handled by this
17378 router. The default value is true for any router that has &%check_local_user%&
17379 set, and false otherwise. Note that this option does not apply to hints keys
17380 for transport delays; they are controlled by a generic transport option of the
17381 same name.
17382
17383 The setting of &%retry_use_local_part%& applies only to the router on which it
17384 appears. If the router generates child addresses, they are routed
17385 independently; this setting does not become attached to them.
17386
17387
17388
17389 .option router_home_directory routers string&!! unset
17390 .cindex "router" "home directory for"
17391 .cindex "home directory" "for router"
17392 .vindex "&$home$&"
17393 This option sets a home directory for use while the router is running. (Compare
17394 &%transport_home_directory%&, which sets a home directory for later
17395 transporting.) In particular, if used on a &(redirect)& router, this option
17396 sets a value for &$home$& while a filter is running. The value is expanded;
17397 forced expansion failure causes the option to be ignored &-- other failures
17398 cause the router to defer.
17399
17400 Expansion of &%router_home_directory%& happens immediately after the
17401 &%check_local_user%& test (if configured), before any further expansions take
17402 place.
17403 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17404 are evaluated.)
17405 While the router is running, &%router_home_directory%& overrides the value of
17406 &$home$& that came from &%check_local_user%&.
17407
17408 When a router accepts an address and assigns it to a local transport (including
17409 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17410 delivery), the home directory setting for the transport is taken from the first
17411 of these values that is set:
17412
17413 .ilist
17414 The &%home_directory%& option on the transport;
17415 .next
17416 The &%transport_home_directory%& option on the router;
17417 .next
17418 The password data if &%check_local_user%& is set on the router;
17419 .next
17420 The &%router_home_directory%& option on the router.
17421 .endlist
17422
17423 In other words, &%router_home_directory%& overrides the password data for the
17424 router, but not for the transport.
17425
17426
17427
17428 .option self routers string freeze
17429 .cindex "MX record" "pointing to local host"
17430 .cindex "local host" "MX pointing to"
17431 This option applies to those routers that use a recipient address to find a
17432 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17433 and &(manualroute)& routers.
17434 Certain configurations of the &(queryprogram)& router can also specify a list
17435 of remote hosts.
17436 Usually such routers are configured to send the message to a remote host via an
17437 &(smtp)& transport. The &%self%& option specifies what happens when the first
17438 host on the list turns out to be the local host.
17439 The way in which Exim checks for the local host is described in section
17440 &<<SECTreclocipadd>>&.
17441
17442 Normally this situation indicates either an error in Exim's configuration (for
17443 example, the router should be configured not to process this domain), or an
17444 error in the DNS (for example, the MX should not point to this host). For this
17445 reason, the default action is to log the incident, defer the address, and
17446 freeze the message. The following alternatives are provided for use in special
17447 cases:
17448
17449 .vlist
17450 .vitem &%defer%&
17451 Delivery of the message is tried again later, but the message is not frozen.
17452
17453 .vitem "&%reroute%&: <&'domain'&>"
17454 The domain is changed to the given domain, and the address is passed back to
17455 be reprocessed by the routers. No rewriting of headers takes place. This
17456 behaviour is essentially a redirection.
17457
17458 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17459 The domain is changed to the given domain, and the address is passed back to be
17460 reprocessed by the routers. Any headers that contain the original domain are
17461 rewritten.
17462
17463 .vitem &%pass%&
17464 .oindex "&%more%&"
17465 .vindex "&$self_hostname$&"
17466 The router passes the address to the next router, or to the router named in the
17467 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17468 subsequent routing and delivery, the variable &$self_hostname$& contains the
17469 name of the local host that the router encountered. This can be used to
17470 distinguish between different cases for hosts with multiple names. The
17471 combination
17472 .code
17473 self = pass
17474 no_more
17475 .endd
17476 ensures that only those addresses that routed to the local host are passed on.
17477 Without &%no_more%&, addresses that were declined for other reasons would also
17478 be passed to the next router.
17479
17480 .vitem &%fail%&
17481 Delivery fails and an error report is generated.
17482
17483 .vitem &%send%&
17484 .cindex "local host" "sending to"
17485 The anomaly is ignored and the address is queued for the transport. This
17486 setting should be used with extreme caution. For an &(smtp)& transport, it
17487 makes sense only in cases where the program that is listening on the SMTP port
17488 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17489 different configuration file that handles the domain in another way.
17490 .endlist
17491
17492
17493
17494 .option senders routers&!? "address list&!!" unset
17495 .cindex "router" "checking senders"
17496 If this option is set, the router is skipped unless the message's sender
17497 address matches something on the list.
17498 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17499 are evaluated.
17500
17501 There are issues concerning verification when the running of routers is
17502 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17503 setting, it sets the sender to the null string. When using the &%-bt%& option
17504 to check a configuration file, it is necessary also to use the &%-f%& option to
17505 set an appropriate sender. For incoming mail, the sender is unset when
17506 verifying the sender, but is available when verifying any recipients. If the
17507 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17508 matters.
17509
17510
17511 .option translate_ip_address routers string&!! unset
17512 .cindex "IP address" "translating"
17513 .cindex "packet radio"
17514 .cindex "router" "IP address translation"
17515 There exist some rare networking situations (for example, packet radio) where
17516 it is helpful to be able to translate IP addresses generated by normal routing
17517 mechanisms into other IP addresses, thus performing a kind of manual IP
17518 routing. This should be done only if the normal IP routing of the TCP/IP stack
17519 is inadequate or broken. Because this is an extremely uncommon requirement, the
17520 code to support this option is not included in the Exim binary unless
17521 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17522
17523 .vindex "&$host_address$&"
17524 The &%translate_ip_address%& string is expanded for every IP address generated
17525 by the router, with the generated address set in &$host_address$&. If the
17526 expansion is forced to fail, no action is taken.
17527 For any other expansion error, delivery of the message is deferred.
17528 If the result of the expansion is an IP address, that replaces the original
17529 address; otherwise the result is assumed to be a host name &-- this is looked
17530 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17531 produce one or more replacement IP addresses. For example, to subvert all IP
17532 addresses in some specific networks, this could be added to a router:
17533 .code
17534 translate_ip_address = \
17535   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17536     {$value}fail}}
17537 .endd
17538 The file would contain lines like
17539 .code
17540 10.2.3.128/26    some.host
17541 10.8.4.34/26     10.44.8.15
17542 .endd
17543 You should not make use of this facility unless you really understand what you
17544 are doing.
17545
17546
17547
17548 .option transport routers string&!! unset
17549 This option specifies the transport to be used when a router accepts an address
17550 and sets it up for delivery. A transport is never needed if a router is used
17551 only for verification. The value of the option is expanded at routing time,
17552 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17553 and result must be the name of one of the configured transports. If it is not,
17554 delivery is deferred.
17555
17556 The &%transport%& option is not used by the &(redirect)& router, but it does
17557 have some private options that set up transports for pipe and file deliveries
17558 (see chapter &<<CHAPredirect>>&).
17559
17560
17561
17562 .option transport_current_directory routers string&!! unset
17563 .cindex "current directory for local transport"
17564 This option associates a current directory with any address that is routed
17565 to a local transport. This can happen either because a transport is
17566 explicitly configured for the router, or because it generates a delivery to a
17567 file or a pipe. During the delivery process (that is, at transport time), this
17568 option string is expanded and is set as the current directory, unless
17569 overridden by a setting on the transport.
17570 If the expansion fails for any reason, including forced failure, an error is
17571 logged, and delivery is deferred.
17572 See chapter &<<CHAPenvironment>>& for details of the local delivery
17573 environment.
17574
17575
17576
17577
17578 .option transport_home_directory routers string&!! "see below"
17579 .cindex "home directory" "for local transport"
17580 This option associates a home directory with any address that is routed to a
17581 local transport. This can happen either because a transport is explicitly
17582 configured for the router, or because it generates a delivery to a file or a
17583 pipe. During the delivery process (that is, at transport time), the option
17584 string is expanded and is set as the home directory, unless overridden by a
17585 setting of &%home_directory%& on the transport.
17586 If the expansion fails for any reason, including forced failure, an error is
17587 logged, and delivery is deferred.
17588
17589 If the transport does not specify a home directory, and
17590 &%transport_home_directory%& is not set for the router, the home directory for
17591 the transport is taken from the password data if &%check_local_user%& is set for
17592 the router. Otherwise it is taken from &%router_home_directory%& if that option
17593 is set; if not, no home directory is set for the transport.
17594
17595 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17596 environment.
17597
17598
17599
17600
17601 .option unseen routers boolean&!! false
17602 .cindex "router" "carrying on after success"
17603 The result of string expansion for this option must be a valid boolean value,
17604 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17605 result causes an error, and delivery is deferred. If the expansion is forced to
17606 fail, the default value for the option (false) is used. Other failures cause
17607 delivery to be deferred.
17608
17609 When this option is set true, routing does not cease if the router accepts the
17610 address. Instead, a copy of the incoming address is passed to the next router,
17611 overriding a false setting of &%more%&. There is little point in setting
17612 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17613 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17614 sometimes true and sometimes false).
17615
17616 .cindex "copy of message (&%unseen%& option)"
17617 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17618 qualifier in filter files. It can be used to cause copies of messages to be
17619 delivered to some other destination, while also carrying out a normal delivery.
17620 In effect, the current address is made into a &"parent"& that has two children
17621 &-- one that is delivered as specified by this router, and a clone that goes on
17622 to be routed further. For this reason, &%unseen%& may not be combined with the
17623 &%one_time%& option in a &(redirect)& router.
17624
17625 &*Warning*&: Header lines added to the address (or specified for removal) by
17626 this router or by previous routers affect the &"unseen"& copy of the message
17627 only. The clone that continues to be processed by further routers starts with
17628 no added headers and none specified for removal. For a &%redirect%& router, if
17629 a generated address is the same as the incoming address, this can lead to
17630 duplicate addresses with different header modifications. Exim does not do
17631 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17632 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17633 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17634 &%redirect%& router may be of help.
17635
17636 Unlike the handling of header modifications, any data that was set by the
17637 &%address_data%& option in the current or previous routers &'is'& passed on to
17638 subsequent routers.
17639
17640
17641 .option user routers string&!! "see below"
17642 .cindex "uid (user id)" "local delivery"
17643 .cindex "local transports" "uid and gid"
17644 .cindex "transport" "local"
17645 .cindex "router" "user for filter processing"
17646 .cindex "filter" "user for processing"
17647 When a router queues an address for a transport, and the transport does not
17648 specify a user, the user given here is used when running the delivery process.
17649 The user may be specified numerically or by name. If expansion fails, the
17650 error is logged and delivery is deferred.
17651 This user is also used by the &(redirect)& router when running a filter file.
17652 The default is unset, except when &%check_local_user%& is set. In this case,
17653 the default is taken from the password information. If the user is specified as
17654 a name, and &%group%& is not set, the group associated with the user is used.
17655 See also &%initgroups%& and &%group%& and the discussion in chapter
17656 &<<CHAPenvironment>>&.
17657
17658
17659
17660 .option verify routers&!? boolean true
17661 Setting this option has the effect of setting &%verify_sender%& and
17662 &%verify_recipient%& to the same value.
17663
17664
17665 .option verify_only routers&!? boolean false
17666 .cindex "EXPN" "with &%verify_only%&"
17667 .oindex "&%-bv%&"
17668 .cindex "router" "used only when verifying"
17669 If this option is set, the router is used only when verifying an address,
17670 delivering in cutthrough mode or
17671 testing with the &%-bv%& option, not when actually doing a delivery, testing
17672 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17673 restricted to verifying only senders or recipients by means of
17674 &%verify_sender%& and &%verify_recipient%&.
17675
17676 &*Warning*&: When the router is being run to verify addresses for an incoming
17677 SMTP message, Exim is not running as root, but under its own uid. If the router
17678 accesses any files, you need to make sure that they are accessible to the Exim
17679 user or group.
17680
17681
17682 .option verify_recipient routers&!? boolean true
17683 If this option is false, the router is skipped when verifying recipient
17684 addresses,
17685 delivering in cutthrough mode
17686 or testing recipient verification using &%-bv%&.
17687 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17688 are evaluated.
17689
17690
17691 .option verify_sender routers&!? boolean true
17692 If this option is false, the router is skipped when verifying sender addresses
17693 or testing sender verification using &%-bvs%&.
17694 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17695 are evaluated.
17696 .ecindex IIDgenoprou1
17697 .ecindex IIDgenoprou2
17698
17699
17700
17701
17702
17703
17704 . ////////////////////////////////////////////////////////////////////////////
17705 . ////////////////////////////////////////////////////////////////////////////
17706
17707 .chapter "The accept router" "CHID4"
17708 .cindex "&(accept)& router"
17709 .cindex "routers" "&(accept)&"
17710 The &(accept)& router has no private options of its own. Unless it is being
17711 used purely for verification (see &%verify_only%&) a transport is required to
17712 be defined by the generic &%transport%& option. If the preconditions that are
17713 specified by generic options are met, the router accepts the address and queues
17714 it for the given transport. The most common use of this router is for setting
17715 up deliveries to local mailboxes. For example:
17716 .code
17717 localusers:
17718   driver = accept
17719   domains = mydomain.example
17720   check_local_user
17721   transport = local_delivery
17722 .endd
17723 The &%domains%& condition in this example checks the domain of the address, and
17724 &%check_local_user%& checks that the local part is the login of a local user.
17725 When both preconditions are met, the &(accept)& router runs, and queues the
17726 address for the &(local_delivery)& transport.
17727
17728
17729
17730
17731
17732
17733 . ////////////////////////////////////////////////////////////////////////////
17734 . ////////////////////////////////////////////////////////////////////////////
17735
17736 .chapter "The dnslookup router" "CHAPdnslookup"
17737 .scindex IIDdnsrou1 "&(dnslookup)& router"
17738 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17739 The &(dnslookup)& router looks up the hosts that handle mail for the
17740 recipient's domain in the DNS. A transport must always be set for this router,
17741 unless &%verify_only%& is set.
17742
17743 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17744 SRV records. If none are found, or if SRV support is not configured,
17745 MX records are looked up. If no MX records exist, address records are sought.
17746 However, &%mx_domains%& can be set to disable the direct use of address
17747 records.
17748
17749 MX records of equal priority are sorted by Exim into a random order. Exim then
17750 looks for address records for the host names obtained from MX or SRV records.
17751 When a host has more than one IP address, they are sorted into a random order,
17752 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17753 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17754 generic option, the router declines.
17755
17756 Unless they have the highest priority (lowest MX value), MX records that point
17757 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17758 are discarded, together with any other MX records of equal or lower priority.
17759
17760 .cindex "MX record" "pointing to local host"
17761 .cindex "local host" "MX pointing to"
17762 .oindex "&%self%&" "in &(dnslookup)& router"
17763 If the host pointed to by the highest priority MX record, or looked up as an
17764 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17765 happens is controlled by the generic &%self%& option.
17766
17767
17768 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17769 There have been problems with DNS servers when SRV records are looked up.
17770 Some mis-behaving servers return a DNS error or timeout when a non-existent
17771 SRV record is sought. Similar problems have in the past been reported for
17772 MX records. The global &%dns_again_means_nonexist%& option can help with this
17773 problem, but it is heavy-handed because it is a global option.
17774
17775 For this reason, there are two options, &%srv_fail_domains%& and
17776 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17777 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17778 an attempt to look up an SRV or MX record causes one of these results, and the
17779 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17780 such record"&. In the case of an SRV lookup, this means that the router
17781 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17782 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17783 case routing fails.
17784
17785
17786 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17787 .cindex "&(dnslookup)& router" "declines"
17788 There are a few cases where a &(dnslookup)& router will decline to accept
17789 an address; if such a router is expected to handle "all remaining non-local
17790 domains", then it is important to set &%no_more%&.
17791
17792 Reasons for a &(dnslookup)& router to decline currently include:
17793 .ilist
17794 The domain does not exist in DNS
17795 .next
17796 The domain exists but the MX record's host part is just "."; this is a common
17797 convention (borrowed from SRV) used to indicate that there is no such service
17798 for this domain and to not fall back to trying A/AAAA records.
17799 .next
17800 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17801 .next
17802 MX record points to a non-existent host.
17803 .next
17804 MX record points to an IP address and the main section option
17805 &%allow_mx_to_ip%& is not set.
17806 .next
17807 MX records exist and point to valid hosts, but all hosts resolve only to
17808 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17809 .next
17810 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17811 &%dns_check_names_pattern%& for handling one variant of this)
17812 .next
17813 &%check_secondary_mx%& is set on this router but the local host can
17814 not be found in the MX records (see below)
17815 .endlist
17816
17817
17818
17819
17820 .section "Private options for dnslookup" "SECID118"
17821 .cindex "options" "&(dnslookup)& router"
17822 The private options for the &(dnslookup)& router are as follows:
17823
17824 .option check_secondary_mx dnslookup boolean false
17825 .cindex "MX record" "checking for secondary"
17826 If this option is set, the router declines unless the local host is found in
17827 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17828 process domains for which the local host is a secondary mail exchanger
17829 differently to other domains. The way in which Exim decides whether a host is
17830 the local host is described in section &<<SECTreclocipadd>>&.
17831
17832
17833 .option check_srv dnslookup string&!! unset
17834 .cindex "SRV record" "enabling use of"
17835 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17836 addition to MX and address records. The support is disabled by default. To
17837 enable SRV support, set the &%check_srv%& option to the name of the service
17838 required. For example,
17839 .code
17840 check_srv = smtp
17841 .endd
17842 looks for SRV records that refer to the normal smtp service. The option is
17843 expanded, so the service name can vary from message to message or address
17844 to address. This might be helpful if SRV records are being used for a
17845 submission service. If the expansion is forced to fail, the &%check_srv%&
17846 option is ignored, and the router proceeds to look for MX records in the
17847 normal way.
17848
17849 When the expansion succeeds, the router searches first for SRV records for
17850 the given service (it assumes TCP protocol). A single SRV record with a
17851 host name that consists of just a single dot indicates &"no such service for
17852 this domain"&; if this is encountered, the router declines. If other kinds of
17853 SRV record are found, they are used to construct a host list for delivery
17854 according to the rules of RFC 2782. MX records are not sought in this case.
17855
17856 When no SRV records are found, MX records (and address records) are sought in
17857 the traditional way. In other words, SRV records take precedence over MX
17858 records, just as MX records take precedence over address records. Note that
17859 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17860 defined it. It is apparently believed that MX records are sufficient for email
17861 and that SRV records should not be used for this purpose. However, SRV records
17862 have an additional &"weight"& feature which some people might find useful when
17863 trying to split an SMTP load between hosts of different power.
17864
17865 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17866 when there is a DNS lookup error.
17867
17868
17869
17870 .option dnssec_request_domains dnslookup "domain list&!!" unset
17871 .cindex "MX record" "security"
17872 .cindex "DNSSEC" "MX lookup"
17873 .cindex "security" "MX lookup"
17874 .cindex "DNS" "DNSSEC"
17875 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17876 the dnssec request bit set.
17877 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
17878
17879
17880
17881 .option dnssec_require_domains dnslookup "domain list&!!" unset
17882 .cindex "MX record" "security"
17883 .cindex "DNSSEC" "MX lookup"
17884 .cindex "security" "MX lookup"
17885 .cindex "DNS" "DNSSEC"
17886 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17887 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17888 (AD bit) set wil be ignored and logged as a host-lookup failure.
17889 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
17890
17891
17892
17893 .option mx_domains dnslookup "domain list&!!" unset
17894 .cindex "MX record" "required to exist"
17895 .cindex "SRV record" "required to exist"
17896 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17897 record in order to be recognized. (The name of this option could be improved.)
17898 For example, if all the mail hosts in &'fict.example'& are known to have MX
17899 records, except for those in &'discworld.fict.example'&, you could use this
17900 setting:
17901 .code
17902 mx_domains = ! *.discworld.fict.example : *.fict.example
17903 .endd
17904 This specifies that messages addressed to a domain that matches the list but
17905 has no MX record should be bounced immediately instead of being routed using
17906 the address record.
17907
17908
17909 .option mx_fail_domains dnslookup "domain list&!!" unset
17910 If the DNS lookup for MX records for one of the domains in this list causes a
17911 DNS lookup error, Exim behaves as if no MX records were found. See section
17912 &<<SECTprowitdnsloo>>& for more discussion.
17913
17914
17915
17916
17917 .option qualify_single dnslookup boolean true
17918 .cindex "DNS" "resolver options"
17919 .cindex "DNS" "qualifying single-component names"
17920 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17921 lookups. Typically, but not standardly, this causes the resolver to qualify
17922 single-component names with the default domain. For example, on a machine
17923 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17924 &'thesaurus.ref.example'& inside the resolver. For details of what your
17925 resolver actually does, consult your man pages for &'resolver'& and
17926 &'resolv.conf'&.
17927
17928
17929
17930 .option rewrite_headers dnslookup boolean true
17931 .cindex "rewriting" "header lines"
17932 .cindex "header lines" "rewriting"
17933 If the domain name in the address that is being processed is not fully
17934 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17935 an address is specified as &'dormouse@teaparty'&, the domain might be
17936 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17937 occur as a result of setting the &%widen_domains%& option. If
17938 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17939 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17940 header lines of the message are rewritten with the full domain name.
17941
17942 This option should be turned off only when it is known that no message is
17943 ever going to be sent outside an environment where the abbreviation makes
17944 sense.
17945
17946 When an MX record is looked up in the DNS and matches a wildcard record, name
17947 servers normally return a record containing the name that has been looked up,
17948 making it impossible to detect whether a wildcard was present or not. However,
17949 some name servers have recently been seen to return the wildcard entry. If the
17950 name returned by a DNS lookup begins with an asterisk, it is not used for
17951 header rewriting.
17952
17953
17954 .option same_domain_copy_routing dnslookup boolean false
17955 .cindex "address" "copying routing"
17956 Addresses with the same domain are normally routed by the &(dnslookup)& router
17957 to the same list of hosts. However, this cannot be presumed, because the router
17958 options and preconditions may refer to the local part of the address. By
17959 default, therefore, Exim routes each address in a message independently. DNS
17960 servers run caches, so repeated DNS lookups are not normally expensive, and in
17961 any case, personal messages rarely have more than a few recipients.
17962
17963 If you are running mailing lists with large numbers of subscribers at the same
17964 domain, and you are using a &(dnslookup)& router which is independent of the
17965 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17966 lookups for identical domains in one message. In this case, when &(dnslookup)&
17967 routes an address to a remote transport, any other unrouted addresses in the
17968 message that have the same domain are automatically given the same routing
17969 without processing them independently,
17970 provided the following conditions are met:
17971
17972 .ilist
17973 No router that processed the address specified &%headers_add%& or
17974 &%headers_remove%&.
17975 .next
17976 The router did not change the address in any way, for example, by &"widening"&
17977 the domain.
17978 .endlist
17979
17980
17981
17982
17983 .option search_parents dnslookup boolean false
17984 .cindex "DNS" "resolver options"
17985 When this option is true, the resolver option RES_DNSRCH is set for DNS
17986 lookups. This is different from the &%qualify_single%& option in that it
17987 applies to domains containing dots. Typically, but not standardly, it causes
17988 the resolver to search for the name in the current domain and in parent
17989 domains. For example, on a machine in the &'fict.example'& domain, if looking
17990 up &'teaparty.wonderland'& failed, the resolver would try
17991 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17992 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17993
17994 Setting this option true can cause problems in domains that have a wildcard MX
17995 record, because any domain that does not have its own MX record matches the
17996 local wildcard.
17997
17998
17999
18000 .option srv_fail_domains dnslookup "domain list&!!" unset
18001 If the DNS lookup for SRV records for one of the domains in this list causes a
18002 DNS lookup error, Exim behaves as if no SRV records were found. See section
18003 &<<SECTprowitdnsloo>>& for more discussion.
18004
18005
18006
18007
18008 .option widen_domains dnslookup "string list" unset
18009 .cindex "domain" "partial; widening"
18010 If a DNS lookup fails and this option is set, each of its strings in turn is
18011 added onto the end of the domain, and the lookup is tried again. For example,
18012 if
18013 .code
18014 widen_domains = fict.example:ref.example
18015 .endd
18016 is set and a lookup of &'klingon.dictionary'& fails,
18017 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18018 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18019 and &%search_parents%& options can cause some widening to be undertaken inside
18020 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18021 when verifying, unless &%rewrite_headers%& is false (not the default).
18022
18023
18024 .section "Effect of qualify_single and search_parents" "SECID119"
18025 When a domain from an envelope recipient is changed by the resolver as a result
18026 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18027 corresponding address in the message's header lines unless &%rewrite_headers%&
18028 is set false. Exim then re-routes the address, using the full domain.
18029
18030 These two options affect only the DNS lookup that takes place inside the router
18031 for the domain of the address that is being routed. They do not affect lookups
18032 such as that implied by
18033 .code
18034 domains = @mx_any
18035 .endd
18036 that may happen while processing a router precondition before the router is
18037 entered. No widening ever takes place for these lookups.
18038 .ecindex IIDdnsrou1
18039 .ecindex IIDdnsrou2
18040
18041
18042
18043
18044
18045
18046
18047
18048
18049 . ////////////////////////////////////////////////////////////////////////////
18050 . ////////////////////////////////////////////////////////////////////////////
18051
18052 .chapter "The ipliteral router" "CHID5"
18053 .cindex "&(ipliteral)& router"
18054 .cindex "domain literal" "routing"
18055 .cindex "routers" "&(ipliteral)&"
18056 This router has no private options. Unless it is being used purely for
18057 verification (see &%verify_only%&) a transport is required to be defined by the
18058 generic &%transport%& option. The router accepts the address if its domain part
18059 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18060 router handles the address
18061 .code
18062 root@[192.168.1.1]
18063 .endd
18064 by setting up delivery to the host with that IP address. IPv4 domain literals
18065 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18066 are similar, but the address is preceded by &`ipv6:`&. For example:
18067 .code
18068 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18069 .endd
18070 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18071 grounds that sooner or later somebody will try it.
18072
18073 .oindex "&%self%&" "in &(ipliteral)& router"
18074 If the IP address matches something in &%ignore_target_hosts%&, the router
18075 declines. If an IP literal turns out to refer to the local host, the generic
18076 &%self%& option determines what happens.
18077
18078 The RFCs require support for domain literals; however, their use is
18079 controversial in today's Internet. If you want to use this router, you must
18080 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18081 Exim will not recognize the domain literal syntax in addresses.
18082
18083
18084
18085 . ////////////////////////////////////////////////////////////////////////////
18086 . ////////////////////////////////////////////////////////////////////////////
18087
18088 .chapter "The iplookup router" "CHID6"
18089 .cindex "&(iplookup)& router"
18090 .cindex "routers" "&(iplookup)&"
18091 The &(iplookup)& router was written to fulfil a specific requirement in
18092 Cambridge University (which in fact no longer exists). For this reason, it is
18093 not included in the binary of Exim by default. If you want to include it, you
18094 must set
18095 .code
18096 ROUTER_IPLOOKUP=yes
18097 .endd
18098 in your &_Local/Makefile_& configuration file.
18099
18100 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18101 connection to one or more specific hosts. The host can then return the same or
18102 a different address &-- in effect rewriting the recipient address in the
18103 message's envelope. The new address is then passed on to subsequent routers. If
18104 this process fails, the address can be passed on to other routers, or delivery
18105 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18106 must not be specified for it.
18107
18108 .cindex "options" "&(iplookup)& router"
18109 .option hosts iplookup string unset
18110 This option must be supplied. Its value is a colon-separated list of host
18111 names. The hosts are looked up using &[gethostbyname()]&
18112 (or &[getipnodebyname()]& when available)
18113 and are tried in order until one responds to the query. If none respond, what
18114 happens is controlled by &%optional%&.
18115
18116
18117 .option optional iplookup boolean false
18118 If &%optional%& is true, if no response is obtained from any host, the address
18119 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18120 delivery to the address is deferred.
18121
18122
18123 .option port iplookup integer 0
18124 .cindex "port" "&(iplookup)& router"
18125 This option must be supplied. It specifies the port number for the TCP or UDP
18126 call.
18127
18128
18129 .option protocol iplookup string udp
18130 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18131 protocols is to be used.
18132
18133
18134 .option query iplookup string&!! "see below"
18135 This defines the content of the query that is sent to the remote hosts. The
18136 default value is:
18137 .code
18138 $local_part@$domain $local_part@$domain
18139 .endd
18140 The repetition serves as a way of checking that a response is to the correct
18141 query in the default case (see &%response_pattern%& below).
18142
18143
18144 .option reroute iplookup string&!! unset
18145 If this option is not set, the rerouted address is precisely the byte string
18146 returned by the remote host, up to the first white space, if any. If set, the
18147 string is expanded to form the rerouted address. It can include parts matched
18148 in the response by &%response_pattern%& by means of numeric variables such as
18149 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18150 whether or not a pattern is in use. In all cases, the rerouted address must end
18151 up in the form &'local_part@domain'&.
18152
18153
18154 .option response_pattern iplookup string unset
18155 This option can be set to a regular expression that is applied to the string
18156 returned from the remote host. If the pattern does not match the response, the
18157 router declines. If &%response_pattern%& is not set, no checking of the
18158 response is done, unless the query was defaulted, in which case there is a
18159 check that the text returned after the first white space is the original
18160 address. This checks that the answer that has been received is in response to
18161 the correct question. For example, if the response is just a new domain, the
18162 following could be used:
18163 .code
18164 response_pattern = ^([^@]+)$
18165 reroute = $local_part@$1
18166 .endd
18167
18168 .option timeout iplookup time 5s
18169 This specifies the amount of time to wait for a response from the remote
18170 machine. The same timeout is used for the &[connect()]& function for a TCP
18171 call. It does not apply to UDP.
18172
18173
18174
18175
18176 . ////////////////////////////////////////////////////////////////////////////
18177 . ////////////////////////////////////////////////////////////////////////////
18178
18179 .chapter "The manualroute router" "CHID7"
18180 .scindex IIDmanrou1 "&(manualroute)& router"
18181 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18182 .cindex "domain" "manually routing"
18183 The &(manualroute)& router is so-called because it provides a way of manually
18184 routing an address according to its domain. It is mainly used when you want to
18185 route addresses to remote hosts according to your own rules, bypassing the
18186 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18187 route to local transports, a facility that may be useful if you want to save
18188 messages for dial-in hosts in local files.
18189
18190 The &(manualroute)& router compares a list of domain patterns with the domain
18191 it is trying to route. If there is no match, the router declines. Each pattern
18192 has associated with it a list of hosts and some other optional data, which may
18193 include a transport. The combination of a pattern and its data is called a
18194 &"routing rule"&. For patterns that do not have an associated transport, the
18195 generic &%transport%& option must specify a transport, unless the router is
18196 being used purely for verification (see &%verify_only%&).
18197
18198 .vindex "&$host$&"
18199 In the case of verification, matching the domain pattern is sufficient for the
18200 router to accept the address. When actually routing an address for delivery,
18201 an address that matches a domain pattern is queued for the associated
18202 transport. If the transport is not a local one, a host list must be associated
18203 with the pattern; IP addresses are looked up for the hosts, and these are
18204 passed to the transport along with the mail address. For local transports, a
18205 host list is optional. If it is present, it is passed in &$host$& as a single
18206 text string.
18207
18208 The list of routing rules can be provided as an inline string in
18209 &%route_list%&, or the data can be obtained by looking up the domain in a file
18210 or database by setting &%route_data%&. Only one of these settings may appear in
18211 any one instance of &(manualroute)&. The format of routing rules is described
18212 below, following the list of private options.
18213
18214
18215 .section "Private options for manualroute" "SECTprioptman"
18216
18217 .cindex "options" "&(manualroute)& router"
18218 The private options for the &(manualroute)& router are as follows:
18219
18220 .option host_all_ignored manualroute string defer
18221 See &%host_find_failed%&.
18222
18223 .option host_find_failed manualroute string freeze
18224 This option controls what happens when &(manualroute)& tries to find an IP
18225 address for a host, and the host does not exist. The option can be set to one
18226 of the following values:
18227 .code
18228 decline
18229 defer
18230 fail
18231 freeze
18232 ignore
18233 pass
18234 .endd
18235 The default (&"freeze"&) assumes that this state is a serious configuration
18236 error. The difference between &"pass"& and &"decline"& is that the former
18237 forces the address to be passed to the next router (or the router defined by
18238 &%pass_router%&),
18239 .oindex "&%more%&"
18240 overriding &%no_more%&, whereas the latter passes the address to the next
18241 router only if &%more%& is true.
18242
18243 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18244 cannot be found. If all the hosts in the list are ignored, the behaviour is
18245 controlled by the &%host_all_ignored%& option. This takes the same values
18246 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18247
18248 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18249 state; if a host lookup gets a temporary error, delivery is deferred unless the
18250 generic &%pass_on_timeout%& option is set.
18251
18252
18253 .option hosts_randomize manualroute boolean false
18254 .cindex "randomized host list"
18255 .cindex "host" "list of; randomized"
18256 If this option is set, the order of the items in a host list in a routing rule
18257 is randomized each time the list is used, unless an option in the routing rule
18258 overrides (see below). Randomizing the order of a host list can be used to do
18259 crude load sharing. However, if more than one mail address is routed by the
18260 same router to the same host list, the host lists are considered to be the same
18261 (even though they may be randomized into different orders) for the purpose of
18262 deciding whether to batch the deliveries into a single SMTP transaction.
18263
18264 When &%hosts_randomize%& is true, a host list may be split
18265 into groups whose order is separately randomized. This makes it possible to
18266 set up MX-like behaviour. The boundaries between groups are indicated by an
18267 item that is just &`+`& in the host list. For example:
18268 .code
18269 route_list = * host1:host2:host3:+:host4:host5
18270 .endd
18271 The order of the first three hosts and the order of the last two hosts is
18272 randomized for each use, but the first three always end up before the last two.
18273 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18274 randomized host list is passed to an &(smtp)& transport that also has
18275 &%hosts_randomize set%&, the list is not re-randomized.
18276
18277
18278 .option route_data manualroute string&!! unset
18279 If this option is set, it must expand to yield the data part of a routing rule.
18280 Typically, the expansion string includes a lookup based on the domain. For
18281 example:
18282 .code
18283 route_data = ${lookup{$domain}dbm{/etc/routes}}
18284 .endd
18285 If the expansion is forced to fail, or the result is an empty string, the
18286 router declines. Other kinds of expansion failure cause delivery to be
18287 deferred.
18288
18289
18290 .option route_list manualroute "string list" unset
18291 This string is a list of routing rules, in the form defined below. Note that,
18292 unlike most string lists, the items are separated by semicolons. This is so
18293 that they may contain colon-separated host lists.
18294
18295
18296 .option same_domain_copy_routing manualroute boolean false
18297 .cindex "address" "copying routing"
18298 Addresses with the same domain are normally routed by the &(manualroute)&
18299 router to the same list of hosts. However, this cannot be presumed, because the
18300 router options and preconditions may refer to the local part of the address. By
18301 default, therefore, Exim routes each address in a message independently. DNS
18302 servers run caches, so repeated DNS lookups are not normally expensive, and in
18303 any case, personal messages rarely have more than a few recipients.
18304
18305 If you are running mailing lists with large numbers of subscribers at the same
18306 domain, and you are using a &(manualroute)& router which is independent of the
18307 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18308 lookups for identical domains in one message. In this case, when
18309 &(manualroute)& routes an address to a remote transport, any other unrouted
18310 addresses in the message that have the same domain are automatically given the
18311 same routing without processing them independently. However, this is only done
18312 if &%headers_add%& and &%headers_remove%& are unset.
18313
18314
18315
18316
18317 .section "Routing rules in route_list" "SECID120"
18318 The value of &%route_list%& is a string consisting of a sequence of routing
18319 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18320 entered as two semicolons. Alternatively, the list separator can be changed as
18321 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18322 Empty rules are ignored. The format of each rule is
18323 .display
18324 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18325 .endd
18326 The following example contains two rules, each with a simple domain pattern and
18327 no options:
18328 .code
18329 route_list = \
18330   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18331   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18332 .endd
18333 The three parts of a rule are separated by white space. The pattern and the
18334 list of hosts can be enclosed in quotes if necessary, and if they are, the
18335 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18336 single domain pattern, which is the only mandatory item in the rule. The
18337 pattern is in the same format as one item in a domain list (see section
18338 &<<SECTdomainlist>>&),
18339 except that it may not be the name of an interpolated file.
18340 That is, it may be wildcarded, or a regular expression, or a file or database
18341 lookup (with semicolons doubled, because of the use of semicolon as a separator
18342 in a &%route_list%&).
18343
18344 The rules in &%route_list%& are searched in order until one of the patterns
18345 matches the domain that is being routed. The list of hosts and then options are
18346 then used as described below. If there is no match, the router declines. When
18347 &%route_list%& is set, &%route_data%& must not be set.
18348
18349
18350
18351 .section "Routing rules in route_data" "SECID121"
18352 The use of &%route_list%& is convenient when there are only a small number of
18353 routing rules. For larger numbers, it is easier to use a file or database to
18354 hold the routing information, and use the &%route_data%& option instead.
18355 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18356 Most commonly, &%route_data%& is set as a string that contains an
18357 expansion lookup. For example, suppose we place two routing rules in a file
18358 like this:
18359 .code
18360 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18361 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18362 .endd
18363 This data can be accessed by setting
18364 .code
18365 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18366 .endd
18367 Failure of the lookup results in an empty string, causing the router to
18368 decline. However, you do not have to use a lookup in &%route_data%&. The only
18369 requirement is that the result of expanding the string is a list of hosts,
18370 possibly followed by options, separated by white space. The list of hosts must
18371 be enclosed in quotes if it contains white space.
18372
18373
18374
18375
18376 .section "Format of the list of hosts" "SECID122"
18377 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18378 always separately expanded before use. If the expansion fails, the router
18379 declines. The result of the expansion must be a colon-separated list of names
18380 and/or IP addresses, optionally also including ports. The format of each item
18381 in the list is described in the next section. The list separator can be changed
18382 as described in section &<<SECTlistconstruct>>&.
18383
18384 If the list of hosts was obtained from a &%route_list%& item, the following
18385 variables are set during its expansion:
18386
18387 .ilist
18388 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18389 If the domain was matched against a regular expression, the numeric variables
18390 &$1$&, &$2$&, etc. may be set. For example:
18391 .code
18392 route_list = ^domain(\d+)   host-$1.text.example
18393 .endd
18394 .next
18395 &$0$& is always set to the entire domain.
18396 .next
18397 &$1$& is also set when partial matching is done in a file lookup.
18398
18399 .next
18400 .vindex "&$value$&"
18401 If the pattern that matched the domain was a lookup item, the data that was
18402 looked up is available in the expansion variable &$value$&. For example:
18403 .code
18404 route_list = lsearch;;/some/file.routes  $value
18405 .endd
18406 .endlist
18407
18408 Note the doubling of the semicolon in the pattern that is necessary because
18409 semicolon is the default route list separator.
18410
18411
18412
18413 .section "Format of one host item" "SECTformatonehostitem"
18414 Each item in the list of hosts is either a host name or an IP address,
18415 optionally with an attached port number. When no port is given, an IP address
18416 is not enclosed in brackets. When a port is specified, it overrides the port
18417 specification on the transport. The port is separated from the name or address
18418 by a colon. This leads to some complications:
18419
18420 .ilist
18421 Because colon is the default separator for the list of hosts, either
18422 the colon that specifies a port must be doubled, or the list separator must
18423 be changed. The following two examples have the same effect:
18424 .code
18425 route_list = * "host1.tld::1225 : host2.tld::1226"
18426 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18427 .endd
18428 .next
18429 When IPv6 addresses are involved, it gets worse, because they contain
18430 colons of their own. To make this case easier, it is permitted to
18431 enclose an IP address (either v4 or v6) in square brackets if a port
18432 number follows. For example:
18433 .code
18434 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18435 .endd
18436 .endlist
18437
18438 .section "How the list of hosts is used" "SECThostshowused"
18439 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18440 the hosts is tried, in the order specified, when carrying out the SMTP
18441 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18442 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18443 transport.
18444
18445 Hosts may be listed by name or by IP address. An unadorned name in the list of
18446 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18447 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18448 records in the DNS. For example:
18449 .code
18450 route_list = *  x.y.z:p.q.r/MX:e.f.g
18451 .endd
18452 If this feature is used with a port specifier, the port must come last. For
18453 example:
18454 .code
18455 route_list = *  dom1.tld/mx::1225
18456 .endd
18457 If the &%hosts_randomize%& option is set, the order of the items in the list is
18458 randomized before any lookups are done. Exim then scans the list; for any name
18459 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18460 be an interface on the local host and the item is not the first in the list,
18461 Exim discards it and any subsequent items. If it is the first item, what
18462 happens is controlled by the
18463 .oindex "&%self%&" "in &(manualroute)& router"
18464 &%self%& option of the router.
18465
18466 A name on the list that is followed by &`/MX`& is replaced with the list of
18467 hosts obtained by looking up MX records for the name. This is always a DNS
18468 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18469 below) are not relevant here. The order of these hosts is determined by the
18470 preference values in the MX records, according to the usual rules. Because
18471 randomizing happens before the MX lookup, it does not affect the order that is
18472 defined by MX preferences.
18473
18474 If the local host is present in the sublist obtained from MX records, but is
18475 not the most preferred host in that list, it and any equally or less
18476 preferred hosts are removed before the sublist is inserted into the main list.
18477
18478 If the local host is the most preferred host in the MX list, what happens
18479 depends on where in the original list of hosts the &`/MX`& item appears. If it
18480 is not the first item (that is, there are previous hosts in the main list),
18481 Exim discards this name and any subsequent items in the main list.
18482
18483 If the MX item is first in the list of hosts, and the local host is the
18484 most preferred host, what happens is controlled by the &%self%& option of the
18485 router.
18486
18487 DNS failures when lookup up the MX records are treated in the same way as DNS
18488 failures when looking up IP addresses: &%pass_on_timeout%& and
18489 &%host_find_failed%& are used when relevant.
18490
18491 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18492 whether obtained from an MX lookup or not.
18493
18494
18495
18496 .section "How the options are used" "SECThowoptused"
18497 The options are a sequence of words; in practice no more than three are ever
18498 present. One of the words can be the name of a transport; this overrides the
18499 &%transport%& option on the router for this particular routing rule only. The
18500 other words (if present) control randomization of the list of hosts on a
18501 per-rule basis, and how the IP addresses of the hosts are to be found when
18502 routing to a remote transport. These options are as follows:
18503
18504 .ilist
18505 &%randomize%&: randomize the order of the hosts in this list, overriding the
18506 setting of &%hosts_randomize%& for this routing rule only.
18507 .next
18508 &%no_randomize%&: do not randomize the order of the hosts in this list,
18509 overriding the setting of &%hosts_randomize%& for this routing rule only.
18510 .next
18511 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18512 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18513 also look in &_/etc/hosts_& or other sources of information.
18514 .next
18515 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18516 no address records are found. If there is a temporary DNS error (such as a
18517 timeout), delivery is deferred.
18518 .endlist
18519
18520 For example:
18521 .code
18522 route_list = domain1  host1:host2:host3  randomize bydns;\
18523              domain2  host4:host5
18524 .endd
18525 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18526 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18527 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18528 or &[gethostbyname()]&, and the result of the lookup is the result of that
18529 call.
18530
18531 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18532 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18533 instead of TRY_AGAIN. That is why the default action is to try a DNS
18534 lookup first. Only if that gives a definite &"no such host"& is the local
18535 function called.
18536
18537
18538
18539 If no IP address for a host can be found, what happens is controlled by the
18540 &%host_find_failed%& option.
18541
18542 .vindex "&$host$&"
18543 When an address is routed to a local transport, IP addresses are not looked up.
18544 The host list is passed to the transport in the &$host$& variable.
18545
18546
18547
18548 .section "Manualroute examples" "SECID123"
18549 In some of the examples that follow, the presence of the &%remote_smtp%&
18550 transport, as defined in the default configuration file, is assumed:
18551
18552 .ilist
18553 .cindex "smart host" "example router"
18554 The &(manualroute)& router can be used to forward all external mail to a
18555 &'smart host'&. If you have set up, in the main part of the configuration, a
18556 named domain list that contains your local domains, for example:
18557 .code
18558 domainlist local_domains = my.domain.example
18559 .endd
18560 You can arrange for all other domains to be routed to a smart host by making
18561 your first router something like this:
18562 .code
18563 smart_route:
18564   driver = manualroute
18565   domains = !+local_domains
18566   transport = remote_smtp
18567   route_list = * smarthost.ref.example
18568 .endd
18569 This causes all non-local addresses to be sent to the single host
18570 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18571 they are tried in order
18572 (but you can use &%hosts_randomize%& to vary the order each time).
18573 Another way of configuring the same thing is this:
18574 .code
18575 smart_route:
18576   driver = manualroute
18577   transport = remote_smtp
18578   route_list = !+local_domains  smarthost.ref.example
18579 .endd
18580 There is no difference in behaviour between these two routers as they stand.
18581 However, they behave differently if &%no_more%& is added to them. In the first
18582 example, the router is skipped if the domain does not match the &%domains%&
18583 precondition; the following router is always tried. If the router runs, it
18584 always matches the domain and so can never decline. Therefore, &%no_more%&
18585 would have no effect. In the second case, the router is never skipped; it
18586 always runs. However, if it doesn't match the domain, it declines. In this case
18587 &%no_more%& would prevent subsequent routers from running.
18588
18589 .next
18590 .cindex "mail hub example"
18591 A &'mail hub'& is a host which receives mail for a number of domains via MX
18592 records in the DNS and delivers it via its own private routing mechanism. Often
18593 the final destinations are behind a firewall, with the mail hub being the one
18594 machine that can connect to machines both inside and outside the firewall. The
18595 &(manualroute)& router is usually used on a mail hub to route incoming messages
18596 to the correct hosts. For a small number of domains, the routing can be inline,
18597 using the &%route_list%& option, but for a larger number a file or database
18598 lookup is easier to manage.
18599
18600 If the domain names are in fact the names of the machines to which the mail is
18601 to be sent by the mail hub, the configuration can be quite simple. For
18602 example:
18603 .code
18604 hub_route:
18605   driver = manualroute
18606   transport = remote_smtp
18607   route_list = *.rhodes.tvs.example  $domain
18608 .endd
18609 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18610 whose names are the same as the mail domains. A similar approach can be taken
18611 if the host name can be obtained from the domain name by a string manipulation
18612 that the expansion facilities can handle. Otherwise, a lookup based on the
18613 domain can be used to find the host:
18614 .code
18615 through_firewall:
18616   driver = manualroute
18617   transport = remote_smtp
18618   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18619 .endd
18620 The result of the lookup must be the name or IP address of the host (or
18621 hosts) to which the address is to be routed. If the lookup fails, the route
18622 data is empty, causing the router to decline. The address then passes to the
18623 next router.
18624
18625 .next
18626 .cindex "batched SMTP output example"
18627 .cindex "SMTP" "batched outgoing; example"
18628 You can use &(manualroute)& to deliver messages to pipes or files in batched
18629 SMTP format for onward transportation by some other means. This is one way of
18630 storing mail for a dial-up host when it is not connected. The route list entry
18631 can be as simple as a single domain name in a configuration like this:
18632 .code
18633 save_in_file:
18634   driver = manualroute
18635   transport = batchsmtp_appendfile
18636   route_list = saved.domain.example
18637 .endd
18638 though often a pattern is used to pick up more than one domain. If there are
18639 several domains or groups of domains with different transport requirements,
18640 different transports can be listed in the routing information:
18641 .code
18642 save_in_file:
18643   driver = manualroute
18644   route_list = \
18645     *.saved.domain1.example  $domain  batch_appendfile; \
18646     *.saved.domain2.example  \
18647       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18648       batch_pipe
18649 .endd
18650 .vindex "&$domain$&"
18651 .vindex "&$host$&"
18652 The first of these just passes the domain in the &$host$& variable, which
18653 doesn't achieve much (since it is also in &$domain$&), but the second does a
18654 file lookup to find a value to pass, causing the router to decline to handle
18655 the address if the lookup fails.
18656
18657 .next
18658 .cindex "UUCP" "example of router for"
18659 Routing mail directly to UUCP software is a specific case of the use of
18660 &(manualroute)& in a gateway to another mail environment. This is an example of
18661 one way it can be done:
18662 .code
18663 # Transport
18664 uucp:
18665   driver = pipe
18666   user = nobody
18667   command = /usr/local/bin/uux -r - \
18668     ${substr_-5:$host}!rmail ${local_part}
18669   return_fail_output = true
18670
18671 # Router
18672 uucphost:
18673   transport = uucp
18674   driver = manualroute
18675   route_data = \
18676     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18677 .endd
18678 The file &_/usr/local/exim/uucphosts_& contains entries like
18679 .code
18680 darksite.ethereal.example:           darksite.UUCP
18681 .endd
18682 It can be set up more simply without adding and removing &".UUCP"& but this way
18683 makes clear the distinction between the domain name
18684 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18685 .endlist
18686 .ecindex IIDmanrou1
18687 .ecindex IIDmanrou2
18688
18689
18690
18691
18692
18693
18694
18695
18696 . ////////////////////////////////////////////////////////////////////////////
18697 . ////////////////////////////////////////////////////////////////////////////
18698
18699 .chapter "The queryprogram router" "CHAPdriverlast"
18700 .scindex IIDquerou1 "&(queryprogram)& router"
18701 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18702 .cindex "routing" "by external program"
18703 The &(queryprogram)& router routes an address by running an external command
18704 and acting on its output. This is an expensive way to route, and is intended
18705 mainly for use in lightly-loaded systems, or for performing experiments.
18706 However, if it is possible to use the precondition options (&%domains%&,
18707 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18708 be used in special cases, even on a busy host. There are the following private
18709 options:
18710 .cindex "options" "&(queryprogram)& router"
18711
18712 .option command queryprogram string&!! unset
18713 This option must be set. It specifies the command that is to be run. The
18714 command is split up into a command name and arguments, and then each is
18715 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18716 &<<CHAPpipetransport>>&).
18717
18718
18719 .option command_group queryprogram string unset
18720 .cindex "gid (group id)" "in &(queryprogram)& router"
18721 This option specifies a gid to be set when running the command while routing an
18722 address for deliver. It must be set if &%command_user%& specifies a numerical
18723 uid. If it begins with a digit, it is interpreted as the numerical value of the
18724 gid. Otherwise it is looked up using &[getgrnam()]&.
18725
18726
18727 .option command_user queryprogram string unset
18728 .cindex "uid (user id)" "for &(queryprogram)&"
18729 This option must be set. It specifies the uid which is set when running the
18730 command while routing an address for delivery. If the value begins with a digit,
18731 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18732 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18733 not set, a value for the gid also.
18734
18735 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18736 root, which it does during a normal delivery in a conventional configuration.
18737 However, when an address is being verified during message reception, Exim is
18738 usually running as the Exim user, not as root. If the &(queryprogram)& router
18739 is called from a non-root process, Exim cannot change uid or gid before running
18740 the command. In this circumstance the command runs under the current uid and
18741 gid.
18742
18743
18744 .option current_directory queryprogram string /
18745 This option specifies an absolute path which is made the current directory
18746 before running the command.
18747
18748
18749 .option timeout queryprogram time 1h
18750 If the command does not complete within the timeout period, its process group
18751 is killed and the message is frozen. A value of zero time specifies no
18752 timeout.
18753
18754
18755 The standard output of the command is connected to a pipe, which is read when
18756 the command terminates. It should consist of a single line of output,
18757 containing up to five fields, separated by white space. The maximum length of
18758 the line is 1023 characters. Longer lines are silently truncated. The first
18759 field is one of the following words (case-insensitive):
18760
18761 .ilist
18762 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18763 below).
18764 .next
18765 &'Decline'&: the router declines; pass the address to the next router, unless
18766 &%no_more%& is set.
18767 .next
18768 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18769 subsequent text on the line is an error message. If the router is run as part
18770 of address verification during an incoming SMTP message, the message is
18771 included in the SMTP response.
18772 .next
18773 &'Defer'&: routing could not be completed at this time; try again later. Any
18774 subsequent text on the line is an error message which is logged. It is not
18775 included in any SMTP response.
18776 .next
18777 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18778 .next
18779 &'Pass'&: pass the address to the next router (or the router specified by
18780 &%pass_router%&), overriding &%no_more%&.
18781 .next
18782 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18783 new addresses, which are routed independently, starting with the first router,
18784 or the router specified by &%redirect_router%&, if set.
18785 .endlist
18786
18787 When the first word is &'accept'&, the remainder of the line consists of a
18788 number of keyed data values, as follows (split into two lines here, to fit on
18789 the page):
18790 .code
18791 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18792 LOOKUP=byname|bydns DATA=<text>
18793 .endd
18794 The data items can be given in any order, and all are optional. If no transport
18795 is included, the transport specified by the generic &%transport%& option is
18796 used. The list of hosts and the lookup type are needed only if the transport is
18797 an &(smtp)& transport that does not itself supply a list of hosts.
18798
18799 The format of the list of hosts is the same as for the &(manualroute)& router.
18800 As well as host names and IP addresses with optional port numbers, as described
18801 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18802 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18803 (see section &<<SECThostshowused>>&).
18804
18805 If the lookup type is not specified, Exim behaves as follows when trying to
18806 find an IP address for each host: First, a DNS lookup is done. If this yields
18807 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18808 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18809 result of the lookup is the result of that call.
18810
18811 .vindex "&$address_data$&"
18812 If the DATA field is set, its value is placed in the &$address_data$&
18813 variable. For example, this return line
18814 .code
18815 accept hosts=x1.y.example:x2.y.example data="rule1"
18816 .endd
18817 routes the address to the default transport, passing a list of two hosts. When
18818 the transport runs, the string &"rule1"& is in &$address_data$&.
18819 .ecindex IIDquerou1
18820 .ecindex IIDquerou2
18821
18822
18823
18824
18825 . ////////////////////////////////////////////////////////////////////////////
18826 . ////////////////////////////////////////////////////////////////////////////
18827
18828 .chapter "The redirect router" "CHAPredirect"
18829 .scindex IIDredrou1 "&(redirect)& router"
18830 .scindex IIDredrou2 "routers" "&(redirect)&"
18831 .cindex "alias file" "in a &(redirect)& router"
18832 .cindex "address redirection" "&(redirect)& router"
18833 The &(redirect)& router handles several kinds of address redirection. Its most
18834 common uses are for resolving local part aliases from a central alias file
18835 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18836 files, but it has many other potential uses. The incoming address can be
18837 redirected in several different ways:
18838
18839 .ilist
18840 It can be replaced by one or more new addresses which are themselves routed
18841 independently.
18842 .next
18843 It can be routed to be delivered to a given file or directory.
18844 .next
18845 It can be routed to be delivered to a specified pipe command.
18846 .next
18847 It can cause an automatic reply to be generated.
18848 .next
18849 It can be forced to fail, optionally with a custom error message.
18850 .next
18851 It can be temporarily deferred, optionally with a custom message.
18852 .next
18853 It can be discarded.
18854 .endlist
18855
18856 The generic &%transport%& option must not be set for &(redirect)& routers.
18857 However, there are some private options which define transports for delivery to
18858 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18859 &%pipe_transport%& and &%reply_transport%& descriptions below.
18860
18861
18862
18863 .section "Redirection data" "SECID124"
18864 The router operates by interpreting a text string which it obtains either by
18865 expanding the contents of the &%data%& option, or by reading the entire
18866 contents of a file whose name is given in the &%file%& option. These two
18867 options are mutually exclusive. The first is commonly used for handling system
18868 aliases, in a configuration like this:
18869 .code
18870 system_aliases:
18871   driver = redirect
18872   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18873 .endd
18874 If the lookup fails, the expanded string in this example is empty. When the
18875 expansion of &%data%& results in an empty string, the router declines. A forced
18876 expansion failure also causes the router to decline; other expansion failures
18877 cause delivery to be deferred.
18878
18879 A configuration using &%file%& is commonly used for handling users'
18880 &_.forward_& files, like this:
18881 .code
18882 userforward:
18883   driver = redirect
18884   check_local_user
18885   file = $home/.forward
18886   no_verify
18887 .endd
18888 If the file does not exist, or causes no action to be taken (for example, it is
18889 empty or consists only of comments), the router declines. &*Warning*&: This
18890 is not the case when the file contains syntactically valid items that happen to
18891 yield empty addresses, for example, items containing only RFC 2822 address
18892 comments.
18893
18894
18895
18896 .section "Forward files and address verification" "SECID125"
18897 .cindex "address redirection" "while verifying"
18898 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18899 &_.forward_& files, as in the example above. There are two reasons for this:
18900
18901 .ilist
18902 When Exim is receiving an incoming SMTP message from a remote host, it is
18903 running under the Exim uid, not as root. Exim is unable to change uid to read
18904 the file as the user, and it may not be able to read it as the Exim user. So in
18905 practice the router may not be able to operate.
18906 .next
18907 However, even when the router can operate, the existence of a &_.forward_& file
18908 is unimportant when verifying an address. What should be checked is whether the
18909 local part is a valid user name or not. Cutting out the redirection processing
18910 saves some resources.
18911 .endlist
18912
18913
18914
18915
18916
18917
18918 .section "Interpreting redirection data" "SECID126"
18919 .cindex "Sieve filter" "specifying in redirection data"
18920 .cindex "filter" "specifying in redirection data"
18921 The contents of the data string, whether obtained from &%data%& or &%file%&,
18922 can be interpreted in two different ways:
18923
18924 .ilist
18925 If the &%allow_filter%& option is set true, and the data begins with the text
18926 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18927 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18928 respectively. Details of the syntax and semantics of filter files are described
18929 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18930 document is intended for use by end users.
18931 .next
18932 Otherwise, the data must be a comma-separated list of redirection items, as
18933 described in the next section.
18934 .endlist
18935
18936 When a message is redirected to a file (a &"mail folder"&), the file name given
18937 in a non-filter redirection list must always be an absolute path. A filter may
18938 generate a relative path &-- how this is handled depends on the transport's
18939 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18940 for the &(appendfile)& transport.
18941
18942
18943
18944 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18945 .cindex "address redirection" "non-filter list items"
18946 When the redirection data is not an Exim or Sieve filter, for example, if it
18947 comes from a conventional alias or forward file, it consists of a list of
18948 addresses, file names, pipe commands, or certain special items (see section
18949 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18950 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18951 depending on their default values. The items in the list are separated by
18952 commas or newlines.
18953 If a comma is required in an item, the entire item must be enclosed in double
18954 quotes.
18955
18956 Lines starting with a # character are comments, and are ignored, and # may
18957 also appear following a comma, in which case everything between the # and the
18958 next newline character is ignored.
18959
18960 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18961 double quotes are retained because some forms of mail address require their use
18962 (but never to enclose the entire address). In the following description,
18963 &"item"& refers to what remains after any surrounding double quotes have been
18964 removed.
18965
18966 .vindex "&$local_part$&"
18967 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18968 and the expansion contains a reference to &$local_part$&, you should make use
18969 of the &%quote_local_part%& expansion operator, in case the local part contains
18970 special characters. For example, to redirect all mail for the domain
18971 &'obsolete.example'&, retaining the existing local part, you could use this
18972 setting:
18973 .code
18974 data = ${quote_local_part:$local_part}@newdomain.example
18975 .endd
18976
18977
18978 .section "Redirecting to a local mailbox" "SECTredlocmai"
18979 .cindex "routing" "loops in"
18980 .cindex "loop" "while routing, avoidance of"
18981 .cindex "address redirection" "to local mailbox"
18982 A redirection item may safely be the same as the address currently under
18983 consideration. This does not cause a routing loop, because a router is
18984 automatically skipped if any ancestor of the address that is being processed
18985 is the same as the current address and was processed by the current router.
18986 Such an address is therefore passed to the following routers, so it is handled
18987 as if there were no redirection. When making this loop-avoidance test, the
18988 complete local part, including any prefix or suffix, is used.
18989
18990 .cindex "address redirection" "local part without domain"
18991 Specifying the same local part without a domain is a common usage in personal
18992 filter files when the user wants to have messages delivered to the local
18993 mailbox and also forwarded elsewhere. For example, the user whose login is
18994 &'cleo'& might have a &_.forward_& file containing this:
18995 .code
18996 cleo, cleopatra@egypt.example
18997 .endd
18998 .cindex "backslash in alias file"
18999 .cindex "alias file" "backslash in"
19000 For compatibility with other MTAs, such unqualified local parts may be
19001 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19002 it does make a difference if more than one domain is being handled
19003 synonymously.
19004
19005 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19006 2822 address that does not include a domain, the item is qualified using the
19007 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19008 addresses are qualified using the value in &%qualify_recipient%&, but you can
19009 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19010
19011 Care must be taken if there are alias names for local users.
19012 Consider an MTA handling a single local domain where the system alias file
19013 contains:
19014 .code
19015 Sam.Reman: spqr
19016 .endd
19017 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19018 messages in the local mailbox, and also forward copies elsewhere. He creates
19019 this forward file:
19020 .code
19021 Sam.Reman, spqr@reme.elsewhere.example
19022 .endd
19023 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19024 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19025 second time round, because it has previously routed it,
19026 and the following routers presumably cannot handle the alias. The forward file
19027 should really contain
19028 .code
19029 spqr, spqr@reme.elsewhere.example
19030 .endd
19031 but because this is such a common error, the &%check_ancestor%& option (see
19032 below) exists to provide a way to get round it. This is normally set on a
19033 &(redirect)& router that is handling users' &_.forward_& files.
19034
19035
19036
19037 .section "Special items in redirection lists" "SECTspecitredli"
19038 In addition to addresses, the following types of item may appear in redirection
19039 lists (that is, in non-filter redirection data):
19040
19041 .ilist
19042 .cindex "pipe" "in redirection list"
19043 .cindex "address redirection" "to pipe"
19044 An item is treated as a pipe command if it begins with &"|"& and does not parse
19045 as a valid RFC 2822 address that includes a domain. A transport for running the
19046 command must be specified by the &%pipe_transport%& option.
19047 Normally, either the router or the transport specifies a user and a group under
19048 which to run the delivery. The default is to use the Exim user and group.
19049
19050 Single or double quotes can be used for enclosing the individual arguments of
19051 the pipe command; no interpretation of escapes is done for single quotes. If
19052 the command contains a comma character, it is necessary to put the whole item
19053 in double quotes, for example:
19054 .code
19055 "|/some/command ready,steady,go"
19056 .endd
19057 since items in redirection lists are terminated by commas. Do not, however,
19058 quote just the command. An item such as
19059 .code
19060 |"/some/command ready,steady,go"
19061 .endd
19062 is interpreted as a pipe with a rather strange command name, and no arguments.
19063
19064 Note that the above example assumes that the text comes from a lookup source
19065 of some sort, so that the quotes are part of the data.  If composing a
19066 redirect router with a &%data%& option directly specifying this command, the
19067 quotes will be used by the configuration parser to define the extent of one
19068 string, but will not be passed down into the redirect router itself.  There
19069 are two main approaches to get around this: escape quotes to be part of the
19070 data itself, or avoid using this mechanism and instead create a custom
19071 transport with the &%command%& option set and reference that transport from
19072 an &%accept%& router.
19073
19074 .next
19075 .cindex "file" "in redirection list"
19076 .cindex "address redirection" "to file"
19077 An item is interpreted as a path name if it begins with &"/"& and does not
19078 parse as a valid RFC 2822 address that includes a domain. For example,
19079 .code
19080 /home/world/minbari
19081 .endd
19082 is treated as a file name, but
19083 .code
19084 /s=molari/o=babylon/@x400gate.way
19085 .endd
19086 is treated as an address. For a file name, a transport must be specified using
19087 the &%file_transport%& option. However, if the generated path name ends with a
19088 forward slash character, it is interpreted as a directory name rather than a
19089 file name, and &%directory_transport%& is used instead.
19090
19091 Normally, either the router or the transport specifies a user and a group under
19092 which to run the delivery. The default is to use the Exim user and group.
19093
19094 .cindex "&_/dev/null_&"
19095 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19096 bypassed at a high level, and the log entry shows &"**bypassed**"&
19097 instead of a transport name. In this case the user and group are not used.
19098
19099 .next
19100 .cindex "included address list"
19101 .cindex "address redirection" "included external list"
19102 If an item is of the form
19103 .code
19104 :include:<path name>
19105 .endd
19106 a list of further items is taken from the given file and included at that
19107 point. &*Note*&: Such a file can not be a filter file; it is just an
19108 out-of-line addition to the list. The items in the included list are separated
19109 by commas or newlines and are not subject to expansion. If this is the first
19110 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19111 the alias name. This example is incorrect:
19112 .code
19113 list1    :include:/opt/lists/list1
19114 .endd
19115 It must be given as
19116 .code
19117 list1:   :include:/opt/lists/list1
19118 .endd
19119 .next
19120 .cindex "address redirection" "to black hole"
19121 Sometimes you want to throw away mail to a particular local part. Making the
19122 &%data%& option expand to an empty string does not work, because that causes
19123 the router to decline. Instead, the alias item
19124 .cindex "black hole"
19125 .cindex "abandoning mail"
19126 &':blackhole:'& can be used. It does what its name implies. No delivery is
19127 done, and no error message is generated. This has the same effect as specifing
19128 &_/dev/null_& as a destination, but it can be independently disabled.
19129
19130 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19131 delivery is done for the original local part, even if other redirection items
19132 are present. If you are generating a multi-item list (for example, by reading a
19133 database) and need the ability to provide a no-op item, you must use
19134 &_/dev/null_&.
19135
19136 .next
19137 .cindex "delivery" "forcing failure"
19138 .cindex "delivery" "forcing deferral"
19139 .cindex "failing delivery" "forcing"
19140 .cindex "deferred delivery, forcing"
19141 .cindex "customizing" "failure message"
19142 An attempt to deliver a particular address can be deferred or forced to fail by
19143 redirection items of the form
19144 .code
19145 :defer:
19146 :fail:
19147 .endd
19148 respectively. When a redirection list contains such an item, it applies
19149 to the entire redirection; any other items in the list are ignored. Any
19150 text following &':fail:'& or &':defer:'& is placed in the error text
19151 associated with the failure. For example, an alias file might contain:
19152 .code
19153 X.Employee:  :fail: Gone away, no forwarding address
19154 .endd
19155 In the case of an address that is being verified from an ACL or as the subject
19156 of a
19157 .cindex "VRFY" "error text, display of"
19158 VRFY command, the text is included in the SMTP error response by
19159 default.
19160 .cindex "EXPN" "error text, display of"
19161 The text is not included in the response to an EXPN command. In non-SMTP cases
19162 the text is included in the error message that Exim generates.
19163
19164 .cindex "SMTP" "error codes"
19165 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19166 &':fail:'&. However, if the message starts with three digits followed by a
19167 space, optionally followed by an extended code of the form &'n.n.n'&, also
19168 followed by a space, and the very first digit is the same as the default error
19169 code, the code from the message is used instead. If the very first digit is
19170 incorrect, a panic error is logged, and the default code is used. You can
19171 suppress the use of the supplied code in a redirect router by setting the
19172 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19173 ignored.
19174
19175 .vindex "&$acl_verify_message$&"
19176 In an ACL, an explicitly provided message overrides the default, but the
19177 default message is available in the variable &$acl_verify_message$& and can
19178 therefore be included in a custom message if this is desired.
19179
19180 Normally the error text is the rest of the redirection list &-- a comma does
19181 not terminate it &-- but a newline does act as a terminator. Newlines are not
19182 normally present in alias expansions. In &(lsearch)& lookups they are removed
19183 as part of the continuation process, but they may exist in other kinds of
19184 lookup and in &':include:'& files.
19185
19186 During routing for message delivery (as opposed to verification), a redirection
19187 containing &':fail:'& causes an immediate failure of the incoming address,
19188 whereas &':defer:'& causes the message to remain on the queue so that a
19189 subsequent delivery attempt can happen at a later time. If an address is
19190 deferred for too long, it will ultimately fail, because the normal retry
19191 rules still apply.
19192
19193 .next
19194 .cindex "alias file" "exception to default"
19195 Sometimes it is useful to use a single-key search type with a default (see
19196 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19197 for exceptions to the default. These can be handled by aliasing them to
19198 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19199 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19200 results in an empty redirection list has the same effect.
19201 .endlist
19202
19203
19204 .section "Duplicate addresses" "SECTdupaddr"
19205 .cindex "duplicate addresses"
19206 .cindex "address duplicate, discarding"
19207 .cindex "pipe" "duplicated"
19208 Exim removes duplicate addresses from the list to which it is delivering, so as
19209 to deliver just one copy to each address. This does not apply to deliveries
19210 routed to pipes by different immediate parent addresses, but an indirect
19211 aliasing scheme of the type
19212 .code
19213 pipe:       |/some/command $local_part
19214 localpart1: pipe
19215 localpart2: pipe
19216 .endd
19217 does not work with a message that is addressed to both local parts, because
19218 when the second is aliased to the intermediate local part &"pipe"& it gets
19219 discarded as being the same as a previously handled address. However, a scheme
19220 such as
19221 .code
19222 localpart1: |/some/command $local_part
19223 localpart2: |/some/command $local_part
19224 .endd
19225 does result in two different pipe deliveries, because the immediate parents of
19226 the pipes are distinct.
19227
19228
19229
19230 .section "Repeated redirection expansion" "SECID128"
19231 .cindex "repeated redirection expansion"
19232 .cindex "address redirection" "repeated for each delivery attempt"
19233 When a message cannot be delivered to all of its recipients immediately,
19234 leading to two or more delivery attempts, redirection expansion is carried out
19235 afresh each time for those addresses whose children were not all previously
19236 delivered. If redirection is being used as a mailing list, this can lead to new
19237 members of the list receiving copies of old messages. The &%one_time%& option
19238 can be used to avoid this.
19239
19240
19241 .section "Errors in redirection lists" "SECID129"
19242 .cindex "address redirection" "errors"
19243 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19244 error is skipped, and an entry is written to the main log. This may be useful
19245 for mailing lists that are automatically managed. Otherwise, if an error is
19246 detected while generating the list of new addresses, the original address is
19247 deferred. See also &%syntax_errors_to%&.
19248
19249
19250
19251 .section "Private options for the redirect router" "SECID130"
19252
19253 .cindex "options" "&(redirect)& router"
19254 The private options for the &(redirect)& router are as follows:
19255
19256
19257 .option allow_defer redirect boolean false
19258 Setting this option allows the use of &':defer:'& in non-filter redirection
19259 data, or the &%defer%& command in an Exim filter file.
19260
19261
19262 .option allow_fail redirect boolean false
19263 .cindex "failing delivery" "from filter"
19264 If this option is true, the &':fail:'& item can be used in a redirection list,
19265 and the &%fail%& command may be used in an Exim filter file.
19266
19267
19268 .option allow_filter redirect boolean false
19269 .cindex "filter" "enabling use of"
19270 .cindex "Sieve filter" "enabling use of"
19271 Setting this option allows Exim to interpret redirection data that starts with
19272 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19273 are some features of Exim filter files that some administrators may wish to
19274 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19275
19276 It is also possible to lock out Exim filters or Sieve filters while allowing
19277 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19278
19279
19280 The filter is run using the uid and gid set by the generic &%user%& and
19281 &%group%& options. These take their defaults from the password data if
19282 &%check_local_user%& is set, so in the normal case of users' personal filter
19283 files, the filter is run as the relevant user. When &%allow_filter%& is set
19284 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19285
19286
19287
19288 .option allow_freeze redirect boolean false
19289 .cindex "freezing messages" "allowing in filter"
19290 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19291 This command is more normally encountered in system filters, and is disabled by
19292 default for redirection filters because it isn't something you usually want to
19293 let ordinary users do.
19294
19295
19296
19297 .option check_ancestor redirect boolean false
19298 This option is concerned with handling generated addresses that are the same
19299 as some address in the list of redirection ancestors of the current address.
19300 Although it is turned off by default in the code, it is set in the default
19301 configuration file for handling users' &_.forward_& files. It is recommended
19302 for this use of the &(redirect)& router.
19303
19304 When &%check_ancestor%& is set, if a generated address (including the domain)
19305 is the same as any ancestor of the current address, it is replaced by a copy of
19306 the current address. This helps in the case where local part A is aliased to B,
19307 and B has a &_.forward_& file pointing back to A. For example, within a single
19308 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19309 &_&~jb/.forward_& contains:
19310 .code
19311 \Joe.Bloggs, <other item(s)>
19312 .endd
19313 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19314 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19315 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19316 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19317 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19318 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19319 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19320 original address. See also the &%repeat_use%& option below.
19321
19322
19323 .option check_group redirect boolean "see below"
19324 When the &%file%& option is used, the group owner of the file is checked only
19325 when this option is set. The permitted groups are those listed in the
19326 &%owngroups%& option, together with the user's default group if
19327 &%check_local_user%& is set. If the file has the wrong group, routing is
19328 deferred. The default setting for this option is true if &%check_local_user%&
19329 is set and the &%modemask%& option permits the group write bit, or if the
19330 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19331
19332
19333
19334 .option check_owner redirect boolean "see below"
19335 When the &%file%& option is used, the owner of the file is checked only when
19336 this option is set. If &%check_local_user%& is set, the local user is
19337 permitted; otherwise the owner must be one of those listed in the &%owners%&
19338 option. The default value for this option is true if &%check_local_user%& or
19339 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19340
19341
19342 .option data redirect string&!! unset
19343 This option is mutually exclusive with &%file%&. One or other of them must be
19344 set, but not both. The contents of &%data%& are expanded, and then used as the
19345 list of forwarding items, or as a set of filtering instructions. If the
19346 expansion is forced to fail, or the result is an empty string or a string that
19347 has no effect (consists entirely of comments), the router declines.
19348
19349 When filtering instructions are used, the string must begin with &"#Exim
19350 filter"&, and all comments in the string, including this initial one, must be
19351 terminated with newline characters. For example:
19352 .code
19353 data = #Exim filter\n\
19354        if $h_to: contains Exim then save $home/mail/exim endif
19355 .endd
19356 If you are reading the data from a database where newlines cannot be included,
19357 you can use the &${sg}$& expansion item to turn the escape string of your
19358 choice into a newline.
19359
19360
19361 .option directory_transport redirect string&!! unset
19362 A &(redirect)& router sets up a direct delivery to a directory when a path name
19363 ending with a slash is specified as a new &"address"&. The transport used is
19364 specified by this option, which, after expansion, must be the name of a
19365 configured transport. This should normally be an &(appendfile)& transport.
19366
19367
19368 .option file redirect string&!! unset
19369 This option specifies the name of a file that contains the redirection data. It
19370 is mutually exclusive with the &%data%& option. The string is expanded before
19371 use; if the expansion is forced to fail, the router declines. Other expansion
19372 failures cause delivery to be deferred. The result of a successful expansion
19373 must be an absolute path. The entire file is read and used as the redirection
19374 data. If the data is an empty string or a string that has no effect (consists
19375 entirely of comments), the router declines.
19376
19377 .cindex "NFS" "checking for file existence"
19378 If the attempt to open the file fails with a &"does not exist"& error, Exim
19379 runs a check on the containing directory,
19380 unless &%ignore_enotdir%& is true (see below).
19381 If the directory does not appear to exist, delivery is deferred. This can
19382 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19383 is a mount problem. If the containing directory does exist, but the file does
19384 not, the router declines.
19385
19386
19387 .option file_transport redirect string&!! unset
19388 .vindex "&$address_file$&"
19389 A &(redirect)& router sets up a direct delivery to a file when a path name not
19390 ending in a slash is specified as a new &"address"&. The transport used is
19391 specified by this option, which, after expansion, must be the name of a
19392 configured transport. This should normally be an &(appendfile)& transport. When
19393 it is running, the file name is in &$address_file$&.
19394
19395
19396 .option filter_prepend_home redirect boolean true
19397 When this option is true, if a &(save)& command in an Exim filter specifies a
19398 relative path, and &$home$& is defined, it is automatically prepended to the
19399 relative path. If this option is set false, this action does not happen. The
19400 relative path is then passed to the transport unmodified.
19401
19402
19403 .option forbid_blackhole redirect boolean false
19404 If this option is true, the &':blackhole:'& item may not appear in a
19405 redirection list.
19406
19407
19408 .option forbid_exim_filter redirect boolean false
19409 If this option is set true, only Sieve filters are permitted when
19410 &%allow_filter%& is true.
19411
19412
19413
19414
19415 .option forbid_file redirect boolean false
19416 .cindex "delivery" "to file; forbidding"
19417 .cindex "Sieve filter" "forbidding delivery to a file"
19418 .cindex "Sieve filter" "&""keep""& facility; disabling"
19419 If this option is true, this router may not generate a new address that
19420 specifies delivery to a local file or directory, either from a filter or from a
19421 conventional forward file. This option is forced to be true if &%one_time%& is
19422 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19423 locks out the Sieve's &"keep"& facility.
19424
19425
19426 .option forbid_filter_dlfunc redirect boolean false
19427 .cindex "filter" "locking out certain features"
19428 If this option is true, string expansions in Exim filters are not allowed to
19429 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19430 functions.
19431
19432 .option forbid_filter_existstest redirect boolean false
19433 .cindex "expansion" "statting a file"
19434 If this option is true, string expansions in Exim filters are not allowed to
19435 make use of the &%exists%& condition or the &%stat%& expansion item.
19436
19437 .option forbid_filter_logwrite redirect boolean false
19438 If this option is true, use of the logging facility in Exim filters is not
19439 permitted. Logging is in any case available only if the filter is being run
19440 under some unprivileged uid (which is normally the case for ordinary users'
19441 &_.forward_& files).
19442
19443
19444 .option forbid_filter_lookup redirect boolean false
19445 If this option is true, string expansions in Exim filter files are not allowed
19446 to make use of &%lookup%& items.
19447
19448
19449 .option forbid_filter_perl redirect boolean false
19450 This option has an effect only if Exim is built with embedded Perl support. If
19451 it is true, string expansions in Exim filter files are not allowed to make use
19452 of the embedded Perl support.
19453
19454
19455 .option forbid_filter_readfile redirect boolean false
19456 If this option is true, string expansions in Exim filter files are not allowed
19457 to make use of &%readfile%& items.
19458
19459
19460 .option forbid_filter_readsocket redirect boolean false
19461 If this option is true, string expansions in Exim filter files are not allowed
19462 to make use of &%readsocket%& items.
19463
19464
19465 .option forbid_filter_reply redirect boolean false
19466 If this option is true, this router may not generate an automatic reply
19467 message. Automatic replies can be generated only from Exim or Sieve filter
19468 files, not from traditional forward files. This option is forced to be true if
19469 &%one_time%& is set.
19470
19471
19472 .option forbid_filter_run redirect boolean false
19473 If this option is true, string expansions in Exim filter files are not allowed
19474 to make use of &%run%& items.
19475
19476
19477 .option forbid_include redirect boolean false
19478 If this option is true, items of the form
19479 .code
19480 :include:<path name>
19481 .endd
19482 are not permitted in non-filter redirection lists.
19483
19484
19485 .option forbid_pipe redirect boolean false
19486 .cindex "delivery" "to pipe; forbidding"
19487 If this option is true, this router may not generate a new address which
19488 specifies delivery to a pipe, either from an Exim filter or from a conventional
19489 forward file. This option is forced to be true if &%one_time%& is set.
19490
19491
19492 .option forbid_sieve_filter redirect boolean false
19493 If this option is set true, only Exim filters are permitted when
19494 &%allow_filter%& is true.
19495
19496
19497 .cindex "SMTP" "error codes"
19498 .option forbid_smtp_code redirect boolean false
19499 If this option is set true, any SMTP error codes that are present at the start
19500 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19501 the default codes (451 and 550, respectively) are always used.
19502
19503
19504
19505
19506 .option hide_child_in_errmsg redirect boolean false
19507 .cindex "bounce message" "redirection details; suppressing"
19508 If this option is true, it prevents Exim from quoting a child address if it
19509 generates a bounce or delay message for it. Instead it says &"an address
19510 generated from <&'the top level address'&>"&. Of course, this applies only to
19511 bounces generated locally. If a message is forwarded to another host, &'its'&
19512 bounce may well quote the generated address.
19513
19514
19515 .option ignore_eacces redirect boolean false
19516 .cindex "EACCES"
19517 If this option is set and an attempt to open a redirection file yields the
19518 EACCES error (permission denied), the &(redirect)& router behaves as if the
19519 file did not exist.
19520
19521
19522 .option ignore_enotdir redirect boolean false
19523 .cindex "ENOTDIR"
19524 If this option is set and an attempt to open a redirection file yields the
19525 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19526 router behaves as if the file did not exist.
19527
19528 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19529 router that has the &%file%& option set discovers that the file does not exist
19530 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19531 against unmounted NFS directories. If the parent can not be statted, delivery
19532 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19533 is set, because that option tells Exim to ignore &"something on the path is not
19534 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19535 that some operating systems give ENOENT where others give ENOTDIR.
19536
19537
19538
19539 .option include_directory redirect string unset
19540 If this option is set, the path names of any &':include:'& items in a
19541 redirection list must start with this directory.
19542
19543
19544 .option modemask redirect "octal integer" 022
19545 This specifies mode bits which must not be set for a file specified by the
19546 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19547
19548
19549 .option one_time redirect boolean false
19550 .cindex "one-time aliasing/forwarding expansion"
19551 .cindex "alias file" "one-time expansion"
19552 .cindex "forward file" "one-time expansion"
19553 .cindex "mailing lists" "one-time expansion"
19554 .cindex "address redirection" "one-time expansion"
19555 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19556 files each time it tries to deliver a message causes a problem when one or more
19557 of the generated addresses fails be delivered at the first attempt. The problem
19558 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19559 but of what happens when the redirection list changes during the time that the
19560 message is on Exim's queue. This is particularly true in the case of mailing
19561 lists, where new subscribers might receive copies of messages that were posted
19562 before they subscribed.
19563
19564 If &%one_time%& is set and any addresses generated by the router fail to
19565 deliver at the first attempt, the failing addresses are added to the message as
19566 &"top level"& addresses, and the parent address that generated them is marked
19567 &"delivered"&. Thus, redirection does not happen again at the next delivery
19568 attempt.
19569
19570 &*Warning 1*&: Any header line addition or removal that is specified by this
19571 router would be lost if delivery did not succeed at the first attempt. For this
19572 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19573 permitted when &%one_time%& is set.
19574
19575 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19576 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19577 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19578
19579 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19580 &%one_time%&.
19581
19582 The original top-level address is remembered with each of the generated
19583 addresses, and is output in any log messages. However, any intermediate parent
19584 addresses are not recorded. This makes a difference to the log only if
19585 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19586 typically be used for mailing lists, where there is normally just one level of
19587 expansion.
19588
19589
19590 .option owners redirect "string list" unset
19591 .cindex "ownership" "alias file"
19592 .cindex "ownership" "forward file"
19593 .cindex "alias file" "ownership"
19594 .cindex "forward file" "ownership"
19595 This specifies a list of permitted owners for the file specified by &%file%&.
19596 This list is in addition to the local user when &%check_local_user%& is set.
19597 See &%check_owner%& above.
19598
19599
19600 .option owngroups redirect "string list" unset
19601 This specifies a list of permitted groups for the file specified by &%file%&.
19602 The list is in addition to the local user's primary group when
19603 &%check_local_user%& is set. See &%check_group%& above.
19604
19605
19606 .option pipe_transport redirect string&!! unset
19607 .vindex "&$address_pipe$&"
19608 A &(redirect)& router sets up a direct delivery to a pipe when a string
19609 starting with a vertical bar character is specified as a new &"address"&. The
19610 transport used is specified by this option, which, after expansion, must be the
19611 name of a configured transport. This should normally be a &(pipe)& transport.
19612 When the transport is run, the pipe command is in &$address_pipe$&.
19613
19614
19615 .option qualify_domain redirect string&!! unset
19616 .vindex "&$qualify_recipient$&"
19617 If this option is set, and an unqualified address (one without a domain) is
19618 generated, and that address would normally be qualified by the global setting
19619 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19620 expanding this string. If the expansion fails, the router declines. If you want
19621 to revert to the default, you can have the expansion generate
19622 &$qualify_recipient$&.
19623
19624 This option applies to all unqualified addresses generated by Exim filters,
19625 but for traditional &_.forward_& files, it applies only to addresses that are
19626 not preceded by a backslash. Sieve filters cannot generate unqualified
19627 addresses.
19628
19629 .option qualify_preserve_domain redirect boolean false
19630 .cindex "domain" "in redirection; preserving"
19631 .cindex "preserving domain in redirection"
19632 .cindex "address redirection" "domain; preserving"
19633 If this option is set, the router's local &%qualify_domain%& option must not be
19634 set (a configuration error occurs if it is). If an unqualified address (one
19635 without a domain) is generated, it is qualified with the domain of the parent
19636 address (the immediately preceding ancestor) instead of the global
19637 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19638 this applies whether or not the address is preceded by a backslash.
19639
19640
19641 .option repeat_use redirect boolean true
19642 If this option is set false, the router is skipped for a child address that has
19643 any ancestor that was routed by this router. This test happens before any of
19644 the other preconditions are tested. Exim's default anti-looping rules skip
19645 only when the ancestor is the same as the current address. See also
19646 &%check_ancestor%& above and the generic &%redirect_router%& option.
19647
19648
19649 .option reply_transport redirect string&!! unset
19650 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19651 &%vacation%& command is used in a filter file. The transport used is specified
19652 by this option, which, after expansion, must be the name of a configured
19653 transport. This should normally be an &(autoreply)& transport. Other transports
19654 are unlikely to do anything sensible or useful.
19655
19656
19657 .option rewrite redirect boolean true
19658 .cindex "address redirection" "disabling rewriting"
19659 If this option is set false, addresses generated by the router are not
19660 subject to address rewriting. Otherwise, they are treated like new addresses
19661 and are rewritten according to the global rewriting rules.
19662
19663
19664 .option sieve_subaddress redirect string&!! unset
19665 The value of this option is passed to a Sieve filter to specify the
19666 :subaddress part of an address.
19667
19668 .option sieve_useraddress redirect string&!! unset
19669 The value of this option is passed to a Sieve filter to specify the :user part
19670 of an address. However, if it is unset, the entire original local part
19671 (including any prefix or suffix) is used for :user.
19672
19673
19674 .option sieve_vacation_directory redirect string&!! unset
19675 .cindex "Sieve filter" "vacation directory"
19676 To enable the &"vacation"& extension for Sieve filters, you must set
19677 &%sieve_vacation_directory%& to the directory where vacation databases are held
19678 (do not put anything else in that directory), and ensure that the
19679 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19680 needs their own directory; Exim will create it if necessary.
19681
19682
19683
19684 .option skip_syntax_errors redirect boolean false
19685 .cindex "forward file" "broken"
19686 .cindex "address redirection" "broken files"
19687 .cindex "alias file" "broken"
19688 .cindex "broken alias or forward files"
19689 .cindex "ignoring faulty addresses"
19690 .cindex "skipping faulty addresses"
19691 .cindex "error" "skipping bad syntax"
19692 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19693 non-filter redirection data are skipped, and each failing address is logged. If
19694 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19695 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19696 are expanded and placed at the head of the error message generated by
19697 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19698 be the same address as the generic &%errors_to%& option. The
19699 &%skip_syntax_errors%& option is often used when handling mailing lists.
19700
19701 If all the addresses in a redirection list are skipped because of syntax
19702 errors, the router declines to handle the original address, and it is passed to
19703 the following routers.
19704
19705 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19706 error in the filter causes filtering to be abandoned without any action being
19707 taken. The incident is logged, and the router declines to handle the address,
19708 so it is passed to the following routers.
19709
19710 .cindex "Sieve filter" "syntax errors in"
19711 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19712 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19713 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19714
19715 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19716 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19717 option, used with an address that does not get redirected, can be used to
19718 notify users of these errors, by means of a router like this:
19719 .code
19720 userforward:
19721   driver = redirect
19722   allow_filter
19723   check_local_user
19724   file = $home/.forward
19725   file_transport = address_file
19726   pipe_transport = address_pipe
19727   reply_transport = address_reply
19728   no_verify
19729   skip_syntax_errors
19730   syntax_errors_to = real-$local_part@$domain
19731   syntax_errors_text = \
19732    This is an automatically generated message. An error has\n\
19733    been found in your .forward file. Details of the error are\n\
19734    reported below. While this error persists, you will receive\n\
19735    a copy of this message for every message that is addressed\n\
19736    to you. If your .forward file is a filter file, or if it is\n\
19737    a non-filter file containing no valid forwarding addresses,\n\
19738    a copy of each incoming message will be put in your normal\n\
19739    mailbox. If a non-filter file contains at least one valid\n\
19740    forwarding address, forwarding to the valid addresses will\n\
19741    happen, and those will be the only deliveries that occur.
19742 .endd
19743 You also need a router to ensure that local addresses that are prefixed by
19744 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19745 put this immediately before the &(userforward)& router:
19746 .code
19747 real_localuser:
19748   driver = accept
19749   check_local_user
19750   local_part_prefix = real-
19751   transport = local_delivery
19752 .endd
19753 For security, it would probably be a good idea to restrict the use of this
19754 router to locally-generated messages, using a condition such as this:
19755 .code
19756   condition = ${if match {$sender_host_address}\
19757                          {\N^(|127\.0\.0\.1)$\N}}
19758 .endd
19759
19760
19761 .option syntax_errors_text redirect string&!! unset
19762 See &%skip_syntax_errors%& above.
19763
19764
19765 .option syntax_errors_to redirect string unset
19766 See &%skip_syntax_errors%& above.
19767 .ecindex IIDredrou1
19768 .ecindex IIDredrou2
19769
19770
19771
19772
19773
19774
19775 . ////////////////////////////////////////////////////////////////////////////
19776 . ////////////////////////////////////////////////////////////////////////////
19777
19778 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19779          "Environment for local transports"
19780 .scindex IIDenvlotra1 "local transports" "environment for"
19781 .scindex IIDenvlotra2 "environment for local transports"
19782 .scindex IIDenvlotra3 "transport" "local; environment for"
19783 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19784 transport can be thought of as similar to a pipe.) Exim always runs transports
19785 in subprocesses, under specified uids and gids. Typical deliveries to local
19786 mailboxes run under the uid and gid of the local user.
19787
19788 Exim also sets a specific current directory while running the transport; for
19789 some transports a home directory setting is also relevant. The &(pipe)&
19790 transport is the only one that sets up environment variables; see section
19791 &<<SECTpipeenv>>& for details.
19792
19793 The values used for the uid, gid, and the directories may come from several
19794 different places. In many cases, the router that handles the address associates
19795 settings with that address as a result of its &%check_local_user%&, &%group%&,
19796 or &%user%& options. However, values may also be given in the transport's own
19797 configuration, and these override anything that comes from the router.
19798
19799
19800
19801 .section "Concurrent deliveries" "SECID131"
19802 .cindex "concurrent deliveries"
19803 .cindex "simultaneous deliveries"
19804 If two different messages for the same local recipient arrive more or less
19805 simultaneously, the two delivery processes are likely to run concurrently. When
19806 the &(appendfile)& transport is used to write to a file, Exim applies locking
19807 rules to stop concurrent processes from writing to the same file at the same
19808 time.
19809
19810 However, when you use a &(pipe)& transport, it is up to you to arrange any
19811 locking that is needed. Here is a silly example:
19812 .code
19813 my_transport:
19814   driver = pipe
19815   command = /bin/sh -c 'cat >>/some/file'
19816 .endd
19817 This is supposed to write the message at the end of the file. However, if two
19818 messages arrive at the same time, the file will be scrambled. You can use the
19819 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19820 file using the same algorithm that Exim itself uses.
19821
19822
19823
19824
19825 .section "Uids and gids" "SECTenvuidgid"
19826 .cindex "local transports" "uid and gid"
19827 .cindex "transport" "local; uid and gid"
19828 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19829 overrides any group that the router set in the address, even if &%user%& is not
19830 set for the transport. This makes it possible, for example, to run local mail
19831 delivery under the uid of the recipient (set by the router), but in a special
19832 group (set by the transport). For example:
19833 .code
19834 # Routers ...
19835 # User/group are set by check_local_user in this router
19836 local_users:
19837   driver = accept
19838   check_local_user
19839   transport = group_delivery
19840
19841 # Transports ...
19842 # This transport overrides the group
19843 group_delivery:
19844   driver = appendfile
19845   file = /var/spool/mail/$local_part
19846   group = mail
19847 .endd
19848 If &%user%& is set for a transport, its value overrides what is set in the
19849 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19850 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19851 set.
19852
19853 .oindex "&%initgroups%&"
19854 When the uid is taken from the transport's configuration, the &[initgroups()]&
19855 function is called for the groups associated with that uid if the
19856 &%initgroups%& option is set for the transport. When the uid is not specified
19857 by the transport, but is associated with the address by a router, the option
19858 for calling &[initgroups()]& is taken from the router configuration.
19859
19860 .cindex "&(pipe)& transport" "uid for"
19861 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19862 is set and &%user%& is not set, the uid of the process that called Exim to
19863 receive the message is used, and if &%group%& is not set, the corresponding
19864 original gid is also used.
19865
19866 This is the detailed preference order for obtaining a gid; the first of the
19867 following that is set is used:
19868
19869 .ilist
19870 A &%group%& setting of the transport;
19871 .next
19872 A &%group%& setting of the router;
19873 .next
19874 A gid associated with a user setting of the router, either as a result of
19875 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19876 .next
19877 The group associated with a non-numeric &%user%& setting of the transport;
19878 .next
19879 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19880 the uid is the creator's uid;
19881 .next
19882 The Exim gid if the Exim uid is being used as a default.
19883 .endlist
19884
19885 If, for example, the user is specified numerically on the router and there are
19886 no group settings, no gid is available. In this situation, an error occurs.
19887 This is different for the uid, for which there always is an ultimate default.
19888 The first of the following that is set is used:
19889
19890 .ilist
19891 A &%user%& setting of the transport;
19892 .next
19893 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19894 .next
19895 A &%user%& setting of the router;
19896 .next
19897 A &%check_local_user%& setting of the router;
19898 .next
19899 The Exim uid.
19900 .endlist
19901
19902 Of course, an error will still occur if the uid that is chosen is on the
19903 &%never_users%& list.
19904
19905
19906
19907
19908
19909 .section "Current and home directories" "SECID132"
19910 .cindex "current directory for local transport"
19911 .cindex "home directory" "for local transport"
19912 .cindex "transport" "local; home directory for"
19913 .cindex "transport" "local; current directory for"
19914 Routers may set current and home directories for local transports by means of
19915 the &%transport_current_directory%& and &%transport_home_directory%& options.
19916 However, if the transport's &%current_directory%& or &%home_directory%& options
19917 are set, they override the router's values. In detail, the home directory
19918 for a local transport is taken from the first of these values that is set:
19919
19920 .ilist
19921 The &%home_directory%& option on the transport;
19922 .next
19923 The &%transport_home_directory%& option on the router;
19924 .next
19925 The password data if &%check_local_user%& is set on the router;
19926 .next
19927 The &%router_home_directory%& option on the router.
19928 .endlist
19929
19930 The current directory is taken from the first of these values that is set:
19931
19932 .ilist
19933 The &%current_directory%& option on the transport;
19934 .next
19935 The &%transport_current_directory%& option on the router.
19936 .endlist
19937
19938
19939 If neither the router nor the transport sets a current directory, Exim uses the
19940 value of the home directory, if it is set. Otherwise it sets the current
19941 directory to &_/_& before running a local transport.
19942
19943
19944
19945 .section "Expansion variables derived from the address" "SECID133"
19946 .vindex "&$domain$&"
19947 .vindex "&$local_part$&"
19948 .vindex "&$original_domain$&"
19949 Normally a local delivery is handling a single address, and in that case the
19950 variables such as &$domain$& and &$local_part$& are set during local
19951 deliveries. However, in some circumstances more than one address may be handled
19952 at once (for example, while writing batch SMTP for onward transmission by some
19953 other means). In this case, the variables associated with the local part are
19954 never set, &$domain$& is set only if all the addresses have the same domain,
19955 and &$original_domain$& is never set.
19956 .ecindex IIDenvlotra1
19957 .ecindex IIDenvlotra2
19958 .ecindex IIDenvlotra3
19959
19960
19961
19962
19963
19964
19965
19966 . ////////////////////////////////////////////////////////////////////////////
19967 . ////////////////////////////////////////////////////////////////////////////
19968
19969 .chapter "Generic options for transports" "CHAPtransportgeneric"
19970 .scindex IIDgenoptra1 "generic options" "transport"
19971 .scindex IIDgenoptra2 "options" "generic; for transports"
19972 .scindex IIDgenoptra3 "transport" "generic options for"
19973 The following generic options apply to all transports:
19974
19975
19976 .option body_only transports boolean false
19977 .cindex "transport" "body only"
19978 .cindex "message" "transporting body only"
19979 .cindex "body of message" "transporting"
19980 If this option is set, the message's headers are not transported. It is
19981 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19982 or &(pipe)& transports, the settings of &%message_prefix%& and
19983 &%message_suffix%& should be checked, because this option does not
19984 automatically suppress them.
19985
19986
19987 .option current_directory transports string&!! unset
19988 .cindex "transport" "current directory for"
19989 This specifies the current directory that is to be set while running the
19990 transport, overriding any value that may have been set by the router.
19991 If the expansion fails for any reason, including forced failure, an error is
19992 logged, and delivery is deferred.
19993
19994
19995 .option disable_logging transports boolean false
19996 If this option is set true, nothing is logged for any
19997 deliveries by the transport or for any
19998 transport errors. You should not set this option unless you really, really know
19999 what you are doing.
20000
20001
20002 .option debug_print transports string&!! unset
20003 .cindex "testing" "variables in drivers"
20004 If this option is set and debugging is enabled (see the &%-d%& command line
20005 option), the string is expanded and included in the debugging output when the
20006 transport is run.
20007 If expansion of the string fails, the error message is written to the debugging
20008 output, and Exim carries on processing.
20009 This facility is provided to help with checking out the values of variables and
20010 so on when debugging driver configurations. For example, if a &%headers_add%&
20011 option is not working properly, &%debug_print%& could be used to output the
20012 variables it references. A newline is added to the text if it does not end with
20013 one.
20014 The variables &$transport_name$& and &$router_name$& contain the name of the
20015 transport and the router that called it.
20016
20017 .option delivery_date_add transports boolean false
20018 .cindex "&'Delivery-date:'& header line"
20019 If this option is true, a &'Delivery-date:'& header is added to the message.
20020 This gives the actual time the delivery was made. As this is not a standard
20021 header, Exim has a configuration option (&%delivery_date_remove%&) which
20022 requests its removal from incoming messages, so that delivered messages can
20023 safely be resent to other recipients.
20024
20025
20026 .option driver transports string unset
20027 This specifies which of the available transport drivers is to be used.
20028 There is no default, and this option must be set for every transport.
20029
20030
20031 .option envelope_to_add transports boolean false
20032 .cindex "&'Envelope-to:'& header line"
20033 If this option is true, an &'Envelope-to:'& header is added to the message.
20034 This gives the original address(es) in the incoming envelope that caused this
20035 delivery to happen. More than one address may be present if the transport is
20036 configured to handle several addresses at once, or if more than one original
20037 address was redirected to the same final address. As this is not a standard
20038 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20039 its removal from incoming messages, so that delivered messages can safely be
20040 resent to other recipients.
20041
20042
20043 .option group transports string&!! "Exim group"
20044 .cindex "transport" "group; specifying"
20045 This option specifies a gid for running the transport process, overriding any
20046 value that the router supplies, and also overriding any value associated with
20047 &%user%& (see below).
20048
20049
20050 .option headers_add transports list&!! unset
20051 .cindex "header lines" "adding in transport"
20052 .cindex "transport" "header lines; adding"
20053 This option specifies a list of text headers, newline-separated,
20054 which are (separately) expanded and added to the header
20055 portion of a message as it is transported, as described in section
20056 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20057 routers. If the result of the expansion is an empty string, or if the expansion
20058 is forced to fail, no action is taken. Other expansion failures are treated as
20059 errors and cause the delivery to be deferred.
20060
20061 Unlike most options, &%headers_add%& can be specified multiple times
20062 for a transport; all listed headers are added.
20063
20064
20065 .option headers_only transports boolean false
20066 .cindex "transport" "header lines only"
20067 .cindex "message" "transporting headers only"
20068 .cindex "header lines" "transporting"
20069 If this option is set, the message's body is not transported. It is mutually
20070 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20071 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20072 checked, since this option does not automatically suppress them.
20073
20074
20075 .option headers_remove transports list&!! unset
20076 .cindex "header lines" "removing"
20077 .cindex "transport" "header lines; removing"
20078 This option specifies a list of header names, colon-separated;
20079 these headers are omitted from the message as it is transported, as described
20080 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20081 routers.
20082 Each list item is separately expanded.
20083 If the result of the expansion is an empty string, or if the expansion
20084 is forced to fail, no action is taken. Other expansion failures are treated as
20085 errors and cause the delivery to be deferred.
20086
20087 Unlike most options, &%headers_remove%& can be specified multiple times
20088 for a router; all listed headers are removed.
20089
20090
20091
20092 .option headers_rewrite transports string unset
20093 .cindex "transport" "header lines; rewriting"
20094 .cindex "rewriting" "at transport time"
20095 This option allows addresses in header lines to be rewritten at transport time,
20096 that is, as the message is being copied to its destination. The contents of the
20097 option are a colon-separated list of rewriting rules. Each rule is in exactly
20098 the same form as one of the general rewriting rules that are applied when a
20099 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20100 example,
20101 .code
20102 headers_rewrite = a@b c@d f : \
20103                   x@y w@z
20104 .endd
20105 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20106 &'w@z'& in all address-bearing header lines. The rules are applied to the
20107 header lines just before they are written out at transport time, so they affect
20108 only those copies of the message that pass through the transport. However, only
20109 the message's original header lines, and any that were added by a system
20110 filter, are rewritten. If a router or transport adds header lines, they are not
20111 affected by this option. These rewriting rules are &'not'& applied to the
20112 envelope. You can change the return path using &%return_path%&, but you cannot
20113 change envelope recipients at this time.
20114
20115
20116 .option home_directory transports string&!! unset
20117 .cindex "transport" "home directory for"
20118 .vindex "&$home$&"
20119 This option specifies a home directory setting for a local transport,
20120 overriding any value that may be set by the router. The home directory is
20121 placed in &$home$& while expanding the transport's private options. It is also
20122 used as the current directory if no current directory is set by the
20123 &%current_directory%& option on the transport or the
20124 &%transport_current_directory%& option on the router. If the expansion fails
20125 for any reason, including forced failure, an error is logged, and delivery is
20126 deferred.
20127
20128
20129 .option initgroups transports boolean false
20130 .cindex "additional groups"
20131 .cindex "groups" "additional"
20132 .cindex "transport" "group; additional"
20133 If this option is true and the uid for the delivery process is provided by the
20134 transport, the &[initgroups()]& function is called when running the transport
20135 to ensure that any additional groups associated with the uid are set up.
20136
20137
20138 .option message_size_limit transports string&!! 0
20139 .cindex "limit" "message size per transport"
20140 .cindex "size" "of message, limit"
20141 .cindex "transport" "message size; limiting"
20142 This option controls the size of messages passed through the transport. It is
20143 expanded before use; the result of the expansion must be a sequence of decimal
20144 digits, optionally followed by K or M. If the expansion fails for any reason,
20145 including forced failure, or if the result is not of the required form,
20146 delivery is deferred. If the value is greater than zero and the size of a
20147 message exceeds this limit, the address is failed. If there is any chance that
20148 the resulting bounce message could be routed to the same transport, you should
20149 ensure that &%return_size_limit%& is less than the transport's
20150 &%message_size_limit%&, as otherwise the bounce message will fail to get
20151 delivered.
20152
20153
20154
20155 .option rcpt_include_affixes transports boolean false
20156 .cindex "prefix" "for local part, including in envelope"
20157 .cindex "suffix for local part" "including in envelope"
20158 .cindex "local part" "prefix"
20159 .cindex "local part" "suffix"
20160 When this option is false (the default), and an address that has had any
20161 affixes (prefixes or suffixes) removed from the local part is delivered by any
20162 form of SMTP or LMTP, the affixes are not included. For example, if a router
20163 that contains
20164 .code
20165 local_part_prefix = *-
20166 .endd
20167 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20168 is delivered with
20169 .code
20170 RCPT TO:<xyz@some.domain>
20171 .endd
20172 This is also the case when an ACL-time callout is being used to verify a
20173 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20174 whole local part is included in the RCPT command. This option applies to BSMTP
20175 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20176 &(lmtp)& and &(smtp)& transports.
20177
20178
20179 .option retry_use_local_part transports boolean "see below"
20180 .cindex "hints database" "retry keys"
20181 When a delivery suffers a temporary failure, a retry record is created
20182 in Exim's hints database. For remote deliveries, the key for the retry record
20183 is based on the name and/or IP address of the failing remote host. For local
20184 deliveries, the key is normally the entire address, including both the local
20185 part and the domain. This is suitable for most common cases of local delivery
20186 temporary failure &-- for example, exceeding a mailbox quota should delay only
20187 deliveries to that mailbox, not to the whole domain.
20188
20189 However, in some special cases you may want to treat a temporary local delivery
20190 as a failure associated with the domain, and not with a particular local part.
20191 (For example, if you are storing all mail for some domain in files.) You can do
20192 this by setting &%retry_use_local_part%& false.
20193
20194 For all the local transports, its default value is true. For remote transports,
20195 the default value is false for tidiness, but changing the value has no effect
20196 on a remote transport in the current implementation.
20197
20198
20199 .option return_path transports string&!! unset
20200 .cindex "envelope sender"
20201 .cindex "transport" "return path; changing"
20202 .cindex "return path" "changing in transport"
20203 If this option is set, the string is expanded at transport time and replaces
20204 the existing return path (envelope sender) value in the copy of the message
20205 that is being delivered. An empty return path is permitted. This feature is
20206 designed for remote deliveries, where the value of this option is used in the
20207 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20208 only effect is to change the address that is placed in the &'Return-path:'&
20209 header line, if one is added to the message (see the next option).
20210
20211 &*Note:*& A changed return path is not logged unless you add
20212 &%return_path_on_delivery%& to the log selector.
20213
20214 .vindex "&$return_path$&"
20215 The expansion can refer to the existing value via &$return_path$&. This is
20216 either the message's envelope sender, or an address set by the
20217 &%errors_to%& option on a router. If the expansion is forced to fail, no
20218 replacement occurs; if it fails for another reason, delivery is deferred. This
20219 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20220 section &<<SECTverp>>&.
20221
20222 &*Note*&: If a delivery error is detected locally, including the case when a
20223 remote server rejects a message at SMTP time, the bounce message is not sent to
20224 the value of this option. It is sent to the previously set errors address.
20225 This defaults to the incoming sender address, but can be changed by setting
20226 &%errors_to%& in a router.
20227
20228
20229
20230 .option return_path_add transports boolean false
20231 .cindex "&'Return-path:'& header line"
20232 If this option is true, a &'Return-path:'& header is added to the message.
20233 Although the return path is normally available in the prefix line of BSD
20234 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20235 have easy access to it.
20236
20237 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20238 the delivery SMTP server makes the final delivery"&. This implies that this
20239 header should not be present in incoming messages. Exim has a configuration
20240 option, &%return_path_remove%&, which requests removal of this header from
20241 incoming messages, so that delivered messages can safely be resent to other
20242 recipients.
20243
20244
20245 .option shadow_condition transports string&!! unset
20246 See &%shadow_transport%& below.
20247
20248
20249 .option shadow_transport transports string unset
20250 .cindex "shadow transport"
20251 .cindex "transport" "shadow"
20252 A local transport may set the &%shadow_transport%& option to the name of
20253 another local transport. Shadow remote transports are not supported.
20254
20255 Whenever a delivery to the main transport succeeds, and either
20256 &%shadow_condition%& is unset, or its expansion does not result in the empty
20257 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20258 passed to the shadow transport, with the same delivery address or addresses. If
20259 expansion fails, no action is taken except that non-forced expansion failures
20260 cause a log line to be written.
20261
20262 The result of the shadow transport is discarded and does not affect the
20263 subsequent processing of the message. Only a single level of shadowing is
20264 provided; the &%shadow_transport%& option is ignored on any transport when it
20265 is running as a shadow. Options concerned with output from pipes are also
20266 ignored. The log line for the successful delivery has an item added on the end,
20267 of the form
20268 .code
20269 ST=<shadow transport name>
20270 .endd
20271 If the shadow transport did not succeed, the error message is put in
20272 parentheses afterwards. Shadow transports can be used for a number of different
20273 purposes, including keeping more detailed log information than Exim normally
20274 provides, and implementing automatic acknowledgment policies based on message
20275 headers that some sites insist on.
20276
20277
20278 .option transport_filter transports string&!! unset
20279 .cindex "transport" "filter"
20280 .cindex "filter" "transport filter"
20281 This option sets up a filtering (in the Unix shell sense) process for messages
20282 at transport time. It should not be confused with mail filtering as set up by
20283 individual users or via a system filter.
20284
20285 When the message is about to be written out, the command specified by
20286 &%transport_filter%& is started up in a separate, parallel process, and
20287 the entire message, including the header lines, is passed to it on its standard
20288 input (this in fact is done from a third process, to avoid deadlock). The
20289 command must be specified as an absolute path.
20290
20291 The lines of the message that are written to the transport filter are
20292 terminated by newline (&"\n"&). The message is passed to the filter before any
20293 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20294 lines beginning with a dot, and also before any processing implied by the
20295 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20296 &(pipe)& transports.
20297
20298 The standard error for the filter process is set to the same destination as its
20299 standard output; this is read and written to the message's ultimate
20300 destination. The process that writes the message to the filter, the
20301 filter itself, and the original process that reads the result and delivers it
20302 are all run in parallel, like a shell pipeline.
20303
20304 The filter can perform any transformations it likes, but of course should take
20305 care not to break RFC 2822 syntax. Exim does not check the result, except to
20306 test for a final newline when SMTP is in use. All messages transmitted over
20307 SMTP must end with a newline, so Exim supplies one if it is missing.
20308
20309 .cindex "content scanning" "per user"
20310 A transport filter can be used to provide content-scanning on a per-user basis
20311 at delivery time if the only required effect of the scan is to modify the
20312 message. For example, a content scan could insert a new header line containing
20313 a spam score. This could be interpreted by a filter in the user's MUA. It is
20314 not possible to discard a message at this stage.
20315
20316 .cindex "SMTP" "SIZE"
20317 A problem might arise if the filter increases the size of a message that is
20318 being sent down an SMTP connection. If the receiving SMTP server has indicated
20319 support for the SIZE parameter, Exim will have sent the size of the message
20320 at the start of the SMTP session. If what is actually sent is substantially
20321 more, the server might reject the message. This can be worked round by setting
20322 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20323 additions to the message, or to disable the use of SIZE altogether.
20324
20325 .vindex "&$pipe_addresses$&"
20326 The value of the &%transport_filter%& option is the command string for starting
20327 the filter, which is run directly from Exim, not under a shell. The string is
20328 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20329 Exim breaks it up into arguments and then expands each argument separately (see
20330 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20331 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20332 of arguments, one for each address that applies to this delivery. (This isn't
20333 an ideal name for this feature here, but as it was already implemented for the
20334 &(pipe)& transport, it seemed sensible not to change it.)
20335
20336 .vindex "&$host$&"
20337 .vindex "&$host_address$&"
20338 The expansion variables &$host$& and &$host_address$& are available when the
20339 transport is a remote one. They contain the name and IP address of the host to
20340 which the message is being sent. For example:
20341 .code
20342 transport_filter = /some/directory/transport-filter.pl \
20343   $host $host_address $sender_address $pipe_addresses
20344 .endd
20345
20346 Two problems arise if you want to use more complicated expansion items to
20347 generate transport filter commands, both of which due to the fact that the
20348 command is split up &'before'& expansion.
20349 .ilist
20350 If an expansion item contains white space, you must quote it, so that it is all
20351 part of the same command item. If the entire option setting is one such
20352 expansion item, you have to take care what kind of quoting you use. For
20353 example:
20354 .code
20355 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20356 .endd
20357 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20358 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20359 stripped by Exim when it read the option's value. When the value is used, if
20360 the single quotes were missing, the line would be split into two items,
20361 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20362 Exim tried to expand the first one.
20363 .next
20364 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20365 expansion cannot generate multiple arguments, or a command name followed by
20366 arguments. Consider this example:
20367 .code
20368 transport_filter = ${lookup{$host}lsearch{/a/file}\
20369                     {$value}{/bin/cat}}
20370 .endd
20371 The result of the lookup is interpreted as the name of the command, even
20372 if it contains white space. The simplest way round this is to use a shell:
20373 .code
20374 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20375                                {$value}{/bin/cat}}
20376 .endd
20377 .endlist
20378
20379 The filter process is run under the same uid and gid as the normal delivery.
20380 For remote deliveries this is the Exim uid/gid by default. The command should
20381 normally yield a zero return code. Transport filters are not supposed to fail.
20382 A non-zero code is taken to mean that the transport filter encountered some
20383 serious problem. Delivery of the message is deferred; the message remains on
20384 the queue and is tried again later. It is not possible to cause a message to be
20385 bounced from a transport filter.
20386
20387 If a transport filter is set on an autoreply transport, the original message is
20388 passed through the filter as it is being copied into the newly generated
20389 message, which happens if the &%return_message%& option is set.
20390
20391
20392 .option transport_filter_timeout transports time 5m
20393 .cindex "transport" "filter, timeout"
20394 When Exim is reading the output of a transport filter, it applies a timeout
20395 that can be set by this option. Exceeding the timeout is normally treated as a
20396 temporary delivery failure. However, if a transport filter is used with a
20397 &(pipe)& transport, a timeout in the transport filter is treated in the same
20398 way as a timeout in the pipe command itself. By default, a timeout is a hard
20399 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20400 becomes a temporary error.
20401
20402
20403 .option user transports string&!! "Exim user"
20404 .cindex "uid (user id)" "local delivery"
20405 .cindex "transport" "user, specifying"
20406 This option specifies the user under whose uid the delivery process is to be
20407 run, overriding any uid that may have been set by the router. If the user is
20408 given as a name, the uid is looked up from the password data, and the
20409 associated group is taken as the value of the gid to be used if the &%group%&
20410 option is not set.
20411
20412 For deliveries that use local transports, a user and group are normally
20413 specified explicitly or implicitly (for example, as a result of
20414 &%check_local_user%&) by the router or transport.
20415
20416 .cindex "hints database" "access by remote transport"
20417 For remote transports, you should leave this option unset unless you really are
20418 sure you know what you are doing. When a remote transport is running, it needs
20419 to be able to access Exim's hints databases, because each host may have its own
20420 retry data.
20421 .ecindex IIDgenoptra1
20422 .ecindex IIDgenoptra2
20423 .ecindex IIDgenoptra3
20424
20425
20426
20427
20428
20429
20430 . ////////////////////////////////////////////////////////////////////////////
20431 . ////////////////////////////////////////////////////////////////////////////
20432
20433 .chapter "Address batching in local transports" "CHAPbatching" &&&
20434          "Address batching"
20435 .cindex "transport" "local; address batching in"
20436 The only remote transport (&(smtp)&) is normally configured to handle more than
20437 one address at a time, so that when several addresses are routed to the same
20438 remote host, just one copy of the message is sent. Local transports, however,
20439 normally handle one address at a time. That is, a separate instance of the
20440 transport is run for each address that is routed to the transport. A separate
20441 copy of the message is delivered each time.
20442
20443 .cindex "batched local delivery"
20444 .oindex "&%batch_max%&"
20445 .oindex "&%batch_id%&"
20446 In special cases, it may be desirable to handle several addresses at once in a
20447 local transport, for example:
20448
20449 .ilist
20450 In an &(appendfile)& transport, when storing messages in files for later
20451 delivery by some other means, a single copy of the message with multiple
20452 recipients saves space.
20453 .next
20454 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20455 a single copy saves time, and is the normal way LMTP is expected to work.
20456 .next
20457 In a &(pipe)& transport, when passing the message
20458 to a scanner program or
20459 to some other delivery mechanism such as UUCP, multiple recipients may be
20460 acceptable.
20461 .endlist
20462
20463 These three local transports all have the same options for controlling multiple
20464 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20465 repeating the information for each transport, these options are described here.
20466
20467 The &%batch_max%& option specifies the maximum number of addresses that can be
20468 delivered together in a single run of the transport. Its default value is one
20469 (no batching). When more than one address is routed to a transport that has a
20470 &%batch_max%& value greater than one, the addresses are delivered in a batch
20471 (that is, in a single run of the transport with multiple recipients), subject
20472 to certain conditions:
20473
20474 .ilist
20475 .vindex "&$local_part$&"
20476 If any of the transport's options contain a reference to &$local_part$&, no
20477 batching is possible.
20478 .next
20479 .vindex "&$domain$&"
20480 If any of the transport's options contain a reference to &$domain$&, only
20481 addresses with the same domain are batched.
20482 .next
20483 .cindex "customizing" "batching condition"
20484 If &%batch_id%& is set, it is expanded for each address, and only those
20485 addresses with the same expanded value are batched. This allows you to specify
20486 customized batching conditions. Failure of the expansion for any reason,
20487 including forced failure, disables batching, but it does not stop the delivery
20488 from taking place.
20489 .next
20490 Batched addresses must also have the same errors address (where to send
20491 delivery errors), the same header additions and removals, the same user and
20492 group for the transport, and if a host list is present, the first host must
20493 be the same.
20494 .endlist
20495
20496 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20497 both when the file or pipe command is specified in the transport, and when it
20498 is specified by a &(redirect)& router, but all the batched addresses must of
20499 course be routed to the same file or pipe command. These two transports have an
20500 option called &%use_bsmtp%&, which causes them to deliver the message in
20501 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20502 &%check_string%& and &%escape_string%& options are forced to the values
20503 .code
20504 check_string = "."
20505 escape_string = ".."
20506 .endd
20507 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20508 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20509 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20510
20511 .cindex "&'Envelope-to:'& header line"
20512 If the generic &%envelope_to_add%& option is set for a batching transport, the
20513 &'Envelope-to:'& header that is added to the message contains all the addresses
20514 that are being processed together. If you are using a batching &(appendfile)&
20515 transport without &%use_bsmtp%&, the only way to preserve the recipient
20516 addresses is to set the &%envelope_to_add%& option.
20517
20518 .cindex "&(pipe)& transport" "with multiple addresses"
20519 .vindex "&$pipe_addresses$&"
20520 If you are using a &(pipe)& transport without BSMTP, and setting the
20521 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20522 the command. This is not a true variable; it is a bit of magic that causes each
20523 of the recipient addresses to be inserted into the command as a separate
20524 argument. This provides a way of accessing all the addresses that are being
20525 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20526 are specified by a &(redirect)& router.
20527
20528
20529
20530
20531 . ////////////////////////////////////////////////////////////////////////////
20532 . ////////////////////////////////////////////////////////////////////////////
20533
20534 .chapter "The appendfile transport" "CHAPappendfile"
20535 .scindex IIDapptra1 "&(appendfile)& transport"
20536 .scindex IIDapptra2 "transports" "&(appendfile)&"
20537 .cindex "directory creation"
20538 .cindex "creating directories"
20539 The &(appendfile)& transport delivers a message by appending it to an existing
20540 file, or by creating an entirely new file in a specified directory. Single
20541 files to which messages are appended can be in the traditional Unix mailbox
20542 format, or optionally in the MBX format supported by the Pine MUA and
20543 University of Washington IMAP daemon, &'inter alia'&. When each message is
20544 being delivered as a separate file, &"maildir"& format can optionally be used
20545 to give added protection against failures that happen part-way through the
20546 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20547 supported. For all file formats, Exim attempts to create as many levels of
20548 directory as necessary, provided that &%create_directory%& is set.
20549
20550 The code for the optional formats is not included in the Exim binary by
20551 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20552 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20553 included.
20554
20555 .cindex "quota" "system"
20556 Exim recognizes system quota errors, and generates an appropriate message. Exim
20557 also supports its own quota control within the transport, for use when the
20558 system facility is unavailable or cannot be used for some reason.
20559
20560 If there is an error while appending to a file (for example, quota exceeded or
20561 partition filled), Exim attempts to reset the file's length and last
20562 modification time back to what they were before. If there is an error while
20563 creating an entirely new file, the new file is removed.
20564
20565 Before appending to a file, a number of security checks are made, and the
20566 file is locked. A detailed description is given below, after the list of
20567 private options.
20568
20569 The &(appendfile)& transport is most commonly used for local deliveries to
20570 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20571 putting messages into files for remote delivery by some means other than Exim.
20572 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20573 option).
20574
20575
20576
20577 .section "The file and directory options" "SECTfildiropt"
20578 The &%file%& option specifies a single file, to which the message is appended;
20579 the &%directory%& option specifies a directory, in which a new file containing
20580 the message is created. Only one of these two options can be set, and for
20581 normal deliveries to mailboxes, one of them &'must'& be set.
20582
20583 .vindex "&$address_file$&"
20584 .vindex "&$local_part$&"
20585 However, &(appendfile)& is also used for delivering messages to files or
20586 directories whose names (or parts of names) are obtained from alias,
20587 forwarding, or filtering operations (for example, a &%save%& command in a
20588 user's Exim filter). When such a transport is running, &$local_part$& contains
20589 the local part that was aliased or forwarded, and &$address_file$& contains the
20590 name (or partial name) of the file or directory generated by the redirection
20591 operation. There are two cases:
20592
20593 .ilist
20594 If neither &%file%& nor &%directory%& is set, the redirection operation
20595 must specify an absolute path (one that begins with &`/`&). This is the most
20596 common case when users with local accounts use filtering to sort mail into
20597 different folders. See for example, the &(address_file)& transport in the
20598 default configuration. If the path ends with a slash, it is assumed to be the
20599 name of a directory. A delivery to a directory can also be forced by setting
20600 &%maildir_format%& or &%mailstore_format%&.
20601 .next
20602 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20603 used to determine the file or directory name for the delivery. Normally, the
20604 contents of &$address_file$& are used in some way in the string expansion.
20605 .endlist
20606
20607
20608 .cindex "Sieve filter" "configuring &(appendfile)&"
20609 .cindex "Sieve filter" "relative mailbox path handling"
20610 As an example of the second case, consider an environment where users do not
20611 have home directories. They may be permitted to use Exim filter commands of the
20612 form:
20613 .code
20614 save folder23
20615 .endd
20616 or Sieve filter commands of the form:
20617 .code
20618 require "fileinto";
20619 fileinto "folder23";
20620 .endd
20621 In this situation, the expansion of &%file%& or &%directory%& in the transport
20622 must transform the relative path into an appropriate absolute file name. In the
20623 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20624 is used as a result of a &"keep"& action in the filter. This example shows one
20625 way of handling this requirement:
20626 .code
20627 file = ${if eq{$address_file}{inbox} \
20628             {/var/mail/$local_part} \
20629             {${if eq{${substr_0_1:$address_file}}{/} \
20630                   {$address_file} \
20631                   {$home/mail/$address_file} \
20632             }} \
20633        }
20634 .endd
20635 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20636 location, absolute paths are used without change, and other folders are in the
20637 &_mail_& directory within the home directory.
20638
20639 &*Note 1*&: While processing an Exim filter, a relative path such as
20640 &_folder23_& is turned into an absolute path if a home directory is known to
20641 the router. In particular, this is the case if &%check_local_user%& is set. If
20642 you want to prevent this happening at routing time, you can set
20643 &%router_home_directory%& empty. This forces the router to pass the relative
20644 path to the transport.
20645
20646 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20647 the &%file%& or &%directory%& option is still used if it is set.
20648
20649
20650
20651
20652 .section "Private options for appendfile" "SECID134"
20653 .cindex "options" "&(appendfile)& transport"
20654
20655
20656
20657 .option allow_fifo appendfile boolean false
20658 .cindex "fifo (named pipe)"
20659 .cindex "named pipe (fifo)"
20660 .cindex "pipe" "named (fifo)"
20661 Setting this option permits delivery to named pipes (FIFOs) as well as to
20662 regular files. If no process is reading the named pipe at delivery time, the
20663 delivery is deferred.
20664
20665
20666 .option allow_symlink appendfile boolean false
20667 .cindex "symbolic link" "to mailbox"
20668 .cindex "mailbox" "symbolic link"
20669 By default, &(appendfile)& will not deliver if the path name for the file is
20670 that of a symbolic link. Setting this option relaxes that constraint, but there
20671 are security issues involved in the use of symbolic links. Be sure you know
20672 what you are doing if you set this. Details of exactly what this option affects
20673 are included in the discussion which follows this list of options.
20674
20675
20676 .option batch_id appendfile string&!! unset
20677 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20678 However, batching is automatically disabled for &(appendfile)& deliveries that
20679 happen as a result of forwarding or aliasing or other redirection directly to a
20680 file.
20681
20682
20683 .option batch_max appendfile integer 1
20684 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20685
20686
20687 .option check_group appendfile boolean false
20688 When this option is set, the group owner of the file defined by the &%file%&
20689 option is checked to see that it is the same as the group under which the
20690 delivery process is running. The default setting is false because the default
20691 file mode is 0600, which means that the group is irrelevant.
20692
20693
20694 .option check_owner appendfile boolean true
20695 When this option is set, the owner of the file defined by the &%file%& option
20696 is checked to ensure that it is the same as the user under which the delivery
20697 process is running.
20698
20699
20700 .option check_string appendfile string "see below"
20701 .cindex "&""From""& line"
20702 As &(appendfile)& writes the message, the start of each line is tested for
20703 matching &%check_string%&, and if it does, the initial matching characters are
20704 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20705 a literal string, not a regular expression, and the case of any letters it
20706 contains is significant.
20707
20708 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20709 are forced to &"."& and &".."& respectively, and any settings in the
20710 configuration are ignored. Otherwise, they default to &"From&~"& and
20711 &">From&~"& when the &%file%& option is set, and unset when any of the
20712 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20713
20714 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20715 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20716 &"From&~"& indicates the start of a new message. All four options need changing
20717 if another format is used. For example, to deliver to mailboxes in MMDF format:
20718 .cindex "MMDF format mailbox"
20719 .cindex "mailbox" "MMDF format"
20720 .code
20721 check_string = "\1\1\1\1\n"
20722 escape_string = "\1\1\1\1 \n"
20723 message_prefix = "\1\1\1\1\n"
20724 message_suffix = "\1\1\1\1\n"
20725 .endd
20726 .option create_directory appendfile boolean true
20727 .cindex "directory creation"
20728 When this option is true, Exim attempts to create any missing superior
20729 directories for the file that it is about to write. A created directory's mode
20730 is given by the &%directory_mode%& option.
20731
20732 The group ownership of a newly created directory is highly dependent on the
20733 operating system (and possibly the file system) that is being used. For
20734 example, in Solaris, if the parent directory has the setgid bit set, its group
20735 is propagated to the child; if not, the currently set group is used. However,
20736 in FreeBSD, the parent's group is always used.
20737
20738
20739
20740 .option create_file appendfile string anywhere
20741 This option constrains the location of files and directories that are created
20742 by this transport. It applies to files defined by the &%file%& option and
20743 directories defined by the &%directory%& option. In the case of maildir
20744 delivery, it applies to the top level directory, not the maildir directories
20745 beneath.
20746
20747 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20748 &"belowhome"&. In the second and third cases, a home directory must have been
20749 set for the transport. This option is not useful when an explicit file name is
20750 given for normal mailbox deliveries. It is intended for the case when file
20751 names are generated from users' &_.forward_& files. These are usually handled
20752 by an &(appendfile)& transport called &%address_file%&. See also
20753 &%file_must_exist%&.
20754
20755
20756 .option directory appendfile string&!! unset
20757 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20758 or &%directory%& must be set, unless the delivery is the direct result of a
20759 redirection (see section &<<SECTfildiropt>>&).
20760
20761 When &%directory%& is set, the string is expanded, and the message is delivered
20762 into a new file or files in or below the given directory, instead of being
20763 appended to a single mailbox file. A number of different formats are provided
20764 (see &%maildir_format%& and &%mailstore_format%&), and see section
20765 &<<SECTopdir>>& for further details of this form of delivery.
20766
20767
20768 .option directory_file appendfile string&!! "see below"
20769 .cindex "base62"
20770 .vindex "&$inode$&"
20771 When &%directory%& is set, but neither &%maildir_format%& nor
20772 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20773 whose name is obtained by expanding this string. The default value is:
20774 .code
20775 q${base62:$tod_epoch}-$inode
20776 .endd
20777 This generates a unique name from the current time, in base 62 form, and the
20778 inode of the file. The variable &$inode$& is available only when expanding this
20779 option.
20780
20781
20782 .option directory_mode appendfile "octal integer" 0700
20783 If &(appendfile)& creates any directories as a result of the
20784 &%create_directory%& option, their mode is specified by this option.
20785
20786
20787 .option escape_string appendfile string "see description"
20788 See &%check_string%& above.
20789
20790
20791 .option file appendfile string&!! unset
20792 This option is mutually exclusive with the &%directory%& option, but one of
20793 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20794 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20795 specifies a single file, to which the message is appended. One or more of
20796 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20797 &%file%&.
20798
20799 .cindex "NFS" "lock file"
20800 .cindex "locking files"
20801 .cindex "lock files"
20802 If you are using more than one host to deliver over NFS into the same
20803 mailboxes, you should always use lock files.
20804
20805 The string value is expanded for each delivery, and must yield an absolute
20806 path. The most common settings of this option are variations on one of these
20807 examples:
20808 .code
20809 file = /var/spool/mail/$local_part
20810 file = /home/$local_part/inbox
20811 file = $home/inbox
20812 .endd
20813 .cindex "&""sticky""& bit"
20814 In the first example, all deliveries are done into the same directory. If Exim
20815 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20816 create a file in the directory, so the &"sticky"& bit must be turned on for
20817 deliveries to be possible, or alternatively the &%group%& option can be used to
20818 run the delivery under a group id which has write access to the directory.
20819
20820
20821
20822 .option file_format appendfile string unset
20823 .cindex "file" "mailbox; checking existing format"
20824 This option requests the transport to check the format of an existing file
20825 before adding to it. The check consists of matching a specific string at the
20826 start of the file. The value of the option consists of an even number of
20827 colon-separated strings. The first of each pair is the test string, and the
20828 second is the name of a transport. If the transport associated with a matched
20829 string is not the current transport, control is passed over to the other
20830 transport. For example, suppose the standard &(local_delivery)& transport has
20831 this added to it:
20832 .code
20833 file_format = "From       : local_delivery :\
20834                \1\1\1\1\n : local_mmdf_delivery"
20835 .endd
20836 Mailboxes that begin with &"From"& are still handled by this transport, but if
20837 a mailbox begins with four binary ones followed by a newline, control is passed
20838 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20839 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20840 is assumed to match the current transport. If the start of a mailbox doesn't
20841 match any string, or if the transport named for a given string is not defined,
20842 delivery is deferred.
20843
20844
20845 .option file_must_exist appendfile boolean false
20846 If this option is true, the file specified by the &%file%& option must exist.
20847 A temporary error occurs if it does not, causing delivery to be deferred.
20848 If this option is false, the file is created if it does not exist.
20849
20850
20851 .option lock_fcntl_timeout appendfile time 0s
20852 .cindex "timeout" "mailbox locking"
20853 .cindex "mailbox" "locking, blocking and non-blocking"
20854 .cindex "locking files"
20855 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20856 when locking an open mailbox file. If the call fails, the delivery process
20857 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20858 Non-blocking calls are used so that the file is not kept open during the wait
20859 for the lock; the reason for this is to make it as safe as possible for
20860 deliveries over NFS in the case when processes might be accessing an NFS
20861 mailbox without using a lock file. This should not be done, but
20862 misunderstandings and hence misconfigurations are not unknown.
20863
20864 On a busy system, however, the performance of a non-blocking lock approach is
20865 not as good as using a blocking lock with a timeout. In this case, the waiting
20866 is done inside the system call, and Exim's delivery process acquires the lock
20867 and can proceed as soon as the previous lock holder releases it.
20868
20869 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20870 timeout, are used. There may still be some retrying: the maximum number of
20871 retries is
20872 .code
20873 (lock_retries * lock_interval) / lock_fcntl_timeout
20874 .endd
20875 rounded up to the next whole number. In other words, the total time during
20876 which &(appendfile)& is trying to get a lock is roughly the same, unless
20877 &%lock_fcntl_timeout%& is set very large.
20878
20879 You should consider setting this option if you are getting a lot of delayed
20880 local deliveries because of errors of the form
20881 .code
20882 failed to lock mailbox /some/file (fcntl)
20883 .endd
20884
20885 .option lock_flock_timeout appendfile time 0s
20886 This timeout applies to file locking when using &[flock()]& (see
20887 &%use_flock%&); the timeout operates in a similar manner to
20888 &%lock_fcntl_timeout%&.
20889
20890
20891 .option lock_interval appendfile time 3s
20892 This specifies the time to wait between attempts to lock the file. See below
20893 for details of locking.
20894
20895
20896 .option lock_retries appendfile integer 10
20897 This specifies the maximum number of attempts to lock the file. A value of zero
20898 is treated as 1. See below for details of locking.
20899
20900
20901 .option lockfile_mode appendfile "octal integer" 0600
20902 This specifies the mode of the created lock file, when a lock file is being
20903 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20904
20905
20906 .option lockfile_timeout appendfile time 30m
20907 .cindex "timeout" "mailbox locking"
20908 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20909 exists and is older than this value, it is assumed to have been left behind by
20910 accident, and Exim attempts to remove it.
20911
20912
20913 .option mailbox_filecount appendfile string&!! unset
20914 .cindex "mailbox" "specifying size of"
20915 .cindex "size" "of mailbox"
20916 If this option is set, it is expanded, and the result is taken as the current
20917 number of files in the mailbox. It must be a decimal number, optionally
20918 followed by K or M. This provides a way of obtaining this information from an
20919 external source that maintains the data.
20920
20921
20922 .option mailbox_size appendfile string&!! unset
20923 .cindex "mailbox" "specifying size of"
20924 .cindex "size" "of mailbox"
20925 If this option is set, it is expanded, and the result is taken as the current
20926 size the mailbox. It must be a decimal number, optionally followed by K or M.
20927 This provides a way of obtaining this information from an external source that
20928 maintains the data. This is likely to be helpful for maildir deliveries where
20929 it is computationally expensive to compute the size of a mailbox.
20930
20931
20932
20933 .option maildir_format appendfile boolean false
20934 .cindex "maildir format" "specifying"
20935 If this option is set with the &%directory%& option, the delivery is into a new
20936 file, in the &"maildir"& format that is used by other mail software. When the
20937 transport is activated directly from a &(redirect)& router (for example, the
20938 &(address_file)& transport in the default configuration), setting
20939 &%maildir_format%& causes the path received from the router to be treated as a
20940 directory, whether or not it ends with &`/`&. This option is available only if
20941 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20942 &<<SECTmaildirdelivery>>& below for further details.
20943
20944
20945 .option maildir_quota_directory_regex appendfile string "See below"
20946 .cindex "maildir format" "quota; directories included in"
20947 .cindex "quota" "maildir; directories included in"
20948 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20949 a regular expression for specifying directories, relative to the quota
20950 directory (see &%quota_directory%&), that should be included in the quota
20951 calculation. The default value is:
20952 .code
20953 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20954 .endd
20955 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20956 (directories whose names begin with a dot). If you want to exclude the
20957 &_Trash_&
20958 folder from the count (as some sites do), you need to change this setting to
20959 .code
20960 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20961 .endd
20962 This uses a negative lookahead in the regular expression to exclude the
20963 directory whose name is &_.Trash_&. When a directory is excluded from quota
20964 calculations, quota processing is bypassed for any messages that are delivered
20965 directly into that directory.
20966
20967
20968 .option maildir_retries appendfile integer 10
20969 This option specifies the number of times to retry when writing a file in
20970 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20971
20972
20973 .option maildir_tag appendfile string&!! unset
20974 This option applies only to deliveries in maildir format, and is described in
20975 section &<<SECTmaildirdelivery>>& below.
20976
20977
20978 .option maildir_use_size_file appendfile&!! boolean false
20979 .cindex "maildir format" "&_maildirsize_& file"
20980 The result of string expansion for this option must be a valid boolean value.
20981 If it is true, it enables support for &_maildirsize_& files. Exim
20982 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20983 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20984 value is zero. See &%maildir_quota_directory_regex%& above and section
20985 &<<SECTmaildirdelivery>>& below for further details.
20986
20987 .option maildirfolder_create_regex appendfile string unset
20988 .cindex "maildir format" "&_maildirfolder_& file"
20989 .cindex "&_maildirfolder_&, creating"
20990 The value of this option is a regular expression. If it is unset, it has no
20991 effect. Otherwise, before a maildir delivery takes place, the pattern is
20992 matched against the name of the maildir directory, that is, the directory
20993 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20994 delivery. If there is a match, Exim checks for the existence of a file called
20995 &_maildirfolder_& in the directory, and creates it if it does not exist.
20996 See section &<<SECTmaildirdelivery>>& for more details.
20997
20998
20999 .option mailstore_format appendfile boolean false
21000 .cindex "mailstore format" "specifying"
21001 If this option is set with the &%directory%& option, the delivery is into two
21002 new files in  &"mailstore"& format. The option is available only if
21003 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21004 below for further details.
21005
21006
21007 .option mailstore_prefix appendfile string&!! unset
21008 This option applies only to deliveries in mailstore format, and is described in
21009 section &<<SECTopdir>>& below.
21010
21011
21012 .option mailstore_suffix appendfile string&!! unset
21013 This option applies only to deliveries in mailstore format, and is described in
21014 section &<<SECTopdir>>& below.
21015
21016
21017 .option mbx_format appendfile boolean false
21018 .cindex "locking files"
21019 .cindex "file" "locking"
21020 .cindex "file" "MBX format"
21021 .cindex "MBX format, specifying"
21022 This option is available only if Exim has been compiled with SUPPORT_MBX
21023 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21024 the message is appended to the mailbox file in MBX format instead of
21025 traditional Unix format. This format is supported by Pine4 and its associated
21026 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21027
21028 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21029 automatically changed by the use of &%mbx_format%&. They should normally be set
21030 empty when using MBX format, so this option almost always appears in this
21031 combination:
21032 .code
21033 mbx_format = true
21034 message_prefix =
21035 message_suffix =
21036 .endd
21037 If none of the locking options are mentioned in the configuration,
21038 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21039 is possible to specify the other kinds of locking with &%mbx_format%&, but
21040 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21041 interworks with &'c-client'&, providing for shared access to the mailbox. It
21042 should not be used if any program that does not use this form of locking is
21043 going to access the mailbox, nor should it be used if the mailbox file is NFS
21044 mounted, because it works only when the mailbox is accessed from a single host.
21045
21046 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21047 the standard version of &'c-client'&, because as long as it has a mailbox open
21048 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21049 append messages to it.
21050
21051
21052 .option message_prefix appendfile string&!! "see below"
21053 .cindex "&""From""& line"
21054 The string specified here is expanded and output at the start of every message.
21055 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21056 in which case it is:
21057 .code
21058 message_prefix = "From ${if def:return_path{$return_path}\
21059   {MAILER-DAEMON}} $tod_bsdinbox\n"
21060 .endd
21061 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21062 &`\n`& to &`\r\n`& in &%message_prefix%&.
21063
21064 .option message_suffix appendfile string&!! "see below"
21065 The string specified here is expanded and output at the end of every message.
21066 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21067 in which case it is a single newline character. The suffix can be suppressed by
21068 setting
21069 .code
21070 message_suffix =
21071 .endd
21072 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21073 &`\n`& to &`\r\n`& in &%message_suffix%&.
21074
21075 .option mode appendfile "octal integer" 0600
21076 If the output file is created, it is given this mode. If it already exists and
21077 has wider permissions, they are reduced to this mode. If it has narrower
21078 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21079 if the delivery is the result of a &%save%& command in a filter file specifying
21080 a particular mode, the mode of the output file is always forced to take that
21081 value, and this option is ignored.
21082
21083
21084 .option mode_fail_narrower appendfile boolean true
21085 This option applies in the case when an existing mailbox file has a narrower
21086 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21087 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21088 continues with the delivery attempt, using the existing mode of the file.
21089
21090
21091 .option notify_comsat appendfile boolean false
21092 If this option is true, the &'comsat'& daemon is notified after every
21093 successful delivery to a user mailbox. This is the daemon that notifies logged
21094 on users about incoming mail.
21095
21096
21097 .option quota appendfile string&!! unset
21098 .cindex "quota" "imposed by Exim"
21099 This option imposes a limit on the size of the file to which Exim is appending,
21100 or to the total space used in the directory tree when the &%directory%& option
21101 is set. In the latter case, computation of the space used is expensive, because
21102 all the files in the directory (and any sub-directories) have to be
21103 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21104 &%maildir_use_size_file%& for ways to avoid this in environments where users
21105 have no shell access to their mailboxes).
21106
21107 As there is no interlock against two simultaneous deliveries into a
21108 multi-file mailbox, it is possible for the quota to be overrun in this case.
21109 For single-file mailboxes, of course, an interlock is a necessity.
21110
21111 A file's size is taken as its &'used'& value. Because of blocking effects, this
21112 may be a lot less than the actual amount of disk space allocated to the file.
21113 If the sizes of a number of files are being added up, the rounding effect can
21114 become quite noticeable, especially on systems that have large block sizes.
21115 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21116 the obvious value which users understand most easily.
21117
21118 The value of the option is expanded, and must then be a numerical value
21119 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21120 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21121 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21122 be handled.
21123
21124 &*Note*&: A value of zero is interpreted as &"no quota"&.
21125
21126 The expansion happens while Exim is running as root, before it changes uid for
21127 the delivery. This means that files that are inaccessible to the end user can
21128 be used to hold quota values that are looked up in the expansion. When delivery
21129 fails because this quota is exceeded, the handling of the error is as for
21130 system quota failures.
21131
21132 By default, Exim's quota checking mimics system quotas, and restricts the
21133 mailbox to the specified maximum size, though the value is not accurate to the
21134 last byte, owing to separator lines and additional headers that may get added
21135 during message delivery. When a mailbox is nearly full, large messages may get
21136 refused even though small ones are accepted, because the size of the current
21137 message is added to the quota when the check is made. This behaviour can be
21138 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21139 for exceeding the quota does not include the current message. Thus, deliveries
21140 continue until the quota has been exceeded; thereafter, no further messages are
21141 delivered. See also &%quota_warn_threshold%&.
21142
21143
21144 .option quota_directory appendfile string&!! unset
21145 This option defines the directory to check for quota purposes when delivering
21146 into individual files. The default is the delivery directory, or, if a file
21147 called &_maildirfolder_& exists in a maildir directory, the parent of the
21148 delivery directory.
21149
21150
21151 .option quota_filecount appendfile string&!! 0
21152 This option applies when the &%directory%& option is set. It limits the total
21153 number of files in the directory (compare the inode limit in system quotas). It
21154 can only be used if &%quota%& is also set. The value is expanded; an expansion
21155 failure causes delivery to be deferred. A value of zero is interpreted as
21156 &"no quota"&.
21157
21158
21159 .option quota_is_inclusive appendfile boolean true
21160 See &%quota%& above.
21161
21162
21163 .option quota_size_regex appendfile string unset
21164 This option applies when one of the delivery modes that writes a separate file
21165 for each message is being used. When Exim wants to find the size of one of
21166 these files in order to test the quota, it first checks &%quota_size_regex%&.
21167 If this is set to a regular expression that matches the file name, and it
21168 captures one string, that string is interpreted as a representation of the
21169 file's size. The value of &%quota_size_regex%& is not expanded.
21170
21171 This feature is useful only when users have no shell access to their mailboxes
21172 &-- otherwise they could defeat the quota simply by renaming the files. This
21173 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21174 the file length to the file name. For example:
21175 .code
21176 maildir_tag = ,S=$message_size
21177 quota_size_regex = ,S=(\d+)
21178 .endd
21179 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21180 number of lines in the message.
21181
21182 The regular expression should not assume that the length is at the end of the
21183 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21184 sometimes add other information onto the ends of message file names.
21185
21186 Section &<<SECID136>>& contains further information.
21187
21188
21189 .option quota_warn_message appendfile string&!! "see below"
21190 See below for the use of this option. If it is not set when
21191 &%quota_warn_threshold%& is set, it defaults to
21192 .code
21193 quota_warn_message = "\
21194   To: $local_part@$domain\n\
21195   Subject: Your mailbox\n\n\
21196   This message is automatically created \
21197   by mail delivery software.\n\n\
21198   The size of your mailbox has exceeded \
21199   a warning threshold that is\n\
21200   set by the system administrator.\n"
21201 .endd
21202
21203
21204 .option quota_warn_threshold appendfile string&!! 0
21205 .cindex "quota" "warning threshold"
21206 .cindex "mailbox" "size warning"
21207 .cindex "size" "of mailbox"
21208 This option is expanded in the same way as &%quota%& (see above). If the
21209 resulting value is greater than zero, and delivery of the message causes the
21210 size of the file or total space in the directory tree to cross the given
21211 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21212 may be specified as a percentage of it by following the value with a percent
21213 sign. For example:
21214 .code
21215 quota = 10M
21216 quota_warn_threshold = 75%
21217 .endd
21218 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21219 percent sign is ignored.
21220
21221 The warning message itself is specified by the &%quota_warn_message%& option,
21222 and it must start with a &'To:'& header line containing the recipient(s) of the
21223 warning message. These do not necessarily have to include the recipient(s) of
21224 the original message. A &'Subject:'& line should also normally be supplied. You
21225 can include any other header lines that you want. If you do not include a
21226 &'From:'& line, the default is:
21227 .code
21228 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21229 .endd
21230 .oindex &%errors_reply_to%&
21231 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21232 option.
21233
21234 The &%quota%& option does not have to be set in order to use this option; they
21235 are independent of one another except when the threshold is specified as a
21236 percentage.
21237
21238
21239 .option use_bsmtp appendfile boolean false
21240 .cindex "envelope sender"
21241 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21242 format, with the envelope sender and recipient(s) included as SMTP commands. If
21243 you want to include a leading HELO command with such messages, you can do
21244 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21245 for details of batch SMTP.
21246
21247
21248 .option use_crlf appendfile boolean false
21249 .cindex "carriage return"
21250 .cindex "linefeed"
21251 This option causes lines to be terminated with the two-character CRLF sequence
21252 (carriage return, linefeed) instead of just a linefeed character. In the case
21253 of batched SMTP, the byte sequence written to the file is then an exact image
21254 of what would be sent down a real SMTP connection.
21255
21256 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21257 (which are used to supply the traditional &"From&~"& and blank line separators
21258 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21259 carriage return characters if these are needed. In cases where these options
21260 have non-empty defaults, the values end with a single linefeed, so they must be
21261 changed to end with &`\r\n`& if &%use_crlf%& is set.
21262
21263
21264 .option use_fcntl_lock appendfile boolean "see below"
21265 This option controls the use of the &[fcntl()]& function to lock a file for
21266 exclusive use when a message is being appended. It is set by default unless
21267 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21268 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21269 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21270
21271
21272 .option use_flock_lock appendfile boolean false
21273 This option is provided to support the use of &[flock()]& for file locking, for
21274 the few situations where it is needed. Most modern operating systems support
21275 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21276 each other. Exim uses &[fcntl()]& locking by default.
21277
21278 This option is required only if you are using an operating system where
21279 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21280 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21281 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21282
21283 .cindex "Solaris" "&[flock()]& support"
21284 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21285 have it (and some, I think, provide a not quite right version built on top of
21286 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21287 the ability to use it, and any attempt to do so will cause a configuration
21288 error.
21289
21290 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21291 is just being mapped onto &[fcntl()]& by the OS).
21292
21293
21294 .option use_lockfile appendfile boolean "see below"
21295 If this option is turned off, Exim does not attempt to create a lock file when
21296 appending to a mailbox file. In this situation, the only locking is by
21297 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21298 sure that every MUA that is ever going to look at your users' mailboxes uses
21299 &[fcntl()]& rather than a lock file, and even then only when you are not
21300 delivering over NFS from more than one host.
21301
21302 .cindex "NFS" "lock file"
21303 In order to append to an NFS file safely from more than one host, it is
21304 necessary to take out a lock &'before'& opening the file, and the lock file
21305 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21306 file corruption.
21307
21308 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21309 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21310 except when &%mbx_format%& is set.
21311
21312
21313 .option use_mbx_lock appendfile boolean "see below"
21314 This option is available only if Exim has been compiled with SUPPORT_MBX
21315 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21316 locking rules be used. It is set by default if &%mbx_format%& is set and none
21317 of the locking options are mentioned in the configuration. The locking rules
21318 are the same as are used by the &'c-client'& library that underlies Pine and
21319 the IMAP4 and POP daemons that come with it (see the discussion below). The
21320 rules allow for shared access to the mailbox. However, this kind of locking
21321 does not work when the mailbox is NFS mounted.
21322
21323 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21324 &%use_flock_lock%& to control what kind of locking is used in implementing the
21325 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21326 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21327
21328
21329
21330
21331 .section "Operational details for appending" "SECTopappend"
21332 .cindex "appending to a file"
21333 .cindex "file" "appending"
21334 Before appending to a file, the following preparations are made:
21335
21336 .ilist
21337 If the name of the file is &_/dev/null_&, no action is taken, and a success
21338 return is given.
21339
21340 .next
21341 .cindex "directory creation"
21342 If any directories on the file's path are missing, Exim creates them if the
21343 &%create_directory%& option is set. A created directory's mode is given by the
21344 &%directory_mode%& option.
21345
21346 .next
21347 If &%file_format%& is set, the format of an existing file is checked. If this
21348 indicates that a different transport should be used, control is passed to that
21349 transport.
21350
21351 .next
21352 .cindex "file" "locking"
21353 .cindex "locking files"
21354 .cindex "NFS" "lock file"
21355 If &%use_lockfile%& is set, a lock file is built in a way that will work
21356 reliably over NFS, as follows:
21357
21358 .olist
21359 Create a &"hitching post"& file whose name is that of the lock file with the
21360 current time, primary host name, and process id added, by opening for writing
21361 as a new file. If this fails with an access error, delivery is deferred.
21362 .next
21363 Close the hitching post file, and hard link it to the lock file name.
21364 .next
21365 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21366 Unlink the hitching post name.
21367 .next
21368 Otherwise, use &[stat()]& to get information about the hitching post file, and
21369 then unlink hitching post name. If the number of links is exactly two, creation
21370 of the lock file succeeded but something (for example, an NFS server crash and
21371 restart) caused this fact not to be communicated to the &[link()]& call.
21372 .next
21373 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21374 up to &%lock_retries%& times. However, since any program that writes to a
21375 mailbox should complete its task very quickly, it is reasonable to time out old
21376 lock files that are normally the result of user agent and system crashes. If an
21377 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21378 it before trying again.
21379 .endlist olist
21380
21381 .next
21382 A call is made to &[lstat()]& to discover whether the main file exists, and if
21383 so, what its characteristics are. If &[lstat()]& fails for any reason other
21384 than non-existence, delivery is deferred.
21385
21386 .next
21387 .cindex "symbolic link" "to mailbox"
21388 .cindex "mailbox" "symbolic link"
21389 If the file does exist and is a symbolic link, delivery is deferred, unless the
21390 &%allow_symlink%& option is set, in which case the ownership of the link is
21391 checked, and then &[stat()]& is called to find out about the real file, which
21392 is then subjected to the checks below. The check on the top-level link
21393 ownership prevents one user creating a link for another's mailbox in a sticky
21394 directory, though allowing symbolic links in this case is definitely not a good
21395 idea. If there is a chain of symbolic links, the intermediate ones are not
21396 checked.
21397
21398 .next
21399 If the file already exists but is not a regular file, or if the file's owner
21400 and group (if the group is being checked &-- see &%check_group%& above) are
21401 different from the user and group under which the delivery is running,
21402 delivery is deferred.
21403
21404 .next
21405 If the file's permissions are more generous than specified, they are reduced.
21406 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21407 is set false, in which case the delivery is tried using the existing
21408 permissions.
21409
21410 .next
21411 The file's inode number is saved, and the file is then opened for appending.
21412 If this fails because the file has vanished, &(appendfile)& behaves as if it
21413 hadn't existed (see below). For any other failures, delivery is deferred.
21414
21415 .next
21416 If the file is opened successfully, check that the inode number hasn't
21417 changed, that it is still a regular file, and that the owner and permissions
21418 have not changed. If anything is wrong, defer delivery and freeze the message.
21419
21420 .next
21421 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21422 option is set. Otherwise, check that the file is being created in a permitted
21423 directory if the &%create_file%& option is set (deferring on failure), and then
21424 open for writing as a new file, with the O_EXCL and O_CREAT options,
21425 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21426 set). In this case, which can happen if the link points to a non-existent file,
21427 the file is opened for writing using O_CREAT but not O_EXCL, because
21428 that prevents link following.
21429
21430 .next
21431 .cindex "loop" "while file testing"
21432 If opening fails because the file exists, obey the tests given above for
21433 existing files. However, to avoid looping in a situation where the file is
21434 being continuously created and destroyed, the exists/not-exists loop is broken
21435 after 10 repetitions, and the message is then frozen.
21436
21437 .next
21438 If opening fails with any other error, defer delivery.
21439
21440 .next
21441 .cindex "file" "locking"
21442 .cindex "locking files"
21443 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21444 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21445 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21446 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21447 file, and an exclusive lock on the file whose name is
21448 .code
21449 /tmp/.<device-number>.<inode-number>
21450 .endd
21451 using the device and inode numbers of the open mailbox file, in accordance with
21452 the MBX locking rules. This file is created with a mode that is specified by
21453 the &%lockfile_mode%& option.
21454
21455 If Exim fails to lock the file, there are two possible courses of action,
21456 depending on the value of the locking timeout. This is obtained from
21457 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21458
21459 If the timeout value is zero, the file is closed, Exim waits for
21460 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21461 to lock it again. This happens up to &%lock_retries%& times, after which the
21462 delivery is deferred.
21463
21464 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21465 &[flock()]& are used (with the given timeout), so there has already been some
21466 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21467 immediately. It retries up to
21468 .code
21469 (lock_retries * lock_interval) / <timeout>
21470 .endd
21471 times (rounded up).
21472 .endlist
21473
21474 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21475 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21476
21477
21478 .section "Operational details for delivery to a new file" "SECTopdir"
21479 .cindex "delivery" "to single file"
21480 .cindex "&""From""& line"
21481 When the &%directory%& option is set instead of &%file%&, each message is
21482 delivered into a newly-created file or set of files. When &(appendfile)& is
21483 activated directly from a &(redirect)& router, neither &%file%& nor
21484 &%directory%& is normally set, because the path for delivery is supplied by the
21485 router. (See for example, the &(address_file)& transport in the default
21486 configuration.) In this case, delivery is to a new file if either the path name
21487 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21488
21489 No locking is required while writing the message to a new file, so the various
21490 locking options of the transport are ignored. The &"From"& line that by default
21491 separates messages in a single file is not normally needed, nor is the escaping
21492 of message lines that start with &"From"&, and there is no need to ensure a
21493 newline at the end of each message. Consequently, the default values for
21494 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21495 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21496
21497 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21498 the files in the delivery directory by default. However, you can specify a
21499 different directory by setting &%quota_directory%&. Also, for maildir
21500 deliveries (see below) the &_maildirfolder_& convention is honoured.
21501
21502
21503 .cindex "maildir format"
21504 .cindex "mailstore format"
21505 There are three different ways in which delivery to individual files can be
21506 done, controlled by the settings of the &%maildir_format%& and
21507 &%mailstore_format%& options. Note that code to support maildir or mailstore
21508 formats is not included in the binary unless SUPPORT_MAILDIR or
21509 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21510
21511 .cindex "directory creation"
21512 In all three cases an attempt is made to create the directory and any necessary
21513 sub-directories if they do not exist, provided that the &%create_directory%&
21514 option is set (the default). The location of a created directory can be
21515 constrained by setting &%create_file%&. A created directory's mode is given by
21516 the &%directory_mode%& option. If creation fails, or if the
21517 &%create_directory%& option is not set when creation is required, delivery is
21518 deferred.
21519
21520
21521
21522 .section "Maildir delivery" "SECTmaildirdelivery"
21523 .cindex "maildir format" "description of"
21524 If the &%maildir_format%& option is true, Exim delivers each message by writing
21525 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21526 directory that is defined by the &%directory%& option (the &"delivery
21527 directory"&). If the delivery is successful, the file is renamed into the
21528 &_new_& subdirectory.
21529
21530 In the file name, <&'stime'&> is the current time of day in seconds, and
21531 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21532 Exim checks that the time-of-day clock has moved on by at least one microsecond
21533 before terminating the delivery process. This guarantees uniqueness for the
21534 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21535 opening it. If any response other than ENOENT (does not exist) is given,
21536 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21537
21538 Before Exim carries out a maildir delivery, it ensures that subdirectories
21539 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21540 do not exist, Exim tries to create them and any superior directories in their
21541 path, subject to the &%create_directory%& and &%create_file%& options. If the
21542 &%maildirfolder_create_regex%& option is set, and the regular expression it
21543 contains matches the delivery directory, Exim also ensures that a file called
21544 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21545 &_maildirfolder_& file cannot be created, delivery is deferred.
21546
21547 These features make it possible to use Exim to create all the necessary files
21548 and directories in a maildir mailbox, including subdirectories for maildir++
21549 folders. Consider this example:
21550 .code
21551 maildir_format = true
21552 directory = /var/mail/$local_part\
21553            ${if eq{$local_part_suffix}{}{}\
21554            {/.${substr_1:$local_part_suffix}}}
21555 maildirfolder_create_regex = /\.[^/]+$
21556 .endd
21557 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21558 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21559 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21560 not match this name, so Exim will not look for or create the file
21561 &_/var/mail/pimbo/maildirfolder_&, though it will create
21562 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21563
21564 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21565 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21566 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21567 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21568 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21569
21570 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21571 not inadvertently match the toplevel maildir directory, because a
21572 &_maildirfolder_& file at top level would completely break quota calculations.
21573
21574 .cindex "quota" "in maildir delivery"
21575 .cindex "maildir++"
21576 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21577 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21578 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21579 Exim assumes the directory is a maildir++ folder directory, which is one level
21580 down from the user's top level mailbox directory. This causes it to start at
21581 the parent directory instead of the current directory when calculating the
21582 amount of space used.
21583
21584 One problem with delivering into a multi-file mailbox is that it is
21585 computationally expensive to compute the size of the mailbox for quota
21586 checking. Various approaches have been taken to reduce the amount of work
21587 needed. The next two sections describe two of them. A third alternative is to
21588 use some external process for maintaining the size data, and use the expansion
21589 of the &%mailbox_size%& option as a way of importing it into Exim.
21590
21591
21592
21593
21594 .section "Using tags to record message sizes" "SECID135"
21595 If &%maildir_tag%& is set, the string is expanded for each delivery.
21596 When the maildir file is renamed into the &_new_& sub-directory, the
21597 tag is added to its name. However, if adding the tag takes the length of the
21598 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21599 the tag is dropped and the maildir file is created with no tag.
21600
21601
21602 .vindex "&$message_size$&"
21603 Tags can be used to encode the size of files in their names; see
21604 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21605 happens after the message has been written. The value of the &$message_size$&
21606 variable is set to the number of bytes actually written. If the expansion is
21607 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21608 be deferred. The expanded tag may contain any printing characters except &"/"&.
21609 Non-printing characters in the string are ignored; if the resulting string is
21610 empty, it is ignored. If it starts with an alphanumeric character, a leading
21611 colon is inserted; this default has not proven to be the path that popular
21612 maildir implementations have chosen (but changing it in Exim would break
21613 backwards compatibility).
21614
21615 For one common implementation, you might set:
21616 .code
21617 maildir_tag = ,S=${message_size}
21618 .endd
21619 but you should check the documentation of the other software to be sure.
21620
21621 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21622 as this allows Exim to extract the size from your tag, instead of having to
21623 &[stat()]& each message file.
21624
21625
21626 .section "Using a maildirsize file" "SECID136"
21627 .cindex "quota" "in maildir delivery"
21628 .cindex "maildir format" "&_maildirsize_& file"
21629 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21630 storing quota and message size information in a file called &_maildirsize_&
21631 within the toplevel maildir directory. If this file does not exist, Exim
21632 creates it, setting the quota from the &%quota%& option of the transport. If
21633 the maildir directory itself does not exist, it is created before any attempt
21634 to write a &_maildirsize_& file.
21635
21636 The &_maildirsize_& file is used to hold information about the sizes of
21637 messages in the maildir, thus speeding up quota calculations. The quota value
21638 in the file is just a cache; if the quota is changed in the transport, the new
21639 value overrides the cached value when the next message is delivered. The cache
21640 is maintained for the benefit of other programs that access the maildir and
21641 need to know the quota.
21642
21643 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21644 file is maintained (with a zero quota setting), but no quota is imposed.
21645
21646 A regular expression is available for controlling which directories in the
21647 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21648 See the description of the &%maildir_quota_directory_regex%& option above for
21649 details.
21650
21651
21652 .section "Mailstore delivery" "SECID137"
21653 .cindex "mailstore format" "description of"
21654 If the &%mailstore_format%& option is true, each message is written as two
21655 files in the given directory. A unique base name is constructed from the
21656 message id and the current delivery process, and the files that are written use
21657 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21658 contains the message's envelope, and the &_.msg_& file contains the message
21659 itself. The base name is placed in the variable &$mailstore_basename$&.
21660
21661 During delivery, the envelope is first written to a file with the suffix
21662 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21663 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21664 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21665 file before accessing either of them. An alternative approach is to wait for
21666 the absence of a &_.tmp_& file.
21667
21668 The envelope file starts with any text defined by the &%mailstore_prefix%&
21669 option, expanded and terminated by a newline if there isn't one. Then follows
21670 the sender address on one line, then all the recipient addresses, one per line.
21671 There can be more than one recipient only if the &%batch_max%& option is set
21672 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21673 appended to the file, followed by a newline if it does not end with one.
21674
21675 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21676 failure, it is ignored. Other expansion errors are treated as serious
21677 configuration errors, and delivery is deferred. The variable
21678 &$mailstore_basename$& is available for use during these expansions.
21679
21680
21681 .section "Non-special new file delivery" "SECID138"
21682 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21683 file is created directly in the named directory. For example, when delivering
21684 messages into files in batched SMTP format for later delivery to some host (see
21685 section &<<SECTbatchSMTP>>&), a setting such as
21686 .code
21687 directory = /var/bsmtp/$host
21688 .endd
21689 might be used. A message is written to a file with a temporary name, which is
21690 then renamed when the delivery is complete. The final name is obtained by
21691 expanding the contents of the &%directory_file%& option.
21692 .ecindex IIDapptra1
21693 .ecindex IIDapptra2
21694
21695
21696
21697
21698
21699
21700 . ////////////////////////////////////////////////////////////////////////////
21701 . ////////////////////////////////////////////////////////////////////////////
21702
21703 .chapter "The autoreply transport" "CHID8"
21704 .scindex IIDauttra1 "transports" "&(autoreply)&"
21705 .scindex IIDauttra2 "&(autoreply)& transport"
21706 The &(autoreply)& transport is not a true transport in that it does not cause
21707 the message to be transmitted. Instead, it generates a new mail message as an
21708 automatic reply to the incoming message. &'References:'& and
21709 &'Auto-Submitted:'& header lines are included. These are constructed according
21710 to the rules in RFCs 2822 and 3834, respectively.
21711
21712 If the router that passes the message to this transport does not have the
21713 &%unseen%& option set, the original message (for the current recipient) is not
21714 delivered anywhere. However, when the &%unseen%& option is set on the router
21715 that passes the message to this transport, routing of the address continues, so
21716 another router can set up a normal message delivery.
21717
21718
21719 The &(autoreply)& transport is usually run as the result of mail filtering, a
21720 &"vacation"& message being the standard example. However, it can also be run
21721 directly from a router like any other transport. To reduce the possibility of
21722 message cascades, messages created by the &(autoreply)& transport always have
21723 empty envelope sender addresses, like bounce messages.
21724
21725 The parameters of the message to be sent can be specified in the configuration
21726 by options described below. However, these are used only when the address
21727 passed to the transport does not contain its own reply information. When the
21728 transport is run as a consequence of a
21729 &%mail%&
21730 or &%vacation%& command in a filter file, the parameters of the message are
21731 supplied by the filter, and passed with the address. The transport's options
21732 that define the message are then ignored (so they are not usually set in this
21733 case). The message is specified entirely by the filter or by the transport; it
21734 is never built from a mixture of options. However, the &%file_optional%&,
21735 &%mode%&, and &%return_message%& options apply in all cases.
21736
21737 &(Autoreply)& is implemented as a local transport. When used as a result of a
21738 command in a user's filter file, &(autoreply)& normally runs under the uid and
21739 gid of the user, and with appropriate current and home directories (see chapter
21740 &<<CHAPenvironment>>&).
21741
21742 There is a subtle difference between routing a message to a &(pipe)& transport
21743 that generates some text to be returned to the sender, and routing it to an
21744 &(autoreply)& transport. This difference is noticeable only if more than one
21745 address from the same message is so handled. In the case of a pipe, the
21746 separate outputs from the different addresses are gathered up and returned to
21747 the sender in a single message, whereas if &(autoreply)& is used, a separate
21748 message is generated for each address that is passed to it.
21749
21750 Non-printing characters are not permitted in the header lines generated for the
21751 message that &(autoreply)& creates, with the exception of newlines that are
21752 immediately followed by white space. If any non-printing characters are found,
21753 the transport defers.
21754 Whether characters with the top bit set count as printing characters or not is
21755 controlled by the &%print_topbitchars%& global option.
21756
21757 If any of the generic options for manipulating headers (for example,
21758 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21759 of the original message that is included in the generated message when
21760 &%return_message%& is set. They do not apply to the generated message itself.
21761
21762 .vindex "&$sender_address$&"
21763 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21764 the message, indicating that there were no recipients, it does not treat this
21765 as an error. This means that autoreplies sent to &$sender_address$& when this
21766 is empty (because the incoming message is a bounce message) do not cause
21767 problems. They are just discarded.
21768
21769
21770
21771 .section "Private options for autoreply" "SECID139"
21772 .cindex "options" "&(autoreply)& transport"
21773
21774 .option bcc autoreply string&!! unset
21775 This specifies the addresses that are to receive &"blind carbon copies"& of the
21776 message when the message is specified by the transport.
21777
21778
21779 .option cc autoreply string&!! unset
21780 This specifies recipients of the message and the contents of the &'Cc:'& header
21781 when the message is specified by the transport.
21782
21783
21784 .option file autoreply string&!! unset
21785 The contents of the file are sent as the body of the message when the message
21786 is specified by the transport. If both &%file%& and &%text%& are set, the text
21787 string comes first.
21788
21789
21790 .option file_expand autoreply boolean false
21791 If this is set, the contents of the file named by the &%file%& option are
21792 subjected to string expansion as they are added to the message.
21793
21794
21795 .option file_optional autoreply boolean false
21796 If this option is true, no error is generated if the file named by the &%file%&
21797 option or passed with the address does not exist or cannot be read.
21798
21799
21800 .option from autoreply string&!! unset
21801 This specifies the contents of the &'From:'& header when the message is
21802 specified by the transport.
21803
21804
21805 .option headers autoreply string&!! unset
21806 This specifies additional RFC 2822 headers that are to be added to the message
21807 when the message is specified by the transport. Several can be given by using
21808 &"\n"& to separate them. There is no check on the format.
21809
21810
21811 .option log autoreply string&!! unset
21812 This option names a file in which a record of every message sent is logged when
21813 the message is specified by the transport.
21814
21815
21816 .option mode autoreply "octal integer" 0600
21817 If either the log file or the &"once"& file has to be created, this mode is
21818 used.
21819
21820
21821 .option never_mail autoreply "address list&!!" unset
21822 If any run of the transport creates a message with a recipient that matches any
21823 item in the list, that recipient is quietly discarded. If all recipients are
21824 discarded, no message is created. This applies both when the recipients are
21825 generated by a filter and when they are specified in the transport.
21826
21827
21828
21829 .option once autoreply string&!! unset
21830 This option names a file or DBM database in which a record of each &'To:'&
21831 recipient is kept when the message is specified by the transport. &*Note*&:
21832 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21833
21834 If &%once%& is unset, or is set to an empty string, the message is always sent.
21835 By default, if &%once%& is set to a non-empty file name, the message
21836 is not sent if a potential recipient is already listed in the database.
21837 However, if the &%once_repeat%& option specifies a time greater than zero, the
21838 message is sent if that much time has elapsed since a message was last sent to
21839 this recipient. A setting of zero time for &%once_repeat%& (the default)
21840 prevents a message from being sent a second time &-- in this case, zero means
21841 infinity.
21842
21843 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21844 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21845 greater than zero, it changes the way Exim implements the &%once%& option.
21846 Instead of using a DBM file to record every recipient it sends to, it uses a
21847 regular file, whose size will never get larger than the given value.
21848
21849 In the file, Exim keeps a linear list of recipient addresses and the times at
21850 which they were sent messages. If the file is full when a new address needs to
21851 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21852 means that a given recipient may receive multiple messages, but at
21853 unpredictable intervals that depend on the rate of turnover of addresses in the
21854 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21855
21856
21857 .option once_file_size autoreply integer 0
21858 See &%once%& above.
21859
21860
21861 .option once_repeat autoreply time&!! 0s
21862 See &%once%& above.
21863 After expansion, the value of this option must be a valid time value.
21864
21865
21866 .option reply_to autoreply string&!! unset
21867 This specifies the contents of the &'Reply-To:'& header when the message is
21868 specified by the transport.
21869
21870
21871 .option return_message autoreply boolean false
21872 If this is set, a copy of the original message is returned with the new
21873 message, subject to the maximum size set in the &%return_size_limit%& global
21874 configuration option.
21875
21876
21877 .option subject autoreply string&!! unset
21878 This specifies the contents of the &'Subject:'& header when the message is
21879 specified by the transport. It is tempting to quote the original subject in
21880 automatic responses. For example:
21881 .code
21882 subject = Re: $h_subject:
21883 .endd
21884 There is a danger in doing this, however. It may allow a third party to
21885 subscribe your users to an opt-in mailing list, provided that the list accepts
21886 bounce messages as subscription confirmations. Well-managed lists require a
21887 non-bounce message to confirm a subscription, so the danger is relatively
21888 small.
21889
21890
21891
21892 .option text autoreply string&!! unset
21893 This specifies a single string to be used as the body of the message when the
21894 message is specified by the transport. If both &%text%& and &%file%& are set,
21895 the text comes first.
21896
21897
21898 .option to autoreply string&!! unset
21899 This specifies recipients of the message and the contents of the &'To:'& header
21900 when the message is specified by the transport.
21901 .ecindex IIDauttra1
21902 .ecindex IIDauttra2
21903
21904
21905
21906
21907 . ////////////////////////////////////////////////////////////////////////////
21908 . ////////////////////////////////////////////////////////////////////////////
21909
21910 .chapter "The lmtp transport" "CHAPLMTP"
21911 .cindex "transports" "&(lmtp)&"
21912 .cindex "&(lmtp)& transport"
21913 .cindex "LMTP" "over a pipe"
21914 .cindex "LMTP" "over a socket"
21915 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21916 specified command
21917 or by interacting with a Unix domain socket.
21918 This transport is something of a cross between the &(pipe)& and &(smtp)&
21919 transports. Exim also has support for using LMTP over TCP/IP; this is
21920 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21921 to be of minority interest, the default build-time configure in &_src/EDITME_&
21922 has it commented out. You need to ensure that
21923 .code
21924 TRANSPORT_LMTP=yes
21925 .endd
21926 .cindex "options" "&(lmtp)& transport"
21927 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21928 included in the Exim binary. The private options of the &(lmtp)& transport are
21929 as follows:
21930
21931 .option batch_id lmtp string&!! unset
21932 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21933
21934
21935 .option batch_max lmtp integer 1
21936 This limits the number of addresses that can be handled in a single delivery.
21937 Most LMTP servers can handle several addresses at once, so it is normally a
21938 good idea to increase this value. See the description of local delivery
21939 batching in chapter &<<CHAPbatching>>&.
21940
21941
21942 .option command lmtp string&!! unset
21943 This option must be set if &%socket%& is not set. The string is a command which
21944 is run in a separate process. It is split up into a command name and list of
21945 arguments, each of which is separately expanded (so expansion cannot change the
21946 number of arguments). The command is run directly, not via a shell. The message
21947 is passed to the new process using the standard input and output to operate the
21948 LMTP protocol.
21949
21950 .option ignore_quota lmtp boolean false
21951 .cindex "LMTP" "ignoring quota errors"
21952 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21953 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21954 in its response to the LHLO command.
21955
21956 .option socket lmtp string&!! unset
21957 This option must be set if &%command%& is not set. The result of expansion must
21958 be the name of a Unix domain socket. The transport connects to the socket and
21959 delivers the message to it using the LMTP protocol.
21960
21961
21962 .option timeout lmtp time 5m
21963 The transport is aborted if the created process or Unix domain socket does not
21964 respond to LMTP commands or message input within this timeout. Delivery
21965 is deferred, and will be tried again later. Here is an example of a typical
21966 LMTP transport:
21967 .code
21968 lmtp:
21969   driver = lmtp
21970   command = /some/local/lmtp/delivery/program
21971   batch_max = 20
21972   user = exim
21973 .endd
21974 This delivers up to 20 addresses at a time, in a mixture of domains if
21975 necessary, running as the user &'exim'&.
21976
21977
21978
21979 . ////////////////////////////////////////////////////////////////////////////
21980 . ////////////////////////////////////////////////////////////////////////////
21981
21982 .chapter "The pipe transport" "CHAPpipetransport"
21983 .scindex IIDpiptra1 "transports" "&(pipe)&"
21984 .scindex IIDpiptra2 "&(pipe)& transport"
21985 The &(pipe)& transport is used to deliver messages via a pipe to a command
21986 running in another process. One example is the use of &(pipe)& as a
21987 pseudo-remote transport for passing messages to some other delivery mechanism
21988 (such as UUCP). Another is the use by individual users to automatically process
21989 their incoming messages. The &(pipe)& transport can be used in one of the
21990 following ways:
21991
21992 .ilist
21993 .vindex "&$local_part$&"
21994 A router routes one address to a transport in the normal way, and the
21995 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21996 contains the local part of the address (as usual), and the command that is run
21997 is specified by the &%command%& option on the transport.
21998 .next
21999 .vindex "&$pipe_addresses$&"
22000 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22001 transport can handle more than one address in a single run. In this case, when
22002 more than one address is routed to the transport, &$local_part$& is not set
22003 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22004 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22005 that are routed to the transport.
22006 .next
22007 .vindex "&$address_pipe$&"
22008 A router redirects an address directly to a pipe command (for example, from an
22009 alias or forward file). In this case, &$address_pipe$& contains the text of the
22010 pipe command, and the &%command%& option on the transport is ignored unless
22011 &%force_command%& is set. If only one address is being transported
22012 (&%batch_max%& is not greater than one, or only one address was redirected to
22013 this pipe command), &$local_part$& contains the local part that was redirected.
22014 .endlist
22015
22016
22017 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22018 deliver messages over pipes using the LMTP interactive protocol. This is
22019 implemented by the &(lmtp)& transport.
22020
22021 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22022 &_.forward_& file, the command runs under the uid and gid of that user. In
22023 other cases, the uid and gid have to be specified explicitly, either on the
22024 transport or on the router that handles the address. Current and &"home"&
22025 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22026 details of the local delivery environment and chapter &<<CHAPbatching>>&
22027 for a discussion of local delivery batching.
22028
22029
22030 .section "Concurrent delivery" "SECID140"
22031 If two messages arrive at almost the same time, and both are routed to a pipe
22032 delivery, the two pipe transports may be run concurrently. You must ensure that
22033 any pipe commands you set up are robust against this happening. If the commands
22034 write to a file, the &%exim_lock%& utility might be of use.
22035
22036
22037
22038
22039 .section "Returned status and data" "SECID141"
22040 .cindex "&(pipe)& transport" "returned data"
22041 If the command exits with a non-zero return code, the delivery is deemed to
22042 have failed, unless either the &%ignore_status%& option is set (in which case
22043 the return code is treated as zero), or the return code is one of those listed
22044 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22045 later"&. In this case, delivery is deferred. Details of a permanent failure are
22046 logged, but are not included in the bounce message, which merely contains
22047 &"local delivery failed"&.
22048
22049 If the command exits on a signal and the &%freeze_signal%& option is set then
22050 the message will be frozen in the queue. If that option is not set, a bounce
22051 will be sent as normal.
22052
22053 If the return code is greater than 128 and the command being run is a shell
22054 script, it normally means that the script was terminated by a signal whose
22055 value is the return code minus 128. The &%freeze_signal%& option does not
22056 apply in this case.
22057
22058 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22059 return code is set to 127. This is the value that a shell returns if it is
22060 asked to run a non-existent command. The wording for the log line suggests that
22061 a non-existent command may be the problem.
22062
22063 The &%return_output%& option can affect the result of a pipe delivery. If it is
22064 set and the command produces any output on its standard output or standard
22065 error streams, the command is considered to have failed, even if it gave a zero
22066 return code or if &%ignore_status%& is set. The output from the command is
22067 included as part of the bounce message. The &%return_fail_output%& option is
22068 similar, except that output is returned only when the command exits with a
22069 failure return code, that is, a value other than zero or a code that matches
22070 &%temp_errors%&.
22071
22072
22073
22074 .section "How the command is run" "SECThowcommandrun"
22075 .cindex "&(pipe)& transport" "path for command"
22076 The command line is (by default) broken down into a command name and arguments
22077 by the &(pipe)& transport itself. The &%allow_commands%& and
22078 &%restrict_to_path%& options can be used to restrict the commands that may be
22079 run.
22080
22081 .cindex "quoting" "in pipe command"
22082 Unquoted arguments are delimited by white space. If an argument appears in
22083 double quotes, backslash is interpreted as an escape character in the usual
22084 way. If an argument appears in single quotes, no escaping is done.
22085
22086 String expansion is applied to the command line except when it comes from a
22087 traditional &_.forward_& file (commands from a filter file are expanded). The
22088 expansion is applied to each argument in turn rather than to the whole line.
22089 For this reason, any string expansion item that contains white space must be
22090 quoted so as to be contained within a single argument. A setting such as
22091 .code
22092 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22093 .endd
22094 will not work, because the expansion item gets split between several
22095 arguments. You have to write
22096 .code
22097 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22098 .endd
22099 to ensure that it is all in one argument. The expansion is done in this way,
22100 argument by argument, so that the number of arguments cannot be changed as a
22101 result of expansion, and quotes or backslashes in inserted variables do not
22102 interact with external quoting. However, this leads to problems if you want to
22103 generate multiple arguments (or the command name plus arguments) from a single
22104 expansion. In this situation, the simplest solution is to use a shell. For
22105 example:
22106 .code
22107 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22108 .endd
22109
22110 .cindex "transport" "filter"
22111 .cindex "filter" "transport filter"
22112 .vindex "&$pipe_addresses$&"
22113 Special handling takes place when an argument consists of precisely the text
22114 &`$pipe_addresses`&. This is not a general expansion variable; the only
22115 place this string is recognized is when it appears as an argument for a pipe or
22116 transport filter command. It causes each address that is being handled to be
22117 inserted in the argument list at that point &'as a separate argument'&. This
22118 avoids any problems with spaces or shell metacharacters, and is of use when a
22119 &(pipe)& transport is handling groups of addresses in a batch.
22120
22121 If &%force_command%& is enabled on the transport, Special handling takes place
22122 for an argument that consists of precisely the text &`$address_pipe`&.  It
22123 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22124 argument is inserted in the argument list at that point
22125 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22126 the only item in the argument; in fact, if it were then &%force_command%&
22127 should behave as a no-op.  Rather, it should be used to adjust the command
22128 run while preserving the argument vector separation.
22129
22130 After splitting up into arguments and expansion, the resulting command is run
22131 in a subprocess directly from the transport, &'not'& under a shell. The
22132 message that is being delivered is supplied on the standard input, and the
22133 standard output and standard error are both connected to a single pipe that is
22134 read by Exim. The &%max_output%& option controls how much output the command
22135 may produce, and the &%return_output%& and &%return_fail_output%& options
22136 control what is done with it.
22137
22138 Not running the command under a shell (by default) lessens the security risks
22139 in cases when a command from a user's filter file is built out of data that was
22140 taken from an incoming message. If a shell is required, it can of course be
22141 explicitly specified as the command to be run. However, there are circumstances
22142 where existing commands (for example, in &_.forward_& files) expect to be run
22143 under a shell and cannot easily be modified. To allow for these cases, there is
22144 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22145 works. Instead of breaking up the command line as just described, it expands it
22146 as a single string and passes the result to &_/bin/sh_&. The
22147 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22148 with &%use_shell%&, and the whole mechanism is inherently less secure.
22149
22150
22151
22152 .section "Environment variables" "SECTpipeenv"
22153 .cindex "&(pipe)& transport" "environment for command"
22154 .cindex "environment for pipe transport"
22155 The environment variables listed below are set up when the command is invoked.
22156 This list is a compromise for maximum compatibility with other MTAs. Note that
22157 the &%environment%& option can be used to add additional variables to this
22158 environment.
22159 .display
22160 &`DOMAIN            `&   the domain of the address
22161 &`HOME              `&   the home directory, if set
22162 &`HOST              `&   the host name when called from a router (see below)
22163 &`LOCAL_PART        `&   see below
22164 &`LOCAL_PART_PREFIX `&   see below
22165 &`LOCAL_PART_SUFFIX `&   see below
22166 &`LOGNAME           `&   see below
22167 &`MESSAGE_ID        `&   Exim's local ID for the message
22168 &`PATH              `&   as specified by the &%path%& option below
22169 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22170 &`RECIPIENT         `&   the complete recipient address
22171 &`SENDER            `&   the sender of the message (empty if a bounce)
22172 &`SHELL             `&   &`/bin/sh`&
22173 &`TZ                `&   the value of the &%timezone%& option, if set
22174 &`USER              `&   see below
22175 .endd
22176 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22177 router, LOCAL_PART is set to the local part of the address. When it is
22178 called as a result of a forward or alias expansion, LOCAL_PART is set to
22179 the local part of the address that was expanded. In both cases, any affixes are
22180 removed from the local part, and made available in LOCAL_PART_PREFIX and
22181 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22182 same value as LOCAL_PART for compatibility with other MTAs.
22183
22184 .cindex "HOST"
22185 HOST is set only when a &(pipe)& transport is called from a router that
22186 associates hosts with an address, typically when using &(pipe)& as a
22187 pseudo-remote transport. HOST is set to the first host name specified by
22188 the router.
22189
22190 .cindex "HOME"
22191 If the transport's generic &%home_directory%& option is set, its value is used
22192 for the HOME environment variable. Otherwise, a home directory may be set
22193 by the router's &%transport_home_directory%& option, which defaults to the
22194 user's home directory if &%check_local_user%& is set.
22195
22196
22197 .section "Private options for pipe" "SECID142"
22198 .cindex "options" "&(pipe)& transport"
22199
22200
22201
22202 .option allow_commands pipe "string list&!!" unset
22203 .cindex "&(pipe)& transport" "permitted commands"
22204 The string is expanded, and is then interpreted as a colon-separated list of
22205 permitted commands. If &%restrict_to_path%& is not set, the only commands
22206 permitted are those in the &%allow_commands%& list. They need not be absolute
22207 paths; the &%path%& option is still used for relative paths. If
22208 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22209 in the &%allow_commands%& list, or a name without any slashes that is found on
22210 the path. In other words, if neither &%allow_commands%& nor
22211 &%restrict_to_path%& is set, there is no restriction on the command, but
22212 otherwise only commands that are permitted by one or the other are allowed. For
22213 example, if
22214 .code
22215 allow_commands = /usr/bin/vacation
22216 .endd
22217 and &%restrict_to_path%& is not set, the only permitted command is
22218 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22219 &%use_shell%& is set.
22220
22221
22222 .option batch_id pipe string&!! unset
22223 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22224
22225
22226 .option batch_max pipe integer 1
22227 This limits the number of addresses that can be handled in a single delivery.
22228 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22229
22230
22231 .option check_string pipe string unset
22232 As &(pipe)& writes the message, the start of each line is tested for matching
22233 &%check_string%&, and if it does, the initial matching characters are replaced
22234 by the contents of &%escape_string%&, provided both are set. The value of
22235 &%check_string%& is a literal string, not a regular expression, and the case of
22236 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22237 of &%check_string%& and &%escape_string%& are forced to values that implement
22238 the SMTP escaping protocol. Any settings made in the configuration file are
22239 ignored.
22240
22241
22242 .option command pipe string&!! unset
22243 This option need not be set when &(pipe)& is being used to deliver to pipes
22244 obtained directly from address redirections. In other cases, the option must be
22245 set, to provide a command to be run. It need not yield an absolute path (see
22246 the &%path%& option below). The command is split up into separate arguments by
22247 Exim, and each argument is separately expanded, as described in section
22248 &<<SECThowcommandrun>>& above.
22249
22250
22251 .option environment pipe string&!! unset
22252 .cindex "&(pipe)& transport" "environment for command"
22253 .cindex "environment for &(pipe)& transport"
22254 This option is used to add additional variables to the environment in which the
22255 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22256 a string which is expanded, and then interpreted as a colon-separated list of
22257 environment settings of the form <&'name'&>=<&'value'&>.
22258
22259
22260 .option escape_string pipe string unset
22261 See &%check_string%& above.
22262
22263
22264 .option freeze_exec_fail pipe boolean false
22265 .cindex "exec failure"
22266 .cindex "failure of exec"
22267 .cindex "&(pipe)& transport" "failure of exec"
22268 Failure to exec the command in a pipe transport is by default treated like
22269 any other failure while running the command. However, if &%freeze_exec_fail%&
22270 is set, failure to exec is treated specially, and causes the message to be
22271 frozen, whatever the setting of &%ignore_status%&.
22272
22273
22274 .option freeze_signal pipe boolean false
22275 .cindex "signal exit"
22276 .cindex "&(pipe)& transport", "signal exit"
22277 Normally if the process run by a command in a pipe transport exits on a signal,
22278 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22279 frozen in Exim's queue instead.
22280
22281
22282 .option force_command pipe boolean false
22283 .cindex "force command"
22284 .cindex "&(pipe)& transport", "force command"
22285 Normally when a router redirects an address directly to a pipe command
22286 the &%command%& option on the transport is ignored.  If &%force_command%&
22287 is set, the &%command%& option will used. This is especially
22288 useful for forcing a wrapper or additional argument to be added to the
22289 command. For example:
22290 .code
22291 command = /usr/bin/remote_exec myhost -- $address_pipe
22292 force_command
22293 .endd
22294
22295 Note that &$address_pipe$& is handled specially in &%command%& when
22296 &%force_command%& is set, expanding out to the original argument vector as
22297 separate items, similarly to a Unix shell &`"$@"`& construct.
22298
22299 .option ignore_status pipe boolean false
22300 If this option is true, the status returned by the subprocess that is set up to
22301 run the command is ignored, and Exim behaves as if zero had been returned.
22302 Otherwise, a non-zero status or termination by signal causes an error return
22303 from the transport unless the status value is one of those listed in
22304 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22305
22306 &*Note*&: This option does not apply to timeouts, which do not return a status.
22307 See the &%timeout_defer%& option for how timeouts are handled.
22308
22309 .option log_defer_output pipe boolean false
22310 .cindex "&(pipe)& transport" "logging output"
22311 If this option is set, and the status returned by the command is
22312 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22313 and any output was produced, the first line of it is written to the main log.
22314
22315
22316 .option log_fail_output pipe boolean false
22317 If this option is set, and the command returns any output, and also ends with a
22318 return code that is neither zero nor one of the return codes listed in
22319 &%temp_errors%& (that is, the delivery failed), the first line of output is
22320 written to the main log. This option and &%log_output%& are mutually exclusive.
22321 Only one of them may be set.
22322
22323
22324
22325 .option log_output pipe boolean false
22326 If this option is set and the command returns any output, the first line of
22327 output is written to the main log, whatever the return code. This option and
22328 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22329
22330
22331
22332 .option max_output pipe integer 20K
22333 This specifies the maximum amount of output that the command may produce on its
22334 standard output and standard error file combined. If the limit is exceeded, the
22335 process running the command is killed. This is intended as a safety measure to
22336 catch runaway processes. The limit is applied independently of the settings of
22337 the options that control what is done with such output (for example,
22338 &%return_output%&). Because of buffering effects, the amount of output may
22339 exceed the limit by a small amount before Exim notices.
22340
22341
22342 .option message_prefix pipe string&!! "see below"
22343 The string specified here is expanded and output at the start of every message.
22344 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22345 .code
22346 message_prefix = \
22347   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22348   ${tod_bsdinbox}\n
22349 .endd
22350 .cindex "Cyrus"
22351 .cindex "&%tmail%&"
22352 .cindex "&""From""& line"
22353 This is required by the commonly used &_/usr/bin/vacation_& program.
22354 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22355 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22356 setting
22357 .code
22358 message_prefix =
22359 .endd
22360 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22361 &`\n`& to &`\r\n`& in &%message_prefix%&.
22362
22363
22364 .option message_suffix pipe string&!! "see below"
22365 The string specified here is expanded and output at the end of every message.
22366 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22367 The suffix can be suppressed by setting
22368 .code
22369 message_suffix =
22370 .endd
22371 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22372 &`\n`& to &`\r\n`& in &%message_suffix%&.
22373
22374
22375 .option path pipe string "see below"
22376 This option specifies the string that is set up in the PATH environment
22377 variable of the subprocess. The default is:
22378 .code
22379 /bin:/usr/bin
22380 .endd
22381 If the &%command%& option does not yield an absolute path name, the command is
22382 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22383 apply to a command specified as a transport filter.
22384
22385
22386 .option permit_coredump pipe boolean false
22387 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22388 a core-dump of a pipe command, enable this command.  This enables core-dumps
22389 during delivery and affects both the Exim binary and the pipe command run.
22390 It is recommended that this option remain off unless and until you have a need
22391 for it and that this only be enabled when needed, as the risk of excessive
22392 resource consumption can be quite high.  Note also that Exim is typically
22393 installed as a setuid binary and most operating systems will inhibit coredumps
22394 of these by default, so further OS-specific action may be required.
22395
22396
22397 .option pipe_as_creator pipe boolean false
22398 .cindex "uid (user id)" "local delivery"
22399 If the generic &%user%& option is not set and this option is true, the delivery
22400 process is run under the uid that was in force when Exim was originally called
22401 to accept the message. If the group id is not otherwise set (via the generic
22402 &%group%& option), the gid that was in force when Exim was originally called to
22403 accept the message is used.
22404
22405
22406 .option restrict_to_path pipe boolean false
22407 When this option is set, any command name not listed in &%allow_commands%& must
22408 contain no slashes. The command is searched for only in the directories listed
22409 in the &%path%& option. This option is intended for use in the case when a pipe
22410 command has been generated from a user's &_.forward_& file. This is usually
22411 handled by a &(pipe)& transport called &%address_pipe%&.
22412
22413
22414 .option return_fail_output pipe boolean false
22415 If this option is true, and the command produced any output and ended with a
22416 return code other than zero or one of the codes listed in &%temp_errors%& (that
22417 is, the delivery failed), the output is returned in the bounce message.
22418 However, if the message has a null sender (that is, it is itself a bounce
22419 message), output from the command is discarded. This option and
22420 &%return_output%& are mutually exclusive. Only one of them may be set.
22421
22422
22423
22424 .option return_output pipe boolean false
22425 If this option is true, and the command produced any output, the delivery is
22426 deemed to have failed whatever the return code from the command, and the output
22427 is returned in the bounce message. Otherwise, the output is just discarded.
22428 However, if the message has a null sender (that is, it is a bounce message),
22429 output from the command is always discarded, whatever the setting of this
22430 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22431 of them may be set.
22432
22433
22434
22435 .option temp_errors pipe "string list" "see below"
22436 .cindex "&(pipe)& transport" "temporary failure"
22437 This option contains either a colon-separated list of numbers, or a single
22438 asterisk. If &%ignore_status%& is false
22439 and &%return_output%& is not set,
22440 and the command exits with a non-zero return code, the failure is treated as
22441 temporary and the delivery is deferred if the return code matches one of the
22442 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22443 codes are treated as permanent errors. The default setting contains the codes
22444 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22445 compiled on a system that does not define these macros, it assumes values of 75
22446 and 73, respectively.
22447
22448
22449 .option timeout pipe time 1h
22450 If the command fails to complete within this time, it is killed. This normally
22451 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22452 specifies no timeout. In order to ensure that any subprocesses created by the
22453 command are also killed, Exim makes the initial process a process group leader,
22454 and kills the whole process group on a timeout. However, this can be defeated
22455 if one of the processes starts a new process group.
22456
22457 .option timeout_defer pipe boolean false
22458 A timeout in a &(pipe)& transport, either in the command that the transport
22459 runs, or in a transport filter that is associated with it, is by default
22460 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22461 is set true, both kinds of timeout become temporary errors, causing the
22462 delivery to be deferred.
22463
22464 .option umask pipe "octal integer" 022
22465 This specifies the umask setting for the subprocess that runs the command.
22466
22467
22468 .option use_bsmtp pipe boolean false
22469 .cindex "envelope sender"
22470 If this option is set true, the &(pipe)& transport writes messages in &"batch
22471 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22472 commands. If you want to include a leading HELO command with such messages,
22473 you can do so by setting the &%message_prefix%& option. See section
22474 &<<SECTbatchSMTP>>& for details of batch SMTP.
22475
22476 .option use_classresources pipe boolean false
22477 .cindex "class resources (BSD)"
22478 This option is available only when Exim is running on FreeBSD, NetBSD, or
22479 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22480 resource limits when a &(pipe)& transport is run to perform a delivery. The
22481 limits for the uid under which the pipe is to run are obtained from the login
22482 class database.
22483
22484
22485 .option use_crlf pipe boolean false
22486 .cindex "carriage return"
22487 .cindex "linefeed"
22488 This option causes lines to be terminated with the two-character CRLF sequence
22489 (carriage return, linefeed) instead of just a linefeed character. In the case
22490 of batched SMTP, the byte sequence written to the pipe is then an exact image
22491 of what would be sent down a real SMTP connection.
22492
22493 The contents of the &%message_prefix%& and &%message_suffix%& options are
22494 written verbatim, so must contain their own carriage return characters if these
22495 are needed. When &%use_bsmtp%& is not set, the default values for both
22496 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22497 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22498
22499
22500 .option use_shell pipe boolean false
22501 .vindex "&$pipe_addresses$&"
22502 If this option is set, it causes the command to be passed to &_/bin/sh_&
22503 instead of being run directly from the transport, as described in section
22504 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22505 where the command is expected to be run under a shell and cannot easily be
22506 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22507 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22508 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22509 its &%-c%& option.
22510
22511
22512
22513 .section "Using an external local delivery agent" "SECID143"
22514 .cindex "local delivery" "using an external agent"
22515 .cindex "&'procmail'&"
22516 .cindex "external local delivery"
22517 .cindex "delivery" "&'procmail'&"
22518 .cindex "delivery" "by external agent"
22519 The &(pipe)& transport can be used to pass all messages that require local
22520 delivery to a separate local delivery agent such as &%procmail%&. When doing
22521 this, care must be taken to ensure that the pipe is run under an appropriate
22522 uid and gid. In some configurations one wants this to be a uid that is trusted
22523 by the delivery agent to supply the correct sender of the message. It may be
22524 necessary to recompile or reconfigure the delivery agent so that it trusts an
22525 appropriate user. The following is an example transport and router
22526 configuration for &%procmail%&:
22527 .code
22528 # transport
22529 procmail_pipe:
22530   driver = pipe
22531   command = /usr/local/bin/procmail -d $local_part
22532   return_path_add
22533   delivery_date_add
22534   envelope_to_add
22535   check_string = "From "
22536   escape_string = ">From "
22537   umask = 077
22538   user = $local_part
22539   group = mail
22540
22541 # router
22542 procmail:
22543   driver = accept
22544   check_local_user
22545   transport = procmail_pipe
22546 .endd
22547 In this example, the pipe is run as the local user, but with the group set to
22548 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22549 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22550 user to supply a correct sender address. If you do not specify either a
22551 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22552 home directory is the user's home directory by default.
22553
22554 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22555 .code
22556 IFS=" "
22557 .endd
22558 as shown in some &%procmail%& documentation, because Exim does not by default
22559 use a shell to run pipe commands.
22560
22561 .cindex "Cyrus"
22562 The next example shows a transport and a router for a system where local
22563 deliveries are handled by the Cyrus IMAP server.
22564 .code
22565 # transport
22566 local_delivery_cyrus:
22567   driver = pipe
22568   command = /usr/cyrus/bin/deliver \
22569             -m ${substr_1:$local_part_suffix} -- $local_part
22570   user = cyrus
22571   group = mail
22572   return_output
22573   log_output
22574   message_prefix =
22575   message_suffix =
22576
22577 # router
22578 local_user_cyrus:
22579   driver = accept
22580   check_local_user
22581   local_part_suffix = .*
22582   transport = local_delivery_cyrus
22583 .endd
22584 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22585 &%return_output%& to cause any text written by Cyrus to be returned to the
22586 sender.
22587 .ecindex IIDpiptra1
22588 .ecindex IIDpiptra2
22589
22590
22591 . ////////////////////////////////////////////////////////////////////////////
22592 . ////////////////////////////////////////////////////////////////////////////
22593
22594 .chapter "The smtp transport" "CHAPsmtptrans"
22595 .scindex IIDsmttra1 "transports" "&(smtp)&"
22596 .scindex IIDsmttra2 "&(smtp)& transport"
22597 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22598 or LMTP protocol. The list of hosts to try can either be taken from the address
22599 that is being processed (having been set up by the router), or specified
22600 explicitly for the transport. Timeout and retry processing (see chapter
22601 &<<CHAPretry>>&) is applied to each IP address independently.
22602
22603
22604 .section "Multiple messages on a single connection" "SECID144"
22605 The sending of multiple messages over a single TCP/IP connection can arise in
22606 two ways:
22607
22608 .ilist
22609 If a message contains more than &%max_rcpt%& (see below) addresses that are
22610 routed to the same host, more than one copy of the message has to be sent to
22611 that host. In this situation, multiple copies may be sent in a single run of
22612 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22613 does when it has too many addresses to send in one message also depends on the
22614 value of the global &%remote_max_parallel%& option. Details are given in
22615 section &<<SECToutSMTPTCP>>&.)
22616 .next
22617 .cindex "hints database" "remembering routing"
22618 When a message has been successfully delivered over a TCP/IP connection, Exim
22619 looks in its hints database to see if there are any other messages awaiting a
22620 connection to the same host. If there are, a new delivery process is started
22621 for one of them, and the current TCP/IP connection is passed on to it. The new
22622 process may in turn send multiple copies and possibly create yet another
22623 process.
22624 .endlist
22625
22626
22627 For each copy sent over the same TCP/IP connection, a sequence counter is
22628 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22629 no further messages are sent over that connection.
22630
22631
22632
22633 .section "Use of the $host and $host_address variables" "SECID145"
22634 .vindex "&$host$&"
22635 .vindex "&$host_address$&"
22636 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22637 &$host_address$& are the name and IP address of the first host on the host list
22638 passed by the router. However, when the transport is about to connect to a
22639 specific host, and while it is connected to that host, &$host$& and
22640 &$host_address$& are set to the values for that host. These are the values
22641 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22642 &%serialize_hosts%&, and the various TLS options are expanded.
22643
22644
22645 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22646 .vindex &$tls_bits$&
22647 .vindex &$tls_cipher$&
22648 .vindex &$tls_peerdn$&
22649 .vindex &$tls_sni$&
22650 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22651 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22652 are the values that were set when the message was received.
22653 These are the values that are used for options that are expanded before any
22654 SMTP connections are made. Just before each connection is made, these four
22655 variables are emptied. If TLS is subsequently started, they are set to the
22656 appropriate values for the outgoing connection, and these are the values that
22657 are in force when any authenticators are run and when the
22658 &%authenticated_sender%& option is expanded.
22659
22660 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22661 and will be removed in a future release.
22662
22663
22664 .section "Private options for smtp" "SECID146"
22665 .cindex "options" "&(smtp)& transport"
22666 The private options of the &(smtp)& transport are as follows:
22667
22668
22669 .option address_retry_include_sender smtp boolean true
22670 .cindex "4&'xx'& responses" "retrying after"
22671 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22672 is the combination of sender and recipient that is delayed in subsequent queue
22673 runs until the retry time is reached. You can delay the recipient without
22674 reference to the sender (which is what earlier versions of Exim did), by
22675 setting &%address_retry_include_sender%& false. However, this can lead to
22676 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22677
22678 .option allow_localhost smtp boolean false
22679 .cindex "local host" "sending to"
22680 .cindex "fallback" "hosts specified on transport"
22681 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22682 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22683 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22684 the delivery anyway. This should be used only in special cases when the
22685 configuration ensures that no looping will result (for example, a differently
22686 configured Exim is listening on the port to which the message is sent).
22687
22688
22689 .option authenticated_sender smtp string&!! unset
22690 .cindex "Cyrus"
22691 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22692 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22693 overriding any existing authenticated sender value. If the string expansion is
22694 forced to fail, the option is ignored. Other expansion failures cause delivery
22695 to be deferred. If the result of expansion is an empty string, that is also
22696 ignored.
22697
22698 The expansion happens after the outgoing connection has been made and TLS
22699 started, if required. This means that the &$host$&, &$host_address$&,
22700 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22701 particular connection.
22702
22703 If the SMTP session is not authenticated, the expansion of
22704 &%authenticated_sender%& still happens (and can cause the delivery to be
22705 deferred if it fails), but no AUTH= item is added to MAIL commands
22706 unless &%authenticated_sender_force%& is true.
22707
22708 This option allows you to use the &(smtp)& transport in LMTP mode to
22709 deliver mail to Cyrus IMAP and provide the proper local part as the
22710 &"authenticated sender"&, via a setting such as:
22711 .code
22712 authenticated_sender = $local_part
22713 .endd
22714 This removes the need for IMAP subfolders to be assigned special ACLs to
22715 allow direct delivery to those subfolders.
22716
22717 Because of expected uses such as that just described for Cyrus (when no
22718 domain is involved), there is no checking on the syntax of the provided
22719 value.
22720
22721
22722 .option authenticated_sender_force smtp boolean false
22723 If this option is set true, the &%authenticated_sender%& option's value
22724 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22725 authenticated as a client.
22726
22727
22728 .option command_timeout smtp time 5m
22729 This sets a timeout for receiving a response to an SMTP command that has been
22730 sent out. It is also used when waiting for the initial banner line from the
22731 remote host. Its value must not be zero.
22732
22733
22734 .option connect_timeout smtp time 5m
22735 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22736 to a remote host. A setting of zero allows the system timeout (typically
22737 several minutes) to act. To have any effect, the value of this option must be
22738 less than the system timeout. However, it has been observed that on some
22739 systems there is no system timeout, which is why the default value for this
22740 option is 5 minutes, a value recommended by RFC 1123.
22741
22742
22743 .option connection_max_messages smtp integer 500
22744 .cindex "SMTP" "passed connection"
22745 .cindex "SMTP" "multiple deliveries"
22746 .cindex "multiple SMTP deliveries"
22747 This controls the maximum number of separate message deliveries that are sent
22748 over a single TCP/IP connection. If the value is zero, there is no limit.
22749 For testing purposes, this value can be overridden by the &%-oB%& command line
22750 option.
22751
22752
22753 .option data_timeout smtp time 5m
22754 This sets a timeout for the transmission of each block in the data portion of
22755 the message. As a result, the overall timeout for a message depends on the size
22756 of the message. Its value must not be zero. See also &%final_timeout%&.
22757
22758
22759 .option delay_after_cutoff smtp boolean true
22760 This option controls what happens when all remote IP addresses for a given
22761 domain have been inaccessible for so long that they have passed their retry
22762 cutoff times.
22763
22764 In the default state, if the next retry time has not been reached for any of
22765 them, the address is bounced without trying any deliveries. In other words,
22766 Exim delays retrying an IP address after the final cutoff time until a new
22767 retry time is reached, and can therefore bounce an address without ever trying
22768 a delivery, when machines have been down for a long time. Some people are
22769 unhappy at this prospect, so...
22770
22771 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22772 addresses are past their final cutoff time, Exim tries to deliver to those
22773 IP addresses that have not been tried since the message arrived. If there are
22774 none, of if they all fail, the address is bounced. In other words, it does not
22775 delay when a new message arrives, but immediately tries those expired IP
22776 addresses that haven't been tried since the message arrived. If there is a
22777 continuous stream of messages for the dead hosts, unsetting
22778 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22779 to them.
22780
22781
22782 .option dns_qualify_single smtp boolean true
22783 If the &%hosts%& or &%fallback_hosts%& option is being used,
22784 and the &%gethostbyname%& option is false,
22785 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22786 in chapter &<<CHAPdnslookup>>& for more details.
22787
22788
22789 .option dns_search_parents smtp boolean false
22790 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22791 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22792 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22793 details.
22794
22795
22796 .option dnssec_request_domains smtp "domain list&!!" unset
22797 .cindex "MX record" "security"
22798 .cindex "DNSSEC" "MX lookup"
22799 .cindex "security" "MX lookup"
22800 .cindex "DNS" "DNSSEC"
22801 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22802 the dnssec request bit set.
22803 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22804
22805
22806
22807 .option dnssec_require_domains smtp "domain list&!!" unset
22808 .cindex "MX record" "security"
22809 .cindex "DNSSEC" "MX lookup"
22810 .cindex "security" "MX lookup"
22811 .cindex "DNS" "DNSSEC"
22812 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22813 the dnssec request bit set.  Any returns not having the Authenticated Data bit
22814 (AD bit) set wil be ignored and logged as a host-lookup failure.
22815 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22816
22817
22818
22819 .option dscp smtp string&!! unset
22820 .cindex "DCSP" "outbound"
22821 This option causes the DSCP value associated with a socket to be set to one
22822 of a number of fixed strings or to numeric value.
22823 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22824 Common values include &`throughput`&, &`mincost`&, and on newer systems
22825 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22826
22827 The outbound packets from Exim will be marked with this value in the header
22828 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22829 that these values will have any effect, not be stripped by networking
22830 equipment, or do much of anything without cooperation with your Network
22831 Engineer and those of all network operators between the source and destination.
22832
22833
22834 .option fallback_hosts smtp "string list" unset
22835 .cindex "fallback" "hosts specified on transport"
22836 String expansion is not applied to this option. The argument must be a
22837 colon-separated list of host names or IP addresses, optionally also including
22838 port numbers, though the separator can be changed, as described in section
22839 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22840 item in a &%route_list%& setting for the &(manualroute)& router, as described
22841 in section &<<SECTformatonehostitem>>&.
22842
22843 Fallback hosts can also be specified on routers, which associate them with the
22844 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22845 &%fallback_hosts%& specified on the transport is used only if the address does
22846 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22847 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22848 However, &%hosts_randomize%& does apply to fallback host lists.
22849
22850 If Exim is unable to deliver to any of the hosts for a particular address, and
22851 the errors are not permanent rejections, the address is put on a separate
22852 transport queue with its host list replaced by the fallback hosts, unless the
22853 address was routed via MX records and the current host was in the original MX
22854 list. In that situation, the fallback host list is not used.
22855
22856 Once normal deliveries are complete, the fallback queue is delivered by
22857 re-running the same transports with the new host lists. If several failing
22858 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22859 copy of the message is sent.
22860
22861 The resolution of the host names on the fallback list is controlled by the
22862 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22863 both to cases when the host list comes with the address and when it is taken
22864 from &%hosts%&. This option provides a &"use a smart host only if delivery
22865 fails"& facility.
22866
22867
22868 .option final_timeout smtp time 10m
22869 This is the timeout that applies while waiting for the response to the final
22870 line containing just &"."& that terminates a message. Its value must not be
22871 zero.
22872
22873 .option gethostbyname smtp boolean false
22874 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22875 being used, names are looked up using &[gethostbyname()]&
22876 (or &[getipnodebyname()]& when available)
22877 instead of using the DNS. Of course, that function may in fact use the DNS, but
22878 it may also consult other sources of information such as &_/etc/hosts_&.
22879
22880 .option gnutls_compat_mode smtp boolean unset
22881 This option controls whether GnuTLS is used in compatibility mode in an Exim
22882 server. This reduces security slightly, but improves interworking with older
22883 implementations of TLS.
22884
22885 .option helo_data smtp string&!! "see below"
22886 .cindex "HELO" "argument, setting"
22887 .cindex "EHLO" "argument, setting"
22888 .cindex "LHLO argument setting"
22889 The value of this option is expanded after a connection to a another host has
22890 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22891 command that starts the outgoing SMTP or LMTP session. The default value of the
22892 option is:
22893 .code
22894 $primary_hostname
22895 .endd
22896 During the expansion, the variables &$host$& and &$host_address$& are set to
22897 the identity of the remote host, and the variables &$sending_ip_address$& and
22898 &$sending_port$& are set to the local IP address and port number that are being
22899 used. These variables can be used to generate different values for different
22900 servers or different local IP addresses. For example, if you want the string
22901 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22902 interface address, you could use this:
22903 .code
22904 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22905   {$primary_hostname}}
22906 .endd
22907 The use of &%helo_data%& applies both to sending messages and when doing
22908 callouts.
22909
22910 .option hosts smtp "string list&!!" unset
22911 Hosts are associated with an address by a router such as &(dnslookup)&, which
22912 finds the hosts by looking up the address domain in the DNS, or by
22913 &(manualroute)&, which has lists of hosts in its configuration. However,
22914 email addresses can be passed to the &(smtp)& transport by any router, and not
22915 all of them can provide an associated list of hosts.
22916
22917 The &%hosts%& option specifies a list of hosts to be used if the address being
22918 processed does not have any hosts associated with it. The hosts specified by
22919 &%hosts%& are also used, whether or not the address has its own hosts, if
22920 &%hosts_override%& is set.
22921
22922 The string is first expanded, before being interpreted as a colon-separated
22923 list of host names or IP addresses, possibly including port numbers. The
22924 separator may be changed to something other than colon, as described in section
22925 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22926 item in a &%route_list%& setting for the &(manualroute)& router, as described
22927 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22928 of the &(manualroute)& router is not available here.
22929
22930 If the expansion fails, delivery is deferred. Unless the failure was caused by
22931 the inability to complete a lookup, the error is logged to the panic log as
22932 well as the main log. Host names are looked up either by searching directly for
22933 address records in the DNS or by calling &[gethostbyname()]& (or
22934 &[getipnodebyname()]& when available), depending on the setting of the
22935 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22936 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22937 address are used.
22938
22939 During delivery, the hosts are tried in order, subject to their retry status,
22940 unless &%hosts_randomize%& is set.
22941
22942
22943 .option hosts_avoid_esmtp smtp "host list&!!" unset
22944 .cindex "ESMTP, avoiding use of"
22945 .cindex "HELO" "forcing use of"
22946 .cindex "EHLO" "avoiding use of"
22947 .cindex "PIPELINING" "avoiding the use of"
22948 This option is for use with broken hosts that announce ESMTP facilities (for
22949 example, PIPELINING) and then fail to implement them properly. When a host
22950 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22951 start of the SMTP session. This means that it cannot use any of the ESMTP
22952 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22953
22954
22955 .option hosts_avoid_pipelining smtp "host list&!!" unset
22956 .cindex "PIPELINING" "avoiding the use of"
22957 Exim will not use the SMTP PIPELINING extension when delivering to any host
22958 that matches this list, even if the server host advertises PIPELINING support.
22959
22960
22961 .option hosts_avoid_tls smtp "host list&!!" unset
22962 .cindex "TLS" "avoiding for certain hosts"
22963 Exim will not try to start a TLS session when delivering to any host that
22964 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22965
22966 .option hosts_verify_avoid_tls smtp "host list&!!" *
22967 .cindex "TLS" "avoiding for certain hosts"
22968 Exim will not try to start a TLS session for a verify callout,
22969 or when delivering in cutthrough mode,
22970 to any host that matches this list.
22971 Note that the default is to not use TLS.
22972
22973
22974 .option hosts_max_try smtp integer 5
22975 .cindex "host" "maximum number to try"
22976 .cindex "limit" "number of hosts tried"
22977 .cindex "limit" "number of MX tried"
22978 .cindex "MX record" "maximum tried"
22979 This option limits the number of IP addresses that are tried for any one
22980 delivery in cases where there are temporary delivery errors. Section
22981 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22982
22983
22984 .option hosts_max_try_hardlimit smtp integer 50
22985 This is an additional check on the maximum number of IP addresses that Exim
22986 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22987 why it exists.
22988
22989
22990
22991 .option hosts_nopass_tls smtp "host list&!!" unset
22992 .cindex "TLS" "passing connection"
22993 .cindex "multiple SMTP deliveries"
22994 .cindex "TLS" "multiple message deliveries"
22995 For any host that matches this list, a connection on which a TLS session has
22996 been started will not be passed to a new delivery process for sending another
22997 message on the same connection. See section &<<SECTmulmessam>>& for an
22998 explanation of when this might be needed.
22999
23000
23001 .option hosts_override smtp boolean false
23002 If this option is set and the &%hosts%& option is also set, any hosts that are
23003 attached to the address are ignored, and instead the hosts specified by the
23004 &%hosts%& option are always used. This option does not apply to
23005 &%fallback_hosts%&.
23006
23007
23008 .option hosts_randomize smtp boolean false
23009 .cindex "randomized host list"
23010 .cindex "host" "list of; randomized"
23011 .cindex "fallback" "randomized hosts"
23012 If this option is set, and either the list of hosts is taken from the
23013 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23014 were not obtained from MX records (this includes fallback hosts from the
23015 router), and were not randomized by the router, the order of trying the hosts
23016 is randomized each time the transport runs. Randomizing the order of a host
23017 list can be used to do crude load sharing.
23018
23019 When &%hosts_randomize%& is true, a host list may be split into groups whose
23020 order is separately randomized. This makes it possible to set up MX-like
23021 behaviour. The boundaries between groups are indicated by an item that is just
23022 &`+`& in the host list. For example:
23023 .code
23024 hosts = host1:host2:host3:+:host4:host5
23025 .endd
23026 The order of the first three hosts and the order of the last two hosts is
23027 randomized for each use, but the first three always end up before the last two.
23028 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23029
23030 .option hosts_require_auth smtp "host list&!!" unset
23031 .cindex "authentication" "required by client"
23032 This option provides a list of servers for which authentication must succeed
23033 before Exim will try to transfer a message. If authentication fails for
23034 servers which are not in this list, Exim tries to send unauthenticated. If
23035 authentication fails for one of these servers, delivery is deferred. This
23036 temporary error is detectable in the retry rules, so it can be turned into a
23037 hard failure if required. See also &%hosts_try_auth%&, and chapter
23038 &<<CHAPSMTPAUTH>>& for details of authentication.
23039
23040
23041 .option hosts_request_ocsp smtp "host list&!!" *
23042 .cindex "TLS" "requiring for certain servers"
23043 Exim will request a Certificate Status on a
23044 TLS session for any host that matches this list.
23045 &%tls_verify_certificates%& should also be set for the transport.
23046
23047 .option hosts_require_ocsp smtp "host list&!!" unset
23048 .cindex "TLS" "requiring for certain servers"
23049 Exim will request, and check for a valid Certificate Status being given, on a
23050 TLS session for any host that matches this list.
23051 &%tls_verify_certificates%& should also be set for the transport.
23052
23053 .option hosts_require_tls smtp "host list&!!" unset
23054 .cindex "TLS" "requiring for certain servers"
23055 Exim will insist on using a TLS session when delivering to any host that
23056 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23057 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23058 incoming messages, use an appropriate ACL.
23059
23060 .option hosts_try_auth smtp "host list&!!" unset
23061 .cindex "authentication" "optional in client"
23062 This option provides a list of servers to which, provided they announce
23063 authentication support, Exim will attempt to authenticate as a client when it
23064 connects. If authentication fails, Exim will try to transfer the message
23065 unauthenticated. See also &%hosts_require_auth%&, and chapter
23066 &<<CHAPSMTPAUTH>>& for details of authentication.
23067
23068 .option hosts_try_prdr smtp "host list&!!" unset
23069 .cindex "PRDR" "enabling, optional in client"
23070 This option provides a list of servers to which, provided they announce
23071 PRDR support, Exim will attempt to negotiate PRDR
23072 for multi-recipient messages.
23073
23074 .option interface smtp "string list&!!" unset
23075 .cindex "bind IP address"
23076 .cindex "IP address" "binding"
23077 .vindex "&$host$&"
23078 .vindex "&$host_address$&"
23079 This option specifies which interface to bind to when making an outgoing SMTP
23080 call. The value is an IP address, not an interface name such as
23081 &`eth0`&. Do not confuse this with the interface address that was used when a
23082 message was received, which is in &$received_ip_address$&, formerly known as
23083 &$interface_address$&. The name was changed to minimize confusion with the
23084 outgoing interface address. There is no variable that contains an outgoing
23085 interface address because, unless it is set by this option, its value is
23086 unknown.
23087
23088 During the expansion of the &%interface%& option the variables &$host$& and
23089 &$host_address$& refer to the host to which a connection is about to be made
23090 during the expansion of the string. Forced expansion failure, or an empty
23091 string result causes the option to be ignored. Otherwise, after expansion, the
23092 string must be a list of IP addresses, colon-separated by default, but the
23093 separator can be changed in the usual way. For example:
23094 .code
23095 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23096 .endd
23097 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23098 connection. If none of them are the correct type, the option is ignored. If
23099 &%interface%& is not set, or is ignored, the system's IP functions choose which
23100 interface to use if the host has more than one.
23101
23102
23103 .option keepalive smtp boolean true
23104 .cindex "keepalive" "on outgoing connection"
23105 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23106 connections. When set, it causes the kernel to probe idle connections
23107 periodically, by sending packets with &"old"& sequence numbers. The other end
23108 of the connection should send a acknowledgment if the connection is still okay
23109 or a reset if the connection has been aborted. The reason for doing this is
23110 that it has the beneficial effect of freeing up certain types of connection
23111 that can get stuck when the remote host is disconnected without tidying up the
23112 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23113 unreachable hosts.
23114
23115
23116 .option lmtp_ignore_quota smtp boolean false
23117 .cindex "LMTP" "ignoring quota errors"
23118 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23119 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23120 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23121
23122 .option max_rcpt smtp integer 100
23123 .cindex "RCPT" "maximum number of outgoing"
23124 This option limits the number of RCPT commands that are sent in a single
23125 SMTP message transaction. Each set of addresses is treated independently, and
23126 so can cause parallel connections to the same host if &%remote_max_parallel%&
23127 permits this.
23128
23129
23130 .option multi_domain smtp boolean true
23131 .vindex "&$domain$&"
23132 When this option is set, the &(smtp)& transport can handle a number of
23133 addresses containing a mixture of different domains provided they all resolve
23134 to the same list of hosts. Turning the option off restricts the transport to
23135 handling only one domain at a time. This is useful if you want to use
23136 &$domain$& in an expansion for the transport, because it is set only when there
23137 is a single domain involved in a remote delivery.
23138
23139
23140 .option port smtp string&!! "see below"
23141 .cindex "port" "sending TCP/IP"
23142 .cindex "TCP/IP" "setting outgoing port"
23143 This option specifies the TCP/IP port on the server to which Exim connects.
23144 &*Note:*& Do not confuse this with the port that was used when a message was
23145 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23146 The name was changed to minimize confusion with the outgoing port. There is no
23147 variable that contains an outgoing port.
23148
23149 If the value of this option begins with a digit it is taken as a port number;
23150 otherwise it is looked up using &[getservbyname()]&. The default value is
23151 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23152 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23153 is deferred.
23154
23155
23156
23157 .option protocol smtp string smtp
23158 .cindex "LMTP" "over TCP/IP"
23159 .cindex "ssmtp protocol" "outbound"
23160 .cindex "TLS" "SSL-on-connect outbound"
23161 .vindex "&$port$&"
23162 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23163 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23164 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23165 deliveries into closed message stores. Exim also has support for running LMTP
23166 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23167
23168 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23169 changes to &"smtps"&, and the transport initiates TLS immediately after
23170 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23171 The Internet standards bodies strongly discourage use of this mode.
23172
23173
23174 .option retry_include_ip_address smtp boolean true
23175 Exim normally includes both the host name and the IP address in the key it
23176 constructs for indexing retry data after a temporary delivery failure. This
23177 means that when one of several IP addresses for a host is failing, it gets
23178 tried periodically (controlled by the retry rules), but use of the other IP
23179 addresses is not affected.
23180
23181 However, in some dialup environments hosts are assigned a different IP address
23182 each time they connect. In this situation the use of the IP address as part of
23183 the retry key leads to undesirable behaviour. Setting this option false causes
23184 Exim to use only the host name. This should normally be done on a separate
23185 instance of the &(smtp)& transport, set up specially to handle the dialup
23186 hosts.
23187
23188
23189 .option serialize_hosts smtp "host list&!!" unset
23190 .cindex "serializing connections"
23191 .cindex "host" "serializing connections"
23192 Because Exim operates in a distributed manner, if several messages for the same
23193 host arrive at around the same time, more than one simultaneous connection to
23194 the remote host can occur. This is not usually a problem except when there is a
23195 slow link between the hosts. In that situation it may be helpful to restrict
23196 Exim to one connection at a time. This can be done by setting
23197 &%serialize_hosts%& to match the relevant hosts.
23198
23199 .cindex "hints database" "serializing deliveries to a host"
23200 Exim implements serialization by means of a hints database in which a record is
23201 written whenever a process connects to one of the restricted hosts. The record
23202 is deleted when the connection is completed. Obviously there is scope for
23203 records to get left lying around if there is a system or program crash. To
23204 guard against this, Exim ignores any records that are more than six hours old.
23205
23206 If you set up this kind of serialization, you should also arrange to delete the
23207 relevant hints database whenever your system reboots. The names of the files
23208 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23209 may be one or two files, depending on the type of DBM in use. The same files
23210 are used for ETRN serialization.
23211
23212
23213 .option size_addition smtp integer 1024
23214 .cindex "SMTP" "SIZE"
23215 .cindex "message" "size issue for transport filter"
23216 .cindex "size" "of message"
23217 .cindex "transport" "filter"
23218 .cindex "filter" "transport filter"
23219 If a remote SMTP server indicates that it supports the SIZE option of the
23220 MAIL command, Exim uses this to pass over the message size at the start of
23221 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23222 sends, to allow for headers and other text that may be added during delivery by
23223 configuration options or in a transport filter. It may be necessary to increase
23224 this if a lot of text is added to messages.
23225
23226 Alternatively, if the value of &%size_addition%& is set negative, it disables
23227 the use of the SIZE option altogether.
23228
23229
23230 .option tls_certificate smtp string&!! unset
23231 .cindex "TLS" "client certificate, location of"
23232 .cindex "certificate" "client, location of"
23233 .vindex "&$host$&"
23234 .vindex "&$host_address$&"
23235 The value of this option must be the absolute path to a file which contains the
23236 client's certificate, for possible use when sending a message over an encrypted
23237 connection. The values of &$host$& and &$host_address$& are set to the name and
23238 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23239 details of TLS.
23240
23241 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23242 certificate when sending messages as a client. The global option of the same
23243 name specifies the certificate for Exim as a server; it is not automatically
23244 assumed that the same certificate should be used when Exim is operating as a
23245 client.
23246
23247
23248 .option tls_crl smtp string&!! unset
23249 .cindex "TLS" "client certificate revocation list"
23250 .cindex "certificate" "revocation list for client"
23251 This option specifies a certificate revocation list. The expanded value must
23252 be the name of a file that contains a CRL in PEM format.
23253
23254
23255 .option tls_dh_min_bits smtp integer 1024
23256 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23257 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23258 key agreement is negotiated, the server will provide a large prime number
23259 for use.  This option establishes the minimum acceptable size of that number.
23260 If the parameter offered by the server is too small, then the TLS handshake
23261 will fail.
23262
23263 Only supported when using GnuTLS.
23264
23265
23266 .option tls_privatekey smtp string&!! unset
23267 .cindex "TLS" "client private key, location of"
23268 .vindex "&$host$&"
23269 .vindex "&$host_address$&"
23270 The value of this option must be the absolute path to a file which contains the
23271 client's private key. This is used when sending a message over an encrypted
23272 connection using a client certificate. The values of &$host$& and
23273 &$host_address$& are set to the name and address of the server during the
23274 expansion. If this option is unset, or the expansion is forced to fail, or the
23275 result is an empty string, the private key is assumed to be in the same file as
23276 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23277
23278
23279 .option tls_require_ciphers smtp string&!! unset
23280 .cindex "TLS" "requiring specific ciphers"
23281 .cindex "cipher" "requiring specific"
23282 .vindex "&$host$&"
23283 .vindex "&$host_address$&"
23284 The value of this option must be a list of permitted cipher suites, for use
23285 when setting up an outgoing encrypted connection. (There is a global option of
23286 the same name for controlling incoming connections.) The values of &$host$& and
23287 &$host_address$& are set to the name and address of the server during the
23288 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23289 is used in different ways by OpenSSL and GnuTLS (see sections
23290 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23291 ciphers is a preference order.
23292
23293
23294
23295 .option tls_sni smtp string&!! unset
23296 .cindex "TLS" "Server Name Indication"
23297 .vindex "&$tls_sni$&"
23298 If this option is set then it sets the $tls_out_sni variable and causes any
23299 TLS session to pass this value as the Server Name Indication extension to
23300 the remote side, which can be used by the remote side to select an appropriate
23301 certificate and private key for the session.
23302
23303 See &<<SECTtlssni>>& for more information.
23304
23305 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23306 TLS extensions.
23307
23308
23309
23310
23311 .option tls_tempfail_tryclear smtp boolean true
23312 .cindex "4&'xx'& responses" "to STARTTLS"
23313 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23314 setting up a TLS session, this option determines whether or not Exim should try
23315 to deliver the message unencrypted. If it is set false, delivery to the
23316 current host is deferred; if there are other hosts, they are tried. If this
23317 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23318 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23319 TLS negotiation fails, Exim closes the current connection (because it is in an
23320 unknown state), opens a new one to the same host, and then tries the delivery
23321 in clear.
23322
23323
23324 .option tls_try_verify_hosts smtp "host list&!! unset
23325 .cindex "TLS" "server certificate verification"
23326 .cindex "certificate" "verification of server"
23327 This option gives a list of hosts for which, on encrypted connections,
23328 certificate verification will be tried but need not succeed.
23329 The &%tls_verify_certificates%& option must also be set.
23330 Note that unless the host is in this list
23331 TLS connections will be denied to hosts using self-signed certificates
23332 when &%tls_verify_certificates%& is set.
23333 The &$tls_out_certificate_verified$& variable is set when
23334 certificate verification succeeds.
23335
23336
23337 .option tls_verify_certificates smtp string&!! unset
23338 .cindex "TLS" "server certificate verification"
23339 .cindex "certificate" "verification of server"
23340 .vindex "&$host$&"
23341 .vindex "&$host_address$&"
23342 The value of this option must be the absolute path to a file containing
23343 permitted server certificates, for use when setting up an encrypted connection.
23344 Alternatively, if you are using OpenSSL, you can set
23345 &%tls_verify_certificates%& to the name of a directory containing certificate
23346 files. This does not work with GnuTLS; the option must be set to the name of a
23347 single file if you are using GnuTLS. The values of &$host$& and
23348 &$host_address$& are set to the name and address of the server during the
23349 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23350
23351 For back-compatability,
23352 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23353 and certificate verification fails the TLS connection is closed.
23354
23355
23356 .option tls_verify_hosts smtp "host list&!! unset
23357 .cindex "TLS" "server certificate verification"
23358 .cindex "certificate" "verification of server"
23359 This option gives a list of hosts for which. on encrypted connections,
23360 certificate verification must succeed.
23361 The &%tls_verify_certificates%& option must also be set.
23362 If both this option and &%tls_try_verify_hosts%& are unset
23363 operation is as if this option selected all hosts.
23364
23365
23366
23367
23368 .section "How the limits for the number of hosts to try are used" &&&
23369          "SECTvalhosmax"
23370 .cindex "host" "maximum number to try"
23371 .cindex "limit" "hosts; maximum number tried"
23372 There are two options that are concerned with the number of hosts that are
23373 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23374 &%hosts_max_try_hardlimit%&.
23375
23376
23377 The &%hosts_max_try%& option limits the number of hosts that are tried
23378 for a single delivery. However, despite the term &"host"& in its name, the
23379 option actually applies to each IP address independently. In other words, a
23380 multihomed host is treated as several independent hosts, just as it is for
23381 retrying.
23382
23383 Many of the larger ISPs have multiple MX records which often point to
23384 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23385 created as a result of routing one of these domains.
23386
23387 Trying every single IP address on such a long list does not seem sensible; if
23388 several at the top of the list fail, it is reasonable to assume there is some
23389 problem that is likely to affect all of them. Roughly speaking, the value of
23390 &%hosts_max_try%& is the maximum number that are tried before deferring the
23391 delivery. However, the logic cannot be quite that simple.
23392
23393 Firstly, IP addresses that are skipped because their retry times have not
23394 arrived do not count, and in addition, addresses that are past their retry
23395 limits are also not counted, even when they are tried. This means that when
23396 some IP addresses are past their retry limits, more than the value of
23397 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23398 that all IP addresses are considered before timing out an email address (but
23399 see below for an exception).
23400
23401 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23402 list to see if there is a subsequent host with a different (higher valued) MX.
23403 If there is, that host is considered next, and the current IP address is used
23404 but not counted. This behaviour helps in the case of a domain with a retry rule
23405 that hardly ever delays any hosts, as is now explained:
23406
23407 Consider the case of a long list of hosts with one MX value, and a few with a
23408 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23409 hosts at the top of the list are tried at first. With the default retry rule,
23410 which specifies increasing retry times, the higher MX hosts are eventually
23411 tried when those at the top of the list are skipped because they have not
23412 reached their retry times.
23413
23414 However, it is common practice to put a fixed short retry time on domains for
23415 large ISPs, on the grounds that their servers are rarely down for very long.
23416 Unfortunately, these are exactly the domains that tend to resolve to long lists
23417 of hosts. The short retry time means that the lowest MX hosts are tried every
23418 time. The attempts may be in a different order because of random sorting, but
23419 without the special MX check, the higher MX hosts would never be tried until
23420 all the lower MX hosts had timed out (which might be several days), because
23421 there are always some lower MX hosts that have reached their retry times. With
23422 the special check, Exim considers at least one IP address from each MX value at
23423 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23424 reached.
23425
23426 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23427 particular, Exim normally eventually tries all the IP addresses before timing
23428 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23429 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23430 been set up with hundreds of IP addresses for some domains. It can
23431 take a very long time indeed for an address to time out in these cases.
23432
23433 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23434 Exim never tries more than this number of IP addresses; if it hits this limit
23435 and they are all timed out, the email address is bounced, even though not all
23436 possible IP addresses have been tried.
23437 .ecindex IIDsmttra1
23438 .ecindex IIDsmttra2
23439
23440
23441
23442
23443
23444 . ////////////////////////////////////////////////////////////////////////////
23445 . ////////////////////////////////////////////////////////////////////////////
23446
23447 .chapter "Address rewriting" "CHAPrewrite"
23448 .scindex IIDaddrew "rewriting" "addresses"
23449 There are some circumstances in which Exim automatically rewrites domains in
23450 addresses. The two most common are when an address is given without a domain
23451 (referred to as an &"unqualified address"&) or when an address contains an
23452 abbreviated domain that is expanded by DNS lookup.
23453
23454 Unqualified envelope addresses are accepted only for locally submitted
23455 messages, or for messages that are received from hosts matching
23456 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23457 appropriate. Unqualified addresses in header lines are qualified if they are in
23458 locally submitted messages, or messages from hosts that are permitted to send
23459 unqualified envelope addresses. Otherwise, unqualified addresses in header
23460 lines are neither qualified nor rewritten.
23461
23462 One situation in which Exim does &'not'& automatically rewrite a domain is
23463 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23464 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23465 do this. The new RFCs do not contain this suggestion.
23466
23467
23468 .section "Explicitly configured address rewriting" "SECID147"
23469 This chapter describes the rewriting rules that can be used in the
23470 main rewrite section of the configuration file, and also in the generic
23471 &%headers_rewrite%& option that can be set on any transport.
23472
23473 Some people believe that configured address rewriting is a Mortal Sin.
23474 Others believe that life is not possible without it. Exim provides the
23475 facility; you do not have to use it.
23476
23477 The main rewriting rules that appear in the &"rewrite"& section of the
23478 configuration file are applied to addresses in incoming messages, both envelope
23479 addresses and addresses in header lines. Each rule specifies the types of
23480 address to which it applies.
23481
23482 Whether or not addresses in header lines are rewritten depends on the origin of
23483 the headers and the type of rewriting. Global rewriting, that is, rewriting
23484 rules from the rewrite section of the configuration file, is applied only to
23485 those headers that were received with the message. Header lines that are added
23486 by ACLs or by a system filter or by individual routers or transports (which
23487 are specific to individual recipient addresses) are not rewritten by the global
23488 rules.
23489
23490 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23491 applies all headers except those added by routers and transports. That is, as
23492 well as the headers that were received with the message, it also applies to
23493 headers that were added by an ACL or a system filter.
23494
23495
23496 In general, rewriting addresses from your own system or domain has some
23497 legitimacy. Rewriting other addresses should be done only with great care and
23498 in special circumstances. The author of Exim believes that rewriting should be
23499 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23500 Although it can sometimes be used as a routing tool, this is very strongly
23501 discouraged.
23502
23503 There are two commonly encountered circumstances where rewriting is used, as
23504 illustrated by these examples:
23505
23506 .ilist
23507 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23508 exchange mail with each other behind a firewall, but there is only a single
23509 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23510 &'hitch.fict.example'& when sending mail off-site.
23511 .next
23512 A host rewrites the local parts of its own users so that, for example,
23513 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23514 .endlist
23515
23516
23517
23518 .section "When does rewriting happen?" "SECID148"
23519 .cindex "rewriting" "timing of"
23520 .cindex "&ACL;" "rewriting addresses in"
23521 Configured address rewriting can take place at several different stages of a
23522 message's processing.
23523
23524 .vindex "&$sender_address$&"
23525 At the start of an ACL for MAIL, the sender address may have been rewritten
23526 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23527 ordinary rewrite rules have yet been applied. If, however, the sender address
23528 is verified in the ACL, it is rewritten before verification, and remains
23529 rewritten thereafter. The subsequent value of &$sender_address$& is the
23530 rewritten address. This also applies if sender verification happens in a
23531 RCPT ACL. Otherwise, when the sender address is not verified, it is
23532 rewritten as soon as a message's header lines have been received.
23533
23534 .vindex "&$domain$&"
23535 .vindex "&$local_part$&"
23536 Similarly, at the start of an ACL for RCPT, the current recipient's address
23537 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23538 rewrite rules have yet been applied to it. However, the behaviour is different
23539 from the sender address when a recipient is verified. The address is rewritten
23540 for the verification, but the rewriting is not remembered at this stage. The
23541 value of &$local_part$& and &$domain$& after verification are always the same
23542 as they were before (that is, they contain the unrewritten &-- except for
23543 SMTP-time rewriting &-- address).
23544
23545 As soon as a message's header lines have been received, all the envelope
23546 recipient addresses are permanently rewritten, and rewriting is also applied to
23547 the addresses in the header lines (if configured). This happens before adding
23548 any header lines that were specified in MAIL or RCPT ACLs, and
23549 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23550 before the DATA ACL and &[local_scan()]& functions are run.
23551
23552 When an address is being routed, either for delivery or for verification,
23553 rewriting is applied immediately to child addresses that are generated by
23554 redirection, unless &%no_rewrite%& is set on the router.
23555
23556 .cindex "envelope sender" "rewriting at transport time"
23557 .cindex "rewriting" "at transport time"
23558 .cindex "header lines" "rewriting at transport time"
23559 At transport time, additional rewriting of addresses in header lines can be
23560 specified by setting the generic &%headers_rewrite%& option on a transport.
23561 This option contains rules that are identical in form to those in the rewrite
23562 section of the configuration file. They are applied to the original message
23563 header lines and any that were added by ACLs or a system filter. They are not
23564 applied to header lines that are added by routers or the transport.
23565
23566 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23567 transport option. However, it is not possible to rewrite envelope recipients at
23568 transport time.
23569
23570
23571
23572
23573 .section "Testing the rewriting rules that apply on input" "SECID149"
23574 .cindex "rewriting" "testing"
23575 .cindex "testing" "rewriting"
23576 Exim's input rewriting configuration appears in a part of the run time
23577 configuration file headed by &"begin rewrite"&. It can be tested by the
23578 &%-brw%& command line option. This takes an address (which can be a full RFC
23579 2822 address) as its argument. The output is a list of how the address would be
23580 transformed by the rewriting rules for each of the different places it might
23581 appear in an incoming message, that is, for each different header and for the
23582 envelope sender and recipient fields. For example,
23583 .code
23584 exim -brw ph10@exim.workshop.example
23585 .endd
23586 might produce the output
23587 .code
23588 sender: Philip.Hazel@exim.workshop.example
23589 from: Philip.Hazel@exim.workshop.example
23590 to: ph10@exim.workshop.example
23591 cc: ph10@exim.workshop.example
23592 bcc: ph10@exim.workshop.example
23593 reply-to: Philip.Hazel@exim.workshop.example
23594 env-from: Philip.Hazel@exim.workshop.example
23595 env-to: ph10@exim.workshop.example
23596 .endd
23597 which shows that rewriting has been set up for that address when used in any of
23598 the source fields, but not when it appears as a recipient address. At the
23599 present time, there is no equivalent way of testing rewriting rules that are
23600 set for a particular transport.
23601
23602
23603 .section "Rewriting rules" "SECID150"
23604 .cindex "rewriting" "rules"
23605 The rewrite section of the configuration file consists of lines of rewriting
23606 rules in the form
23607 .display
23608 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23609 .endd
23610 Rewriting rules that are specified for the &%headers_rewrite%& generic
23611 transport option are given as a colon-separated list. Each item in the list
23612 takes the same form as a line in the main rewriting configuration (except that
23613 any colons must be doubled, of course).
23614
23615 The formats of source patterns and replacement strings are described below.
23616 Each is terminated by white space, unless enclosed in double quotes, in which
23617 case normal quoting conventions apply inside the quotes. The flags are single
23618 characters which may appear in any order. Spaces and tabs between them are
23619 ignored.
23620
23621 For each address that could potentially be rewritten, the rules are scanned in
23622 order, and replacements for the address from earlier rules can themselves be
23623 replaced by later rules (but see the &"q"& and &"R"& flags).
23624
23625 The order in which addresses are rewritten is undefined, may change between
23626 releases, and must not be relied on, with one exception: when a message is
23627 received, the envelope sender is always rewritten first, before any header
23628 lines are rewritten. For example, the replacement string for a rewrite of an
23629 address in &'To:'& must not assume that the message's address in &'From:'& has
23630 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23631 that the envelope sender has already been rewritten.
23632
23633 .vindex "&$domain$&"
23634 .vindex "&$local_part$&"
23635 The variables &$local_part$& and &$domain$& can be used in the replacement
23636 string to refer to the address that is being rewritten. Note that lookup-driven
23637 rewriting can be done by a rule of the form
23638 .code
23639 *@*   ${lookup ...
23640 .endd
23641 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23642 refer to the address that is being rewritten.
23643
23644
23645 .section "Rewriting patterns" "SECID151"
23646 .cindex "rewriting" "patterns"
23647 .cindex "address list" "in a rewriting pattern"
23648 The source pattern in a rewriting rule is any item which may appear in an
23649 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23650 single-item address list, which means that it is expanded before being tested
23651 against the address. As always, if you use a regular expression as a pattern,
23652 you must take care to escape dollar and backslash characters, or use the &`\N`&
23653 facility to suppress string expansion within the regular expression.
23654
23655 Domains in patterns should be given in lower case. Local parts in patterns are
23656 case-sensitive. If you want to do case-insensitive matching of local parts, you
23657 can use a regular expression that starts with &`^(?i)`&.
23658
23659 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23660 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23661 depending on the type of match which occurred. These can be used in the
23662 replacement string to insert portions of the incoming address. &$0$& always
23663 refers to the complete incoming address. When a regular expression is used, the
23664 numerical variables are set from its capturing subexpressions. For other types
23665 of pattern they are set as follows:
23666
23667 .ilist
23668 If a local part or domain starts with an asterisk, the numerical variables
23669 refer to the character strings matched by asterisks, with &$1$& associated with
23670 the first asterisk, and &$2$& with the second, if present. For example, if the
23671 pattern
23672 .code
23673 *queen@*.fict.example
23674 .endd
23675 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23676 .code
23677 $0 = hearts-queen@wonderland.fict.example
23678 $1 = hearts-
23679 $2 = wonderland
23680 .endd
23681 Note that if the local part does not start with an asterisk, but the domain
23682 does, it is &$1$& that contains the wild part of the domain.
23683
23684 .next
23685 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23686 of the domain are placed in the next available numerical variables. Suppose,
23687 for example, that the address &'foo@bar.baz.example'& is processed by a
23688 rewriting rule of the form
23689 .display
23690 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23691 .endd
23692 and the key in the file that matches the domain is &`*.baz.example`&. Then
23693 .code
23694 $1 = foo
23695 $2 = bar
23696 $3 = baz.example
23697 .endd
23698 If the address &'foo@baz.example'& is looked up, this matches the same
23699 wildcard file entry, and in this case &$2$& is set to the empty string, but
23700 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23701 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23702 whole domain. For non-partial domain lookups, no numerical variables are set.
23703 .endlist
23704
23705
23706 .section "Rewriting replacements" "SECID152"
23707 .cindex "rewriting" "replacements"
23708 If the replacement string for a rule is a single asterisk, addresses that
23709 match the pattern and the flags are &'not'& rewritten, and no subsequent
23710 rewriting rules are scanned. For example,
23711 .code
23712 hatta@lookingglass.fict.example  *  f
23713 .endd
23714 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23715 &'From:'& headers.
23716
23717 .vindex "&$domain$&"
23718 .vindex "&$local_part$&"
23719 If the replacement string is not a single asterisk, it is expanded, and must
23720 yield a fully qualified address. Within the expansion, the variables
23721 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23722 Any letters they contain retain their original case &-- they are not lower
23723 cased. The numerical variables are set up according to the type of pattern that
23724 matched the address, as described above. If the expansion is forced to fail by
23725 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23726 current rule is abandoned, but subsequent rules may take effect. Any other
23727 expansion failure causes the entire rewriting operation to be abandoned, and an
23728 entry written to the panic log.
23729
23730
23731
23732 .section "Rewriting flags" "SECID153"
23733 There are three different kinds of flag that may appear on rewriting rules:
23734
23735 .ilist
23736 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23737 c, f, h, r, s, t.
23738 .next
23739 A flag that specifies rewriting at SMTP time: S.
23740 .next
23741 Flags that control the rewriting process: Q, q, R, w.
23742 .endlist
23743
23744 For rules that are part of the &%headers_rewrite%& generic transport option,
23745 E, F, T, and S are not permitted.
23746
23747
23748
23749 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23750          "SECID154"
23751 .cindex "rewriting" "flags"
23752 If none of the following flag letters, nor the &"S"& flag (see section
23753 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23754 and to both the sender and recipient fields of the envelope, whereas a
23755 transport-time rewriting rule just applies to all headers. Otherwise, the
23756 rewriting rule is skipped unless the relevant addresses are being processed.
23757 .display
23758 &`E`&       rewrite all envelope fields
23759 &`F`&       rewrite the envelope From field
23760 &`T`&       rewrite the envelope To field
23761 &`b`&       rewrite the &'Bcc:'& header
23762 &`c`&       rewrite the &'Cc:'& header
23763 &`f`&       rewrite the &'From:'& header
23764 &`h`&       rewrite all headers
23765 &`r`&       rewrite the &'Reply-To:'& header
23766 &`s`&       rewrite the &'Sender:'& header
23767 &`t`&       rewrite the &'To:'& header
23768 .endd
23769 "All headers" means all of the headers listed above that can be selected
23770 individually, plus their &'Resent-'& versions. It does not include
23771 other headers such as &'Subject:'& etc.
23772
23773 You should be particularly careful about rewriting &'Sender:'& headers, and
23774 restrict this to special known cases in your own domains.
23775
23776
23777 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23778 .cindex "SMTP" "rewriting malformed addresses"
23779 .cindex "RCPT" "rewriting argument of"
23780 .cindex "MAIL" "rewriting argument of"
23781 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23782 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23783 before any other processing; even before syntax checking. The pattern is
23784 required to be a regular expression, and it is matched against the whole of the
23785 data for the command, including any surrounding angle brackets.
23786
23787 .vindex "&$domain$&"
23788 .vindex "&$local_part$&"
23789 This form of rewrite rule allows for the handling of addresses that are not
23790 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23791 input). Because the input is not required to be a syntactically valid address,
23792 the variables &$local_part$& and &$domain$& are not available during the
23793 expansion of the replacement string. The result of rewriting replaces the
23794 original address in the MAIL or RCPT command.
23795
23796
23797 .section "Flags controlling the rewriting process" "SECID155"
23798 There are four flags which control the way the rewriting process works. These
23799 take effect only when a rule is invoked, that is, when the address is of the
23800 correct type (matches the flags) and matches the pattern:
23801
23802 .ilist
23803 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23804 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23805 absence of &"Q"& the rewritten address must always include a domain.
23806 .next
23807 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23808 even if no rewriting actually takes place because of a &"fail"& in the
23809 expansion. The &"q"& flag is not effective if the address is of the wrong type
23810 (does not match the flags) or does not match the pattern.
23811 .next
23812 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23813 address, up to ten times. It can be combined with the &"q"& flag, to stop
23814 rewriting once it fails to match (after at least one successful rewrite).
23815 .next
23816 .cindex "rewriting" "whole addresses"
23817 When an address in a header is rewritten, the rewriting normally applies only
23818 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23819 left unchanged. For example, rewriting might change
23820 .code
23821 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23822 .endd
23823 into
23824 .code
23825 From: Ford Prefect <prefectf@hitch.fict.example>
23826 .endd
23827 .cindex "RFC 2047"
23828 Sometimes there is a need to replace the whole address item, and this can be
23829 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23830 causes an address in a header line to be rewritten, the entire address is
23831 replaced, not just the working part. The replacement must be a complete RFC
23832 2822 address, including the angle brackets if necessary. If text outside angle
23833 brackets contains a character whose value is greater than 126 or less than 32
23834 (except for tab), the text is encoded according to RFC 2047. The character set
23835 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23836
23837 When the &"w"& flag is set on a rule that causes an envelope address to be
23838 rewritten, all but the working part of the replacement address is discarded.
23839 .endlist
23840
23841
23842 .section "Rewriting examples" "SECID156"
23843 Here is an example of the two common rewriting paradigms:
23844 .code
23845 *@*.hitch.fict.example  $1@hitch.fict.example
23846 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23847                      {$value}fail}@hitch.fict.example bctfrF
23848 .endd
23849 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23850 the string expansion to fail if the lookup does not succeed. In this context it
23851 has the effect of leaving the original address unchanged, but Exim goes on to
23852 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23853 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23854 explicitly, which would cause the rewritten address to be the same as before,
23855 at the cost of a small bit of processing. Not supplying either of these is an
23856 error, since the rewritten address would then contain no local part.
23857
23858 The first example above replaces the domain with a superior, more general
23859 domain. This may not be desirable for certain local parts. If the rule
23860 .code
23861 root@*.hitch.fict.example  *
23862 .endd
23863 were inserted before the first rule, rewriting would be suppressed for the
23864 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23865
23866 Rewriting can be made conditional on a number of tests, by making use of
23867 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23868 messages that originate outside the local host:
23869 .code
23870 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23871                          {$1@hitch.fict.example}fail}"
23872 .endd
23873 The replacement string is quoted in this example because it contains white
23874 space.
23875
23876 .cindex "rewriting" "bang paths"
23877 .cindex "bang paths" "rewriting"
23878 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23879 an address it treats it as an unqualified local part which it qualifies with
23880 the local qualification domain (if the source of the message is local or if the
23881 remote host is permitted to send unqualified addresses). Rewriting can
23882 sometimes be used to handle simple bang paths with a fixed number of
23883 components. For example, the rule
23884 .code
23885 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23886 .endd
23887 rewrites a two-component bang path &'host.name!user'& as the domain address
23888 &'user@host.name'&. However, there is a security implication in using this as
23889 a global rewriting rule for envelope addresses. It can provide a backdoor
23890 method for using your system as a relay, because the incoming addresses appear
23891 to be local. If the bang path addresses are received via SMTP, it is safer to
23892 use the &"S"& flag to rewrite them as they are received, so that relay checking
23893 can be done on the rewritten addresses.
23894 .ecindex IIDaddrew
23895
23896
23897
23898
23899
23900 . ////////////////////////////////////////////////////////////////////////////
23901 . ////////////////////////////////////////////////////////////////////////////
23902
23903 .chapter "Retry configuration" "CHAPretry"
23904 .scindex IIDretconf1 "retry" "configuration, description of"
23905 .scindex IIDregconf2 "configuration file" "retry section"
23906 The &"retry"& section of the runtime configuration file contains a list of
23907 retry rules that control how often Exim tries to deliver messages that cannot
23908 be delivered at the first attempt. If there are no retry rules (the section is
23909 empty or not present), there are no retries. In this situation, temporary
23910 errors are treated as permanent. The default configuration contains a single,
23911 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23912 line option can be used to test which retry rule will be used for a given
23913 address, domain and error.
23914
23915 The most common cause of retries is temporary failure to deliver to a remote
23916 host because the host is down, or inaccessible because of a network problem.
23917 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23918 address) basis, not on a per-message basis. Thus, if one message has recently
23919 been delayed, delivery of a new message to the same host is not immediately
23920 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23921 log selector is set, the message
23922 .cindex "retry" "time not reached"
23923 &"retry time not reached"& is written to the main log whenever a delivery is
23924 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23925 the handling of errors during remote deliveries.
23926
23927 Retry processing applies to routing as well as to delivering, except as covered
23928 in the next paragraph. The retry rules do not distinguish between these
23929 actions. It is not possible, for example, to specify different behaviour for
23930 failures to route the domain &'snark.fict.example'& and failures to deliver to
23931 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23932 added complication, so did not implement it. However, although they share the
23933 same retry rule, the actual retry times for routing and transporting a given
23934 domain are maintained independently.
23935
23936 When a delivery is not part of a queue run (typically an immediate delivery on
23937 receipt of a message), the routers are always run, and local deliveries are
23938 always attempted, even if retry times are set for them. This makes for better
23939 behaviour if one particular message is causing problems (for example, causing
23940 quota overflow, or provoking an error in a filter file). If such a delivery
23941 suffers a temporary failure, the retry data is updated as normal, and
23942 subsequent delivery attempts from queue runs occur only when the retry time for
23943 the local address is reached.
23944
23945 .section "Changing retry rules" "SECID157"
23946 If you change the retry rules in your configuration, you should consider
23947 whether or not to delete the retry data that is stored in Exim's spool area in
23948 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23949 always safe; that is why they are called &"hints"&.
23950
23951 The hints retry data contains suggested retry times based on the previous
23952 rules. In the case of a long-running problem with a remote host, it might
23953 record the fact that the host has timed out. If your new rules increase the
23954 timeout time for such a host, you should definitely remove the old retry data
23955 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23956 messages that it should now be retaining.
23957
23958
23959
23960 .section "Format of retry rules" "SECID158"
23961 .cindex "retry" "rules"
23962 Each retry rule occupies one line and consists of three or four parts,
23963 separated by white space: a pattern, an error name, an optional list of sender
23964 addresses, and a list of retry parameters. The pattern and sender lists must be
23965 enclosed in double quotes if they contain white space. The rules are searched
23966 in order until one is found where the pattern, error name, and sender list (if
23967 present) match the failing host or address, the error that occurred, and the
23968 message's sender, respectively.
23969
23970
23971 The pattern is any single item that may appear in an address list (see section
23972 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23973 which means that it is expanded before being tested against the address that
23974 has been delayed. A negated address list item is permitted. Address
23975 list processing treats a plain domain name as if it were preceded by &"*@"&,
23976 which makes it possible for many retry rules to start with just a domain. For
23977 example,
23978 .code
23979 lookingglass.fict.example        *  F,24h,30m;
23980 .endd
23981 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23982 whereas
23983 .code
23984 alice@lookingglass.fict.example  *  F,24h,30m;
23985 .endd
23986 applies only to temporary failures involving the local part &%alice%&.
23987 In practice, almost all rules start with a domain name pattern without a local
23988 part.
23989
23990 .cindex "regular expressions" "in retry rules"
23991 &*Warning*&: If you use a regular expression in a retry rule pattern, it
23992 must match a complete address, not just a domain, because that is how regular
23993 expressions work in address lists.
23994 .display
23995 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23996 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23997 .endd
23998
23999
24000 .section "Choosing which retry rule to use for address errors" "SECID159"
24001 When Exim is looking for a retry rule after a routing attempt has failed (for
24002 example, after a DNS timeout), each line in the retry configuration is tested
24003 against the complete address only if &%retry_use_local_part%& is set for the
24004 router. Otherwise, only the domain is used, except when matching against a
24005 regular expression, when the local part of the address is replaced with &"*"&.
24006 A domain on its own can match a domain pattern, or a pattern that starts with
24007 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24008 &%check_local_user%& is true, and false for other routers.
24009
24010 Similarly, when Exim is looking for a retry rule after a local delivery has
24011 failed (for example, after a mailbox full error), each line in the retry
24012 configuration is tested against the complete address only if
24013 &%retry_use_local_part%& is set for the transport (it defaults true for all
24014 local transports).
24015
24016 .cindex "4&'xx'& responses" "retry rules for"
24017 However, when Exim is looking for a retry rule after a remote delivery attempt
24018 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24019 whole address is always used as the key when searching the retry rules. The
24020 rule that is found is used to create a retry time for the combination of the
24021 failing address and the message's sender. It is the combination of sender and
24022 recipient that is delayed in subsequent queue runs until its retry time is
24023 reached. You can delay the recipient without regard to the sender by setting
24024 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24025 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24026 commands.
24027
24028
24029
24030 .section "Choosing which retry rule to use for host and message errors" &&&
24031          "SECID160"
24032 For a temporary error that is not related to an individual address (for
24033 example, a connection timeout), each line in the retry configuration is checked
24034 twice. First, the name of the remote host is used as a domain name (preceded by
24035 &"*@"& when matching a regular expression). If this does not match the line,
24036 the domain from the email address is tried in a similar fashion. For example,
24037 suppose the MX records for &'a.b.c.example'& are
24038 .code
24039 a.b.c.example  MX  5  x.y.z.example
24040                MX  6  p.q.r.example
24041                MX  7  m.n.o.example
24042 .endd
24043 and the retry rules are
24044 .code
24045 p.q.r.example    *      F,24h,30m;
24046 a.b.c.example    *      F,4d,45m;
24047 .endd
24048 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24049 first rule matches neither the host nor the domain, so Exim looks at the second
24050 rule. This does not match the host, but it does match the domain, so it is used
24051 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24052 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24053 first retry rule is used, because it matches the host.
24054
24055 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24056 first rule to determine retry times, but for all the other hosts for the domain
24057 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24058 routing to &'a.b.c.example'& suffers a temporary failure.
24059
24060 &*Note*&: The host name is used when matching the patterns, not its IP address.
24061 However, if a message is routed directly to an IP address without the use of a
24062 host name, for example, if a &(manualroute)& router contains a setting such as:
24063 .code
24064 route_list = *.a.example  192.168.34.23
24065 .endd
24066 then the &"host name"& that is used when searching for a retry rule is the
24067 textual form of the IP address.
24068
24069 .section "Retry rules for specific errors" "SECID161"
24070 .cindex "retry" "specific errors; specifying"
24071 The second field in a retry rule is the name of a particular error, or an
24072 asterisk, which matches any error. The errors that can be tested for are:
24073
24074 .vlist
24075 .vitem &%auth_failed%&
24076 Authentication failed when trying to send to a host in the
24077 &%hosts_require_auth%& list in an &(smtp)& transport.
24078
24079 .vitem &%data_4xx%&
24080 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24081 after the command, or after sending the message's data.
24082
24083 .vitem &%mail_4xx%&
24084 A 4&'xx'& error was received for an outgoing MAIL command.
24085
24086 .vitem &%rcpt_4xx%&
24087 A 4&'xx'& error was received for an outgoing RCPT command.
24088 .endlist
24089
24090 For the three 4&'xx'& errors, either the first or both of the x's can be given
24091 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24092 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24093 and have retries every ten minutes with a one-hour timeout, you could set up a
24094 retry rule of this form:
24095 .code
24096 the.domain.name  rcpt_452   F,1h,10m
24097 .endd
24098 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24099 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24100
24101 .vlist
24102 .vitem &%lost_connection%&
24103 A server unexpectedly closed the SMTP connection. There may, of course,
24104 legitimate reasons for this (host died, network died), but if it repeats a lot
24105 for the same host, it indicates something odd.
24106
24107 .vitem &%refused_MX%&
24108 A connection to a host obtained from an MX record was refused.
24109
24110 .vitem &%refused_A%&
24111 A connection to a host not obtained from an MX record was refused.
24112
24113 .vitem &%refused%&
24114 A connection was refused.
24115
24116 .vitem &%timeout_connect_MX%&
24117 A connection attempt to a host obtained from an MX record timed out.
24118
24119 .vitem &%timeout_connect_A%&
24120 A connection attempt to a host not obtained from an MX record timed out.
24121
24122 .vitem &%timeout_connect%&
24123 A connection attempt timed out.
24124
24125 .vitem &%timeout_MX%&
24126 There was a timeout while connecting or during an SMTP session with a host
24127 obtained from an MX record.
24128
24129 .vitem &%timeout_A%&
24130 There was a timeout while connecting or during an SMTP session with a host not
24131 obtained from an MX record.
24132
24133 .vitem &%timeout%&
24134 There was a timeout while connecting or during an SMTP session.
24135
24136 .vitem &%tls_required%&
24137 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24138 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24139 to STARTTLS, or there was a problem setting up the TLS connection.
24140
24141 .vitem &%quota%&
24142 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24143 transport.
24144
24145 .vitem &%quota_%&<&'time'&>
24146 .cindex "quota" "error testing in retry rule"
24147 .cindex "retry" "quota error testing"
24148 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24149 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24150 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24151 for four days.
24152 .endlist
24153
24154 .cindex "mailbox" "time of last read"
24155 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24156 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24157 it should be based on the last time that the user accessed the mailbox.
24158 However, it is not always possible to determine this. Exim uses the following
24159 heuristic rules:
24160
24161 .ilist
24162 If the mailbox is a single file, the time of last access (the &"atime"&) is
24163 used. As no new messages are being delivered (because the mailbox is over
24164 quota), Exim does not access the file, so this is the time of last user access.
24165 .next
24166 .cindex "maildir format" "time of last read"
24167 For a maildir delivery, the time of last modification of the &_new_&
24168 subdirectory is used. As the mailbox is over quota, no new files are created in
24169 the &_new_& subdirectory, because no new messages are being delivered. Any
24170 change to the &_new_& subdirectory is therefore assumed to be the result of an
24171 MUA moving a new message to the &_cur_& directory when it is first read. The
24172 time that is used is therefore the last time that the user read a new message.
24173 .next
24174 For other kinds of multi-file mailbox, the time of last access cannot be
24175 obtained, so a retry rule that uses this type of error field is never matched.
24176 .endlist
24177
24178 The quota errors apply both to system-enforced quotas and to Exim's own quota
24179 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24180 when a local delivery is deferred because a partition is full (the ENOSPC
24181 error).
24182
24183
24184
24185 .section "Retry rules for specified senders" "SECID162"
24186 .cindex "retry" "rules; sender-specific"
24187 You can specify retry rules that apply only when the failing message has a
24188 specific sender. In particular, this can be used to define retry rules that
24189 apply only to bounce messages. The third item in a retry rule can be of this
24190 form:
24191 .display
24192 &`senders=`&<&'address list'&>
24193 .endd
24194 The retry timings themselves are then the fourth item. For example:
24195 .code
24196 *   rcpt_4xx   senders=:   F,1h,30m
24197 .endd
24198 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24199 host. If the address list contains white space, it must be enclosed in quotes.
24200 For example:
24201 .code
24202 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24203 .endd
24204 &*Warning*&: This facility can be unhelpful if it is used for host errors
24205 (which do not depend on the recipient). The reason is that the sender is used
24206 only to match the retry rule. Once the rule has been found for a host error,
24207 its contents are used to set a retry time for the host, and this will apply to
24208 all messages, not just those with specific senders.
24209
24210 When testing retry rules using &%-brt%&, you can supply a sender using the
24211 &%-f%& command line option, like this:
24212 .code
24213 exim -f "" -brt user@dom.ain
24214 .endd
24215 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24216 list is never matched.
24217
24218
24219
24220
24221
24222 .section "Retry parameters" "SECID163"
24223 .cindex "retry" "parameters in rules"
24224 The third (or fourth, if a senders list is present) field in a retry rule is a
24225 sequence of retry parameter sets, separated by semicolons. Each set consists of
24226 .display
24227 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24228 .endd
24229 The letter identifies the algorithm for computing a new retry time; the cutoff
24230 time is the time beyond which this algorithm no longer applies, and the
24231 arguments vary the algorithm's action. The cutoff time is measured from the
24232 time that the first failure for the domain (combined with the local part if
24233 relevant) was detected, not from the time the message was received.
24234
24235 .cindex "retry" "algorithms"
24236 .cindex "retry" "fixed intervals"
24237 .cindex "retry" "increasing intervals"
24238 .cindex "retry" "random intervals"
24239 The available algorithms are:
24240
24241 .ilist
24242 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24243 the interval.
24244 .next
24245 &'G'&: retry at geometrically increasing intervals. The first argument
24246 specifies a starting value for the interval, and the second a multiplier, which
24247 is used to increase the size of the interval at each retry.
24248 .next
24249 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24250 retry, the previous interval is multiplied by the factor in order to get a
24251 maximum for the next interval. The minimum interval is the first argument of
24252 the parameter, and an actual interval is chosen randomly between them. Such a
24253 rule has been found to be helpful in cluster configurations when all the
24254 members of the cluster restart at once, and may therefore synchronize their
24255 queue processing times.
24256 .endlist
24257
24258 When computing the next retry time, the algorithm definitions are scanned in
24259 order until one whose cutoff time has not yet passed is reached. This is then
24260 used to compute a new retry time that is later than the current time. In the
24261 case of fixed interval retries, this simply means adding the interval to the
24262 current time. For geometrically increasing intervals, retry intervals are
24263 computed from the rule's parameters until one that is greater than the previous
24264 interval is found. The main configuration variable
24265 .cindex "limit" "retry interval"
24266 .cindex "retry" "interval, maximum"
24267 .oindex "&%retry_interval_max%&"
24268 &%retry_interval_max%& limits the maximum interval between retries. It
24269 cannot be set greater than &`24h`&, which is its default value.
24270
24271 A single remote domain may have a number of hosts associated with it, and each
24272 host may have more than one IP address. Retry algorithms are selected on the
24273 basis of the domain name, but are applied to each IP address independently. If,
24274 for example, a host has two IP addresses and one is unusable, Exim will
24275 generate retry times for it and will not try to use it until its next retry
24276 time comes. Thus the good IP address is likely to be tried first most of the
24277 time.
24278
24279 .cindex "hints database" "use for retrying"
24280 Retry times are hints rather than promises. Exim does not make any attempt to
24281 run deliveries exactly at the computed times. Instead, a queue runner process
24282 starts delivery processes for delayed messages periodically, and these attempt
24283 new deliveries only for those addresses that have passed their next retry time.
24284 If a new message arrives for a deferred address, an immediate delivery attempt
24285 occurs only if the address has passed its retry time. In the absence of new
24286 messages, the minimum time between retries is the interval between queue runner
24287 processes. There is not much point in setting retry times of five minutes if
24288 your queue runners happen only once an hour, unless there are a significant
24289 number of incoming messages (which might be the case on a system that is
24290 sending everything to a smart host, for example).
24291
24292 The data in the retry hints database can be inspected by using the
24293 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24294 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24295 &'exinext'& utility script can be used to find out what the next retry times
24296 are for the hosts associated with a particular mail domain, and also for local
24297 deliveries that have been deferred.
24298
24299
24300 .section "Retry rule examples" "SECID164"
24301 Here are some example retry rules:
24302 .code
24303 alice@wonderland.fict.example quota_5d  F,7d,3h
24304 wonderland.fict.example       quota_5d
24305 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24306 lookingglass.fict.example     *         F,24h,30m;
24307 *                 refused_A   F,2h,20m;
24308 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24309 .endd
24310 The first rule sets up special handling for mail to
24311 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24312 mailbox has not been read for at least 5 days. Retries continue every three
24313 hours for 7 days. The second rule handles over-quota errors for all other local
24314 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24315 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24316 fail are bounced immediately if the mailbox has not been read for at least 5
24317 days.
24318
24319 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24320 happen every 15 minutes for an hour, then with geometrically increasing
24321 intervals until two days have passed since a delivery first failed. After the
24322 first hour there is a delay of one hour, then two hours, then four hours, and
24323 so on (this is a rather extreme example).
24324
24325 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24326 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24327 all other domains, with special action for connection refusal from hosts that
24328 were not obtained from an MX record.
24329
24330 The final rule in a retry configuration should always have asterisks in the
24331 first two fields so as to provide a general catch-all for any addresses that do
24332 not have their own special handling. This example tries every 15 minutes for 2
24333 hours, then with intervals starting at one hour and increasing by a factor of
24334 1.5 up to 16 hours, then every 8 hours up to 5 days.
24335
24336
24337
24338 .section "Timeout of retry data" "SECID165"
24339 .cindex "timeout" "of retry data"
24340 .oindex "&%retry_data_expire%&"
24341 .cindex "hints database" "data expiry"
24342 .cindex "retry" "timeout of data"
24343 Exim timestamps the data that it writes to its retry hints database. When it
24344 consults the data during a delivery it ignores any that is older than the value
24345 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24346 been tried for 7 days, Exim will try to deliver to it immediately a message
24347 arrives, and if that fails, it will calculate a retry time as if it were
24348 failing for the first time.
24349
24350 This improves the behaviour for messages routed to rarely-used hosts such as MX
24351 backups. If such a host was down at one time, and happens to be down again when
24352 Exim tries a month later, using the old retry data would imply that it had been
24353 down all the time, which is not a justified assumption.
24354
24355 If a host really is permanently dead, this behaviour causes a burst of retries
24356 every now and again, but only if messages routed to it are rare. If there is a
24357 message at least once every 7 days the retry data never expires.
24358
24359
24360
24361
24362 .section "Long-term failures" "SECID166"
24363 .cindex "delivery failure, long-term"
24364 .cindex "retry" "after long-term failure"
24365 Special processing happens when an email address has been failing for so long
24366 that the cutoff time for the last algorithm is reached. For example, using the
24367 default retry rule:
24368 .code
24369 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24370 .endd
24371 the cutoff time is four days. Reaching the retry cutoff is independent of how
24372 long any specific message has been failing; it is the length of continuous
24373 failure for the recipient address that counts.
24374
24375 When the cutoff time is reached for a local delivery, or for all the IP
24376 addresses associated with a remote delivery, a subsequent delivery failure
24377 causes Exim to give up on the address, and a bounce message is generated.
24378 In order to cater for new messages that use the failing address, a next retry
24379 time is still computed from the final algorithm, and is used as follows:
24380
24381 For local deliveries, one delivery attempt is always made for any subsequent
24382 messages. If this delivery fails, the address fails immediately. The
24383 post-cutoff retry time is not used.
24384
24385 If the delivery is remote, there are two possibilities, controlled by the
24386 .oindex "&%delay_after_cutoff%&"
24387 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24388 default. Until the post-cutoff retry time for one of the IP addresses is
24389 reached, the failing email address is bounced immediately, without a delivery
24390 attempt taking place. After that time, one new delivery attempt is made to
24391 those IP addresses that are past their retry times, and if that still fails,
24392 the address is bounced and new retry times are computed.
24393
24394 In other words, when all the hosts for a given email address have been failing
24395 for a long time, Exim bounces rather then defers until one of the hosts' retry
24396 times is reached. Then it tries once, and bounces if that attempt fails. This
24397 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24398 to a broken destination, but if the host does recover, Exim will eventually
24399 notice.
24400
24401 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24402 addresses are past their final cutoff time, Exim tries to deliver to those IP
24403 addresses that have not been tried since the message arrived. If there are
24404 no suitable IP addresses, or if they all fail, the address is bounced. In other
24405 words, it does not delay when a new message arrives, but tries the expired
24406 addresses immediately, unless they have been tried since the message arrived.
24407 If there is a continuous stream of messages for the failing domains, setting
24408 &%delay_after_cutoff%& false means that there will be many more attempts to
24409 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24410 true.
24411
24412 .section "Deliveries that work intermittently" "SECID167"
24413 .cindex "retry" "intermittently working deliveries"
24414 Some additional logic is needed to cope with cases where a host is
24415 intermittently available, or when a message has some attribute that prevents
24416 its delivery when others to the same address get through. In this situation,
24417 because some messages are successfully delivered, the &"retry clock"& for the
24418 host or address keeps getting reset by the successful deliveries, and so
24419 failing messages remain on the queue for ever because the cutoff time is never
24420 reached.
24421
24422 Two exceptional actions are applied to prevent this happening. The first
24423 applies to errors that are related to a message rather than a remote host.
24424 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24425 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24426 commands, and quota failures. For this type of error, if a message's arrival
24427 time is earlier than the &"first failed"& time for the error, the earlier time
24428 is used when scanning the retry rules to decide when to try next and when to
24429 time out the address.
24430
24431 The exceptional second action applies in all cases. If a message has been on
24432 the queue for longer than the cutoff time of any applicable retry rule for a
24433 given address, a delivery is attempted for that address, even if it is not yet
24434 time, and if this delivery fails, the address is timed out. A new retry time is
24435 not computed in this case, so that other messages for the same address are
24436 considered immediately.
24437 .ecindex IIDretconf1
24438 .ecindex IIDregconf2
24439
24440
24441
24442
24443
24444
24445 . ////////////////////////////////////////////////////////////////////////////
24446 . ////////////////////////////////////////////////////////////////////////////
24447
24448 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24449 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24450 .scindex IIDauthconf2 "authentication"
24451 The &"authenticators"& section of Exim's run time configuration is concerned
24452 with SMTP authentication. This facility is an extension to the SMTP protocol,
24453 described in RFC 2554, which allows a client SMTP host to authenticate itself
24454 to a server. This is a common way for a server to recognize clients that are
24455 permitted to use it as a relay. SMTP authentication is not of relevance to the
24456 transfer of mail between servers that have no managerial connection with each
24457 other.
24458
24459 .cindex "AUTH" "description of"
24460 Very briefly, the way SMTP authentication works is as follows:
24461
24462 .ilist
24463 The server advertises a number of authentication &'mechanisms'& in response to
24464 the client's EHLO command.
24465 .next
24466 The client issues an AUTH command, naming a specific mechanism. The command
24467 may, optionally, contain some authentication data.
24468 .next
24469 The server may issue one or more &'challenges'&, to which the client must send
24470 appropriate responses. In simple authentication mechanisms, the challenges are
24471 just prompts for user names and passwords. The server does not have to issue
24472 any challenges &-- in some mechanisms the relevant data may all be transmitted
24473 with the AUTH command.
24474 .next
24475 The server either accepts or denies authentication.
24476 .next
24477 If authentication succeeds, the client may optionally make use of the AUTH
24478 option on the MAIL command to pass an authenticated sender in subsequent
24479 mail transactions. Authentication lasts for the remainder of the SMTP
24480 connection.
24481 .next
24482 If authentication fails, the client may give up, or it may try a different
24483 authentication mechanism, or it may try transferring mail over the
24484 unauthenticated connection.
24485 .endlist
24486
24487 If you are setting up a client, and want to know which authentication
24488 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24489 SMTP port) on the server, and issue an EHLO command. The response to this
24490 includes the list of supported mechanisms. For example:
24491 .display
24492 &`$ `&&*&`telnet server.example 25`&*&
24493 &`Trying 192.168.34.25...`&
24494 &`Connected to server.example.`&
24495 &`Escape character is &#x0027;^]&#x0027;.`&
24496 &`220 server.example ESMTP Exim 4.20 ...`&
24497 &*&`ehlo client.example`&*&
24498 &`250-server.example Hello client.example [10.8.4.5]`&
24499 &`250-SIZE 52428800`&
24500 &`250-PIPELINING`&
24501 &`250-AUTH PLAIN`&
24502 &`250 HELP`&
24503 .endd
24504 The second-last line of this example output shows that the server supports
24505 authentication using the PLAIN mechanism. In Exim, the different authentication
24506 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24507 routers and transports, which authenticators are included in the binary is
24508 controlled by build-time definitions. The following are currently available,
24509 included by setting
24510 .code
24511 AUTH_CRAM_MD5=yes
24512 AUTH_CYRUS_SASL=yes
24513 AUTH_DOVECOT=yes
24514 AUTH_GSASL=yes
24515 AUTH_HEIMDAL_GSSAPI=yes
24516 AUTH_PLAINTEXT=yes
24517 AUTH_SPA=yes
24518 .endd
24519 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24520 authentication mechanism (RFC 2195), and the second provides an interface to
24521 the Cyrus SASL authentication library.
24522 The third is an interface to Dovecot's authentication system, delegating the
24523 work via a socket interface.
24524 The fourth provides an interface to the GNU SASL authentication library, which
24525 provides mechanisms but typically not data sources.
24526 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24527 supporting setting a server keytab.
24528 The sixth can be configured to support
24529 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24530 not formally documented, but used by several MUAs. The seventh authenticator
24531 supports Microsoft's &'Secure Password Authentication'& mechanism.
24532
24533 The authenticators are configured using the same syntax as other drivers (see
24534 section &<<SECTfordricon>>&). If no authenticators are required, no
24535 authentication section need be present in the configuration file. Each
24536 authenticator can in principle have both server and client functions. When Exim
24537 is receiving SMTP mail, it is acting as a server; when it is sending out
24538 messages over SMTP, it is acting as a client. Authenticator configuration
24539 options are provided for use in both these circumstances.
24540
24541 To make it clear which options apply to which situation, the prefixes
24542 &%server_%& and &%client_%& are used on option names that are specific to
24543 either the server or the client function, respectively. Server and client
24544 functions are disabled if none of their options are set. If an authenticator is
24545 to be used for both server and client functions, a single definition, using
24546 both sets of options, is required. For example:
24547 .code
24548 cram:
24549   driver = cram_md5
24550   public_name = CRAM-MD5
24551   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24552   client_name = ph10
24553   client_secret = secret2
24554 .endd
24555 The &%server_%& option is used when Exim is acting as a server, and the
24556 &%client_%& options when it is acting as a client.
24557
24558 Descriptions of the individual authenticators are given in subsequent chapters.
24559 The remainder of this chapter covers the generic options for the
24560 authenticators, followed by general discussion of the way authentication works
24561 in Exim.
24562
24563 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24564 per-mechanism basis.  Please read carefully to determine which variables hold
24565 account labels such as usercodes and which hold passwords or other
24566 authenticating data.
24567
24568 Note that some mechanisms support two different identifiers for accounts: the
24569 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24570 and &'authz'& are commonly encountered.  The American spelling is standard here.
24571 Conceptually, authentication data such as passwords are tied to the identifier
24572 used to authenticate; servers may have rules to permit one user to act as a
24573 second user, so that after login the session is treated as though that second
24574 user had logged in.  That second user is the &'authorization id'&.  A robust
24575 configuration might confirm that the &'authz'& field is empty or matches the
24576 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24577 as verified data, the &'authz'& as an unverified request which the server might
24578 choose to honour.
24579
24580 A &'realm'& is a text string, typically a domain name, presented by a server
24581 to a client to help it select an account and credentials to use.  In some
24582 mechanisms, the client and server provably agree on the realm, but clients
24583 typically can not treat the realm as secure data to be blindly trusted.
24584
24585
24586
24587 .section "Generic options for authenticators" "SECID168"
24588 .cindex "authentication" "generic options"
24589 .cindex "options" "generic; for authenticators"
24590
24591 .option client_condition authenticators string&!! unset
24592 When Exim is authenticating as a client, it skips any authenticator whose
24593 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24594 used, for example, to skip plain text authenticators when the connection is not
24595 encrypted by a setting such as:
24596 .code
24597 client_condition = ${if !eq{$tls_out_cipher}{}}
24598 .endd
24599
24600
24601 .option client_set_id authenticators string&!! unset
24602 When client authentication succeeds, this condition is expanded; the
24603 result is used in the log lines for outbound messasges.
24604 Typically it will be the user name used for authentication.
24605
24606
24607 .option driver authenticators string unset
24608 This option must always be set. It specifies which of the available
24609 authenticators is to be used.
24610
24611
24612 .option public_name authenticators string unset
24613 This option specifies the name of the authentication mechanism that the driver
24614 implements, and by which it is known to the outside world. These names should
24615 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24616 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24617 defaults to the driver's instance name.
24618
24619
24620 .option server_advertise_condition authenticators string&!! unset
24621 When a server is about to advertise an authentication mechanism, the condition
24622 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24623 mechanism is not advertised.
24624 If the expansion fails, the mechanism is not advertised. If the failure was not
24625 forced, and was not caused by a lookup defer, the incident is logged.
24626 See section &<<SECTauthexiser>>& below for further discussion.
24627
24628
24629 .option server_condition authenticators string&!! unset
24630 This option must be set for a &%plaintext%& server authenticator, where it
24631 is used directly to control authentication. See section &<<SECTplainserver>>&
24632 for details.
24633
24634 For the &(gsasl)& authenticator, this option is required for various
24635 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24636
24637 For the other authenticators, &%server_condition%& can be used as an additional
24638 authentication or authorization mechanism that is applied after the other
24639 authenticator conditions succeed. If it is set, it is expanded when the
24640 authenticator would otherwise return a success code. If the expansion is forced
24641 to fail, authentication fails. Any other expansion failure causes a temporary
24642 error code to be returned. If the result of a successful expansion is an empty
24643 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24644 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24645 other result, a temporary error code is returned, with the expanded string as
24646 the error text.
24647
24648
24649 .option server_debug_print authenticators string&!! unset
24650 If this option is set and authentication debugging is enabled (see the &%-d%&
24651 command line option), the string is expanded and included in the debugging
24652 output when the authenticator is run as a server. This can help with checking
24653 out the values of variables.
24654 If expansion of the string fails, the error message is written to the debugging
24655 output, and Exim carries on processing.
24656
24657
24658 .option server_set_id authenticators string&!! unset
24659 .vindex "&$authenticated_id$&"
24660 When an Exim server successfully authenticates a client, this string is
24661 expanded using data from the authentication, and preserved for any incoming
24662 messages in the variable &$authenticated_id$&. It is also included in the log
24663 lines for incoming messages. For example, a user/password authenticator
24664 configuration might preserve the user name that was used to authenticate, and
24665 refer to it subsequently during delivery of the message.
24666 If expansion fails, the option is ignored.
24667
24668
24669 .option server_mail_auth_condition authenticators string&!! unset
24670 This option allows a server to discard authenticated sender addresses supplied
24671 as part of MAIL commands in SMTP connections that are authenticated by the
24672 driver on which &%server_mail_auth_condition%& is set. The option is not used
24673 as part of the authentication process; instead its (unexpanded) value is
24674 remembered for later use.
24675 How it is used is described in the following section.
24676
24677
24678
24679
24680
24681 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24682 .cindex "authentication" "sender; authenticated"
24683 .cindex "AUTH" "on MAIL command"
24684 When a client supplied an AUTH= item on a MAIL command, Exim applies
24685 the following checks before accepting it as the authenticated sender of the
24686 message:
24687
24688 .ilist
24689 If the connection is not using extended SMTP (that is, HELO was used rather
24690 than EHLO), the use of AUTH= is a syntax error.
24691 .next
24692 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24693 .next
24694 .vindex "&$authenticated_sender$&"
24695 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24696 running, the value of &$authenticated_sender$& is set to the value obtained
24697 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24698 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24699 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24700 given for the MAIL command.
24701 .next
24702 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24703 is accepted and placed in &$authenticated_sender$& only if the client has
24704 authenticated.
24705 .next
24706 If the AUTH= value was accepted by either of the two previous rules, and
24707 the client has authenticated, and the authenticator has a setting for the
24708 &%server_mail_auth_condition%&, the condition is checked at this point. The
24709 valued that was saved from the authenticator is expanded. If the expansion
24710 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24711 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24712 the value of &$authenticated_sender$& is retained and passed on with the
24713 message.
24714 .endlist
24715
24716
24717 When &$authenticated_sender$& is set for a message, it is passed on to other
24718 hosts to which Exim authenticates as a client. Do not confuse this value with
24719 &$authenticated_id$&, which is a string obtained from the authentication
24720 process, and which is not usually a complete email address.
24721
24722 .vindex "&$sender_address$&"
24723 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24724 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24725 therefore make use of &$authenticated_sender$&. The converse is not true: the
24726 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24727 ACL is run.
24728
24729
24730
24731 .section "Authentication on an Exim server" "SECTauthexiser"
24732 .cindex "authentication" "on an Exim server"
24733 When Exim receives an EHLO command, it advertises the public names of those
24734 authenticators that are configured as servers, subject to the following
24735 conditions:
24736
24737 .ilist
24738 The client host must match &%auth_advertise_hosts%& (default *).
24739 .next
24740 It the &%server_advertise_condition%& option is set, its expansion must not
24741 yield the empty string, &"0"&, &"no"&, or &"false"&.
24742 .endlist
24743
24744 The order in which the authenticators are defined controls the order in which
24745 the mechanisms are advertised.
24746
24747 Some mail clients (for example, some versions of Netscape) require the user to
24748 provide a name and password for authentication whenever AUTH is advertised,
24749 even though authentication may not in fact be needed (for example, Exim may be
24750 set up to allow unconditional relaying from the client by an IP address check).
24751 You can make such clients more friendly by not advertising AUTH to them.
24752 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24753 that runs for RCPT) to relay without authentication, you should set
24754 .code
24755 auth_advertise_hosts = ! 10.9.8.0/24
24756 .endd
24757 so that no authentication mechanisms are advertised to them.
24758
24759 The &%server_advertise_condition%& controls the advertisement of individual
24760 authentication mechanisms. For example, it can be used to restrict the
24761 advertisement of a particular mechanism to encrypted connections, by a setting
24762 such as:
24763 .code
24764 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24765 .endd
24766 .vindex "&$tls_in_cipher$&"
24767 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24768 yields &"yes"&, which allows the advertisement to happen.
24769
24770 When an Exim server receives an AUTH command from a client, it rejects it
24771 immediately if AUTH was not advertised in response to an earlier EHLO
24772 command. This is the case if
24773
24774 .ilist
24775 The client host does not match &%auth_advertise_hosts%&; or
24776 .next
24777 No authenticators are configured with server options; or
24778 .next
24779 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24780 server authenticators.
24781 .endlist
24782
24783
24784 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24785 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24786 AUTH is accepted from any client host.
24787
24788 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24789 server authentication mechanism that was advertised in response to EHLO and
24790 that matches the one named in the AUTH command. If it finds one, it runs
24791 the appropriate authentication protocol, and authentication either succeeds or
24792 fails. If there is no matching advertised mechanism, the AUTH command is
24793 rejected with a 504 error.
24794
24795 .vindex "&$received_protocol$&"
24796 .vindex "&$sender_host_authenticated$&"
24797 When a message is received from an authenticated host, the value of
24798 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24799 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24800 public name) of the authenticator driver that successfully authenticated the
24801 client from which the message was received. This variable is empty if there was
24802 no successful authentication.
24803
24804
24805
24806
24807 .section "Testing server authentication" "SECID169"
24808 .cindex "authentication" "testing a server"
24809 .cindex "AUTH" "testing a server"
24810 .cindex "base64 encoding" "creating authentication test data"
24811 Exim's &%-bh%& option can be useful for testing server authentication
24812 configurations. The data for the AUTH command has to be sent using base64
24813 encoding. A quick way to produce such data for testing is the following Perl
24814 script:
24815 .code
24816 use MIME::Base64;
24817 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24818 .endd
24819 .cindex "binary zero" "in authentication data"
24820 This interprets its argument as a Perl string, and then encodes it. The
24821 interpretation as a Perl string allows binary zeros, which are required for
24822 some kinds of authentication, to be included in the data. For example, a
24823 command line to run this script on such data might be
24824 .code
24825 encode '\0user\0password'
24826 .endd
24827 Note the use of single quotes to prevent the shell interpreting the
24828 backslashes, so that they can be interpreted by Perl to specify characters
24829 whose code value is zero.
24830
24831 &*Warning 1*&: If either of the user or password strings starts with an octal
24832 digit, you must use three zeros instead of one after the leading backslash. If
24833 you do not, the octal digit that starts your string will be incorrectly
24834 interpreted as part of the code for the first character.
24835
24836 &*Warning 2*&: If there are characters in the strings that Perl interprets
24837 specially, you must use a Perl escape to prevent them being misinterpreted. For
24838 example, a command such as
24839 .code
24840 encode '\0user@domain.com\0pas$$word'
24841 .endd
24842 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24843
24844 If you have the &%mimencode%& command installed, another way to do produce
24845 base64-encoded strings is to run the command
24846 .code
24847 echo -e -n `\0user\0password' | mimencode
24848 .endd
24849 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24850 in the argument, and the &%-n%& option specifies no newline at the end of its
24851 output. However, not all versions of &%echo%& recognize these options, so you
24852 should check your version before relying on this suggestion.
24853
24854
24855
24856 .section "Authentication by an Exim client" "SECID170"
24857 .cindex "authentication" "on an Exim client"
24858 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24859 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24860 announces support for authentication, and the host matches an entry in either
24861 of these options, Exim (as a client) tries to authenticate as follows:
24862
24863 .ilist
24864 For each authenticator that is configured as a client, in the order in which
24865 they are defined in the configuration, it searches the authentication
24866 mechanisms announced by the server for one whose name matches the public name
24867 of the authenticator.
24868 .next
24869 .vindex "&$host$&"
24870 .vindex "&$host_address$&"
24871 When it finds one that matches, it runs the authenticator's client code. The
24872 variables &$host$& and &$host_address$& are available for any string expansions
24873 that the client might do. They are set to the server's name and IP address. If
24874 any expansion is forced to fail, the authentication attempt is abandoned, and
24875 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24876 delivery to be deferred.
24877 .next
24878 If the result of the authentication attempt is a temporary error or a timeout,
24879 Exim abandons trying to send the message to the host for the moment. It will
24880 try again later. If there are any backup hosts available, they are tried in the
24881 usual way.
24882 .next
24883 If the response to authentication is a permanent error (5&'xx'& code), Exim
24884 carries on searching the list of authenticators and tries another one if
24885 possible. If all authentication attempts give permanent errors, or if there are
24886 no attempts because no mechanisms match (or option expansions force failure),
24887 what happens depends on whether the host matches &%hosts_require_auth%& or
24888 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24889 delivery is deferred. The error can be detected in the retry rules, and thereby
24890 turned into a permanent error if you wish. In the second case, Exim tries to
24891 deliver the message unauthenticated.
24892 .endlist
24893
24894 .cindex "AUTH" "on MAIL command"
24895 When Exim has authenticated itself to a remote server, it adds the AUTH
24896 parameter to the MAIL commands it sends, if it has an authenticated sender for
24897 the message. If the message came from a remote host, the authenticated sender
24898 is the one that was receiving on an incoming MAIL command, provided that the
24899 incoming connection was authenticated and the &%server_mail_auth%& condition
24900 allowed the authenticated sender to be retained. If a local process calls Exim
24901 to send a message, the sender address that is built from the login name and
24902 &%qualify_domain%& is treated as authenticated. However, if the
24903 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24904 the authenticated sender that was received with the message.
24905 .ecindex IIDauthconf1
24906 .ecindex IIDauthconf2
24907
24908
24909
24910
24911
24912
24913 . ////////////////////////////////////////////////////////////////////////////
24914 . ////////////////////////////////////////////////////////////////////////////
24915
24916 .chapter "The plaintext authenticator" "CHAPplaintext"
24917 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24918 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24919 The &(plaintext)& authenticator can be configured to support the PLAIN and
24920 LOGIN authentication mechanisms, both of which transfer authentication data as
24921 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24922 security risk; you are strongly advised to insist on the use of SMTP encryption
24923 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24924 use unencrypted plain text, you should not use the same passwords for SMTP
24925 connections as you do for login accounts.
24926
24927 .section "Plaintext options" "SECID171"
24928 .cindex "options" "&(plaintext)& authenticator (server)"
24929 When configured as a server, &(plaintext)& uses the following options:
24930
24931 .option server_condition authenticators string&!! unset
24932 This is actually a global authentication option, but it must be set in order to
24933 configure the &(plaintext)& driver as a server. Its use is described below.
24934
24935 .option server_prompts plaintext string&!! unset
24936 The contents of this option, after expansion, must be a colon-separated list of
24937 prompt strings. If expansion fails, a temporary authentication rejection is
24938 given.
24939
24940 .section "Using plaintext in a server" "SECTplainserver"
24941 .cindex "AUTH" "in &(plaintext)& authenticator"
24942 .cindex "binary zero" "in &(plaintext)& authenticator"
24943 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24944         "in &(plaintext)& authenticator"
24945 .vindex "&$auth1$&, &$auth2$&, etc"
24946 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24947
24948 When running as a server, &(plaintext)& performs the authentication test by
24949 expanding a string. The data sent by the client with the AUTH command, or in
24950 response to subsequent prompts, is base64 encoded, and so may contain any byte
24951 values when decoded. If any data is supplied with the command, it is treated as
24952 a list of strings, separated by NULs (binary zeros), the first three of which
24953 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24954 (neither LOGIN nor PLAIN uses more than three strings).
24955
24956 For compatibility with previous releases of Exim, the values are also placed in
24957 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24958 variables for this purpose is now deprecated, as it can lead to confusion in
24959 string expansions that also use them for other things.
24960
24961 If there are more strings in &%server_prompts%& than the number of strings
24962 supplied with the AUTH command, the remaining prompts are used to obtain more
24963 data. Each response from the client may be a list of NUL-separated strings.
24964
24965 .vindex "&$authenticated_id$&"
24966 Once a sufficient number of data strings have been received,
24967 &%server_condition%& is expanded. If the expansion is forced to fail,
24968 authentication fails. Any other expansion failure causes a temporary error code
24969 to be returned. If the result of a successful expansion is an empty string,
24970 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24971 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24972 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24973 For any other result, a temporary error code is returned, with the expanded
24974 string as the error text
24975
24976 &*Warning*&: If you use a lookup in the expansion to find the user's
24977 password, be sure to make the authentication fail if the user is unknown.
24978 There are good and bad examples at the end of the next section.
24979
24980
24981
24982 .section "The PLAIN authentication mechanism" "SECID172"
24983 .cindex "PLAIN authentication mechanism"
24984 .cindex "authentication" "PLAIN mechanism"
24985 .cindex "binary zero" "in &(plaintext)& authenticator"
24986 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24987 sent as one item of data (that is, one combined string containing two NUL
24988 separators). The data is sent either as part of the AUTH command, or
24989 subsequently in response to an empty prompt from the server.
24990
24991 The second and third strings are a user name and a corresponding password.
24992 Using a single fixed user name and password as an example, this could be
24993 configured as follows:
24994 .code
24995 fixed_plain:
24996   driver = plaintext
24997   public_name = PLAIN
24998   server_prompts = :
24999   server_condition = \
25000     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25001   server_set_id = $auth2
25002 .endd
25003 Note that the default result strings from &%if%& (&"true"& or an empty string)
25004 are exactly what we want here, so they need not be specified. Obviously, if the
25005 password contains expansion-significant characters such as dollar, backslash,
25006 or closing brace, they have to be escaped.
25007
25008 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25009 the end of a string list are ignored). If all the data comes as part of the
25010 AUTH command, as is commonly the case, the prompt is not used. This
25011 authenticator is advertised in the response to EHLO as
25012 .code
25013 250-AUTH PLAIN
25014 .endd
25015 and a client host can authenticate itself by sending the command
25016 .code
25017 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25018 .endd
25019 As this contains three strings (more than the number of prompts), no further
25020 data is required from the client. Alternatively, the client may just send
25021 .code
25022 AUTH PLAIN
25023 .endd
25024 to initiate authentication, in which case the server replies with an empty
25025 prompt. The client must respond with the combined data string.
25026
25027 The data string is base64 encoded, as required by the RFC. This example,
25028 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25029 represents a zero byte. This is split up into three strings, the first of which
25030 is empty. The &%server_condition%& option in the authenticator checks that the
25031 second two are &`username`& and &`mysecret`& respectively.
25032
25033 Having just one fixed user name and password, as in this example, is not very
25034 realistic, though for a small organization with only a handful of
25035 authenticating clients it could make sense.
25036
25037 A more sophisticated instance of this authenticator could use the user name in
25038 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25039 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25040 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25041 This is an incorrect example:
25042 .code
25043 server_condition = \
25044   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25045 .endd
25046 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25047 which it then compares to the supplied password (&$auth3$&). Why is this example
25048 incorrect? It works fine for existing users, but consider what happens if a
25049 non-existent user name is given. The lookup fails, but as no success/failure
25050 strings are given for the lookup, it yields an empty string. Thus, to defeat
25051 the authentication, all a client has to do is to supply a non-existent user
25052 name and an empty password. The correct way of writing this test is:
25053 .code
25054 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25055   {${if eq{$value}{$auth3}}} {false}}
25056 .endd
25057 In this case, if the lookup succeeds, the result is checked; if the lookup
25058 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25059 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25060 always fails if its second argument is empty. However, the second way of
25061 writing the test makes the logic clearer.
25062
25063
25064 .section "The LOGIN authentication mechanism" "SECID173"
25065 .cindex "LOGIN authentication mechanism"
25066 .cindex "authentication" "LOGIN mechanism"
25067 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25068 in a number of programs. No data is sent with the AUTH command. Instead, a
25069 user name and password are supplied separately, in response to prompts. The
25070 plaintext authenticator can be configured to support this as in this example:
25071 .code
25072 fixed_login:
25073   driver = plaintext
25074   public_name = LOGIN
25075   server_prompts = User Name : Password
25076   server_condition = \
25077     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25078   server_set_id = $auth1
25079 .endd
25080 Because of the way plaintext operates, this authenticator accepts data supplied
25081 with the AUTH command (in contravention of the specification of LOGIN), but
25082 if the client does not supply it (as is the case for LOGIN clients), the prompt
25083 strings are used to obtain two data items.
25084
25085 Some clients are very particular about the precise text of the prompts. For
25086 example, Outlook Express is reported to recognize only &"Username:"& and
25087 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25088 strings. It uses the &%ldapauth%& expansion condition to check the user
25089 name and password by binding to an LDAP server:
25090 .code
25091 login:
25092   driver = plaintext
25093   public_name = LOGIN
25094   server_prompts = Username:: : Password::
25095   server_condition = ${if and{{ \
25096     !eq{}{$auth1} }{ \
25097     ldapauth{\
25098       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25099       pass=${quote:$auth2} \
25100       ldap://ldap.example.org/} }} }
25101   server_set_id = uid=$auth1,ou=people,o=example.org
25102 .endd
25103 We have to check that the username is not empty before using it, because LDAP
25104 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25105 operator to correctly quote the DN for authentication. However, the basic
25106 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25107 correct one to use for the password, because quoting is needed only to make
25108 the password conform to the Exim syntax. At the LDAP level, the password is an
25109 uninterpreted string.
25110
25111
25112 .section "Support for different kinds of authentication" "SECID174"
25113 A number of string expansion features are provided for the purpose of
25114 interfacing to different ways of user authentication. These include checking
25115 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25116 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25117 &<<SECTexpcond>>&.
25118
25119
25120
25121
25122 .section "Using plaintext in a client" "SECID175"
25123 .cindex "options" "&(plaintext)& authenticator (client)"
25124 The &(plaintext)& authenticator has two client options:
25125
25126 .option client_ignore_invalid_base64 plaintext boolean false
25127 If the client receives a server prompt that is not a valid base64 string,
25128 authentication is abandoned by default. However, if this option is set true,
25129 the error in the challenge is ignored and the client sends the response as
25130 usual.
25131
25132 .option client_send plaintext string&!! unset
25133 The string is a colon-separated list of authentication data strings. Each
25134 string is independently expanded before being sent to the server. The first
25135 string is sent with the AUTH command; any more strings are sent in response
25136 to prompts from the server. Before each string is expanded, the value of the
25137 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25138 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25139 way. Thus, the prompt that is received in response to sending the first string
25140 (with the AUTH command) can be used in the expansion of the second string, and
25141 so on. If an invalid base64 string is received when
25142 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25143 &$auth$&<&'n'&> variable.
25144
25145 &*Note*&: You cannot use expansion to create multiple strings, because
25146 splitting takes priority and happens first.
25147
25148 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25149 the data, further processing is applied to each string before it is sent. If
25150 there are any single circumflex characters in the string, they are converted to
25151 NULs. Should an actual circumflex be required as data, it must be doubled in
25152 the string.
25153
25154 This is an example of a client configuration that implements the PLAIN
25155 authentication mechanism with a fixed user name and password:
25156 .code
25157 fixed_plain:
25158   driver = plaintext
25159   public_name = PLAIN
25160   client_send = ^username^mysecret
25161 .endd
25162 The lack of colons means that the entire text is sent with the AUTH
25163 command, with the circumflex characters converted to NULs. A similar example
25164 that uses the LOGIN mechanism is:
25165 .code
25166 fixed_login:
25167   driver = plaintext
25168   public_name = LOGIN
25169   client_send = : username : mysecret
25170 .endd
25171 The initial colon means that the first string is empty, so no data is sent with
25172 the AUTH command itself. The remaining strings are sent in response to
25173 prompts.
25174 .ecindex IIDplaiauth1
25175 .ecindex IIDplaiauth2
25176
25177
25178
25179
25180 . ////////////////////////////////////////////////////////////////////////////
25181 . ////////////////////////////////////////////////////////////////////////////
25182
25183 .chapter "The cram_md5 authenticator" "CHID9"
25184 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25185 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25186 .cindex "CRAM-MD5 authentication mechanism"
25187 .cindex "authentication" "CRAM-MD5 mechanism"
25188 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25189 sends a challenge string to the client, and the response consists of a user
25190 name and the CRAM-MD5 digest of the challenge string combined with a secret
25191 string (password) which is known to both server and client. Thus, the secret
25192 is not sent over the network as plain text, which makes this authenticator more
25193 secure than &(plaintext)&. However, the downside is that the secret has to be
25194 available in plain text at either end.
25195
25196
25197 .section "Using cram_md5 as a server" "SECID176"
25198 .cindex "options" "&(cram_md5)& authenticator (server)"
25199 This authenticator has one server option, which must be set to configure the
25200 authenticator as a server:
25201
25202 .option server_secret cram_md5 string&!! unset
25203 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25204 When the server receives the client's response, the user name is placed in
25205 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25206 obtain the password for that user. The server then computes the CRAM-MD5 digest
25207 that the client should have sent, and checks that it received the correct
25208 string. If the expansion of &%server_secret%& is forced to fail, authentication
25209 fails. If the expansion fails for some other reason, a temporary error code is
25210 returned to the client.
25211
25212 For compatibility with previous releases of Exim, the user name is also placed
25213 in &$1$&. However, the use of this variables for this purpose is now
25214 deprecated, as it can lead to confusion in string expansions that also use
25215 numeric variables for other things.
25216
25217 For example, the following authenticator checks that the user name given by the
25218 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25219 user name, authentication fails.
25220 .code
25221 fixed_cram:
25222   driver = cram_md5
25223   public_name = CRAM-MD5
25224   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25225   server_set_id = $auth1
25226 .endd
25227 .vindex "&$authenticated_id$&"
25228 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25229 name in &$authenticated_id$&. A more typical configuration might look up the
25230 secret string in a file, using the user name as the key. For example:
25231 .code
25232 lookup_cram:
25233   driver = cram_md5
25234   public_name = CRAM-MD5
25235   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25236                   {$value}fail}
25237   server_set_id = $auth1
25238 .endd
25239 Note that this expansion explicitly forces failure if the lookup fails
25240 because &$auth1$& contains an unknown user name.
25241
25242 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25243 using the relevant libraries, you need to know the realm to specify in the
25244 lookup and then ask for the &"userPassword"& attribute for that user in that
25245 realm, with:
25246 .code
25247 cyrusless_crammd5:
25248   driver = cram_md5
25249   public_name = CRAM-MD5
25250   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25251                   dbmjz{/etc/sasldb2}}
25252   server_set_id = $auth1
25253 .endd
25254
25255 .section "Using cram_md5 as a client" "SECID177"
25256 .cindex "options" "&(cram_md5)& authenticator (client)"
25257 When used as a client, the &(cram_md5)& authenticator has two options:
25258
25259
25260
25261 .option client_name cram_md5 string&!! "the primary host name"
25262 This string is expanded, and the result used as the user name data when
25263 computing the response to the server's challenge.
25264
25265
25266 .option client_secret cram_md5 string&!! unset
25267 This option must be set for the authenticator to work as a client. Its value is
25268 expanded and the result used as the secret string when computing the response.
25269
25270
25271 .vindex "&$host$&"
25272 .vindex "&$host_address$&"
25273 Different user names and secrets can be used for different servers by referring
25274 to &$host$& or &$host_address$& in the options. Forced failure of either
25275 expansion string is treated as an indication that this authenticator is not
25276 prepared to handle this case. Exim moves on to the next configured client
25277 authenticator. Any other expansion failure causes Exim to give up trying to
25278 send the message to the current server.
25279
25280 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25281 strings, is:
25282 .code
25283 fixed_cram:
25284   driver = cram_md5
25285   public_name = CRAM-MD5
25286   client_name = ph10
25287   client_secret = secret
25288 .endd
25289 .ecindex IIDcramauth1
25290 .ecindex IIDcramauth2
25291
25292
25293
25294 . ////////////////////////////////////////////////////////////////////////////
25295 . ////////////////////////////////////////////////////////////////////////////
25296
25297 .chapter "The cyrus_sasl authenticator" "CHID10"
25298 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25299 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25300 .cindex "Cyrus" "SASL library"
25301 .cindex "Kerberos"
25302 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25303 Digital Ltd (&url(http://www.aldigital.co.uk)).
25304
25305 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25306 library implementation of the RFC 2222 (&"Simple Authentication and Security
25307 Layer"&). This library supports a number of authentication mechanisms,
25308 including PLAIN and LOGIN, but also several others that Exim does not support
25309 directly. In particular, there is support for Kerberos authentication.
25310
25311 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25312 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25313 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25314 name of the driver to determine which mechanism to support.
25315
25316 Where access to some kind of secret file is required, for example in GSSAPI
25317 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25318 user, and that the Cyrus SASL library has no way of escalating privileges
25319 by default. You may also find you need to set environment variables,
25320 depending on the driver you are using.
25321
25322 The application name provided by Exim is &"exim"&, so various SASL options may
25323 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25324 Kerberos, note that because of limitations in the GSSAPI interface,
25325 changing the server keytab might need to be communicated down to the Kerberos
25326 layer independently. The mechanism for doing so is dependent upon the Kerberos
25327 implementation.
25328
25329 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25330 may be set to point to an alternative keytab file. Exim will pass this
25331 variable through from its own inherited environment when started as root or the
25332 Exim user. The keytab file needs to be readable by the Exim user.
25333 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25334 environment variable.  In practice, for those releases, the Cyrus authenticator
25335 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25336 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25337
25338
25339 .section "Using cyrus_sasl as a server" "SECID178"
25340 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25341 (on a successful authentication) into &$auth1$&. For compatibility with
25342 previous releases of Exim, the username is also placed in &$1$&. However, the
25343 use of this variable for this purpose is now deprecated, as it can lead to
25344 confusion in string expansions that also use numeric variables for other
25345 things.
25346
25347
25348 .option server_hostname cyrus_sasl string&!! "see below"
25349 This option selects the hostname that is used when communicating with the
25350 library. The default value is &`$primary_hostname`&. It is up to the underlying
25351 SASL plug-in what it does with this data.
25352
25353
25354 .option server_mech cyrus_sasl string "see below"
25355 This option selects the authentication mechanism this driver should use. The
25356 default is the value of the generic &%public_name%& option. This option allows
25357 you to use a different underlying mechanism from the advertised name. For
25358 example:
25359 .code
25360 sasl:
25361   driver = cyrus_sasl
25362   public_name = X-ANYTHING
25363   server_mech = CRAM-MD5
25364   server_set_id = $auth1
25365 .endd
25366
25367 .option server_realm cyrus_sasl string&!! unset
25368 This specifies the SASL realm that the server claims to be in.
25369
25370
25371 .option server_service cyrus_sasl string &`smtp`&
25372 This is the SASL service that the server claims to implement.
25373
25374
25375 For straightforward cases, you do not need to set any of the authenticator's
25376 private options. All you need to do is to specify an appropriate mechanism as
25377 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25378 PLAIN, you could have two authenticators as follows:
25379 .code
25380 sasl_cram_md5:
25381   driver = cyrus_sasl
25382   public_name = CRAM-MD5
25383   server_set_id = $auth1
25384
25385 sasl_plain:
25386   driver = cyrus_sasl
25387   public_name = PLAIN
25388   server_set_id = $auth2
25389 .endd
25390 Cyrus SASL does implement the LOGIN authentication method, even though it is
25391 not a standard method. It is disabled by default in the source distribution,
25392 but it is present in many binary distributions.
25393 .ecindex IIDcyrauth1
25394 .ecindex IIDcyrauth2
25395
25396
25397
25398
25399 . ////////////////////////////////////////////////////////////////////////////
25400 . ////////////////////////////////////////////////////////////////////////////
25401 .chapter "The dovecot authenticator" "CHAPdovecot"
25402 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25403 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25404 This authenticator is an interface to the authentication facility of the
25405 Dovecot POP/IMAP server, which can support a number of authentication methods.
25406 Note that Dovecot must be configured to use auth-client not auth-userdb.
25407 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25408 to use the same mechanisms for SMTP authentication. This is a server
25409 authenticator only. There is only one option:
25410
25411 .option server_socket dovecot string unset
25412
25413 This option must specify the socket that is the interface to Dovecot
25414 authentication. The &%public_name%& option must specify an authentication
25415 mechanism that Dovecot is configured to support. You can have several
25416 authenticators for different mechanisms. For example:
25417 .code
25418 dovecot_plain:
25419   driver = dovecot
25420   public_name = PLAIN
25421   server_socket = /var/run/dovecot/auth-client
25422   server_set_id = $auth1
25423
25424 dovecot_ntlm:
25425   driver = dovecot
25426   public_name = NTLM
25427   server_socket = /var/run/dovecot/auth-client
25428   server_set_id = $auth1
25429 .endd
25430 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25431 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25432 option is passed in the Dovecot authentication command. If, for a TLS
25433 connection, a client certificate has been verified, the &"valid-client-cert"&
25434 option is passed. When authentication succeeds, the identity of the user
25435 who authenticated is placed in &$auth1$&.
25436 .ecindex IIDdcotauth1
25437 .ecindex IIDdcotauth2
25438
25439
25440 . ////////////////////////////////////////////////////////////////////////////
25441 . ////////////////////////////////////////////////////////////////////////////
25442 .chapter "The gsasl authenticator" "CHAPgsasl"
25443 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25444 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25445 .cindex "authentication" "GNU SASL"
25446 .cindex "authentication" "SASL"
25447 .cindex "authentication" "EXTERNAL"
25448 .cindex "authentication" "ANONYMOUS"
25449 .cindex "authentication" "PLAIN"
25450 .cindex "authentication" "LOGIN"
25451 .cindex "authentication" "DIGEST-MD5"
25452 .cindex "authentication" "CRAM-MD5"
25453 .cindex "authentication" "SCRAM-SHA-1"
25454 The &(gsasl)& authenticator provides server integration for the GNU SASL
25455 library and the mechanisms it provides.  This is new as of the 4.80 release
25456 and there are a few areas where the library does not let Exim smoothly
25457 scale to handle future authentication mechanisms, so no guarantee can be
25458 made that any particular new authentication mechanism will be supported
25459 without code changes in Exim.
25460
25461
25462 .option server_channelbinding gsasl boolean false
25463 Some authentication mechanisms are able to use external context at both ends
25464 of the session to bind the authentication to that context, and fail the
25465 authentication process if that context differs.  Specifically, some TLS
25466 ciphersuites can provide identifying information about the cryptographic
25467 context.
25468
25469 This means that certificate identity and verification becomes a non-issue,
25470 as a man-in-the-middle attack will cause the correct client and server to
25471 see different identifiers and authentication will fail.
25472
25473 This is currently only supported when using the GnuTLS library.  This is
25474 only usable by mechanisms which support "channel binding"; at time of
25475 writing, that's the SCRAM family.
25476
25477 This defaults off to ensure smooth upgrade across Exim releases, in case
25478 this option causes some clients to start failing.  Some future release
25479 of Exim may switch the default to be true.
25480
25481
25482 .option server_hostname gsasl string&!! "see below"
25483 This option selects the hostname that is used when communicating with the
25484 library. The default value is &`$primary_hostname`&.
25485 Some mechanisms will use this data.
25486
25487
25488 .option server_mech gsasl string "see below"
25489 This option selects the authentication mechanism this driver should use. The
25490 default is the value of the generic &%public_name%& option. This option allows
25491 you to use a different underlying mechanism from the advertised name. For
25492 example:
25493 .code
25494 sasl:
25495   driver = gsasl
25496   public_name = X-ANYTHING
25497   server_mech = CRAM-MD5
25498   server_set_id = $auth1
25499 .endd
25500
25501
25502 .option server_password gsasl string&!! unset
25503 Various mechanisms need access to the cleartext password on the server, so
25504 that proof-of-possession can be demonstrated on the wire, without sending
25505 the password itself.
25506
25507 The data available for lookup varies per mechanism.
25508 In all cases, &$auth1$& is set to the &'authentication id'&.
25509 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25510 if available, else the empty string.
25511 The &$auth3$& variable will always be the &'realm'& if available,
25512 else the empty string.
25513
25514 A forced failure will cause authentication to defer.
25515
25516 If using this option, it may make sense to set the &%server_condition%&
25517 option to be simply "true".
25518
25519
25520 .option server_realm gsasl string&!! unset
25521 This specifies the SASL realm that the server claims to be in.
25522 Some mechanisms will use this data.
25523
25524
25525 .option server_scram_iter gsasl string&!! unset
25526 This option provides data for the SCRAM family of mechanisms.
25527 &$auth1$& is not available at evaluation time.
25528 (This may change, as we receive feedback on use)
25529
25530
25531 .option server_scram_salt gsasl string&!! unset
25532 This option provides data for the SCRAM family of mechanisms.
25533 &$auth1$& is not available at evaluation time.
25534 (This may change, as we receive feedback on use)
25535
25536
25537 .option server_service gsasl string &`smtp`&
25538 This is the SASL service that the server claims to implement.
25539 Some mechanisms will use this data.
25540
25541
25542 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25543 .vindex "&$auth1$&, &$auth2$&, etc"
25544 These may be set when evaluating specific options, as detailed above.
25545 They will also be set when evaluating &%server_condition%&.
25546
25547 Unless otherwise stated below, the &(gsasl)& integration will use the following
25548 meanings for these variables:
25549
25550 .ilist
25551 .vindex "&$auth1$&"
25552 &$auth1$&: the &'authentication id'&
25553 .next
25554 .vindex "&$auth2$&"
25555 &$auth2$&: the &'authorization id'&
25556 .next
25557 .vindex "&$auth3$&"
25558 &$auth3$&: the &'realm'&
25559 .endlist
25560
25561 On a per-mechanism basis:
25562
25563 .ilist
25564 .cindex "authentication" "EXTERNAL"
25565 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25566 the &%server_condition%& option must be present.
25567 .next
25568 .cindex "authentication" "ANONYMOUS"
25569 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25570 the &%server_condition%& option must be present.
25571 .next
25572 .cindex "authentication" "GSSAPI"
25573 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25574 &$auth2$& will be set to the &'authorization id'&,
25575 the &%server_condition%& option must be present.
25576 .endlist
25577
25578 An &'anonymous token'& is something passed along as an unauthenticated
25579 identifier; this is analogous to FTP anonymous authentication passing an
25580 email address, or software-identifier@, as the "password".
25581
25582
25583 An example showing the password having the realm specified in the callback
25584 and demonstrating a Cyrus SASL to GSASL migration approach is:
25585 .code
25586 gsasl_cyrusless_crammd5:
25587   driver = gsasl
25588   public_name = CRAM-MD5
25589   server_realm = imap.example.org
25590   server_password = ${lookup{$auth1:$auth3:userPassword}\
25591                     dbmjz{/etc/sasldb2}{$value}fail}
25592   server_set_id = ${quote:$auth1}
25593   server_condition = yes
25594 .endd
25595
25596
25597 . ////////////////////////////////////////////////////////////////////////////
25598 . ////////////////////////////////////////////////////////////////////////////
25599
25600 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25601 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25602 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25603 .cindex "authentication" "GSSAPI"
25604 .cindex "authentication" "Kerberos"
25605 The &(heimdal_gssapi)& authenticator provides server integration for the
25606 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25607 reliably.
25608
25609 .option server_hostname heimdal_gssapi string&!! "see below"
25610 This option selects the hostname that is used, with &%server_service%&,
25611 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25612 identifier.  The default value is &`$primary_hostname`&.
25613
25614 .option server_keytab heimdal_gssapi string&!! unset
25615 If set, then Heimdal will not use the system default keytab (typically
25616 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25617 The value should be a pathname, with no &"file:"& prefix.
25618
25619 .option server_service heimdal_gssapi string&!! "smtp"
25620 This option specifies the service identifier used, in conjunction with
25621 &%server_hostname%&, for building the identifer for finding credentials
25622 from the keytab.
25623
25624
25625 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25626 Beware that these variables will typically include a realm, thus will appear
25627 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25628 not verified, so a malicious client can set it to anything.
25629
25630 The &$auth1$& field should be safely trustable as a value from the Key
25631 Distribution Center.  Note that these are not quite email addresses.
25632 Each identifier is for a role, and so the left-hand-side may include a
25633 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25634
25635 .vindex "&$auth1$&, &$auth2$&, etc"
25636 .ilist
25637 .vindex "&$auth1$&"
25638 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25639 .next
25640 .vindex "&$auth2$&"
25641 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25642 authentication.  If that was empty, this will also be set to the
25643 GSS Display Name.
25644 .endlist
25645
25646
25647 . ////////////////////////////////////////////////////////////////////////////
25648 . ////////////////////////////////////////////////////////////////////////////
25649
25650 .chapter "The spa authenticator" "CHAPspa"
25651 .scindex IIDspaauth1 "&(spa)& authenticator"
25652 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25653 .cindex "authentication" "Microsoft Secure Password"
25654 .cindex "authentication" "NTLM"
25655 .cindex "Microsoft Secure Password Authentication"
25656 .cindex "NTLM authentication"
25657 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25658 Password Authentication'& mechanism,
25659 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25660 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25661 taken from the Samba project (&url(http://www.samba.org)). The code for the
25662 server side was subsequently contributed by Tom Kistner. The mechanism works as
25663 follows:
25664
25665 .ilist
25666 After the AUTH command has been accepted, the client sends an SPA
25667 authentication request based on the user name and optional domain.
25668 .next
25669 The server sends back a challenge.
25670 .next
25671 The client builds a challenge response which makes use of the user's password
25672 and sends it to the server, which then accepts or rejects it.
25673 .endlist
25674
25675 Encryption is used to protect the password in transit.
25676
25677
25678
25679 .section "Using spa as a server" "SECID179"
25680 .cindex "options" "&(spa)& authenticator (server)"
25681 The &(spa)& authenticator has just one server option:
25682
25683 .option server_password spa string&!! unset
25684 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25685 This option is expanded, and the result must be the cleartext password for the
25686 authenticating user, whose name is at this point in &$auth1$&. For
25687 compatibility with previous releases of Exim, the user name is also placed in
25688 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25689 it can lead to confusion in string expansions that also use numeric variables
25690 for other things. For example:
25691 .code
25692 spa:
25693   driver = spa
25694   public_name = NTLM
25695   server_password = \
25696     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25697 .endd
25698 If the expansion is forced to fail, authentication fails. Any other expansion
25699 failure causes a temporary error code to be returned.
25700
25701
25702
25703
25704
25705 .section "Using spa as a client" "SECID180"
25706 .cindex "options" "&(spa)& authenticator (client)"
25707 The &(spa)& authenticator has the following client options:
25708
25709
25710
25711 .option client_domain spa string&!! unset
25712 This option specifies an optional domain for the authentication.
25713
25714
25715 .option client_password spa string&!! unset
25716 This option specifies the user's password, and must be set.
25717
25718
25719 .option client_username spa string&!! unset
25720 This option specifies the user name, and must be set. Here is an example of a
25721 configuration of this authenticator for use with the mail servers at
25722 &'msn.com'&:
25723 .code
25724 msn:
25725   driver = spa
25726   public_name = MSN
25727   client_username = msn/msn_username
25728   client_password = msn_plaintext_password
25729   client_domain = DOMAIN_OR_UNSET
25730 .endd
25731 .ecindex IIDspaauth1
25732 .ecindex IIDspaauth2
25733
25734
25735
25736
25737
25738 . ////////////////////////////////////////////////////////////////////////////
25739 . ////////////////////////////////////////////////////////////////////////////
25740
25741 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25742          "Encrypted SMTP connections"
25743 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25744 .scindex IIDencsmtp2 "SMTP" "encryption"
25745 .cindex "TLS" "on SMTP connection"
25746 .cindex "OpenSSL"
25747 .cindex "GnuTLS"
25748 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25749 Sockets Layer), is implemented by making use of the OpenSSL library or the
25750 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25751 cryptographic code in the Exim distribution itself for implementing TLS. In
25752 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25753 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25754 You also need to understand the basic concepts of encryption at a managerial
25755 level, and in particular, the way that public keys, private keys, and
25756 certificates are used.
25757
25758 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25759 connection is established, the client issues a STARTTLS command. If the
25760 server accepts this, the client and the server negotiate an encryption
25761 mechanism. If the negotiation succeeds, the data that subsequently passes
25762 between them is encrypted.
25763
25764 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25765 and if so, what cipher suite is in use, whether the client supplied a
25766 certificate, and whether or not that certificate was verified. This makes it
25767 possible for an Exim server to deny or accept certain commands based on the
25768 encryption state.
25769
25770 &*Warning*&: Certain types of firewall and certain anti-virus products can
25771 disrupt TLS connections. You need to turn off SMTP scanning for these products
25772 in order to get TLS to work.
25773
25774
25775
25776 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25777          "SECID284"
25778 .cindex "ssmtp protocol"
25779 .cindex "smtps protocol"
25780 .cindex "SMTP" "ssmtp protocol"
25781 .cindex "SMTP" "smtps protocol"
25782 Early implementations of encrypted SMTP used a different TCP port from normal
25783 SMTP, and expected an encryption negotiation to start immediately, instead of
25784 waiting for a STARTTLS command from the client using the standard SMTP
25785 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25786 allocated for this purpose.
25787
25788 This approach was abandoned when encrypted SMTP was standardized, but there are
25789 still some legacy clients that use it. Exim supports these clients by means of
25790 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25791 numbers; the most common use is expected to be:
25792 .code
25793 tls_on_connect_ports = 465
25794 .endd
25795 The port numbers specified by this option apply to all SMTP connections, both
25796 via the daemon and via &'inetd'&. You still need to specify all the ports that
25797 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25798 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25799 an extra port &-- rather, it specifies different behaviour on a port that is
25800 defined elsewhere.
25801
25802 There is also a &%-tls-on-connect%& command line option. This overrides
25803 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25804
25805
25806
25807
25808
25809
25810 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25811 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25812 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25813 followed later, when the first versions of GnuTLS were released. To build Exim
25814 to use GnuTLS, you need to set
25815 .code
25816 USE_GNUTLS=yes
25817 .endd
25818 in Local/Makefile, in addition to
25819 .code
25820 SUPPORT_TLS=yes
25821 .endd
25822 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25823 include files and libraries for GnuTLS can be found.
25824
25825 There are some differences in usage when using GnuTLS instead of OpenSSL:
25826
25827 .ilist
25828 The &%tls_verify_certificates%& option must contain the name of a file, not the
25829 name of a directory (for OpenSSL it can be either).
25830 .next
25831 The default value for &%tls_dhparam%& differs for historical reasons.
25832 .next
25833 .vindex "&$tls_in_peerdn$&"
25834 .vindex "&$tls_out_peerdn$&"
25835 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25836 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25837 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25838 .next
25839 OpenSSL identifies cipher suites using hyphens as separators, for example:
25840 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25841 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25842 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25843 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25844 to handle its own older variants) when processing lists of cipher suites in the
25845 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25846 option).
25847 .next
25848 The &%tls_require_ciphers%& options operate differently, as described in the
25849 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25850 .next
25851 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25852 When using OpenSSL, this option is ignored.
25853 (If an API is found to let OpenSSL be configured in this way,
25854 let the Exim Maintainers know and we'll likely use it).
25855 .next
25856 Some other recently added features may only be available in one or the other.
25857 This should be documented with the feature.  If the documentation does not
25858 explicitly state that the feature is infeasible in the other TLS
25859 implementation, then patches are welcome.
25860 .endlist
25861
25862
25863 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25864 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25865 an explicit path; if the latter, then the text about generation still applies,
25866 but not the chosen filename.
25867 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25868 See the documentation of &%tls_dhparam%& for more information.
25869
25870 GnuTLS uses D-H parameters that may take a substantial amount of time
25871 to compute. It is unreasonable to re-compute them for every TLS session.
25872 Therefore, Exim keeps this data in a file in its spool directory, called
25873 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25874 of bits requested.
25875 The file is owned by the Exim user and is readable only by
25876 its owner. Every Exim process that start up GnuTLS reads the D-H
25877 parameters from this file. If the file does not exist, the first Exim process
25878 that needs it computes the data and writes it to a temporary file which is
25879 renamed once it is complete. It does not matter if several Exim processes do
25880 this simultaneously (apart from wasting a few resources). Once a file is in
25881 place, new Exim processes immediately start using it.
25882
25883 For maximum security, the parameters that are stored in this file should be
25884 recalculated periodically, the frequency depending on your paranoia level.
25885 If you are avoiding using the fixed D-H primes published in RFCs, then you
25886 are concerned about some advanced attacks and will wish to do this; if you do
25887 not regenerate then you might as well stick to the standard primes.
25888
25889 Arranging this is easy in principle; just delete the file when you want new
25890 values to be computed. However, there may be a problem. The calculation of new
25891 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25892 If the system is not very active, &_/dev/random_& may delay returning data
25893 until enough randomness (entropy) is available. This may cause Exim to hang for
25894 a substantial amount of time, causing timeouts on incoming connections.
25895
25896 The solution is to generate the parameters externally to Exim. They are stored
25897 in &_gnutls-params-N_& in PEM format, which means that they can be
25898 generated externally using the &(certtool)& command that is part of GnuTLS.
25899
25900 To replace the parameters with new ones, instead of deleting the file
25901 and letting Exim re-create it, you can generate new parameters using
25902 &(certtool)& and, when this has been done, replace Exim's cache file by
25903 renaming. The relevant commands are something like this:
25904 .code
25905 # ls
25906 [ look for file; assume gnutls-params-2236 is the most recent ]
25907 # rm -f new-params
25908 # touch new-params
25909 # chown exim:exim new-params
25910 # chmod 0600 new-params
25911 # certtool --generate-dh-params --bits 2236 >>new-params
25912 # openssl dhparam -noout -text -in new-params | head
25913 [ check the first line, make sure it's not more than 2236;
25914   if it is, then go back to the start ("rm") and repeat
25915   until the size generated is at most the size requested ]
25916 # chmod 0400 new-params
25917 # mv new-params gnutls-params-2236
25918 .endd
25919 If Exim never has to generate the parameters itself, the possibility of
25920 stalling is removed.
25921
25922 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25923 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25924 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25925 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25926 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25927 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25928 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25929 which applies to all D-H usage, client or server.  If the value returned by
25930 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25931 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25932 limit, which is still much higher than Exim historically used.
25933
25934 The filename and bits used will change as the GnuTLS maintainers change the
25935 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25936 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25937 2432 bits, while NSS is limited to 2236 bits.
25938
25939 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25940 increase the chance of the generated prime actually being within acceptable
25941 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25942 procedure above.  There is no sane procedure available to Exim to double-check
25943 the size of the generated prime, so it might still be too large.
25944
25945
25946 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25947 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25948 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25949 There is a function in the OpenSSL library that can be passed a list of cipher
25950 suites before the cipher negotiation takes place. This specifies which ciphers
25951 are acceptable. The list is colon separated and may contain names like
25952 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25953 directly to this function call.
25954 Many systems will install the OpenSSL manual-pages, so you may have
25955 &'ciphers(1)'& available to you.
25956 The following quotation from the OpenSSL
25957 documentation specifies what forms of item are allowed in the cipher string:
25958
25959 .ilist
25960 It can consist of a single cipher suite such as RC4-SHA.
25961 .next
25962 It can represent a list of cipher suites containing a certain algorithm,
25963 or cipher suites of a certain type. For example SHA1 represents all
25964 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25965 SSL v3 algorithms.
25966 .next
25967 Lists of cipher suites can be combined in a single cipher string using
25968 the + character. This is used as a logical and operation. For example
25969 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25970 algorithms.
25971 .endlist
25972
25973 Each cipher string can be optionally preceded by one of the characters &`!`&,
25974 &`-`& or &`+`&.
25975 .ilist
25976 If &`!`& is used, the ciphers are permanently deleted from the list. The
25977 ciphers deleted can never reappear in the list even if they are explicitly
25978 stated.
25979 .next
25980 If &`-`& is used, the ciphers are deleted from the list, but some or all
25981 of the ciphers can be added again by later options.
25982 .next
25983 If &`+`& is used, the ciphers are moved to the end of the list. This
25984 option does not add any new ciphers; it just moves matching existing ones.
25985 .endlist
25986
25987 If none of these characters is present, the string is interpreted as
25988 a list of ciphers to be appended to the current preference list. If the list
25989 includes any ciphers already present they will be ignored: that is, they will
25990 not be moved to the end of the list.
25991 .endlist
25992
25993 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25994 string:
25995 .code
25996 # note single-quotes to get ! past any shell history expansion
25997 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25998 .endd
25999
26000 This example will let the library defaults be permitted on the MX port, where
26001 there's probably no identity verification anyway, but ups the ante on the
26002 submission ports where the administrator might have some influence on the
26003 choice of clients used:
26004 .code
26005 # OpenSSL variant; see man ciphers(1)
26006 tls_require_ciphers = ${if =={$received_port}{25}\
26007                            {DEFAULT}\
26008                            {HIGH:!MD5:!SHA1}}
26009 .endd
26010
26011
26012
26013 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26014          "SECTreqciphgnu"
26015 .cindex "GnuTLS" "specifying parameters for"
26016 .cindex "TLS" "specifying ciphers (GnuTLS)"
26017 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26018 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26019 .cindex "TLS" "specifying protocols (GnuTLS)"
26020 .cindex "TLS" "specifying priority string (GnuTLS)"
26021 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26022 The GnuTLS library allows the caller to provide a "priority string", documented
26023 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26024 ciphersuite specification in OpenSSL.
26025
26026 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
26027
26028 The &%tls_require_ciphers%& option is available both as an global option,
26029 controlling how Exim behaves as a server, and also as an option of the
26030 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26031 the value is string expanded.  The resulting string is not an Exim list and
26032 the string is given to the GnuTLS library, so that Exim does not need to be
26033 aware of future feature enhancements of GnuTLS.
26034
26035 Documentation of the strings accepted may be found in the GnuTLS manual, under
26036 "Priority strings".  This is online as
26037 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26038 but beware that this relates to GnuTLS 3, which may be newer than the version
26039 installed on your system.  If you are using GnuTLS 3,
26040 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26041 on that site can be used to test a given string.
26042
26043 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26044 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26045 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26046
26047 This example will let the library defaults be permitted on the MX port, where
26048 there's probably no identity verification anyway, and lowers security further
26049 by increasing compatibility; but this ups the ante on the submission ports
26050 where the administrator might have some influence on the choice of clients
26051 used:
26052 .code
26053 # GnuTLS variant
26054 tls_require_ciphers = ${if =={$received_port}{25}\
26055                            {NORMAL:%COMPAT}\
26056                            {SECURE128}}
26057 .endd
26058
26059
26060 .section "Configuring an Exim server to use TLS" "SECID182"
26061 .cindex "TLS" "configuring an Exim server"
26062 When Exim has been built with TLS support, it advertises the availability of
26063 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26064 but not to any others. The default value of this option is unset, which means
26065 that STARTTLS is not advertised at all. This default is chosen because you
26066 need to set some other options in order to make TLS available, and also it is
26067 sensible for systems that want to use TLS only as a client.
26068
26069 If a client issues a STARTTLS command and there is some configuration
26070 problem in the server, the command is rejected with a 454 error. If the client
26071 persists in trying to issue SMTP commands, all except QUIT are rejected
26072 with the error
26073 .code
26074 554 Security failure
26075 .endd
26076 If a STARTTLS command is issued within an existing TLS session, it is
26077 rejected with a 554 error code.
26078
26079 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26080 match some hosts. You can, of course, set it to * to match all hosts.
26081 However, this is not all you need to do. TLS sessions to a server won't work
26082 without some further configuration at the server end.
26083
26084 It is rumoured that all existing clients that support TLS/SSL use RSA
26085 encryption. To make this work you need to set, in the server,
26086 .code
26087 tls_certificate = /some/file/name
26088 tls_privatekey = /some/file/name
26089 .endd
26090 These options are, in fact, expanded strings, so you can make them depend on
26091 the identity of the client that is connected if you wish. The first file
26092 contains the server's X509 certificate, and the second contains the private key
26093 that goes with it. These files need to be readable by the Exim user, and must
26094 always be given as full path names. They can be the same file if both the
26095 certificate and the key are contained within it. If &%tls_privatekey%& is not
26096 set, or if its expansion is forced to fail or results in an empty string, this
26097 is assumed to be the case. The certificate file may also contain intermediate
26098 certificates that need to be sent to the client to enable it to authenticate
26099 the server's certificate.
26100
26101 If you do not understand about certificates and keys, please try to find a
26102 source of this background information, which is not Exim-specific. (There are a
26103 few comments below in section &<<SECTcerandall>>&.)
26104
26105 &*Note*&: These options do not apply when Exim is operating as a client &--
26106 they apply only in the case of a server. If you need to use a certificate in an
26107 Exim client, you must set the options of the same names in an &(smtp)&
26108 transport.
26109
26110 With just these options, an Exim server will be able to use TLS. It does not
26111 require the client to have a certificate (but see below for how to insist on
26112 this). There is one other option that may be needed in other situations. If
26113 .code
26114 tls_dhparam = /some/file/name
26115 .endd
26116 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26117 with the parameters contained in the file.
26118 Set this to &`none`& to disable use of DH entirely, by making no prime
26119 available:
26120 .code
26121 tls_dhparam = none
26122 .endd
26123 This may also be set to a string identifying a standard prime to be used for
26124 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26125 used is &`ike23`&.  There are a few standard primes available, see the
26126 documentation for &%tls_dhparam%& for the complete list.
26127
26128 See the command
26129 .code
26130 openssl dhparam
26131 .endd
26132 for a way of generating file data.
26133
26134 The strings supplied for these three options are expanded every time a client
26135 host connects. It is therefore possible to use different certificates and keys
26136 for different hosts, if you so wish, by making use of the client's IP address
26137 in &$sender_host_address$& to control the expansion. If a string expansion is
26138 forced to fail, Exim behaves as if the option is not set.
26139
26140 .cindex "cipher" "logging"
26141 .cindex "log" "TLS cipher"
26142 .vindex "&$tls_in_cipher$&"
26143 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26144 an incoming TLS connection. It is included in the &'Received:'& header of an
26145 incoming message (by default &-- you can, of course, change this), and it is
26146 also included in the log line that records a message's arrival, keyed by
26147 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26148 condition can be used to test for specific cipher suites in ACLs.
26149
26150 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26151 can check the name of the cipher suite and vary their actions accordingly. The
26152 cipher suite names vary, depending on which TLS library is being used. For
26153 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26154 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26155 documentation for more details.
26156
26157 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26158 (again depending on the &%tls_cipher%& log selector).
26159
26160
26161 .section "Requesting and verifying client certificates" "SECID183"
26162 .cindex "certificate" "verification of client"
26163 .cindex "TLS" "client certificate verification"
26164 If you want an Exim server to request a certificate when negotiating a TLS
26165 session with a client, you must set either &%tls_verify_hosts%& or
26166 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26167 apply to all TLS connections. For any host that matches one of these options,
26168 Exim requests a certificate as part of the setup of the TLS session. The
26169 contents of the certificate are verified by comparing it with a list of
26170 expected certificates. These must be available in a file or,
26171 for OpenSSL only (not GnuTLS), a directory, identified by
26172 &%tls_verify_certificates%&.
26173
26174 A file can contain multiple certificates, concatenated end to end. If a
26175 directory is used
26176 (OpenSSL only),
26177 each certificate must be in a separate file, with a name (or a symbolic link)
26178 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26179 certificate. You can compute the relevant hash by running the command
26180 .code
26181 openssl x509 -hash -noout -in /cert/file
26182 .endd
26183 where &_/cert/file_& contains a single certificate.
26184
26185 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26186 what happens if the client does not supply a certificate, or if the certificate
26187 does not match any of the certificates in the collection named by
26188 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26189 attempt to set up a TLS session is aborted, and the incoming connection is
26190 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26191 session continues. ACLs that run for subsequent SMTP commands can detect the
26192 fact that no certificate was verified, and vary their actions accordingly. For
26193 example, you can insist on a certificate before accepting a message for
26194 relaying, but not when the message is destined for local delivery.
26195
26196 .vindex "&$tls_in_peerdn$&"
26197 When a client supplies a certificate (whether it verifies or not), the value of
26198 the Distinguished Name of the certificate is made available in the variable
26199 &$tls_in_peerdn$& during subsequent processing of the message.
26200
26201 .cindex "log" "distinguished name"
26202 Because it is often a long text string, it is not included in the log line or
26203 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26204 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26205 &%received_header_text%& to change the &'Received:'& header. When no
26206 certificate is supplied, &$tls_in_peerdn$& is empty.
26207
26208
26209 .section "Revoked certificates" "SECID184"
26210 .cindex "TLS" "revoked certificates"
26211 .cindex "revocation list"
26212 .cindex "certificate" "revocation list"
26213 .cindex "OCSP" "stapling"
26214 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26215 certificates are revoked. If you have such a list, you can pass it to an Exim
26216 server using the global option called &%tls_crl%& and to an Exim client using
26217 an identically named option for the &(smtp)& transport. In each case, the value
26218 of the option is expanded and must then be the name of a file that contains a
26219 CRL in PEM format.
26220 The downside is that clients have to periodically re-download a potentially huge
26221 file from every certificate authority the know of.
26222
26223 The way with most moving parts at query time is Online Certificate
26224 Status Protocol (OCSP), where the client verifies the certificate
26225 against an OCSP server run by the CA.  This lets the CA track all
26226 usage of the certs.  It requires running software with access to the
26227 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26228 is based on HTTP and can be proxied accordingly.
26229
26230 The only widespread OCSP server implementation (known to this writer)
26231 comes as part of OpenSSL and aborts on an invalid request, such as
26232 connecting to the port and then disconnecting.  This requires
26233 re-entering the passphrase each time some random client does this.
26234
26235 The third way is OCSP Stapling; in this, the server using a certificate
26236 issued by the CA periodically requests an OCSP proof of validity from
26237 the OCSP server, then serves it up inline as part of the TLS
26238 negotiation.   This approach adds no extra round trips, does not let the
26239 CA track users, scales well with number of certs issued by the CA and is
26240 resilient to temporary OCSP server failures, as long as the server
26241 starts retrying to fetch an OCSP proof some time before its current
26242 proof expires.  The downside is that it requires server support.
26243
26244 Unless Exim is built with the support disabled,
26245 or with GnuTLS earlier than version 3.1.3,
26246 support for OCSP stapling is included.
26247
26248 There is a global option called &%tls_ocsp_file%&.
26249 The file specified therein is expected to be in DER format, and contain
26250 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26251 option will be re-expanded for SNI, if the &%tls_certificate%& option
26252 contains &`tls_in_sni`&, as per other TLS options.
26253
26254 Exim does not at this time implement any support for fetching a new OCSP
26255 proof.  The burden is on the administrator to handle this, outside of
26256 Exim.  The file specified should be replaced atomically, so that the
26257 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26258 on each connection, so a new file will be handled transparently on the
26259 next connection.
26260
26261 When built with OpenSSL Exim will check for a valid next update timestamp
26262 in the OCSP proof; if not present, or if the proof has expired, it will be
26263 ignored.
26264
26265 For the client to be able to verify the stapled OCSP the server must
26266 also supply, in its stapled information, any intermediate
26267 certificates for the chain leading to the OCSP proof from the signer
26268 of the server certificate.  There may be zero or one such. These
26269 intermediate certificates should be added to the server OCSP stapling
26270 file named by &%tls_ocsp_file%&.
26271
26272 Note that the proof only covers the terminal server certificate,
26273 not any of the chain from CA to it.
26274
26275 There is no current way to staple a proof for a client certificate.
26276
26277 .code
26278   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26279   OCSP server is supplied.  The server URL may be included in the
26280   server certificate, if the CA is helpful.
26281
26282   One failure mode seen was the OCSP Signer cert expiring before the end
26283   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26284   noted this as invalid overall, but the re-fetch script did not.
26285 .endd
26286
26287
26288
26289
26290 .section "Configuring an Exim client to use TLS" "SECID185"
26291 .cindex "cipher" "logging"
26292 .cindex "log" "TLS cipher"
26293 .cindex "log" "distinguished name"
26294 .cindex "TLS" "configuring an Exim client"
26295 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26296 deliveries as well as to incoming, the latter one causing logging of the
26297 server certificate's DN. The remaining client configuration for TLS is all
26298 within the &(smtp)& transport.
26299
26300 It is not necessary to set any options to have TLS work in the &(smtp)&
26301 transport. If Exim is built with TLS support, and TLS is advertised by a
26302 server, the &(smtp)& transport always tries to start a TLS session. However,
26303 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26304 transport) to a list of server hosts for which TLS should not be used.
26305
26306 If you do not want Exim to attempt to send messages unencrypted when an attempt
26307 to set up an encrypted connection fails in any way, you can set
26308 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26309 those hosts, delivery is always deferred if an encrypted connection cannot be
26310 set up. If there are any other hosts for the address, they are tried in the
26311 usual way.
26312
26313 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26314 the message unencrypted. It always does this if the response to STARTTLS is
26315 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26316 session after a success response code, what happens is controlled by the
26317 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26318 delivery to this host is deferred, and other hosts (if available) are tried. If
26319 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26320 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26321 negotiation fails, Exim closes the current connection (because it is in an
26322 unknown state), opens a new one to the same host, and then tries the delivery
26323 unencrypted.
26324
26325 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26326 transport provide the client with a certificate, which is passed to the server
26327 if it requests it. If the server is Exim, it will request a certificate only if
26328 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26329
26330 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26331 must name a file or,
26332 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
26333 expected server certificates. The client verifies the server's certificate
26334 against this collection, taking into account any revoked certificates that are
26335 in the list defined by &%tls_crl%&.
26336 Failure to verify fails the TLS connection unless either of the
26337 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26338
26339 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26340 certificate verification to the listed servers.  Verification either must
26341 or need not succeed respectively.
26342
26343 The &(smtp)& transport has two OCSP-related options:
26344 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26345 is requested and required for the connection to proceed.  The default
26346 value is empty.
26347 &%hosts_request_ocsp%&; a host-list for which (additionally)
26348 a Certificate Status is requested (but not necessarily verified).  The default
26349 value is "*" meaning that requests are made unless configured
26350 otherwise.
26351
26352 The host(s) should also be in &%hosts_require_tls%&, and
26353 &%tls_verify_certificates%& configured for the transport,
26354 for OCSP to be relevant.
26355
26356 If
26357 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26358 list of permitted cipher suites. If either of these checks fails, delivery to
26359 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26360 alternative hosts, if any.
26361
26362  &*Note*&:
26363 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26364 is operating as a client. Exim does not assume that a server certificate (set
26365 by the global options of the same name) should also be used when operating as a
26366 client.
26367
26368 .vindex "&$host$&"
26369 .vindex "&$host_address$&"
26370 All the TLS options in the &(smtp)& transport are expanded before use, with
26371 &$host$& and &$host_address$& containing the name and address of the server to
26372 which the client is connected. Forced failure of an expansion causes Exim to
26373 behave as if the relevant option were unset.
26374
26375 .vindex &$tls_out_bits$&
26376 .vindex &$tls_out_cipher$&
26377 .vindex &$tls_out_peerdn$&
26378 .vindex &$tls_out_sni$&
26379 Before an SMTP connection is established, the
26380 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26381 variables are emptied. (Until the first connection, they contain the values
26382 that were set when the message was received.) If STARTTLS is subsequently
26383 successfully obeyed, these variables are set to the relevant values for the
26384 outgoing connection.
26385
26386
26387
26388 .section "Use of TLS Server Name Indication" "SECTtlssni"
26389 .cindex "TLS" "Server Name Indication"
26390 .vindex "&$tls_in_sni$&"
26391 .oindex "&%tls_in_sni%&"
26392 With TLS1.0 or above, there is an extension mechanism by which extra
26393 information can be included at various points in the protocol.  One of these
26394 extensions, documented in RFC 6066 (and before that RFC 4366) is
26395 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26396 client in the initial handshake, so that the server can examine the servername
26397 within and possibly choose to use different certificates and keys (and more)
26398 for this session.
26399
26400 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26401 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26402 address.
26403
26404 With SMTP to MX, there are the same problems here as in choosing the identity
26405 against which to validate a certificate: you can't rely on insecure DNS to
26406 provide the identity which you then cryptographically verify.  So this will
26407 be of limited use in that environment.
26408
26409 With SMTP to Submission, there is a well-defined hostname which clients are
26410 connecting to and can validate certificates against.  Thus clients &*can*&
26411 choose to include this information in the TLS negotiation.  If this becomes
26412 wide-spread, then hosters can choose to present different certificates to
26413 different clients.  Or even negotiate different cipher suites.
26414
26415 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26416 if not empty, will be sent on a TLS session as part of the handshake.  There's
26417 nothing more to it.  Choosing a sensible value not derived insecurely is the
26418 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26419 for the lifetime of the client connection (including during authentication).
26420
26421 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26422 received from a client.
26423 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26424
26425 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26426 option (prior to expansion) then the following options will be re-expanded
26427 during TLS session handshake, to permit alternative values to be chosen:
26428
26429 .ilist
26430 .vindex "&%tls_certificate%&"
26431 &%tls_certificate%&
26432 .next
26433 .vindex "&%tls_crl%&"
26434 &%tls_crl%&
26435 .next
26436 .vindex "&%tls_privatekey%&"
26437 &%tls_privatekey%&
26438 .next
26439 .vindex "&%tls_verify_certificates%&"
26440 &%tls_verify_certificates%&
26441 .next
26442 .vindex "&%tls_ocsp_file%&"
26443 &%tls_verify_certificates%&
26444 .endlist
26445
26446 Great care should be taken to deal with matters of case, various injection
26447 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26448 can always be referenced; it is important to remember that &$tls_sni$& is
26449 arbitrary unverified data provided prior to authentication.
26450
26451 The Exim developers are proceeding cautiously and so far no other TLS options
26452 are re-expanded.
26453
26454 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26455 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26456 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26457 see &`-servername`& in the output, then OpenSSL has support.
26458
26459 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26460 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26461 built, then you have SNI support).
26462
26463
26464
26465 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26466          "SECTmulmessam"
26467 .cindex "multiple SMTP deliveries with TLS"
26468 .cindex "TLS" "multiple message deliveries"
26469 Exim sends multiple messages down the same TCP/IP connection by starting up
26470 an entirely new delivery process for each message, passing the socket from
26471 one process to the next. This implementation does not fit well with the use
26472 of TLS, because there is quite a lot of state information associated with a TLS
26473 connection, not just a socket identification. Passing all the state information
26474 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26475 session before passing the socket to a new process. The new process may then
26476 try to start a new TLS session, and if successful, may try to re-authenticate
26477 if AUTH is in use, before sending the next message.
26478
26479 The RFC is not clear as to whether or not an SMTP session continues in clear
26480 after TLS has been shut down, or whether TLS may be restarted again later, as
26481 just described. However, if the server is Exim, this shutdown and
26482 reinitialization works. It is not known which (if any) other servers operate
26483 successfully if the client closes a TLS session and continues with unencrypted
26484 SMTP, but there are certainly some that do not work. For such servers, Exim
26485 should not pass the socket to another process, because the failure of the
26486 subsequent attempt to use it would cause Exim to record a temporary host error,
26487 and delay other deliveries to that host.
26488
26489 To test for this case, Exim sends an EHLO command to the server after
26490 closing down the TLS session. If this fails in any way, the connection is
26491 closed instead of being passed to a new delivery process, but no retry
26492 information is recorded.
26493
26494 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26495 &(smtp)& transport to match those hosts for which Exim should not pass
26496 connections to new processes if TLS has been used.
26497
26498
26499
26500
26501 .section "Certificates and all that" "SECTcerandall"
26502 .cindex "certificate" "references to discussion"
26503 In order to understand fully how TLS works, you need to know about
26504 certificates, certificate signing, and certificate authorities. This is not the
26505 place to give a tutorial, especially as I do not know very much about it
26506 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26507 to Apache, currently at
26508 .display
26509 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26510 .endd
26511 Other parts of the &'modssl'& documentation are also helpful, and have
26512 links to further files.
26513 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26514 0-201-61598-3), contains both introductory and more in-depth descriptions.
26515 Some sample programs taken from the book are available from
26516 .display
26517 &url(http://www.rtfm.com/openssl-examples/)
26518 .endd
26519
26520
26521 .section "Certificate chains" "SECID186"
26522 The file named by &%tls_certificate%& may contain more than one
26523 certificate. This is useful in the case where the certificate that is being
26524 sent is validated by an intermediate certificate which the other end does
26525 not have. Multiple certificates must be in the correct order in the file.
26526 First the host's certificate itself, then the first intermediate
26527 certificate to validate the issuer of the host certificate, then the next
26528 intermediate certificate to validate the issuer of the first intermediate
26529 certificate, and so on, until finally (optionally) the root certificate.
26530 The root certificate must already be trusted by the recipient for
26531 validation to succeed, of course, but if it's not preinstalled, sending the
26532 root certificate along with the rest makes it available for the user to
26533 install if the receiving end is a client MUA that can interact with a user.
26534
26535 Note that certificates using MD5 are unlikely to work on today's Internet;
26536 even if your libraries allow loading them for use in Exim when acting as a
26537 server, increasingly clients will not accept such certificates.  The error
26538 diagnostics in such a case can be frustratingly vague.
26539
26540
26541
26542 .section "Self-signed certificates" "SECID187"
26543 .cindex "certificate" "self-signed"
26544 You can create a self-signed certificate using the &'req'& command provided
26545 with OpenSSL, like this:
26546 . ==== Do not shorten the duration here without reading and considering
26547 . ==== the text below.  Please leave it at 9999 days.
26548 .code
26549 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26550             -days 9999 -nodes
26551 .endd
26552 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26553 delimited and so can be identified independently. The &%-days%& option
26554 specifies a period for which the certificate is valid. The &%-nodes%& option is
26555 important: if you do not set it, the key is encrypted with a passphrase
26556 that you are prompted for, and any use that is made of the key causes more
26557 prompting for the passphrase. This is not helpful if you are going to use
26558 this certificate and key in an MTA, where prompting is not possible.
26559
26560 . ==== I expect to still be working 26 years from now.  The less technical
26561 . ==== debt I create, in terms of storing up trouble for my later years, the
26562 . ==== happier I will be then.  We really have reached the point where we
26563 . ==== should start, at the very least, provoking thought and making folks
26564 . ==== pause before proceeding, instead of leaving all the fixes until two
26565 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26566 . ==== -pdp, 2012
26567 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26568 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26569 the above command might produce a date in the past.  Think carefully about
26570 the lifetime of the systems you're deploying, and either reduce the duration
26571 of the certificate or reconsider your platform deployment.  (At time of
26572 writing, reducing the duration is the most likely choice, but the inexorable
26573 progression of time takes us steadily towards an era where this will not
26574 be a sensible resolution).
26575
26576 A self-signed certificate made in this way is sufficient for testing, and
26577 may be adequate for all your requirements if you are mainly interested in
26578 encrypting transfers, and not in secure identification.
26579
26580 However, many clients require that the certificate presented by the server be a
26581 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26582 certificate. In this situation, the self-signed certificate described above
26583 must be installed on the client host as a trusted root &'certification
26584 authority'& (CA), and the certificate used by Exim must be a user certificate
26585 signed with that self-signed certificate.
26586
26587 For information on creating self-signed CA certificates and using them to sign
26588 user certificates, see the &'General implementation overview'& chapter of the
26589 Open-source PKI book, available online at
26590 &url(http://ospkibook.sourceforge.net/).
26591 .ecindex IIDencsmtp1
26592 .ecindex IIDencsmtp2
26593
26594
26595
26596 . ////////////////////////////////////////////////////////////////////////////
26597 . ////////////////////////////////////////////////////////////////////////////
26598
26599 .chapter "Access control lists" "CHAPACL"
26600 .scindex IIDacl "&ACL;" "description"
26601 .cindex "control of incoming mail"
26602 .cindex "message" "controlling incoming"
26603 .cindex "policy control" "access control lists"
26604 Access Control Lists (ACLs) are defined in a separate section of the run time
26605 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26606 name, terminated by a colon. Here is a complete ACL section that contains just
26607 one very small ACL:
26608 .code
26609 begin acl
26610 small_acl:
26611   accept   hosts = one.host.only
26612 .endd
26613 You can have as many lists as you like in the ACL section, and the order in
26614 which they appear does not matter. The lists are self-terminating.
26615
26616 The majority of ACLs are used to control Exim's behaviour when it receives
26617 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26618 when a local process submits a message using SMTP by specifying the &%-bs%&
26619 option. The most common use is for controlling which recipients are accepted
26620 in incoming messages. In addition, you can define an ACL that is used to check
26621 local non-SMTP messages. The default configuration file contains an example of
26622 a realistic ACL for checking RCPT commands. This is discussed in chapter
26623 &<<CHAPdefconfil>>&.
26624
26625
26626 .section "Testing ACLs" "SECID188"
26627 The &%-bh%& command line option provides a way of testing your ACL
26628 configuration locally by running a fake SMTP session with which you interact.
26629 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26630 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26631
26632
26633
26634 .section "Specifying when ACLs are used" "SECID189"
26635 .cindex "&ACL;" "options for specifying"
26636 In order to cause an ACL to be used, you have to name it in one of the relevant
26637 options in the main part of the configuration. These options are:
26638 .cindex "AUTH" "ACL for"
26639 .cindex "DATA" "ACLs for"
26640 .cindex "ETRN" "ACL for"
26641 .cindex "EXPN" "ACL for"
26642 .cindex "HELO" "ACL for"
26643 .cindex "EHLO" "ACL for"
26644 .cindex "MAIL" "ACL for"
26645 .cindex "QUIT, ACL for"
26646 .cindex "RCPT" "ACL for"
26647 .cindex "STARTTLS, ACL for"
26648 .cindex "VRFY" "ACL for"
26649 .cindex "SMTP" "connection, ACL for"
26650 .cindex "non-SMTP messages" "ACLs for"
26651 .cindex "MIME content scanning" "ACL for"
26652 .cindex "PRDR" "ACL for"
26653
26654 .table2 140pt
26655 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26656 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26657 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26658 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26659 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26660 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26661 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26662 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26663 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26664 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26665 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26666 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26667 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26668 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26669 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26670 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26671 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26672 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26673 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26674 .endtable
26675
26676 For example, if you set
26677 .code
26678 acl_smtp_rcpt = small_acl
26679 .endd
26680 the little ACL defined above is used whenever Exim receives a RCPT command
26681 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26682 done when RCPT commands arrive. A rejection of RCPT should cause the
26683 sending MTA to give up on the recipient address contained in the RCPT
26684 command, whereas rejection at other times may cause the client MTA to keep on
26685 trying to deliver the message. It is therefore recommended that you do as much
26686 testing as possible at RCPT time.
26687
26688
26689 .section "The non-SMTP ACLs" "SECID190"
26690 .cindex "non-SMTP messages" "ACLs for"
26691 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26692 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26693 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26694 the state of the SMTP connection such as encryption and authentication) are not
26695 relevant and are forbidden in these ACLs. However, the sender and recipients
26696 are known, so the &%senders%& and &%sender_domains%& conditions and the
26697 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26698 &$authenticated_sender$& are also available. You can specify added header lines
26699 in any of these ACLs.
26700
26701 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26702 non-SMTP message, before any of the message has been read. (This is the
26703 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26704 batched SMTP input, it runs after the DATA command has been reached. The
26705 result of this ACL is ignored; it cannot be used to reject a message. If you
26706 really need to, you could set a value in an ACL variable here and reject based
26707 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26708 controls, and in particular, it can be used to set
26709 .code
26710 control = suppress_local_fixups
26711 .endd
26712 This cannot be used in the other non-SMTP ACLs because by the time they are
26713 run, it is too late.
26714
26715 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26716 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26717
26718 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26719 kind of rejection is treated as permanent, because there is no way of sending a
26720 temporary error for these kinds of message.
26721
26722
26723 .section "The SMTP connect ACL" "SECID191"
26724 .cindex "SMTP" "connection, ACL for"
26725 .oindex &%smtp_banner%&
26726 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26727 session, after the test specified by &%host_reject_connection%& (which is now
26728 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26729 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26730 the message override the banner message that is otherwise specified by the
26731 &%smtp_banner%& option.
26732
26733
26734 .section "The EHLO/HELO ACL" "SECID192"
26735 .cindex "EHLO" "ACL for"
26736 .cindex "HELO" "ACL for"
26737 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26738 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26739 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26740 Note that a client may issue more than one EHLO or HELO command in an SMTP
26741 session, and indeed is required to issue a new EHLO or HELO after successfully
26742 setting up encryption following a STARTTLS command.
26743
26744 If the command is accepted by an &%accept%& verb that has a &%message%&
26745 modifier, the message may not contain more than one line (it will be truncated
26746 at the first newline and a panic logged if it does). Such a message cannot
26747 affect the EHLO options that are listed on the second and subsequent lines of
26748 an EHLO response.
26749
26750
26751 .section "The DATA ACLs" "SECID193"
26752 .cindex "DATA" "ACLs for"
26753 Two ACLs are associated with the DATA command, because it is two-stage
26754 command, with two responses being sent to the client.
26755 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26756 is obeyed. This gives you control after all the RCPT commands, but before
26757 the message itself is received. It offers the opportunity to give a negative
26758 response to the DATA command before the data is transmitted. Header lines
26759 added by MAIL or RCPT ACLs are not visible at this time, but any that
26760 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26761
26762 You cannot test the contents of the message, for example, to verify addresses
26763 in the headers, at RCPT time or when the DATA command is received. Such
26764 tests have to appear in the ACL that is run after the message itself has been
26765 received, before the final response to the DATA command is sent. This is
26766 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26767 associated with the DATA command.
26768
26769 For both of these ACLs, it is not possible to reject individual recipients. An
26770 error response rejects the entire message. Unfortunately, it is known that some
26771 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26772 before or after the data) correctly &-- they keep the message on their queues
26773 and try again later, but that is their problem, though it does waste some of
26774 your resources.
26775
26776 The &%acl_smtp_data%& ACL is run after
26777 the &%acl_smtp_data_prdr%&,
26778 the &%acl_smtp_dkim%&
26779 and the &%acl_smtp_mime%& ACLs.
26780
26781 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26782 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26783 enabled (which is the default).
26784
26785 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26786 received, and is executed for each DKIM signature found in a message.  If not
26787 otherwise specified, the default action is to accept.
26788
26789 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26790
26791 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26792
26793
26794 .section "The SMTP MIME ACL" "SECID194"
26795 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26796 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26797
26798 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26799
26800
26801 .section "The SMTP PRDR ACL" "SECTPRDRACL"
26802 .oindex "&%prdr_enable%&"
26803 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
26804 with PRDR support enabled (which is the default).
26805 It becomes active only when the PRDR feature is negotiated between
26806 client and server for a message, and more than one recipient
26807 has been accepted.
26808
26809 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
26810 has been recieved, and is executed for each recipient of the message.
26811 The test may accept or deny for inividual recipients.
26812 The &%acl_smtp_data%& will still be called after this ACL and
26813 can reject the message overall, even if this ACL has accepted it
26814 for some or all recipients.
26815
26816 PRDR may be used to support per-user content filtering.  Without it
26817 one must defer any recipient after the first that has a different
26818 content-filter configuration.  With PRDR, the RCPT-time check
26819 for this can be disabled when the MAIL-time $smtp_command included
26820 "PRDR".  Any required difference in behaviour of the main DATA-time
26821 ACL should however depend on the PRDR-time ACL having run, as Exim
26822 will avoid doing so in some situations (eg.  single-recipient mails).
26823
26824 See also the &%prdr_enable%& global option
26825 and the &%hosts_try_prdr%& smtp transport option.
26826
26827 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26828 If the ACL is not defined, processing completes as if
26829 the feature was not requested by the client.
26830
26831 .section "The QUIT ACL" "SECTQUITACL"
26832 .cindex "QUIT, ACL for"
26833 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26834 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26835 does not in fact control any access. For this reason, the only verbs that are
26836 permitted are &%accept%& and &%warn%&.
26837
26838 This ACL can be used for tasks such as custom logging at the end of an SMTP
26839 session. For example, you can use ACL variables in other ACLs to count
26840 messages, recipients, etc., and log the totals at QUIT time using one or
26841 more &%logwrite%& modifiers on a &%warn%& verb.
26842
26843 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26844 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26845
26846 You do not need to have a final &%accept%&, but if you do, you can use a
26847 &%message%& modifier to specify custom text that is sent as part of the 221
26848 response to QUIT.
26849
26850 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26851 failure (for example, failure to open a log file, or when Exim is bombing out
26852 because it has detected an unrecoverable error), all SMTP commands from the
26853 client are given temporary error responses until QUIT is received or the
26854 connection is closed. In these special cases, the QUIT ACL does not run.
26855
26856
26857 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26858 .vindex &$acl_smtp_notquit$&
26859 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26860 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26861 trouble, such as being unable to write to its log files, this ACL is not run,
26862 because it might try to do things (such as write to log files) that make the
26863 situation even worse.
26864
26865 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26866 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26867 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26868 and &%warn%&.
26869
26870 .vindex &$smtp_notquit_reason$&
26871 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26872 to a string that indicates the reason for the termination of the SMTP
26873 connection. The possible values are:
26874 .table2
26875 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26876 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26877 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26878 .irow &`connection-lost`&          "The SMTP connection has been lost"
26879 .irow &`data-timeout`&             "Timeout while reading message data"
26880 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26881 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26882 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26883 .irow &`synchronization-error`&    "SMTP synchronization error"
26884 .irow &`tls-failed`&               "TLS failed to start"
26885 .endtable
26886 In most cases when an SMTP connection is closed without having received QUIT,
26887 Exim sends an SMTP response message before actually closing the connection.
26888 With the exception of the &`acl-drop`& case, the default message can be
26889 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26890 &%drop%& verb in another ACL, it is the message from the other ACL that is
26891 used.
26892
26893
26894 .section "Finding an ACL to use" "SECID195"
26895 .cindex "&ACL;" "finding which to use"
26896 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26897 you can use different ACLs in different circumstances. For example,
26898 .code
26899 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26900                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26901 .endd
26902 In the default configuration file there are some example settings for
26903 providing an RFC 4409 message submission service on port 587 and a
26904 non-standard &"smtps"& service on port 465. You can use a string
26905 expansion like this to choose an ACL for MUAs on these ports which is
26906 more appropriate for this purpose than the default ACL on port 25.
26907
26908 The expanded string does not have to be the name of an ACL in the
26909 configuration file; there are other possibilities. Having expanded the
26910 string, Exim searches for an ACL as follows:
26911
26912 .ilist
26913 If the string begins with a slash, Exim uses it as a file name, and reads its
26914 contents as an ACL. The lines are processed in the same way as lines in the
26915 Exim configuration file. In particular, continuation lines are supported, blank
26916 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26917 If the file does not exist or cannot be read, an error occurs (typically
26918 causing a temporary failure of whatever caused the ACL to be run). For example:
26919 .code
26920 acl_smtp_data = /etc/acls/\
26921   ${lookup{$sender_host_address}lsearch\
26922   {/etc/acllist}{$value}{default}}
26923 .endd
26924 This looks up an ACL file to use on the basis of the host's IP address, falling
26925 back to a default if the lookup fails. If an ACL is successfully read from a
26926 file, it is retained in memory for the duration of the Exim process, so that it
26927 can be re-used without having to re-read the file.
26928 .next
26929 If the string does not start with a slash, and does not contain any spaces,
26930 Exim searches the ACL section of the configuration for an ACL whose name
26931 matches the string.
26932 .next
26933 If no named ACL is found, or if the string contains spaces, Exim parses
26934 the string as an inline ACL. This can save typing in cases where you just
26935 want to have something like
26936 .code
26937 acl_smtp_vrfy = accept
26938 .endd
26939 in order to allow free use of the VRFY command. Such a string may contain
26940 newlines; it is processed in the same way as an ACL that is read from a file.
26941 .endlist
26942
26943
26944
26945
26946 .section "ACL return codes" "SECID196"
26947 .cindex "&ACL;" "return codes"
26948 Except for the QUIT ACL, which does not affect the SMTP return code (see
26949 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26950 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26951 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26952 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
26953 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
26954 This also causes a 4&'xx'& return code.
26955
26956 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
26957 &"deny"&, because there is no mechanism for passing temporary errors to the
26958 submitters of non-SMTP messages.
26959
26960
26961 ACLs that are relevant to message reception may also return &"discard"&. This
26962 has the effect of &"accept"&, but causes either the entire message or an
26963 individual recipient address to be discarded. In other words, it is a
26964 blackholing facility. Use it with care.
26965
26966 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
26967 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
26968 RCPT ACL is to discard just the one recipient address. If there are no
26969 recipients left when the message's data is received, the DATA ACL is not
26970 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
26971 remaining recipients. The &"discard"& return is not permitted for the
26972 &%acl_smtp_predata%& ACL.
26973
26974
26975 .cindex "&[local_scan()]& function" "when all recipients discarded"
26976 The &[local_scan()]& function is always run, even if there are no remaining
26977 recipients; it may create new recipients.
26978
26979
26980
26981 .section "Unset ACL options" "SECID197"
26982 .cindex "&ACL;" "unset options"
26983 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
26984 all the same. &*Note*&: These defaults apply only when the relevant ACL is
26985 not defined at all. For any defined ACL, the default action when control
26986 reaches the end of the ACL statements is &"deny"&.
26987
26988 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
26989 these two are ACLs that are used only for their side effects. They cannot be
26990 used to accept or reject anything.
26991
26992 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
26993 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
26994 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
26995 when the ACL is not defined is &"accept"&.
26996
26997 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
26998 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
26999 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27000 messages over an SMTP connection. For an example, see the ACL in the default
27001 configuration file.
27002
27003
27004
27005
27006 .section "Data for message ACLs" "SECID198"
27007 .cindex "&ACL;" "data for message ACL"
27008 .vindex &$domain$&
27009 .vindex &$local_part$&
27010 .vindex &$sender_address$&
27011 .vindex &$sender_host_address$&
27012 .vindex &$smtp_command$&
27013 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27014 that contain information about the host and the message's sender (for example,
27015 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27016 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27017 &$local_part$& are set from the argument address. The entire SMTP command
27018 is available in &$smtp_command$&.
27019
27020 When an ACL for the AUTH parameter of MAIL is running, the variables that
27021 contain information about the host are set, but &$sender_address$& is not yet
27022 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27023 how it is used.
27024
27025 .vindex "&$message_size$&"
27026 The &$message_size$& variable is set to the value of the SIZE parameter on
27027 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27028 that parameter is not given. The value is updated to the true message size by
27029 the time the final DATA ACL is run (after the message data has been
27030 received).
27031
27032 .vindex "&$rcpt_count$&"
27033 .vindex "&$recipients_count$&"
27034 The &$rcpt_count$& variable increases by one for each RCPT command received.
27035 The &$recipients_count$& variable increases by one each time a RCPT command is
27036 accepted, so while an ACL for RCPT is being processed, it contains the number
27037 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27038 &$rcpt_count$& contains the total number of RCPT commands, and
27039 &$recipients_count$& contains the total number of accepted recipients.
27040
27041
27042
27043
27044
27045 .section "Data for non-message ACLs" "SECTdatfornon"
27046 .cindex "&ACL;" "data for non-message ACL"
27047 .vindex &$smtp_command_argument$&
27048 .vindex &$smtp_command$&
27049 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27050 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27051 and the entire SMTP command is available in &$smtp_command$&.
27052 These variables can be tested using a &%condition%& condition. For example,
27053 here is an ACL for use with AUTH, which insists that either the session is
27054 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27055 does not permit authentication methods that use cleartext passwords on
27056 unencrypted connections.
27057 .code
27058 acl_check_auth:
27059   accept encrypted = *
27060   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27061                      {CRAM-MD5}}
27062   deny   message   = TLS encryption or CRAM-MD5 required
27063 .endd
27064 (Another way of applying this restriction is to arrange for the authenticators
27065 that use cleartext passwords not to be advertised when the connection is not
27066 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27067 option to do this.)
27068
27069
27070
27071 .section "Format of an ACL" "SECID199"
27072 .cindex "&ACL;" "format of"
27073 .cindex "&ACL;" "verbs, definition of"
27074 An individual ACL consists of a number of statements. Each statement starts
27075 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27076 Modifiers can change the way the verb operates, define error and log messages,
27077 set variables, insert delays, and vary the processing of accepted messages.
27078
27079 If all the conditions are met, the verb is obeyed. The same condition may be
27080 used (with different arguments) more than once in the same statement. This
27081 provides a means of specifying an &"and"& conjunction between conditions. For
27082 example:
27083 .code
27084 deny  dnslists = list1.example
27085 dnslists = list2.example
27086 .endd
27087 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27088 the conditions and modifiers when it reaches a condition that fails. What
27089 happens then depends on the verb (and in one case, on a special modifier). Not
27090 all the conditions make sense at every testing point. For example, you cannot
27091 test a sender address in the ACL that is run for a VRFY command.
27092
27093
27094 .section "ACL verbs" "SECID200"
27095 The ACL verbs are as follows:
27096
27097 .ilist
27098 .cindex "&%accept%& ACL verb"
27099 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27100 of the conditions are not met, what happens depends on whether &%endpass%&
27101 appears among the conditions (for syntax see below). If the failing condition
27102 is before &%endpass%&, control is passed to the next ACL statement; if it is
27103 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27104 check a RCPT command:
27105 .code
27106 accept domains = +local_domains
27107 endpass
27108 verify = recipient
27109 .endd
27110 If the recipient domain does not match the &%domains%& condition, control
27111 passes to the next statement. If it does match, the recipient is verified, and
27112 the command is accepted if verification succeeds. However, if verification
27113 fails, the ACL yields &"deny"&, because the failing condition is after
27114 &%endpass%&.
27115
27116 The &%endpass%& feature has turned out to be confusing to many people, so its
27117 use is not recommended nowadays. It is always possible to rewrite an ACL so
27118 that &%endpass%& is not needed, and it is no longer used in the default
27119 configuration.
27120
27121 .cindex "&%message%& ACL modifier" "with &%accept%&"
27122 If a &%message%& modifier appears on an &%accept%& statement, its action
27123 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27124 (when an &%accept%& verb either accepts or passes control to the next
27125 statement), &%message%& can be used to vary the message that is sent when an
27126 SMTP command is accepted. For example, in a RCPT ACL you could have:
27127 .display
27128 &`accept  `&<&'some conditions'&>
27129 &`        message = OK, I will allow you through today`&
27130 .endd
27131 You can specify an SMTP response code, optionally followed by an &"extended
27132 response code"& at the start of the message, but the first digit must be the
27133 same as would be sent by default, which is 2 for an &%accept%& verb.
27134
27135 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27136 an error message that is used when access is denied. This behaviour is retained
27137 for backward compatibility, but current &"best practice"& is to avoid the use
27138 of &%endpass%&.
27139
27140
27141 .next
27142 .cindex "&%defer%& ACL verb"
27143 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27144 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27145 &%defer%& is the same as &%deny%&, because there is no way of sending a
27146 temporary error. For a RCPT command, &%defer%& is much the same as using a
27147 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27148 be used in any ACL, and even for a recipient it might be a simpler approach.
27149
27150
27151 .next
27152 .cindex "&%deny%& ACL verb"
27153 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27154 the conditions are not met, control is passed to the next ACL statement. For
27155 example,
27156 .code
27157 deny dnslists = blackholes.mail-abuse.org
27158 .endd
27159 rejects commands from hosts that are on a DNS black list.
27160
27161
27162 .next
27163 .cindex "&%discard%& ACL verb"
27164 &%discard%&: This verb behaves like &%accept%&, except that it returns
27165 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27166 that are concerned with receiving messages. When all the conditions are true,
27167 the sending entity receives a &"success"& response. However, &%discard%& causes
27168 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27169 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27170 message's recipients are discarded. Recipients that are discarded before DATA
27171 do not appear in the log line when the &%received_recipients%& log selector is set.
27172
27173 If the &%log_message%& modifier is set when &%discard%& operates,
27174 its contents are added to the line that is automatically written to the log.
27175 The &%message%& modifier operates exactly as it does for &%accept%&.
27176
27177
27178 .next
27179 .cindex "&%drop%& ACL verb"
27180 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27181 forcibly closed after the 5&'xx'& error message has been sent. For example:
27182 .code
27183 drop   message   = I don't take more than 20 RCPTs
27184        condition = ${if > {$rcpt_count}{20}}
27185 .endd
27186 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27187 The connection is always dropped after sending a 550 response.
27188
27189 .next
27190 .cindex "&%require%& ACL verb"
27191 &%require%&: If all the conditions are met, control is passed to the next ACL
27192 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27193 example, when checking a RCPT command,
27194 .code
27195 require message = Sender did not verify
27196         verify  = sender
27197 .endd
27198 passes control to subsequent statements only if the message's sender can be
27199 verified. Otherwise, it rejects the command. Note the positioning of the
27200 &%message%& modifier, before the &%verify%& condition. The reason for this is
27201 discussed in section &<<SECTcondmodproc>>&.
27202
27203 .next
27204 .cindex "&%warn%& ACL verb"
27205 &%warn%&: If all the conditions are true, a line specified by the
27206 &%log_message%& modifier is written to Exim's main log. Control always passes
27207 to the next ACL statement. If any condition is false, the log line is not
27208 written. If an identical log line is requested several times in the same
27209 message, only one copy is actually written to the log. If you want to force
27210 duplicates to be written, use the &%logwrite%& modifier instead.
27211
27212 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27213 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27214 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27215 first failing condition. There is more about adding header lines in section
27216 &<<SECTaddheadacl>>&.
27217
27218 If any condition on a &%warn%& statement cannot be completed (that is, there is
27219 some sort of defer), the log line specified by &%log_message%& is not written.
27220 This does not include the case of a forced failure from a lookup, which
27221 is considered to be a successful completion. After a defer, no further
27222 conditions or modifiers in the &%warn%& statement are processed. The incident
27223 is logged, and the ACL continues to be processed, from the next statement
27224 onwards.
27225
27226
27227 .vindex "&$acl_verify_message$&"
27228 When one of the &%warn%& conditions is an address verification that fails, the
27229 text of the verification failure message is in &$acl_verify_message$&. If you
27230 want this logged, you must set it up explicitly. For example:
27231 .code
27232 warn   !verify = sender
27233        log_message = sender verify failed: $acl_verify_message
27234 .endd
27235 .endlist
27236
27237 At the end of each ACL there is an implicit unconditional &%deny%&.
27238
27239 As you can see from the examples above, the conditions and modifiers are
27240 written one to a line, with the first one on the same line as the verb, and
27241 subsequent ones on following lines. If you have a very long condition, you can
27242 continue it onto several physical lines by the usual backslash continuation
27243 mechanism. It is conventional to align the conditions vertically.
27244
27245
27246
27247 .section "ACL variables" "SECTaclvariables"
27248 .cindex "&ACL;" "variables"
27249 There are some special variables that can be set during ACL processing. They
27250 can be used to pass information between different ACLs, different invocations
27251 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27252 transports, and filters that are used to deliver a message. The names of these
27253 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27254 an underscore, but the remainder of the name can be any sequence of
27255 alphanumeric characters and underscores that you choose. There is no limit on
27256 the number of ACL variables. The two sets act as follows:
27257 .ilist
27258 The values of those variables whose names begin with &$acl_c$& persist
27259 throughout an SMTP connection. They are never reset. Thus, a value that is set
27260 while receiving one message is still available when receiving the next message
27261 on the same SMTP connection.
27262 .next
27263 The values of those variables whose names begin with &$acl_m$& persist only
27264 while a message is being received. They are reset afterwards. They are also
27265 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27266 .endlist
27267
27268 When a message is accepted, the current values of all the ACL variables are
27269 preserved with the message and are subsequently made available at delivery
27270 time. The ACL variables are set by a modifier called &%set%&. For example:
27271 .code
27272 accept hosts = whatever
27273        set acl_m4 = some value
27274 accept authenticated = *
27275        set acl_c_auth = yes
27276 .endd
27277 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27278 be set. If you want to set a variable without taking any action, you can use a
27279 &%warn%& verb without any other modifiers or conditions.
27280
27281 .oindex &%strict_acl_vars%&
27282 What happens if a syntactically valid but undefined ACL variable is
27283 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27284 false (the default), an empty string is substituted; if it is true, an
27285 error is generated.
27286
27287 Versions of Exim before 4.64 have a limited set of numbered variables, but
27288 their names are compatible, so there is no problem with upgrading.
27289
27290
27291 .section "Condition and modifier processing" "SECTcondmodproc"
27292 .cindex "&ACL;" "conditions; processing"
27293 .cindex "&ACL;" "modifiers; processing"
27294 An exclamation mark preceding a condition negates its result. For example:
27295 .code
27296 deny   domains = *.dom.example
27297       !verify  = recipient
27298 .endd
27299 causes the ACL to return &"deny"& if the recipient domain ends in
27300 &'dom.example'& and the recipient address cannot be verified. Sometimes
27301 negation can be used on the right-hand side of a condition. For example, these
27302 two statements are equivalent:
27303 .code
27304 deny  hosts = !192.168.3.4
27305 deny !hosts =  192.168.3.4
27306 .endd
27307 However, for many conditions (&%verify%& being a good example), only left-hand
27308 side negation of the whole condition is possible.
27309
27310 The arguments of conditions and modifiers are expanded. A forced failure
27311 of an expansion causes a condition to be ignored, that is, it behaves as if the
27312 condition is true. Consider these two statements:
27313 .code
27314 accept  senders = ${lookup{$host_name}lsearch\
27315                   {/some/file}{$value}fail}
27316 accept  senders = ${lookup{$host_name}lsearch\
27317                   {/some/file}{$value}{}}
27318 .endd
27319 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27320 the returned list is searched, but if the lookup fails the behaviour is
27321 different in the two cases. The &%fail%& in the first statement causes the
27322 condition to be ignored, leaving no further conditions. The &%accept%& verb
27323 therefore succeeds. The second statement, however, generates an empty list when
27324 the lookup fails. No sender can match an empty list, so the condition fails,
27325 and therefore the &%accept%& also fails.
27326
27327 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27328 specify actions that are taken as the conditions for a statement are checked;
27329 others specify text for messages that are used when access is denied or a
27330 warning is generated. The &%control%& modifier affects the way an incoming
27331 message is handled.
27332
27333 The positioning of the modifiers in an ACL statement is important, because the
27334 processing of a verb ceases as soon as its outcome is known. Only those
27335 modifiers that have already been encountered will take effect. For example,
27336 consider this use of the &%message%& modifier:
27337 .code
27338 require message = Can't verify sender
27339         verify  = sender
27340         message = Can't verify recipient
27341         verify  = recipient
27342         message = This message cannot be used
27343 .endd
27344 If sender verification fails, Exim knows that the result of the statement is
27345 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27346 so its text is used as the error message. If sender verification succeeds, but
27347 recipient verification fails, the second message is used. If recipient
27348 verification succeeds, the third message becomes &"current"&, but is never used
27349 because there are no more conditions to cause failure.
27350
27351 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27352 modifier that is used, because all the conditions must be true for rejection to
27353 happen. Specifying more than one &%message%& modifier does not make sense, and
27354 the message can even be specified after all the conditions. For example:
27355 .code
27356 deny   hosts = ...
27357       !senders = *@my.domain.example
27358        message = Invalid sender from client host
27359 .endd
27360 The &"deny"& result does not happen until the end of the statement is reached,
27361 by which time Exim has set up the message.
27362
27363
27364
27365 .section "ACL modifiers" "SECTACLmodi"
27366 .cindex "&ACL;" "modifiers; list of"
27367 The ACL modifiers are as follows:
27368
27369 .vlist
27370 .vitem &*add_header*&&~=&~<&'text'&>
27371 This modifier specifies one or more header lines that are to be added to an
27372 incoming message, assuming, of course, that the message is ultimately
27373 accepted. For details, see section &<<SECTaddheadacl>>&.
27374
27375 .vitem &*continue*&&~=&~<&'text'&>
27376 .cindex "&%continue%& ACL modifier"
27377 .cindex "database" "updating in ACL"
27378 This modifier does nothing of itself, and processing of the ACL always
27379 continues with the next condition or modifier. The value of &%continue%& is in
27380 the side effects of expanding its argument. Typically this could be used to
27381 update a database. It is really just a syntactic tidiness, to avoid having to
27382 write rather ugly lines like this:
27383 .display
27384 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27385 .endd
27386 Instead, all you need is
27387 .display
27388 &`continue = `&<&'some expansion'&>
27389 .endd
27390
27391 .vitem &*control*&&~=&~<&'text'&>
27392 .cindex "&%control%& ACL modifier"
27393 This modifier affects the subsequent processing of the SMTP connection or of an
27394 incoming message that is accepted. The effect of the first type of control
27395 lasts for the duration of the connection, whereas the effect of the second type
27396 lasts only until the current message has been received. The message-specific
27397 controls always apply to the whole message, not to individual recipients,
27398 even if the &%control%& modifier appears in a RCPT ACL.
27399
27400 As there are now quite a few controls that can be applied, they are described
27401 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27402 in several different ways. For example:
27403
27404 . ==== As this is a nested list, any displays it contains must be indented
27405 . ==== as otherwise they are too far to the left. That comment applies only
27406 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27407 . ==== way.
27408
27409 .ilist
27410 It can be at the end of an &%accept%& statement:
27411 .code
27412     accept  ...some conditions
27413             control = queue_only
27414 .endd
27415 In this case, the control is applied when this statement yields &"accept"&, in
27416 other words, when the conditions are all true.
27417
27418 .next
27419 It can be in the middle of an &%accept%& statement:
27420 .code
27421     accept  ...some conditions...
27422             control = queue_only
27423             ...some more conditions...
27424 .endd
27425 If the first set of conditions are true, the control is applied, even if the
27426 statement does not accept because one of the second set of conditions is false.
27427 In this case, some subsequent statement must yield &"accept"& for the control
27428 to be relevant.
27429
27430 .next
27431 It can be used with &%warn%& to apply the control, leaving the
27432 decision about accepting or denying to a subsequent verb. For
27433 example:
27434 .code
27435     warn    ...some conditions...
27436             control = freeze
27437     accept  ...
27438 .endd
27439 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27440 &%logwrite%&, so it does not add anything to the message and does not write a
27441 log entry.
27442
27443 .next
27444 If you want to apply a control unconditionally, you can use it with a
27445 &%require%& verb. For example:
27446 .code
27447     require  control = no_multiline_responses
27448 .endd
27449 .endlist
27450
27451 .vitem &*delay*&&~=&~<&'time'&>
27452 .cindex "&%delay%& ACL modifier"
27453 .oindex "&%-bh%&"
27454 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27455 the time interval before proceeding. However, when testing Exim using the
27456 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27457 output instead). The time is given in the usual Exim notation, and the delay
27458 happens as soon as the modifier is processed. In an SMTP session, pending
27459 output is flushed before the delay is imposed.
27460
27461 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27462 example:
27463 .code
27464 deny    ...some conditions...
27465         delay = 30s
27466 .endd
27467 The delay happens if all the conditions are true, before the statement returns
27468 &"deny"&. Compare this with:
27469 .code
27470 deny    delay = 30s
27471         ...some conditions...
27472 .endd
27473 which waits for 30s before processing the conditions. The &%delay%& modifier
27474 can also be used with &%warn%& and together with &%control%&:
27475 .code
27476 warn    ...some conditions...
27477         delay = 2m
27478         control = freeze
27479 accept  ...
27480 .endd
27481
27482 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27483 responses to several commands are no longer buffered and sent in one packet (as
27484 they would normally be) because all output is flushed before imposing the
27485 delay. This optimization is disabled so that a number of small delays do not
27486 appear to the client as one large aggregated delay that might provoke an
27487 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27488 using a &%control%& modifier to set &%no_delay_flush%&.
27489
27490
27491 .vitem &*endpass*&
27492 .cindex "&%endpass%& ACL modifier"
27493 This modifier, which has no argument, is recognized only in &%accept%& and
27494 &%discard%& statements. It marks the boundary between the conditions whose
27495 failure causes control to pass to the next statement, and the conditions whose
27496 failure causes the ACL to return &"deny"&. This concept has proved to be
27497 confusing to some people, so the use of &%endpass%& is no longer recommended as
27498 &"best practice"&. See the description of &%accept%& above for more details.
27499
27500
27501 .vitem &*log_message*&&~=&~<&'text'&>
27502 .cindex "&%log_message%& ACL modifier"
27503 This modifier sets up a message that is used as part of the log message if the
27504 ACL denies access or a &%warn%& statement's conditions are true. For example:
27505 .code
27506 require log_message = wrong cipher suite $tls_in_cipher
27507         encrypted   = DES-CBC3-SHA
27508 .endd
27509 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27510 example:
27511 .display
27512 &`discard `&<&'some conditions'&>
27513 &`        log_message = Discarded $local_part@$domain because...`&
27514 .endd
27515 When access is denied, &%log_message%& adds to any underlying error message
27516 that may exist because of a condition failure. For example, while verifying a
27517 recipient address, a &':fail:'& redirection might have already set up a
27518 message.
27519
27520 The message may be defined before the conditions to which it applies, because
27521 the string expansion does not happen until Exim decides that access is to be
27522 denied. This means that any variables that are set by the condition are
27523 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27524 variables are set after a DNS black list lookup succeeds. If the expansion of
27525 &%log_message%& fails, or if the result is an empty string, the modifier is
27526 ignored.
27527
27528 .vindex "&$acl_verify_message$&"
27529 If you want to use a &%warn%& statement to log the result of an address
27530 verification, you can use &$acl_verify_message$& to include the verification
27531 error message.
27532
27533 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27534 the start of the logged message. If the same warning log message is requested
27535 more than once while receiving  a single email message, only one copy is
27536 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27537 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27538 is logged for a successful &%warn%& statement.
27539
27540 If &%log_message%& is not present and there is no underlying error message (for
27541 example, from the failure of address verification), but &%message%& is present,
27542 the &%message%& text is used for logging rejections. However, if any text for
27543 logging contains newlines, only the first line is logged. In the absence of
27544 both &%log_message%& and &%message%&, a default built-in message is used for
27545 logging rejections.
27546
27547
27548 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27549 .cindex "&%log_reject_target%& ACL modifier"
27550 .cindex "logging in ACL" "specifying which log"
27551 This modifier makes it possible to specify which logs are used for messages
27552 about ACL rejections. Its argument is a colon-separated list of words that can
27553 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27554 may be empty, in which case a rejection is not logged at all. For example, this
27555 ACL fragment writes no logging information when access is denied:
27556 .display
27557 &`deny `&<&'some conditions'&>
27558 &`     log_reject_target =`&
27559 .endd
27560 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27561 permanent and temporary rejections. Its effect lasts for the rest of the
27562 current ACL.
27563
27564
27565 .vitem &*logwrite*&&~=&~<&'text'&>
27566 .cindex "&%logwrite%& ACL modifier"
27567 .cindex "logging in ACL" "immediate"
27568 This modifier writes a message to a log file as soon as it is encountered when
27569 processing an ACL. (Compare &%log_message%&, which, except in the case of
27570 &%warn%& and &%discard%&, is used only if the ACL statement denies
27571 access.) The &%logwrite%& modifier can be used to log special incidents in
27572 ACLs. For example:
27573 .display
27574 &`accept `&<&'some special conditions'&>
27575 &`       control  = freeze`&
27576 &`       logwrite = froze message because ...`&
27577 .endd
27578 By default, the message is written to the main log. However, it may begin
27579 with a colon, followed by a comma-separated list of log names, and then
27580 another colon, to specify exactly which logs are to be written. For
27581 example:
27582 .code
27583 logwrite = :main,reject: text for main and reject logs
27584 logwrite = :panic: text for panic log only
27585 .endd
27586
27587
27588 .vitem &*message*&&~=&~<&'text'&>
27589 .cindex "&%message%& ACL modifier"
27590 This modifier sets up a text string that is expanded and used as a response
27591 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27592 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27593 there is some complication if &%endpass%& is involved; see the description of
27594 &%accept%& for details.)
27595
27596 The expansion of the message happens at the time Exim decides that the ACL is
27597 to end, not at the time it processes &%message%&. If the expansion fails, or
27598 generates an empty string, the modifier is ignored. Here is an example where
27599 &%message%& must be specified first, because the ACL ends with a rejection if
27600 the &%hosts%& condition fails:
27601 .code
27602 require  message = Host not recognized
27603          hosts = 10.0.0.0/8
27604 .endd
27605 (Once a condition has failed, no further conditions or modifiers are
27606 processed.)
27607
27608 .cindex "SMTP" "error codes"
27609 .oindex "&%smtp_banner%&
27610 For ACLs that are triggered by SMTP commands, the message is returned as part
27611 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27612 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27613 is accepted. In the case of the connect ACL, accepting with a message modifier
27614 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27615 accept message may not contain more than one line (otherwise it will be
27616 truncated at the first newline and a panic logged), and it cannot affect the
27617 EHLO options.
27618
27619 When SMTP is involved, the message may begin with an overriding response code,
27620 consisting of three digits optionally followed by an &"extended response code"&
27621 of the form &'n.n.n'&, each code being followed by a space. For example:
27622 .code
27623 deny  message = 599 1.2.3 Host not welcome
27624       hosts = 192.168.34.0/24
27625 .endd
27626 The first digit of the supplied response code must be the same as would be sent
27627 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27628 access, but for the predata ACL, note that the default success code is 354, not
27629 2&'xx'&.
27630
27631 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27632 the message modifier cannot override the 221 response code.
27633
27634 The text in a &%message%& modifier is literal; any quotes are taken as
27635 literals, but because the string is expanded, backslash escapes are processed
27636 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27637 response.
27638
27639 .vindex "&$acl_verify_message$&"
27640 .new
27641 For ACLs that are called by an &%acl =%& ACL condition, the message is
27642 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27643 .wen
27644
27645 If &%message%& is used on a statement that verifies an address, the message
27646 specified overrides any message that is generated by the verification process.
27647 However, the original message is available in the variable
27648 &$acl_verify_message$&, so you can incorporate it into your message if you
27649 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27650 routers to be passed back as part of the SMTP response, you should either not
27651 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27652
27653 For compatibility with previous releases of Exim, a &%message%& modifier that
27654 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27655 modifier, but this usage is now deprecated. However, &%message%& acts only when
27656 all the conditions are true, wherever it appears in an ACL command, whereas
27657 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27658 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27659 effect.
27660
27661
27662 .vitem &*remove_header*&&~=&~<&'text'&>
27663 This modifier specifies one or more header names in a colon-separated list
27664  that are to be removed from an incoming message, assuming, of course, that
27665 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27666
27667
27668 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27669 .cindex "&%set%& ACL modifier"
27670 This modifier puts a value into one of the ACL variables (see section
27671 &<<SECTaclvariables>>&).
27672
27673
27674 .vitem &*udpsend*&&~=&~<&'parameters'&>
27675 This modifier sends a UDP packet, for purposes such as statistics
27676 collection or behaviour monitoring. The parameters are expanded, and
27677 the result of the expansion must be a colon-separated list consisting
27678 of a destination server, port number, and the packet contents. The
27679 server can be specified as a host name or IPv4 or IPv6 address. The
27680 separator can be changed with the usual angle bracket syntax. For
27681 example, you might want to collect information on which hosts connect
27682 when:
27683 .code
27684 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27685              $tod_zulu $sender_host_address
27686 .endd
27687 .endlist
27688
27689
27690
27691
27692 .section "Use of the control modifier" "SECTcontrols"
27693 .cindex "&%control%& ACL modifier"
27694 The &%control%& modifier supports the following settings:
27695
27696 .vlist
27697 .vitem &*control&~=&~allow_auth_unadvertised*&
27698 This modifier allows a client host to use the SMTP AUTH command even when it
27699 has not been advertised in response to EHLO. Furthermore, because there are
27700 apparently some really broken clients that do this, Exim will accept AUTH after
27701 HELO (rather than EHLO) when this control is set. It should be used only if you
27702 really need it, and you should limit its use to those broken clients that do
27703 not work without it. For example:
27704 .code
27705 warn hosts   = 192.168.34.25
27706      control = allow_auth_unadvertised
27707 .endd
27708 Normally, when an Exim server receives an AUTH command, it checks the name of
27709 the authentication mechanism that is given in the command to ensure that it
27710 matches an advertised mechanism. When this control is set, the check that a
27711 mechanism has been advertised is bypassed. Any configured mechanism can be used
27712 by the client. This control is permitted only in the connection and HELO ACLs.
27713
27714
27715 .vitem &*control&~=&~caseful_local_part*& &&&
27716        &*control&~=&~caselower_local_part*&
27717 .cindex "&ACL;" "case of local part in"
27718 .cindex "case of local parts"
27719 .vindex "&$local_part$&"
27720 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27721 (that is, during RCPT processing). By default, the contents of &$local_part$&
27722 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27723 any uppercase letters in the original local part are restored in &$local_part$&
27724 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27725 is encountered.
27726
27727 These controls affect only the current recipient. Moreover, they apply only to
27728 local part handling that takes place directly in the ACL (for example, as a key
27729 in lookups). If a test to verify the recipient is obeyed, the case-related
27730 handling of the local part during the verification is controlled by the router
27731 configuration (see the &%caseful_local_part%& generic router option).
27732
27733 This facility could be used, for example, to add a spam score to local parts
27734 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27735 spam score:
27736 .code
27737 warn  control = caseful_local_part
27738       set acl_m4 = ${eval:\
27739                      $acl_m4 + \
27740                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27741                     }
27742       control = caselower_local_part
27743 .endd
27744 Notice that we put back the lower cased version afterwards, assuming that
27745 is what is wanted for subsequent tests.
27746
27747
27748 .vitem &*control&~=&~cutthrough_delivery*&
27749 .cindex "&ACL;" "cutthrough routing"
27750 .cindex "cutthrough" "requesting"
27751 This option requests delivery be attempted while the item is being received.
27752 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27753 from one SMTP connection to another.  If a recipient-verify callout connection is
27754 requested in the same ACL it is held open and used for the data, otherwise one is made
27755 after the ACL completes.
27756
27757 Note that routers are used in verify mode,
27758 and cannot depend on content of received headers.
27759 Note also that headers cannot be
27760 modified by any of the post-data ACLs (DATA, MIME and DKIM).
27761 Headers may be modified by routers (subject to the above) and transports.
27762
27763 Cutthrough delivery is not supported via transport-filters or when DKIM signing
27764 of outgoing messages is done, because it sends data to the ultimate destination
27765 before the entire message has been received from the source.
27766
27767 Should the ultimate destination system positively accept or reject the mail,
27768 a corresponding indication is given to the source system and nothing is queued.
27769 If there is a temporary error the item is queued for later delivery in the
27770 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27771 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27772 line.
27773
27774 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27775 sender when the destination system is doing content-scan based rejection.
27776
27777
27778 .vitem &*control&~=&~debug/*&<&'options'&>
27779 .cindex "&ACL;" "enabling debug logging"
27780 .cindex "debugging" "enabling from an ACL"
27781 This control turns on debug logging, almost as though Exim had been invoked
27782 with &`-d`&, with the output going to a new logfile, by default called
27783 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27784 may access any variables already defined.  The logging may be adjusted with
27785 the &'opts'& option, which takes the same values as the &`-d`& command-line
27786 option.  Some examples (which depend on variables that don't exist in all
27787 contexts):
27788 .code
27789       control = debug
27790       control = debug/tag=.$sender_host_address
27791       control = debug/opts=+expand+acl
27792       control = debug/tag=.$message_exim_id/opts=+expand
27793 .endd
27794
27795
27796 .vitem &*control&~=&~dkim_disable_verify*&
27797 .cindex "disable DKIM verify"
27798 .cindex "DKIM" "disable verify"
27799 This control turns off DKIM verification processing entirely.  For details on
27800 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27801
27802
27803 .vitem &*control&~=&~dscp/*&<&'value'&>
27804 .cindex "&ACL;" "setting DSCP value"
27805 .cindex "DSCP" "inbound"
27806 This option causes the DSCP value associated with the socket for the inbound
27807 connection to be adjusted to a given value, given as one of a number of fixed
27808 strings or to numeric value.
27809 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27810 Common values include &`throughput`&, &`mincost`&, and on newer systems
27811 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27812
27813 The outbound packets from Exim will be marked with this value in the header
27814 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27815 that these values will have any effect, not be stripped by networking
27816 equipment, or do much of anything without cooperation with your Network
27817 Engineer and those of all network operators between the source and destination.
27818
27819
27820 .vitem &*control&~=&~enforce_sync*& &&&
27821        &*control&~=&~no_enforce_sync*&
27822 .cindex "SMTP" "synchronization checking"
27823 .cindex "synchronization checking in SMTP"
27824 These controls make it possible to be selective about when SMTP synchronization
27825 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27826 state of the switch (it is true by default). See the description of this option
27827 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27828
27829 The effect of these two controls lasts for the remainder of the SMTP
27830 connection. They can appear in any ACL except the one for the non-SMTP
27831 messages. The most straightforward place to put them is in the ACL defined by
27832 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27833 before the first synchronization check. The expected use is to turn off the
27834 synchronization checks for badly-behaved hosts that you nevertheless need to
27835 work with.
27836
27837
27838 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27839 .cindex "fake defer"
27840 .cindex "defer, fake"
27841 This control works in exactly the same way as &%fakereject%& (described below)
27842 except that it causes an SMTP 450 response after the message data instead of a
27843 550 response. You must take care when using &%fakedefer%& because it causes the
27844 messages to be duplicated when the sender retries. Therefore, you should not
27845 use &%fakedefer%& if the message is to be delivered normally.
27846
27847 .vitem &*control&~=&~fakereject/*&<&'message'&>
27848 .cindex "fake rejection"
27849 .cindex "rejection, fake"
27850 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27851 words, only when an SMTP message is being received. If Exim accepts the
27852 message, instead the final 250 response, a 550 rejection message is sent.
27853 However, Exim proceeds to deliver the message as normal. The control applies
27854 only to the current message, not to any subsequent ones that may be received in
27855 the same SMTP connection.
27856
27857 The text for the 550 response is taken from the &%control%& modifier. If no
27858 message is supplied, the following is used:
27859 .code
27860 550-Your message has been rejected but is being
27861 550-kept for evaluation.
27862 550-If it was a legitimate message, it may still be
27863 550 delivered to the target recipient(s).
27864 .endd
27865 This facility should be used with extreme caution.
27866
27867 .vitem &*control&~=&~freeze*&
27868 .cindex "frozen messages" "forcing in ACL"
27869 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27870 other words, only when a message is being received. If the message is accepted,
27871 it is placed on Exim's queue and frozen. The control applies only to the
27872 current message, not to any subsequent ones that may be received in the same
27873 SMTP connection.
27874
27875 This modifier can optionally be followed by &`/no_tell`&. If the global option
27876 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27877 is told about the freezing), provided all the &*control=freeze*& modifiers that
27878 are obeyed for the current message have the &`/no_tell`& option.
27879
27880 .vitem &*control&~=&~no_delay_flush*&
27881 .cindex "SMTP" "output flushing, disabling for delay"
27882 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27883 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27884 use. This control, as long as it is encountered before the &%delay%& modifier,
27885 disables such output flushing.
27886
27887 .vitem &*control&~=&~no_callout_flush*&
27888 .cindex "SMTP" "output flushing, disabling for callout"
27889 Exim normally flushes SMTP output before performing a callout in an ACL, to
27890 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27891 use. This control, as long as it is encountered before the &%verify%& condition
27892 that causes the callout, disables such output flushing.
27893
27894 .vitem &*control&~=&~no_mbox_unspool*&
27895 This control is available when Exim is compiled with the content scanning
27896 extension. Content scanning may require a copy of the current message, or parts
27897 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27898 or spam scanner. Normally, such copies are deleted when they are no longer
27899 needed. If this control is set, the copies are not deleted. The control applies
27900 only to the current message, not to any subsequent ones that may be received in
27901 the same SMTP connection. It is provided for debugging purposes and is unlikely
27902 to be useful in production.
27903
27904 .vitem &*control&~=&~no_multiline_responses*&
27905 .cindex "multiline responses, suppressing"
27906 This control is permitted for any ACL except the one for non-SMTP messages.
27907 It seems that there are broken clients in use that cannot handle multiline
27908 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27909
27910 If this control is set, multiline SMTP responses from ACL rejections are
27911 suppressed. One way of doing this would have been to put out these responses as
27912 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27913 (&"use multiline responses for more"& it says &-- ha!), and some of the
27914 responses might get close to that. So this facility, which is after all only a
27915 sop to broken clients, is implemented by doing two very easy things:
27916
27917 .ilist
27918 Extra information that is normally output as part of a rejection caused by
27919 sender verification failure is omitted. Only the final line (typically &"sender
27920 verification failed"&) is sent.
27921 .next
27922 If a &%message%& modifier supplies a multiline response, only the first
27923 line is output.
27924 .endlist
27925
27926 The setting of the switch can, of course, be made conditional on the
27927 calling host. Its effect lasts until the end of the SMTP connection.
27928
27929 .vitem &*control&~=&~no_pipelining*&
27930 .cindex "PIPELINING" "suppressing advertising"
27931 This control turns off the advertising of the PIPELINING extension to SMTP in
27932 the current session. To be useful, it must be obeyed before Exim sends its
27933 response to an EHLO command. Therefore, it should normally appear in an ACL
27934 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27935 &%pipelining_advertise_hosts%&.
27936
27937 .vitem &*control&~=&~queue_only*&
27938 .oindex "&%queue_only%&"
27939 .cindex "queueing incoming messages"
27940 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27941 other words, only when a message is being received. If the message is accepted,
27942 it is placed on Exim's queue and left there for delivery by a subsequent queue
27943 runner. No immediate delivery process is started. In other words, it has the
27944 effect as the &%queue_only%& global option. However, the control applies only
27945 to the current message, not to any subsequent ones that may be received in the
27946 same SMTP connection.
27947
27948 .vitem &*control&~=&~submission/*&<&'options'&>
27949 .cindex "message" "submission"
27950 .cindex "submission mode"
27951 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27952 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
27953 the current message is a submission from a local MUA. In this case, Exim
27954 operates in &"submission mode"&, and applies certain fixups to the message if
27955 necessary. For example, it adds a &'Date:'& header line if one is not present.
27956 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
27957 late (the message has already been created).
27958
27959 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
27960 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
27961 submission mode; the available options for this control are described there.
27962 The control applies only to the current message, not to any subsequent ones
27963 that may be received in the same SMTP connection.
27964
27965 .vitem &*control&~=&~suppress_local_fixups*&
27966 .cindex "submission fixups, suppressing"
27967 This control applies to locally submitted (non TCP/IP) messages, and is the
27968 complement of &`control = submission`&. It disables the fixups that are
27969 normally applied to locally-submitted messages. Specifically:
27970
27971 .ilist
27972 Any &'Sender:'& header line is left alone (in this respect, it is a
27973 dynamic version of &%local_sender_retain%&).
27974 .next
27975 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
27976 .next
27977 There is no check that &'From:'& corresponds to the actual sender.
27978 .endlist ilist
27979
27980 This control may be useful when a remotely-originated message is accepted,
27981 passed to some scanning program, and then re-submitted for delivery. It can be
27982 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27983 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
27984 data is read.
27985
27986 &*Note:*& This control applies only to the current message, not to any others
27987 that are being submitted at the same time using &%-bs%& or &%-bS%&.
27988 .endlist vlist
27989
27990
27991 .section "Summary of message fixup control" "SECTsummesfix"
27992 All four possibilities for message fixups can be specified:
27993
27994 .ilist
27995 Locally submitted, fixups applied: the default.
27996 .next
27997 Locally submitted, no fixups applied: use
27998 &`control = suppress_local_fixups`&.
27999 .next
28000 Remotely submitted, no fixups applied: the default.
28001 .next
28002 Remotely submitted, fixups applied: use &`control = submission`&.
28003 .endlist
28004
28005
28006
28007 .section "Adding header lines in ACLs" "SECTaddheadacl"
28008 .cindex "header lines" "adding in an ACL"
28009 .cindex "header lines" "position of added lines"
28010 .cindex "&%add_header%& ACL modifier"
28011 The &%add_header%& modifier can be used to add one or more extra header lines
28012 to an incoming message, as in this example:
28013 .code
28014 warn dnslists = sbl.spamhaus.org : \
28015                 dialup.mail-abuse.org
28016      add_header = X-blacklisted-at: $dnslist_domain
28017 .endd
28018 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28019 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28020 receiving a message). The message must ultimately be accepted for
28021 &%add_header%& to have any significant effect. You can use &%add_header%& with
28022 any ACL verb, including &%deny%& (though this is potentially useful only in a
28023 RCPT ACL).
28024
28025 Headers will not be added to the message if the modifier is used in
28026 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28027
28028 Leading and trailing newlines are removed from
28029 the data for the &%add_header%& modifier; if it then
28030 contains one or more newlines that
28031 are not followed by a space or a tab, it is assumed to contain multiple header
28032 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28033 front of any line that is not a valid header line.
28034
28035 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28036 They are added to the message before processing the DATA and MIME ACLs.
28037 However, if an identical header line is requested more than once, only one copy
28038 is actually added to the message. Further header lines may be accumulated
28039 during the DATA and MIME ACLs, after which they are added to the message, again
28040 with duplicates suppressed. Thus, it is possible to add two identical header
28041 lines to an SMTP message, but only if one is added before DATA and one after.
28042 In the case of non-SMTP messages, new headers are accumulated during the
28043 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28044 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28045 are included in the entry that is written to the reject log.
28046
28047 .cindex "header lines" "added; visibility of"
28048 Header lines are not visible in string expansions
28049 of message headers
28050 until they are added to the
28051 message. It follows that header lines defined in the MAIL, RCPT, and predata
28052 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28053 header lines that are added by the DATA or MIME ACLs are not visible in those
28054 ACLs. Because of this restriction, you cannot use header lines as a way of
28055 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28056 this, you can use ACL variables, as described in section
28057 &<<SECTaclvariables>>&.
28058
28059 The list of headers yet to be added is given by the &%$headers_added%& variable.
28060
28061 The &%add_header%& modifier acts immediately as it is encountered during the
28062 processing of an ACL. Notice the difference between these two cases:
28063 .display
28064 &`accept add_header = ADDED: some text`&
28065 &`       `&<&'some condition'&>
28066
28067 &`accept `&<&'some condition'&>
28068 &`       add_header = ADDED: some text`&
28069 .endd
28070 In the first case, the header line is always added, whether or not the
28071 condition is true. In the second case, the header line is added only if the
28072 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28073 ACL statement. All those that are encountered before a condition fails are
28074 honoured.
28075
28076 .cindex "&%warn%& ACL verb"
28077 For compatibility with previous versions of Exim, a &%message%& modifier for a
28078 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28079 effect only if all the conditions are true, even if it appears before some of
28080 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28081 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28082 are present on a &%warn%& verb, both are processed according to their
28083 specifications.
28084
28085 By default, new header lines are added to a message at the end of the existing
28086 header lines. However, you can specify that any particular header line should
28087 be added right at the start (before all the &'Received:'& lines), immediately
28088 after the first block of &'Received:'& lines, or immediately before any line
28089 that is not a &'Received:'& or &'Resent-something:'& header.
28090
28091 This is done by specifying &":at_start:"&, &":after_received:"&, or
28092 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28093 header line, respectively. (Header text cannot start with a colon, as there has
28094 to be a header name first.) For example:
28095 .code
28096 warn add_header = \
28097        :after_received:X-My-Header: something or other...
28098 .endd
28099 If more than one header line is supplied in a single &%add_header%& modifier,
28100 each one is treated independently and can therefore be placed differently. If
28101 you add more than one line at the start, or after the Received: block, they end
28102 up in reverse order.
28103
28104 &*Warning*&: This facility currently applies only to header lines that are
28105 added in an ACL. It does NOT work for header lines that are added in a
28106 system filter or in a router or transport.
28107
28108
28109
28110 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28111 .cindex "header lines" "removing in an ACL"
28112 .cindex "header lines" "position of removed lines"
28113 .cindex "&%remove_header%& ACL modifier"
28114 The &%remove_header%& modifier can be used to remove one or more header lines
28115 from an incoming message, as in this example:
28116 .code
28117 warn   message        = Remove internal headers
28118        remove_header  = x-route-mail1 : x-route-mail2
28119 .endd
28120 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28121 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28122 receiving a message). The message must ultimately be accepted for
28123 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28124 with any ACL verb, including &%deny%&, though this is really not useful for
28125 any verb that doesn't result in a delivered message.
28126
28127 Headers will not be removed to the message if the modifier is used in
28128 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28129
28130 More than one header can be removed at the same time by using a colon separated
28131 list of header names. The header matching is case insensitive. Wildcards are
28132 not permitted, nor is list expansion performed, so you cannot use hostlists to
28133 create a list of headers, however both connection and message variable expansion
28134 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28135 .code
28136 warn   hosts           = +internal_hosts
28137        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28138 warn   message         = Remove internal headers
28139        remove_header   = $acl_c_ihdrs
28140 .endd
28141 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28142 They are removed from the message before processing the DATA and MIME ACLs.
28143 There is no harm in attempting to remove the same header twice nor is removing
28144 a non-existent header. Further header lines to be removed may be accumulated
28145 during the DATA and MIME ACLs, after which they are removed from the message,
28146 if present. In the case of non-SMTP messages, headers to be removed are
28147 accumulated during the non-SMTP ACLs, and are removed from the message after
28148 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28149 ACL, there really is no effect because there is no logging of what headers
28150 would have been removed.
28151
28152 .cindex "header lines" "removed; visibility of"
28153 Header lines are not visible in string expansions until the DATA phase when it
28154 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28155 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28156 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28157 this restriction, you cannot use header lines as a way of controlling data
28158 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28159 you should instead use ACL variables, as described in section
28160 &<<SECTaclvariables>>&.
28161
28162 The &%remove_header%& modifier acts immediately as it is encountered during the
28163 processing of an ACL. Notice the difference between these two cases:
28164 .display
28165 &`accept remove_header = X-Internal`&
28166 &`       `&<&'some condition'&>
28167
28168 &`accept `&<&'some condition'&>
28169 &`       remove_header = X-Internal`&
28170 .endd
28171 In the first case, the header line is always removed, whether or not the
28172 condition is true. In the second case, the header line is removed only if the
28173 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28174 same ACL statement. All those that are encountered before a condition fails
28175 are honoured.
28176
28177 &*Warning*&: This facility currently applies only to header lines that are
28178 present during ACL processing. It does NOT remove header lines that are added
28179 in a system filter or in a router or transport.
28180
28181
28182
28183
28184 .section "ACL conditions" "SECTaclconditions"
28185 .cindex "&ACL;" "conditions; list of"
28186 Some of the conditions listed in this section are available only when Exim is
28187 compiled with the content-scanning extension. They are included here briefly
28188 for completeness. More detailed descriptions can be found in the discussion on
28189 content scanning in chapter &<<CHAPexiscan>>&.
28190
28191 Not all conditions are relevant in all circumstances. For example, testing
28192 senders and recipients does not make sense in an ACL that is being run as the
28193 result of the arrival of an ETRN command, and checks on message headers can be
28194 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28195 can use the same condition (with different parameters) more than once in the
28196 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28197 The conditions are as follows:
28198
28199
28200 .vlist
28201 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28202 .cindex "&ACL;" "nested"
28203 .cindex "&ACL;" "indirect"
28204 .cindex "&ACL;" "arguments"
28205 .cindex "&%acl%& ACL condition"
28206 The possible values of the argument are the same as for the
28207 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28208 &"accept"& the condition is true; if it returns &"deny"& the condition is
28209 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28210 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28211 condition false. This means that further processing of the &%warn%& verb
28212 ceases, but processing of the ACL continues.
28213
28214 If the argument is a named ACL, up to nine space-separated optional values
28215 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28216 and $acl_narg is set to the count of values.
28217 Previous values of these variables are restored after the call returns.
28218 The name and values are expanded separately.
28219
28220 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28221 the connection is dropped. If it returns &"discard"&, the verb must be
28222 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28223 conditions are tested.
28224
28225 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28226 loops. This condition allows you to use different ACLs in different
28227 circumstances. For example, different ACLs can be used to handle RCPT commands
28228 for different local users or different local domains.
28229
28230 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28231 .cindex "&%authenticated%& ACL condition"
28232 .cindex "authentication" "ACL checking"
28233 .cindex "&ACL;" "testing for authentication"
28234 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28235 the name of the authenticator is tested against the list. To test for
28236 authentication by any authenticator, you can set
28237 .code
28238 authenticated = *
28239 .endd
28240
28241 .vitem &*condition&~=&~*&<&'string'&>
28242 .cindex "&%condition%& ACL condition"
28243 .cindex "customizing" "ACL condition"
28244 .cindex "&ACL;" "customized test"
28245 .cindex "&ACL;" "testing, customized"
28246 This feature allows you to make up custom conditions. If the result of
28247 expanding the string is an empty string, the number zero, or one of the strings
28248 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28249 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28250 any other value, some error is assumed to have occurred, and the ACL returns
28251 &"defer"&. However, if the expansion is forced to fail, the condition is
28252 ignored. The effect is to treat it as true, whether it is positive or
28253 negative.
28254
28255 .vitem &*decode&~=&~*&<&'location'&>
28256 .cindex "&%decode%& ACL condition"
28257 This condition is available only when Exim is compiled with the
28258 content-scanning extension, and it is allowed only in the ACL defined by
28259 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28260 If all goes well, the condition is true. It is false only if there are
28261 problems such as a syntax error or a memory shortage. For more details, see
28262 chapter &<<CHAPexiscan>>&.
28263
28264 .vitem &*demime&~=&~*&<&'extension&~list'&>
28265 .cindex "&%demime%& ACL condition"
28266 This condition is available only when Exim is compiled with the
28267 content-scanning extension. Its use is described in section
28268 &<<SECTdemimecond>>&.
28269
28270 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28271 .cindex "&%dnslists%& ACL condition"
28272 .cindex "DNS list" "in ACL"
28273 .cindex "black list (DNS)"
28274 .cindex "&ACL;" "testing a DNS list"
28275 This condition checks for entries in DNS black lists. These are also known as
28276 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28277 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28278 different variants of this condition to describe briefly here. See sections
28279 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28280
28281 .vitem &*domains&~=&~*&<&'domain&~list'&>
28282 .cindex "&%domains%& ACL condition"
28283 .cindex "domain" "ACL checking"
28284 .cindex "&ACL;" "testing a recipient domain"
28285 .vindex "&$domain_data$&"
28286 This condition is relevant only after a RCPT command. It checks that the domain
28287 of the recipient address is in the domain list. If percent-hack processing is
28288 enabled, it is done before this test is done. If the check succeeds with a
28289 lookup, the result of the lookup is placed in &$domain_data$& until the next
28290 &%domains%& test.
28291
28292 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28293 use &%domains%& in a DATA ACL.
28294
28295
28296 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28297 .cindex "&%encrypted%& ACL condition"
28298 .cindex "encryption" "checking in an ACL"
28299 .cindex "&ACL;" "testing for encryption"
28300 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28301 name of the cipher suite in use is tested against the list. To test for
28302 encryption without testing for any specific cipher suite(s), set
28303 .code
28304 encrypted = *
28305 .endd
28306
28307
28308 .vitem &*hosts&~=&~*&<&'host&~list'&>
28309 .cindex "&%hosts%& ACL condition"
28310 .cindex "host" "ACL checking"
28311 .cindex "&ACL;" "testing the client host"
28312 This condition tests that the calling host matches the host list. If you have
28313 name lookups or wildcarded host names and IP addresses in the same host list,
28314 you should normally put the IP addresses first. For example, you could have:
28315 .code
28316 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28317 .endd
28318 The lookup in this example uses the host name for its key. This is implied by
28319 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28320 and it wouldn't matter which way round you had these two items.)
28321
28322 The reason for the problem with host names lies in the left-to-right way that
28323 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28324 but when it reaches an item that requires a host name, it fails if it cannot
28325 find a host name to compare with the pattern. If the above list is given in the
28326 opposite order, the &%accept%& statement fails for a host whose name cannot be
28327 found, even if its IP address is 10.9.8.7.
28328
28329 If you really do want to do the name check first, and still recognize the IP
28330 address even if the name lookup fails, you can rewrite the ACL like this:
28331 .code
28332 accept hosts = dbm;/etc/friendly/hosts
28333 accept hosts = 10.9.8.7
28334 .endd
28335 The default action on failing to find the host name is to assume that the host
28336 is not in the list, so the first &%accept%& statement fails. The second
28337 statement can then check the IP address.
28338
28339 .vindex "&$host_data$&"
28340 If a &%hosts%& condition is satisfied by means of a lookup, the result
28341 of the lookup is made available in the &$host_data$& variable. This
28342 allows you, for example, to set up a statement like this:
28343 .code
28344 deny  hosts = net-lsearch;/some/file
28345 message = $host_data
28346 .endd
28347 which gives a custom error message for each denied host.
28348
28349 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28350 .cindex "&%local_parts%& ACL condition"
28351 .cindex "local part" "ACL checking"
28352 .cindex "&ACL;" "testing a local part"
28353 .vindex "&$local_part_data$&"
28354 This condition is relevant only after a RCPT command. It checks that the local
28355 part of the recipient address is in the list. If percent-hack processing is
28356 enabled, it is done before this test. If the check succeeds with a lookup, the
28357 result of the lookup is placed in &$local_part_data$&, which remains set until
28358 the next &%local_parts%& test.
28359
28360 .vitem &*malware&~=&~*&<&'option'&>
28361 .cindex "&%malware%& ACL condition"
28362 .cindex "&ACL;" "virus scanning"
28363 .cindex "&ACL;" "scanning for viruses"
28364 This condition is available only when Exim is compiled with the
28365 content-scanning extension. It causes the incoming message to be scanned for
28366 viruses. For details, see chapter &<<CHAPexiscan>>&.
28367
28368 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28369 .cindex "&%mime_regex%& ACL condition"
28370 .cindex "&ACL;" "testing by regex matching"
28371 This condition is available only when Exim is compiled with the
28372 content-scanning extension, and it is allowed only in the ACL defined by
28373 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28374 with any of the regular expressions. For details, see chapter
28375 &<<CHAPexiscan>>&.
28376
28377 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28378 .cindex "rate limiting"
28379 This condition can be used to limit the rate at which a user or host submits
28380 messages. Details are given in section &<<SECTratelimiting>>&.
28381
28382 .vitem &*recipients&~=&~*&<&'address&~list'&>
28383 .cindex "&%recipients%& ACL condition"
28384 .cindex "recipient" "ACL checking"
28385 .cindex "&ACL;" "testing a recipient"
28386 This condition is relevant only after a RCPT command. It checks the entire
28387 recipient address against a list of recipients.
28388
28389 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28390 .cindex "&%regex%& ACL condition"
28391 .cindex "&ACL;" "testing by regex matching"
28392 This condition is available only when Exim is compiled with the
28393 content-scanning extension, and is available only in the DATA, MIME, and
28394 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28395 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28396
28397 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28398 .cindex "&%sender_domains%& ACL condition"
28399 .cindex "sender" "ACL checking"
28400 .cindex "&ACL;" "testing a sender domain"
28401 .vindex "&$domain$&"
28402 .vindex "&$sender_address_domain$&"
28403 This condition tests the domain of the sender of the message against the given
28404 domain list. &*Note*&: The domain of the sender address is in
28405 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28406 of this condition. This is an exception to the general rule for testing domain
28407 lists. It is done this way so that, if this condition is used in an ACL for a
28408 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28409 influence the sender checking.
28410
28411 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28412 relaying, because sender addresses are easily, and commonly, forged.
28413
28414 .vitem &*senders&~=&~*&<&'address&~list'&>
28415 .cindex "&%senders%& ACL condition"
28416 .cindex "sender" "ACL checking"
28417 .cindex "&ACL;" "testing a sender"
28418 This condition tests the sender of the message against the given list. To test
28419 for a bounce message, which has an empty sender, set
28420 .code
28421 senders = :
28422 .endd
28423 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28424 relaying, because sender addresses are easily, and commonly, forged.
28425
28426 .vitem &*spam&~=&~*&<&'username'&>
28427 .cindex "&%spam%& ACL condition"
28428 .cindex "&ACL;" "scanning for spam"
28429 This condition is available only when Exim is compiled with the
28430 content-scanning extension. It causes the incoming message to be scanned by
28431 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28432
28433 .vitem &*verify&~=&~certificate*&
28434 .cindex "&%verify%& ACL condition"
28435 .cindex "TLS" "client certificate verification"
28436 .cindex "certificate" "verification of client"
28437 .cindex "&ACL;" "certificate verification"
28438 .cindex "&ACL;" "testing a TLS certificate"
28439 This condition is true in an SMTP session if the session is encrypted, and a
28440 certificate was received from the client, and the certificate was verified. The
28441 server requests a certificate only if the client matches &%tls_verify_hosts%&
28442 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28443
28444 .vitem &*verify&~=&~csa*&
28445 .cindex "CSA verification"
28446 This condition checks whether the sending host (the client) is authorized to
28447 send email. Details of how this works are given in section
28448 &<<SECTverifyCSA>>&.
28449
28450 .vitem &*verify&~=&~header_names_ascii*&
28451 .cindex "&%verify%& ACL condition"
28452 .cindex "&ACL;" "verifying header names only ASCII"
28453 .cindex "header lines" "verifying header names only ASCII"
28454 .cindex "verifying" "header names only ASCII"
28455 This condition is relevant only in an ACL that is run after a message has been
28456 received, that is, in an ACL specified by &%acl_smtp_data%& or
28457 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28458 there are no non-ASCII characters, also excluding control characters.  The
28459 allowable characters are decimal ASCII values 33 through 126.
28460
28461 Exim itself will handle headers with non-ASCII characters, but it can cause
28462 problems for downstream applications, so this option will allow their
28463 detection and rejection in the DATA ACL's.
28464
28465 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28466 .cindex "&%verify%& ACL condition"
28467 .cindex "&ACL;" "verifying sender in the header"
28468 .cindex "header lines" "verifying the sender in"
28469 .cindex "sender" "verifying in header"
28470 .cindex "verifying" "sender in header"
28471 This condition is relevant only in an ACL that is run after a message has been
28472 received, that is, in an ACL specified by &%acl_smtp_data%& or
28473 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28474 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28475 is loosely thought of as a &"sender"& address (hence the name of the test).
28476 However, an address that appears in one of these headers need not be an address
28477 that accepts bounce messages; only sender addresses in envelopes are required
28478 to accept bounces. Therefore, if you use the callout option on this check, you
28479 might want to arrange for a non-empty address in the MAIL command.
28480
28481 Details of address verification and the options are given later, starting at
28482 section &<<SECTaddressverification>>& (callouts are described in section
28483 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28484 condition to restrict it to bounce messages only:
28485 .code
28486 deny    senders = :
28487         message = A valid sender header is required for bounces
28488        !verify  = header_sender
28489 .endd
28490
28491 .vitem &*verify&~=&~header_syntax*&
28492 .cindex "&%verify%& ACL condition"
28493 .cindex "&ACL;" "verifying header syntax"
28494 .cindex "header lines" "verifying syntax"
28495 .cindex "verifying" "header syntax"
28496 This condition is relevant only in an ACL that is run after a message has been
28497 received, that is, in an ACL specified by &%acl_smtp_data%& or
28498 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28499 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28500 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28501 permitted only in locally generated messages and from hosts that match
28502 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28503 appropriate.
28504
28505 Note that this condition is a syntax check only. However, a common spamming
28506 ploy used to be to send syntactically invalid headers such as
28507 .code
28508 To: @
28509 .endd
28510 and this condition can be used to reject such messages, though they are not as
28511 common as they used to be.
28512
28513 .vitem &*verify&~=&~helo*&
28514 .cindex "&%verify%& ACL condition"
28515 .cindex "&ACL;" "verifying HELO/EHLO"
28516 .cindex "HELO" "verifying"
28517 .cindex "EHLO" "verifying"
28518 .cindex "verifying" "EHLO"
28519 .cindex "verifying" "HELO"
28520 This condition is true if a HELO or EHLO command has been received from the
28521 client host, and its contents have been verified. If there has been no previous
28522 attempt to verify the HELO/EHLO contents, it is carried out when this
28523 condition is encountered. See the description of the &%helo_verify_hosts%& and
28524 &%helo_try_verify_hosts%& options for details of how to request verification
28525 independently of this condition.
28526
28527 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28528 option), this condition is always true.
28529
28530
28531 .vitem &*verify&~=&~not_blind*&
28532 .cindex "verifying" "not blind"
28533 .cindex "bcc recipients, verifying none"
28534 This condition checks that there are no blind (bcc) recipients in the message.
28535 Every envelope recipient must appear either in a &'To:'& header line or in a
28536 &'Cc:'& header line for this condition to be true. Local parts are checked
28537 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28538 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28539 used only in a DATA or non-SMTP ACL.
28540
28541 There are, of course, many legitimate messages that make use of blind (bcc)
28542 recipients. This check should not be used on its own for blocking messages.
28543
28544
28545 .vitem &*verify&~=&~recipient/*&<&'options'&>
28546 .cindex "&%verify%& ACL condition"
28547 .cindex "&ACL;" "verifying recipient"
28548 .cindex "recipient" "verifying"
28549 .cindex "verifying" "recipient"
28550 .vindex "&$address_data$&"
28551 This condition is relevant only after a RCPT command. It verifies the current
28552 recipient. Details of address verification are given later, starting at section
28553 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28554 of &$address_data$& is the last value that was set while routing the address.
28555 This applies even if the verification fails. When an address that is being
28556 verified is redirected to a single address, verification continues with the new
28557 address, and in that case, the subsequent value of &$address_data$& is the
28558 value for the child address.
28559
28560 .vitem &*verify&~=&~reverse_host_lookup*&
28561 .cindex "&%verify%& ACL condition"
28562 .cindex "&ACL;" "verifying host reverse lookup"
28563 .cindex "host" "verifying reverse lookup"
28564 This condition ensures that a verified host name has been looked up from the IP
28565 address of the client host. (This may have happened already if the host name
28566 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28567 Verification ensures that the host name obtained from a reverse DNS lookup, or
28568 one of its aliases, does, when it is itself looked up in the DNS, yield the
28569 original IP address.
28570
28571 If this condition is used for a locally generated message (that is, when there
28572 is no client host involved), it always succeeds.
28573
28574 .vitem &*verify&~=&~sender/*&<&'options'&>
28575 .cindex "&%verify%& ACL condition"
28576 .cindex "&ACL;" "verifying sender"
28577 .cindex "sender" "verifying"
28578 .cindex "verifying" "sender"
28579 This condition is relevant only after a MAIL or RCPT command, or after a
28580 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28581 the message's sender is empty (that is, this is a bounce message), the
28582 condition is true. Otherwise, the sender address is verified.
28583
28584 .vindex "&$address_data$&"
28585 .vindex "&$sender_address_data$&"
28586 If there is data in the &$address_data$& variable at the end of routing, its
28587 value is placed in &$sender_address_data$& at the end of verification. This
28588 value can be used in subsequent conditions and modifiers in the same ACL
28589 statement. It does not persist after the end of the current statement. If you
28590 want to preserve the value for longer, you can save it in an ACL variable.
28591
28592 Details of verification are given later, starting at section
28593 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28594 to avoid doing it more than once per message.
28595
28596 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28597 .cindex "&%verify%& ACL condition"
28598 This is a variation of the previous option, in which a modified address is
28599 verified as a sender.
28600 .endlist
28601
28602
28603
28604 .section "Using DNS lists" "SECTmorednslists"
28605 .cindex "DNS list" "in ACL"
28606 .cindex "black list (DNS)"
28607 .cindex "&ACL;" "testing a DNS list"
28608 In its simplest form, the &%dnslists%& condition tests whether the calling host
28609 is on at least one of a number of DNS lists by looking up the inverted IP
28610 address in one or more DNS domains. (Note that DNS list domains are not mail
28611 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28612 special options instead.) For example, if the calling host's IP
28613 address is 192.168.62.43, and the ACL statement is
28614 .code
28615 deny dnslists = blackholes.mail-abuse.org : \
28616                 dialups.mail-abuse.org
28617 .endd
28618 the following records are looked up:
28619 .code
28620 43.62.168.192.blackholes.mail-abuse.org
28621 43.62.168.192.dialups.mail-abuse.org
28622 .endd
28623 As soon as Exim finds an existing DNS record, processing of the list stops.
28624 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28625 to test that a host is on more than one list (an &"and"& conjunction), you can
28626 use two separate conditions:
28627 .code
28628 deny dnslists = blackholes.mail-abuse.org
28629      dnslists = dialups.mail-abuse.org
28630 .endd
28631 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28632 behaves as if the host does not match the list item, that is, as if the DNS
28633 record does not exist. If there are further items in the DNS list, they are
28634 processed.
28635
28636 This is usually the required action when &%dnslists%& is used with &%deny%&
28637 (which is the most common usage), because it prevents a DNS failure from
28638 blocking mail. However, you can change this behaviour by putting one of the
28639 following special items in the list:
28640 .display
28641 &`+include_unknown `&   behave as if the item is on the list
28642 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28643 &`+defer_unknown   `&   give a temporary error
28644 .endd
28645 .cindex "&`+include_unknown`&"
28646 .cindex "&`+exclude_unknown`&"
28647 .cindex "&`+defer_unknown`&"
28648 Each of these applies to any subsequent items on the list. For example:
28649 .code
28650 deny dnslists = +defer_unknown : foo.bar.example
28651 .endd
28652 Testing the list of domains stops as soon as a match is found. If you want to
28653 warn for one list and block for another, you can use two different statements:
28654 .code
28655 deny  dnslists = blackholes.mail-abuse.org
28656 warn  message  = X-Warn: sending host is on dialups list
28657       dnslists = dialups.mail-abuse.org
28658 .endd
28659 DNS list lookups are cached by Exim for the duration of the SMTP session,
28660 so a lookup based on the IP address is done at most once for any incoming
28661 connection. Exim does not share information between multiple incoming
28662 connections (but your local name server cache should be active).
28663
28664
28665
28666 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28667 .cindex "DNS list" "keyed by explicit IP address"
28668 By default, the IP address that is used in a DNS list lookup is the IP address
28669 of the calling host. However, you can specify another IP address by listing it
28670 after the domain name, introduced by a slash. For example:
28671 .code
28672 deny dnslists = black.list.tld/192.168.1.2
28673 .endd
28674 This feature is not very helpful with explicit IP addresses; it is intended for
28675 use with IP addresses that are looked up, for example, the IP addresses of the
28676 MX hosts or nameservers of an email sender address. For an example, see section
28677 &<<SECTmulkeyfor>>& below.
28678
28679
28680
28681
28682 .section "DNS lists keyed on domain names" "SECID202"
28683 .cindex "DNS list" "keyed by domain name"
28684 There are some lists that are keyed on domain names rather than inverted IP
28685 addresses (see for example the &'domain based zones'& link at
28686 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28687 with these lists. You can change the name that is looked up in a DNS list by
28688 listing it after the domain name, introduced by a slash. For example,
28689 .code
28690 deny  message  = Sender's domain is listed at $dnslist_domain
28691       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28692 .endd
28693 This particular example is useful only in ACLs that are obeyed after the
28694 RCPT or DATA commands, when a sender address is available. If (for
28695 example) the message's sender is &'user@tld.example'& the name that is looked
28696 up by this example is
28697 .code
28698 tld.example.dsn.rfc-ignorant.org
28699 .endd
28700 A single &%dnslists%& condition can contain entries for both names and IP
28701 addresses. For example:
28702 .code
28703 deny dnslists = sbl.spamhaus.org : \
28704                 dsn.rfc-ignorant.org/$sender_address_domain
28705 .endd
28706 The first item checks the sending host's IP address; the second checks a domain
28707 name. The whole condition is true if either of the DNS lookups succeeds.
28708
28709
28710
28711
28712 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28713 .cindex "DNS list" "multiple keys for"
28714 The syntax described above for looking up explicitly-defined values (either
28715 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28716 name for the DNS list, what follows the slash can in fact be a list of items.
28717 As with all lists in Exim, the default separator is a colon. However, because
28718 this is a sublist within the list of DNS blacklist domains, it is necessary
28719 either to double the separators like this:
28720 .code
28721 dnslists = black.list.tld/name.1::name.2
28722 .endd
28723 or to change the separator character, like this:
28724 .code
28725 dnslists = black.list.tld/<;name.1;name.2
28726 .endd
28727 If an item in the list is an IP address, it is inverted before the DNS
28728 blacklist domain is appended. If it is not an IP address, no inversion
28729 occurs. Consider this condition:
28730 .code
28731 dnslists = black.list.tld/<;192.168.1.2;a.domain
28732 .endd
28733 The DNS lookups that occur are:
28734 .code
28735 2.1.168.192.black.list.tld
28736 a.domain.black.list.tld
28737 .endd
28738 Once a DNS record has been found (that matches a specific IP return
28739 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28740 are done. If there is a temporary DNS error, the rest of the sublist of domains
28741 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28742 only if no other DNS lookup in this sublist succeeds. In other words, a
28743 successful lookup for any of the items in the sublist overrides a temporary
28744 error for a previous item.
28745
28746 The ability to supply a list of items after the slash is in some sense just a
28747 syntactic convenience. These two examples have the same effect:
28748 .code
28749 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28750 dnslists = black.list.tld/a.domain::b.domain
28751 .endd
28752 However, when the data for the list is obtained from a lookup, the second form
28753 is usually much more convenient. Consider this example:
28754 .code
28755 deny message  = The mail servers for the domain \
28756                 $sender_address_domain \
28757                 are listed at $dnslist_domain ($dnslist_value); \
28758                 see $dnslist_text.
28759      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28760                                    ${lookup dnsdb {>|mxh=\
28761                                    $sender_address_domain} }} }
28762 .endd
28763 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28764 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28765 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28766 of expanding the condition might be something like this:
28767 .code
28768 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28769 .endd
28770 Thus, this example checks whether or not the IP addresses of the sender
28771 domain's mail servers are on the Spamhaus black list.
28772
28773 The key that was used for a successful DNS list lookup is put into the variable
28774 &$dnslist_matched$& (see section &<<SECID204>>&).
28775
28776
28777
28778
28779 .section "Data returned by DNS lists" "SECID203"
28780 .cindex "DNS list" "data returned from"
28781 DNS lists are constructed using address records in the DNS. The original RBL
28782 just used the address 127.0.0.1 on the right hand side of each record, but the
28783 RBL+ list and some other lists use a number of values with different meanings.
28784 The values used on the RBL+ list are:
28785 .display
28786 127.1.0.1  RBL
28787 127.1.0.2  DUL
28788 127.1.0.3  DUL and RBL
28789 127.1.0.4  RSS
28790 127.1.0.5  RSS and RBL
28791 127.1.0.6  RSS and DUL
28792 127.1.0.7  RSS and DUL and RBL
28793 .endd
28794 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28795 different values. Some DNS lists may return more than one address record;
28796 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28797
28798
28799 .section "Variables set from DNS lists" "SECID204"
28800 .cindex "expansion" "variables, set from DNS list"
28801 .cindex "DNS list" "variables set from"
28802 .vindex "&$dnslist_domain$&"
28803 .vindex "&$dnslist_matched$&"
28804 .vindex "&$dnslist_text$&"
28805 .vindex "&$dnslist_value$&"
28806 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28807 the name of the overall domain that matched (for example,
28808 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28809 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28810 the DNS record. When the key is an IP address, it is not reversed in
28811 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28812 cases, for example:
28813 .code
28814 deny dnslists = spamhaus.example
28815 .endd
28816 the key is also available in another variable (in this case,
28817 &$sender_host_address$&). In more complicated cases, however, this is not true.
28818 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28819 might generate a dnslists lookup like this:
28820 .code
28821 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28822 .endd
28823 If this condition succeeds, the value in &$dnslist_matched$& might be
28824 &`192.168.6.7`& (for example).
28825
28826 If more than one address record is returned by the DNS lookup, all the IP
28827 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28828 The variable &$dnslist_text$& contains the contents of any associated TXT
28829 record. For lists such as RBL+ the TXT record for a merged entry is often not
28830 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28831 information.
28832
28833 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28834 &-- although these appear before the condition in the ACL, they are not
28835 expanded until after it has failed. For example:
28836 .code
28837 deny    hosts = !+local_networks
28838         message = $sender_host_address is listed \
28839                   at $dnslist_domain
28840         dnslists = rbl-plus.mail-abuse.example
28841 .endd
28842
28843
28844
28845 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28846 .cindex "DNS list" "matching specific returned data"
28847 You can add an equals sign and an IP address after a &%dnslists%& domain name
28848 in order to restrict its action to DNS records with a matching right hand side.
28849 For example,
28850 .code
28851 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28852 .endd
28853 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28854 any address record is considered to be a match. For the moment, we assume
28855 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28856 describes how multiple records are handled.
28857
28858 More than one IP address may be given for checking, using a comma as a
28859 separator. These are alternatives &-- if any one of them matches, the
28860 &%dnslists%& condition is true. For example:
28861 .code
28862 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28863 .endd
28864 If you want to specify a constraining address list and also specify names or IP
28865 addresses to be looked up, the constraining address list must be specified
28866 first. For example:
28867 .code
28868 deny dnslists = dsn.rfc-ignorant.org\
28869                 =127.0.0.2/$sender_address_domain
28870 .endd
28871
28872 If the character &`&&`& is used instead of &`=`&, the comparison for each
28873 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28874 In other words, the listed addresses are used as bit masks. The comparison is
28875 true if all the bits in the mask are present in the address that is being
28876 tested. For example:
28877 .code
28878 dnslists = a.b.c&0.0.0.3
28879 .endd
28880 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
28881 want to test whether one bit or another bit is present (as opposed to both
28882 being present), you must use multiple values. For example:
28883 .code
28884 dnslists = a.b.c&0.0.0.1,0.0.0.2
28885 .endd
28886 matches if the final component of the address is an odd number or two times
28887 an odd number.
28888
28889
28890
28891 .section "Negated DNS matching conditions" "SECID205"
28892 You can supply a negative list of IP addresses as part of a &%dnslists%&
28893 condition. Whereas
28894 .code
28895 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28896 .endd
28897 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28898 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
28899 .code
28900 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28901 .endd
28902 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28903 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28904 words, the result of the test is inverted if an exclamation mark appears before
28905 the &`=`& (or the &`&&`&) sign.
28906
28907 &*Note*&: This kind of negation is not the same as negation in a domain,
28908 host, or address list (which is why the syntax is different).
28909
28910 If you are using just one list, the negation syntax does not gain you much. The
28911 previous example is precisely equivalent to
28912 .code
28913 deny  dnslists = a.b.c
28914      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28915 .endd
28916 However, if you are using multiple lists, the negation syntax is clearer.
28917 Consider this example:
28918 .code
28919 deny  dnslists = sbl.spamhaus.org : \
28920                  list.dsbl.org : \
28921                  dnsbl.njabl.org!=127.0.0.3 : \
28922                  relays.ordb.org
28923 .endd
28924 Using only positive lists, this would have to be:
28925 .code
28926 deny  dnslists = sbl.spamhaus.org : \
28927                  list.dsbl.org
28928 deny  dnslists = dnsbl.njabl.org
28929      !dnslists = dnsbl.njabl.org=127.0.0.3
28930 deny  dnslists = relays.ordb.org
28931 .endd
28932 which is less clear, and harder to maintain.
28933
28934
28935
28936
28937 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28938 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28939 thereby providing more than one IP address. When an item in a &%dnslists%& list
28940 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28941 the match to specific results from the DNS lookup, there are two ways in which
28942 the checking can be handled. For example, consider the condition:
28943 .code
28944 dnslists = a.b.c=127.0.0.1
28945 .endd
28946 What happens if the DNS lookup for the incoming IP address yields both
28947 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28948 condition true because at least one given value was found, or is it false
28949 because at least one of the found values was not listed? And how does this
28950 affect negated conditions? Both possibilities are provided for with the help of
28951 additional separators &`==`& and &`=&&`&.
28952
28953 .ilist
28954 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
28955 IP addresses matches one of the listed addresses. For the example above, the
28956 condition is true because 127.0.0.1 matches.
28957 .next
28958 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
28959 looked up IP addresses matches one of the listed addresses. If the condition is
28960 changed to:
28961 .code
28962 dnslists = a.b.c==127.0.0.1
28963 .endd
28964 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28965 false because 127.0.0.2 is not listed. You would need to have:
28966 .code
28967 dnslists = a.b.c==127.0.0.1,127.0.0.2
28968 .endd
28969 for the condition to be true.
28970 .endlist
28971
28972 When &`!`& is used to negate IP address matching, it inverts the result, giving
28973 the precise opposite of the behaviour above. Thus:
28974 .ilist
28975 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
28976 addresses matches one of the listed addresses. Consider:
28977 .code
28978 dnslists = a.b.c!&0.0.0.1
28979 .endd
28980 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28981 false because 127.0.0.1 matches.
28982 .next
28983 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
28984 looked up IP address that does not match. Consider:
28985 .code
28986 dnslists = a.b.c!=&0.0.0.1
28987 .endd
28988 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28989 true, because 127.0.0.2 does not match. You would need to have:
28990 .code
28991 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
28992 .endd
28993 for the condition to be false.
28994 .endlist
28995 When the DNS lookup yields only a single IP address, there is no difference
28996 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
28997
28998
28999
29000
29001 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29002 .cindex "DNS list" "information from merged"
29003 When the facility for restricting the matching IP values in a DNS list is used,
29004 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29005 the true reason for rejection. This happens when lists are merged and the IP
29006 address in the A record is used to distinguish them; unfortunately there is
29007 only one TXT record. One way round this is not to use merged lists, but that
29008 can be inefficient because it requires multiple DNS lookups where one would do
29009 in the vast majority of cases when the host of interest is not on any of the
29010 lists.
29011
29012 A less inefficient way of solving this problem is available. If
29013 two domain names, comma-separated, are given, the second is used first to
29014 do an initial check, making use of any IP value restrictions that are set.
29015 If there is a match, the first domain is used, without any IP value
29016 restrictions, to get the TXT record. As a byproduct of this, there is also
29017 a check that the IP being tested is indeed on the first list. The first
29018 domain is the one that is put in &$dnslist_domain$&. For example:
29019 .code
29020 reject message  = \
29021          rejected because $sender_host_address is blacklisted \
29022          at $dnslist_domain\n$dnslist_text
29023        dnslists = \
29024          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29025          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29026 .endd
29027 For the first blacklist item, this starts by doing a lookup in
29028 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29029 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29030 value, and as long as something is found, it looks for the corresponding TXT
29031 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29032 The second blacklist item is processed similarly.
29033
29034 If you are interested in more than one merged list, the same list must be
29035 given several times, but because the results of the DNS lookups are cached,
29036 the DNS calls themselves are not repeated. For example:
29037 .code
29038 reject dnslists = \
29039          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29040          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29041          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29042          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29043 .endd
29044 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29045 values matches (or if no record is found), this is the only lookup that is
29046 done. Only if there is a match is one of the more specific lists consulted.
29047
29048
29049
29050 .section "DNS lists and IPv6" "SECTmorednslistslast"
29051 .cindex "IPv6" "DNS black lists"
29052 .cindex "DNS list" "IPv6 usage"
29053 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29054 nibble by nibble. For example, if the calling host's IP address is
29055 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29056 .code
29057 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29058   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29059 .endd
29060 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29061 lists contain wildcard records, intended for IPv4, that interact badly with
29062 IPv6. For example, the DNS entry
29063 .code
29064 *.3.some.list.example.    A    127.0.0.1
29065 .endd
29066 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29067 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29068
29069 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29070 &%condition%& condition, as in this example:
29071 .code
29072 deny   condition = ${if isip4{$sender_host_address}}
29073        dnslists  = some.list.example
29074 .endd
29075
29076 If an explicit key is being used for a DNS lookup and it may be an IPv6
29077 address you should specify alternate list separators for both the outer
29078 (DNS list name) list and inner (lookup keys) list:
29079 .code
29080        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29081 .endd
29082
29083 .section "Rate limiting incoming messages" "SECTratelimiting"
29084 .cindex "rate limiting" "client sending"
29085 .cindex "limiting client sending rates"
29086 .oindex "&%smtp_ratelimit_*%&"
29087 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29088 which clients can send email. This is more powerful than the
29089 &%smtp_ratelimit_*%& options, because those options control the rate of
29090 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29091 works across all connections (concurrent and sequential) from the same client
29092 host. The syntax of the &%ratelimit%& condition is:
29093 .display
29094 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29095 .endd
29096 If the average client sending rate is less than &'m'& messages per time
29097 period &'p'& then the condition is false; otherwise it is true.
29098
29099 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29100 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29101 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29102 of &'p'&.
29103
29104 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29105 time interval, for example, &`8h`& for eight hours. A larger time constant
29106 means that it takes Exim longer to forget a client's past behaviour. The
29107 parameter &'m'& is the maximum number of messages that a client is permitted to
29108 send in each time interval. It also specifies the number of messages permitted
29109 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29110 constant, you can allow a client to send more messages in a burst without
29111 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29112 both small, messages must be sent at an even rate.
29113
29114 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29115 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29116 when deploying the &%ratelimit%& ACL condition. The script prints usage
29117 instructions when it is run with no arguments.
29118
29119 The key is used to look up the data for calculating the client's average
29120 sending rate. This data is stored in Exim's spool directory, alongside the
29121 retry and other hints databases. The default key is &$sender_host_address$&,
29122 which means Exim computes the sending rate of each client host IP address.
29123 By changing the key you can change how Exim identifies clients for the purpose
29124 of ratelimiting. For example, to limit the sending rate of each authenticated
29125 user, independent of the computer they are sending from, set the key to
29126 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29127 example, &$authenticated_id$& is only meaningful if the client has
29128 authenticated (which you can check with the &%authenticated%& ACL condition).
29129
29130 The lookup key does not have to identify clients: If you want to limit the
29131 rate at which a recipient receives messages, you can use the key
29132 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29133 ACL.
29134
29135 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29136 specifies what Exim measures the rate of, for example messages or recipients
29137 or bytes. You can adjust the measurement using the &%unique=%& and/or
29138 &%count=%& options. You can also control when Exim updates the recorded rate
29139 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29140 separated by a slash, like the other parameters. They may appear in any order.
29141
29142 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29143 any options that alter the meaning of the stored data. The limit &'m'& is not
29144 stored, so you can alter the configured maximum rate and Exim will still
29145 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29146 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29147 behaviour. The lookup key is not affected by changes to the update mode and
29148 the &%count=%& option.
29149
29150
29151 .section "Ratelimit options for what is being measured" "ratoptmea"
29152 .cindex "rate limiting" "per_* options"
29153 The &%per_conn%& option limits the client's connection rate. It is not
29154 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29155 &%acl_not_smtp_start%& ACLs.
29156
29157 The &%per_mail%& option limits the client's rate of sending messages. This is
29158 the default if none of the &%per_*%& options is specified. It can be used in
29159 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29160 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29161
29162 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29163 the same ACLs as the &%per_mail%& option, though it is best to use this option
29164 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29165 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29166 in its MAIL command, which may be inaccurate or completely missing. You can
29167 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29168 in kilobytes, megabytes, or gigabytes, respectively.
29169
29170 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29171 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29172 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29173 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29174 ACLs the rate is updated with the total recipient count in one go. Note that
29175 in either case the rate limiting engine will see a message with many
29176 recipients as a large high-speed burst.
29177
29178 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29179 number of different recipients that the client has sent messages to in the
29180 last time period. That is, if the client repeatedly sends messages to the same
29181 recipient, its measured rate is not increased. This option can only be used in
29182 &%acl_smtp_rcpt%&.
29183
29184 The &%per_cmd%& option causes Exim to recompute the rate every time the
29185 condition is processed. This can be used to limit the rate of any SMTP
29186 command. If it is used in multiple ACLs it can limit the aggregate rate of
29187 multiple different commands.
29188
29189 The &%count=%& option can be used to alter how much Exim adds to the client's
29190 measured rate. For example, the &%per_byte%& option is equivalent to
29191 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29192 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29193 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29194
29195 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29196
29197
29198 .section "Ratelimit update modes" "ratoptupd"
29199 .cindex "rate limiting" "reading data without updating"
29200 You can specify one of three options with the &%ratelimit%& condition to
29201 control when its database is updated. This section describes the &%readonly%&
29202 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29203
29204 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29205 previously-computed rate to check against the limit.
29206
29207 For example, you can test the client's sending rate and deny it access (when
29208 it is too fast) in the connect ACL. If the client passes this check then it
29209 can go on to send a message, in which case its recorded rate will be updated
29210 in the MAIL ACL. Subsequent connections from the same client will check this
29211 new rate.
29212 .code
29213 acl_check_connect:
29214  deny ratelimit = 100 / 5m / readonly
29215     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29216                   (max $sender_rate_limit)
29217 # ...
29218 acl_check_mail:
29219  warn ratelimit = 100 / 5m / strict
29220     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29221                   (max $sender_rate_limit)
29222 .endd
29223
29224 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29225 processing a message then it may increase the client's measured rate more than
29226 it should. For example, this will happen if you check the &%per_rcpt%& option
29227 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29228 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29229 multiple update problems by using the &%readonly%& option on later ratelimit
29230 checks.
29231
29232 The &%per_*%& options described above do not make sense in some ACLs. If you
29233 use a &%per_*%& option in an ACL where it is not normally permitted then the
29234 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29235 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29236 next section) so you must specify the &%readonly%& option explicitly.
29237
29238
29239 .section "Ratelimit options for handling fast clients" "ratoptfast"
29240 .cindex "rate limiting" "strict and leaky modes"
29241 If a client's average rate is greater than the maximum, the rate limiting
29242 engine can react in two possible ways, depending on the presence of the
29243 &%strict%& or &%leaky%& update modes. This is independent of the other
29244 counter-measures (such as rejecting the message) that may be specified by the
29245 rest of the ACL.
29246
29247 The &%leaky%& (default) option means that the client's recorded rate is not
29248 updated if it is above the limit. The effect of this is that Exim measures the
29249 client's average rate of successfully sent email, which cannot be greater than
29250 the maximum allowed. If the client is over the limit it may suffer some
29251 counter-measures (as specified in the ACL), but it will still be able to send
29252 email at the configured maximum rate, whatever the rate of its attempts. This
29253 is generally the better choice if you have clients that retry automatically.
29254 For example, it does not prevent a sender with an over-aggressive retry rate
29255 from getting any email through.
29256
29257 The &%strict%& option means that the client's recorded rate is always
29258 updated. The effect of this is that Exim measures the client's average rate
29259 of attempts to send email, which can be much higher than the maximum it is
29260 actually allowed. If the client is over the limit it may be subjected to
29261 counter-measures by the ACL. It must slow down and allow sufficient time to
29262 pass that its computed rate falls below the maximum before it can send email
29263 again. The time (the number of smoothing periods) it must wait and not
29264 attempt to send mail can be calculated with this formula:
29265 .code
29266         ln(peakrate/maxrate)
29267 .endd
29268
29269
29270 .section "Limiting the rate of different events" "ratoptuniq"
29271 .cindex "rate limiting" "counting unique events"
29272 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29273 rate of different events. For example, the &%per_addr%& option uses this
29274 mechanism to count the number of different recipients that the client has
29275 sent messages to in the last time period; it is equivalent to
29276 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29277 measure the rate that a client uses different sender addresses with the
29278 options &`per_mail/unique=$sender_address`&.
29279
29280 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29281 has seen for that key. The whole set is thrown away when it is older than the
29282 rate smoothing period &'p'&, so each different event is counted at most once
29283 per period. In the &%leaky%& update mode, an event that causes the client to
29284 go over the limit is not added to the set, in the same way that the client's
29285 recorded rate is not updated in the same situation.
29286
29287 When you combine the &%unique=%& and &%readonly%& options, the specific
29288 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29289 rate.
29290
29291 The &%unique=%& mechanism needs more space in the ratelimit database than the
29292 other &%ratelimit%& options in order to store the event set. The number of
29293 unique values is potentially as large as the rate limit, so the extra space
29294 required increases with larger limits.
29295
29296 The uniqueification is not perfect: there is a small probability that Exim
29297 will think a new event has happened before. If the sender's rate is less than
29298 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29299 the measured rate can go above the limit, in which case Exim may under-count
29300 events by a significant margin. Fortunately, if the rate is high enough (2.7
29301 times the limit) that the false positive rate goes above 9%, then Exim will
29302 throw away the over-full event set before the measured rate falls below the
29303 limit. Therefore the only harm should be that exceptionally high sending rates
29304 are logged incorrectly; any countermeasures you configure will be as effective
29305 as intended.
29306
29307
29308 .section "Using rate limiting" "useratlim"
29309 Exim's other ACL facilities are used to define what counter-measures are taken
29310 when the rate limit is exceeded. This might be anything from logging a warning
29311 (for example, while measuring existing sending rates in order to define
29312 policy), through time delays to slow down fast senders, up to rejecting the
29313 message. For example:
29314 .code
29315 # Log all senders' rates
29316 warn ratelimit = 0 / 1h / strict
29317      log_message = Sender rate $sender_rate / $sender_rate_period
29318
29319 # Slow down fast senders; note the need to truncate $sender_rate
29320 # at the decimal point.
29321 warn ratelimit = 100 / 1h / per_rcpt / strict
29322      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29323                    $sender_rate_limit }s
29324
29325 # Keep authenticated users under control
29326 deny authenticated = *
29327      ratelimit = 100 / 1d / strict / $authenticated_id
29328
29329 # System-wide rate limit
29330 defer message = Sorry, too busy. Try again later.
29331      ratelimit = 10 / 1s / $primary_hostname
29332
29333 # Restrict incoming rate from each host, with a default
29334 # set using a macro and special cases looked up in a table.
29335 defer message = Sender rate exceeds $sender_rate_limit \
29336                messages per $sender_rate_period
29337      ratelimit = ${lookup {$sender_host_address} \
29338                    cdb {DB/ratelimits.cdb} \
29339                    {$value} {RATELIMIT} }
29340 .endd
29341 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29342 especially with the &%per_rcpt%& option, you may suffer from a performance
29343 bottleneck caused by locking on the ratelimit hints database. Apart from
29344 making your ACLs less complicated, you can reduce the problem by using a
29345 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29346 this means that Exim will lose its hints data after a reboot (including retry
29347 hints, the callout cache, and ratelimit data).
29348
29349
29350
29351 .section "Address verification" "SECTaddressverification"
29352 .cindex "verifying address" "options for"
29353 .cindex "policy control" "address verification"
29354 Several of the &%verify%& conditions described in section
29355 &<<SECTaclconditions>>& cause addresses to be verified. Section
29356 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29357 The verification conditions can be followed by options that modify the
29358 verification process. The options are separated from the keyword and from each
29359 other by slashes, and some of them contain parameters. For example:
29360 .code
29361 verify = sender/callout
29362 verify = recipient/defer_ok/callout=10s,defer_ok
29363 .endd
29364 The first stage of address verification, which always happens, is to run the
29365 address through the routers, in &"verify mode"&. Routers can detect the
29366 difference between verification and routing for delivery, and their actions can
29367 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29368 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29369 The available options are as follows:
29370
29371 .ilist
29372 If the &%callout%& option is specified, successful routing to one or more
29373 remote hosts is followed by a &"callout"& to those hosts as an additional
29374 check. Callouts and their sub-options are discussed in the next section.
29375 .next
29376 If there is a defer error while doing verification routing, the ACL
29377 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29378 options, the condition is forced to be true instead. Note that this is a main
29379 verification option as well as a suboption for callouts.
29380 .next
29381 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29382 discusses the reporting of sender address verification failures.
29383 .next
29384 The &%success_on_redirect%& option causes verification always to succeed
29385 immediately after a successful redirection. By default, if a redirection
29386 generates just one address, that address is also verified. See further
29387 discussion in section &<<SECTredirwhilveri>>&.
29388 .endlist
29389
29390 .cindex "verifying address" "differentiating failures"
29391 .vindex "&$recipient_verify_failure$&"
29392 .vindex "&$sender_verify_failure$&"
29393 .vindex "&$acl_verify_message$&"
29394 After an address verification failure, &$acl_verify_message$& contains the
29395 error message that is associated with the failure. It can be preserved by
29396 coding like this:
29397 .code
29398 warn  !verify = sender
29399        set acl_m0 = $acl_verify_message
29400 .endd
29401 If you are writing your own custom rejection message or log message when
29402 denying access, you can use this variable to include information about the
29403 verification failure.
29404
29405 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29406 appropriate) contains one of the following words:
29407
29408 .ilist
29409 &%qualify%&: The address was unqualified (no domain), and the message
29410 was neither local nor came from an exempted host.
29411 .next
29412 &%route%&: Routing failed.
29413 .next
29414 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29415 occurred at or before the MAIL command (that is, on initial
29416 connection, HELO, or MAIL).
29417 .next
29418 &%recipient%&: The RCPT command in a callout was rejected.
29419 .next
29420 &%postmaster%&: The postmaster check in a callout was rejected.
29421 .endlist
29422
29423 The main use of these variables is expected to be to distinguish between
29424 rejections of MAIL and rejections of RCPT in callouts.
29425
29426
29427
29428
29429 .section "Callout verification" "SECTcallver"
29430 .cindex "verifying address" "by callout"
29431 .cindex "callout" "verification"
29432 .cindex "SMTP" "callout verification"
29433 For non-local addresses, routing verifies the domain, but is unable to do any
29434 checking of the local part. There are situations where some means of verifying
29435 the local part is desirable. One way this can be done is to make an SMTP
29436 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29437 a subsequent host for a recipient address, to see if the host accepts the
29438 address. We use the term &'callout'& to cover both cases. Note that for a
29439 sender address, the callback is not to the client host that is trying to
29440 deliver the message, but to one of the hosts that accepts incoming mail for the
29441 sender's domain.
29442
29443 Exim does not do callouts by default. If you want them to happen, you must
29444 request them by setting appropriate options on the &%verify%& condition, as
29445 described below. This facility should be used with care, because it can add a
29446 lot of resource usage to the cost of verifying an address. However, Exim does
29447 cache the results of callouts, which helps to reduce the cost. Details of
29448 caching are in section &<<SECTcallvercache>>&.
29449
29450 Recipient callouts are usually used only between hosts that are controlled by
29451 the same administration. For example, a corporate gateway host could use
29452 callouts to check for valid recipients on an internal mailserver. A successful
29453 callout does not guarantee that a real delivery to the address would succeed;
29454 on the other hand, a failing callout does guarantee that a delivery would fail.
29455
29456 If the &%callout%& option is present on a condition that verifies an address, a
29457 second stage of verification occurs if the address is successfully routed to
29458 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29459 &(manualroute)& router, where the router specifies the hosts. However, if a
29460 router that does not set up hosts routes to an &(smtp)& transport with a
29461 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29462 &%hosts_override%& set, its hosts are always used, whether or not the router
29463 supplies a host list.
29464 Callouts are only supported on &(smtp)& transports.
29465
29466 The port that is used is taken from the transport, if it is specified and is a
29467 remote transport. (For routers that do verification only, no transport need be
29468 specified.) Otherwise, the default SMTP port is used. If a remote transport
29469 specifies an outgoing interface, this is used; otherwise the interface is not
29470 specified. Likewise, the text that is used for the HELO command is taken from
29471 the transport's &%helo_data%& option; if there is no transport, the value of
29472 &$smtp_active_hostname$& is used.
29473
29474 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29475 test whether a bounce message could be delivered to the sender address. The
29476 following SMTP commands are sent:
29477 .display
29478 &`HELO `&<&'local host name'&>
29479 &`MAIL FROM:<>`&
29480 &`RCPT TO:`&<&'the address to be tested'&>
29481 &`QUIT`&
29482 .endd
29483 LHLO is used instead of HELO if the transport's &%protocol%& option is
29484 set to &"lmtp"&.
29485
29486 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29487 settings.
29488
29489 A recipient callout check is similar. By default, it also uses an empty address
29490 for the sender. This default is chosen because most hosts do not make use of
29491 the sender address when verifying a recipient. Using the same address means
29492 that a single cache entry can be used for each recipient. Some sites, however,
29493 do make use of the sender address when verifying. These are catered for by the
29494 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29495
29496 If the response to the RCPT command is a 2&'xx'& code, the verification
29497 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29498 Exim tries the next host, if any. If there is a problem with all the remote
29499 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29500 &%callout%& option is given, in which case the condition is forced to succeed.
29501
29502 .cindex "SMTP" "output flushing, disabling for callout"
29503 A callout may take a little time. For this reason, Exim normally flushes SMTP
29504 output before performing a callout in an ACL, to avoid unexpected timeouts in
29505 clients when the SMTP PIPELINING extension is in use. The flushing can be
29506 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29507
29508
29509
29510
29511 .section "Additional parameters for callouts" "CALLaddparcall"
29512 .cindex "callout" "additional parameters for"
29513 The &%callout%& option can be followed by an equals sign and a number of
29514 optional parameters, separated by commas. For example:
29515 .code
29516 verify = recipient/callout=10s,defer_ok
29517 .endd
29518 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29519 separate verify options, is retained for backwards compatibility, but is now
29520 deprecated. The additional parameters for &%callout%& are as follows:
29521
29522
29523 .vlist
29524 .vitem <&'a&~time&~interval'&>
29525 .cindex "callout" "timeout, specifying"
29526 This specifies the timeout that applies for the callout attempt to each host.
29527 For example:
29528 .code
29529 verify = sender/callout=5s
29530 .endd
29531 The default is 30 seconds. The timeout is used for each response from the
29532 remote host. It is also used for the initial connection, unless overridden by
29533 the &%connect%& parameter.
29534
29535
29536 .vitem &*connect&~=&~*&<&'time&~interval'&>
29537 .cindex "callout" "connection timeout, specifying"
29538 This parameter makes it possible to set a different (usually smaller) timeout
29539 for making the SMTP connection. For example:
29540 .code
29541 verify = sender/callout=5s,connect=1s
29542 .endd
29543 If not specified, this timeout defaults to the general timeout value.
29544
29545 .vitem &*defer_ok*&
29546 .cindex "callout" "defer, action on"
29547 When this parameter is present, failure to contact any host, or any other kind
29548 of temporary error, is treated as success by the ACL. However, the cache is not
29549 updated in this circumstance.
29550
29551 .vitem &*fullpostmaster*&
29552 .cindex "callout" "full postmaster check"
29553 This operates like the &%postmaster%& option (see below), but if the check for
29554 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29555 accordance with the specification in RFC 2821. The RFC states that the
29556 unqualified address &'postmaster'& should be accepted.
29557
29558
29559 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29560 .cindex "callout" "sender when verifying header"
29561 When verifying addresses in header lines using the &%header_sender%&
29562 verification option, Exim behaves by default as if the addresses are envelope
29563 sender addresses from a message. Callout verification therefore tests to see
29564 whether a bounce message could be delivered, by using an empty address in the
29565 MAIL command. However, it is arguable that these addresses might never be used
29566 as envelope senders, and could therefore justifiably reject bounce messages
29567 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29568 address to use in the MAIL command. For example:
29569 .code
29570 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29571 .endd
29572 This parameter is available only for the &%header_sender%& verification option.
29573
29574
29575 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29576 .cindex "callout" "overall timeout, specifying"
29577 This parameter sets an overall timeout for performing a callout verification.
29578 For example:
29579 .code
29580 verify = sender/callout=5s,maxwait=30s
29581 .endd
29582 This timeout defaults to four times the callout timeout for individual SMTP
29583 commands. The overall timeout applies when there is more than one host that can
29584 be tried. The timeout is checked before trying the next host. This prevents
29585 very long delays if there are a large number of hosts and all are timing out
29586 (for example, when network connections are timing out).
29587
29588
29589 .vitem &*no_cache*&
29590 .cindex "callout" "cache, suppressing"
29591 .cindex "caching callout, suppressing"
29592 When this parameter is given, the callout cache is neither read nor updated.
29593
29594 .vitem &*postmaster*&
29595 .cindex "callout" "postmaster; checking"
29596 When this parameter is set, a successful callout check is followed by a similar
29597 check for the local part &'postmaster'& at the same domain. If this address is
29598 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29599 the postmaster check is recorded in a cache record; if it is a failure, this is
29600 used to fail subsequent callouts for the domain without a connection being
29601 made, until the cache record expires.
29602
29603 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29604 The postmaster check uses an empty sender in the MAIL command by default.
29605 You can use this parameter to do a postmaster check using a different address.
29606 For example:
29607 .code
29608 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29609 .endd
29610 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29611 one overrides. The &%postmaster%& parameter is equivalent to this example:
29612 .code
29613 require  verify = sender/callout=postmaster_mailfrom=
29614 .endd
29615 &*Warning*&: The caching arrangements for postmaster checking do not take
29616 account of the sender address. It is assumed that either the empty address or
29617 a fixed non-empty address will be used. All that Exim remembers is that the
29618 postmaster check for the domain succeeded or failed.
29619
29620
29621 .vitem &*random*&
29622 .cindex "callout" "&""random""& check"
29623 When this parameter is set, before doing the normal callout check, Exim does a
29624 check for a &"random"& local part at the same domain. The local part is not
29625 really random &-- it is defined by the expansion of the option
29626 &%callout_random_local_part%&, which defaults to
29627 .code
29628 $primary_hostname-$tod_epoch-testing
29629 .endd
29630 The idea here is to try to determine whether the remote host accepts all local
29631 parts without checking. If it does, there is no point in doing callouts for
29632 specific local parts. If the &"random"& check succeeds, the result is saved in
29633 a cache record, and used to force the current and subsequent callout checks to
29634 succeed without a connection being made, until the cache record expires.
29635
29636 .vitem &*use_postmaster*&
29637 .cindex "callout" "sender for recipient check"
29638 This parameter applies to recipient callouts only. For example:
29639 .code
29640 deny  !verify = recipient/callout=use_postmaster
29641 .endd
29642 .vindex "&$qualify_domain$&"
29643 It causes a non-empty postmaster address to be used in the MAIL command when
29644 performing the callout for the recipient, and also for a &"random"& check if
29645 that is configured. The local part of the address is &`postmaster`& and the
29646 domain is the contents of &$qualify_domain$&.
29647
29648 .vitem &*use_sender*&
29649 This option applies to recipient callouts only. For example:
29650 .code
29651 require  verify = recipient/callout=use_sender
29652 .endd
29653 It causes the message's actual sender address to be used in the MAIL
29654 command when performing the callout, instead of an empty address. There is no
29655 need to use this option unless you know that the called hosts make use of the
29656 sender when checking recipients. If used indiscriminately, it reduces the
29657 usefulness of callout caching.
29658 .endlist
29659
29660 If you use any of the parameters that set a non-empty sender for the MAIL
29661 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29662 &%use_sender%&), you should think about possible loops. Recipient checking is
29663 usually done between two hosts that are under the same management, and the host
29664 that receives the callouts is not normally configured to do callouts itself.
29665 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29666 these circumstances.
29667
29668 However, if you use a non-empty sender address for a callout to an arbitrary
29669 host, there is the likelihood that the remote host will itself initiate a
29670 callout check back to your host. As it is checking what appears to be a message
29671 sender, it is likely to use an empty address in MAIL, thus avoiding a
29672 callout loop. However, to be on the safe side it would be best to set up your
29673 own ACLs so that they do not do sender verification checks when the recipient
29674 is the address you use for header sender or postmaster callout checking.
29675
29676 Another issue to think about when using non-empty senders for callouts is
29677 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29678 by the sender/recipient combination; thus, for any given recipient, many more
29679 actual callouts are performed than when an empty sender or postmaster is used.
29680
29681
29682
29683
29684 .section "Callout caching" "SECTcallvercache"
29685 .cindex "hints database" "callout cache"
29686 .cindex "callout" "cache, description of"
29687 .cindex "caching" "callout"
29688 Exim caches the results of callouts in order to reduce the amount of resources
29689 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29690 option. A hints database called &"callout"& is used for the cache. Two
29691 different record types are used: one records the result of a callout check for
29692 a specific address, and the other records information that applies to the
29693 entire domain (for example, that it accepts the local part &'postmaster'&).
29694
29695 When an original callout fails, a detailed SMTP error message is given about
29696 the failure. However, for subsequent failures use the cache data, this message
29697 is not available.
29698
29699 The expiry times for negative and positive address cache records are
29700 independent, and can be set by the global options &%callout_negative_expire%&
29701 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29702
29703 If a host gives a negative response to an SMTP connection, or rejects any
29704 commands up to and including
29705 .code
29706 MAIL FROM:<>
29707 .endd
29708 (but not including the MAIL command with a non-empty address),
29709 any callout attempt is bound to fail. Exim remembers such failures in a
29710 domain cache record, which it uses to fail callouts for the domain without
29711 making new connections, until the domain record times out. There are two
29712 separate expiry times for domain cache records:
29713 &%callout_domain_negative_expire%& (default 3h) and
29714 &%callout_domain_positive_expire%& (default 7d).
29715
29716 Domain records expire when the negative expiry time is reached if callouts
29717 cannot be made for the domain, or if the postmaster check failed.
29718 Otherwise, they expire when the positive expiry time is reached. This
29719 ensures that, for example, a host that stops accepting &"random"& local parts
29720 will eventually be noticed.
29721
29722 The callout caching mechanism is based on the domain of the address that is
29723 being tested. If the domain routes to several hosts, it is assumed that their
29724 behaviour will be the same.
29725
29726
29727
29728 .section "Sender address verification reporting" "SECTsenaddver"
29729 .cindex "verifying" "suppressing error details"
29730 See section &<<SECTaddressverification>>& for a general discussion of
29731 verification. When sender verification fails in an ACL, the details of the
29732 failure are given as additional output lines before the 550 response to the
29733 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29734 you might see:
29735 .code
29736 MAIL FROM:<xyz@abc.example>
29737 250 OK
29738 RCPT TO:<pqr@def.example>
29739 550-Verification failed for <xyz@abc.example>
29740 550-Called:   192.168.34.43
29741 550-Sent:     RCPT TO:<xyz@abc.example>
29742 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29743 550 Sender verification failed
29744 .endd
29745 If more than one RCPT command fails in the same way, the details are given
29746 only for the first of them. However, some administrators do not want to send
29747 out this much information. You can suppress the details by adding
29748 &`/no_details`& to the ACL statement that requests sender verification. For
29749 example:
29750 .code
29751 verify = sender/no_details
29752 .endd
29753
29754 .section "Redirection while verifying" "SECTredirwhilveri"
29755 .cindex "verifying" "redirection while"
29756 .cindex "address redirection" "while verifying"
29757 A dilemma arises when a local address is redirected by aliasing or forwarding
29758 during verification: should the generated addresses themselves be verified,
29759 or should the successful expansion of the original address be enough to verify
29760 it? By default, Exim takes the following pragmatic approach:
29761
29762 .ilist
29763 When an incoming address is redirected to just one child address, verification
29764 continues with the child address, and if that fails to verify, the original
29765 verification also fails.
29766 .next
29767 When an incoming address is redirected to more than one child address,
29768 verification does not continue. A success result is returned.
29769 .endlist
29770
29771 This seems the most reasonable behaviour for the common use of aliasing as a
29772 way of redirecting different local parts to the same mailbox. It means, for
29773 example, that a pair of alias entries of the form
29774 .code
29775 A.Wol:   aw123
29776 aw123:   :fail: Gone away, no forwarding address
29777 .endd
29778 work as expected, with both local parts causing verification failure. When a
29779 redirection generates more than one address, the behaviour is more like a
29780 mailing list, where the existence of the alias itself is sufficient for
29781 verification to succeed.
29782
29783 It is possible, however, to change the default behaviour so that all successful
29784 redirections count as successful verifications, however many new addresses are
29785 generated. This is specified by the &%success_on_redirect%& verification
29786 option. For example:
29787 .code
29788 require verify = recipient/success_on_redirect/callout=10s
29789 .endd
29790 In this example, verification succeeds if a router generates a new address, and
29791 the callout does not occur, because no address was routed to a remote host.
29792
29793 When verification is being tested via the &%-bv%& option, the treatment of
29794 redirections is as just described, unless the &%-v%& or any debugging option is
29795 also specified. In that case, full verification is done for every generated
29796 address and a report is output for each of them.
29797
29798
29799
29800 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29801 .cindex "CSA" "verifying"
29802 Client SMTP Authorization is a system that allows a site to advertise
29803 which machines are and are not permitted to send email. This is done by placing
29804 special SRV records in the DNS; these are looked up using the client's HELO
29805 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29806 Authorization checks in Exim are performed by the ACL condition:
29807 .code
29808 verify = csa
29809 .endd
29810 This fails if the client is not authorized. If there is a DNS problem, or if no
29811 valid CSA SRV record is found, or if the client is authorized, the condition
29812 succeeds. These three cases can be distinguished using the expansion variable
29813 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29814 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29815 be likely to cause problems for legitimate email.
29816
29817 The error messages produced by the CSA code include slightly more
29818 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29819 looking up the CSA SRV record, or problems looking up the CSA target
29820 address record. There are four reasons for &$csa_status$& being &"fail"&:
29821
29822 .ilist
29823 The client's host name is explicitly not authorized.
29824 .next
29825 The client's IP address does not match any of the CSA target IP addresses.
29826 .next
29827 The client's host name is authorized but it has no valid target IP addresses
29828 (for example, the target's addresses are IPv6 and the client is using IPv4).
29829 .next
29830 The client's host name has no CSA SRV record but a parent domain has asserted
29831 that all subdomains must be explicitly authorized.
29832 .endlist
29833
29834 The &%csa%& verification condition can take an argument which is the domain to
29835 use for the DNS query. The default is:
29836 .code
29837 verify = csa/$sender_helo_name
29838 .endd
29839 This implementation includes an extension to CSA. If the query domain
29840 is an address literal such as [192.0.2.95], or if it is a bare IP
29841 address, Exim searches for CSA SRV records in the reverse DNS as if
29842 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29843 meaningful to say:
29844 .code
29845 verify = csa/$sender_host_address
29846 .endd
29847 In fact, this is the check that Exim performs if the client does not say HELO.
29848 This extension can be turned off by setting the main configuration option
29849 &%dns_csa_use_reverse%& to be false.
29850
29851 If a CSA SRV record is not found for the domain itself, a search
29852 is performed through its parent domains for a record which might be
29853 making assertions about subdomains. The maximum depth of this search is limited
29854 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29855 default. Exim does not look for CSA SRV records in a top level domain, so the
29856 default settings handle HELO domains as long as seven
29857 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29858 of legitimate HELO domains.
29859
29860 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29861 direct SRV lookups, this is not sufficient because of the extra parent domain
29862 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29863 addresses into lookups in the reverse DNS space. The result of a successful
29864 lookup such as:
29865 .code
29866 ${lookup dnsdb {csa=$sender_helo_name}}
29867 .endd
29868 has two space-separated fields: an authorization code and a target host name.
29869 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29870 authorization required but absent, or &"?"& for unknown.
29871
29872
29873
29874
29875 .section "Bounce address tag validation" "SECTverifyPRVS"
29876 .cindex "BATV, verifying"
29877 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
29878 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
29879 Genuine incoming bounce messages should therefore always be addressed to
29880 recipients that have a valid tag. This scheme is a way of detecting unwanted
29881 bounce messages caused by sender address forgeries (often called &"collateral
29882 spam"&), because the recipients of such messages do not include valid tags.
29883
29884 There are two expansion items to help with the implementation of the BATV
29885 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
29886 the original envelope sender address by using a simple key to add a hash of the
29887 address and some time-based randomizing information. The &%prvs%& expansion
29888 item creates a signed address, and the &%prvscheck%& expansion item checks one.
29889 The syntax of these expansion items is described in section
29890 &<<SECTexpansionitems>>&.
29891
29892 As an example, suppose the secret per-address keys are stored in an MySQL
29893 database. A query to look up the key for an address could be defined as a macro
29894 like this:
29895 .code
29896 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
29897                 WHERE sender='${quote_mysql:$prvscheck_address}'\
29898                 }{$value}}
29899 .endd
29900 Suppose also that the senders who make use of BATV are defined by an address
29901 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
29902 use this:
29903 .code
29904 # Bounces: drop unsigned addresses for BATV senders
29905 deny message = This address does not send an unsigned reverse path
29906      senders = :
29907      recipients = +batv_senders
29908
29909 # Bounces: In case of prvs-signed address, check signature.
29910 deny message = Invalid reverse path signature.
29911      senders = :
29912      condition  = ${prvscheck {$local_part@$domain}\
29913                   {PRVSCHECK_SQL}{1}}
29914      !condition = $prvscheck_result
29915 .endd
29916 The first statement rejects recipients for bounce messages that are addressed
29917 to plain BATV sender addresses, because it is known that BATV senders do not
29918 send out messages with plain sender addresses. The second statement rejects
29919 recipients that are prvs-signed, but with invalid signatures (either because
29920 the key is wrong, or the signature has timed out).
29921
29922 A non-prvs-signed address is not rejected by the second statement, because the
29923 &%prvscheck%& expansion yields an empty string if its first argument is not a
29924 prvs-signed address, thus causing the &%condition%& condition to be false. If
29925 the first argument is a syntactically valid prvs-signed address, the yield is
29926 the third string (in this case &"1"&), whether or not the cryptographic and
29927 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29928 of the checks (empty for failure, &"1"& for success).
29929
29930 There is one more issue you must consider when implementing prvs-signing:
29931 you have to ensure that the routers accept prvs-signed addresses and
29932 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29933 router to remove the signature with a configuration along these lines:
29934 .code
29935 batv_redirect:
29936   driver = redirect
29937   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29938 .endd
29939 This works because, if the third argument of &%prvscheck%& is empty, the result
29940 of the expansion of a prvs-signed address is the decoded value of the original
29941 address. This router should probably be the first of your routers that handles
29942 local addresses.
29943
29944 To create BATV-signed addresses in the first place, a transport of this form
29945 can be used:
29946 .code
29947 external_smtp_batv:
29948   driver = smtp
29949   return_path = ${prvs {$return_path} \
29950                        {${lookup mysql{SELECT \
29951                        secret FROM batv_prvs WHERE \
29952                        sender='${quote_mysql:$sender_address}'} \
29953                        {$value}fail}}}
29954 .endd
29955 If no key can be found for the existing return path, no signing takes place.
29956
29957
29958
29959 .section "Using an ACL to control relaying" "SECTrelaycontrol"
29960 .cindex "&ACL;" "relay control"
29961 .cindex "relaying" "control by ACL"
29962 .cindex "policy control" "relay control"
29963 An MTA is said to &'relay'& a message if it receives it from some host and
29964 delivers it directly to another host as a result of a remote address contained
29965 within it. Redirecting a local address via an alias or forward file and then
29966 passing the message on to another host is not relaying,
29967 .cindex "&""percent hack""&"
29968 but a redirection as a result of the &"percent hack"& is.
29969
29970 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
29971 A host which is acting as a gateway or an MX backup is concerned with incoming
29972 relaying from arbitrary hosts to a specific set of domains. On the other hand,
29973 a host which is acting as a smart host for a number of clients is concerned
29974 with outgoing relaying from those clients to the Internet at large. Often the
29975 same host is fulfilling both functions,
29976 . ///
29977 . as illustrated in the diagram below,
29978 . ///
29979 but in principle these two kinds of relaying are entirely independent. What is
29980 not wanted is the transmission of mail from arbitrary remote hosts through your
29981 system to arbitrary domains.
29982
29983
29984 You can implement relay control by means of suitable statements in the ACL that
29985 runs for each RCPT command. For convenience, it is often easiest to use
29986 Exim's named list facility to define the domains and hosts involved. For
29987 example, suppose you want to do the following:
29988
29989 .ilist
29990 Deliver a number of domains to mailboxes on the local host (or process them
29991 locally in some other way). Let's say these are &'my.dom1.example'& and
29992 &'my.dom2.example'&.
29993 .next
29994 Relay mail for a number of other domains for which you are the secondary MX.
29995 These might be &'friend1.example'& and &'friend2.example'&.
29996 .next
29997 Relay mail from the hosts on your local LAN, to whatever domains are involved.
29998 Suppose your LAN is 192.168.45.0/24.
29999 .endlist
30000
30001
30002 In the main part of the configuration, you put the following definitions:
30003 .code
30004 domainlist local_domains    = my.dom1.example : my.dom2.example
30005 domainlist relay_to_domains = friend1.example : friend2.example
30006 hostlist   relay_from_hosts = 192.168.45.0/24
30007 .endd
30008 Now you can use these definitions in the ACL that is run for every RCPT
30009 command:
30010 .code
30011 acl_check_rcpt:
30012   accept domains = +local_domains : +relay_to_domains
30013   accept hosts   = +relay_from_hosts
30014 .endd
30015 The first statement accepts any RCPT command that contains an address in
30016 the local or relay domains. For any other domain, control passes to the second
30017 statement, which accepts the command only if it comes from one of the relay
30018 hosts. In practice, you will probably want to make your ACL more sophisticated
30019 than this, for example, by including sender and recipient verification. The
30020 default configuration includes a more comprehensive example, which is described
30021 in chapter &<<CHAPdefconfil>>&.
30022
30023
30024
30025 .section "Checking a relay configuration" "SECTcheralcon"
30026 .cindex "relaying" "checking control of"
30027 You can check the relay characteristics of your configuration in the same way
30028 that you can test any ACL behaviour for an incoming SMTP connection, by using
30029 the &%-bh%& option to run a fake SMTP session with which you interact.
30030
30031 For specifically testing for unwanted relaying, the host
30032 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30033 host from the host on which Exim is running, using the normal telnet port, you
30034 will see a normal telnet connection message and then quite a long delay. Be
30035 patient. The remote host is making an SMTP connection back to your host, and
30036 trying a number of common probes to test for open relay vulnerability. The
30037 results of the tests will eventually appear on your terminal.
30038 .ecindex IIDacl
30039
30040
30041
30042 . ////////////////////////////////////////////////////////////////////////////
30043 . ////////////////////////////////////////////////////////////////////////////
30044
30045 .chapter "Content scanning at ACL time" "CHAPexiscan"
30046 .scindex IIDcosca "content scanning" "at ACL time"
30047 The extension of Exim to include content scanning at ACL time, formerly known
30048 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30049 was integrated into the main source for Exim release 4.50, and Tom continues to
30050 maintain it. Most of the wording of this chapter is taken from Tom's
30051 specification.
30052
30053 It is also possible to scan the content of messages at other times. The
30054 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30055 scanning after all the ACLs have run. A transport filter can be used to scan
30056 messages at delivery time (see the &%transport_filter%& option, described in
30057 chapter &<<CHAPtransportgeneric>>&).
30058
30059 If you want to include the ACL-time content-scanning features when you compile
30060 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30061 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30062
30063 .ilist
30064 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30065 for all MIME parts for SMTP and non-SMTP messages, respectively.
30066 .next
30067 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30068 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30069 run at the end of message reception (the &%acl_smtp_data%& ACL).
30070 .next
30071 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30072 of messages, or parts of messages, for debugging purposes.
30073 .next
30074 Additional expansion variables that are set in the new ACL and by the new
30075 conditions.
30076 .next
30077 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30078 .endlist
30079
30080 There is another content-scanning configuration option for &_Local/Makefile_&,
30081 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30082 condition is compiled, in addition to all the other content-scanning features.
30083
30084 Content-scanning is continually evolving, and new features are still being
30085 added. While such features are still unstable and liable to incompatible
30086 changes, they are made available in Exim by setting options whose names begin
30087 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30088 this manual. You can find out about them by reading the file called
30089 &_doc/experimental.txt_&.
30090
30091 All the content-scanning facilities work on a MBOX copy of the message that is
30092 temporarily created in a file called:
30093 .display
30094 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30095 .endd
30096 The &_.eml_& extension is a friendly hint to virus scanners that they can
30097 expect an MBOX-like structure inside that file. The file is created when the
30098 first content scanning facility is called. Subsequent calls to content
30099 scanning conditions open the same file again. The directory is recursively
30100 removed when the &%acl_smtp_data%& ACL has finished running, unless
30101 .code
30102 control = no_mbox_unspool
30103 .endd
30104 has been encountered. When the MIME ACL decodes files, they are put into the
30105 same directory by default.
30106
30107
30108
30109 .section "Scanning for viruses" "SECTscanvirus"
30110 .cindex "virus scanning"
30111 .cindex "content scanning" "for viruses"
30112 .cindex "content scanning" "the &%malware%& condition"
30113 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30114 It supports a &"generic"& interface to scanners called via the shell, and
30115 specialized interfaces for &"daemon"& type virus scanners, which are resident
30116 in memory and thus are much faster.
30117
30118
30119 .oindex "&%av_scanner%&"
30120 You can set the &%av_scanner%& option in first part of the Exim configuration
30121 file to specify which scanner to use, together with any additional options that
30122 are needed. The basic syntax is as follows:
30123 .display
30124 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30125 .endd
30126 If you do not set &%av_scanner%&, it defaults to
30127 .code
30128 av_scanner = sophie:/var/run/sophie
30129 .endd
30130 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30131 before use.
30132 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30133 The following scanner types are supported in this release:
30134
30135 .vlist
30136 .vitem &%aveserver%&
30137 .cindex "virus scanners" "Kaspersky"
30138 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30139 at &url(http://www.kaspersky.com). This scanner type takes one option,
30140 which is the path to the daemon's UNIX socket. The default is shown in this
30141 example:
30142 .code
30143 av_scanner = aveserver:/var/run/aveserver
30144 .endd
30145
30146
30147 .vitem &%clamd%&
30148 .cindex "virus scanners" "clamd"
30149 This daemon-type scanner is GPL and free. You can get it at
30150 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30151 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30152 in the MIME ACL. This no longer believed to be necessary. One option is
30153 required: either the path and name of a UNIX socket file, or a hostname or IP
30154 number, and a port, separated by space, as in the second of these examples:
30155 .code
30156 av_scanner = clamd:/opt/clamd/socket
30157 av_scanner = clamd:192.0.2.3 1234
30158 av_scanner = clamd:192.0.2.3 1234:local
30159 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30160 .endd
30161 If the value of av_scanner points to a UNIX socket file or contains the local
30162 keyword, then the ClamAV interface will pass a filename containing the data
30163 to be scanned, which will should normally result in less I/O happening and be
30164 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30165 Exim does not assume that there is a common filesystem with the remote host.
30166 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30167 you be running a version of ClamAV prior to 0.95.
30168
30169 The final example shows that multiple TCP targets can be specified.  Exim will
30170 randomly use one for each incoming email (i.e. it load balances them).  Note
30171 that only TCP targets may be used if specifying a list of scanners; a UNIX
30172 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30173 unavailable, Exim will try the remaining one(s) until it finds one that works.
30174 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30175 not keep track of scanner state between multiple messages, and the scanner
30176 selection is random, so the message will get logged in the mainlog for each
30177 email that the down scanner gets chosen first (message wrapped to be readable):
30178 .code
30179 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30180    clamd: connection to localhost, port 3310 failed
30181    (Connection refused)
30182 .endd
30183
30184 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30185 contributing the code for this scanner.
30186
30187 .vitem &%cmdline%&
30188 .cindex "virus scanners" "command line interface"
30189 This is the keyword for the generic command line scanner interface. It can be
30190 used to attach virus scanners that are invoked from the shell. This scanner
30191 type takes 3 mandatory options:
30192
30193 .olist
30194 The full path and name of the scanner binary, with all command line options,
30195 and a placeholder (&`%s`&) for the directory to scan.
30196
30197 .next
30198 A regular expression to match against the STDOUT and STDERR output of the
30199 virus scanner. If the expression matches, a virus was found. You must make
30200 absolutely sure that this expression matches on &"virus found"&. This is called
30201 the &"trigger"& expression.
30202
30203 .next
30204 Another regular expression, containing exactly one pair of parentheses, to
30205 match the name of the virus found in the scanners output. This is called the
30206 &"name"& expression.
30207 .endlist olist
30208
30209 For example, Sophos Sweep reports a virus on a line like this:
30210 .code
30211 Virus 'W32/Magistr-B' found in file ./those.bat
30212 .endd
30213 For the trigger expression, we can match the phrase &"found in file"&. For the
30214 name expression, we want to extract the W32/Magistr-B string, so we can match
30215 for the single quotes left and right of it. Altogether, this makes the
30216 configuration setting:
30217 .code
30218 av_scanner = cmdline:\
30219              /path/to/sweep -ss -all -rec -archive %s:\
30220              found in file:'(.+)'
30221 .endd
30222 .vitem &%drweb%&
30223 .cindex "virus scanners" "DrWeb"
30224 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
30225 argument, either a full path to a UNIX socket, or an IP address and port
30226 separated by white space, as in these examples:
30227 .code
30228 av_scanner = drweb:/var/run/drwebd.sock
30229 av_scanner = drweb:192.168.2.20 31337
30230 .endd
30231 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30232 is used. Thanks to Alex Miller for contributing the code for this scanner.
30233
30234 .vitem &%fsecure%&
30235 .cindex "virus scanners" "F-Secure"
30236 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30237 argument which is the path to a UNIX socket. For example:
30238 .code
30239 av_scanner = fsecure:/path/to/.fsav
30240 .endd
30241 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30242 Thelmen for contributing the code for this scanner.
30243
30244 .vitem &%kavdaemon%&
30245 .cindex "virus scanners" "Kaspersky"
30246 This is the scanner daemon of Kaspersky Version 4. This version of the
30247 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30248 scanner type takes one option, which is the path to the daemon's UNIX socket.
30249 For example:
30250 .code
30251 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30252 .endd
30253 The default path is &_/var/run/AvpCtl_&.
30254
30255 .vitem &%mksd%&
30256 .cindex "virus scanners" "mksd"
30257 This is a daemon type scanner that is aimed mainly at Polish users, though some
30258 parts of documentation are now available in English. You can get it at
30259 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30260 the maximum number of processes used simultaneously to scan the attachments,
30261 provided that the demime facility is employed and also provided that mksd has
30262 been run with at least the same number of child processes. For example:
30263 .code
30264 av_scanner = mksd:2
30265 .endd
30266 You can safely omit this option (the default value is 1).
30267
30268 .vitem &%sock%&
30269 .cindex "virus scanners" "simple socket-connected"
30270 This is a general-purpose way of talking to simple scanner daemons
30271 running on the local machine.
30272 There are four options:
30273 an address (which may be an IP addres and port, or the path of a Unix socket),
30274 a commandline to send (may include a single %s which will be replaced with
30275 the path to the mail file to be scanned),
30276 an RE to trigger on from the returned data,
30277 an RE to extract malware_name from the returned data.
30278 For example:
30279 .code
30280 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30281 .endd
30282 Default for the socket specifier is &_/tmp/malware.sock_&.
30283 Default for the commandline is &_%s\n_&.
30284 Both regular-expressions are required.
30285
30286 .vitem &%sophie%&
30287 .cindex "virus scanners" "Sophos and Sophie"
30288 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30289 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30290 for this scanner type is the path to the UNIX socket that Sophie uses for
30291 client communication. For example:
30292 .code
30293 av_scanner = sophie:/tmp/sophie
30294 .endd
30295 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30296 the option.
30297 .endlist
30298
30299 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30300 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30301 ACL.
30302
30303 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30304 makes it possible to use different scanners. See further below for an example.
30305 The &%malware%& condition caches its results, so when you use it multiple times
30306 for the same message, the actual scanning process is only carried out once.
30307 However, using expandable items in &%av_scanner%& disables this caching, in
30308 which case each use of the &%malware%& condition causes a new scan of the
30309 message.
30310
30311 The &%malware%& condition takes a right-hand argument that is expanded before
30312 use. It can then be one of
30313
30314 .ilist
30315 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30316 The condition succeeds if a virus was found, and fail otherwise. This is the
30317 recommended usage.
30318 .next
30319 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30320 the condition fails immediately.
30321 .next
30322 A regular expression, in which case the message is scanned for viruses. The
30323 condition succeeds if a virus is found and its name matches the regular
30324 expression. This allows you to take special actions on certain types of virus.
30325 .endlist
30326
30327 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
30328 even if there is a problem with the virus scanner. Otherwise, such a problem
30329 causes the ACL to defer.
30330
30331 .vindex "&$malware_name$&"
30332 When a virus is found, the condition sets up an expansion variable called
30333 &$malware_name$& that contains the name of the virus. You can use it in a
30334 &%message%& modifier that specifies the error returned to the sender, and/or in
30335 logging data.
30336
30337 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30338 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30339 &%malware%& condition.
30340
30341 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30342 imposed by your anti-virus scanner.
30343
30344 Here is a very simple scanning example:
30345 .code
30346 deny message = This message contains malware ($malware_name)
30347      demime = *
30348      malware = *
30349 .endd
30350 The next example accepts messages when there is a problem with the scanner:
30351 .code
30352 deny message = This message contains malware ($malware_name)
30353      demime = *
30354      malware = */defer_ok
30355 .endd
30356 The next example shows how to use an ACL variable to scan with both sophie and
30357 aveserver. It assumes you have set:
30358 .code
30359 av_scanner = $acl_m0
30360 .endd
30361 in the main Exim configuration.
30362 .code
30363 deny message = This message contains malware ($malware_name)
30364      set acl_m0 = sophie
30365      malware = *
30366
30367 deny message = This message contains malware ($malware_name)
30368      set acl_m0 = aveserver
30369      malware = *
30370 .endd
30371
30372
30373 .section "Scanning with SpamAssassin" "SECTscanspamass"
30374 .cindex "content scanning" "for spam"
30375 .cindex "spam scanning"
30376 .cindex "SpamAssassin"
30377 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30378 score and a report for the message. You can get SpamAssassin at
30379 &url(http://www.spamassassin.org), or, if you have a working Perl
30380 installation, you can use CPAN by running:
30381 .code
30382 perl -MCPAN -e 'install Mail::SpamAssassin'
30383 .endd
30384 SpamAssassin has its own set of configuration files. Please review its
30385 documentation to see how you can tweak it. The default installation should work
30386 nicely, however.
30387
30388 .oindex "&%spamd_address%&"
30389 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
30390 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
30391 port for &%spamd%&, you must set the &%spamd_address%& option in the global
30392 part of the Exim configuration as follows (example):
30393 .code
30394 spamd_address = 192.168.99.45 387
30395 .endd
30396 You do not need to set this option if you use the default. As of version 2.60,
30397 &%spamd%& also supports communication over UNIX sockets. If you want to use
30398 these, supply &%spamd_address%& with an absolute file name instead of a
30399 address/port pair:
30400 .code
30401 spamd_address = /var/run/spamd_socket
30402 .endd
30403 You can have multiple &%spamd%& servers to improve scalability. These can
30404 reside on other hardware reachable over the network. To specify multiple
30405 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30406 option, separated with colons:
30407 .code
30408 spamd_address = 192.168.2.10 783 : \
30409                 192.168.2.11 783 : \
30410                 192.168.2.12 783
30411 .endd
30412 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
30413 fashion. When a server fails to respond to the connection attempt, all other
30414 servers are tried until one succeeds. If no server responds, the &%spam%&
30415 condition defers.
30416
30417 &*Warning*&: It is not possible to use the UNIX socket connection method with
30418 multiple &%spamd%& servers.
30419
30420 The &%spamd_address%& variable is expanded before use if it starts with
30421 a dollar sign. In this case, the expansion may return a string that is
30422 used as the list so that multiple spamd servers can be the result of an
30423 expansion.
30424
30425 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30426 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30427 .code
30428 deny message = This message was classified as SPAM
30429      spam = joe
30430 .endd
30431 The right-hand side of the &%spam%& condition specifies a name. This is
30432 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30433 to scan using a specific profile, but rather use the SpamAssassin system-wide
30434 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30435 However, you must put something on the right-hand side.
30436
30437 The name allows you to use per-domain or per-user antispam profiles in
30438 principle, but this is not straightforward in practice, because a message may
30439 have multiple recipients, not necessarily all in the same domain. Because the
30440 &%spam%& condition has to be called from a DATA ACL in order to be able to
30441 read the contents of the message, the variables &$local_part$& and &$domain$&
30442 are not set.
30443
30444 The right-hand side of the &%spam%& condition is expanded before being used, so
30445 you can put lookups or conditions there. When the right-hand side evaluates to
30446 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30447
30448
30449 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30450 large ones may cause significant performance degradation. As most spam messages
30451 are quite small, it is recommended that you do not scan the big ones. For
30452 example:
30453 .code
30454 deny message = This message was classified as SPAM
30455      condition = ${if < {$message_size}{10K}}
30456      spam = nobody
30457 .endd
30458
30459 The &%spam%& condition returns true if the threshold specified in the user's
30460 SpamAssassin profile has been matched or exceeded. If you want to use the
30461 &%spam%& condition for its side effects (see the variables below), you can make
30462 it always return &"true"& by appending &`:true`& to the username.
30463
30464 .cindex "spam scanning" "returned variables"
30465 When the &%spam%& condition is run, it sets up a number of expansion
30466 variables. These variables are saved with the received message, thus they are
30467 available for use at delivery time.
30468
30469 .vlist
30470 .vitem &$spam_score$&
30471 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30472 for inclusion in log or reject messages.
30473
30474 .vitem &$spam_score_int$&
30475 The spam score of the message, multiplied by ten, as an integer value. For
30476 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30477 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30478 The integer value is useful for numeric comparisons in conditions.
30479
30480 .vitem &$spam_bar$&
30481 A string consisting of a number of &"+"& or &"-"& characters, representing the
30482 integer part of the spam score value. A spam score of 4.4 would have a
30483 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30484 headers, since MUAs can match on such strings.
30485
30486 .vitem &$spam_report$&
30487 A multiline text table, containing the full SpamAssassin report for the
30488 message. Useful for inclusion in headers or reject messages.
30489 .endlist
30490
30491 The &%spam%& condition caches its results unless expansion in
30492 spamd_address was used. If you call it again with the same user name, it
30493 does not scan again, but rather returns the same values as before.
30494
30495 The &%spam%& condition returns DEFER if there is any error while running
30496 the message through SpamAssassin or if the expansion of spamd_address
30497 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30498 statement block), append &`/defer_ok`& to the right-hand side of the
30499 spam condition, like this:
30500 .code
30501 deny message = This message was classified as SPAM
30502      spam    = joe/defer_ok
30503 .endd
30504 This causes messages to be accepted even if there is a problem with &%spamd%&.
30505
30506 Here is a longer, commented example of the use of the &%spam%&
30507 condition:
30508 .code
30509 # put headers in all messages (no matter if spam or not)
30510 warn  spam = nobody:true
30511       add_header = X-Spam-Score: $spam_score ($spam_bar)
30512       add_header = X-Spam-Report: $spam_report
30513
30514 # add second subject line with *SPAM* marker when message
30515 # is over threshold
30516 warn  spam = nobody
30517       add_header = Subject: *SPAM* $h_Subject:
30518
30519 # reject spam at high scores (> 12)
30520 deny  message = This message scored $spam_score spam points.
30521       spam = nobody:true
30522       condition = ${if >{$spam_score_int}{120}{1}{0}}
30523 .endd
30524
30525
30526
30527 .section "Scanning MIME parts" "SECTscanmimepart"
30528 .cindex "content scanning" "MIME parts"
30529 .cindex "MIME content scanning"
30530 .oindex "&%acl_smtp_mime%&"
30531 .oindex "&%acl_not_smtp_mime%&"
30532 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30533 each MIME part of an SMTP message, including multipart types, in the sequence
30534 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30535 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30536 options may both refer to the same ACL if you want the same processing in both
30537 cases.
30538
30539 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30540 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30541 the case of a non-SMTP message. However, a MIME ACL is called only if the
30542 message contains a &'Content-Type:'& header line. When a call to a MIME
30543 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30544 result code is sent to the client. In the case of an SMTP message, the
30545 &%acl_smtp_data%& ACL is not called when this happens.
30546
30547 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30548 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30549 condition to match against the raw MIME part. You can also use the
30550 &%mime_regex%& condition to match against the decoded MIME part (see section
30551 &<<SECTscanregex>>&).
30552
30553 At the start of a MIME ACL, a number of variables are set from the header
30554 information for the relevant MIME part. These are described below. The contents
30555 of the MIME part are not by default decoded into a disk file except for MIME
30556 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30557 part into a disk file, you can use the &%decode%& condition. The general
30558 syntax is:
30559 .display
30560 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30561 .endd
30562 The right hand side is expanded before use. After expansion,
30563 the value can be:
30564
30565 .olist
30566 &"0"& or &"false"&, in which case no decoding is done.
30567 .next
30568 The string &"default"&. In that case, the file is put in the temporary
30569 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30570 a sequential file name consisting of the message id and a sequence number. The
30571 full path and name is available in &$mime_decoded_filename$& after decoding.
30572 .next
30573 A full path name starting with a slash. If the full name is an existing
30574 directory, it is used as a replacement for the default directory. The filename
30575 is then sequentially assigned. If the path does not exist, it is used as
30576 the full path and file name.
30577 .next
30578 If the string does not start with a slash, it is used as the
30579 filename, and the default path is then used.
30580 .endlist
30581 The &%decode%& condition normally succeeds. It is only false for syntax
30582 errors or unusual circumstances such as memory shortages. You can easily decode
30583 a file with its original, proposed filename using
30584 .code
30585 decode = $mime_filename
30586 .endd
30587 However, you should keep in mind that &$mime_filename$& might contain
30588 anything. If you place files outside of the default path, they are not
30589 automatically unlinked.
30590
30591 For RFC822 attachments (these are messages attached to messages, with a
30592 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30593 as for the primary message, only that the &$mime_is_rfc822$& expansion
30594 variable is set (see below). Attached messages are always decoded to disk
30595 before being checked, and the files are unlinked once the check is done.
30596
30597 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30598 used to match regular expressions against raw and decoded MIME parts,
30599 respectively. They are described in section &<<SECTscanregex>>&.
30600
30601 .cindex "MIME content scanning" "returned variables"
30602 The following list describes all expansion variables that are
30603 available in the MIME ACL:
30604
30605 .vlist
30606 .vitem &$mime_boundary$&
30607 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30608 have a boundary string, which is stored in this variable. If the current part
30609 has no boundary parameter in the &'Content-Type:'& header, this variable
30610 contains the empty string.
30611
30612 .vitem &$mime_charset$&
30613 This variable contains the character set identifier, if one was found in the
30614 &'Content-Type:'& header. Examples for charset identifiers are:
30615 .code
30616 us-ascii
30617 gb2312 (Chinese)
30618 iso-8859-1
30619 .endd
30620 Please note that this value is not normalized, so you should do matches
30621 case-insensitively.
30622
30623 .vitem &$mime_content_description$&
30624 This variable contains the normalized content of the &'Content-Description:'&
30625 header. It can contain a human-readable description of the parts content. Some
30626 implementations repeat the filename for attachments here, but they are usually
30627 only used for display purposes.
30628
30629 .vitem &$mime_content_disposition$&
30630 This variable contains the normalized content of the &'Content-Disposition:'&
30631 header. You can expect strings like &"attachment"& or &"inline"& here.
30632
30633 .vitem &$mime_content_id$&
30634 This variable contains the normalized content of the &'Content-ID:'& header.
30635 This is a unique ID that can be used to reference a part from another part.
30636
30637 .vitem &$mime_content_size$&
30638 This variable is set only after the &%decode%& modifier (see above) has been
30639 successfully run. It contains the size of the decoded part in kilobytes. The
30640 size is always rounded up to full kilobytes, so only a completely empty part
30641 has a &$mime_content_size$& of zero.
30642
30643 .vitem &$mime_content_transfer_encoding$&
30644 This variable contains the normalized content of the
30645 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30646 type. Typical values are &"base64"& and &"quoted-printable"&.
30647
30648 .vitem &$mime_content_type$&
30649 If the MIME part has a &'Content-Type:'& header, this variable contains its
30650 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30651 are some examples of popular MIME types, as they may appear in this variable:
30652 .code
30653 text/plain
30654 text/html
30655 application/octet-stream
30656 image/jpeg
30657 audio/midi
30658 .endd
30659 If the MIME part has no &'Content-Type:'& header, this variable contains the
30660 empty string.
30661
30662 .vitem &$mime_decoded_filename$&
30663 This variable is set only after the &%decode%& modifier (see above) has been
30664 successfully run. It contains the full path and file name of the file
30665 containing the decoded data.
30666 .endlist
30667
30668 .cindex "RFC 2047"
30669 .vlist
30670 .vitem &$mime_filename$&
30671 This is perhaps the most important of the MIME variables. It contains a
30672 proposed filename for an attachment, if one was found in either the
30673 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30674 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30675 found, this variable contains the empty string.
30676
30677 .vitem &$mime_is_coverletter$&
30678 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30679 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30680 content in the cover letter, while not restricting attachments at all.
30681
30682 The variable contains 1 (true) for a MIME part believed to be part of the
30683 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30684 follows:
30685
30686 .olist
30687 The outermost MIME part of a message is always a cover letter.
30688
30689 .next
30690 If a multipart/alternative or multipart/related MIME part is a cover letter,
30691 so are all MIME subparts within that multipart.
30692
30693 .next
30694 If any other multipart is a cover letter, the first subpart is a cover letter,
30695 and the rest are attachments.
30696
30697 .next
30698 All parts contained within an attachment multipart are attachments.
30699 .endlist olist
30700
30701 As an example, the following will ban &"HTML mail"& (including that sent with
30702 alternative plain text), while allowing HTML files to be attached. HTML
30703 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30704 .code
30705 deny message = HTML mail is not accepted here
30706 !condition = $mime_is_rfc822
30707 condition = $mime_is_coverletter
30708 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30709 .endd
30710 .vitem &$mime_is_multipart$&
30711 This variable has the value 1 (true) when the current part has the main type
30712 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30713 Since multipart entities only serve as containers for other parts, you may not
30714 want to carry out specific actions on them.
30715
30716 .vitem &$mime_is_rfc822$&
30717 This variable has the value 1 (true) if the current part is not a part of the
30718 checked message itself, but part of an attached message. Attached message
30719 decoding is fully recursive.
30720
30721 .vitem &$mime_part_count$&
30722 This variable is a counter that is raised for each processed MIME part. It
30723 starts at zero for the very first part (which is usually a multipart). The
30724 counter is per-message, so it is reset when processing RFC822 attachments (see
30725 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
30726 complete, so you can use it in the DATA ACL to determine the number of MIME
30727 parts of a message. For non-MIME messages, this variable contains the value -1.
30728 .endlist
30729
30730
30731
30732 .section "Scanning with regular expressions" "SECTscanregex"
30733 .cindex "content scanning" "with regular expressions"
30734 .cindex "regular expressions" "content scanning with"
30735 You can specify your own custom regular expression matches on the full body of
30736 the message, or on individual MIME parts.
30737
30738 The &%regex%& condition takes one or more regular expressions as arguments and
30739 matches them against the full message (when called in the DATA ACL) or a raw
30740 MIME part (when called in the MIME ACL). The &%regex%& condition matches
30741 linewise, with a maximum line length of 32K characters. That means you cannot
30742 have multiline matches with the &%regex%& condition.
30743
30744 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30745 to 32K of decoded content (the whole content at once, not linewise). If the
30746 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30747 is decoded automatically when &%mime_regex%& is executed (using default path
30748 and filename values). If the decoded data is larger than  32K, only the first
30749 32K characters are checked.
30750
30751 The regular expressions are passed as a colon-separated list. To include a
30752 literal colon, you must double it. Since the whole right-hand side string is
30753 expanded before being used, you must also escape dollar signs and backslashes
30754 with more backslashes, or use the &`\N`& facility to disable expansion.
30755 Here is a simple example that contains two regular expressions:
30756 .code
30757 deny message = contains blacklisted regex ($regex_match_string)
30758      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30759 .endd
30760 The conditions returns true if any one of the regular expressions matches. The
30761 &$regex_match_string$& expansion variable is then set up and contains the
30762 matching regular expression.
30763
30764 &*Warning*&: With large messages, these conditions can be fairly
30765 CPU-intensive.
30766
30767
30768
30769
30770 .section "The demime condition" "SECTdemimecond"
30771 .cindex "content scanning" "MIME checking"
30772 .cindex "MIME content scanning"
30773 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30774 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30775 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30776 ACL functionality, but provides no additional facilities. Please note that this
30777 condition is deprecated and kept only for backward compatibility. You must set
30778 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30779 use the &%demime%& condition.
30780
30781 The &%demime%& condition unpacks MIME containers in the message. It detects
30782 errors in MIME containers and can match file extensions found in the message
30783 against a list. Using this facility produces files containing the unpacked MIME
30784 parts of the message in the temporary scan directory. If you do antivirus
30785 scanning, it is recommended that you use the &%demime%& condition before the
30786 antivirus (&%malware%&) condition.
30787
30788 On the right-hand side of the &%demime%& condition you can pass a
30789 colon-separated list of file extensions that it should match against. For
30790 example:
30791 .code
30792 deny message = Found blacklisted file attachment
30793      demime  = vbs:com:bat:pif:prf:lnk
30794 .endd
30795 If one of the file extensions is found, the condition is true, otherwise it is
30796 false. If there is a temporary error while demimeing (for example, &"disk
30797 full"&), the condition defers, and the message is temporarily rejected (unless
30798 the condition is on a &%warn%& verb).
30799
30800 The right-hand side is expanded before being treated as a list, so you can have
30801 conditions and lookups there. If it expands to an empty string, &"false"&, or
30802 zero (&"0"&), no demimeing is done and the condition is false.
30803
30804 The &%demime%& condition set the following variables:
30805
30806 .vlist
30807 .vitem &$demime_errorlevel$&
30808 .vindex "&$demime_errorlevel$&"
30809 When an error is detected in a MIME container, this variable contains the
30810 severity of the error, as an integer number. The higher the value, the more
30811 severe the error (the current maximum value is 3). If this variable is unset or
30812 zero, no error occurred.
30813
30814 .vitem &$demime_reason$&
30815 .vindex "&$demime_reason$&"
30816 When &$demime_errorlevel$& is greater than zero, this variable contains a
30817 human-readable text string describing the MIME error that occurred.
30818 .endlist
30819
30820 .vlist
30821 .vitem &$found_extension$&
30822 .vindex "&$found_extension$&"
30823 When the &%demime%& condition is true, this variable contains the file
30824 extension it found.
30825 .endlist
30826
30827 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30828 the &%demime%& condition, and are not changed on subsequent calls.
30829
30830 If you do not want to check for file extensions, but rather use the &%demime%&
30831 condition for unpacking or error checking purposes, pass &"*"& as the
30832 right-hand side value. Here is a more elaborate example of how to use this
30833 facility:
30834 .code
30835 # Reject messages with serious MIME container errors
30836 deny  message = Found MIME error ($demime_reason).
30837       demime = *
30838       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30839
30840 # Reject known virus spreading file extensions.
30841 # Accepting these is pretty much braindead.
30842 deny  message = contains $found_extension file (blacklisted).
30843       demime  = com:vbs:bat:pif:scr
30844
30845 # Freeze .exe and .doc files. Postmaster can
30846 # examine them and eventually thaw them.
30847 deny  log_message = Another $found_extension file.
30848       demime = exe:doc
30849       control = freeze
30850 .endd
30851 .ecindex IIDcosca
30852
30853
30854
30855
30856 . ////////////////////////////////////////////////////////////////////////////
30857 . ////////////////////////////////////////////////////////////////////////////
30858
30859 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30860          "Local scan function"
30861 .scindex IIDlosca "&[local_scan()]& function" "description of"
30862 .cindex "customizing" "input scan using C function"
30863 .cindex "policy control" "by local scan function"
30864 In these days of email worms, viruses, and ever-increasing spam, some sites
30865 want to apply a lot of checking to messages before accepting them.
30866
30867 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30868 passing messages to external virus and spam scanning software. You can also do
30869 a certain amount in Exim itself through string expansions and the &%condition%&
30870 condition in the ACL that runs after the SMTP DATA command or the ACL for
30871 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30872
30873 To allow for further customization to a site's own requirements, there is the
30874 possibility of linking Exim with a private message scanning function, written
30875 in C. If you want to run code that is written in something other than C, you
30876 can of course use a little C stub to call it.
30877
30878 The local scan function is run once for every incoming message, at the point
30879 when Exim is just about to accept the message.
30880 It can therefore be used to control non-SMTP messages from local processes as
30881 well as messages arriving via SMTP.
30882
30883 Exim applies a timeout to calls of the local scan function, and there is an
30884 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
30885 Zero means &"no timeout"&.
30886 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
30887 before calling the local scan function, so that the most common types of crash
30888 are caught. If the timeout is exceeded or one of those signals is caught, the
30889 incoming message is rejected with a temporary error if it is an SMTP message.
30890 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
30891 code. The incident is logged on the main and reject logs.
30892
30893
30894
30895 .section "Building Exim to use a local scan function" "SECID207"
30896 .cindex "&[local_scan()]& function" "building Exim to use"
30897 To make use of the local scan function feature, you must tell Exim where your
30898 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
30899 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
30900 directory, so you might set
30901 .code
30902 LOCAL_SCAN_SOURCE=Local/local_scan.c
30903 .endd
30904 for example. The function must be called &[local_scan()]&. It is called by
30905 Exim after it has received a message, when the success return code is about to
30906 be sent. This is after all the ACLs have been run. The return code from your
30907 function controls whether the message is actually accepted or not. There is a
30908 commented template function (that just accepts the message) in the file
30909 _src/local_scan.c_.
30910
30911 If you want to make use of Exim's run time configuration file to set options
30912 for your &[local_scan()]& function, you must also set
30913 .code
30914 LOCAL_SCAN_HAS_OPTIONS=yes
30915 .endd
30916 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
30917
30918
30919
30920
30921 .section "API for local_scan()" "SECTapiforloc"
30922 .cindex "&[local_scan()]& function" "API description"
30923 You must include this line near the start of your code:
30924 .code
30925 #include "local_scan.h"
30926 .endd
30927 This header file defines a number of variables and other values, and the
30928 prototype for the function itself. Exim is coded to use unsigned char values
30929 almost exclusively, and one of the things this header defines is a shorthand
30930 for &`unsigned char`& called &`uschar`&.
30931 It also contains the following macro definitions, to simplify casting character
30932 strings and pointers to character strings:
30933 .code
30934 #define CS   (char *)
30935 #define CCS  (const char *)
30936 #define CSS  (char **)
30937 #define US   (unsigned char *)
30938 #define CUS  (const unsigned char *)
30939 #define USS  (unsigned char **)
30940 .endd
30941 The function prototype for &[local_scan()]& is:
30942 .code
30943 extern int local_scan(int fd, uschar **return_text);
30944 .endd
30945 The arguments are as follows:
30946
30947 .ilist
30948 &%fd%& is a file descriptor for the file that contains the body of the message
30949 (the -D file). The file is open for reading and writing, but updating it is not
30950 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30951
30952 The descriptor is positioned at character 19 of the file, which is the first
30953 character of the body itself, because the first 19 characters are the message
30954 id followed by &`-D`& and a newline. If you rewind the file, you should use the
30955 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
30956 case this changes in some future version.
30957 .next
30958 &%return_text%& is an address which you can use to return a pointer to a text
30959 string at the end of the function. The value it points to on entry is NULL.
30960 .endlist
30961
30962 The function must return an &%int%& value which is one of the following macros:
30963
30964 .vlist
30965 .vitem &`LOCAL_SCAN_ACCEPT`&
30966 .vindex "&$local_scan_data$&"
30967 The message is accepted. If you pass back a string of text, it is saved with
30968 the message, and made available in the variable &$local_scan_data$&. No
30969 newlines are permitted (if there are any, they are turned into spaces) and the
30970 maximum length of text is 1000 characters.
30971
30972 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
30973 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30974 queued without immediate delivery, and is frozen.
30975
30976 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
30977 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30978 queued without immediate delivery.
30979
30980 .vitem &`LOCAL_SCAN_REJECT`&
30981 The message is rejected; the returned text is used as an error message which is
30982 passed back to the sender and which is also logged. Newlines are permitted &--
30983 they cause a multiline response for SMTP rejections, but are converted to
30984 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
30985 used.
30986
30987 .vitem &`LOCAL_SCAN_TEMPREJECT`&
30988 The message is temporarily rejected; the returned text is used as an error
30989 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
30990 problem"& is used.
30991
30992 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
30993 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
30994 message is not written to the reject log. It has the effect of unsetting the
30995 &%rejected_header%& log selector for just this rejection. If
30996 &%rejected_header%& is already unset (see the discussion of the
30997 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
30998 same as LOCAL_SCAN_REJECT.
30999
31000 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31001 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31002 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31003 .endlist
31004
31005 If the message is not being received by interactive SMTP, rejections are
31006 reported by writing to &%stderr%& or by sending an email, as configured by the
31007 &%-oe%& command line options.
31008
31009
31010
31011 .section "Configuration options for local_scan()" "SECTconoptloc"
31012 .cindex "&[local_scan()]& function" "configuration options"
31013 It is possible to have option settings in the main configuration file
31014 that set values in static variables in the &[local_scan()]& module. If you
31015 want to do this, you must have the line
31016 .code
31017 LOCAL_SCAN_HAS_OPTIONS=yes
31018 .endd
31019 in your &_Local/Makefile_& when you build Exim. (This line is in
31020 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31021 file, you must define static variables to hold the option values, and a table
31022 to define them.
31023
31024 The table must be a vector called &%local_scan_options%&, of type
31025 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31026 and a pointer to the variable that holds the value. The entries must appear in
31027 alphabetical order. Following &%local_scan_options%& you must also define a
31028 variable called &%local_scan_options_count%& that contains the number of
31029 entries in the table. Here is a short example, showing two kinds of option:
31030 .code
31031 static int my_integer_option = 42;
31032 static uschar *my_string_option = US"a default string";
31033
31034 optionlist local_scan_options[] = {
31035   { "my_integer", opt_int,       &my_integer_option },
31036   { "my_string",  opt_stringptr, &my_string_option }
31037 };
31038
31039 int local_scan_options_count =
31040   sizeof(local_scan_options)/sizeof(optionlist);
31041 .endd
31042 The values of the variables can now be changed from Exim's runtime
31043 configuration file by including a local scan section as in this example:
31044 .code
31045 begin local_scan
31046 my_integer = 99
31047 my_string = some string of text...
31048 .endd
31049 The available types of option data are as follows:
31050
31051 .vlist
31052 .vitem &*opt_bool*&
31053 This specifies a boolean (true/false) option. The address should point to a
31054 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31055 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31056 whether such a variable has been set at all, you can initialize it to
31057 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31058 values.)
31059
31060 .vitem &*opt_fixed*&
31061 This specifies a fixed point number, such as is used for load averages.
31062 The address should point to a variable of type &`int`&. The value is stored
31063 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31064
31065 .vitem &*opt_int*&
31066 This specifies an integer; the address should point to a variable of type
31067 &`int`&. The value may be specified in any of the integer formats accepted by
31068 Exim.
31069
31070 .vitem &*opt_mkint*&
31071 This is the same as &%opt_int%&, except that when such a value is output in a
31072 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31073 printed with the suffix K or M.
31074
31075 .vitem &*opt_octint*&
31076 This also specifies an integer, but the value is always interpreted as an
31077 octal integer, whether or not it starts with the digit zero, and it is
31078 always output in octal.
31079
31080 .vitem &*opt_stringptr*&
31081 This specifies a string value; the address must be a pointer to a
31082 variable that points to a string (for example, of type &`uschar *`&).
31083
31084 .vitem &*opt_time*&
31085 This specifies a time interval value. The address must point to a variable of
31086 type &`int`&. The value that is placed there is a number of seconds.
31087 .endlist
31088
31089 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31090 out the values of all the &[local_scan()]& options.
31091
31092
31093
31094 .section "Available Exim variables" "SECID208"
31095 .cindex "&[local_scan()]& function" "available Exim variables"
31096 The header &_local_scan.h_& gives you access to a number of C variables. These
31097 are the only ones that are guaranteed to be maintained from release to release.
31098 Note, however, that you can obtain the value of any Exim expansion variable,
31099 including &$recipients$&, by calling &'expand_string()'&. The exported
31100 C variables are as follows:
31101
31102 .vlist
31103 .vitem &*int&~body_linecount*&
31104 This variable contains the number of lines in the message's body.
31105
31106 .vitem &*int&~body_zerocount*&
31107 This variable contains the number of binary zero bytes in the message's body.
31108
31109 .vitem &*unsigned&~int&~debug_selector*&
31110 This variable is set to zero when no debugging is taking place. Otherwise, it
31111 is a bitmap of debugging selectors. Two bits are identified for use in
31112 &[local_scan()]&; they are defined as macros:
31113
31114 .ilist
31115 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31116 testing option that is not privileged &-- any caller may set it. All the
31117 other selector bits can be set only by admin users.
31118
31119 .next
31120 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31121 by the &`+local_scan`& debug selector. It is not included in the default set
31122 of debugging bits.
31123 .endlist ilist
31124
31125 Thus, to write to the debugging output only when &`+local_scan`& has been
31126 selected, you should use code like this:
31127 .code
31128 if ((debug_selector & D_local_scan) != 0)
31129   debug_printf("xxx", ...);
31130 .endd
31131 .vitem &*uschar&~*expand_string_message*&
31132 After a failing call to &'expand_string()'& (returned value NULL), the
31133 variable &%expand_string_message%& contains the error message, zero-terminated.
31134
31135 .vitem &*header_line&~*header_list*&
31136 A pointer to a chain of header lines. The &%header_line%& structure is
31137 discussed below.
31138
31139 .vitem &*header_line&~*header_last*&
31140 A pointer to the last of the header lines.
31141
31142 .vitem &*uschar&~*headers_charset*&
31143 The value of the &%headers_charset%& configuration option.
31144
31145 .vitem &*BOOL&~host_checking*&
31146 This variable is TRUE during a host checking session that is initiated by the
31147 &%-bh%& command line option.
31148
31149 .vitem &*uschar&~*interface_address*&
31150 The IP address of the interface that received the message, as a string. This
31151 is NULL for locally submitted messages.
31152
31153 .vitem &*int&~interface_port*&
31154 The port on which this message was received. When testing with the &%-bh%&
31155 command line option, the value of this variable is -1 unless a port has been
31156 specified via the &%-oMi%& option.
31157
31158 .vitem &*uschar&~*message_id*&
31159 This variable contains Exim's message id for the incoming message (the value of
31160 &$message_exim_id$&) as a zero-terminated string.
31161
31162 .vitem &*uschar&~*received_protocol*&
31163 The name of the protocol by which the message was received.
31164
31165 .vitem &*int&~recipients_count*&
31166 The number of accepted recipients.
31167
31168 .vitem &*recipient_item&~*recipients_list*&
31169 .cindex "recipient" "adding in local scan"
31170 .cindex "recipient" "removing in local scan"
31171 The list of accepted recipients, held in a vector of length
31172 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31173 can add additional recipients by calling &'receive_add_recipient()'& (see
31174 below). You can delete recipients by removing them from the vector and
31175 adjusting the value in &%recipients_count%&. In particular, by setting
31176 &%recipients_count%& to zero you remove all recipients. If you then return the
31177 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31178 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31179 and then call &'receive_add_recipient()'& as often as needed.
31180
31181 .vitem &*uschar&~*sender_address*&
31182 The envelope sender address. For bounce messages this is the empty string.
31183
31184 .vitem &*uschar&~*sender_host_address*&
31185 The IP address of the sending host, as a string. This is NULL for
31186 locally-submitted messages.
31187
31188 .vitem &*uschar&~*sender_host_authenticated*&
31189 The name of the authentication mechanism that was used, or NULL if the message
31190 was not received over an authenticated SMTP connection.
31191
31192 .vitem &*uschar&~*sender_host_name*&
31193 The name of the sending host, if known.
31194
31195 .vitem &*int&~sender_host_port*&
31196 The port on the sending host.
31197
31198 .vitem &*BOOL&~smtp_input*&
31199 This variable is TRUE for all SMTP input, including BSMTP.
31200
31201 .vitem &*BOOL&~smtp_batched_input*&
31202 This variable is TRUE for BSMTP input.
31203
31204 .vitem &*int&~store_pool*&
31205 The contents of this variable control which pool of memory is used for new
31206 requests. See section &<<SECTmemhanloc>>& for details.
31207 .endlist
31208
31209
31210 .section "Structure of header lines" "SECID209"
31211 The &%header_line%& structure contains the members listed below.
31212 You can add additional header lines by calling the &'header_add()'& function
31213 (see below). You can cause header lines to be ignored (deleted) by setting
31214 their type to *.
31215
31216
31217 .vlist
31218 .vitem &*struct&~header_line&~*next*&
31219 A pointer to the next header line, or NULL for the last line.
31220
31221 .vitem &*int&~type*&
31222 A code identifying certain headers that Exim recognizes. The codes are printing
31223 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31224 Notice in particular that any header line whose type is * is not transmitted
31225 with the message. This flagging is used for header lines that have been
31226 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31227 lines.) Effectively, * means &"deleted"&.
31228
31229 .vitem &*int&~slen*&
31230 The number of characters in the header line, including the terminating and any
31231 internal newlines.
31232
31233 .vitem &*uschar&~*text*&
31234 A pointer to the text of the header. It always ends with a newline, followed by
31235 a zero byte. Internal newlines are preserved.
31236 .endlist
31237
31238
31239
31240 .section "Structure of recipient items" "SECID210"
31241 The &%recipient_item%& structure contains these members:
31242
31243 .vlist
31244 .vitem &*uschar&~*address*&
31245 This is a pointer to the recipient address as it was received.
31246
31247 .vitem &*int&~pno*&
31248 This is used in later Exim processing when top level addresses are created by
31249 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31250 and must always contain -1 at this stage.
31251
31252 .vitem &*uschar&~*errors_to*&
31253 If this value is not NULL, bounce messages caused by failing to deliver to the
31254 recipient are sent to the address it contains. In other words, it overrides the
31255 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31256 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31257 an unqualified address, Exim qualifies it using the domain from
31258 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31259 is NULL for all recipients.
31260 .endlist
31261
31262
31263
31264 .section "Available Exim functions" "SECID211"
31265 .cindex "&[local_scan()]& function" "available Exim functions"
31266 The header &_local_scan.h_& gives you access to a number of Exim functions.
31267 These are the only ones that are guaranteed to be maintained from release to
31268 release:
31269
31270 .vlist
31271 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31272        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31273
31274 This function creates a child process that runs the command specified by
31275 &%argv%&. The environment for the process is specified by &%envp%&, which can
31276 be NULL if no environment variables are to be passed. A new umask is supplied
31277 for the process in &%newumask%&.
31278
31279 Pipes to the standard input and output of the new process are set up
31280 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31281 standard error is cloned to the standard output. If there are any file
31282 descriptors &"in the way"& in the new process, they are closed. If the final
31283 argument is TRUE, the new process is made into a process group leader.
31284
31285 The function returns the pid of the new process, or -1 if things go wrong.
31286
31287 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31288 This function waits for a child process to terminate, or for a timeout (in
31289 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31290 return value is as follows:
31291
31292 .ilist
31293 >= 0
31294
31295 The process terminated by a normal exit and the value is the process
31296 ending status.
31297
31298 .next
31299 < 0 and > &--256
31300
31301 The process was terminated by a signal and the value is the negation of the
31302 signal number.
31303
31304 .next
31305 &--256
31306
31307 The process timed out.
31308 .next
31309 &--257
31310
31311 The was some other error in wait(); &%errno%& is still set.
31312 .endlist
31313
31314 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31315 This function provide you with a means of submitting a new message to
31316 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31317 want, but this packages it all up for you.) The function creates a pipe,
31318 forks a subprocess that is running
31319 .code
31320 exim -t -oem -oi -f <>
31321 .endd
31322 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31323 that is connected to the standard input. The yield of the function is the PID
31324 of the subprocess. You can then write a message to the file descriptor, with
31325 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31326
31327 When you have finished, call &'child_close()'& to wait for the process to
31328 finish and to collect its ending status. A timeout value of zero is usually
31329 fine in this circumstance. Unless you have made a mistake with the recipient
31330 addresses, you should get a return code of zero.
31331
31332
31333 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31334        *sender_authentication)*&
31335 This function is a more sophisticated version of &'child_open()'&. The command
31336 that it runs is:
31337 .display
31338 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31339 .endd
31340 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31341
31342
31343 .vitem &*void&~debug_printf(char&~*,&~...)*&
31344 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31345 output is written to the standard error stream. If no debugging is selected,
31346 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31347 conditional on the &`local_scan`& debug selector by coding like this:
31348 .code
31349 if ((debug_selector & D_local_scan) != 0)
31350   debug_printf("xxx", ...);
31351 .endd
31352
31353 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31354 This is an interface to Exim's string expansion code. The return value is the
31355 expanded string, or NULL if there was an expansion failure.
31356 The C variable &%expand_string_message%& contains an error message after an
31357 expansion failure. If expansion does not change the string, the return value is
31358 the pointer to the input string. Otherwise, the return value points to a new
31359 block of memory that was obtained by a call to &'store_get()'&. See section
31360 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31361
31362 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31363 This function allows you to an add additional header line at the end of the
31364 existing ones. The first argument is the type, and should normally be a space
31365 character. The second argument is a format string and any number of
31366 substitution arguments as for &[sprintf()]&. You may include internal newlines
31367 if you want, and you must ensure that the string ends with a newline.
31368
31369 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31370         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31371 This function adds a new header line at a specified point in the header
31372 chain. The header itself is specified as for &'header_add()'&.
31373
31374 If &%name%& is NULL, the new header is added at the end of the chain if
31375 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31376 NULL, the header lines are searched for the first non-deleted header that
31377 matches the name. If one is found, the new header is added before it if
31378 &%after%& is false. If &%after%& is true, the new header is added after the
31379 found header and any adjacent subsequent ones with the same name (even if
31380 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31381 option controls where the header is added. If it is true, addition is at the
31382 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31383 headers, or at the top if there are no &'Received:'& headers, you could use
31384 .code
31385 header_add_at_position(TRUE, US"Received", TRUE,
31386   ' ', "X-xxx: ...");
31387 .endd
31388 Normally, there is always at least one non-deleted &'Received:'& header, but
31389 there may not be if &%received_header_text%& expands to an empty string.
31390
31391
31392 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31393 This function removes header lines. If &%occurrence%& is zero or negative, all
31394 occurrences of the header are removed. If occurrence is greater than zero, that
31395 particular instance of the header is removed. If no header(s) can be found that
31396 match the specification, the function does nothing.
31397
31398
31399 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31400         int&~length,&~BOOL&~notdel)*&"
31401 This function tests whether the given header has the given name. It is not just
31402 a string comparison, because white space is permitted between the name and the
31403 colon. If the &%notdel%& argument is true, a false return is forced for all
31404 &"deleted"& headers; otherwise they are not treated specially. For example:
31405 .code
31406 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31407 .endd
31408 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31409 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31410 This function base64-encodes a string, which is passed by address and length.
31411 The text may contain bytes of any value, including zero. The result is passed
31412 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31413 zero-terminated.
31414
31415 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31416 This function decodes a base64-encoded string. Its arguments are a
31417 zero-terminated base64-encoded string and the address of a variable that is set
31418 to point to the result, which is in dynamic memory. The length of the decoded
31419 string is the yield of the function. If the input is invalid base64 data, the
31420 yield is -1. A zero byte is added to the end of the output string to make it
31421 easy to interpret as a C string (assuming it contains no zeros of its own). The
31422 added zero byte is not included in the returned count.
31423
31424 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31425 This function checks for a match in a domain list. Domains are always
31426 matched caselessly. The return value is one of the following:
31427 .display
31428 &`OK     `& match succeeded
31429 &`FAIL   `& match failed
31430 &`DEFER  `& match deferred
31431 .endd
31432 DEFER is usually caused by some kind of lookup defer, such as the
31433 inability to contact a database.
31434
31435 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31436         BOOL&~caseless)*&"
31437 This function checks for a match in a local part list. The third argument
31438 controls case-sensitivity. The return values are as for
31439 &'lss_match_domain()'&.
31440
31441 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31442         BOOL&~caseless)*&"
31443 This function checks for a match in an address list. The third argument
31444 controls the case-sensitivity of the local part match. The domain is always
31445 matched caselessly. The return values are as for &'lss_match_domain()'&.
31446
31447 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31448         uschar&~*list)*&"
31449 This function checks for a match in a host list. The most common usage is
31450 expected to be
31451 .code
31452 lss_match_host(sender_host_name, sender_host_address, ...)
31453 .endd
31454 .vindex "&$sender_host_address$&"
31455 An empty address field matches an empty item in the host list. If the host name
31456 is NULL, the name corresponding to &$sender_host_address$& is automatically
31457 looked up if a host name is required to match an item in the list. The return
31458 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31459 returns ERROR in the case when it had to look up a host name, but the lookup
31460 failed.
31461
31462 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31463         *format,&~...)*&"
31464 This function writes to Exim's log files. The first argument should be zero (it
31465 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31466 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31467 them. It specifies to which log or logs the message is written. The remaining
31468 arguments are a format and relevant insertion arguments. The string should not
31469 contain any newlines, not even at the end.
31470
31471
31472 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31473 This function adds an additional recipient to the message. The first argument
31474 is the recipient address. If it is unqualified (has no domain), it is qualified
31475 with the &%qualify_recipient%& domain. The second argument must always be -1.
31476
31477 This function does not allow you to specify a private &%errors_to%& address (as
31478 described with the structure of &%recipient_item%& above), because it pre-dates
31479 the addition of that field to the structure. However, it is easy to add such a
31480 value afterwards. For example:
31481 .code
31482  receive_add_recipient(US"monitor@mydom.example", -1);
31483  recipients_list[recipients_count-1].errors_to =
31484    US"postmaster@mydom.example";
31485 .endd
31486
31487 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31488 This is a convenience function to remove a named recipient from the list of
31489 recipients. It returns true if a recipient was removed, and false if no
31490 matching recipient could be found. The argument must be a complete email
31491 address.
31492 .endlist
31493
31494
31495 .cindex "RFC 2047"
31496 .vlist
31497 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31498   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31499 This function decodes strings that are encoded according to RFC 2047. Typically
31500 these are the contents of header lines. First, each &"encoded word"& is decoded
31501 from the Q or B encoding into a byte-string. Then, if provided with the name of
31502 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31503 made  to translate the result to the named character set. If this fails, the
31504 binary string is returned with an error message.
31505
31506 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31507 maximum MIME word length is enforced. The third argument is the target
31508 encoding, or NULL if no translation is wanted.
31509
31510 .cindex "binary zero" "in RFC 2047 decoding"
31511 .cindex "RFC 2047" "binary zero in"
31512 If a binary zero is encountered in the decoded string, it is replaced by the
31513 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31514 not be 0 because header lines are handled as zero-terminated strings.
31515
31516 The function returns the result of processing the string, zero-terminated; if
31517 &%lenptr%& is not NULL, the length of the result is set in the variable to
31518 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31519
31520 If an error is encountered, the function returns NULL and uses the &%error%&
31521 argument to return an error message. The variable pointed to by &%error%& is
31522 set to NULL if there is no error; it may be set non-NULL even when the function
31523 returns a non-NULL value if decoding was successful, but there was a problem
31524 with translation.
31525
31526
31527 .vitem &*int&~smtp_fflush(void)*&
31528 This function is used in conjunction with &'smtp_printf()'&, as described
31529 below.
31530
31531 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31532 The arguments of this function are like &[printf()]&; it writes to the SMTP
31533 output stream. You should use this function only when there is an SMTP output
31534 stream, that is, when the incoming message is being received via interactive
31535 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31536 is FALSE. If you want to test for an incoming message from another host (as
31537 opposed to a local process that used the &%-bs%& command line option), you can
31538 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31539 is involved.
31540
31541 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31542 output function, so it can be used for all forms of SMTP connection.
31543
31544 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31545 must start with an appropriate response code: 550 if you are going to return
31546 LOCAL_SCAN_REJECT, 451 if you are going to return
31547 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31548 initial lines of a multi-line response, the code must be followed by a hyphen
31549 to indicate that the line is not the final response line. You must also ensure
31550 that the lines you write terminate with CRLF. For example:
31551 .code
31552 smtp_printf("550-this is some extra info\r\n");
31553 return LOCAL_SCAN_REJECT;
31554 .endd
31555 Note that you can also create multi-line responses by including newlines in
31556 the data returned via the &%return_text%& argument. The added value of using
31557 &'smtp_printf()'& is that, for instance, you could introduce delays between
31558 multiple output lines.
31559
31560 The &'smtp_printf()'& function does not return any error indication, because it
31561 does not automatically flush pending output, and therefore does not test
31562 the state of the stream. (In the main code of Exim, flushing and error
31563 detection is done when Exim is ready for the next SMTP input command.) If
31564 you want to flush the output and check for an error (for example, the
31565 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31566 arguments. It flushes the output stream, and returns a non-zero value if there
31567 is an error.
31568
31569 .vitem &*void&~*store_get(int)*&
31570 This function accesses Exim's internal store (memory) manager. It gets a new
31571 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31572 runs out of memory. See the next section for a discussion of memory handling.
31573
31574 .vitem &*void&~*store_get_perm(int)*&
31575 This function is like &'store_get()'&, but it always gets memory from the
31576 permanent pool. See the next section for a discussion of memory handling.
31577
31578 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31579 See below.
31580
31581 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31582 See below.
31583
31584 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31585 These three functions create strings using Exim's dynamic memory facilities.
31586 The first makes a copy of an entire string. The second copies up to a maximum
31587 number of characters, indicated by the second argument. The third uses a format
31588 and insertion arguments to create a new string. In each case, the result is a
31589 pointer to a new string in the current memory pool. See the next section for
31590 more discussion.
31591 .endlist
31592
31593
31594
31595 .section "More about Exim's memory handling" "SECTmemhanloc"
31596 .cindex "&[local_scan()]& function" "memory handling"
31597 No function is provided for freeing memory, because that is never needed.
31598 The dynamic memory that Exim uses when receiving a message is automatically
31599 recycled if another message is received by the same process (this applies only
31600 to incoming SMTP connections &-- other input methods can supply only one
31601 message at a time). After receiving the last message, a reception process
31602 terminates.
31603
31604 Because it is recycled, the normal dynamic memory cannot be used for holding
31605 data that must be preserved over a number of incoming messages on the same SMTP
31606 connection. However, Exim in fact uses two pools of dynamic memory; the second
31607 one is not recycled, and can be used for this purpose.
31608
31609 If you want to allocate memory that remains available for subsequent messages
31610 in the same SMTP connection, you should set
31611 .code
31612 store_pool = POOL_PERM
31613 .endd
31614 before calling the function that does the allocation. There is no need to
31615 restore the value if you do not need to; however, if you do want to revert to
31616 the normal pool, you can either restore the previous value of &%store_pool%& or
31617 set it explicitly to POOL_MAIN.
31618
31619 The pool setting applies to all functions that get dynamic memory, including
31620 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31621 There is also a convenience function called &'store_get_perm()'& that gets a
31622 block of memory from the permanent pool while preserving the value of
31623 &%store_pool%&.
31624 .ecindex IIDlosca
31625
31626
31627
31628
31629 . ////////////////////////////////////////////////////////////////////////////
31630 . ////////////////////////////////////////////////////////////////////////////
31631
31632 .chapter "System-wide message filtering" "CHAPsystemfilter"
31633 .scindex IIDsysfil1 "filter" "system filter"
31634 .scindex IIDsysfil2 "filtering all mail"
31635 .scindex IIDsysfil3 "system filter"
31636 The previous chapters (on ACLs and the local scan function) describe checks
31637 that can be applied to messages before they are accepted by a host. There is
31638 also a mechanism for checking messages once they have been received, but before
31639 they are delivered. This is called the &'system filter'&.
31640
31641 The system filter operates in a similar manner to users' filter files, but it
31642 is run just once per message (however many recipients the message has).
31643 It should not normally be used as a substitute for routing, because &%deliver%&
31644 commands in a system router provide new envelope recipient addresses.
31645 The system filter must be an Exim filter. It cannot be a Sieve filter.
31646
31647 The system filter is run at the start of a delivery attempt, before any routing
31648 is done. If a message fails to be completely delivered at the first attempt,
31649 the system filter is run again at the start of every retry.
31650 If you want your filter to do something only once per message, you can make use
31651 of the &%first_delivery%& condition in an &%if%& command in the filter to
31652 prevent it happening on retries.
31653
31654 .vindex "&$domain$&"
31655 .vindex "&$local_part$&"
31656 &*Warning*&: Because the system filter runs just once, variables that are
31657 specific to individual recipient addresses, such as &$local_part$& and
31658 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31659 you want to run a centrally-specified filter for each recipient address
31660 independently, you can do so by setting up a suitable &(redirect)& router, as
31661 described in section &<<SECTperaddfil>>& below.
31662
31663
31664 .section "Specifying a system filter" "SECID212"
31665 .cindex "uid (user id)" "system filter"
31666 .cindex "gid (group id)" "system filter"
31667 The name of the file that contains the system filter must be specified by
31668 setting &%system_filter%&. If you want the filter to run under a uid and gid
31669 other than root, you must also set &%system_filter_user%& and
31670 &%system_filter_group%& as appropriate. For example:
31671 .code
31672 system_filter = /etc/mail/exim.filter
31673 system_filter_user = exim
31674 .endd
31675 If a system filter generates any deliveries directly to files or pipes (via the
31676 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31677 specified by setting &%system_filter_file_transport%& and
31678 &%system_filter_pipe_transport%&, respectively. Similarly,
31679 &%system_filter_reply_transport%& must be set to handle any messages generated
31680 by the &%reply%& command.
31681
31682
31683 .section "Testing a system filter" "SECID213"
31684 You can run simple tests of a system filter in the same way as for a user
31685 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31686 are permitted only in system filters are recognized.
31687
31688 If you want to test the combined effect of a system filter and a user filter,
31689 you can use both &%-bF%& and &%-bf%& on the same command line.
31690
31691
31692
31693 .section "Contents of a system filter" "SECID214"
31694 The language used to specify system filters is the same as for users' filter
31695 files. It is described in the separate end-user document &'Exim's interface to
31696 mail filtering'&. However, there are some additional features that are
31697 available only in system filters; these are described in subsequent sections.
31698 If they are encountered in a user's filter file or when testing with &%-bf%&,
31699 they cause errors.
31700
31701 .cindex "frozen messages" "manual thaw; testing in filter"
31702 There are two special conditions which, though available in users' filter
31703 files, are designed for use in system filters. The condition &%first_delivery%&
31704 is true only for the first attempt at delivering a message, and
31705 &%manually_thawed%& is true only if the message has been frozen, and
31706 subsequently thawed by an admin user. An explicit forced delivery counts as a
31707 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31708
31709 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31710 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31711 succeed, it will not be tried again.
31712 If you want Exim to retry an unseen delivery until it succeeds, you should
31713 arrange to set it up every time the filter runs.
31714
31715 When a system filter finishes running, the values of the variables &$n0$& &--
31716 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31717 users' filter files. Thus a system filter can, for example, set up &"scores"&
31718 to which users' filter files can refer.
31719
31720
31721
31722 .section "Additional variable for system filters" "SECID215"
31723 .vindex "&$recipients$&"
31724 The expansion variable &$recipients$&, containing a list of all the recipients
31725 of the message (separated by commas and white space), is available in system
31726 filters. It is not available in users' filters for privacy reasons.
31727
31728
31729
31730 .section "Defer, freeze, and fail commands for system filters" "SECID216"
31731 .cindex "freezing messages"
31732 .cindex "message" "freezing"
31733 .cindex "message" "forced failure"
31734 .cindex "&%fail%&" "in system filter"
31735 .cindex "&%freeze%& in system filter"
31736 .cindex "&%defer%& in system filter"
31737 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
31738 always available in system filters, but are not normally enabled in users'
31739 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
31740 for the &(redirect)& router.) These commands can optionally be followed by the
31741 word &%text%& and a string containing an error message, for example:
31742 .code
31743 fail text "this message looks like spam to me"
31744 .endd
31745 The keyword &%text%& is optional if the next character is a double quote.
31746
31747 The &%defer%& command defers delivery of the original recipients of the
31748 message. The &%fail%& command causes all the original recipients to be failed,
31749 and a bounce message to be created. The &%freeze%& command suspends all
31750 delivery attempts for the original recipients. In all cases, any new deliveries
31751 that are specified by the filter are attempted as normal after the filter has
31752 run.
31753
31754 The &%freeze%& command is ignored if the message has been manually unfrozen and
31755 not manually frozen since. This means that automatic freezing by a system
31756 filter can be used as a way of checking out suspicious messages. If a message
31757 is found to be all right, manually unfreezing it allows it to be delivered.
31758
31759 .cindex "log" "&%fail%& command log line"
31760 .cindex "&%fail%&" "log line; reducing"
31761 The text given with a fail command is used as part of the bounce message as
31762 well as being written to the log. If the message is quite long, this can fill
31763 up a lot of log space when such failures are common. To reduce the size of the
31764 log message, Exim interprets the text in a special way if it starts with the
31765 two characters &`<<`& and contains &`>>`& later. The text between these two
31766 strings is written to the log, and the rest of the text is used in the bounce
31767 message. For example:
31768 .code
31769 fail "<<filter test 1>>Your message is rejected \
31770      because it contains attachments that we are \
31771      not prepared to receive."
31772 .endd
31773
31774 .cindex "loop" "caused by &%fail%&"
31775 Take great care with the &%fail%& command when basing the decision to fail on
31776 the contents of the message, because the bounce message will of course include
31777 the contents of the original message and will therefore trigger the &%fail%&
31778 command again (causing a mail loop) unless steps are taken to prevent this.
31779 Testing the &%error_message%& condition is one way to prevent this. You could
31780 use, for example
31781 .code
31782 if $message_body contains "this is spam" and not error_message
31783 then fail text "spam is not wanted here" endif
31784 .endd
31785 though of course that might let through unwanted bounce messages. The
31786 alternative is clever checking of the body and/or headers to detect bounces
31787 generated by the filter.
31788
31789 The interpretation of a system filter file ceases after a
31790 &%defer%&,
31791 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31792 set up earlier in the filter file are honoured, so you can use a sequence such
31793 as
31794 .code
31795 mail ...
31796 freeze
31797 .endd
31798 to send a specified message when the system filter is freezing (or deferring or
31799 failing) a message. The normal deliveries for the message do not, of course,
31800 take place.
31801
31802
31803
31804 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31805 .cindex "header lines" "adding; in system filter"
31806 .cindex "header lines" "removing; in system filter"
31807 .cindex "filter" "header lines; adding/removing"
31808 Two filter commands that are available only in system filters are:
31809 .code
31810 headers add <string>
31811 headers remove <string>
31812 .endd
31813 The argument for the &%headers add%& is a string that is expanded and then
31814 added to the end of the message's headers. It is the responsibility of the
31815 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31816 space is ignored, and if the string is otherwise empty, or if the expansion is
31817 forced to fail, the command has no effect.
31818
31819 You can use &"\n"& within the string, followed by white space, to specify
31820 continued header lines. More than one header may be added in one command by
31821 including &"\n"& within the string without any following white space. For
31822 example:
31823 .code
31824 headers add "X-header-1: ....\n  \
31825              continuation of X-header-1 ...\n\
31826              X-header-2: ...."
31827 .endd
31828 Note that the header line continuation white space after the first newline must
31829 be placed before the backslash that continues the input string, because white
31830 space after input continuations is ignored.
31831
31832 The argument for &%headers remove%& is a colon-separated list of header names.
31833 This command applies only to those headers that are stored with the message;
31834 those that are added at delivery time (such as &'Envelope-To:'& and
31835 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31836 header with the same name, they are all removed.
31837
31838 The &%headers%& command in a system filter makes an immediate change to the set
31839 of header lines that was received with the message (with possible additions
31840 from ACL processing). Subsequent commands in the system filter operate on the
31841 modified set, which also forms the basis for subsequent message delivery.
31842 Unless further modified during routing or transporting, this set of headers is
31843 used for all recipients of the message.
31844
31845 During routing and transporting, the variables that refer to the contents of
31846 header lines refer only to those lines that are in this set. Thus, header lines
31847 that are added by a system filter are visible to users' filter files and to all
31848 routers and transports. This contrasts with the manipulation of header lines by
31849 routers and transports, which is not immediate, but which instead is saved up
31850 until the message is actually being written (see section
31851 &<<SECTheadersaddrem>>&).
31852
31853 If the message is not delivered at the first attempt, header lines that were
31854 added by the system filter are stored with the message, and so are still
31855 present at the next delivery attempt. Header lines that were removed are still
31856 present, but marked &"deleted"& so that they are not transported with the
31857 message. For this reason, it is usual to make the &%headers%& command
31858 conditional on &%first_delivery%& so that the set of header lines is not
31859 modified more than once.
31860
31861 Because header modification in a system filter acts immediately, you have to
31862 use an indirect approach if you want to modify the contents of a header line.
31863 For example:
31864 .code
31865 headers add "Old-Subject: $h_subject:"
31866 headers remove "Subject"
31867 headers add "Subject: new subject (was: $h_old-subject:)"
31868 headers remove "Old-Subject"
31869 .endd
31870
31871
31872
31873 .section "Setting an errors address in a system filter" "SECID217"
31874 .cindex "envelope sender"
31875 In a system filter, if a &%deliver%& command is followed by
31876 .code
31877 errors_to <some address>
31878 .endd
31879 in order to change the envelope sender (and hence the error reporting) for that
31880 delivery, any address may be specified. (In a user filter, only the current
31881 user's address can be set.) For example, if some mail is being monitored, you
31882 might use
31883 .code
31884 unseen deliver monitor@spying.example errors_to root@local.example
31885 .endd
31886 to take a copy which would not be sent back to the normal error reporting
31887 address if its delivery failed.
31888
31889
31890
31891 .section "Per-address filtering" "SECTperaddfil"
31892 .vindex "&$domain$&"
31893 .vindex "&$local_part$&"
31894 In contrast to the system filter, which is run just once per message for each
31895 delivery attempt, it is also possible to set up a system-wide filtering
31896 operation that runs once for each recipient address. In this case, variables
31897 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
31898 filter file could be made dependent on them. This is an example of a router
31899 which implements such a filter:
31900 .code
31901 central_filter:
31902   check_local_user
31903   driver = redirect
31904   domains = +local_domains
31905   file = /central/filters/$local_part
31906   no_verify
31907   allow_filter
31908   allow_freeze
31909 .endd
31910 The filter is run in a separate process under its own uid. Therefore, either
31911 &%check_local_user%& must be set (as above), in which case the filter is run as
31912 the local user, or the &%user%& option must be used to specify which user to
31913 use. If both are set, &%user%& overrides.
31914
31915 Care should be taken to ensure that none of the commands in the filter file
31916 specify a significant delivery if the message is to go on to be delivered to
31917 its intended recipient. The router will not then claim to have dealt with the
31918 address, so it will be passed on to subsequent routers to be delivered in the
31919 normal way.
31920 .ecindex IIDsysfil1
31921 .ecindex IIDsysfil2
31922 .ecindex IIDsysfil3
31923
31924
31925
31926
31927
31928
31929 . ////////////////////////////////////////////////////////////////////////////
31930 . ////////////////////////////////////////////////////////////////////////////
31931
31932 .chapter "Message processing" "CHAPmsgproc"
31933 .scindex IIDmesproc "message" "general processing"
31934 Exim performs various transformations on the sender and recipient addresses of
31935 all messages that it handles, and also on the messages' header lines. Some of
31936 these are optional and configurable, while others always take place. All of
31937 this processing, except rewriting as a result of routing, and the addition or
31938 removal of header lines while delivering, happens when a message is received,
31939 before it is placed on Exim's queue.
31940
31941 Some of the automatic processing takes place by default only for
31942 &"locally-originated"& messages. This adjective is used to describe messages
31943 that are not received over TCP/IP, but instead are passed to an Exim process on
31944 its standard input. This includes the interactive &"local SMTP"& case that is
31945 set up by the &%-bs%& command line option.
31946
31947 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
31948 or ::1) are not considered to be locally-originated. Exim does not treat the
31949 loopback interface specially in any way.
31950
31951 If you want the loopback interface to be treated specially, you must ensure
31952 that there are appropriate entries in your ACLs.
31953
31954
31955
31956
31957 .section "Submission mode for non-local messages" "SECTsubmodnon"
31958 .cindex "message" "submission"
31959 .cindex "submission mode"
31960 Processing that happens automatically for locally-originated messages (unless
31961 &%suppress_local_fixups%& is set) can also be requested for messages that are
31962 received over TCP/IP. The term &"submission mode"& is used to describe this
31963 state. Submission mode is set by the modifier
31964 .code
31965 control = submission
31966 .endd
31967 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
31968 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
31969 a local submission, and is normally used when the source of the message is
31970 known to be an MUA running on a client host (as opposed to an MTA). For
31971 example, to set submission mode for messages originating on the IPv4 loopback
31972 interface, you could include the following in the MAIL ACL:
31973 .code
31974 warn  hosts = 127.0.0.1
31975       control = submission
31976 .endd
31977 .cindex "&%sender_retain%& submission option"
31978 There are some options that can be used when setting submission mode. A slash
31979 is used to separate options. For example:
31980 .code
31981 control = submission/sender_retain
31982 .endd
31983 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
31984 true and &%local_from_check%& false for the current incoming message. The first
31985 of these allows an existing &'Sender:'& header in the message to remain, and
31986 the second suppresses the check to ensure that &'From:'& matches the
31987 authenticated sender. With this setting, Exim still fixes up messages by adding
31988 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
31989 attempt to check sender authenticity in header lines.
31990
31991 When &%sender_retain%& is not set, a submission mode setting may specify a
31992 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
31993 example:
31994 .code
31995 control = submission/domain=some.domain
31996 .endd
31997 The domain may be empty. How this value is used is described in sections
31998 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
31999 that allows you to specify the user's full name for inclusion in a created
32000 &'Sender:'& or &'From:'& header line. For example:
32001 .code
32002 accept authenticated = *
32003        control = submission/domain=wonderland.example/\
32004                             name=${lookup {$authenticated_id} \
32005                                    lsearch {/etc/exim/namelist}}
32006 .endd
32007 Because the name may contain any characters, including slashes, the &%name%&
32008 option must be given last. The remainder of the string is used as the name. For
32009 the example above, if &_/etc/exim/namelist_& contains:
32010 .code
32011 bigegg:  Humpty Dumpty
32012 .endd
32013 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32014 line would be:
32015 .code
32016 Sender: Humpty Dumpty <bigegg@wonderland.example>
32017 .endd
32018 .cindex "return path" "in submission mode"
32019 By default, submission mode forces the return path to the same address as is
32020 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32021 specified, the return path is also left unchanged.
32022
32023 &*Note*&: The changes caused by submission mode take effect after the predata
32024 ACL. This means that any sender checks performed before the fix-ups use the
32025 untrusted sender address specified by the user, not the trusted sender address
32026 specified by submission mode. Although this might be slightly unexpected, it
32027 does mean that you can configure ACL checks to spot that a user is trying to
32028 spoof another's address.
32029
32030 .section "Line endings" "SECTlineendings"
32031 .cindex "line endings"
32032 .cindex "carriage return"
32033 .cindex "linefeed"
32034 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32035 linefeed) is the line ending for messages transmitted over the Internet using
32036 SMTP over TCP/IP. However, within individual operating systems, different
32037 conventions are used. For example, Unix-like systems use just LF, but others
32038 use CRLF or just CR.
32039
32040 Exim was designed for Unix-like systems, and internally, it stores messages
32041 using the system's convention of a single LF as a line terminator. When
32042 receiving a message, all line endings are translated to this standard format.
32043 Originally, it was thought that programs that passed messages directly to an
32044 MTA within an operating system would use that system's convention. Experience
32045 has shown that this is not the case; for example, there are Unix applications
32046 that use CRLF in this circumstance. For this reason, and for compatibility with
32047 other MTAs, the way Exim handles line endings for all messages is now as
32048 follows:
32049
32050 .ilist
32051 LF not preceded by CR is treated as a line ending.
32052 .next
32053 CR is treated as a line ending; if it is immediately followed by LF, the LF
32054 is ignored.
32055 .next
32056 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32057 nor a local message in the state where a line containing only a dot is a
32058 terminator.
32059 .next
32060 If a bare CR is encountered within a header line, an extra space is added after
32061 the line terminator so as not to end the header line. The reasoning behind this
32062 is that bare CRs in header lines are most likely either to be mistakes, or
32063 people trying to play silly games.
32064 .next
32065 If the first header line received in a message ends with CRLF, a subsequent
32066 bare LF in a header line is treated in the same way as a bare CR in a header
32067 line.
32068 .endlist
32069
32070
32071
32072
32073
32074 .section "Unqualified addresses" "SECID218"
32075 .cindex "unqualified addresses"
32076 .cindex "address" "qualification"
32077 By default, Exim expects every envelope address it receives from an external
32078 host to be fully qualified. Unqualified addresses cause negative responses to
32079 SMTP commands. However, because SMTP is used as a means of transporting
32080 messages from MUAs running on personal workstations, there is sometimes a
32081 requirement to accept unqualified addresses from specific hosts or IP networks.
32082
32083 Exim has two options that separately control which hosts may send unqualified
32084 sender or recipient addresses in SMTP commands, namely
32085 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32086 cases, if an unqualified address is accepted, it is qualified by adding the
32087 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32088
32089 .oindex "&%qualify_domain%&"
32090 .oindex "&%qualify_recipient%&"
32091 Unqualified addresses in header lines are automatically qualified for messages
32092 that are locally originated, unless the &%-bnq%& option is given on the command
32093 line. For messages received over SMTP, unqualified addresses in header lines
32094 are qualified only if unqualified addresses are permitted in SMTP commands. In
32095 other words, such qualification is also controlled by
32096 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32097
32098
32099
32100
32101 .section "The UUCP From line" "SECID219"
32102 .cindex "&""From""& line"
32103 .cindex "UUCP" "&""From""& line"
32104 .cindex "sender" "address"
32105 .oindex "&%uucp_from_pattern%&"
32106 .oindex "&%uucp_from_sender%&"
32107 .cindex "envelope sender"
32108 .cindex "Sendmail compatibility" "&""From""& line"
32109 Messages that have come from UUCP (and some other applications) often begin
32110 with a line containing the envelope sender and a timestamp, following the word
32111 &"From"&. Examples of two common formats are:
32112 .code
32113 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32114 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32115 .endd
32116 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32117 Exim recognizes such lines at the start of messages that are submitted to it
32118 via the command line (that is, on the standard input). It does not recognize
32119 such lines in incoming SMTP messages, unless the sending host matches
32120 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32121 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32122 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32123 default value matches the two common cases shown above and puts the address
32124 that follows &"From"& into &$1$&.
32125
32126 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32127 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32128 a trusted user, the message's sender address is constructed by expanding the
32129 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32130 then parsed as an RFC 2822 address. If there is no domain, the local part is
32131 qualified with &%qualify_domain%& unless it is the empty string. However, if
32132 the command line &%-f%& option is used, it overrides the &"From"& line.
32133
32134 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32135 sender address is not changed. This is also the case for incoming SMTP messages
32136 that are permitted to contain &"From"& lines.
32137
32138 Only one &"From"& line is recognized. If there is more than one, the second is
32139 treated as a data line that starts the body of the message, as it is not valid
32140 as a header line. This also happens if a &"From"& line is present in an
32141 incoming SMTP message from a source that is not permitted to send them.
32142
32143
32144
32145 .section "Resent- header lines" "SECID220"
32146 .cindex "&%Resent-%& header lines"
32147 RFC 2822 makes provision for sets of header lines starting with the string
32148 &`Resent-`& to be added to a message when it is resent by the original
32149 recipient to somebody else. These headers are &'Resent-Date:'&,
32150 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32151 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32152
32153 .blockquote
32154 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32155 processing of replies or other such automatic actions on messages.'&
32156 .endblockquote
32157
32158 This leaves things a bit vague as far as other processing actions such as
32159 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32160 follows:
32161
32162 .ilist
32163 A &'Resent-From:'& line that just contains the login id of the submitting user
32164 is automatically rewritten in the same way as &'From:'& (see below).
32165 .next
32166 If there's a rewriting rule for a particular header line, it is also applied to
32167 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32168 &'From:'& also rewrites &'Resent-From:'&.
32169 .next
32170 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32171 also removed.
32172 .next
32173 For a locally-submitted message,
32174 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32175 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32176 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32177 included in log lines in this case.
32178 .next
32179 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32180 &%Resent-%& header lines are present.
32181 .endlist
32182
32183
32184
32185
32186 .section "The Auto-Submitted: header line" "SECID221"
32187 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32188 includes the header line:
32189 .code
32190 Auto-Submitted: auto-replied
32191 .endd
32192
32193 .section "The Bcc: header line" "SECID222"
32194 .cindex "&'Bcc:'& header line"
32195 If Exim is called with the &%-t%& option, to take recipient addresses from a
32196 message's header, it removes any &'Bcc:'& header line that may exist (after
32197 extracting its addresses). If &%-t%& is not present on the command line, any
32198 existing &'Bcc:'& is not removed.
32199
32200
32201 .section "The Date: header line" "SECID223"
32202 .cindex "&'Date:'& header line"
32203 If a locally-generated or submission-mode message has no &'Date:'& header line,
32204 Exim adds one, using the current date and time, unless the
32205 &%suppress_local_fixups%& control has been specified.
32206
32207 .section "The Delivery-date: header line" "SECID224"
32208 .cindex "&'Delivery-date:'& header line"
32209 .oindex "&%delivery_date_remove%&"
32210 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32211 set. Exim can be configured to add them to the final delivery of messages. (See
32212 the generic &%delivery_date_add%& transport option.) They should not be present
32213 in messages in transit. If the &%delivery_date_remove%& configuration option is
32214 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32215 messages.
32216
32217
32218 .section "The Envelope-to: header line" "SECID225"
32219 .cindex "&'Envelope-to:'& header line"
32220 .oindex "&%envelope_to_remove%&"
32221 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32222 Exim can be configured to add them to the final delivery of messages. (See the
32223 generic &%envelope_to_add%& transport option.) They should not be present in
32224 messages in transit. If the &%envelope_to_remove%& configuration option is set
32225 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32226 messages.
32227
32228
32229 .section "The From: header line" "SECTthefrohea"
32230 .cindex "&'From:'& header line"
32231 .cindex "Sendmail compatibility" "&""From""& line"
32232 .cindex "message" "submission"
32233 .cindex "submission mode"
32234 If a submission-mode message does not contain a &'From:'& header line, Exim
32235 adds one if either of the following conditions is true:
32236
32237 .ilist
32238 The envelope sender address is not empty (that is, this is not a bounce
32239 message). The added header line copies the envelope sender address.
32240 .next
32241 .vindex "&$authenticated_id$&"
32242 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32243 .olist
32244 .vindex "&$qualify_domain$&"
32245 If no domain is specified by the submission control, the local part is
32246 &$authenticated_id$& and the domain is &$qualify_domain$&.
32247 .next
32248 If a non-empty domain is specified by the submission control, the local
32249 part is &$authenticated_id$&, and the domain is the specified domain.
32250 .next
32251 If an empty domain is specified by the submission control,
32252 &$authenticated_id$& is assumed to be the complete address.
32253 .endlist
32254 .endlist
32255
32256 A non-empty envelope sender takes precedence.
32257
32258 If a locally-generated incoming message does not contain a &'From:'& header
32259 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32260 containing the sender's address. The calling user's login name and full name
32261 are used to construct the address, as described in section &<<SECTconstr>>&.
32262 They are obtained from the password data by calling &[getpwuid()]& (but see the
32263 &%unknown_login%& configuration option). The address is qualified with
32264 &%qualify_domain%&.
32265
32266 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32267 &'From:'& header line containing just the unqualified login name of the calling
32268 user, this is replaced by an address containing the user's login name and full
32269 name as described in section &<<SECTconstr>>&.
32270
32271
32272 .section "The Message-ID: header line" "SECID226"
32273 .cindex "&'Message-ID:'& header line"
32274 .cindex "message" "submission"
32275 .oindex "&%message_id_header_text%&"
32276 If a locally-generated or submission-mode incoming message does not contain a
32277 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32278 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32279 to the message. If there are any &'Resent-:'& headers in the message, it
32280 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32281 message id, preceded by the letter E to ensure it starts with a letter, and
32282 followed by @ and the primary host name. Additional information can be included
32283 in this header line by setting the &%message_id_header_text%& and/or
32284 &%message_id_header_domain%& options.
32285
32286
32287 .section "The Received: header line" "SECID227"
32288 .cindex "&'Received:'& header line"
32289 A &'Received:'& header line is added at the start of every message. The
32290 contents are defined by the &%received_header_text%& configuration option, and
32291 Exim automatically adds a semicolon and a timestamp to the configured string.
32292
32293 The &'Received:'& header is generated as soon as the message's header lines
32294 have been received. At this stage, the timestamp in the &'Received:'& header
32295 line is the time that the message started to be received. This is the value
32296 that is seen by the DATA ACL and by the &[local_scan()]& function.
32297
32298 Once a message is accepted, the timestamp in the &'Received:'& header line is
32299 changed to the time of acceptance, which is (apart from a small delay while the
32300 -H spool file is written) the earliest time at which delivery could start.
32301
32302
32303 .section "The References: header line" "SECID228"
32304 .cindex "&'References:'& header line"
32305 Messages created by the &(autoreply)& transport include a &'References:'&
32306 header line. This is constructed according to the rules that are described in
32307 section 3.64 of RFC 2822 (which states that replies should contain such a
32308 header line), and section 3.14 of RFC 3834 (which states that automatic
32309 responses are not different in this respect). However, because some mail
32310 processing software does not cope well with very long header lines, no more
32311 than 12 message IDs are copied from the &'References:'& header line in the
32312 incoming message. If there are more than 12, the first one and then the final
32313 11 are copied, before adding the message ID of the incoming message.
32314
32315
32316
32317 .section "The Return-path: header line" "SECID229"
32318 .cindex "&'Return-path:'& header line"
32319 .oindex "&%return_path_remove%&"
32320 &'Return-path:'& header lines are defined as something an MTA may insert when
32321 it does the final delivery of messages. (See the generic &%return_path_add%&
32322 transport option.) Therefore, they should not be present in messages in
32323 transit. If the &%return_path_remove%& configuration option is set (the
32324 default), Exim removes &'Return-path:'& header lines from incoming messages.
32325
32326
32327
32328 .section "The Sender: header line" "SECTthesenhea"
32329 .cindex "&'Sender:'& header line"
32330 .cindex "message" "submission"
32331 For a locally-originated message from an untrusted user, Exim may remove an
32332 existing &'Sender:'& header line, and it may add a new one. You can modify
32333 these actions by setting the &%local_sender_retain%& option true, the
32334 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32335 control setting.
32336
32337 When a local message is received from an untrusted user and
32338 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32339 control has not been set, a check is made to see if the address given in the
32340 &'From:'& header line is the correct (local) sender of the message. The address
32341 that is expected has the login name as the local part and the value of
32342 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32343 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32344 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32345 line is added to the message.
32346
32347 If you set &%local_from_check%& false, this checking does not occur. However,
32348 the removal of an existing &'Sender:'& line still happens, unless you also set
32349 &%local_sender_retain%& to be true. It is not possible to set both of these
32350 options true at the same time.
32351
32352 .cindex "submission mode"
32353 By default, no processing of &'Sender:'& header lines is done for messages
32354 received over TCP/IP or for messages submitted by trusted users. However, when
32355 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32356 not specified on the submission control, the following processing takes place:
32357
32358 .vindex "&$authenticated_id$&"
32359 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32360 authenticated, and &$authenticated_id$& is not empty, a sender address is
32361 created as follows:
32362
32363 .ilist
32364 .vindex "&$qualify_domain$&"
32365 If no domain is specified by the submission control, the local part is
32366 &$authenticated_id$& and the domain is &$qualify_domain$&.
32367 .next
32368 If a non-empty domain is specified by the submission control, the local part
32369 is &$authenticated_id$&, and the domain is the specified domain.
32370 .next
32371 If an empty domain is specified by the submission control,
32372 &$authenticated_id$& is assumed to be the complete address.
32373 .endlist
32374
32375 This address is compared with the address in the &'From:'& header line. If they
32376 are different, a &'Sender:'& header line containing the created address is
32377 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32378 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32379
32380 .cindex "return path" "created from &'Sender:'&"
32381 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32382 the message (the envelope sender address) is changed to be the same address,
32383 except in the case of submission mode when &%sender_retain%& is specified.
32384
32385
32386
32387 .section "Adding and removing header lines in routers and transports" &&&
32388          "SECTheadersaddrem"
32389 .cindex "header lines" "adding; in router or transport"
32390 .cindex "header lines" "removing; in router or transport"
32391 When a message is delivered, the addition and removal of header lines can be
32392 specified in a system filter, or on any of the routers and transports that
32393 process the message. Section &<<SECTaddremheasys>>& contains details about
32394 modifying headers in a system filter. Header lines can also be added in an ACL
32395 as a message is received (see section &<<SECTaddheadacl>>&).
32396
32397 In contrast to what happens in a system filter, header modifications that are
32398 specified on routers and transports apply only to the particular recipient
32399 addresses that are being processed by those routers and transports. These
32400 changes do not actually take place until a copy of the message is being
32401 transported. Therefore, they do not affect the basic set of header lines, and
32402 they do not affect the values of the variables that refer to header lines.
32403
32404 &*Note*&: In particular, this means that any expansions in the configuration of
32405 the transport cannot refer to the modified header lines, because such
32406 expansions all occur before the message is actually transported.
32407
32408 For both routers and transports, the argument of a &%headers_add%&
32409 option must be in the form of one or more RFC 2822 header lines, separated by
32410 newlines (coded as &"\n"&). For example:
32411 .code
32412 headers_add = X-added-header: added by $primary_hostname\n\
32413               X-added-second: another added header line
32414 .endd
32415 Exim does not check the syntax of these added header lines.
32416
32417 Multiple &%headers_add%& options for a single router or transport can be
32418 specified; the values will append to a single list of header lines.
32419 Each header-line is separately expanded.
32420
32421 The argument of a &%headers_remove%& option must consist of a colon-separated
32422 list of header names. This is confusing, because header names themselves are
32423 often terminated by colons. In this case, the colons are the list separators,
32424 not part of the names. For example:
32425 .code
32426 headers_remove = return-receipt-to:acknowledge-to
32427 .endd
32428
32429 Multiple &%headers_remove%& options for a single router or transport can be
32430 specified; the arguments will append to a single header-names list.
32431 Each item is separately expanded.
32432
32433 When &%headers_add%& or &%headers_remove%& is specified on a router,
32434 items are expanded at routing time,
32435 and then associated with all addresses that are
32436 accepted by that router, and also with any new addresses that it generates. If
32437 an address passes through several routers as a result of aliasing or
32438 forwarding, the changes are cumulative.
32439
32440 .oindex "&%unseen%&"
32441 However, this does not apply to multiple routers that result from the use of
32442 the &%unseen%& option. Any header modifications that were specified by the
32443 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32444
32445 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32446 settings cannot be delivered together in a batch, so a transport is always
32447 dealing with a set of addresses that have the same header-processing
32448 requirements.
32449
32450 The transport starts by writing the original set of header lines that arrived
32451 with the message, possibly modified by the system filter. As it writes out
32452 these lines, it consults the list of header names that were attached to the
32453 recipient address(es) by &%headers_remove%& options in routers, and it also
32454 consults the transport's own &%headers_remove%& option. Header lines whose
32455 names are on either of these lists are not written out. If there are multiple
32456 instances of any listed header, they are all skipped.
32457
32458 After the remaining original header lines have been written, new header
32459 lines that were specified by routers' &%headers_add%& options are written, in
32460 the order in which they were attached to the address. These are followed by any
32461 header lines specified by the transport's &%headers_add%& option.
32462
32463 This way of handling header line modifications in routers and transports has
32464 the following consequences:
32465
32466 .ilist
32467 The original set of header lines, possibly modified by the system filter,
32468 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32469 to it, at all times.
32470 .next
32471 Header lines that are added by a router's
32472 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32473 expansion syntax in subsequent routers or the transport.
32474 .next
32475 Conversely, header lines that are specified for removal by &%headers_remove%&
32476 in a router remain visible to subsequent routers and the transport.
32477 .next
32478 Headers added to an address by &%headers_add%& in a router cannot be removed by
32479 a later router or by a transport.
32480 .next
32481 An added header can refer to the contents of an original header that is to be
32482 removed, even it has the same name as the added header. For example:
32483 .code
32484 headers_remove = subject
32485 headers_add = Subject: new subject (was: $h_subject:)
32486 .endd
32487 .endlist
32488
32489 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32490 for a &(redirect)& router that has the &%one_time%& option set.
32491
32492
32493
32494
32495
32496 .section "Constructed addresses" "SECTconstr"
32497 .cindex "address" "constructed"
32498 .cindex "constructed address"
32499 When Exim constructs a sender address for a locally-generated message, it uses
32500 the form
32501 .display
32502 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32503 .endd
32504 For example:
32505 .code
32506 Zaphod Beeblebrox <zaphod@end.univ.example>
32507 .endd
32508 The user name is obtained from the &%-F%& command line option if set, or
32509 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32510 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32511 ampersand character, this is replaced by the login name with the first letter
32512 upper cased, as is conventional in a number of operating systems. See the
32513 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32514 The &%unknown_username%& option can be used to specify user names in cases when
32515 there is no password file entry.
32516
32517 .cindex "RFC 2047"
32518 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32519 parts of it if necessary. In addition, if it contains any non-printing
32520 characters, it is encoded as described in RFC 2047, which defines a way of
32521 including non-ASCII characters in header lines. The value of the
32522 &%headers_charset%& option specifies the name of the encoding that is used (the
32523 characters are assumed to be in this encoding). The setting of
32524 &%print_topbitchars%& controls whether characters with the top bit set (that
32525 is, with codes greater than 127) count as printing characters or not.
32526
32527
32528
32529 .section "Case of local parts" "SECID230"
32530 .cindex "case of local parts"
32531 .cindex "local part" "case of"
32532 RFC 2822 states that the case of letters in the local parts of addresses cannot
32533 be assumed to be non-significant. Exim preserves the case of local parts of
32534 addresses, but by default it uses a lower-cased form when it is routing,
32535 because on most Unix systems, usernames are in lower case and case-insensitive
32536 routing is required. However, any particular router can be made to use the
32537 original case for local parts by setting the &%caseful_local_part%& generic
32538 router option.
32539
32540 .cindex "mixed-case login names"
32541 If you must have mixed-case user names on your system, the best way to proceed,
32542 assuming you want case-independent handling of incoming email, is to set up
32543 your first router to convert incoming local parts in your domains to the
32544 correct case by means of a file lookup. For example:
32545 .code
32546 correct_case:
32547   driver = redirect
32548   domains = +local_domains
32549   data = ${lookup{$local_part}cdb\
32550               {/etc/usercased.cdb}{$value}fail}\
32551               @$domain
32552 .endd
32553 For this router, the local part is forced to lower case by the default action
32554 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32555 up a new local part in the correct case. If you then set &%caseful_local_part%&
32556 on any subsequent routers which process your domains, they will operate on
32557 local parts with the correct case in a case-sensitive manner.
32558
32559
32560
32561 .section "Dots in local parts" "SECID231"
32562 .cindex "dot" "in local part"
32563 .cindex "local part" "dots in"
32564 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32565 part may not begin or end with a dot, nor have two consecutive dots in the
32566 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32567 empty components for compatibility.
32568
32569
32570
32571 .section "Rewriting addresses" "SECID232"
32572 .cindex "rewriting" "addresses"
32573 Rewriting of sender and recipient addresses, and addresses in headers, can
32574 happen automatically, or as the result of configuration options, as described
32575 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32576 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32577
32578 Automatic rewriting includes qualification, as mentioned above. The other case
32579 in which it can happen is when an incomplete non-local domain is given. The
32580 routing process may cause this to be expanded into the full domain name. For
32581 example, a header such as
32582 .code
32583 To: hare@teaparty
32584 .endd
32585 might get rewritten as
32586 .code
32587 To: hare@teaparty.wonderland.fict.example
32588 .endd
32589 Rewriting as a result of routing is the one kind of message processing that
32590 does not happen at input time, as it cannot be done until the address has
32591 been routed.
32592
32593 Strictly, one should not do &'any'& deliveries of a message until all its
32594 addresses have been routed, in case any of the headers get changed as a
32595 result of routing. However, doing this in practice would hold up many
32596 deliveries for unreasonable amounts of time, just because one address could not
32597 immediately be routed. Exim therefore does not delay other deliveries when
32598 routing of one or more addresses is deferred.
32599 .ecindex IIDmesproc
32600
32601
32602
32603 . ////////////////////////////////////////////////////////////////////////////
32604 . ////////////////////////////////////////////////////////////////////////////
32605
32606 .chapter "SMTP processing" "CHAPSMTP"
32607 .scindex IIDsmtpproc1 "SMTP" "processing details"
32608 .scindex IIDsmtpproc2 "LMTP" "processing details"
32609 Exim supports a number of different ways of using the SMTP protocol, and its
32610 LMTP variant, which is an interactive protocol for transferring messages into a
32611 closed mail store application. This chapter contains details of how SMTP is
32612 processed. For incoming mail, the following are available:
32613
32614 .ilist
32615 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32616 .next
32617 SMTP over the standard input and output (the &%-bs%& option);
32618 .next
32619 Batched SMTP on the standard input (the &%-bS%& option).
32620 .endlist
32621
32622 For mail delivery, the following are available:
32623
32624 .ilist
32625 SMTP over TCP/IP (the &(smtp)& transport);
32626 .next
32627 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32628 &"lmtp"&);
32629 .next
32630 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32631 transport);
32632 .next
32633 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32634 the &%use_bsmtp%& option set).
32635 .endlist
32636
32637 &'Batched SMTP'& is the name for a process in which batches of messages are
32638 stored in or read from files (or pipes), in a format in which SMTP commands are
32639 used to contain the envelope information.
32640
32641
32642
32643 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32644 .cindex "SMTP" "outgoing over TCP/IP"
32645 .cindex "outgoing SMTP over TCP/IP"
32646 .cindex "LMTP" "over TCP/IP"
32647 .cindex "outgoing LMTP over TCP/IP"
32648 .cindex "EHLO"
32649 .cindex "HELO"
32650 .cindex "SIZE option on MAIL command"
32651 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32652 The &%protocol%& option selects which protocol is to be used, but the actual
32653 processing is the same in both cases.
32654
32655 If, in response to its EHLO command, Exim is told that the SIZE
32656 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32657 command. The value of <&'n'&> is the message size plus the value of the
32658 &%size_addition%& option (default 1024) to allow for additions to the message
32659 such as per-transport header lines, or changes made in a
32660 .cindex "transport" "filter"
32661 .cindex "filter" "transport filter"
32662 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32663 suppressed.
32664
32665 If the remote server advertises support for PIPELINING, Exim uses the
32666 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32667 required for the transaction.
32668
32669 If the remote server advertises support for the STARTTLS command, and Exim
32670 was built to support TLS encryption, it tries to start a TLS session unless the
32671 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32672 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32673 is called for verification.
32674
32675 If the remote server advertises support for the AUTH command, Exim scans
32676 the authenticators configuration for any suitable client settings, as described
32677 in chapter &<<CHAPSMTPAUTH>>&.
32678
32679 .cindex "carriage return"
32680 .cindex "linefeed"
32681 Responses from the remote host are supposed to be terminated by CR followed by
32682 LF. However, there are known to be hosts that do not send CR characters, so in
32683 order to be able to interwork with such hosts, Exim treats LF on its own as a
32684 line terminator.
32685
32686 If a message contains a number of different addresses, all those with the same
32687 characteristics (for example, the same envelope sender) that resolve to the
32688 same set of hosts, in the same order, are sent in a single SMTP transaction,
32689 even if they are for different domains, unless there are more than the setting
32690 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32691 they are split into groups containing no more than &%max_rcpt%&s addresses
32692 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32693 in parallel sessions. The order of hosts with identical MX values is not
32694 significant when checking whether addresses can be batched in this way.
32695
32696 When the &(smtp)& transport suffers a temporary failure that is not
32697 message-related, Exim updates its transport-specific database, which contains
32698 records indexed by host name that remember which messages are waiting for each
32699 particular host. It also updates the retry database with new retry times.
32700
32701 .cindex "hints database" "retry keys"
32702 Exim's retry hints are based on host name plus IP address, so if one address of
32703 a multi-homed host is broken, it will soon be skipped most of the time.
32704 See the next section for more detail about error handling.
32705
32706 .cindex "SMTP" "passed connection"
32707 .cindex "SMTP" "batching over TCP/IP"
32708 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32709 looks in the hints database for the transport to see if there are any queued
32710 messages waiting for the host to which it is connected. If it finds one, it
32711 creates a new Exim process using the &%-MC%& option (which can only be used by
32712 a process running as root or the Exim user) and passes the TCP/IP socket to it
32713 so that it can deliver another message using the same socket. The new process
32714 does only those deliveries that are routed to the connected host, and may in
32715 turn pass the socket on to a third process, and so on.
32716
32717 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32718 limit the number of messages sent down a single TCP/IP connection.
32719
32720 .cindex "asterisk" "after IP address"
32721 The second and subsequent messages delivered down an existing connection are
32722 identified in the main log by the addition of an asterisk after the closing
32723 square bracket of the IP address.
32724
32725
32726
32727
32728 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
32729 .cindex "error" "in outgoing SMTP"
32730 .cindex "SMTP" "errors in outgoing"
32731 .cindex "host" "error"
32732 Three different kinds of error are recognized for outgoing SMTP: host errors,
32733 message errors, and recipient errors.
32734
32735 .vlist
32736 .vitem "&*Host errors*&"
32737 A host error is not associated with a particular message or with a
32738 particular recipient of a message. The host errors are:
32739
32740 .ilist
32741 Connection refused or timed out,
32742 .next
32743 Any error response code on connection,
32744 .next
32745 Any error response code to EHLO or HELO,
32746 .next
32747 Loss of connection at any time, except after &"."&,
32748 .next
32749 I/O errors at any time,
32750 .next
32751 Timeouts during the session, other than in response to MAIL, RCPT or
32752 the &"."& at the end of the data.
32753 .endlist ilist
32754
32755 For a host error, a permanent error response on connection, or in response to
32756 EHLO, causes all addresses routed to the host to be failed. Any other host
32757 error causes all addresses to be deferred, and retry data to be created for the
32758 host. It is not tried again, for any message, until its retry time arrives. If
32759 the current set of addresses are not all delivered in this run (to some
32760 alternative host), the message is added to the list of those waiting for this
32761 host, so if it is still undelivered when a subsequent successful delivery is
32762 made to the host, it will be sent down the same SMTP connection.
32763
32764 .vitem "&*Message errors*&"
32765 .cindex "message" "error"
32766 A message error is associated with a particular message when sent to a
32767 particular host, but not with a particular recipient of the message. The
32768 message errors are:
32769
32770 .ilist
32771 Any error response code to MAIL, DATA, or the &"."& that terminates
32772 the data,
32773 .next
32774 Timeout after MAIL,
32775 .next
32776 Timeout or loss of connection after the &"."& that terminates the data. A
32777 timeout after the DATA command itself is treated as a host error, as is loss of
32778 connection at any other time.
32779 .endlist ilist
32780
32781 For a message error, a permanent error response (5&'xx'&) causes all addresses
32782 to be failed, and a delivery error report to be returned to the sender. A
32783 temporary error response (4&'xx'&), or one of the timeouts, causes all
32784 addresses to be deferred. Retry data is not created for the host, but instead,
32785 a retry record for the combination of host plus message id is created. The
32786 message is not added to the list of those waiting for this host. This ensures
32787 that the failing message will not be sent to this host again until the retry
32788 time arrives. However, other messages that are routed to the host are not
32789 affected, so if it is some property of the message that is causing the error,
32790 it will not stop the delivery of other mail.
32791
32792 If the remote host specified support for the SIZE parameter in its response
32793 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32794 over-large message will cause a message error because the error arrives as a
32795 response to MAIL.
32796
32797 .vitem "&*Recipient errors*&"
32798 .cindex "recipient" "error"
32799 A recipient error is associated with a particular recipient of a message. The
32800 recipient errors are:
32801
32802 .ilist
32803 Any error response to RCPT,
32804 .next
32805 Timeout after RCPT.
32806 .endlist
32807
32808 For a recipient error, a permanent error response (5&'xx'&) causes the
32809 recipient address to be failed, and a bounce message to be returned to the
32810 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32811 address to be deferred, and routing retry data to be created for it. This is
32812 used to delay processing of the address in subsequent queue runs, until its
32813 routing retry time arrives. This applies to all messages, but because it
32814 operates only in queue runs, one attempt will be made to deliver a new message
32815 to the failing address before the delay starts to operate. This ensures that,
32816 if the failure is really related to the message rather than the recipient
32817 (&"message too big for this recipient"& is a possible example), other messages
32818 have a chance of getting delivered. If a delivery to the address does succeed,
32819 the retry information gets cleared, so all stuck messages get tried again, and
32820 the retry clock is reset.
32821
32822 The message is not added to the list of those waiting for this host. Use of the
32823 host for other messages is unaffected, and except in the case of a timeout,
32824 other recipients are processed independently, and may be successfully delivered
32825 in the current SMTP session. After a timeout it is of course impossible to
32826 proceed with the session, so all addresses get deferred. However, those other
32827 than the one that failed do not suffer any subsequent retry delays. Therefore,
32828 if one recipient is causing trouble, the others have a chance of getting
32829 through when a subsequent delivery attempt occurs before the failing
32830 recipient's retry time.
32831 .endlist
32832
32833 In all cases, if there are other hosts (or IP addresses) available for the
32834 current set of addresses (for example, from multiple MX records), they are
32835 tried in this run for any undelivered addresses, subject of course to their
32836 own retry data. In other words, recipient error retry data does not take effect
32837 until the next delivery attempt.
32838
32839 Some hosts have been observed to give temporary error responses to every
32840 MAIL command at certain times (&"insufficient space"& has been seen). It
32841 would be nice if such circumstances could be recognized, and defer data for the
32842 host itself created, but this is not possible within the current Exim design.
32843 What actually happens is that retry data for every (host, message) combination
32844 is created.
32845
32846 The reason that timeouts after MAIL and RCPT are treated specially is that
32847 these can sometimes arise as a result of the remote host's verification
32848 procedures. Exim makes this assumption, and treats them as if a temporary error
32849 response had been received. A timeout after &"."& is treated specially because
32850 it is known that some broken implementations fail to recognize the end of the
32851 message if the last character of the last line is a binary zero. Thus, it is
32852 helpful to treat this case as a message error.
32853
32854 Timeouts at other times are treated as host errors, assuming a problem with the
32855 host, or the connection to it. If a timeout after MAIL, RCPT,
32856 or &"."& is really a connection problem, the assumption is that at the next try
32857 the timeout is likely to occur at some other point in the dialogue, causing it
32858 then to be treated as a host error.
32859
32860 There is experimental evidence that some MTAs drop the connection after the
32861 terminating &"."& if they do not like the contents of the message for some
32862 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32863 should be given. That is why Exim treats this case as a message rather than a
32864 host error, in order not to delay other messages to the same host.
32865
32866
32867
32868
32869 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32870 .cindex "SMTP" "incoming over TCP/IP"
32871 .cindex "incoming SMTP over TCP/IP"
32872 .cindex "inetd"
32873 .cindex "daemon"
32874 Incoming SMTP messages can be accepted in one of two ways: by running a
32875 listening daemon, or by using &'inetd'&. In the latter case, the entry in
32876 &_/etc/inetd.conf_& should be like this:
32877 .code
32878 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
32879 .endd
32880 Exim distinguishes between this case and the case of a locally running user
32881 agent using the &%-bs%& option by checking whether or not the standard input is
32882 a socket. When it is, either the port must be privileged (less than 1024), or
32883 the caller must be root or the Exim user. If any other user passes a socket
32884 with an unprivileged port number, Exim prints a message on the standard error
32885 stream and exits with an error code.
32886
32887 By default, Exim does not make a log entry when a remote host connects or
32888 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
32889 unexpected. It can be made to write such log entries by setting the
32890 &%smtp_connection%& log selector.
32891
32892 .cindex "carriage return"
32893 .cindex "linefeed"
32894 Commands from the remote host are supposed to be terminated by CR followed by
32895 LF. However, there are known to be hosts that do not send CR characters. In
32896 order to be able to interwork with such hosts, Exim treats LF on its own as a
32897 line terminator.
32898 Furthermore, because common code is used for receiving messages from all
32899 sources, a CR on its own is also interpreted as a line terminator. However, the
32900 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
32901
32902 .cindex "EHLO" "invalid data"
32903 .cindex "HELO" "invalid data"
32904 One area that sometimes gives rise to problems concerns the EHLO or
32905 HELO commands. Some clients send syntactically invalid versions of these
32906 commands, which Exim rejects by default. (This is nothing to do with verifying
32907 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
32908 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
32909 match the broken hosts that send invalid commands.
32910
32911 .cindex "SIZE option on MAIL command"
32912 .cindex "MAIL" "SIZE option"
32913 The amount of disk space available is checked whenever SIZE is received on
32914 a MAIL command, independently of whether &%message_size_limit%& or
32915 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
32916 false. A temporary error is given if there is not enough space. If
32917 &%check_spool_space%& is set, the check is for that amount of space plus the
32918 value given with SIZE, that is, it checks that the addition of the incoming
32919 message will not reduce the space below the threshold.
32920
32921 When a message is successfully received, Exim includes the local message id in
32922 its response to the final &"."& that terminates the data. If the remote host
32923 logs this text it can help with tracing what has happened to a message.
32924
32925 The Exim daemon can limit the number of simultaneous incoming connections it is
32926 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
32927 number of simultaneous incoming connections from a single remote host (see the
32928 &%smtp_accept_max_per_host%& option). Additional connection attempts are
32929 rejected using the SMTP temporary error code 421.
32930
32931 The Exim daemon does not rely on the SIGCHLD signal to detect when a
32932 subprocess has finished, as this can get lost at busy times. Instead, it looks
32933 for completed subprocesses every time it wakes up. Provided there are other
32934 things happening (new incoming calls, starts of queue runs), completed
32935 processes will be noticed and tidied away. On very quiet systems you may
32936 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
32937 it will be noticed when the daemon next wakes up.
32938
32939 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
32940 and can also be set up to reject SMTP calls from non-reserved hosts at times of
32941 high system load &-- for details see the &%smtp_accept_reserve%&,
32942 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
32943 applies in both the daemon and &'inetd'& cases.
32944
32945 Exim normally starts a delivery process for each message received, though this
32946 can be varied by means of the &%-odq%& command line option and the
32947 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
32948 number of simultaneously running delivery processes started in this way from
32949 SMTP input can be limited by the &%smtp_accept_queue%& and
32950 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
32951 subsequently received messages are just put on the input queue without starting
32952 a delivery process.
32953
32954 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
32955 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
32956 started up from the &'inetd'& daemon, because in that case each connection is
32957 handled by an entirely independent Exim process. Control by load average is,
32958 however, available with &'inetd'&.
32959
32960 Exim can be configured to verify addresses in incoming SMTP commands as they
32961 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
32962 to rewrite addresses at this time &-- before any syntax checking is done. See
32963 section &<<SECTrewriteS>>&.
32964
32965 Exim can also be configured to limit the rate at which a client host submits
32966 MAIL and RCPT commands in a single SMTP session. See the
32967 &%smtp_ratelimit_hosts%& option.
32968
32969
32970
32971 .section "Unrecognized SMTP commands" "SECID234"
32972 .cindex "SMTP" "unrecognized commands"
32973 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
32974 commands during a single SMTP connection, it drops the connection after sending
32975 the error response to the last command. The default value for
32976 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
32977 abuse that subvert web servers into making connections to SMTP ports; in these
32978 circumstances, a number of non-SMTP lines are sent first.
32979
32980
32981 .section "Syntax and protocol errors in SMTP commands" "SECID235"
32982 .cindex "SMTP" "syntax errors"
32983 .cindex "SMTP" "protocol errors"
32984 A syntax error is detected if an SMTP command is recognized, but there is
32985 something syntactically wrong with its data, for example, a malformed email
32986 address in a RCPT command. Protocol errors include invalid command
32987 sequencing such as RCPT before MAIL. If Exim receives more than
32988 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
32989 drops the connection after sending the error response to the last command. The
32990 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
32991 broken clients that loop sending bad commands (yes, it has been seen).
32992
32993
32994
32995 .section "Use of non-mail SMTP commands" "SECID236"
32996 .cindex "SMTP" "non-mail commands"
32997 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
32998 DATA. Exim counts such commands, and drops the connection if there are too
32999 many of them in a single SMTP session. This action catches some
33000 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33001 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33002 defines what &"too many"& means. Its default value is 10.
33003
33004 When a new message is expected, one occurrence of RSET is not counted. This
33005 allows a client to send one RSET between messages (this is not necessary,
33006 but some clients do it). Exim also allows one uncounted occurrence of HELO
33007 or EHLO, and one occurrence of STARTTLS between messages. After
33008 starting up a TLS session, another EHLO is expected, and so it too is not
33009 counted.
33010
33011 The first occurrence of AUTH in a connection, or immediately following
33012 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33013 RCPT, DATA, and QUIT are counted.
33014
33015 You can control which hosts are subject to the limit set by
33016 &%smtp_accept_max_nonmail%& by setting
33017 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33018 the limit apply to all hosts. This option means that you can exclude any
33019 specific badly-behaved hosts that you have to live with.
33020
33021
33022
33023
33024 .section "The VRFY and EXPN commands" "SECID237"
33025 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33026 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33027 appropriate) in order to decide whether the command should be accepted or not.
33028 If no ACL is defined, the command is rejected.
33029
33030 .cindex "VRFY" "processing"
33031 When VRFY is accepted, it runs exactly the same code as when Exim is
33032 called with the &%-bv%& option.
33033
33034 .cindex "EXPN" "processing"
33035 When EXPN is accepted, a single-level expansion of the address is done.
33036 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33037 than a verification (the &%-bv%& option). If an unqualified local part is given
33038 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33039 of VRFY and EXPN commands are logged on the main and reject logs, and
33040 VRFY verification failures are logged on the main log for consistency with
33041 RCPT failures.
33042
33043
33044
33045 .section "The ETRN command" "SECTETRN"
33046 .cindex "ETRN" "processing"
33047 RFC 1985 describes an SMTP command called ETRN that is designed to
33048 overcome the security problems of the TURN command (which has fallen into
33049 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33050 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33051 should be accepted or not. If no ACL is defined, the command is rejected.
33052
33053 The ETRN command is concerned with &"releasing"& messages that are awaiting
33054 delivery to certain hosts. As Exim does not organize its message queue by host,
33055 the only form of ETRN that is supported by default is the one where the
33056 text starts with the &"#"& prefix, in which case the remainder of the text is
33057 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33058 the &%-R%& option to happen, with the remainder of the ETRN text as its
33059 argument. For example,
33060 .code
33061 ETRN #brigadoon
33062 .endd
33063 runs the command
33064 .code
33065 exim -R brigadoon
33066 .endd
33067 which causes a delivery attempt on all messages with undelivered addresses
33068 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33069 default), Exim prevents the simultaneous execution of more than one queue run
33070 for the same argument string as a result of an ETRN command. This stops
33071 a misbehaving client from starting more than one queue runner at once.
33072
33073 .cindex "hints database" "ETRN serialization"
33074 Exim implements the serialization by means of a hints database in which a
33075 record is written whenever a process is started by ETRN, and deleted when
33076 the process completes. However, Exim does not keep the SMTP session waiting for
33077 the ETRN process to complete. Once ETRN is accepted, the client is sent
33078 a &"success"& return code. Obviously there is scope for hints records to get
33079 left lying around if there is a system or program crash. To guard against this,
33080 Exim ignores any records that are more than six hours old.
33081
33082 .oindex "&%smtp_etrn_command%&"
33083 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33084 used. This specifies a command that is run whenever ETRN is received,
33085 whatever the form of its argument. For
33086 example:
33087 .code
33088 smtp_etrn_command = /etc/etrn_command $domain \
33089                     $sender_host_address
33090 .endd
33091 .vindex "&$domain$&"
33092 The string is split up into arguments which are independently expanded. The
33093 expansion variable &$domain$& is set to the argument of the ETRN command,
33094 and no syntax checking is done on the contents of this argument. Exim does not
33095 wait for the command to complete, so its status code is not checked. Exim runs
33096 under its own uid and gid when receiving incoming SMTP, so it is not possible
33097 for it to change them before running the command.
33098
33099
33100
33101 .section "Incoming local SMTP" "SECID238"
33102 .cindex "SMTP" "local incoming"
33103 Some user agents use SMTP to pass messages to their local MTA using the
33104 standard input and output, as opposed to passing the envelope on the command
33105 line and writing the message to the standard input. This is supported by the
33106 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33107 messages over TCP/IP (including the use of ACLs), except that the envelope
33108 sender given in a MAIL command is ignored unless the caller is trusted. In
33109 an ACL you can detect this form of SMTP input by testing for an empty host
33110 identification. It is common to have this as the first line in the ACL that
33111 runs for RCPT commands:
33112 .code
33113 accept hosts = :
33114 .endd
33115 This accepts SMTP messages from local processes without doing any other tests.
33116
33117
33118
33119 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33120 .cindex "SMTP" "batched outgoing"
33121 .cindex "batched SMTP output"
33122 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33123 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33124 be output in BSMTP format. No SMTP responses are possible for this form of
33125 delivery. All it is doing is using SMTP commands as a way of transmitting the
33126 envelope along with the message.
33127
33128 The message is written to the file or pipe preceded by the SMTP commands
33129 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33130 the message that start with a dot have an extra dot added. The SMTP command
33131 HELO is not normally used. If it is required, the &%message_prefix%& option
33132 can be used to specify it.
33133
33134 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33135 one recipient address at a time by default. However, you can arrange for them
33136 to handle several addresses at once by setting the &%batch_max%& option. When
33137 this is done for BSMTP, messages may contain multiple RCPT commands. See
33138 chapter &<<CHAPbatching>>& for more details.
33139
33140 .vindex "&$host$&"
33141 When one or more addresses are routed to a BSMTP transport by a router that
33142 sets up a host list, the name of the first host on the list is available to the
33143 transport in the variable &$host$&. Here is an example of such a transport and
33144 router:
33145 .code
33146 begin routers
33147 route_append:
33148   driver = manualroute
33149   transport = smtp_appendfile
33150   route_list = domain.example  batch.host.example
33151
33152 begin transports
33153 smtp_appendfile:
33154   driver = appendfile
33155   directory = /var/bsmtp/$host
33156   batch_max = 1000
33157   use_bsmtp
33158   user = exim
33159 .endd
33160 This causes messages addressed to &'domain.example'& to be written in BSMTP
33161 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33162 message (unless there are more than 1000 recipients).
33163
33164
33165
33166 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33167 .cindex "SMTP" "batched incoming"
33168 .cindex "batched SMTP input"
33169 The &%-bS%& command line option causes Exim to accept one or more messages by
33170 reading SMTP on the standard input, but to generate no responses. If the caller
33171 is trusted, the senders in the MAIL commands are believed; otherwise the
33172 sender is always the caller of Exim. Unqualified senders and receivers are not
33173 rejected (there seems little point) but instead just get qualified. HELO
33174 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33175 as NOOP; QUIT quits.
33176
33177 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33178 ACL is run in the same way as for non-SMTP local input.
33179
33180 If an error is detected while reading a message, including a missing &"."& at
33181 the end, Exim gives up immediately. It writes details of the error to the
33182 standard output in a stylized way that the calling program should be able to
33183 make some use of automatically, for example:
33184 .code
33185 554 Unexpected end of file
33186 Transaction started in line 10
33187 Error detected in line 14
33188 .endd
33189 It writes a more verbose version, for human consumption, to the standard error
33190 file, for example:
33191 .code
33192 An error was detected while processing a file of BSMTP input.
33193 The error message was:
33194
33195 501 '>' missing at end of address
33196
33197 The SMTP transaction started in line 10.
33198 The error was detected in line 12.
33199 The SMTP command at fault was:
33200
33201 rcpt to:<malformed@in.com.plete
33202
33203 1 previous message was successfully processed.
33204 The rest of the batch was abandoned.
33205 .endd
33206 The return code from Exim is zero only if there were no errors. It is 1 if some
33207 messages were accepted before an error was detected, and 2 if no messages were
33208 accepted.
33209 .ecindex IIDsmtpproc1
33210 .ecindex IIDsmtpproc2
33211
33212
33213
33214 . ////////////////////////////////////////////////////////////////////////////
33215 . ////////////////////////////////////////////////////////////////////////////
33216
33217 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33218          "Customizing messages"
33219 When a message fails to be delivered, or remains on the queue for more than a
33220 configured amount of time, Exim sends a message to the original sender, or
33221 to an alternative configured address. The text of these messages is built into
33222 the code of Exim, but it is possible to change it, either by adding a single
33223 string, or by replacing each of the paragraphs by text supplied in a file.
33224
33225 The &'From:'& and &'To:'& header lines are automatically generated; you can
33226 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33227 option. Exim also adds the line
33228 .code
33229 Auto-Submitted: auto-generated
33230 .endd
33231 to all warning and bounce messages,
33232
33233
33234 .section "Customizing bounce messages" "SECID239"
33235 .cindex "customizing" "bounce message"
33236 .cindex "bounce message" "customizing"
33237 If &%bounce_message_text%& is set, its contents are included in the default
33238 message immediately after &"This message was created automatically by mail
33239 delivery software."& The string is not expanded. It is not used if
33240 &%bounce_message_file%& is set.
33241
33242 When &%bounce_message_file%& is set, it must point to a template file for
33243 constructing error messages. The file consists of a series of text items,
33244 separated by lines consisting of exactly four asterisks. If the file cannot be
33245 opened, default text is used and a message is written to the main and panic
33246 logs. If any text item in the file is empty, default text is used for that
33247 item.
33248
33249 .vindex "&$bounce_recipient$&"
33250 .vindex "&$bounce_return_size_limit$&"
33251 Each item of text that is read from the file is expanded, and there are two
33252 expansion variables which can be of use here: &$bounce_recipient$& is set to
33253 the recipient of an error message while it is being created, and
33254 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33255 option, rounded to a whole number.
33256
33257 The items must appear in the file in the following order:
33258
33259 .ilist
33260 The first item is included in the headers, and should include at least a
33261 &'Subject:'& header. Exim does not check the syntax of these headers.
33262 .next
33263 The second item forms the start of the error message. After it, Exim lists the
33264 failing addresses with their error messages.
33265 .next
33266 The third item is used to introduce any text from pipe transports that is to be
33267 returned to the sender. It is omitted if there is no such text.
33268 .next
33269 The fourth item is used to introduce the copy of the message that is returned
33270 as part of the error report.
33271 .next
33272 The fifth item is added after the fourth one if the returned message is
33273 truncated because it is bigger than &%return_size_limit%&.
33274 .next
33275 The sixth item is added after the copy of the original message.
33276 .endlist
33277
33278 The default state (&%bounce_message_file%& unset) is equivalent to the
33279 following file, in which the sixth item is empty. The &'Subject:'& and some
33280 other lines have been split in order to fit them on the page:
33281 .code
33282 Subject: Mail delivery failed
33283   ${if eq{$sender_address}{$bounce_recipient}
33284   {: returning message to sender}}
33285 ****
33286 This message was created automatically by mail delivery software.
33287
33288 A message ${if eq{$sender_address}{$bounce_recipient}
33289   {that you sent }{sent by
33290
33291 <$sender_address>
33292
33293 }}could not be delivered to all of its recipients.
33294 This is a permanent error. The following address(es) failed:
33295 ****
33296 The following text was generated during the delivery attempt(s):
33297 ****
33298 ------ This is a copy of the message, including all the headers.
33299   ------
33300 ****
33301 ------ The body of the message is $message_size characters long;
33302   only the first
33303 ------ $bounce_return_size_limit or so are included here.
33304 ****
33305 .endd
33306 .section "Customizing warning messages" "SECTcustwarn"
33307 .cindex "customizing" "warning message"
33308 .cindex "warning of delay" "customizing the message"
33309 The option &%warn_message_file%& can be pointed at a template file for use when
33310 warnings about message delays are created. In this case there are only three
33311 text sections:
33312
33313 .ilist
33314 The first item is included in the headers, and should include at least a
33315 &'Subject:'& header. Exim does not check the syntax of these headers.
33316 .next
33317 The second item forms the start of the warning message. After it, Exim lists
33318 the delayed addresses.
33319 .next
33320 The third item then ends the message.
33321 .endlist
33322
33323 The default state is equivalent to the following file, except that some lines
33324 have been split here, in order to fit them on the page:
33325 .code
33326 Subject: Warning: message $message_exim_id delayed
33327   $warn_message_delay
33328 ****
33329 This message was created automatically by mail delivery software.
33330
33331 A message ${if eq{$sender_address}{$warn_message_recipients}
33332 {that you sent }{sent by
33333
33334 <$sender_address>
33335
33336 }}has not been delivered to all of its recipients after
33337 more than $warn_message_delay on the queue on $primary_hostname.
33338
33339 The message identifier is:     $message_exim_id
33340 The subject of the message is: $h_subject
33341 The date of the message is:    $h_date
33342
33343 The following address(es) have not yet been delivered:
33344 ****
33345 No action is required on your part. Delivery attempts will
33346 continue for some time, and this warning may be repeated at
33347 intervals if the message remains undelivered. Eventually the
33348 mail delivery software will give up, and when that happens,
33349 the message will be returned to you.
33350 .endd
33351 .vindex "&$warn_message_delay$&"
33352 .vindex "&$warn_message_recipients$&"
33353 However, in the default state the subject and date lines are omitted if no
33354 appropriate headers exist. During the expansion of this file,
33355 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33356 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33357 of recipients for the warning message. There may be more than one if there are
33358 multiple addresses with different &%errors_to%& settings on the routers that
33359 handled them.
33360
33361
33362
33363
33364 . ////////////////////////////////////////////////////////////////////////////
33365 . ////////////////////////////////////////////////////////////////////////////
33366
33367 .chapter "Some common configuration settings" "CHAPcomconreq"
33368 This chapter discusses some configuration settings that seem to be fairly
33369 common. More examples and discussion can be found in the Exim book.
33370
33371
33372
33373 .section "Sending mail to a smart host" "SECID240"
33374 .cindex "smart host" "example router"
33375 If you want to send all mail for non-local domains to a &"smart host"&, you
33376 should replace the default &(dnslookup)& router with a router which does the
33377 routing explicitly:
33378 .code
33379 send_to_smart_host:
33380   driver = manualroute
33381   route_list = !+local_domains smart.host.name
33382   transport = remote_smtp
33383 .endd
33384 You can use the smart host's IP address instead of the name if you wish.
33385 If you are using Exim only to submit messages to a smart host, and not for
33386 receiving incoming messages, you can arrange for it to do the submission
33387 synchronously by setting the &%mua_wrapper%& option (see chapter
33388 &<<CHAPnonqueueing>>&).
33389
33390
33391
33392
33393 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33394 .cindex "mailing lists"
33395 Exim can be used to run simple mailing lists, but for large and/or complicated
33396 requirements, the use of additional specialized mailing list software such as
33397 Majordomo or Mailman is recommended.
33398
33399 The &(redirect)& router can be used to handle mailing lists where each list
33400 is maintained in a separate file, which can therefore be managed by an
33401 independent manager. The &%domains%& router option can be used to run these
33402 lists in a separate domain from normal mail. For example:
33403 .code
33404 lists:
33405   driver = redirect
33406   domains = lists.example
33407   file = /usr/lists/$local_part
33408   forbid_pipe
33409   forbid_file
33410   errors_to = $local_part-request@lists.example
33411   no_more
33412 .endd
33413 This router is skipped for domains other than &'lists.example'&. For addresses
33414 in that domain, it looks for a file that matches the local part. If there is no
33415 such file, the router declines, but because &%no_more%& is set, no subsequent
33416 routers are tried, and so the whole delivery fails.
33417
33418 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33419 expanded into a file name or a pipe delivery, which is usually inappropriate in
33420 a mailing list.
33421
33422 .oindex "&%errors_to%&"
33423 The &%errors_to%& option specifies that any delivery errors caused by addresses
33424 taken from a mailing list are to be sent to the given address rather than the
33425 original sender of the message. However, before acting on this, Exim verifies
33426 the error address, and ignores it if verification fails.
33427
33428 For example, using the configuration above, mail sent to
33429 &'dicts@lists.example'& is passed on to those addresses contained in
33430 &_/usr/lists/dicts_&, with error reports directed to
33431 &'dicts-request@lists.example'&, provided that this address can be verified.
33432 There could be a file called &_/usr/lists/dicts-request_& containing
33433 the address(es) of this particular list's manager(s), but other approaches,
33434 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33435 or &%local_part_suffix%& options) to handle addresses of the form
33436 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33437
33438
33439
33440 .section "Syntax errors in mailing lists" "SECID241"
33441 .cindex "mailing lists" "syntax errors in"
33442 If an entry in redirection data contains a syntax error, Exim normally defers
33443 delivery of the original address. That means that a syntax error in a mailing
33444 list holds up all deliveries to the list. This may not be appropriate when a
33445 list is being maintained automatically from data supplied by users, and the
33446 addresses are not rigorously checked.
33447
33448 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33449 entries that fail to parse, noting the incident in the log. If in addition
33450 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33451 whenever a broken address is skipped. It is usually appropriate to set
33452 &%syntax_errors_to%& to the same address as &%errors_to%&.
33453
33454
33455
33456 .section "Re-expansion of mailing lists" "SECID242"
33457 .cindex "mailing lists" "re-expansion of"
33458 Exim remembers every individual address to which a message has been delivered,
33459 in order to avoid duplication, but it normally stores only the original
33460 recipient addresses with a message. If all the deliveries to a mailing list
33461 cannot be done at the first attempt, the mailing list is re-expanded when the
33462 delivery is next tried. This means that alterations to the list are taken into
33463 account at each delivery attempt, so addresses that have been added to
33464 the list since the message arrived will therefore receive a copy of the
33465 message, even though it pre-dates their subscription.
33466
33467 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33468 on the &(redirect)& router. If this is done, any addresses generated by the
33469 router that fail to deliver at the first attempt are added to the message as
33470 &"top level"& addresses, and the parent address that generated them is marked
33471 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33472 subsequent delivery attempts. The disadvantage of this is that if any of the
33473 failing addresses are incorrect, correcting them in the file has no effect on
33474 pre-existing messages.
33475
33476 The original top-level address is remembered with each of the generated
33477 addresses, and is output in any log messages. However, any intermediate parent
33478 addresses are not recorded. This makes a difference to the log only if the
33479 &%all_parents%& selector is set, but for mailing lists there is normally only
33480 one level of expansion anyway.
33481
33482
33483
33484 .section "Closed mailing lists" "SECID243"
33485 .cindex "mailing lists" "closed"
33486 The examples so far have assumed open mailing lists, to which anybody may
33487 send mail. It is also possible to set up closed lists, where mail is accepted
33488 from specified senders only. This is done by making use of the generic
33489 &%senders%& option to restrict the router that handles the list.
33490
33491 The following example uses the same file as a list of recipients and as a list
33492 of permitted senders. It requires three routers:
33493 .code
33494 lists_request:
33495   driver = redirect
33496   domains = lists.example
33497   local_part_suffix = -request
33498   file = /usr/lists/$local_part$local_part_suffix
33499   no_more
33500
33501 lists_post:
33502   driver = redirect
33503   domains = lists.example
33504   senders = ${if exists {/usr/lists/$local_part}\
33505              {lsearch;/usr/lists/$local_part}{*}}
33506   file = /usr/lists/$local_part
33507   forbid_pipe
33508   forbid_file
33509   errors_to = $local_part-request@lists.example
33510   no_more
33511
33512 lists_closed:
33513   driver = redirect
33514   domains = lists.example
33515   allow_fail
33516   data = :fail: $local_part@lists.example is a closed mailing list
33517 .endd
33518 All three routers have the same &%domains%& setting, so for any other domains,
33519 they are all skipped. The first router runs only if the local part ends in
33520 &%-request%&. It handles messages to the list manager(s) by means of an open
33521 mailing list.
33522
33523 The second router runs only if the &%senders%& precondition is satisfied. It
33524 checks for the existence of a list that corresponds to the local part, and then
33525 checks that the sender is on the list by means of a linear search. It is
33526 necessary to check for the existence of the file before trying to search it,
33527 because otherwise Exim thinks there is a configuration error. If the file does
33528 not exist, the expansion of &%senders%& is *, which matches all senders. This
33529 means that the router runs, but because there is no list, declines, and
33530 &%no_more%& ensures that no further routers are run. The address fails with an
33531 &"unrouteable address"& error.
33532
33533 The third router runs only if the second router is skipped, which happens when
33534 a mailing list exists, but the sender is not on it. This router forcibly fails
33535 the address, giving a suitable error message.
33536
33537
33538
33539
33540 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33541 .cindex "VERP"
33542 .cindex "Variable Envelope Return Paths"
33543 .cindex "envelope sender"
33544 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33545 are a way of helping mailing list administrators discover which subscription
33546 address is the cause of a particular delivery failure. The idea is to encode
33547 the original recipient address in the outgoing envelope sender address, so that
33548 if the message is forwarded by another host and then subsequently bounces, the
33549 original recipient can be extracted from the recipient address of the bounce.
33550
33551 .oindex &%errors_to%&
33552 .oindex &%return_path%&
33553 Envelope sender addresses can be modified by Exim using two different
33554 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33555 list examples), or the &%return_path%& option on a transport. The second of
33556 these is effective only if the message is successfully delivered to another
33557 host; it is not used for errors detected on the local host (see the description
33558 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33559 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33560 .code
33561 verp_smtp:
33562   driver = smtp
33563   max_rcpt = 1
33564   return_path = \
33565     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33566       {$1-request+$local_part=$domain@your.dom.example}fail}
33567 .endd
33568 This has the effect of rewriting the return path (envelope sender) on outgoing
33569 SMTP messages, if the local part of the original return path ends in
33570 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33571 local part and domain of the recipient into the return path. Suppose, for
33572 example, that a message whose return path has been set to
33573 &'somelist-request@your.dom.example'& is sent to
33574 &'subscriber@other.dom.example'&. In the transport, the return path is
33575 rewritten as
33576 .code
33577 somelist-request+subscriber=other.dom.example@your.dom.example
33578 .endd
33579 .vindex "&$local_part$&"
33580 For this to work, you must tell Exim to send multiple copies of messages that
33581 have more than one recipient, so that each copy has just one recipient. This is
33582 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33583 might be sent to several different recipients in the same domain, in which case
33584 &$local_part$& is not available in the transport, because it is not unique.
33585
33586 Unless your host is doing nothing but mailing list deliveries, you should
33587 probably use a separate transport for the VERP deliveries, so as not to use
33588 extra resources in making one-per-recipient copies for other deliveries. This
33589 can easily be done by expanding the &%transport%& option in the router:
33590 .code
33591 dnslookup:
33592   driver = dnslookup
33593   domains = ! +local_domains
33594   transport = \
33595     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33596       {verp_smtp}{remote_smtp}}
33597   no_more
33598 .endd
33599 If you want to change the return path using &%errors_to%& in a router instead
33600 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33601 routers that handle mailing list addresses. This will ensure that all delivery
33602 errors, including those detected on the local host, are sent to the VERP
33603 address.
33604
33605 On a host that does no local deliveries and has no manual routing, only the
33606 &(dnslookup)& router needs to be changed. A special transport is not needed for
33607 SMTP deliveries. Every mailing list recipient has its own return path value,
33608 and so Exim must hand them to the transport one at a time. Here is an example
33609 of a &(dnslookup)& router that implements VERP:
33610 .code
33611 verp_dnslookup:
33612   driver = dnslookup
33613   domains = ! +local_domains
33614   transport = remote_smtp
33615   errors_to = \
33616     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33617      {$1-request+$local_part=$domain@your.dom.example}fail}
33618   no_more
33619 .endd
33620 Before you start sending out messages with VERPed return paths, you must also
33621 configure Exim to accept the bounce messages that come back to those paths.
33622 Typically this is done by setting a &%local_part_suffix%& option for a
33623 router, and using this to route the messages to wherever you want to handle
33624 them.
33625
33626 The overhead incurred in using VERP depends very much on the size of the
33627 message, the number of recipient addresses that resolve to the same remote
33628 host, and the speed of the connection over which the message is being sent. If
33629 a lot of addresses resolve to the same host and the connection is slow, sending
33630 a separate copy of the message for each address may take substantially longer
33631 than sending a single copy with many recipients (for which VERP cannot be
33632 used).
33633
33634
33635
33636
33637
33638
33639 .section "Virtual domains" "SECTvirtualdomains"
33640 .cindex "virtual domains"
33641 .cindex "domain" "virtual"
33642 The phrase &'virtual domain'& is unfortunately used with two rather different
33643 meanings:
33644
33645 .ilist
33646 A domain for which there are no real mailboxes; all valid local parts are
33647 aliases for other email addresses. Common examples are organizational
33648 top-level domains and &"vanity"& domains.
33649 .next
33650 One of a number of independent domains that are all handled by the same host,
33651 with mailboxes on that host, but where the mailbox owners do not necessarily
33652 have login accounts on that host.
33653 .endlist
33654
33655 The first usage is probably more common, and does seem more &"virtual"& than
33656 the second. This kind of domain can be handled in Exim with a straightforward
33657 aliasing router. One approach is to create a separate alias file for each
33658 virtual domain. Exim can test for the existence of the alias file to determine
33659 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33660 to a router of this form:
33661 .code
33662 virtual:
33663   driver = redirect
33664   domains = dsearch;/etc/mail/virtual
33665   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33666   no_more
33667 .endd
33668 The &%domains%& option specifies that the router is to be skipped, unless there
33669 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33670 domain that is being processed. When the router runs, it looks up the local
33671 part in the file to find a new address (or list of addresses). The &%no_more%&
33672 setting ensures that if the lookup fails (leading to &%data%& being an empty
33673 string), Exim gives up on the address without trying any subsequent routers.
33674
33675 This one router can handle all the virtual domains because the alias file names
33676 follow a fixed pattern. Permissions can be arranged so that appropriate people
33677 can edit the different alias files. A successful aliasing operation results in
33678 a new envelope recipient address, which is then routed from scratch.
33679
33680 The other kind of &"virtual"& domain can also be handled in a straightforward
33681 way. One approach is to create a file for each domain containing a list of
33682 valid local parts, and use it in a router like this:
33683 .code
33684 my_domains:
33685   driver = accept
33686   domains = dsearch;/etc/mail/domains
33687   local_parts = lsearch;/etc/mail/domains/$domain
33688   transport = my_mailboxes
33689 .endd
33690 The address is accepted if there is a file for the domain, and the local part
33691 can be found in the file. The &%domains%& option is used to check for the
33692 file's existence because &%domains%& is tested before the &%local_parts%&
33693 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33694 because that option is tested after &%local_parts%&. The transport is as
33695 follows:
33696 .code
33697 my_mailboxes:
33698   driver = appendfile
33699   file = /var/mail/$domain/$local_part
33700   user = mail
33701 .endd
33702 This uses a directory of mailboxes for each domain. The &%user%& setting is
33703 required, to specify which uid is to be used for writing to the mailboxes.
33704
33705 The configuration shown here is just one example of how you might support this
33706 requirement. There are many other ways this kind of configuration can be set
33707 up, for example, by using a database instead of separate files to hold all the
33708 information about the domains.
33709
33710
33711
33712 .section "Multiple user mailboxes" "SECTmulbox"
33713 .cindex "multiple mailboxes"
33714 .cindex "mailbox" "multiple"
33715 .cindex "local part" "prefix"
33716 .cindex "local part" "suffix"
33717 Heavy email users often want to operate with multiple mailboxes, into which
33718 incoming mail is automatically sorted. A popular way of handling this is to
33719 allow users to use multiple sender addresses, so that replies can easily be
33720 identified. Users are permitted to add prefixes or suffixes to their local
33721 parts for this purpose. The wildcard facility of the generic router options
33722 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33723 example, consider this router:
33724 .code
33725 userforward:
33726   driver = redirect
33727   check_local_user
33728   file = $home/.forward
33729   local_part_suffix = -*
33730   local_part_suffix_optional
33731   allow_filter
33732 .endd
33733 .vindex "&$local_part_suffix$&"
33734 It runs a user's &_.forward_& file for all local parts of the form
33735 &'username-*'&. Within the filter file the user can distinguish different
33736 cases by testing the variable &$local_part_suffix$&. For example:
33737 .code
33738 if $local_part_suffix contains -special then
33739 save /home/$local_part/Mail/special
33740 endif
33741 .endd
33742 If the filter file does not exist, or does not deal with such addresses, they
33743 fall through to subsequent routers, and, assuming no subsequent use of the
33744 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33745 control over which suffixes are valid.
33746
33747 Alternatively, a suffix can be used to trigger the use of a different
33748 &_.forward_& file &-- which is the way a similar facility is implemented in
33749 another MTA:
33750 .code
33751 userforward:
33752   driver = redirect
33753   check_local_user
33754   file = $home/.forward$local_part_suffix
33755   local_part_suffix = -*
33756   local_part_suffix_optional
33757   allow_filter
33758 .endd
33759 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33760 example, &_.forward-special_& is used. Once again, if the appropriate file
33761 does not exist, or does not deal with the address, it is passed on to
33762 subsequent routers, which could, if required, look for an unqualified
33763 &_.forward_& file to use as a default.
33764
33765
33766
33767 .section "Simplified vacation processing" "SECID244"
33768 .cindex "vacation processing"
33769 The traditional way of running the &'vacation'& program is for a user to set up
33770 a pipe command in a &_.forward_& file
33771 (see section &<<SECTspecitredli>>& for syntax details).
33772 This is prone to error by inexperienced users. There are two features of Exim
33773 that can be used to make this process simpler for users:
33774
33775 .ilist
33776 A local part prefix such as &"vacation-"& can be specified on a router which
33777 can cause the message to be delivered directly to the &'vacation'& program, or
33778 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33779 &_.forward_& file are then much simpler. For example:
33780 .code
33781 spqr, vacation-spqr
33782 .endd
33783 .next
33784 The &%require_files%& generic router option can be used to trigger a
33785 vacation delivery by checking for the existence of a certain file in the
33786 user's home directory. The &%unseen%& generic option should also be used, to
33787 ensure that the original delivery also proceeds. In this case, all the user has
33788 to do is to create a file called, say, &_.vacation_&, containing a vacation
33789 message.
33790 .endlist
33791
33792 Another advantage of both these methods is that they both work even when the
33793 use of arbitrary pipes by users is locked out.
33794
33795
33796
33797 .section "Taking copies of mail" "SECID245"
33798 .cindex "message" "copying every"
33799 Some installations have policies that require archive copies of all messages to
33800 be made. A single copy of each message can easily be taken by an appropriate
33801 command in a system filter, which could, for example, use a different file for
33802 each day's messages.
33803
33804 There is also a shadow transport mechanism that can be used to take copies of
33805 messages that are successfully delivered by local transports, one copy per
33806 delivery. This could be used, &'inter alia'&, to implement automatic
33807 notification of delivery by sites that insist on doing such things.
33808
33809
33810
33811 .section "Intermittently connected hosts" "SECID246"
33812 .cindex "intermittently connected hosts"
33813 It has become quite common (because it is cheaper) for hosts to connect to the
33814 Internet periodically rather than remain connected all the time. The normal
33815 arrangement is that mail for such hosts accumulates on a system that is
33816 permanently connected.
33817
33818 Exim was designed for use on permanently connected hosts, and so it is not
33819 particularly well-suited to use in an intermittently connected environment.
33820 Nevertheless there are some features that can be used.
33821
33822
33823 .section "Exim on the upstream server host" "SECID247"
33824 It is tempting to arrange for incoming mail for the intermittently connected
33825 host to remain on Exim's queue until the client connects. However, this
33826 approach does not scale very well. Two different kinds of waiting message are
33827 being mixed up in the same queue &-- those that cannot be delivered because of
33828 some temporary problem, and those that are waiting for their destination host
33829 to connect. This makes it hard to manage the queue, as well as wasting
33830 resources, because each queue runner scans the entire queue.
33831
33832 A better approach is to separate off those messages that are waiting for an
33833 intermittently connected host. This can be done by delivering these messages
33834 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33835 format, from where they are transmitted by other software when their
33836 destination connects. This makes it easy to collect all the mail for one host
33837 in a single directory, and to apply local timeout rules on a per-message basis
33838 if required.
33839
33840 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33841 you are doing this, you should configure Exim with a long retry period for the
33842 intermittent host. For example:
33843 .code
33844 cheshire.wonderland.fict.example    *   F,5d,24h
33845 .endd
33846 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33847 which messages it has queued up for that host. Once the intermittent host comes
33848 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33849 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33850 causes all the queued up messages to be delivered, often down a single SMTP
33851 connection. While the host remains connected, any new messages get delivered
33852 immediately.
33853
33854 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33855 issued with a different IP address each time it connects, Exim's retry
33856 mechanisms on the holding host get confused, because the IP address is normally
33857 used as part of the key string for holding retry information. This can be
33858 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33859 Since this has disadvantages for permanently connected hosts, it is best to
33860 arrange a separate transport for the intermittently connected ones.
33861
33862
33863
33864 .section "Exim on the intermittently connected client host" "SECID248"
33865 The value of &%smtp_accept_queue_per_connection%& should probably be
33866 increased, or even set to zero (that is, disabled) on the intermittently
33867 connected host, so that all incoming messages down a single connection get
33868 delivered immediately.
33869
33870 .cindex "SMTP" "passed connection"
33871 .cindex "SMTP" "multiple deliveries"
33872 .cindex "multiple SMTP deliveries"
33873 Mail waiting to be sent from an intermittently connected host will probably
33874 not have been routed, because without a connection DNS lookups are not
33875 possible. This means that if a normal queue run is done at connection time,
33876 each message is likely to be sent in a separate SMTP session. This can be
33877 avoided by starting the queue run with a command line option beginning with
33878 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
33879 first pass, routing is done but no deliveries take place. The second pass is a
33880 normal queue run; since all the messages have been previously routed, those
33881 destined for the same host are likely to get sent as multiple deliveries in a
33882 single SMTP connection.
33883
33884
33885
33886 . ////////////////////////////////////////////////////////////////////////////
33887 . ////////////////////////////////////////////////////////////////////////////
33888
33889 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
33890          "Exim as a non-queueing client"
33891 .cindex "client, non-queueing"
33892 .cindex "smart host" "suppressing queueing"
33893 On a personal computer, it is a common requirement for all
33894 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
33895 configured to operate that way, for all the popular operating systems.
33896 However, there are some MUAs for Unix-like systems that cannot be so
33897 configured: they submit messages using the command line interface of
33898 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
33899 messages this way.
33900
33901 If the personal computer runs continuously, there is no problem, because it can
33902 run a conventional MTA that handles delivery to the smart host, and deal with
33903 any delays via its queueing mechanism. However, if the computer does not run
33904 continuously or runs different operating systems at different times, queueing
33905 email is not desirable.
33906
33907 There is therefore a requirement for something that can provide the
33908 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
33909 any queueing or retrying facilities. Furthermore, the delivery to the smart
33910 host should be synchronous, so that if it fails, the sending MUA is immediately
33911 informed. In other words, we want something that extends an MUA that submits
33912 to a local MTA via the command line so that it behaves like one that submits
33913 to a remote smart host using TCP/SMTP.
33914
33915 There are a number of applications (for example, there is one called &'ssmtp'&)
33916 that do this job. However, people have found them to be lacking in various
33917 ways. For instance, you might want to allow aliasing and forwarding to be done
33918 before sending a message to the smart host.
33919
33920 Exim already had the necessary infrastructure for doing this job. Just a few
33921 tweaks were needed to make it behave as required, though it is somewhat of an
33922 overkill to use a fully-featured MTA for this purpose.
33923
33924 .oindex "&%mua_wrapper%&"
33925 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
33926 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
33927 assumes that it is being used to &"wrap"& a command-line MUA in the manner
33928 just described. As well as setting &%mua_wrapper%&, you also need to provide a
33929 compatible router and transport configuration. Typically there will be just one
33930 router and one transport, sending everything to a smart host.
33931
33932 When run in MUA wrapping mode, the behaviour of Exim changes in the
33933 following ways:
33934
33935 .ilist
33936 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
33937 In other words, the only way to submit messages is via the command line.
33938 .next
33939 Each message is synchronously delivered as soon as it is received (&%-odi%& is
33940 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
33941 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
33942 does not finish until the delivery attempt is complete. If the delivery is
33943 successful, a zero return code is given.
33944 .next
33945 Address redirection is permitted, but the final routing for all addresses must
33946 be to the same remote transport, and to the same list of hosts. Furthermore,
33947 the return address (envelope sender) must be the same for all recipients, as
33948 must any added or deleted header lines. In other words, it must be possible to
33949 deliver the message in a single SMTP transaction, however many recipients there
33950 are.
33951 .next
33952 If these conditions are not met, or if routing any address results in a
33953 failure or defer status, or if Exim is unable to deliver all the recipients
33954 successfully to one of the smart hosts, delivery of the entire message fails.
33955 .next
33956 Because no queueing is allowed, all failures are treated as permanent; there
33957 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
33958 smart host. Furthermore, because only a single yes/no response can be given to
33959 the caller, it is not possible to deliver to some recipients and not others. If
33960 there is an error (temporary or permanent) for any recipient, all are failed.
33961 .next
33962 If more than one smart host is listed, Exim will try another host after a
33963 connection failure or a timeout, in the normal way. However, if this kind of
33964 failure happens for all the hosts, the delivery fails.
33965 .next
33966 When delivery fails, an error message is written to the standard error stream
33967 (as well as to Exim's log), and Exim exits to the caller with a return code
33968 value 1. The message is expunged from Exim's spool files. No bounce messages
33969 are ever generated.
33970 .next
33971 No retry data is maintained, and any retry rules are ignored.
33972 .next
33973 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
33974 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
33975 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
33976 .endlist
33977
33978 The overall effect is that Exim makes a single synchronous attempt to deliver
33979 the message, failing if there is any kind of problem. Because no local
33980 deliveries are done and no daemon can be run, Exim does not need root
33981 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
33982 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
33983 the advantages and disadvantages of running without root privilege.
33984
33985
33986
33987
33988 . ////////////////////////////////////////////////////////////////////////////
33989 . ////////////////////////////////////////////////////////////////////////////
33990
33991 .chapter "Log files" "CHAPlog"
33992 .scindex IIDloggen "log" "general description"
33993 .cindex "log" "types of"
33994 Exim writes three different logs, referred to as the main log, the reject log,
33995 and the panic log:
33996
33997 .ilist
33998 .cindex "main log"
33999 The main log records the arrival of each message and each delivery in a single
34000 line in each case. The format is as compact as possible, in an attempt to keep
34001 down the size of log files. Two-character flag sequences make it easy to pick
34002 out these lines. A number of other events are recorded in the main log. Some of
34003 them are optional, in which case the &%log_selector%& option controls whether
34004 they are included or not. A Perl script called &'eximstats'&, which does simple
34005 analysis of main log files, is provided in the Exim distribution (see section
34006 &<<SECTmailstat>>&).
34007 .next
34008 .cindex "reject log"
34009 The reject log records information from messages that are rejected as a result
34010 of a configuration option (that is, for policy reasons).
34011 The first line of each rejection is a copy of the line that is also written to
34012 the main log. Then, if the message's header has been read at the time the log
34013 is written, its contents are written to this log. Only the original header
34014 lines are available; header lines added by ACLs are not logged. You can use the
34015 reject log to check that your policy controls are working correctly; on a busy
34016 host this may be easier than scanning the main log for rejection messages. You
34017 can suppress the writing of the reject log by setting &%write_rejectlog%&
34018 false.
34019 .next
34020 .cindex "panic log"
34021 .cindex "system log"
34022 When certain serious errors occur, Exim writes entries to its panic log. If the
34023 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34024 are usually written to the main log as well, but can get lost amid the mass of
34025 other entries. The panic log should be empty under normal circumstances. It is
34026 therefore a good idea to check it (or to have a &'cron'& script check it)
34027 regularly, in order to become aware of any problems. When Exim cannot open its
34028 panic log, it tries as a last resort to write to the system log (syslog). This
34029 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34030 message itself is written at priority LOG_CRIT.
34031 .endlist
34032
34033 Every log line starts with a timestamp, in the format shown in the following
34034 example. Note that many of the examples shown in this chapter are line-wrapped.
34035 In the log file, this would be all on one line:
34036 .code
34037 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34038   by QUIT
34039 .endd
34040 By default, the timestamps are in the local timezone. There are two
34041 ways of changing this:
34042
34043 .ilist
34044 You can set the &%timezone%& option to a different time zone; in particular, if
34045 you set
34046 .code
34047 timezone = UTC
34048 .endd
34049 the timestamps will be in UTC (aka GMT).
34050 .next
34051 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34052 example:
34053 .code
34054 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34055 .endd
34056 .endlist
34057
34058 .cindex "log" "process ids in"
34059 .cindex "pid (process id)" "in log lines"
34060 Exim does not include its process id in log lines by default, but you can
34061 request that it does so by specifying the &`pid`& log selector (see section
34062 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34063 brackets, immediately after the time and date.
34064
34065
34066
34067
34068 .section "Where the logs are written" "SECTwhelogwri"
34069 .cindex "log" "destination"
34070 .cindex "log" "to file"
34071 .cindex "log" "to syslog"
34072 .cindex "syslog"
34073 The logs may be written to local files, or to syslog, or both. However, it
34074 should be noted that many syslog implementations use UDP as a transport, and
34075 are therefore unreliable in the sense that messages are not guaranteed to
34076 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34077 It has also been reported that on large log files (tens of megabytes) you may
34078 need to tweak syslog to prevent it syncing the file with each write &-- on
34079 Linux this has been seen to make syslog take 90% plus of CPU time.
34080
34081 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34082 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34083 configuration. This latter string is expanded, so it can contain, for example,
34084 references to the host name:
34085 .code
34086 log_file_path = /var/log/$primary_hostname/exim_%slog
34087 .endd
34088 It is generally advisable, however, to set the string in &_Local/Makefile_&
34089 rather than at run time, because then the setting is available right from the
34090 start of Exim's execution. Otherwise, if there's something it wants to log
34091 before it has read the configuration file (for example, an error in the
34092 configuration file) it will not use the path you want, and may not be able to
34093 log at all.
34094
34095 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34096 list, currently limited to at most two items. This is one option where the
34097 facility for changing a list separator may not be used. The list must always be
34098 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34099 otherwise the item must either be an absolute path, containing &`%s`& at the
34100 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34101 implying the use of a default path.
34102
34103 When Exim encounters an empty item in the list, it searches the list defined by
34104 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34105 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34106 mean &"use the path specified at build time"&. It no such item exists, log
34107 files are written in the &_log_& subdirectory of the spool directory. This is
34108 equivalent to the setting:
34109 .code
34110 log_file_path = $spool_directory/log/%slog
34111 .endd
34112 If you do not specify anything at build time or run time, that is where the
34113 logs are written.
34114
34115 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34116 are in use &-- see section &<<SECTdatlogfil>>& below.
34117
34118 Here are some examples of possible settings:
34119 .display
34120 &`LOG_FILE_PATH=syslog                    `& syslog only
34121 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34122 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34123 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34124 .endd
34125 If there are more than two paths in the list, the first is used and a panic
34126 error is logged.
34127
34128
34129
34130 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34131 .cindex "log" "cycling local files"
34132 .cindex "cycling logs"
34133 .cindex "&'exicyclog'&"
34134 .cindex "log" "local files; writing to"
34135 Some operating systems provide centralized and standardized methods for cycling
34136 log files. For those that do not, a utility script called &'exicyclog'& is
34137 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34138 main and reject logs each time it is called. The maximum number of old logs to
34139 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34140
34141 An Exim delivery process opens the main log when it first needs to write to it,
34142 and it keeps the file open in case subsequent entries are required &-- for
34143 example, if a number of different deliveries are being done for the same
34144 message. However, remote SMTP deliveries can take a long time, and this means
34145 that the file may be kept open long after it is renamed if &'exicyclog'& or
34146 something similar is being used to rename log files on a regular basis. To
34147 ensure that a switch of log files is noticed as soon as possible, Exim calls
34148 &[stat()]& on the main log's name before reusing an open file, and if the file
34149 does not exist, or its inode has changed, the old file is closed and Exim
34150 tries to open the main log from scratch. Thus, an old log file may remain open
34151 for quite some time, but no Exim processes should write to it once it has been
34152 renamed.
34153
34154
34155
34156 .section "Datestamped log files" "SECTdatlogfil"
34157 .cindex "log" "datestamped files"
34158 Instead of cycling the main and reject log files by renaming them
34159 periodically, some sites like to use files whose names contain a datestamp,
34160 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34161 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34162 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34163 point where the datestamp is required. For example:
34164 .code
34165 log_file_path = /var/spool/exim/log/%slog-%D
34166 log_file_path = /var/log/exim-%s-%D.log
34167 log_file_path = /var/spool/exim/log/%D-%slog
34168 log_file_path = /var/log/exim/%s.%M
34169 .endd
34170 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34171 examples of names generated by the above examples:
34172 .code
34173 /var/spool/exim/log/mainlog-20021225
34174 /var/log/exim-reject-20021225.log
34175 /var/spool/exim/log/20021225-mainlog
34176 /var/log/exim/main.200212
34177 .endd
34178 When this form of log file is specified, Exim automatically switches to new
34179 files at midnight. It does not make any attempt to compress old logs; you
34180 will need to write your own script if you require this. You should not
34181 run &'exicyclog'& with this form of logging.
34182
34183 The location of the panic log is also determined by &%log_file_path%&, but it
34184 is not datestamped, because rotation of the panic log does not make sense.
34185 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34186 the string. In addition, if it immediately follows a slash, a following
34187 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34188 character is removed. Thus, the four examples above would give these panic
34189 log names:
34190 .code
34191 /var/spool/exim/log/paniclog
34192 /var/log/exim-panic.log
34193 /var/spool/exim/log/paniclog
34194 /var/log/exim/panic
34195 .endd
34196
34197
34198 .section "Logging to syslog" "SECID249"
34199 .cindex "log" "syslog; writing to"
34200 The use of syslog does not change what Exim logs or the format of its messages,
34201 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34202 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34203 that, the same strings are written to syslog as to log files. The syslog
34204 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34205 by default, but you can change these by setting the &%syslog_facility%& and
34206 &%syslog_processname%& options, respectively. If Exim was compiled with
34207 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34208 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34209 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34210 the time and host name to each line.
34211 The three log streams are mapped onto syslog priorities as follows:
34212
34213 .ilist
34214 &'mainlog'& is mapped to LOG_INFO
34215 .next
34216 &'rejectlog'& is mapped to LOG_NOTICE
34217 .next
34218 &'paniclog'& is mapped to LOG_ALERT
34219 .endlist
34220
34221 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34222 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34223 these are routed by syslog to the same place. You can suppress this duplication
34224 by setting &%syslog_duplication%& false.
34225
34226 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34227 entries contain multiple lines when headers are included. To cope with both
34228 these cases, entries written to syslog are split into separate &[syslog()]&
34229 calls at each internal newline, and also after a maximum of
34230 870 data characters. (This allows for a total syslog line length of 1024, when
34231 additions such as timestamps are added.) If you are running a syslog
34232 replacement that can handle lines longer than the 1024 characters allowed by
34233 RFC 3164, you should set
34234 .code
34235 SYSLOG_LONG_LINES=yes
34236 .endd
34237 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34238 lines, but it still splits at internal newlines in &'reject'& log entries.
34239
34240 To make it easy to re-assemble split lines later, each component of a split
34241 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34242 where <&'n'&> is the component number and <&'m'&> is the total number of
34243 components in the entry. The / delimiter is used when the line was split
34244 because it was too long; if it was split because of an internal newline, the \
34245 delimiter is used. For example, supposing the length limit to be 50 instead of
34246 870, the following would be the result of a typical rejection message to
34247 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34248 name, and pid as added by syslog:
34249 .code
34250 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34251 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34252 [3/5]  when scanning for sender: missing or malformed lo
34253 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34254 [5/5] mple>)
34255 .endd
34256 The same error might cause the following lines to be written to &"rejectlog"&
34257 (LOG_NOTICE):
34258 .code
34259 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34260 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34261 [3/18] er when scanning for sender: missing or malformed
34262 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34263 [5\18] .example>)
34264 [6\18] Recipients: ph10@some.domain.cam.example
34265 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34266 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34267 [9\18]        id 16RdAL-0006pc-00
34268 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34269 [11\18] 09:43 +0100
34270 [12\18] F From: <>
34271 [13\18]   Subject: this is a test header
34272 [18\18]   X-something: this is another header
34273 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34274 [16\18] le>
34275 [17\18] B Bcc:
34276 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34277 .endd
34278 Log lines that are neither too long nor contain newlines are written to syslog
34279 without modification.
34280
34281 If only syslog is being used, the Exim monitor is unable to provide a log tail
34282 display, unless syslog is routing &'mainlog'& to a file on the local host and
34283 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34284 where it is.
34285
34286
34287
34288 .section "Log line flags" "SECID250"
34289 One line is written to the main log for each message received, and for each
34290 successful, unsuccessful, and delayed delivery. These lines can readily be
34291 picked out by the distinctive two-character flags that immediately follow the
34292 timestamp. The flags are:
34293 .display
34294 &`<=`&     message arrival
34295 &`=>`&     normal message delivery
34296 &`->`&     additional address in same delivery
34297 &`>>`&     cutthrough message delivery
34298 &`*>`&     delivery suppressed by &%-N%&
34299 &`**`&     delivery failed; address bounced
34300 &`==`&     delivery deferred; temporary problem
34301 .endd
34302
34303
34304 .section "Logging message reception" "SECID251"
34305 .cindex "log" "reception line"
34306 The format of the single-line entry in the main log that is written for every
34307 message received is shown in the basic example below, which is split over
34308 several lines in order to fit it on the page:
34309 .code
34310 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34311   H=mailer.fict.example [192.168.123.123] U=exim
34312   P=smtp S=5678 id=<incoming message id>
34313 .endd
34314 The address immediately following &"<="& is the envelope sender address. A
34315 bounce message is shown with the sender address &"<>"&, and if it is locally
34316 generated, this is followed by an item of the form
34317 .code
34318 R=<message id>
34319 .endd
34320 which is a reference to the message that caused the bounce to be sent.
34321
34322 .cindex "HELO"
34323 .cindex "EHLO"
34324 For messages from other hosts, the H and U fields identify the remote host and
34325 record the RFC 1413 identity of the user that sent the message, if one was
34326 received. The number given in square brackets is the IP address of the sending
34327 host. If there is a single, unparenthesized  host name in the H field, as
34328 above, it has been verified to correspond to the IP address (see the
34329 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34330 by the remote host in the SMTP HELO or EHLO command, and has not been
34331 verified. If verification yields a different name to that given for HELO or
34332 EHLO, the verified name appears first, followed by the HELO or EHLO
34333 name in parentheses.
34334
34335 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34336 without brackets, in the HELO or EHLO command, leading to entries in
34337 the log containing text like these examples:
34338 .code
34339 H=(10.21.32.43) [192.168.8.34]
34340 H=([10.21.32.43]) [192.168.8.34]
34341 .endd
34342 This can be confusing. Only the final address in square brackets can be relied
34343 on.
34344
34345 For locally generated messages (that is, messages not received over TCP/IP),
34346 the H field is omitted, and the U field contains the login name of the caller
34347 of Exim.
34348
34349 .cindex "authentication" "logging"
34350 .cindex "AUTH" "logging"
34351 For all messages, the P field specifies the protocol used to receive the
34352 message. This is the value that is stored in &$received_protocol$&. In the case
34353 of incoming SMTP messages, the value indicates whether or not any SMTP
34354 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34355 session was encrypted, there is an additional X field that records the cipher
34356 suite that was used.
34357
34358 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34359 hosts that have authenticated themselves using the SMTP AUTH command. The first
34360 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34361 there is an additional item A= followed by the name of the authenticator that
34362 was used. If an authenticated identification was set up by the authenticator's
34363 &%server_set_id%& option, this is logged too, separated by a colon from the
34364 authenticator name.
34365
34366 .cindex "size" "of message"
34367 The id field records the existing message id, if present. The size of the
34368 received message is given by the S field. When the message is delivered,
34369 headers may be removed or added, so that the size of delivered copies of the
34370 message may not correspond with this value (and indeed may be different to each
34371 other).
34372
34373 The &%log_selector%& option can be used to request the logging of additional
34374 data when a message is received. See section &<<SECTlogselector>>& below.
34375
34376
34377
34378 .section "Logging deliveries" "SECID252"
34379 .cindex "log" "delivery line"
34380 The format of the single-line entry in the main log that is written for every
34381 delivery is shown in one of the examples below, for local and remote
34382 deliveries, respectively. Each example has been split into two lines in order
34383 to fit it on the page:
34384 .code
34385 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34386   <marv@hitch.fict.example> R=localuser T=local_delivery
34387 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34388   monk@holistic.fict.example R=dnslookup T=remote_smtp
34389   H=holistic.fict.example [192.168.234.234]
34390 .endd
34391 For ordinary local deliveries, the original address is given in angle brackets
34392 after the final delivery address, which might be a pipe or a file. If
34393 intermediate address(es) exist between the original and the final address, the
34394 last of these is given in parentheses after the final address. The R and T
34395 fields record the router and transport that were used to process the address.
34396
34397 If SMTP AUTH was used for the delivery there is an additional item A=
34398 followed by the name of the authenticator that was used.
34399 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34400 option, this is logged too, separated by a colon from the authenticator name.
34401
34402 If a shadow transport was run after a successful local delivery, the log line
34403 for the successful delivery has an item added on the end, of the form
34404 .display
34405 &`ST=<`&&'shadow transport name'&&`>`&
34406 .endd
34407 If the shadow transport did not succeed, the error message is put in
34408 parentheses afterwards.
34409
34410 .cindex "asterisk" "after IP address"
34411 When more than one address is included in a single delivery (for example, two
34412 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34413 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34414 down a single SMTP connection, an asterisk follows the IP address in the log
34415 lines for the second and subsequent messages.
34416
34417 .cindex "delivery" "cutthrough; logging"
34418 .cindex "cutthrough" "logging"
34419 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34420 line precedes the reception line, since cutthrough waits for a possible
34421 rejection from the destination in case it can reject the sourced item.
34422
34423 The generation of a reply message by a filter file gets logged as a
34424 &"delivery"& to the addressee, preceded by &">"&.
34425
34426 The &%log_selector%& option can be used to request the logging of additional
34427 data when a message is delivered. See section &<<SECTlogselector>>& below.
34428
34429
34430 .section "Discarded deliveries" "SECID253"
34431 .cindex "discarded messages"
34432 .cindex "message" "discarded"
34433 .cindex "delivery" "discarded; logging"
34434 When a message is discarded as a result of the command &"seen finish"& being
34435 obeyed in a filter file which generates no deliveries, a log entry of the form
34436 .code
34437 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34438   <low.club@bridge.example> R=userforward
34439 .endd
34440 is written, to record why no deliveries are logged. When a message is discarded
34441 because it is aliased to &":blackhole:"& the log line is like this:
34442 .code
34443 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34444   <hole@nowhere.example> R=blackhole_router
34445 .endd
34446
34447
34448 .section "Deferred deliveries" "SECID254"
34449 When a delivery is deferred, a line of the following form is logged:
34450 .code
34451 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34452   R=dnslookup T=smtp defer (146): Connection refused
34453 .endd
34454 In the case of remote deliveries, the error is the one that was given for the
34455 last IP address that was tried. Details of individual SMTP failures are also
34456 written to the log, so the above line would be preceded by something like
34457 .code
34458 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34459   mail1.endrest.example [192.168.239.239]: Connection refused
34460 .endd
34461 When a deferred address is skipped because its retry time has not been reached,
34462 a message is written to the log, but this can be suppressed by setting an
34463 appropriate value in &%log_selector%&.
34464
34465
34466
34467 .section "Delivery failures" "SECID255"
34468 .cindex "delivery" "failure; logging"
34469 If a delivery fails because an address cannot be routed, a line of the
34470 following form is logged:
34471 .code
34472 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34473   <jim@trek99.example>: unknown mail domain
34474 .endd
34475 If a delivery fails at transport time, the router and transport are shown, and
34476 the response from the remote host is included, as in this example:
34477 .code
34478 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34479   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34480   after pipelined RCPT TO:<ace400@pb.example>: host
34481   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34482   <ace400@pb.example>...Addressee unknown
34483 .endd
34484 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34485 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34486 disabling PIPELINING. The log lines for all forms of delivery failure are
34487 flagged with &`**`&.
34488
34489
34490
34491 .section "Fake deliveries" "SECID256"
34492 .cindex "delivery" "fake; logging"
34493 If a delivery does not actually take place because the &%-N%& option has been
34494 used to suppress it, a normal delivery line is written to the log, except that
34495 &"=>"& is replaced by &"*>"&.
34496
34497
34498
34499 .section "Completion" "SECID257"
34500 A line of the form
34501 .code
34502 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34503 .endd
34504 is written to the main log when a message is about to be removed from the spool
34505 at the end of its processing.
34506
34507
34508
34509
34510 .section "Summary of Fields in Log Lines" "SECID258"
34511 .cindex "log" "summary of fields"
34512 A summary of the field identifiers that are used in log lines is shown in
34513 the following table:
34514 .display
34515 &`A   `&        authenticator name (and optional id and sender)
34516 &`C   `&        SMTP confirmation on delivery
34517 &`    `&        command list for &"no mail in SMTP session"&
34518 &`CV  `&        certificate verification status
34519 &`D   `&        duration of &"no mail in SMTP session"&
34520 &`DN  `&        distinguished name from peer certificate
34521 &`DT  `&        on &`=>`& lines: time taken for a delivery
34522 &`F   `&        sender address (on delivery lines)
34523 &`H   `&        host name and IP address
34524 &`I   `&        local interface used
34525 &`id  `&        message id for incoming message
34526 &`P   `&        on &`<=`& lines: protocol used
34527 &`    `&        on &`=>`& and &`**`& lines: return path
34528 &`QT  `&        on &`=>`& lines: time spent on queue so far
34529 &`    `&        on &"Completed"& lines: time spent on queue
34530 &`R   `&        on &`<=`& lines: reference for local bounce
34531 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34532 &`S   `&        size of message
34533 &`SNI `&        server name indication from TLS client hello
34534 &`ST  `&        shadow transport name
34535 &`T   `&        on &`<=`& lines: message subject (topic)
34536 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34537 &`U   `&        local user or RFC 1413 identity
34538 &`X   `&        TLS cipher suite
34539 .endd
34540
34541
34542 .section "Other log entries" "SECID259"
34543 Various other types of log entry are written from time to time. Most should be
34544 self-explanatory. Among the more common are:
34545
34546 .ilist
34547 .cindex "retry" "time not reached"
34548 &'retry time not reached'&&~&~An address previously suffered a temporary error
34549 during routing or local delivery, and the time to retry has not yet arrived.
34550 This message is not written to an individual message log file unless it happens
34551 during the first delivery attempt.
34552 .next
34553 &'retry time not reached for any host'&&~&~An address previously suffered
34554 temporary errors during remote delivery, and the retry time has not yet arrived
34555 for any of the hosts to which it is routed.
34556 .next
34557 .cindex "spool directory" "file locked"
34558 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34559 some other Exim process is already working on the message. This can be quite
34560 common if queue running processes are started at frequent intervals. The
34561 &'exiwhat'& utility script can be used to find out what Exim processes are
34562 doing.
34563 .next
34564 .cindex "error" "ignored"
34565 &'error ignored'&&~&~There are several circumstances that give rise to this
34566 message:
34567 .olist
34568 Exim failed to deliver a bounce message whose age was greater than
34569 &%ignore_bounce_errors_after%&. The bounce was discarded.
34570 .next
34571 A filter file set up a delivery using the &"noerror"& option, and the delivery
34572 failed. The delivery was discarded.
34573 .next
34574 A delivery set up by a router configured with
34575 . ==== As this is a nested list, any displays it contains must be indented
34576 . ==== as otherwise they are too far to the left.
34577 .code
34578     errors_to = <>
34579 .endd
34580 failed. The delivery was discarded.
34581 .endlist olist
34582 .endlist ilist
34583
34584
34585
34586
34587
34588 .section "Reducing or increasing what is logged" "SECTlogselector"
34589 .cindex "log" "selectors"
34590 By setting the &%log_selector%& global option, you can disable some of Exim's
34591 default logging, or you can request additional logging. The value of
34592 &%log_selector%& is made up of names preceded by plus or minus characters. For
34593 example:
34594 .code
34595 log_selector = +arguments -retry_defer
34596 .endd
34597 The list of optional log items is in the following table, with the default
34598 selection marked by asterisks:
34599 .display
34600 &` 8bitmime                   `&  received 8BITMIME status
34601 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34602 &` address_rewrite            `&  address rewriting
34603 &` all_parents                `&  all parents in => lines
34604 &` arguments                  `&  command line arguments
34605 &`*connection_reject          `&  connection rejections
34606 &`*delay_delivery             `&  immediate delivery delayed
34607 &` deliver_time               `&  time taken to perform delivery
34608 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34609 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34610 &`*etrn                       `&  ETRN commands
34611 &`*host_lookup_failed         `&  as it says
34612 &` ident_timeout              `&  timeout for ident connection
34613 &` incoming_interface         `&  incoming interface on <= lines
34614 &` incoming_port              `&  incoming port on <= lines
34615 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34616 &` outgoing_port              `&  add remote port to => lines
34617 &`*queue_run                  `&  start and end queue runs
34618 &` queue_time                 `&  time on queue for one recipient
34619 &` queue_time_overall         `&  time on queue for whole message
34620 &` pid                        `&  Exim process id
34621 &` received_recipients        `&  recipients on <= lines
34622 &` received_sender            `&  sender on <= lines
34623 &`*rejected_header            `&  header contents on reject log
34624 &`*retry_defer                `&  &"retry time not reached"&
34625 &` return_path_on_delivery    `&  put return path on => and ** lines
34626 &` sender_on_delivery         `&  add sender to => lines
34627 &`*sender_verify_fail         `&  sender verification failures
34628 &`*size_reject                `&  rejection because too big
34629 &`*skip_delivery              `&  delivery skipped in a queue run
34630 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34631 &` smtp_connection            `&  SMTP connections
34632 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34633 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34634 &` smtp_no_mail               `&  session with no MAIL commands
34635 &` smtp_protocol_error        `&  SMTP protocol errors
34636 &` smtp_syntax_error          `&  SMTP syntax errors
34637 &` subject                    `&  contents of &'Subject:'& on <= lines
34638 &` tls_certificate_verified   `&  certificate verification status
34639 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34640 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34641 &` tls_sni                    `&  TLS SNI on <= lines
34642 &` unknown_in_list            `&  DNS lookup failed in list match
34643
34644 &` all                        `&  all of the above
34645 .endd
34646 More details on each of these items follows:
34647
34648 .ilist
34649 .cindex "8BITMIME"
34650 .cindex "log" "8BITMIME"
34651 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34652 which may help in tracking down interoperability issues with ancient MTAs
34653 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34654 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34655 &`7BIT`& and &`8BITMIME`& respectively.
34656 .next
34657 .cindex "&%warn%& ACL verb" "log when skipping"
34658 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34659 its conditions cannot be evaluated, a log line to this effect is written if
34660 this log selector is set.
34661 .next
34662 .cindex "log" "rewriting"
34663 .cindex "rewriting" "logging"
34664 &%address_rewrite%&: This applies both to global rewrites and per-transport
34665 rewrites, but not to rewrites in filters run as an unprivileged user (because
34666 such users cannot access the log).
34667 .next
34668 .cindex "log" "full parentage"
34669 &%all_parents%&: Normally only the original and final addresses are logged on
34670 delivery lines; with this selector, intermediate parents are given in
34671 parentheses between them.
34672 .next
34673 .cindex "log" "Exim arguments"
34674 .cindex "Exim arguments, logging"
34675 &%arguments%&: This causes Exim to write the arguments with which it was called
34676 to the main log, preceded by the current working directory. This is a debugging
34677 feature, added to make it easier to find out how certain MUAs call
34678 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34679 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34680 that are empty or that contain white space are quoted. Non-printing characters
34681 are shown as escape sequences. This facility cannot log unrecognized arguments,
34682 because the arguments are checked before the configuration file is read. The
34683 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34684 between the caller and Exim.
34685 .next
34686 .cindex "log" "connection rejections"
34687 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34688 connection is rejected, for whatever reason.
34689 .next
34690 .cindex "log" "delayed delivery"
34691 .cindex "delayed delivery, logging"
34692 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34693 started for an incoming message because the load is too high or too many
34694 messages were received on one connection. Logging does not occur if no delivery
34695 process is started because &%queue_only%& is set or &%-odq%& was used.
34696 .next
34697 .cindex "log" "delivery duration"
34698 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34699 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34700 .next
34701 .cindex "log" "message size on delivery"
34702 .cindex "size" "of message"
34703 &%delivery_size%&: For each delivery, the size of message delivered is added to
34704 the &"=>"& line, tagged with S=.
34705 .next
34706 .cindex "log" "dnslist defer"
34707 .cindex "DNS list" "logging defer"
34708 .cindex "black list (DNS)"
34709 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34710 DNS black list suffers a temporary error.
34711 .next
34712 .cindex "log" "ETRN commands"
34713 .cindex "ETRN" "logging"
34714 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34715 is run to determine whether or not it is actually accepted. An invalid ETRN
34716 command, or one received within a message transaction is not logged by this
34717 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34718 .next
34719 .cindex "log" "host lookup failure"
34720 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34721 any addresses, or when a lookup of an IP address fails to find a host name, a
34722 log line is written. This logging does not apply to direct DNS lookups when
34723 routing email addresses, but it does apply to &"byname"& lookups.
34724 .next
34725 .cindex "log" "ident timeout"
34726 .cindex "RFC 1413" "logging timeout"
34727 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
34728 client's ident port times out.
34729 .next
34730 .cindex "log" "incoming interface"
34731 .cindex "interface" "logging"
34732 &%incoming_interface%&: The interface on which a message was received is added
34733 to the &"<="& line as an IP address in square brackets, tagged by I= and
34734 followed by a colon and the port number. The local interface and port are also
34735 added to other SMTP log lines, for example &"SMTP connection from"&, and to
34736 rejection lines.
34737 .next
34738 .cindex "log" "incoming remote port"
34739 .cindex "port" "logging remote"
34740 .cindex "TCP/IP" "logging incoming remote port"
34741 .vindex "&$sender_fullhost$&"
34742 .vindex "&$sender_rcvhost$&"
34743 &%incoming_port%&: The remote port number from which a message was received is
34744 added to log entries and &'Received:'& header lines, following the IP address
34745 in square brackets, and separated from it by a colon. This is implemented by
34746 changing the value that is put in the &$sender_fullhost$& and
34747 &$sender_rcvhost$& variables. Recording the remote port number has become more
34748 important with the widening use of NAT (see RFC 2505).
34749 .next
34750 .cindex "log" "dropped connection"
34751 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34752 connection is unexpectedly dropped.
34753 .next
34754 .cindex "log" "outgoing remote port"
34755 .cindex "port" "logging outgoint remote"
34756 .cindex "TCP/IP" "logging ougtoing remote port"
34757 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34758 containing => tags) following the IP address. This option is not included in
34759 the default setting, because for most ordinary configurations, the remote port
34760 number is always 25 (the SMTP port).
34761 .next
34762 .cindex "log" "process ids in"
34763 .cindex "pid (process id)" "in log lines"
34764 &%pid%&: The current process id is added to every log line, in square brackets,
34765 immediately after the time and date.
34766 .next
34767 .cindex "log" "queue run"
34768 .cindex "queue runner" "logging"
34769 &%queue_run%&: The start and end of every queue run are logged.
34770 .next
34771 .cindex "log" "queue time"
34772 &%queue_time%&: The amount of time the message has been in the queue on the
34773 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34774 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34775 includes reception time as well as the delivery time for the current address.
34776 This means that it may be longer than the difference between the arrival and
34777 delivery log line times, because the arrival log line is not written until the
34778 message has been successfully received.
34779 .next
34780 &%queue_time_overall%&: The amount of time the message has been in the queue on
34781 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34782 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34783 message, so it includes reception time as well as the total delivery time.
34784 .next
34785 .cindex "log" "recipients"
34786 &%received_recipients%&: The recipients of a message are listed in the main log
34787 as soon as the message is received. The list appears at the end of the log line
34788 that is written when a message is received, preceded by the word &"for"&. The
34789 addresses are listed after they have been qualified, but before any rewriting
34790 has taken place.
34791 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34792 in the list.
34793 .next
34794 .cindex "log" "sender reception"
34795 &%received_sender%&: The unrewritten original sender of a message is added to
34796 the end of the log line that records the message's arrival, after the word
34797 &"from"& (before the recipients if &%received_recipients%& is also set).
34798 .next
34799 .cindex "log" "header lines for rejection"
34800 &%rejected_header%&: If a message's header has been received at the time a
34801 rejection is written to the reject log, the complete header is added to the
34802 log. Header logging can be turned off individually for messages that are
34803 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34804 .next
34805 .cindex "log" "retry defer"
34806 &%retry_defer%&: A log line is written if a delivery is deferred because a
34807 retry time has not yet been reached. However, this &"retry time not reached"&
34808 message is always omitted from individual message logs after the first delivery
34809 attempt.
34810 .next
34811 .cindex "log" "return path"
34812 &%return_path_on_delivery%&: The return path that is being transmitted with
34813 the message is included in delivery and bounce lines, using the tag P=.
34814 This is omitted if no delivery actually happens, for example, if routing fails,
34815 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
34816 .next
34817 .cindex "log" "sender on delivery"
34818 &%sender_on_delivery%&: The message's sender address is added to every delivery
34819 and bounce line, tagged by F= (for &"from"&).
34820 This is the original sender that was received with the message; it is not
34821 necessarily the same as the outgoing return path.
34822 .next
34823 .cindex "log" "sender verify failure"
34824 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34825 gives details of a sender verification failure is not written. Log lines for
34826 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34827 detail is lost.
34828 .next
34829 .cindex "log" "size rejection"
34830 &%size_reject%&: A log line is written whenever a message is rejected because
34831 it is too big.
34832 .next
34833 .cindex "log" "frozen messages; skipped"
34834 .cindex "frozen messages" "logging skipping"
34835 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34836 queue run because it is frozen or because another process is already delivering
34837 it.
34838 .cindex "&""spool file is locked""&"
34839 The message that is written is &"spool file is locked"&.
34840 .next
34841 .cindex "log" "smtp confirmation"
34842 .cindex "SMTP" "logging confirmation"
34843 .cindex "LMTP" "logging confirmation"
34844 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
34845 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34846 A number of MTAs (including Exim) return an identifying string in this
34847 response.
34848 .next
34849 .cindex "log" "SMTP connections"
34850 .cindex "SMTP" "logging connections"
34851 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34852 established or closed, unless the connection is from a host that matches
34853 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34854 only when the closure is unexpected.) This applies to connections from local
34855 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34856 dropped in the middle of a message, a log line is always written, whether or
34857 not this selector is set, but otherwise nothing is written at the start and end
34858 of connections unless this selector is enabled.
34859
34860 For TCP/IP connections to an Exim daemon, the current number of connections is
34861 included in the log message for each new connection, but note that the count is
34862 reset if the daemon is restarted.
34863 Also, because connections are closed (and the closure is logged) in
34864 subprocesses, the count may not include connections that have been closed but
34865 whose termination the daemon has not yet noticed. Thus, while it is possible to
34866 match up the opening and closing of connections in the log, the value of the
34867 logged counts may not be entirely accurate.
34868 .next
34869 .cindex "log" "SMTP transaction; incomplete"
34870 .cindex "SMTP" "logging incomplete transactions"
34871 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
34872 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
34873 and the message sender plus any accepted recipients are included in the log
34874 line. This can provide evidence of dictionary attacks.
34875 .next
34876 .cindex "log" "non-MAIL SMTP sessions"
34877 .cindex "MAIL" "logging session without"
34878 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
34879 connection terminates without having issued a MAIL command. This includes both
34880 the case when the connection is dropped, and the case when QUIT is used. It
34881 does not include cases where the connection is rejected right at the start (by
34882 an ACL, or because there are too many connections, or whatever). These cases
34883 already have their own log lines.
34884
34885 The log line that is written contains the identity of the client in the usual
34886 way, followed by D= and a time, which records the duration of the connection.
34887 If the connection was authenticated, this fact is logged exactly as it is for
34888 an incoming message, with an A= item. If the connection was encrypted, CV=,
34889 DN=, and X= items may appear as they do for an incoming message, controlled by
34890 the same logging options.
34891
34892 Finally, if any SMTP commands were issued during the connection, a C= item
34893 is added to the line, listing the commands that were used. For example,
34894 .code
34895 C=EHLO,QUIT
34896 .endd
34897 shows that the client issued QUIT straight after EHLO. If there were fewer
34898 than 20 commands, they are all listed. If there were more than 20 commands,
34899 the last 20 are listed, preceded by &"..."&. However, with the default
34900 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
34901 have been aborted before 20 non-mail commands are processed.
34902 .next
34903 &%smtp_mailauth%&: A third subfield with the authenticated sender,
34904 colon-separated, is appended to the A= item for a message arrival or delivery
34905 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
34906 was accepted or used.
34907 .next
34908 .cindex "log" "SMTP protocol error"
34909 .cindex "SMTP" "logging protocol error"
34910 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
34911 encountered. Exim does not have perfect detection of all protocol errors
34912 because of transmission delays and the use of pipelining. If PIPELINING has
34913 been advertised to a client, an Exim server assumes that the client will use
34914 it, and therefore it does not count &"expected"& errors (for example, RCPT
34915 received after rejecting MAIL) as protocol errors.
34916 .next
34917 .cindex "SMTP" "logging syntax errors"
34918 .cindex "SMTP" "syntax errors; logging"
34919 .cindex "SMTP" "unknown command; logging"
34920 .cindex "log" "unknown SMTP command"
34921 .cindex "log" "SMTP syntax error"
34922 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
34923 encountered. An unrecognized command is treated as a syntax error. For an
34924 external connection, the host identity is given; for an internal connection
34925 using &%-bs%& the sender identification (normally the calling user) is given.
34926 .next
34927 .cindex "log" "subject"
34928 .cindex "subject, logging"
34929 &%subject%&: The subject of the message is added to the arrival log line,
34930 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
34931 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
34932 specifies whether characters with values greater than 127 should be logged
34933 unchanged, or whether they should be rendered as escape sequences.
34934 .next
34935 .cindex "log" "certificate verification"
34936 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
34937 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
34938 verified, and &`CV=no`& if not.
34939 .next
34940 .cindex "log" "TLS cipher"
34941 .cindex "TLS" "logging cipher"
34942 &%tls_cipher%&: When a message is sent or received over an encrypted
34943 connection, the cipher suite used is added to the log line, preceded by X=.
34944 .next
34945 .cindex "log" "TLS peer DN"
34946 .cindex "TLS" "logging peer DN"
34947 &%tls_peerdn%&: When a message is sent or received over an encrypted
34948 connection, and a certificate is supplied by the remote host, the peer DN is
34949 added to the log line, preceded by DN=.
34950 .next
34951 .cindex "log" "TLS SNI"
34952 .cindex "TLS" "logging SNI"
34953 &%tls_sni%&: When a message is received over an encrypted connection, and
34954 the remote host provided the Server Name Indication extension, the SNI is
34955 added to the log line, preceded by SNI=.
34956 .next
34957 .cindex "log" "DNS failure in list"
34958 &%unknown_in_list%&: This setting causes a log entry to be written when the
34959 result of a list match is failure because a DNS lookup failed.
34960 .endlist
34961
34962
34963 .section "Message log" "SECID260"
34964 .cindex "message" "log file for"
34965 .cindex "log" "message log; description of"
34966 .cindex "&_msglog_& directory"
34967 .oindex "&%preserve_message_logs%&"
34968 In addition to the general log files, Exim writes a log file for each message
34969 that it handles. The names of these per-message logs are the message ids, and
34970 they are kept in the &_msglog_& sub-directory of the spool directory. Each
34971 message log contains copies of the log lines that apply to the message. This
34972 makes it easier to inspect the status of an individual message without having
34973 to search the main log. A message log is deleted when processing of the message
34974 is complete, unless &%preserve_message_logs%& is set, but this should be used
34975 only with great care because they can fill up your disk very quickly.
34976
34977 On a heavily loaded system, it may be desirable to disable the use of
34978 per-message logs, in order to reduce disk I/O. This can be done by setting the
34979 &%message_logs%& option false.
34980 .ecindex IIDloggen
34981
34982
34983
34984
34985 . ////////////////////////////////////////////////////////////////////////////
34986 . ////////////////////////////////////////////////////////////////////////////
34987
34988 .chapter "Exim utilities" "CHAPutils"
34989 .scindex IIDutils "utilities"
34990 A number of utility scripts and programs are supplied with Exim and are
34991 described in this chapter. There is also the Exim Monitor, which is covered in
34992 the next chapter. The utilities described here are:
34993
34994 .itable none 0 0 3  7* left  15* left  40* left
34995 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
34996   "list what Exim processes are doing"
34997 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
34998 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
34999 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35000 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35001                                                 various criteria"
35002 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35003 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35004   "extract statistics from the log"
35005 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35006   "check address acceptance from given IP"
35007 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35008 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35009 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35010 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35011 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35012 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35013 .endtable
35014
35015 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35016 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35017 &url(http://duncanthrax.net/exilog/) for details.
35018
35019
35020
35021
35022 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35023 .cindex "&'exiwhat'&"
35024 .cindex "process, querying"
35025 .cindex "SIGUSR1"
35026 On operating systems that can restart a system call after receiving a signal
35027 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35028 a line describing what it is doing to the file &_exim-process.info_& in the
35029 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35030 processes it can find, having first emptied the file. It then waits for one
35031 second to allow the Exim processes to react before displaying the results. In
35032 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35033 send the signal to the Exim processes, so it is normally run as root.
35034
35035 &*Warning*&: This is not an efficient process. It is intended for occasional
35036 use by system administrators. It is not sensible, for example, to set up a
35037 script that sends SIGUSR1 signals to Exim processes at short intervals.
35038
35039
35040 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35041 varies in different operating systems. Not only are different options used,
35042 but the format of the output is different. For this reason, there are some
35043 system configuration options that configure exactly how &'exiwhat'& works. If
35044 it doesn't seem to be working for you, check the following compile-time
35045 options:
35046 .display
35047 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35048 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35049 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35050 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35051 .endd
35052 An example of typical output from &'exiwhat'& is
35053 .code
35054 164 daemon: -q1h, listening on port 25
35055 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35056 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35057   [10.19.42.42] (editor@ref.example)
35058 10592 handling incoming call from [192.168.243.242]
35059 10628 accepting a local non-SMTP message
35060 .endd
35061 The first number in the output line is the process number. The third line has
35062 been split here, in order to fit it on the page.
35063
35064
35065
35066 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35067 .cindex "&'exiqgrep'&"
35068 .cindex "queue" "grepping"
35069 This utility is a Perl script contributed by Matt Hubbard. It runs
35070 .code
35071 exim -bpu
35072 .endd
35073 or (in case &*-a*& switch is specified)
35074 .code
35075 exim -bp
35076 .endd
35077 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35078 contain alternate exim configuration the queue management might be using.
35079
35080 to obtain a queue listing, and then greps the output to select messages 
35081 that match given criteria. The following selection options are available:
35082
35083 .vlist
35084 .vitem &*-f*&&~<&'regex'&>
35085 Match the sender address using a case-insensitive search. The field that is
35086 tested is enclosed in angle brackets, so you can test for bounce messages with
35087 .code
35088 exiqgrep -f '^<>$'
35089 .endd
35090 .vitem &*-r*&&~<&'regex'&>
35091 Match a recipient address using a case-insensitve search. The field that is
35092 tested is not enclosed in angle brackets.
35093
35094 .vitem &*-s*&&~<&'regex'&>
35095 Match against the size field.
35096
35097 .vitem &*-y*&&~<&'seconds'&>
35098 Match messages that are younger than the given time.
35099
35100 .vitem &*-o*&&~<&'seconds'&>
35101 Match messages that are older than the given time.
35102
35103 .vitem &*-z*&
35104 Match only frozen messages.
35105
35106 .vitem &*-x*&
35107 Match only non-frozen messages.
35108 .endlist
35109
35110 The following options control the format of the output:
35111
35112 .vlist
35113 .vitem &*-c*&
35114 Display only the count of matching messages.
35115
35116 .vitem &*-l*&
35117 Long format &-- display the full message information as output by Exim. This is
35118 the default.
35119
35120 .vitem &*-i*&
35121 Display message ids only.
35122
35123 .vitem &*-b*&
35124 Brief format &-- one line per message.
35125
35126 .vitem &*-R*&
35127 Display messages in reverse order.
35128
35129 .vitem &*-a*&
35130 Include delivered recipients in queue listing.
35131 .endlist
35132
35133 There is one more option, &%-h%&, which outputs a list of options.
35134
35135
35136
35137 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35138 .cindex "&'exiqsumm'&"
35139 .cindex "queue" "summary"
35140 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35141 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35142 running a command such as
35143 .code
35144 exim -bp | exiqsumm
35145 .endd
35146 The output consists of one line for each domain that has messages waiting for
35147 it, as in the following example:
35148 .code
35149 3   2322   74m   66m  msn.com.example
35150 .endd
35151 Each line lists the number of pending deliveries for a domain, their total
35152 volume, and the length of time that the oldest and the newest messages have
35153 been waiting. Note that the number of pending deliveries is greater than the
35154 number of messages when messages have more than one recipient.
35155
35156 A summary line is output at the end. By default the output is sorted on the
35157 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35158 the output to be sorted by oldest message and by count of messages,
35159 respectively. There are also three options that split the messages for each
35160 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35161 separates frozen messages, and &%-s%& separates messages according to their
35162 sender.
35163
35164 The output of &'exim -bp'& contains the original addresses in the message, so
35165 this also applies to the output from &'exiqsumm'&. No domains from addresses
35166 generated by aliasing or forwarding are included (unless the &%one_time%&
35167 option of the &(redirect)& router has been used to convert them into &"top
35168 level"& addresses).
35169
35170
35171
35172
35173 .section "Extracting specific information from the log (exigrep)" &&&
35174          "SECTextspeinf"
35175 .cindex "&'exigrep'&"
35176 .cindex "log" "extracts; grepping for"
35177 The &'exigrep'& utility is a Perl script that searches one or more main log
35178 files for entries that match a given pattern. When it finds a match, it
35179 extracts all the log entries for the relevant message, not just those that
35180 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35181 given message, or all mail for a given user, or for a given host, for example.
35182 The input files can be in Exim log format or syslog format.
35183 If a matching log line is not associated with a specific message, it is
35184 included in &'exigrep'&'s output without any additional lines. The usage is:
35185 .display
35186 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35187 .endd
35188 If no log file names are given on the command line, the standard input is read.
35189
35190 The &%-t%& argument specifies a number of seconds. It adds an additional
35191 condition for message selection. Messages that are complete are shown only if
35192 they spent more than <&'n'&> seconds on the queue.
35193
35194 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35195 makes it case-sensitive. This may give a performance improvement when searching
35196 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35197 option; with &%-I%& they do not. In both cases it is possible to change the
35198 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35199
35200 The &%-l%& option means &"literal"&, that is, treat all characters in the
35201 pattern as standing for themselves. Otherwise the pattern must be a Perl
35202 regular expression.
35203
35204 The &%-v%& option inverts the matching condition. That is, a line is selected
35205 if it does &'not'& match the pattern.
35206
35207 If the location of a &'zcat'& command is known from the definition of
35208 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35209 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35210
35211
35212 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35213 .cindex "&'exipick'&"
35214 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35215 lists messages from the queue according to a variety of criteria. For details
35216 of &'exipick'&'s facilities, visit the web page at
35217 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35218 the &%--help%& option.
35219
35220
35221 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35222 .cindex "log" "cycling local files"
35223 .cindex "cycling logs"
35224 .cindex "&'exicyclog'&"
35225 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35226 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35227 you are using log files with datestamps in their names (see section
35228 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35229 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35230 There are two command line options for &'exicyclog'&:
35231 .ilist
35232 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35233 default that is set when Exim is built. The default default is 10.
35234 .next
35235 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35236 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35237 overriding the script's default, which is to find the setting from Exim's
35238 configuration.
35239 .endlist
35240
35241 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35242 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35243 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35244 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35245 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35246 logs are handled similarly.
35247
35248 If the limit is greater than 99, the script uses 3-digit numbers such as
35249 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35250 to one that is greater, or &'vice versa'&, you will have to fix the names of
35251 any existing log files.
35252
35253 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35254 the end are deleted. All files with numbers greater than 01 are compressed,
35255 using a compression command which is configured by the COMPRESS_COMMAND
35256 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35257 root &%crontab%& entry of the form
35258 .code
35259 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35260 .endd
35261 assuming you have used the name &"exim"& for the Exim user. You can run
35262 &'exicyclog'& as root if you wish, but there is no need.
35263
35264
35265
35266 .section "Mail statistics (eximstats)" "SECTmailstat"
35267 .cindex "statistics"
35268 .cindex "&'eximstats'&"
35269 A Perl script called &'eximstats'& is provided for extracting statistical
35270 information from log files. The output is either plain text, or HTML.
35271 Exim log files are also supported by the &'Lire'& system produced by the
35272 LogReport Foundation &url(http://www.logreport.org).
35273
35274 The &'eximstats'& script has been hacked about quite a bit over time. The
35275 latest version is the result of some extensive revision by Steve Campbell. A
35276 lot of information is given by default, but there are options for suppressing
35277 various parts of it. Following any options, the arguments to the script are a
35278 list of files, which should be main log files. For example:
35279 .code
35280 eximstats -nr /var/spool/exim/log/mainlog.01
35281 .endd
35282 By default, &'eximstats'& extracts information about the number and volume of
35283 messages received from or delivered to various hosts. The information is sorted
35284 both by message count and by volume, and the top fifty hosts in each category
35285 are listed on the standard output. Similar information, based on email
35286 addresses or domains instead of hosts can be requested by means of various
35287 options. For messages delivered and received locally, similar statistics are
35288 also produced per user.
35289
35290 The output also includes total counts and statistics about delivery errors, and
35291 histograms showing the number of messages received and deliveries made in each
35292 hour of the day. A delivery with more than one address in its envelope (for
35293 example, an SMTP transaction with more than one RCPT command) is counted
35294 as a single delivery by &'eximstats'&.
35295
35296 Though normally more deliveries than receipts are reported (as messages may
35297 have multiple recipients), it is possible for &'eximstats'& to report more
35298 messages received than delivered, even though the queue is empty at the start
35299 and end of the period in question. If an incoming message contains no valid
35300 recipients, no deliveries are recorded for it. A bounce message is handled as
35301 an entirely separate message.
35302
35303 &'eximstats'& always outputs a grand total summary giving the volume and number
35304 of messages received and deliveries made, and the number of hosts involved in
35305 each case. It also outputs the number of messages that were delayed (that is,
35306 not completely delivered at the first attempt), and the number that had at
35307 least one address that failed.
35308
35309 The remainder of the output is in sections that can be independently disabled
35310 or modified by various options. It consists of a summary of deliveries by
35311 transport, histograms of messages received and delivered per time interval
35312 (default per hour), information about the time messages spent on the queue,
35313 a list of relayed messages, lists of the top fifty sending hosts, local
35314 senders, destination hosts, and destination local users by count and by volume,
35315 and a list of delivery errors that occurred.
35316
35317 The relay information lists messages that were actually relayed, that is, they
35318 came from a remote host and were directly delivered to some other remote host,
35319 without being processed (for example, for aliasing or forwarding) locally.
35320
35321 There are quite a few options for &'eximstats'& to control exactly what it
35322 outputs. These are documented in the Perl script itself, and can be extracted
35323 by running the command &(perldoc)& on the script. For example:
35324 .code
35325 perldoc /usr/exim/bin/eximstats
35326 .endd
35327
35328 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35329 .cindex "&'exim_checkaccess'&"
35330 .cindex "policy control" "checking access"
35331 .cindex "checking access"
35332 The &%-bh%& command line argument allows you to run a fake SMTP session with
35333 debugging output, in order to check what Exim is doing when it is applying
35334 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35335 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35336 sometimes you just want to answer the question &"Does this address have
35337 access?"& without bothering with any further details.
35338
35339 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35340 two arguments, an IP address and an email address:
35341 .code
35342 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35343 .endd
35344 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35345 given email address would be accepted in a RCPT command in a TCP/IP
35346 connection from the host with the given IP address. The output of the utility
35347 is either the word &"accepted"&, or the SMTP error response, for example:
35348 .code
35349 Rejected:
35350 550 Relay not permitted
35351 .endd
35352 When running this test, the utility uses &`<>`& as the envelope sender address
35353 for the MAIL command, but you can change this by providing additional
35354 options. These are passed directly to the Exim command. For example, to specify
35355 that the test is to be run with the sender address &'himself@there.example'&
35356 you can use:
35357 .code
35358 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35359                  -f himself@there.example
35360 .endd
35361 Note that these additional Exim command line items must be given after the two
35362 mandatory arguments.
35363
35364 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35365 while running its checks. You can run checks that include callouts by using
35366 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35367
35368
35369
35370 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35371 .cindex "DBM" "building dbm files"
35372 .cindex "building DBM files"
35373 .cindex "&'exim_dbmbuild'&"
35374 .cindex "lower casing"
35375 .cindex "binary zero" "in lookup key"
35376 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35377 the format used by the &(lsearch)& lookup (see section
35378 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35379 names as keys and the remainder of the information as data. The lower-casing
35380 can be prevented by calling the program with the &%-nolc%& option.
35381
35382 A terminating zero is included as part of the key string. This is expected by
35383 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35384 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35385 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35386 files.
35387
35388 The program requires two arguments: the name of the input file (which can be a
35389 single hyphen to indicate the standard input), and the name of the output file.
35390 It creates the output under a temporary name, and then renames it if all went
35391 well.
35392
35393 .cindex "USE_DB"
35394 If the native DB interface is in use (USE_DB is set in a compile-time
35395 configuration file &-- this is common in free versions of Unix) the two file
35396 names must be different, because in this mode the Berkeley DB functions create
35397 a single output file using exactly the name given. For example,
35398 .code
35399 exim_dbmbuild /etc/aliases /etc/aliases.db
35400 .endd
35401 reads the system alias file and creates a DBM version of it in
35402 &_/etc/aliases.db_&.
35403
35404 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35405 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35406 environment, the suffixes are added to the second argument of
35407 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35408 when the Berkeley functions are used in compatibility mode (though this is not
35409 recommended), because in that case it adds a &_.db_& suffix to the file name.
35410
35411 If a duplicate key is encountered, the program outputs a warning, and when it
35412 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35413 option is used. By default, only the first of a set of duplicates is used &--
35414 this makes it compatible with &(lsearch)& lookups. There is an option
35415 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35416 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35417 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35418 return code is 2.
35419
35420
35421
35422
35423 .section "Finding individual retry times (exinext)" "SECTfinindret"
35424 .cindex "retry" "times"
35425 .cindex "&'exinext'&"
35426 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35427 fish specific information out of the retry database. Given a mail domain (or a
35428 complete address), it looks up the hosts for that domain, and outputs any retry
35429 information for the hosts or for the domain. At present, the retry information
35430 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35431 output. For example:
35432 .code
35433 $ exinext piglet@milne.fict.example
35434 kanga.milne.example:192.168.8.1 error 146: Connection refused
35435   first failed: 21-Feb-1996 14:57:34
35436   last tried:   21-Feb-1996 14:57:34
35437   next try at:  21-Feb-1996 15:02:34
35438 roo.milne.example:192.168.8.3 error 146: Connection refused
35439   first failed: 20-Jan-1996 13:12:08
35440   last tried:   21-Feb-1996 11:42:03
35441   next try at:  21-Feb-1996 19:42:03
35442   past final cutoff time
35443 .endd
35444 You can also give &'exinext'& a local part, without a domain, and it
35445 will give any retry information for that local part in your default domain.
35446 A message id can be used to obtain retry information pertaining to a specific
35447 message. This exists only when an attempt to deliver a message to a remote host
35448 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35449 &'exinext'& is not particularly efficient, but then it is not expected to be
35450 run very often.
35451
35452 The &'exinext'& utility calls Exim to find out information such as the location
35453 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35454 passed on to the &'exim'& commands. The first specifies an alternate Exim
35455 configuration file, and the second sets macros for use within the configuration
35456 file. These features are mainly to help in testing, but might also be useful in
35457 environments where more than one configuration file is in use.
35458
35459
35460
35461 .section "Hints database maintenance" "SECThindatmai"
35462 .cindex "hints database" "maintenance"
35463 .cindex "maintaining Exim's hints database"
35464 Three utility programs are provided for maintaining the DBM files that Exim
35465 uses to contain its delivery hint information. Each program requires two
35466 arguments. The first specifies the name of Exim's spool directory, and the
35467 second is the name of the database it is to operate on. These are as follows:
35468
35469 .ilist
35470 &'retry'&: the database of retry information
35471 .next
35472 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35473 for remote hosts
35474 .next
35475 &'callout'&: the callout cache
35476 .next
35477 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35478 .next
35479 &'misc'&: other hints data
35480 .endlist
35481
35482 The &'misc'& database is used for
35483
35484 .ilist
35485 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35486 .next
35487 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35488 &(smtp)& transport)
35489 .endlist
35490
35491
35492
35493 .section "exim_dumpdb" "SECID261"
35494 .cindex "&'exim_dumpdb'&"
35495 The entire contents of a database are written to the standard output by the
35496 &'exim_dumpdb'& program, which has no options or arguments other than the
35497 spool and database names. For example, to dump the retry database:
35498 .code
35499 exim_dumpdb /var/spool/exim retry
35500 .endd
35501 Two lines of output are produced for each entry:
35502 .code
35503 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35504 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35505 .endd
35506 The first item on the first line is the key of the record. It starts with one
35507 of the letters R, or T, depending on whether it refers to a routing or
35508 transport retry. For a local delivery, the next part is the local address; for
35509 a remote delivery it is the name of the remote host, followed by its failing IP
35510 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35511 transport). If the remote port is not the standard one (port 25), it is added
35512 to the IP address. Then there follows an error code, an additional error code,
35513 and a textual description of the error.
35514
35515 The three times on the second line are the time of first failure, the time of
35516 the last delivery attempt, and the computed time for the next attempt. The line
35517 ends with an asterisk if the cutoff time for the last retry rule has been
35518 exceeded.
35519
35520 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35521 consists of a host name followed by a list of ids for messages that are or were
35522 waiting to be delivered to that host. If there are a very large number for any
35523 one host, continuation records, with a sequence number added to the host name,
35524 may be seen. The data in these records is often out of date, because a message
35525 may be routed to several alternative hosts, and Exim makes no effort to keep
35526 cross-references.
35527
35528
35529
35530 .section "exim_tidydb" "SECID262"
35531 .cindex "&'exim_tidydb'&"
35532 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35533 database. If run with no options, it removes all records that are more than 30
35534 days old. The age is calculated from the date and time that the record was last
35535 updated. Note that, in the case of the retry database, it is &'not'& the time
35536 since the first delivery failure. Information about a host that has been down
35537 for more than 30 days will remain in the database, provided that the record is
35538 updated sufficiently often.
35539
35540 The cutoff date can be altered by means of the &%-t%& option, which must be
35541 followed by a time. For example, to remove all records older than a week from
35542 the retry database:
35543 .code
35544 exim_tidydb -t 7d /var/spool/exim retry
35545 .endd
35546 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35547 message ids. In the former these appear as data in records keyed by host &--
35548 they were messages that were waiting for that host &-- and in the latter they
35549 are the keys for retry information for messages that have suffered certain
35550 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35551 message ids in database records are those of messages that are still on the
35552 queue. Message ids for messages that no longer exist are removed from
35553 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35554 For the &'retry'& database, records whose keys are non-existent message ids are
35555 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35556 whenever it removes information from the database.
35557
35558 Certain records are automatically removed by Exim when they are no longer
35559 needed, but others are not. For example, if all the MX hosts for a domain are
35560 down, a retry record is created for each one. If the primary MX host comes back
35561 first, its record is removed when Exim successfully delivers to it, but the
35562 records for the others remain because Exim has not tried to use those hosts.
35563
35564 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35565 hints databases. You should do this at a quiet time of day, because it requires
35566 a database to be locked (and therefore inaccessible to Exim) while it does its
35567 work. Removing records from a DBM file does not normally make the file smaller,
35568 but all the common DBM libraries are able to re-use the space that is released.
35569 After an initial phase of increasing in size, the databases normally reach a
35570 point at which they no longer get any bigger, as long as they are regularly
35571 tidied.
35572
35573 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35574 databases is likely to keep on increasing.
35575
35576
35577
35578
35579 .section "exim_fixdb" "SECID263"
35580 .cindex "&'exim_fixdb'&"
35581 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35582 Its main use is for testing Exim, but it might also be occasionally useful for
35583 getting round problems in a live system. It has no options, and its interface
35584 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35585 key of a database record can then be entered, and the data for that record is
35586 displayed.
35587
35588 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35589 except the &'retry'& database, that is the only operation that can be carried
35590 out. For the &'retry'& database, each field is output preceded by a number, and
35591 data for individual fields can be changed by typing the field number followed
35592 by new data, for example:
35593 .code
35594 > 4 951102:1000
35595 .endd
35596 resets the time of the next delivery attempt. Time values are given as a
35597 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35598 used as optional separators.
35599
35600
35601
35602
35603 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35604 .cindex "mailbox" "maintenance"
35605 .cindex "&'exim_lock'&"
35606 .cindex "locking mailboxes"
35607 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35608 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35609 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35610 a user agent while investigating a problem. The utility requires the name of
35611 the file as its first argument. If the locking is successful, the second
35612 argument is run as a command (using C's &[system()]& function); if there is no
35613 second argument, the value of the SHELL environment variable is used; if this
35614 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35615 is unlocked and the utility ends. The following options are available:
35616
35617 .vlist
35618 .vitem &%-fcntl%&
35619 Use &[fcntl()]& locking on the open mailbox.
35620
35621 .vitem &%-flock%&
35622 Use &[flock()]& locking on the open mailbox, provided the operating system
35623 supports it.
35624
35625 .vitem &%-interval%&
35626 This must be followed by a number, which is a number of seconds; it sets the
35627 interval to sleep between retries (default 3).
35628
35629 .vitem &%-lockfile%&
35630 Create a lock file before opening the mailbox.
35631
35632 .vitem &%-mbx%&
35633 Lock the mailbox using MBX rules.
35634
35635 .vitem &%-q%&
35636 Suppress verification output.
35637
35638 .vitem &%-retries%&
35639 This must be followed by a number; it sets the number of times to try to get
35640 the lock (default 10).
35641
35642 .vitem &%-restore_time%&
35643 This option causes &%exim_lock%& to restore the modified and read times to the
35644 locked file before exiting. This allows you to access a locked mailbox (for
35645 example, to take a backup copy) without disturbing the times that the user
35646 subsequently sees.
35647
35648 .vitem &%-timeout%&
35649 This must be followed by a number, which is a number of seconds; it sets a
35650 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35651 default), a non-blocking call is used.
35652
35653 .vitem &%-v%&
35654 Generate verbose output.
35655 .endlist
35656
35657 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35658 default is to create a lock file and also to use &[fcntl()]& locking on the
35659 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35660 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35661 requires that the directory containing the file be writeable. Locking by lock
35662 file does not last for ever; Exim assumes that a lock file is expired if it is
35663 more than 30 minutes old.
35664
35665 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35666 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35667 to be taken out on the open mailbox, and an exclusive lock on the file
35668 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35669 number of the mailbox file. When the locking is released, if an exclusive lock
35670 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35671
35672 The default output contains verification of the locking that takes place. The
35673 &%-v%& option causes some additional information to be given. The &%-q%& option
35674 suppresses all output except error messages.
35675
35676 A command such as
35677 .code
35678 exim_lock /var/spool/mail/spqr
35679 .endd
35680 runs an interactive shell while the file is locked, whereas
35681 .display
35682 &`exim_lock -q /var/spool/mail/spqr <<End`&
35683 <&'some commands'&>
35684 &`End`&
35685 .endd
35686 runs a specific non-interactive sequence of commands while the file is locked,
35687 suppressing all verification output. A single command can be run by a command
35688 such as
35689 .code
35690 exim_lock -q /var/spool/mail/spqr \
35691   "cp /var/spool/mail/spqr /some/where"
35692 .endd
35693 Note that if a command is supplied, it must be entirely contained within the
35694 second argument &-- hence the quotes.
35695 .ecindex IIDutils
35696
35697
35698 . ////////////////////////////////////////////////////////////////////////////
35699 . ////////////////////////////////////////////////////////////////////////////
35700
35701 .chapter "The Exim monitor" "CHAPeximon"
35702 .scindex IIDeximon "Exim monitor" "description"
35703 .cindex "X-windows"
35704 .cindex "&'eximon'&"
35705 .cindex "Local/eximon.conf"
35706 .cindex "&_exim_monitor/EDITME_&"
35707 The Exim monitor is an application which displays in an X window information
35708 about the state of Exim's queue and what Exim is doing. An admin user can
35709 perform certain operations on messages from this GUI interface; however all
35710 such facilities are also available from the command line, and indeed, the
35711 monitor itself makes use of the command line to perform any actions requested.
35712
35713
35714
35715 .section "Running the monitor" "SECID264"
35716 The monitor is started by running the script called &'eximon'&. This is a shell
35717 script that sets up a number of environment variables, and then runs the
35718 binary called &_eximon.bin_&. The default appearance of the monitor window can
35719 be changed by editing the &_Local/eximon.conf_& file created by editing
35720 &_exim_monitor/EDITME_&. Comments in that file describe what the various
35721 parameters are for.
35722
35723 The parameters that get built into the &'eximon'& script can be overridden for
35724 a particular invocation by setting up environment variables of the same names,
35725 preceded by &`EXIMON_`&. For example, a shell command such as
35726 .code
35727 EXIMON_LOG_DEPTH=400 eximon
35728 .endd
35729 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
35730 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
35731 overrides the Exim log file configuration. This makes it possible to have
35732 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
35733 syslog messages are routed to a file on the local host.
35734
35735 X resources can be used to change the appearance of the window in the normal
35736 way. For example, a resource setting of the form
35737 .code
35738 Eximon*background: gray94
35739 .endd
35740 changes the colour of the background to light grey rather than white. The
35741 stripcharts are drawn with both the data lines and the reference lines in
35742 black. This means that the reference lines are not visible when on top of the
35743 data. However, their colour can be changed by setting a resource called
35744 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
35745 For example, if your X server is running Unix, you could set up lighter
35746 reference lines in the stripcharts by obeying
35747 .code
35748 xrdb -merge <<End
35749 Eximon*highlight: gray
35750 End
35751 .endd
35752 .cindex "admin user"
35753 In order to see the contents of messages on the queue, and to operate on them,
35754 &'eximon'& must either be run as root or by an admin user.
35755
35756 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35757 contain X11 resource parameters interpreted by the X11 library.  In addition,
35758 if the first parameter starts with the string "gdb" then it is removed and the
35759 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35760 versioned variants of gdb can be invoked).
35761
35762 The monitor's window is divided into three parts. The first contains one or
35763 more stripcharts and two action buttons, the second contains a &"tail"& of the
35764 main log file, and the third is a display of the queue of messages awaiting
35765 delivery, with two more action buttons. The following sections describe these
35766 different parts of the display.
35767
35768
35769
35770
35771 .section "The stripcharts" "SECID265"
35772 .cindex "stripchart"
35773 The first stripchart is always a count of messages on the queue. Its name can
35774 be configured by setting QUEUE_STRIPCHART_NAME in the
35775 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35776 configuration script by regular expression matches on log file entries, making
35777 it possible to display, for example, counts of messages delivered to certain
35778 hosts or using certain transports. The supplied defaults display counts of
35779 received and delivered messages, and of local and SMTP deliveries. The default
35780 period between stripchart updates is one minute; this can be adjusted by a
35781 parameter in the &_Local/eximon.conf_& file.
35782
35783 The stripchart displays rescale themselves automatically as the value they are
35784 displaying changes. There are always 10 horizontal lines in each chart; the
35785 title string indicates the value of each division when it is greater than one.
35786 For example, &"x2"& means that each division represents a value of 2.
35787
35788 It is also possible to have a stripchart which shows the percentage fullness of
35789 a particular disk partition, which is useful when local deliveries are confined
35790 to a single partition.
35791
35792 .cindex "&%statvfs%& function"
35793 This relies on the availability of the &[statvfs()]& function or equivalent in
35794 the operating system. Most, but not all versions of Unix that support Exim have
35795 this. For this particular stripchart, the top of the chart always represents
35796 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35797 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35798 &_Local/eximon.conf_& file.
35799
35800
35801
35802
35803 .section "Main action buttons" "SECID266"
35804 .cindex "size" "of monitor window"
35805 .cindex "Exim monitor" "window size"
35806 .cindex "window size"
35807 Below the stripcharts there is an action button for quitting the monitor. Next
35808 to this is another button marked &"Size"&. They are placed here so that
35809 shrinking the window to its default minimum size leaves just the queue count
35810 stripchart and these two buttons visible. Pressing the &"Size"& button causes
35811 the window to expand to its maximum size, unless it is already at the maximum,
35812 in which case it is reduced to its minimum.
35813
35814 When expanding to the maximum, if the window cannot be fully seen where it
35815 currently is, it is moved back to where it was the last time it was at full
35816 size. When it is expanding from its minimum size, the old position is
35817 remembered, and next time it is reduced to the minimum it is moved back there.
35818
35819 The idea is that you can keep a reduced window just showing one or two
35820 stripcharts at a convenient place on your screen, easily expand it to show
35821 the full window when required, and just as easily put it back to what it was.
35822 The idea is copied from what the &'twm'& window manager does for its
35823 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
35824 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
35825
35826 Normally, the monitor starts up with the window at its full size, but it can be
35827 built so that it starts up with the window at its smallest size, by setting
35828 START_SMALL=yes in &_Local/eximon.conf_&.
35829
35830
35831
35832 .section "The log display" "SECID267"
35833 .cindex "log" "tail of; in monitor"
35834 The second section of the window is an area in which a display of the tail of
35835 the main log is maintained.
35836 To save space on the screen, the timestamp on each log line is shortened by
35837 removing the date and, if &%log_timezone%& is set, the timezone.
35838 The log tail is not available when the only destination for logging data is
35839 syslog, unless the syslog lines are routed to a local file whose name is passed
35840 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
35841
35842 The log sub-window has a scroll bar at its lefthand side which can be used to
35843 move back to look at earlier text, and the up and down arrow keys also have a
35844 scrolling effect. The amount of log that is kept depends on the setting of
35845 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
35846 to use. When this is full, the earlier 50% of data is discarded &-- this is
35847 much more efficient than throwing it away line by line. The sub-window also has
35848 a horizontal scroll bar for accessing the ends of long log lines. This is the
35849 only means of horizontal scrolling; the right and left arrow keys are not
35850 available. Text can be cut from this part of the window using the mouse in the
35851 normal way. The size of this subwindow is controlled by parameters in the
35852 configuration file &_Local/eximon.conf_&.
35853
35854 Searches of the text in the log window can be carried out by means of the ^R
35855 and ^S keystrokes, which default to a reverse and a forward search,
35856 respectively. The search covers only the text that is displayed in the window.
35857 It cannot go further back up the log.
35858
35859 The point from which the search starts is indicated by a caret marker. This is
35860 normally at the end of the text in the window, but can be positioned explicitly
35861 by pointing and clicking with the left mouse button, and is moved automatically
35862 by a successful search. If new text arrives in the window when it is scrolled
35863 back, the caret remains where it is, but if the window is not scrolled back,
35864 the caret is moved to the end of the new text.
35865
35866 Pressing ^R or ^S pops up a window into which the search text can be typed.
35867 There are buttons for selecting forward or reverse searching, for carrying out
35868 the search, and for cancelling. If the &"Search"& button is pressed, the search
35869 happens and the window remains so that further searches can be done. If the
35870 &"Return"& key is pressed, a single search is done and the window is closed. If
35871 ^C is typed the search is cancelled.
35872
35873 The searching facility is implemented using the facilities of the Athena text
35874 widget. By default this pops up a window containing both &"search"& and
35875 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
35876 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
35877 However, the linkers in BSDI and HP-UX seem unable to handle an externally
35878 provided version of &%TextPop%& when the remaining parts of the text widget
35879 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
35880 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
35881 on these systems, at the expense of having unwanted items in the search popup
35882 window.
35883
35884
35885
35886 .section "The queue display" "SECID268"
35887 .cindex "queue" "display in monitor"
35888 The bottom section of the monitor window contains a list of all messages that
35889 are on the queue, which includes those currently being received or delivered,
35890 as well as those awaiting delivery. The size of this subwindow is controlled by
35891 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
35892 at which it is updated is controlled by another parameter in the same file &--
35893 the default is 5 minutes, since queue scans can be quite expensive. However,
35894 there is an &"Update"& action button just above the display which can be used
35895 to force an update of the queue display at any time.
35896
35897 When a host is down for some time, a lot of pending mail can build up for it,
35898 and this can make it hard to deal with other messages on the queue. To help
35899 with this situation there is a button next to &"Update"& called &"Hide"&. If
35900 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
35901 type anything in here and press &"Return"&, the text is added to a chain of
35902 such texts, and if every undelivered address in a message matches at least one
35903 of the texts, the message is not displayed.
35904
35905 If there is an address that does not match any of the texts, all the addresses
35906 are displayed as normal. The matching happens on the ends of addresses so, for
35907 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
35908 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
35909 has been set up, a button called &"Unhide"& is displayed. If pressed, it
35910 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
35911 a hide request is automatically cancelled after one hour.
35912
35913 While the dialogue box is displayed, you can't press any buttons or do anything
35914 else to the monitor window. For this reason, if you want to cut text from the
35915 queue display to use in the dialogue box, you have to do the cutting before
35916 pressing the &"Hide"& button.
35917
35918 The queue display contains, for each unhidden queued message, the length of
35919 time it has been on the queue, the size of the message, the message id, the
35920 message sender, and the first undelivered recipient, all on one line. If it is
35921 a bounce message, the sender is shown as &"<>"&. If there is more than one
35922 recipient to which the message has not yet been delivered, subsequent ones are
35923 listed on additional lines, up to a maximum configured number, following which
35924 an ellipsis is displayed. Recipients that have already received the message are
35925 not shown.
35926
35927 .cindex "frozen messages" "display"
35928 If a message is frozen, an asterisk is displayed at the left-hand side.
35929
35930 The queue display has a vertical scroll bar, and can also be scrolled by means
35931 of the arrow keys. Text can be cut from it using the mouse in the normal way.
35932 The text searching facilities, as described above for the log window, are also
35933 available, but the caret is always moved to the end of the text when the queue
35934 display is updated.
35935
35936
35937
35938 .section "The queue menu" "SECID269"
35939 .cindex "queue" "menu in monitor"
35940 If the &%shift%& key is held down and the left button is clicked when the mouse
35941 pointer is over the text for any message, an action menu pops up, and the first
35942 line of the queue display for the message is highlighted. This does not affect
35943 any selected text.
35944
35945 If you want to use some other event for popping up the menu, you can set the
35946 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
35947 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
35948 value set in this parameter is a standard X event description. For example, to
35949 run eximon using &%ctrl%& rather than &%shift%& you could use
35950 .code
35951 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
35952 .endd
35953 The title of the menu is the message id, and it contains entries which act as
35954 follows:
35955
35956 .ilist
35957 &'message log'&: The contents of the message log for the message are displayed
35958 in a new text window.
35959 .next
35960 &'headers'&: Information from the spool file that contains the envelope
35961 information and headers is displayed in a new text window. See chapter
35962 &<<CHAPspool>>& for a description of the format of spool files.
35963 .next
35964 &'body'&: The contents of the spool file containing the body of the message are
35965 displayed in a new text window. There is a default limit of 20,000 bytes to the
35966 amount of data displayed. This can be changed by setting the BODY_MAX
35967 option at compile time, or the EXIMON_BODY_MAX option at run time.
35968 .next
35969 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
35970 delivery of the message. This causes an automatic thaw if the message is
35971 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
35972 a new text window. The delivery is run in a separate process, to avoid holding
35973 up the monitor while the delivery proceeds.
35974 .next
35975 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
35976 that the message be frozen.
35977 .next
35978 .cindex "thawing messages"
35979 .cindex "unfreezing messages"
35980 .cindex "frozen messages" "thawing"
35981 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
35982 that the message be thawed.
35983 .next
35984 .cindex "delivery" "forcing failure"
35985 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
35986 that Exim gives up trying to deliver the message. A bounce message is generated
35987 for any remaining undelivered addresses.
35988 .next
35989 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
35990 that the message be deleted from the system without generating a bounce
35991 message.
35992 .next
35993 &'add recipient'&: A dialog box is displayed into which a recipient address can
35994 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35995 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35996 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35997 causes a call to Exim to be made using the &%-Mar%& option to request that an
35998 additional recipient be added to the message, unless the entry box is empty, in
35999 which case no action is taken.
36000 .next
36001 &'mark delivered'&: A dialog box is displayed into which a recipient address
36002 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36003 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36004 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36005 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36006 recipient address as already delivered, unless the entry box is empty, in which
36007 case no action is taken.
36008 .next
36009 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36010 mark all recipient addresses as already delivered.
36011 .next
36012 &'edit sender'&: A dialog box is displayed initialized with the current
36013 sender's address. Pressing RETURN causes a call to Exim to be made using the
36014 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36015 in which case no action is taken. If you want to set an empty sender (as in
36016 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36017 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36018 the address is qualified with that domain.
36019 .endlist
36020
36021 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36022 other cases when a call to Exim is made, if there is any output from Exim (in
36023 particular, if the command fails) a window containing the command and the
36024 output is displayed. Otherwise, the results of the action are normally apparent
36025 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36026 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36027 if no output is generated.
36028
36029 The queue display is automatically updated for actions such as freezing and
36030 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36031 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36032 force an update of the display after one of these actions.
36033
36034 In any text window that is displayed as result of a menu action, the normal
36035 cut-and-paste facility is available, and searching can be carried out using ^R
36036 and ^S, as described above for the log tail window.
36037 .ecindex IIDeximon
36038
36039
36040
36041
36042
36043 . ////////////////////////////////////////////////////////////////////////////
36044 . ////////////////////////////////////////////////////////////////////////////
36045
36046 .chapter "Security considerations" "CHAPsecurity"
36047 .scindex IIDsecurcon "security" "discussion of"
36048 This chapter discusses a number of issues concerned with security, some of
36049 which are also covered in other parts of this manual.
36050
36051 For reasons that this author does not understand, some people have promoted
36052 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36053 existence of this chapter in the documentation. However, the intent of the
36054 chapter is simply to describe the way Exim works in relation to certain
36055 security concerns, not to make any specific claims about the effectiveness of
36056 its security as compared with other MTAs.
36057
36058 What follows is a description of the way Exim is supposed to be. Best efforts
36059 have been made to try to ensure that the code agrees with the theory, but an
36060 absence of bugs can never be guaranteed. Any that are reported will get fixed
36061 as soon as possible.
36062
36063
36064 .section "Building a more &""hardened""& Exim" "SECID286"
36065 .cindex "security" "build-time features"
36066 There are a number of build-time options that can be set in &_Local/Makefile_&
36067 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36068 Exim administrator who does not have the root password, or by someone who has
36069 penetrated the Exim (but not the root) account. These options are as follows:
36070
36071 .ilist
36072 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36073 start of any file names used with the &%-C%& option. When it is set, these file
36074 names are also not allowed to contain the sequence &"/../"&. (However, if the
36075 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36076 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36077 default setting for &%ALT_CONFIG_PREFIX%&.
36078
36079 If the permitted configuration files are confined to a directory to
36080 which only root has access, this guards against someone who has broken
36081 into the Exim account from running a privileged Exim with an arbitrary
36082 configuration file, and using it to break into other accounts.
36083 .next
36084
36085 If a non-trusted configuration file (i.e. not the default configuration file
36086 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36087 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36088 the next item), then root privilege is retained only if the caller of Exim is
36089 root. This locks out the possibility of testing a configuration using &%-C%&
36090 right through message reception and delivery, even if the caller is root. The
36091 reception works, but by that time, Exim is running as the Exim user, so when
36092 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36093 privilege to be lost. However, root can test reception and delivery using two
36094 separate commands.
36095
36096 .next
36097 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36098 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36099 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36100 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36101 the restrictive side.  Requiring build-time selection of safe macros is onerous
36102 but this option is intended solely as a transition mechanism to permit
36103 previously-working configurations to continue to work after release 4.73.
36104 .next
36105 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36106 is disabled.
36107 .next
36108 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36109 never to be used for any deliveries. This is like the &%never_users%& runtime
36110 option, but it cannot be overridden; the runtime option adds additional users
36111 to the list. The default setting is &"root"&; this prevents a non-root user who
36112 is permitted to modify the runtime file from using Exim as a way to get root.
36113 .endlist
36114
36115
36116
36117 .section "Root privilege" "SECID270"
36118 .cindex "setuid"
36119 .cindex "root privilege"
36120 The Exim binary is normally setuid to root, which means that it gains root
36121 privilege (runs as root) when it starts execution. In some special cases (for
36122 example, when the daemon is not in use and there are no local deliveries), it
36123 may be possible to run Exim setuid to some user other than root. This is
36124 discussed in the next section. However, in most installations, root privilege
36125 is required for two things:
36126
36127 .ilist
36128 To set up a socket connected to the standard SMTP port (25) when initialising
36129 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36130 not required.
36131 .next
36132 To be able to change uid and gid in order to read users' &_.forward_& files and
36133 perform local deliveries as the receiving user or as specified in the
36134 configuration.
36135 .endlist
36136
36137 It is not necessary to be root to do any of the other things Exim does, such as
36138 receiving messages and delivering them externally over SMTP, and it is
36139 obviously more secure if Exim does not run as root except when necessary.
36140 For this reason, a user and group for Exim to use must be defined in
36141 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36142 group"&. Their values can be changed by the run time configuration, though this
36143 is not recommended. Often a user called &'exim'& is used, but some sites use
36144 &'mail'& or another user name altogether.
36145
36146 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36147 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36148 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36149
36150 After a new Exim process has interpreted its command line options, it changes
36151 uid and gid in the following cases:
36152
36153 .ilist
36154 .oindex "&%-C%&"
36155 .oindex "&%-D%&"
36156 If the &%-C%& option is used to specify an alternate configuration file, or if
36157 the &%-D%& option is used to define macro values for the configuration, and the
36158 calling process is not running as root, the uid and gid are changed to those of
36159 the calling process.
36160 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36161 option may not be used at all.
36162 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36163 can be supplied if the calling process is running as root, the Exim run-time
36164 user or CONFIGURE_OWNER, if defined.
36165 .next
36166 .oindex "&%-be%&"
36167 .oindex "&%-bf%&"
36168 .oindex "&%-bF%&"
36169 If the expansion test option (&%-be%&) or one of the filter testing options
36170 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36171 calling process.
36172 .next
36173 If the process is not a daemon process or a queue runner process or a delivery
36174 process or a process for testing address routing (started with &%-bt%&), the
36175 uid and gid are changed to the Exim user and group. This means that Exim always
36176 runs under its own uid and gid when receiving messages. This also applies when
36177 testing address verification
36178 .oindex "&%-bv%&"
36179 .oindex "&%-bh%&"
36180 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36181 option).
36182 .next
36183 For a daemon, queue runner, delivery, or address testing process, the uid
36184 remains as root at this stage, but the gid is changed to the Exim group.
36185 .endlist
36186
36187 The processes that initially retain root privilege behave as follows:
36188
36189 .ilist
36190 A daemon process changes the gid to the Exim group and the uid to the Exim
36191 user after setting up one or more listening sockets. The &[initgroups()]&
36192 function is called, so that if the Exim user is in any additional groups, they
36193 will be used during message reception.
36194 .next
36195 A queue runner process retains root privilege throughout its execution. Its
36196 job is to fork a controlled sequence of delivery processes.
36197 .next
36198 A delivery process retains root privilege throughout most of its execution,
36199 but any actual deliveries (that is, the transports themselves) are run in
36200 subprocesses which always change to a non-root uid and gid. For local
36201 deliveries this is typically the uid and gid of the owner of the mailbox; for
36202 remote deliveries, the Exim uid and gid are used. Once all the delivery
36203 subprocesses have been run, a delivery process changes to the Exim uid and gid
36204 while doing post-delivery tidying up such as updating the retry database and
36205 generating bounce and warning messages.
36206
36207 While the recipient addresses in a message are being routed, the delivery
36208 process runs as root. However, if a user's filter file has to be processed,
36209 this is done in a subprocess that runs under the individual user's uid and
36210 gid. A system filter is run as root unless &%system_filter_user%& is set.
36211 .next
36212 A process that is testing addresses (the &%-bt%& option) runs as root so that
36213 the routing is done in the same environment as a message delivery.
36214 .endlist
36215
36216
36217
36218
36219 .section "Running Exim without privilege" "SECTrunexiwitpri"
36220 .cindex "privilege, running without"
36221 .cindex "unprivileged running"
36222 .cindex "root privilege" "running without"
36223 Some installations like to run Exim in an unprivileged state for more of its
36224 operation, for added security. Support for this mode of operation is provided
36225 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36226 gid are changed to the Exim user and group at the start of a delivery process
36227 (and also queue runner and address testing processes). This means that address
36228 routing is no longer run as root, and the deliveries themselves cannot change
36229 to any other uid.
36230
36231 .cindex SIGHUP
36232 .cindex "daemon" "restarting"
36233 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36234 that the daemon can still be started in the usual way, and it can respond
36235 correctly to SIGHUP because the re-invocation regains root privilege.
36236
36237 An alternative approach is to make Exim setuid to the Exim user and also setgid
36238 to the Exim group. If you do this, the daemon must be started from a root
36239 process. (Calling Exim from a root process makes it behave in the way it does
36240 when it is setuid root.) However, the daemon cannot restart itself after a
36241 SIGHUP signal because it cannot regain privilege.
36242
36243 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36244 stops Exim from trying to re-invoke itself to do a delivery after a message has
36245 been received. Such a re-invocation is a waste of resources because it has no
36246 effect.
36247
36248 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36249 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36250 to the Exim user seems a clean approach, but there is one complication:
36251
36252 In this style of operation, Exim is running with the real uid and gid set to
36253 those of the calling process, and the effective uid/gid set to Exim's values.
36254 Ideally, any association with the calling process' uid/gid should be dropped,
36255 that is, the real uid/gid should be reset to the effective values so as to
36256 discard any privileges that the caller may have. While some operating systems
36257 have a function that permits this action for a non-root effective uid, quite a
36258 number of them do not. Because of this lack of standardization, Exim does not
36259 address this problem at this time.
36260
36261 For this reason, the recommended approach for &"mostly unprivileged"& running
36262 is to keep the Exim binary setuid to root, and to set
36263 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36264 be used in the most straightforward way.
36265
36266 If you configure Exim not to run delivery processes as root, there are a
36267 number of restrictions on what you can do:
36268
36269 .ilist
36270 You can deliver only as the Exim user/group. You should  explicitly use the
36271 &%user%& and &%group%& options to override routers or local transports that
36272 normally deliver as the recipient. This makes sure that configurations that
36273 work in this mode function the same way in normal mode. Any implicit or
36274 explicit specification of another user causes an error.
36275 .next
36276 Use of &_.forward_& files is severely restricted, such that it is usually
36277 not worthwhile to include them in the configuration.
36278 .next
36279 Users who wish to use &_.forward_& would have to make their home directory and
36280 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36281 and their equivalents in Exim filters, cannot be used. While they could be
36282 enabled in the Exim user's name, that would be insecure and not very useful.
36283 .next
36284 Unless the local user mailboxes are all owned by the Exim user (possible in
36285 some POP3 or IMAP-only environments):
36286
36287 .olist
36288 They must be owned by the Exim group and be writeable by that group. This
36289 implies you must set &%mode%& in the appendfile configuration, as well as the
36290 mode of the mailbox files themselves.
36291 .next
36292 You must set &%no_check_owner%&, since most or all of the files will not be
36293 owned by the Exim user.
36294 .next
36295 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36296 on a newly created mailbox when unprivileged. This also implies that new
36297 mailboxes need to be created manually.
36298 .endlist olist
36299 .endlist ilist
36300
36301
36302 These restrictions severely restrict what can be done in local deliveries.
36303 However, there are no restrictions on remote deliveries. If you are running a
36304 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36305 gives more security at essentially no cost.
36306
36307 If you are using the &%mua_wrapper%& facility (see chapter
36308 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36309
36310
36311
36312
36313 .section "Delivering to local files" "SECID271"
36314 Full details of the checks applied by &(appendfile)& before it writes to a file
36315 are given in chapter &<<CHAPappendfile>>&.
36316
36317
36318
36319 .section "Running local commands" "SECTsecconslocalcmds"
36320 .cindex "security" "local commands"
36321 .cindex "security" "command injection attacks"
36322 There are a number of ways in which an administrator can configure Exim to run
36323 commands based upon received, untrustworthy, data. Further, in some
36324 configurations a user who can control a &_.forward_& file can also arrange to
36325 run commands. Configuration to check includes, but is not limited to:
36326
36327 .ilist
36328 Use of &%use_shell%& in the pipe transport: various forms of shell command
36329 injection may be possible with this option present. It is dangerous and should
36330 be used only with considerable caution. Consider constraints which whitelist
36331 allowed characters in a variable which is to be used in a pipe transport that
36332 has &%use_shell%& enabled.
36333 .next
36334 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36335 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36336 &_.forward_& files in a redirect router. If Exim is running on a central mail
36337 hub to which ordinary users do not have shell access, but home directories are
36338 NFS mounted (for instance) then administrators should review the list of these
36339 forbid options available, and should bear in mind that the options that may
36340 need forbidding can change as new features are added between releases.
36341 .next
36342 The &%${run...}%& expansion item does not use a shell by default, but
36343 administrators can configure use of &_/bin/sh_& as part of the command.
36344 Such invocations should be viewed with prejudicial suspicion.
36345 .next
36346 Administrators who use embedded Perl are advised to explore how Perl's
36347 taint checking might apply to their usage.
36348 .next
36349 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36350 administrators are well advised to view its use with suspicion, in case (for
36351 instance) it allows a local-part to contain embedded Exim directives.
36352 .next
36353 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36354 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36355 each can reference arbitrary lists and files, rather than just being a list
36356 of opaque strings.
36357 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36358 real-world security vulnerabilities caused by its use with untrustworthy data
36359 injected in, for SQL injection attacks.
36360 Consider the use of the &%inlisti%& expansion condition instead.
36361 .endlist
36362
36363
36364
36365
36366 .section "Trust in configuration data" "SECTsecconfdata"
36367 .cindex "security" "data sources"
36368 .cindex "security" "regular expressions"
36369 .cindex "regular expressions" "security"
36370 .cindex "PCRE" "security"
36371 If configuration data for Exim can come from untrustworthy sources, there
36372 are some issues to be aware of:
36373
36374 .ilist
36375 Use of &%${expand...}%& may provide a path for shell injection attacks.
36376 .next
36377 Letting untrusted data provide a regular expression is unwise.
36378 .next
36379 Using &%${match...}%& to apply a fixed regular expression against untrusted
36380 data may result in pathological behaviour within PCRE.  Be aware of what
36381 "backtracking" means and consider options for being more strict with a regular
36382 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36383 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36384 possessive quantifiers or just not using regular expressions against untrusted
36385 data.
36386 .next
36387 It can be important to correctly use &%${quote:...}%&,
36388 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36389 items to ensure that data is correctly constructed.
36390 .next
36391 Some lookups might return multiple results, even though normal usage is only
36392 expected to yield one result.
36393 .endlist
36394
36395
36396
36397
36398 .section "IPv4 source routing" "SECID272"
36399 .cindex "source routing" "in IP packets"
36400 .cindex "IP source routing"
36401 Many operating systems suppress IP source-routed packets in the kernel, but
36402 some cannot be made to do this, so Exim does its own check. It logs incoming
36403 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36404 IPv6. No special checking is currently done.
36405
36406
36407
36408 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36409 Support for these SMTP commands is disabled by default. If required, they can
36410 be enabled by defining suitable ACLs.
36411
36412
36413
36414
36415 .section "Privileged users" "SECID274"
36416 .cindex "trusted users"
36417 .cindex "admin user"
36418 .cindex "privileged user"
36419 .cindex "user" "trusted"
36420 .cindex "user" "admin"
36421 Exim recognizes two sets of users with special privileges. Trusted users are
36422 able to submit new messages to Exim locally, but supply their own sender
36423 addresses and information about a sending host. For other users submitting
36424 local messages, Exim sets up the sender address from the uid, and doesn't
36425 permit a remote host to be specified.
36426
36427 .oindex "&%-f%&"
36428 However, an untrusted user is permitted to use the &%-f%& command line option
36429 in the special form &%-f <>%& to indicate that a delivery failure for the
36430 message should not cause an error report. This affects the message's envelope,
36431 but it does not affect the &'Sender:'& header. Untrusted users may also be
36432 permitted to use specific forms of address with the &%-f%& option by setting
36433 the &%untrusted_set_sender%& option.
36434
36435 Trusted users are used to run processes that receive mail messages from some
36436 other mail domain and pass them on to Exim for delivery either locally, or over
36437 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36438 as any user listed in the &%trusted_users%& configuration option, or under any
36439 group listed in the &%trusted_groups%& option.
36440
36441 Admin users are permitted to do things to the messages on Exim's queue. They
36442 can freeze or thaw messages, cause them to be returned to their senders, remove
36443 them entirely, or modify them in various ways. In addition, admin users can run
36444 the Exim monitor and see all the information it is capable of providing, which
36445 includes the contents of files on the spool.
36446
36447 .oindex "&%-M%&"
36448 .oindex "&%-q%&"
36449 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36450 delivery of messages on its queue is restricted to admin users. This
36451 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36452 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36453 queue is also restricted to admin users. This restriction can be relaxed by
36454 setting &%no_queue_list_requires_admin%&.
36455
36456 Exim recognizes an admin user if the calling process is running as root or as
36457 the Exim user or if any of the groups associated with the calling process is
36458 the Exim group. It is not necessary actually to be running under the Exim
36459 group. However, if admin users who are not root or the Exim user are to access
36460 the contents of files on the spool via the Exim monitor (which runs
36461 unprivileged), Exim must be built to allow group read access to its spool
36462 files.
36463
36464
36465
36466 .section "Spool files" "SECID275"
36467 .cindex "spool directory" "files"
36468 Exim's spool directory and everything it contains is owned by the Exim user and
36469 set to the Exim group. The mode for spool files is defined in the
36470 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36471 any user who is a member of the Exim group can access these files.
36472
36473
36474
36475 .section "Use of argv[0]" "SECID276"
36476 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36477 of specific strings, Exim assumes certain options. For example, calling Exim
36478 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36479 to calling it with the option &%-bS%&. There are no security implications in
36480 this.
36481
36482
36483
36484 .section "Use of %f formatting" "SECID277"
36485 The only use made of &"%f"& by Exim is in formatting load average values. These
36486 are actually stored in integer variables as 1000 times the load average.
36487 Consequently, their range is limited and so therefore is the length of the
36488 converted output.
36489
36490
36491
36492 .section "Embedded Exim path" "SECID278"
36493 Exim uses its own path name, which is embedded in the code, only when it needs
36494 to re-exec in order to regain root privilege. Therefore, it is not root when it
36495 does so. If some bug allowed the path to get overwritten, it would lead to an
36496 arbitrary program's being run as exim, not as root.
36497
36498
36499
36500 .section "Dynamic module directory" "SECTdynmoddir"
36501 Any dynamically loadable modules must be installed into the directory
36502 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36503 loading it.
36504
36505
36506 .section "Use of sprintf()" "SECID279"
36507 .cindex "&[sprintf()]&"
36508 A large number of occurrences of &"sprintf"& in the code are actually calls to
36509 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36510 The intermediate formatting is done into a large fixed buffer by a function
36511 that runs through the format string itself, and checks the length of each
36512 conversion before performing it, thus preventing buffer overruns.
36513
36514 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36515 the output buffer is known to be sufficiently long to contain the converted
36516 string.
36517
36518
36519
36520 .section "Use of debug_printf() and log_write()" "SECID280"
36521 Arbitrary strings are passed to both these functions, but they do their
36522 formatting by calling the function &'string_vformat()'&, which runs through
36523 the format string itself, and checks the length of each conversion.
36524
36525
36526
36527 .section "Use of strcat() and strcpy()" "SECID281"
36528 These are used only in cases where the output buffer is known to be large
36529 enough to hold the result.
36530 .ecindex IIDsecurcon
36531
36532
36533
36534
36535 . ////////////////////////////////////////////////////////////////////////////
36536 . ////////////////////////////////////////////////////////////////////////////
36537
36538 .chapter "Format of spool files" "CHAPspool"
36539 .scindex IIDforspo1 "format" "spool files"
36540 .scindex IIDforspo2 "spool directory" "format of files"
36541 .scindex IIDforspo3 "spool files" "format of"
36542 .cindex "spool files" "editing"
36543 A message on Exim's queue consists of two files, whose names are the message id
36544 followed by -D and -H, respectively. The data portion of the message is kept in
36545 the -D file on its own. The message's envelope, status, and headers are all
36546 kept in the -H file, whose format is described in this chapter. Each of these
36547 two files contains the final component of its own name as its first line. This
36548 is insurance against disk crashes where the directory is lost but the files
36549 themselves are recoverable.
36550
36551 Some people are tempted into editing -D files in order to modify messages. You
36552 need to be extremely careful if you do this; it is not recommended and you are
36553 on your own if you do it. Here are some of the pitfalls:
36554
36555 .ilist
36556 You must ensure that Exim does not try to deliver the message while you are
36557 fiddling with it. The safest way is to take out a write lock on the -D file,
36558 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36559 place, the lock will be retained. If you write a new file and rename it, the
36560 lock will be lost at the instant of rename.
36561 .next
36562 .vindex "&$body_linecount$&"
36563 If you change the number of lines in the file, the value of
36564 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36565 present, this value is not used by Exim, but there is no guarantee that this
36566 will always be the case.
36567 .next
36568 If the message is in MIME format, you must take care not to break it.
36569 .next
36570 If the message is cryptographically signed, any change will invalidate the
36571 signature.
36572 .endlist
36573 All in all, modifying -D files is fraught with danger.
36574
36575 Files whose names end with -J may also be seen in the &_input_& directory (or
36576 its subdirectories when &%split_spool_directory%& is set). These are journal
36577 files, used to record addresses to which the message has been delivered during
36578 the course of a delivery attempt. If there are still undelivered recipients at
36579 the end, the -H file is updated, and the -J file is deleted. If, however, there
36580 is some kind of crash (for example, a power outage) before this happens, the -J
36581 file remains in existence. When Exim next processes the message, it notices the
36582 -J file and uses it to update the -H file before starting the next delivery
36583 attempt.
36584
36585 .section "Format of the -H file" "SECID282"
36586 .cindex "uid (user id)" "in spool file"
36587 .cindex "gid (group id)" "in spool file"
36588 The second line of the -H file contains the login name for the uid of the
36589 process that called Exim to read the message, followed by the numerical uid and
36590 gid. For a locally generated message, this is normally the user who sent the
36591 message. For a message received over TCP/IP via the daemon, it is
36592 normally the Exim user.
36593
36594 The third line of the file contains the address of the message's sender as
36595 transmitted in the envelope, contained in angle brackets. The sender address is
36596 empty for bounce messages. For incoming SMTP mail, the sender address is given
36597 in the MAIL command. For locally generated mail, the sender address is
36598 created by Exim from the login name of the current user and the configured
36599 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36600 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36601 &"<>"& or an address that matches &%untrusted_set_senders%&.
36602
36603 The fourth line contains two numbers. The first is the time that the message
36604 was received, in the conventional Unix form &-- the number of seconds since the
36605 start of the epoch. The second number is a count of the number of messages
36606 warning of delayed delivery that have been sent to the sender.
36607
36608 There follow a number of lines starting with a hyphen. These can appear in any
36609 order, and are omitted when not relevant:
36610
36611 .vlist
36612 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36613 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36614 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36615 recognized, to provide backward compatibility. In the old format, a line of
36616 this form is present for every ACL variable that is not empty. The number
36617 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36618 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36619 the data string for the variable. The string itself starts at the beginning of
36620 the next line, and is followed by a newline character. It may contain internal
36621 newlines.
36622
36623 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36624 A line of this form is present for every ACL connection variable that is
36625 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36626 The length is the length of the data string for the variable. The string itself
36627 starts at the beginning of the next line, and is followed by a newline
36628 character. It may contain internal newlines.
36629
36630 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36631 A line of this form is present for every ACL message variable that is defined.
36632 Note that there is a space between &%-aclm%& and the rest of the name. The
36633 length is the length of the data string for the variable. The string itself
36634 starts at the beginning of the next line, and is followed by a newline
36635 character. It may contain internal newlines.
36636
36637 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36638 This is present if, when the message was received over SMTP, the value of
36639 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36640
36641 .vitem &%-allow_unqualified_recipient%&
36642 This is present if unqualified recipient addresses are permitted in header
36643 lines (to stop such addresses from being qualified if rewriting occurs at
36644 transport time). Local messages that were input using &%-bnq%& and remote
36645 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36646
36647 .vitem &%-allow_unqualified_sender%&
36648 This is present if unqualified sender addresses are permitted in header lines
36649 (to stop such addresses from being qualified if rewriting occurs at transport
36650 time). Local messages that were input using &%-bnq%& and remote messages from
36651 hosts that match &%sender_unqualified_hosts%& set this flag.
36652
36653 .vitem "&%-auth_id%&&~<&'text'&>"
36654 The id information for a message received on an authenticated SMTP connection
36655 &-- the value of the &$authenticated_id$& variable.
36656
36657 .vitem "&%-auth_sender%&&~<&'address'&>"
36658 The address of an authenticated sender &-- the value of the
36659 &$authenticated_sender$& variable.
36660
36661 .vitem "&%-body_linecount%&&~<&'number'&>"
36662 This records the number of lines in the body of the message, and is always
36663 present.
36664
36665 .vitem "&%-body_zerocount%&&~<&'number'&>"
36666 This records the number of binary zero bytes in the body of the message, and is
36667 present if the number is greater than zero.
36668
36669 .vitem &%-deliver_firsttime%&
36670 This is written when a new message is first added to the spool. When the spool
36671 file is updated after a deferral, it is omitted.
36672
36673 .vitem "&%-frozen%&&~<&'time'&>"
36674 .cindex "frozen messages" "spool data"
36675 The message is frozen, and the freezing happened at <&'time'&>.
36676
36677 .vitem "&%-helo_name%&&~<&'text'&>"
36678 This records the host name as specified by a remote host in a HELO or EHLO
36679 command.
36680
36681 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36682 This records the IP address of the host from which the message was received and
36683 the remote port number that was used. It is omitted for locally generated
36684 messages.
36685
36686 .vitem "&%-host_auth%&&~<&'text'&>"
36687 If the message was received on an authenticated SMTP connection, this records
36688 the name of the authenticator &-- the value of the
36689 &$sender_host_authenticated$& variable.
36690
36691 .vitem &%-host_lookup_failed%&
36692 This is present if an attempt to look up the sending host's name from its IP
36693 address failed. It corresponds to the &$host_lookup_failed$& variable.
36694
36695 .vitem "&%-host_name%&&~<&'text'&>"
36696 .cindex "reverse DNS lookup"
36697 .cindex "DNS" "reverse lookup"
36698 This records the name of the remote host from which the message was received,
36699 if the host name was looked up from the IP address when the message was being
36700 received. It is not present if no reverse lookup was done.
36701
36702 .vitem "&%-ident%&&~<&'text'&>"
36703 For locally submitted messages, this records the login of the originating user,
36704 unless it was a trusted user and the &%-oMt%& option was used to specify an
36705 ident value. For messages received over TCP/IP, this records the ident string
36706 supplied by the remote host, if any.
36707
36708 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
36709 This records the IP address of the local interface and the port number through
36710 which a message was received from a remote host. It is omitted for locally
36711 generated messages.
36712
36713 .vitem &%-local%&
36714 The message is from a local sender.
36715
36716 .vitem &%-localerror%&
36717 The message is a locally-generated bounce message.
36718
36719 .vitem "&%-local_scan%&&~<&'string'&>"
36720 This records the data string that was returned by the &[local_scan()]& function
36721 when the message was received &-- the value of the &$local_scan_data$&
36722 variable. It is omitted if no data was returned.
36723
36724 .vitem &%-manual_thaw%&
36725 The message was frozen but has been thawed manually, that is, by an explicit
36726 Exim command rather than via the auto-thaw process.
36727
36728 .vitem &%-N%&
36729 A testing delivery process was started using the &%-N%& option to suppress any
36730 actual deliveries, but delivery was deferred. At any further delivery attempts,
36731 &%-N%& is assumed.
36732
36733 .vitem &%-received_protocol%&
36734 This records the value of the &$received_protocol$& variable, which contains
36735 the name of the protocol by which the message was received.
36736
36737 .vitem &%-sender_set_untrusted%&
36738 The envelope sender of this message was set by an untrusted local caller (used
36739 to ensure that the caller is displayed in queue listings).
36740
36741 .vitem "&%-spam_score_int%&&~<&'number'&>"
36742 If a message was scanned by SpamAssassin, this is present. It records the value
36743 of &$spam_score_int$&.
36744
36745 .vitem &%-tls_certificate_verified%&
36746 A TLS certificate was received from the client that sent this message, and the
36747 certificate was verified by the server.
36748
36749 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
36750 When the message was received over an encrypted connection, this records the
36751 name of the cipher suite that was used.
36752
36753 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
36754 When the message was received over an encrypted connection, and a certificate
36755 was received from the client, this records the Distinguished Name from that
36756 certificate.
36757 .endlist
36758
36759 Following the options there is a list of those addresses to which the message
36760 is not to be delivered. This set of addresses is initialized from the command
36761 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
36762 is set; otherwise it starts out empty. Whenever a successful delivery is made,
36763 the address is added to this set. The addresses are kept internally as a
36764 balanced binary tree, and it is a representation of that tree which is written
36765 to the spool file. If an address is expanded via an alias or forward file, the
36766 original address is added to the tree when deliveries to all its child
36767 addresses are complete.
36768
36769 If the tree is empty, there is a single line in the spool file containing just
36770 the text &"XX"&. Otherwise, each line consists of two letters, which are either
36771 Y or N, followed by an address. The address is the value for the node of the
36772 tree, and the letters indicate whether the node has a left branch and/or a
36773 right branch attached to it, respectively. If branches exist, they immediately
36774 follow. Here is an example of a three-node tree:
36775 .code
36776 YY darcy@austen.fict.example
36777 NN alice@wonderland.fict.example
36778 NN editor@thesaurus.ref.example
36779 .endd
36780 After the non-recipients tree, there is a list of the message's recipients.
36781 This is a simple list, preceded by a count. It includes all the original
36782 recipients of the message, including those to whom the message has already been
36783 delivered. In the simplest case, the list contains one address per line. For
36784 example:
36785 .code
36786 4
36787 editor@thesaurus.ref.example
36788 darcy@austen.fict.example
36789 rdo@foundation
36790 alice@wonderland.fict.example
36791 .endd
36792 However, when a child address has been added to the top-level addresses as a
36793 result of the use of the &%one_time%& option on a &(redirect)& router, each
36794 line is of the following form:
36795 .display
36796 <&'top-level address'&> <&'errors_to address'&> &&&
36797   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
36798 .endd
36799 The 01 flag bit indicates the presence of the three other fields that follow
36800 the top-level address. Other bits may be used in future to support additional
36801 fields. The <&'parent number'&> is the offset in the recipients list of the
36802 original parent of the &"one time"& address. The first two fields are the
36803 envelope sender that is associated with this address and its length. If the
36804 length is zero, there is no special envelope sender (there are then two space
36805 characters in the line). A non-empty field can arise from a &(redirect)& router
36806 that has an &%errors_to%& setting.
36807
36808
36809 A blank line separates the envelope and status information from the headers
36810 which follow. A header may occupy several lines of the file, and to save effort
36811 when reading it in, each header is preceded by a number and an identifying
36812 character. The number is the number of characters in the header, including any
36813 embedded newlines and the terminating newline. The character is one of the
36814 following:
36815
36816 .table2 50pt
36817 .row <&'blank'&>         "header in which Exim has no special interest"
36818 .row &`B`&               "&'Bcc:'& header"
36819 .row &`C`&               "&'Cc:'& header"
36820 .row &`F`&               "&'From:'& header"
36821 .row &`I`&               "&'Message-id:'& header"
36822 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
36823 .row &`R`&               "&'Reply-To:'& header"
36824 .row &`S`&               "&'Sender:'& header"
36825 .row &`T`&               "&'To:'& header"
36826 .row &`*`&               "replaced or deleted header"
36827 .endtable
36828
36829 Deleted or replaced (rewritten) headers remain in the spool file for debugging
36830 purposes. They are not transmitted when the message is delivered. Here is a
36831 typical set of headers:
36832 .code
36833 111P Received: by hobbit.fict.example with local (Exim 4.00)
36834 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
36835 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
36836 038* X-rewrote-sender: bb@hobbit.fict.example
36837 042* From: Bilbo Baggins <bb@hobbit.fict.example>
36838 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
36839 099* To: alice@wonderland.fict.example, rdo@foundation,
36840 darcy@austen.fict.example, editor@thesaurus.ref.example
36841 104T To: alice@wonderland.fict.example, rdo@foundation.example,
36842 darcy@austen.fict.example, editor@thesaurus.ref.example
36843 038  Date: Fri, 11 May 2001 10:28:59 +0100
36844 .endd
36845 The asterisked headers indicate that the envelope sender, &'From:'& header, and
36846 &'To:'& header have been rewritten, the last one because routing expanded the
36847 unqualified domain &'foundation'&.
36848 .ecindex IIDforspo1
36849 .ecindex IIDforspo2
36850 .ecindex IIDforspo3
36851
36852 . ////////////////////////////////////////////////////////////////////////////
36853 . ////////////////////////////////////////////////////////////////////////////
36854
36855 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
36856          "DKIM Support"
36857 .cindex "DKIM"
36858
36859 DKIM is a mechanism by which messages sent by some entity can be provably
36860 linked to a domain which that entity controls.  It permits reputation to
36861 be tracked on a per-domain basis, rather than merely upon source IP address.
36862 DKIM is documented in RFC 4871.
36863
36864 Since version 4.70, DKIM support is compiled into Exim by default. It can be
36865 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
36866
36867 Exim's DKIM implementation allows to
36868 .olist
36869 Sign outgoing messages: This function is implemented in the SMTP transport.
36870 It can co-exist with all other Exim features
36871 (including transport filters)
36872 except cutthrough delivery.
36873 .next
36874 Verify signatures in incoming messages: This is implemented by an additional
36875 ACL (acl_smtp_dkim), which can be called several times per message, with
36876 different signature contexts.
36877 .endlist
36878
36879 In typical Exim style, the verification implementation does not include any
36880 default "policy". Instead it enables you to build your own policy using
36881 Exim's standard controls.
36882
36883 Please note that verification of DKIM signatures in incoming mail is turned
36884 on by default for logging purposes. For each signature in incoming email,
36885 exim will log a line displaying the most important signature details, and the
36886 signature status. Here is an example (with line-breaks added for clarity):
36887 .code
36888 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
36889     d=facebookmail.com s=q1-2009b
36890     c=relaxed/relaxed a=rsa-sha1
36891     i=@facebookmail.com t=1252484542 [verification succeeded]
36892 .endd
36893 You might want to turn off DKIM verification processing entirely for internal
36894 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
36895 control modifier. This should typically be done in the RCPT ACL, at points
36896 where you accept mail from relay sources (internal hosts or authenticated
36897 senders).
36898
36899
36900 .section "Signing outgoing messages" "SECID513"
36901 .cindex "DKIM" "signing"
36902
36903 Signing is implemented by setting private options on the SMTP transport.
36904 These options take (expandable) strings as arguments.
36905
36906 .option dkim_domain smtp string&!! unset
36907 MANDATORY:
36908 The domain you want to sign with. The result of this expanded
36909 option is put into the &%$dkim_domain%& expansion variable.
36910
36911 .option dkim_selector smtp string&!! unset
36912 MANDATORY:
36913 This sets the key selector string. You can use the &%$dkim_domain%& expansion
36914 variable to look up a matching selector. The result is put in the expansion
36915 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
36916 option along with &%$dkim_domain%&.
36917
36918 .option dkim_private_key smtp string&!! unset
36919 MANDATORY:
36920 This sets the private key to use. You can use the &%$dkim_domain%& and
36921 &%$dkim_selector%& expansion variables to determine the private key to use.
36922 The result can either
36923 .ilist
36924 be a valid RSA private key in ASCII armor, including line breaks.
36925 .next
36926 start with a slash, in which case it is treated as a file that contains
36927 the private key.
36928 .next
36929 be "0", "false" or the empty string, in which case the message will not
36930 be signed. This case will not result in an error, even if &%dkim_strict%&
36931 is set.
36932 .endlist
36933
36934 .option dkim_canon smtp string&!! unset
36935 OPTIONAL:
36936 This option sets the canonicalization method used when signing a message.
36937 The DKIM RFC currently supports two methods: "simple" and "relaxed".
36938 The option defaults to "relaxed" when unset. Note: the current implementation
36939 only supports using the same canonicalization method for both headers and body.
36940
36941 .option dkim_strict smtp string&!! unset
36942 OPTIONAL:
36943 This  option  defines  how  Exim  behaves  when  signing a message that
36944 should be signed fails for some reason.  When the expansion evaluates to
36945 either "1" or "true", Exim will defer. Otherwise Exim will send the message
36946 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
36947 variables here.
36948
36949 .option dkim_sign_headers smtp string&!! unset
36950 OPTIONAL:
36951 When set, this option must expand to (or be specified as) a colon-separated
36952 list of header names. Headers with these names will be included in the message
36953 signature. When unspecified, the header names recommended in RFC4871 will be
36954 used.
36955
36956
36957 .section "Verifying DKIM signatures in incoming mail" "SECID514"
36958 .cindex "DKIM" "verification"
36959
36960 Verification of DKIM signatures in incoming email is implemented via the
36961 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
36962 syntactically(!) correct signature in the incoming message.
36963 A missing ACL definition defaults to accept.
36964 If any ACL call does not acccept, the message is not accepted.
36965 If a cutthrough delivery was in progress for the message it is
36966 summarily dropped (having wasted the transmission effort).
36967
36968 To evaluate the signature in the ACL a large number of expansion variables
36969 containing the signature status and its details are set up during the
36970 runtime of the ACL.
36971
36972 Calling the ACL only for existing signatures is not sufficient to build
36973 more advanced policies. For that reason, the global option
36974 &%dkim_verify_signers%&, and a global expansion variable
36975 &%$dkim_signers%& exist.
36976
36977 The global option &%dkim_verify_signers%& can be set to a colon-separated
36978 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
36979 called. It is expanded when the message has been received. At this point,
36980 the expansion variable &%$dkim_signers%& already contains a colon-separated
36981 list of signer domains and identities for the message. When
36982 &%dkim_verify_signers%& is not specified in the main configuration,
36983 it defaults as:
36984 .code
36985 dkim_verify_signers = $dkim_signers
36986 .endd
36987 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
36988 DKIM signature in the message. Current DKIM verifiers may want to explicitly
36989 call the ACL for known domains or identities. This would be achieved as follows:
36990 .code
36991 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
36992 .endd
36993 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
36994 and "ebay.com", plus all domains and identities that have signatures in the message.
36995 You can also be more creative in constructing your policy. For example:
36996 .code
36997 dkim_verify_signers = $sender_address_domain:$dkim_signers
36998 .endd
36999
37000 If a domain or identity is listed several times in the (expanded) value of
37001 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37002
37003
37004 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37005 available (from most to least important):
37006
37007
37008 .vlist
37009 .vitem &%$dkim_cur_signer%&
37010 The signer that is being evaluated in this ACL run. This can be a domain or
37011 an identity. This is one of the list items from the expanded main option
37012 &%dkim_verify_signers%& (see above).
37013 .vitem &%$dkim_verify_status%&
37014 A string describing the general status of the signature. One of
37015 .ilist
37016 &%none%&: There is no signature in the message for the current domain or
37017 identity (as reflected by &%$dkim_cur_signer%&).
37018 .next
37019 &%invalid%&: The signature could not be verified due to a processing error.
37020 More detail is available in &%$dkim_verify_reason%&.
37021 .next
37022 &%fail%&: Verification of the signature failed.  More detail is
37023 available in &%$dkim_verify_reason%&.
37024 .next
37025 &%pass%&: The signature passed verification. It is valid.
37026 .endlist
37027 .vitem &%$dkim_verify_reason%&
37028 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37029 "fail" or "invalid". One of
37030 .ilist
37031 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37032 key for the domain could not be retrieved. This may be a temporary problem.
37033 .next
37034 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37035 record for the domain is syntactically invalid.
37036 .next
37037 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37038 body hash does not match the one specified in the signature header. This
37039 means that the message body was modified in transit.
37040 .next
37041 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37042 could not be verified. This may mean that headers were modified,
37043 re-written or otherwise changed in a way which is incompatible with
37044 DKIM verification. It may of course also mean that the signature is forged.
37045 .endlist
37046 .vitem &%$dkim_domain%&
37047 The signing domain. IMPORTANT: This variable is only populated if there is
37048 an actual signature in the message for the current domain or identity (as
37049 reflected by &%$dkim_cur_signer%&).
37050 .vitem &%$dkim_identity%&
37051 The signing identity, if present. IMPORTANT: This variable is only populated
37052 if there is an actual signature in the message for the current domain or
37053 identity (as reflected by &%$dkim_cur_signer%&).
37054 .vitem &%$dkim_selector%&
37055 The key record selector string.
37056 .vitem &%$dkim_algo%&
37057 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37058 .vitem &%$dkim_canon_body%&
37059 The body canonicalization method. One of 'relaxed' or 'simple'.
37060 .vitem &%dkim_canon_headers%&
37061 The header canonicalization method. One of 'relaxed' or 'simple'.
37062 .vitem &%$dkim_copiedheaders%&
37063 A transcript of headers and their values which are included in the signature
37064 (copied from the 'z=' tag of the signature).
37065 .vitem &%$dkim_bodylength%&
37066 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37067 limit was set by the signer, "9999999999999" is returned. This makes sure
37068 that this variable always expands to an integer value.
37069 .vitem &%$dkim_created%&
37070 UNIX timestamp reflecting the date and time when the signature was created.
37071 When this was not specified by the signer, "0" is returned.
37072 .vitem &%$dkim_expires%&
37073 UNIX timestamp reflecting the date and time when the signer wants the
37074 signature to be treated as "expired". When this was not specified by the
37075 signer, "9999999999999" is returned. This makes it possible to do useful
37076 integer size comparisons against this value.
37077 .vitem &%$dkim_headernames%&
37078 A colon-separated list of names of headers included in the signature.
37079 .vitem &%$dkim_key_testing%&
37080 "1" if the key record has the "testing" flag set, "0" if not.
37081 .vitem &%$dkim_key_nosubdomains%&
37082 "1" if the key record forbids subdomaining, "0" otherwise.
37083 .vitem &%$dkim_key_srvtype%&
37084 Service type (tag s=) from the key record. Defaults to "*" if not specified
37085 in the key record.
37086 .vitem &%$dkim_key_granularity%&
37087 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37088 in the key record.
37089 .vitem &%$dkim_key_notes%&
37090 Notes from the key record (tag n=).
37091 .endlist
37092
37093 In addition, two ACL conditions are provided:
37094
37095 .vlist
37096 .vitem &%dkim_signers%&
37097 ACL condition that checks a colon-separated list of domains or identities
37098 for a match against the domain or identity that the ACL is currently verifying
37099 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37100 verb to a group of domains or identities. For example:
37101
37102 .code
37103 # Warn when Mail purportedly from GMail has no signature at all
37104 warn log_message = GMail sender without DKIM signature
37105      sender_domains = gmail.com
37106      dkim_signers = gmail.com
37107      dkim_status = none
37108 .endd
37109
37110 .vitem &%dkim_status%&
37111 ACL condition that checks a colon-separated list of possible DKIM verification
37112 results against the actual result of verification. This is typically used
37113 to restrict an ACL verb to a list of verification outcomes, for example:
37114
37115 .code
37116 deny message = Mail from Paypal with invalid/missing signature
37117      sender_domains = paypal.com:paypal.de
37118      dkim_signers = paypal.com:paypal.de
37119      dkim_status = none:invalid:fail
37120 .endd
37121
37122 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37123 see the documentation of the &%$dkim_verify_status%& expansion variable above
37124 for more information of what they mean.
37125 .endlist
37126
37127 . ////////////////////////////////////////////////////////////////////////////
37128 . ////////////////////////////////////////////////////////////////////////////
37129
37130 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37131          "Adding drivers or lookups"
37132 .cindex "adding drivers"
37133 .cindex "new drivers, adding"
37134 .cindex "drivers" "adding new"
37135 The following actions have to be taken in order to add a new router, transport,
37136 authenticator, or lookup type to Exim:
37137
37138 .olist
37139 Choose a name for the driver or lookup type that does not conflict with any
37140 existing name; I will use &"newdriver"& in what follows.
37141 .next
37142 Add to &_src/EDITME_& the line:
37143 .display
37144 <&'type'&>&`_NEWDRIVER=yes`&
37145 .endd
37146 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37147 code is not to be included in the binary by default, comment this line out. You
37148 should also add any relevant comments about the driver or lookup type.
37149 .next
37150 Add to &_src/config.h.defaults_& the line:
37151 .code
37152 #define <type>_NEWDRIVER
37153 .endd
37154 .next
37155 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37156 and create a table entry as is done for all the other drivers and lookup types.
37157 .next
37158 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37159 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37160 Add your &`NEWDRIVER`& to that list.
37161 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37162 simple form that most lookups have.
37163 .next
37164 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37165 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37166 driver or lookup type and add it to the definition of OBJ.
37167 .next
37168 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37169 &_src_&.
37170 .next
37171 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37172 as for other drivers and lookups.
37173 .endlist
37174
37175 Then all you need to do is write the code! A good way to start is to make a
37176 proforma by copying an existing module of the same type, globally changing all
37177 occurrences of the name, and cutting out most of the code. Note that any
37178 options you create must be listed in alphabetical order, because the tables are
37179 searched using a binary chop procedure.
37180
37181 There is a &_README_& file in each of the sub-directories of &_src_& describing
37182 the interface that is expected.
37183
37184
37185
37186
37187 . ////////////////////////////////////////////////////////////////////////////
37188 . ////////////////////////////////////////////////////////////////////////////
37189
37190 . /////////////////////////////////////////////////////////////////////////////
37191 . These lines are processing instructions for the Simple DocBook Processor that
37192 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37193 . PDFs than using xmlto and fop. They will be ignored by all other XML
37194 . processors.
37195 . /////////////////////////////////////////////////////////////////////////////
37196
37197 .literal xml
37198 <?sdop
37199   format="newpage"
37200   foot_right_recto="&chaptertitle;"
37201   foot_right_verso="&chaptertitle;"
37202 ?>
37203 .literal off
37204
37205 .makeindex "Options index"   "option"
37206 .makeindex "Variables index" "variable"
37207 .makeindex "Concept index"   "concept"
37208
37209
37210 . /////////////////////////////////////////////////////////////////////////////
37211 . /////////////////////////////////////////////////////////////////////////////