Filter xfpt needs new macro too
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.80"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2012
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 .new
543 The distributions will be PGP signed by an individual key of the Release
544 Coordinator.  This key will have a uid containing an email address in the
545 &'exim.org'& domain and will have signatures from other people, including
546 other Exim maintainers.  We expect that the key will be in the "strong set" of
547 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
548 PGP key, a version of which can be found in the release directory in the file
549 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
550 such as &'pool.sks-keyservers.net'&.
551
552 At time of last update, releases were being made by Phil Pennock and signed with
553 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
554 A trust path from Nigel's key to Phil's can be observed at
555 &url(https://www.security.spodhuis.org/exim-trustpath).
556 .wen
557
558 The signatures for the tar bundles are in:
559 .display
560 &_exim-n.nn.tar.gz.asc_&
561 &_exim-n.nn.tar.bz2.asc_&
562 .endd
563 For each released version, the log of changes is made separately available in a
564 separate file in the directory &_ChangeLogs_& so that it is possible to
565 find out what has changed without having to download the entire distribution.
566
567 .cindex "documentation" "available formats"
568 The main distribution contains ASCII versions of this specification and other
569 documentation; other formats of the documents are available in separate files
570 inside the &_exim4_& directory of the FTP site:
571 .display
572 &_exim-html-n.nn.tar.gz_&
573 &_exim-pdf-n.nn.tar.gz_&
574 &_exim-postscript-n.nn.tar.gz_&
575 &_exim-texinfo-n.nn.tar.gz_&
576 .endd
577 These tar files contain only the &_doc_& directory, not the complete
578 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
579
580
581 .section "Limitations" "SECID6"
582 .ilist
583 .cindex "limitations of Exim"
584 .cindex "bang paths" "not handled by Exim"
585 Exim is designed for use as an Internet MTA, and therefore handles addresses in
586 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
587 simple two-component bang paths can be converted by a straightforward rewriting
588 configuration. This restriction does not prevent Exim from being interfaced to
589 UUCP as a transport mechanism, provided that domain addresses are used.
590 .next
591 .cindex "domainless addresses"
592 .cindex "address" "without domain"
593 Exim insists that every address it handles has a domain attached. For incoming
594 local messages, domainless addresses are automatically qualified with a
595 configured domain value. Configuration options specify from which remote
596 systems unqualified addresses are acceptable. These are then qualified on
597 arrival.
598 .next
599 .cindex "transport" "external"
600 .cindex "external transports"
601 The only external transport mechanisms that are currently implemented are SMTP
602 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
603 transport is available, and there are facilities for writing messages to files
604 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
605 to send messages to other transport mechanisms such as UUCP, provided they can
606 handle domain-style addresses. Batched SMTP input is also catered for.
607 .next
608 Exim is not designed for storing mail for dial-in hosts. When the volumes of
609 such mail are large, it is better to get the messages &"delivered"& into files
610 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
611 other means.
612 .next
613 Although Exim does have basic facilities for scanning incoming messages, these
614 are not comprehensive enough to do full virus or spam scanning. Such operations
615 are best carried out using additional specialized software packages. If you
616 compile Exim with the content-scanning extension, straightforward interfaces to
617 a number of common scanners are provided.
618 .endlist
619
620
621 .section "Run time configuration" "SECID7"
622 Exim's run time configuration is held in a single text file that is divided
623 into a number of sections. The entries in this file consist of keywords and
624 values, in the style of Smail 3 configuration files. A default configuration
625 file which is suitable for simple online installations is provided in the
626 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
627
628
629 .section "Calling interface" "SECID8"
630 .cindex "Sendmail compatibility" "command line interface"
631 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
632 can be a straight replacement for &_/usr/lib/sendmail_& or
633 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
634 about Sendmail in order to run Exim. For actions other than sending messages,
635 Sendmail-compatible options also exist, but those that produce output (for
636 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
637 format. There are also some additional options that are compatible with Smail
638 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
639 documents all Exim's command line options. This information is automatically
640 made into the man page that forms part of the Exim distribution.
641
642 Control of messages on the queue can be done via certain privileged command
643 line options. There is also an optional monitor program called &'eximon'&,
644 which displays current information in an X window, and which contains a menu
645 interface to Exim's command line administration options.
646
647
648
649 .section "Terminology" "SECID9"
650 .cindex "terminology definitions"
651 .cindex "body of message" "definition of"
652 The &'body'& of a message is the actual data that the sender wants to transmit.
653 It is the last part of a message, and is separated from the &'header'& (see
654 below) by a blank line.
655
656 .cindex "bounce message" "definition of"
657 When a message cannot be delivered, it is normally returned to the sender in a
658 delivery failure message or a &"non-delivery report"& (NDR). The term
659 &'bounce'& is commonly used for this action, and the error reports are often
660 called &'bounce messages'&. This is a convenient shorthand for &"delivery
661 failure error report"&. Such messages have an empty sender address in the
662 message's &'envelope'& (see below) to ensure that they cannot themselves give
663 rise to further bounce messages.
664
665 The term &'default'& appears frequently in this manual. It is used to qualify a
666 value which is used in the absence of any setting in the configuration. It may
667 also qualify an action which is taken unless a configuration setting specifies
668 otherwise.
669
670 The term &'defer'& is used when the delivery of a message to a specific
671 destination cannot immediately take place for some reason (a remote host may be
672 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
673 until a later time.
674
675 The word &'domain'& is sometimes used to mean all but the first component of a
676 host's name. It is &'not'& used in that sense here, where it normally refers to
677 the part of an email address following the @ sign.
678
679 .cindex "envelope, definition of"
680 .cindex "sender" "definition of"
681 A message in transit has an associated &'envelope'&, as well as a header and a
682 body. The envelope contains a sender address (to which bounce messages should
683 be delivered), and any number of recipient addresses. References to the
684 sender or the recipients of a message usually mean the addresses in the
685 envelope. An MTA uses these addresses for delivery, and for returning bounce
686 messages, not the addresses that appear in the header lines.
687
688 .cindex "message" "header, definition of"
689 .cindex "header section" "definition of"
690 The &'header'& of a message is the first part of a message's text, consisting
691 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
692 &'Subject:'&, etc. Long header lines can be split over several text lines by
693 indenting the continuations. The header is separated from the body by a blank
694 line.
695
696 .cindex "local part" "definition of"
697 .cindex "domain" "definition of"
698 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
699 part of an email address that precedes the @ sign. The part that follows the
700 @ sign is called the &'domain'& or &'mail domain'&.
701
702 .cindex "local delivery" "definition of"
703 .cindex "remote delivery, definition of"
704 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
705 delivery to a file or a pipe on the local host from delivery by SMTP over
706 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
707 host it is running on are &'remote'&.
708
709 .cindex "return path" "definition of"
710 &'Return path'& is another name that is used for the sender address in a
711 message's envelope.
712
713 .cindex "queue" "definition of"
714 The term &'queue'& is used to refer to the set of messages awaiting delivery,
715 because this term is in widespread use in the context of MTAs. However, in
716 Exim's case the reality is more like a pool than a queue, because there is
717 normally no ordering of waiting messages.
718
719 .cindex "queue runner" "definition of"
720 The term &'queue runner'& is used to describe a process that scans the queue
721 and attempts to deliver those messages whose retry times have come. This term
722 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
723 the waiting messages are normally processed in an unpredictable order.
724
725 .cindex "spool directory" "definition of"
726 The term &'spool directory'& is used for a directory in which Exim keeps the
727 messages on its queue &-- that is, those that it is in the process of
728 delivering. This should not be confused with the directory in which local
729 mailboxes are stored, which is called a &"spool directory"& by some people. In
730 the Exim documentation, &"spool"& is always used in the first sense.
731
732
733
734
735
736
737 . ////////////////////////////////////////////////////////////////////////////
738 . ////////////////////////////////////////////////////////////////////////////
739
740 .chapter "Incorporated code" "CHID2"
741 .cindex "incorporated code"
742 .cindex "regular expressions" "library"
743 .cindex "PCRE"
744 .cindex "OpenDMARC"
745 A number of pieces of external code are included in the Exim distribution.
746
747 .ilist
748 Regular expressions are supported in the main Exim program and in the
749 Exim monitor using the freely-distributable PCRE library, copyright
750 &copy; University of Cambridge. The source to PCRE is no longer shipped with
751 Exim, so you will need to use the version of PCRE shipped with your system,
752 or obtain and install the full version of the library from
753 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
754 .next
755 .cindex "cdb" "acknowledgment"
756 Support for the cdb (Constant DataBase) lookup method is provided by code
757 contributed by Nigel Metheringham of (at the time he contributed it) Planet
758 Online Ltd. The implementation is completely contained within the code of Exim.
759 It does not link against an external cdb library. The code contains the
760 following statements:
761
762 .blockquote
763 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
764
765 This program is free software; you can redistribute it and/or modify it under
766 the terms of the GNU General Public License as published by the Free Software
767 Foundation; either version 2 of the License, or (at your option) any later
768 version.
769 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
770 the spec and sample code for cdb can be obtained from
771 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
772 some code from Dan Bernstein's implementation (which has no license
773 restrictions applied to it).
774 .endblockquote
775 .next
776 .cindex "SPA authentication"
777 .cindex "Samba project"
778 .cindex "Microsoft Secure Password Authentication"
779 Client support for Microsoft's &'Secure Password Authentication'& is provided
780 by code contributed by Marc Prud'hommeaux. Server support was contributed by
781 Tom Kistner. This includes code taken from the Samba project, which is released
782 under the Gnu GPL.
783 .next
784 .cindex "Cyrus"
785 .cindex "&'pwcheck'& daemon"
786 .cindex "&'pwauthd'& daemon"
787 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
788 by code taken from the Cyrus-SASL library and adapted by Alexander S.
789 Sabourenkov. The permission notice appears below, in accordance with the
790 conditions expressed therein.
791
792 .blockquote
793 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
794
795 Redistribution and use in source and binary forms, with or without
796 modification, are permitted provided that the following conditions
797 are met:
798
799 .olist
800 Redistributions of source code must retain the above copyright
801 notice, this list of conditions and the following disclaimer.
802 .next
803 Redistributions in binary form must reproduce the above copyright
804 notice, this list of conditions and the following disclaimer in
805 the documentation and/or other materials provided with the
806 distribution.
807 .next
808 The name &"Carnegie Mellon University"& must not be used to
809 endorse or promote products derived from this software without
810 prior written permission. For permission or any other legal
811 details, please contact
812 .display
813               Office of Technology Transfer
814               Carnegie Mellon University
815               5000 Forbes Avenue
816               Pittsburgh, PA  15213-3890
817               (412) 268-4387, fax: (412) 268-7395
818               tech-transfer@andrew.cmu.edu
819 .endd
820 .next
821 Redistributions of any form whatsoever must retain the following
822 acknowledgment:
823
824 &"This product includes software developed by Computing Services
825 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
826
827 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
828 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
829 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
830 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
831 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
832 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
833 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
834 .endlist
835 .endblockquote
836
837 .next
838 .cindex "Exim monitor" "acknowledgment"
839 .cindex "X-windows"
840 .cindex "Athena"
841 The Exim Monitor program, which is an X-Window application, includes
842 modified versions of the Athena StripChart and TextPop widgets.
843 This code is copyright by DEC and MIT, and their permission notice appears
844 below, in accordance with the conditions expressed therein.
845
846 .blockquote
847 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
848 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
849
850 All Rights Reserved
851
852 Permission to use, copy, modify, and distribute this software and its
853 documentation for any purpose and without fee is hereby granted,
854 provided that the above copyright notice appear in all copies and that
855 both that copyright notice and this permission notice appear in
856 supporting documentation, and that the names of Digital or MIT not be
857 used in advertising or publicity pertaining to distribution of the
858 software without specific, written prior permission.
859
860 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
861 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
862 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
863 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
864 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
865 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
866 SOFTWARE.
867 .endblockquote
868
869 .next
870 .cindex "opendmarc" "acknowledgment"
871 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
872 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
873 derived code are indicated in the respective source files. The full OpenDMARC
874 license is provided in the LICENSE.opendmarc file contained in the distributed
875 source code.
876
877 .next
878 Many people have contributed code fragments, some large, some small, that were
879 not covered by any specific licence requirements. It is assumed that the
880 contributors are happy to see their code incorporated into Exim under the GPL.
881 .endlist
882
883
884
885
886
887 . ////////////////////////////////////////////////////////////////////////////
888 . ////////////////////////////////////////////////////////////////////////////
889
890 .chapter "How Exim receives and delivers mail" "CHID11" &&&
891          "Receiving and delivering mail"
892
893
894 .section "Overall philosophy" "SECID10"
895 .cindex "design philosophy"
896 Exim is designed to work efficiently on systems that are permanently connected
897 to the Internet and are handling a general mix of mail. In such circumstances,
898 most messages can be delivered immediately. Consequently, Exim does not
899 maintain independent queues of messages for specific domains or hosts, though
900 it does try to send several messages in a single SMTP connection after a host
901 has been down, and it also maintains per-host retry information.
902
903
904 .section "Policy control" "SECID11"
905 .cindex "policy control" "overview"
906 Policy controls are now an important feature of MTAs that are connected to the
907 Internet. Perhaps their most important job is to stop MTAs being abused as
908 &"open relays"& by misguided individuals who send out vast amounts of
909 unsolicited junk, and want to disguise its source. Exim provides flexible
910 facilities for specifying policy controls on incoming mail:
911
912 .ilist
913 .cindex "&ACL;" "introduction"
914 Exim 4 (unlike previous versions of Exim) implements policy controls on
915 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
916 series of statements that may either grant or deny access. ACLs can be used at
917 several places in the SMTP dialogue while receiving a message from a remote
918 host. However, the most common places are after each RCPT command, and at the
919 very end of the message. The sysadmin can specify conditions for accepting or
920 rejecting individual recipients or the entire message, respectively, at these
921 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
922 error code.
923 .next
924 An ACL is also available for locally generated, non-SMTP messages. In this
925 case, the only available actions are to accept or deny the entire message.
926 .next
927 When Exim is compiled with the content-scanning extension, facilities are
928 provided in the ACL mechanism for passing the message to external virus and/or
929 spam scanning software. The result of such a scan is passed back to the ACL,
930 which can then use it to decide what to do with the message.
931 .next
932 When a message has been received, either from a remote host or from the local
933 host, but before the final acknowledgment has been sent, a locally supplied C
934 function called &[local_scan()]& can be run to inspect the message and decide
935 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
936 is accepted, the list of recipients can be modified by the function.
937 .next
938 Using the &[local_scan()]& mechanism is another way of calling external scanner
939 software. The &%SA-Exim%& add-on package works this way. It does not require
940 Exim to be compiled with the content-scanning extension.
941 .next
942 After a message has been accepted, a further checking mechanism is available in
943 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
944 runs at the start of every delivery process.
945 .endlist
946
947
948
949 .section "User filters" "SECID12"
950 .cindex "filter" "introduction"
951 .cindex "Sieve filter"
952 In a conventional Exim configuration, users are able to run private filters by
953 setting up appropriate &_.forward_& files in their home directories. See
954 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
955 configuration needed to support this, and the separate document entitled
956 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
957 of filtering are available:
958
959 .ilist
960 Sieve filters are written in the standard filtering language that is defined
961 by RFC 3028.
962 .next
963 Exim filters are written in a syntax that is unique to Exim, but which is more
964 powerful than Sieve, which it pre-dates.
965 .endlist
966
967 User filters are run as part of the routing process, described below.
968
969
970
971 .section "Message identification" "SECTmessiden"
972 .cindex "message ids" "details of format"
973 .cindex "format" "of message id"
974 .cindex "id of message"
975 .cindex "base62"
976 .cindex "base36"
977 .cindex "Darwin"
978 .cindex "Cygwin"
979 Every message handled by Exim is given a &'message id'& which is sixteen
980 characters long. It is divided into three parts, separated by hyphens, for
981 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
982 normally encoding numbers in base 62. However, in the Darwin operating
983 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
984 (avoiding the use of lower case letters) is used instead, because the message
985 id is used to construct file names, and the names of files in those systems are
986 not always case-sensitive.
987
988 .cindex "pid (process id)" "re-use of"
989 The detail of the contents of the message id have changed as Exim has evolved.
990 Earlier versions relied on the operating system not re-using a process id (pid)
991 within one second. On modern operating systems, this assumption can no longer
992 be made, so the algorithm had to be changed. To retain backward compatibility,
993 the format of the message id was retained, which is why the following rules are
994 somewhat eccentric:
995
996 .ilist
997 The first six characters of the message id are the time at which the message
998 started to be received, to a granularity of one second. That is, this field
999 contains the number of seconds since the start of the epoch (the normal Unix
1000 way of representing the date and time of day).
1001 .next
1002 After the first hyphen, the next six characters are the id of the process that
1003 received the message.
1004 .next
1005 There are two different possibilities for the final two characters:
1006 .olist
1007 .oindex "&%localhost_number%&"
1008 If &%localhost_number%& is not set, this value is the fractional part of the
1009 time of reception, normally in units of 1/2000 of a second, but for systems
1010 that must use base 36 instead of base 62 (because of case-insensitive file
1011 systems), the units are 1/1000 of a second.
1012 .next
1013 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1014 the fractional part of the time, which in this case is in units of 1/200
1015 (1/100) of a second.
1016 .endlist
1017 .endlist
1018
1019 After a message has been received, Exim waits for the clock to tick at the
1020 appropriate resolution before proceeding, so that if another message is
1021 received by the same process, or by another process with the same (re-used)
1022 pid, it is guaranteed that the time will be different. In most cases, the clock
1023 will already have ticked while the message was being received.
1024
1025
1026 .section "Receiving mail" "SECID13"
1027 .cindex "receiving mail"
1028 .cindex "message" "reception"
1029 The only way Exim can receive mail from another host is using SMTP over
1030 TCP/IP, in which case the sender and recipient addresses are transferred using
1031 SMTP commands. However, from a locally running process (such as a user's MUA),
1032 there are several possibilities:
1033
1034 .ilist
1035 If the process runs Exim with the &%-bm%& option, the message is read
1036 non-interactively (usually via a pipe), with the recipients taken from the
1037 command line, or from the body of the message if &%-t%& is also used.
1038 .next
1039 If the process runs Exim with the &%-bS%& option, the message is also read
1040 non-interactively, but in this case the recipients are listed at the start of
1041 the message in a series of SMTP RCPT commands, terminated by a DATA
1042 command. This is so-called &"batch SMTP"& format,
1043 but it isn't really SMTP. The SMTP commands are just another way of passing
1044 envelope addresses in a non-interactive submission.
1045 .next
1046 If the process runs Exim with the &%-bs%& option, the message is read
1047 interactively, using the SMTP protocol. A two-way pipe is normally used for
1048 passing data between the local process and the Exim process.
1049 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1050 example, the ACLs for SMTP commands are used for this form of submission.
1051 .next
1052 A local process may also make a TCP/IP call to the host's loopback address
1053 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1054 does not treat the loopback address specially. It treats all such connections
1055 in the same way as connections from other hosts.
1056 .endlist
1057
1058
1059 .cindex "message sender, constructed by Exim"
1060 .cindex "sender" "constructed by Exim"
1061 In the three cases that do not involve TCP/IP, the sender address is
1062 constructed from the login name of the user that called Exim and a default
1063 qualification domain (which can be set by the &%qualify_domain%& configuration
1064 option). For local or batch SMTP, a sender address that is passed using the
1065 SMTP MAIL command is ignored. However, the system administrator may allow
1066 certain users (&"trusted users"&) to specify a different sender address
1067 unconditionally, or all users to specify certain forms of different sender
1068 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1069 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1070 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1071 users to change sender addresses.
1072
1073 Messages received by either of the non-interactive mechanisms are subject to
1074 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1075 (either over TCP/IP, or interacting with a local process) can be checked by a
1076 number of ACLs that operate at different times during the SMTP session. Either
1077 individual recipients, or the entire message, can be rejected if local policy
1078 requirements are not met. The &[local_scan()]& function (see chapter
1079 &<<CHAPlocalscan>>&) is run for all incoming messages.
1080
1081 Exim can be configured not to start a delivery process when a message is
1082 received; this can be unconditional, or depend on the number of incoming SMTP
1083 connections or the system load. In these situations, new messages wait on the
1084 queue until a queue runner process picks them up. However, in standard
1085 configurations under normal conditions, delivery is started as soon as a
1086 message is received.
1087
1088
1089
1090
1091
1092 .section "Handling an incoming message" "SECID14"
1093 .cindex "spool directory" "files that hold a message"
1094 .cindex "file" "how a message is held"
1095 When Exim accepts a message, it writes two files in its spool directory. The
1096 first contains the envelope information, the current status of the message, and
1097 the header lines, and the second contains the body of the message. The names of
1098 the two spool files consist of the message id, followed by &`-H`& for the
1099 file containing the envelope and header, and &`-D`& for the data file.
1100
1101 .cindex "spool directory" "&_input_& sub-directory"
1102 By default all these message files are held in a single directory called
1103 &_input_& inside the general Exim spool directory. Some operating systems do
1104 not perform very well if the number of files in a directory gets large; to
1105 improve performance in such cases, the &%split_spool_directory%& option can be
1106 used. This causes Exim to split up the input files into 62 sub-directories
1107 whose names are single letters or digits. When this is done, the queue is
1108 processed one sub-directory at a time instead of all at once, which can improve
1109 overall performance even when there are not enough files in each directory to
1110 affect file system performance.
1111
1112 The envelope information consists of the address of the message's sender and
1113 the addresses of the recipients. This information is entirely separate from
1114 any addresses contained in the header lines. The status of the message includes
1115 a list of recipients who have already received the message. The format of the
1116 first spool file is described in chapter &<<CHAPspool>>&.
1117
1118 .cindex "rewriting" "addresses"
1119 Address rewriting that is specified in the rewrite section of the configuration
1120 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1121 both in the header lines and the envelope, at the time the message is accepted.
1122 If during the course of delivery additional addresses are generated (for
1123 example, via aliasing), these new addresses are rewritten as soon as they are
1124 generated. At the time a message is actually delivered (transported) further
1125 rewriting can take place; because this is a transport option, it can be
1126 different for different forms of delivery. It is also possible to specify the
1127 addition or removal of certain header lines at the time the message is
1128 delivered (see chapters &<<CHAProutergeneric>>& and
1129 &<<CHAPtransportgeneric>>&).
1130
1131
1132
1133 .section "Life of a message" "SECID15"
1134 .cindex "message" "life of"
1135 .cindex "message" "frozen"
1136 A message remains in the spool directory until it is completely delivered to
1137 its recipients or to an error address, or until it is deleted by an
1138 administrator or by the user who originally created it. In cases when delivery
1139 cannot proceed &-- for example, when a message can neither be delivered to its
1140 recipients nor returned to its sender, the message is marked &"frozen"& on the
1141 spool, and no more deliveries are attempted.
1142
1143 .cindex "frozen messages" "thawing"
1144 .cindex "message" "thawing frozen"
1145 An administrator can &"thaw"& such messages when the problem has been
1146 corrected, and can also freeze individual messages by hand if necessary. In
1147 addition, an administrator can force a delivery error, causing a bounce message
1148 to be sent.
1149
1150 .oindex "&%timeout_frozen_after%&"
1151 .oindex "&%ignore_bounce_errors_after%&"
1152 There are options called &%ignore_bounce_errors_after%& and
1153 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1154 The first applies only to frozen bounces, the second to any frozen messages.
1155
1156 .cindex "message" "log file for"
1157 .cindex "log" "file for each message"
1158 While Exim is working on a message, it writes information about each delivery
1159 attempt to its main log file. This includes successful, unsuccessful, and
1160 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1161 lines are also written to a separate &'message log'& file for each message.
1162 These logs are solely for the benefit of the administrator, and are normally
1163 deleted along with the spool files when processing of a message is complete.
1164 The use of individual message logs can be disabled by setting
1165 &%no_message_logs%&; this might give an improvement in performance on very busy
1166 systems.
1167
1168 .cindex "journal file"
1169 .cindex "file" "journal"
1170 All the information Exim itself needs to set up a delivery is kept in the first
1171 spool file, along with the header lines. When a successful delivery occurs, the
1172 address is immediately written at the end of a journal file, whose name is the
1173 message id followed by &`-J`&. At the end of a delivery run, if there are some
1174 addresses left to be tried again later, the first spool file (the &`-H`& file)
1175 is updated to indicate which these are, and the journal file is then deleted.
1176 Updating the spool file is done by writing a new file and renaming it, to
1177 minimize the possibility of data loss.
1178
1179 Should the system or the program crash after a successful delivery but before
1180 the spool file has been updated, the journal is left lying around. The next
1181 time Exim attempts to deliver the message, it reads the journal file and
1182 updates the spool file before proceeding. This minimizes the chances of double
1183 deliveries caused by crashes.
1184
1185
1186
1187 .section "Processing an address for delivery" "SECTprocaddress"
1188 .cindex "drivers" "definition of"
1189 .cindex "router" "definition of"
1190 .cindex "transport" "definition of"
1191 The main delivery processing elements of Exim are called &'routers'& and
1192 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1193 number of them is provided in the source distribution, and compile-time options
1194 specify which ones are included in the binary. Run time options specify which
1195 ones are actually used for delivering messages.
1196
1197 .cindex "drivers" "instance definition"
1198 Each driver that is specified in the run time configuration is an &'instance'&
1199 of that particular driver type. Multiple instances are allowed; for example,
1200 you can set up several different &(smtp)& transports, each with different
1201 option values that might specify different ports or different timeouts. Each
1202 instance has its own identifying name. In what follows we will normally use the
1203 instance name when discussing one particular instance (that is, one specific
1204 configuration of the driver), and the generic driver name when discussing
1205 the driver's features in general.
1206
1207 A &'router'& is a driver that operates on an address, either determining how
1208 its delivery should happen, by assigning it to a specific transport, or
1209 converting the address into one or more new addresses (for example, via an
1210 alias file). A router may also explicitly choose to fail an address, causing it
1211 to be bounced.
1212
1213 A &'transport'& is a driver that transmits a copy of the message from Exim's
1214 spool to some destination. There are two kinds of transport: for a &'local'&
1215 transport, the destination is a file or a pipe on the local host, whereas for a
1216 &'remote'& transport the destination is some other host. A message is passed
1217 to a specific transport as a result of successful routing. If a message has
1218 several recipients, it may be passed to a number of different transports.
1219
1220 .cindex "preconditions" "definition of"
1221 An address is processed by passing it to each configured router instance in
1222 turn, subject to certain preconditions, until a router accepts the address or
1223 specifies that it should be bounced. We will describe this process in more
1224 detail shortly. First, as a simple example, we consider how each recipient
1225 address in a message is processed in a small configuration of three routers.
1226
1227 To make this a more concrete example, it is described in terms of some actual
1228 routers, but remember, this is only an example. You can configure Exim's
1229 routers in many different ways, and there may be any number of routers in a
1230 configuration.
1231
1232 The first router that is specified in a configuration is often one that handles
1233 addresses in domains that are not recognized specially by the local host. These
1234 are typically addresses for arbitrary domains on the Internet. A precondition
1235 is set up which looks for the special domains known to the host (for example,
1236 its own domain name), and the router is run for addresses that do &'not'&
1237 match. Typically, this is a router that looks up domains in the DNS in order to
1238 find the hosts to which this address routes. If it succeeds, the address is
1239 assigned to a suitable SMTP transport; if it does not succeed, the router is
1240 configured to fail the address.
1241
1242 The second router is reached only when the domain is recognized as one that
1243 &"belongs"& to the local host. This router does redirection &-- also known as
1244 aliasing and forwarding. When it generates one or more new addresses from the
1245 original, each of them is routed independently from the start. Otherwise, the
1246 router may cause an address to fail, or it may simply decline to handle the
1247 address, in which case the address is passed to the next router.
1248
1249 The final router in many configurations is one that checks to see if the
1250 address belongs to a local mailbox. The precondition may involve a check to
1251 see if the local part is the name of a login account, or it may look up the
1252 local part in a file or a database. If its preconditions are not met, or if
1253 the router declines, we have reached the end of the routers. When this happens,
1254 the address is bounced.
1255
1256
1257
1258 .section "Processing an address for verification" "SECID16"
1259 .cindex "router" "for verification"
1260 .cindex "verifying address" "overview"
1261 As well as being used to decide how to deliver to an address, Exim's routers
1262 are also used for &'address verification'&. Verification can be requested as
1263 one of the checks to be performed in an ACL for incoming messages, on both
1264 sender and recipient addresses, and it can be tested using the &%-bv%& and
1265 &%-bvs%& command line options.
1266
1267 When an address is being verified, the routers are run in &"verify mode"&. This
1268 does not affect the way the routers work, but it is a state that can be
1269 detected. By this means, a router can be skipped or made to behave differently
1270 when verifying. A common example is a configuration in which the first router
1271 sends all messages to a message-scanning program, unless they have been
1272 previously scanned. Thus, the first router accepts all addresses without any
1273 checking, making it useless for verifying. Normally, the &%no_verify%& option
1274 would be set for such a router, causing it to be skipped in verify mode.
1275
1276
1277
1278
1279 .section "Running an individual router" "SECTrunindrou"
1280 .cindex "router" "running details"
1281 .cindex "preconditions" "checking"
1282 .cindex "router" "result of running"
1283 As explained in the example above, a number of preconditions are checked before
1284 running a router. If any are not met, the router is skipped, and the address is
1285 passed to the next router. When all the preconditions on a router &'are'& met,
1286 the router is run. What happens next depends on the outcome, which is one of
1287 the following:
1288
1289 .ilist
1290 &'accept'&: The router accepts the address, and either assigns it to a
1291 transport, or generates one or more &"child"& addresses. Processing the
1292 original address ceases,
1293 .oindex "&%unseen%&"
1294 unless the &%unseen%& option is set on the router. This option
1295 can be used to set up multiple deliveries with different routing (for example,
1296 for keeping archive copies of messages). When &%unseen%& is set, the address is
1297 passed to the next router. Normally, however, an &'accept'& return marks the
1298 end of routing.
1299
1300 Any child addresses generated by the router are processed independently,
1301 starting with the first router by default. It is possible to change this by
1302 setting the &%redirect_router%& option to specify which router to start at for
1303 child addresses. Unlike &%pass_router%& (see below) the router specified by
1304 &%redirect_router%& may be anywhere in the router configuration.
1305 .next
1306 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1307 requests that the address be passed to another router. By default the address
1308 is passed to the next router, but this can be changed by setting the
1309 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1310 must be below the current router (to avoid loops).
1311 .next
1312 &'decline'&: The router declines to accept the address because it does not
1313 recognize it at all. By default, the address is passed to the next router, but
1314 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1315 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1316 &'decline'& into &'fail'&.
1317 .next
1318 &'fail'&: The router determines that the address should fail, and queues it for
1319 the generation of a bounce message. There is no further processing of the
1320 original address unless &%unseen%& is set on the router.
1321 .next
1322 &'defer'&: The router cannot handle the address at the present time. (A
1323 database may be offline, or a DNS lookup may have timed out.) No further
1324 processing of the address happens in this delivery attempt. It is tried again
1325 next time the message is considered for delivery.
1326 .next
1327 &'error'&: There is some error in the router (for example, a syntax error in
1328 its configuration). The action is as for defer.
1329 .endlist
1330
1331 If an address reaches the end of the routers without having been accepted by
1332 any of them, it is bounced as unrouteable. The default error message in this
1333 situation is &"unrouteable address"&, but you can set your own message by
1334 making use of the &%cannot_route_message%& option. This can be set for any
1335 router; the value from the last router that &"saw"& the address is used.
1336
1337 Sometimes while routing you want to fail a delivery when some conditions are
1338 met but others are not, instead of passing the address on for further routing.
1339 You can do this by having a second router that explicitly fails the delivery
1340 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1341 facility for this purpose.
1342
1343
1344 .section "Duplicate addresses" "SECID17"
1345 .cindex "case of local parts"
1346 .cindex "address duplicate, discarding"
1347 .cindex "duplicate addresses"
1348 Once routing is complete, Exim scans the addresses that are assigned to local
1349 and remote transports, and discards any duplicates that it finds. During this
1350 check, local parts are treated as case-sensitive. This happens only when
1351 actually delivering a message; when testing routers with &%-bt%&, all the
1352 routed addresses are shown.
1353
1354
1355
1356 .section "Router preconditions" "SECTrouprecon"
1357 .cindex "router" "preconditions, order of processing"
1358 .cindex "preconditions" "order of processing"
1359 The preconditions that are tested for each router are listed below, in the
1360 order in which they are tested. The individual configuration options are
1361 described in more detail in chapter &<<CHAProutergeneric>>&.
1362
1363 .ilist
1364 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1365 the local parts handled by the router may or must have certain prefixes and/or
1366 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1367 skipped. These conditions are tested first. When an affix is present, it is
1368 removed from the local part before further processing, including the evaluation
1369 of any other conditions.
1370 .next
1371 Routers can be designated for use only when not verifying an address, that is,
1372 only when routing it for delivery (or testing its delivery routing). If the
1373 &%verify%& option is set false, the router is skipped when Exim is verifying an
1374 address.
1375 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1376 &%verify_recipient%&, which independently control the use of the router for
1377 sender and recipient verification. You can set these options directly if
1378 you want a router to be used for only one type of verification.
1379 Note that cutthrough delivery is classed as a recipient verification
1380 for this purpose.
1381 .next
1382 If the &%address_test%& option is set false, the router is skipped when Exim is
1383 run with the &%-bt%& option to test an address routing. This can be helpful
1384 when the first router sends all new messages to a scanner of some sort; it
1385 makes it possible to use &%-bt%& to test subsequent delivery routing without
1386 having to simulate the effect of the scanner.
1387 .next
1388 Routers can be designated for use only when verifying an address, as
1389 opposed to routing it for delivery. The &%verify_only%& option controls this.
1390 Again, cutthrough delibery counts as a verification.
1391 .next
1392 Individual routers can be explicitly skipped when running the routers to
1393 check an address given in the SMTP EXPN command (see the &%expn%& option).
1394 .next
1395 If the &%domains%& option is set, the domain of the address must be in the set
1396 of domains that it defines.
1397 .next
1398 .vindex "&$local_part_prefix$&"
1399 .vindex "&$local_part$&"
1400 .vindex "&$local_part_suffix$&"
1401 If the &%local_parts%& option is set, the local part of the address must be in
1402 the set of local parts that it defines. If &%local_part_prefix%& or
1403 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1404 part before this check. If you want to do precondition tests on local parts
1405 that include affixes, you can do so by using a &%condition%& option (see below)
1406 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1407 &$local_part_suffix$& as necessary.
1408 .next
1409 .vindex "&$local_user_uid$&"
1410 .vindex "&$local_user_gid$&"
1411 .vindex "&$home$&"
1412 If the &%check_local_user%& option is set, the local part must be the name of
1413 an account on the local host. If this check succeeds, the uid and gid of the
1414 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1415 user's home directory is placed in &$home$&; these values can be used in the
1416 remaining preconditions.
1417 .next
1418 If the &%router_home_directory%& option is set, it is expanded at this point,
1419 because it overrides the value of &$home$&. If this expansion were left till
1420 later, the value of &$home$& as set by &%check_local_user%& would be used in
1421 subsequent tests. Having two different values of &$home$& in the same router
1422 could lead to confusion.
1423 .next
1424 If the &%senders%& option is set, the envelope sender address must be in the
1425 set of addresses that it defines.
1426 .next
1427 If the &%require_files%& option is set, the existence or non-existence of
1428 specified files is tested.
1429 .next
1430 .cindex "customizing" "precondition"
1431 If the &%condition%& option is set, it is evaluated and tested. This option
1432 uses an expanded string to allow you to set up your own custom preconditions.
1433 Expanded strings are described in chapter &<<CHAPexpand>>&.
1434 .endlist
1435
1436
1437 Note that &%require_files%& comes near the end of the list, so you cannot use
1438 it to check for the existence of a file in which to lookup up a domain, local
1439 part, or sender. However, as these options are all expanded, you can use the
1440 &%exists%& expansion condition to make such tests within each condition. The
1441 &%require_files%& option is intended for checking files that the router may be
1442 going to use internally, or which are needed by a specific transport (for
1443 example, &_.procmailrc_&).
1444
1445
1446
1447 .section "Delivery in detail" "SECID18"
1448 .cindex "delivery" "in detail"
1449 When a message is to be delivered, the sequence of events is as follows:
1450
1451 .ilist
1452 If a system-wide filter file is specified, the message is passed to it. The
1453 filter may add recipients to the message, replace the recipients, discard the
1454 message, cause a new message to be generated, or cause the message delivery to
1455 fail. The format of the system filter file is the same as for Exim user filter
1456 files, described in the separate document entitled &'Exim's interfaces to mail
1457 filtering'&.
1458 .cindex "Sieve filter" "not available for system filter"
1459 (&*Note*&: Sieve cannot be used for system filter files.)
1460
1461 Some additional features are available in system filters &-- see chapter
1462 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1463 filter only once per delivery attempt, however many recipients it has. However,
1464 if there are several delivery attempts because one or more addresses could not
1465 be immediately delivered, the system filter is run each time. The filter
1466 condition &%first_delivery%& can be used to detect the first run of the system
1467 filter.
1468 .next
1469 Each recipient address is offered to each configured router in turn, subject to
1470 its preconditions, until one is able to handle it. If no router can handle the
1471 address, that is, if they all decline, the address is failed. Because routers
1472 can be targeted at particular domains, several locally handled domains can be
1473 processed entirely independently of each other.
1474 .next
1475 .cindex "routing" "loops in"
1476 .cindex "loop" "while routing"
1477 A router that accepts an address may assign it to a local or a remote
1478 transport. However, the transport is not run at this time. Instead, the address
1479 is placed on a list for the particular transport, which will be run later.
1480 Alternatively, the router may generate one or more new addresses (typically
1481 from alias, forward, or filter files). New addresses are fed back into this
1482 process from the top, but in order to avoid loops, a router ignores any address
1483 which has an identically-named ancestor that was processed by itself.
1484 .next
1485 When all the routing has been done, addresses that have been successfully
1486 handled are passed to their assigned transports. When local transports are
1487 doing real local deliveries, they handle only one address at a time, but if a
1488 local transport is being used as a pseudo-remote transport (for example, to
1489 collect batched SMTP messages for transmission by some other means) multiple
1490 addresses can be handled. Remote transports can always handle more than one
1491 address at a time, but can be configured not to do so, or to restrict multiple
1492 addresses to the same domain.
1493 .next
1494 Each local delivery to a file or a pipe runs in a separate process under a
1495 non-privileged uid, and these deliveries are run one at a time. Remote
1496 deliveries also run in separate processes, normally under a uid that is private
1497 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1498 run in parallel. The maximum number of simultaneous remote deliveries for any
1499 one message is set by the &%remote_max_parallel%& option.
1500 The order in which deliveries are done is not defined, except that all local
1501 deliveries happen before any remote deliveries.
1502 .next
1503 .cindex "queue runner"
1504 When it encounters a local delivery during a queue run, Exim checks its retry
1505 database to see if there has been a previous temporary delivery failure for the
1506 address before running the local transport. If there was a previous failure,
1507 Exim does not attempt a new delivery until the retry time for the address is
1508 reached. However, this happens only for delivery attempts that are part of a
1509 queue run. Local deliveries are always attempted when delivery immediately
1510 follows message reception, even if retry times are set for them. This makes for
1511 better behaviour if one particular message is causing problems (for example,
1512 causing quota overflow, or provoking an error in a filter file).
1513 .next
1514 .cindex "delivery" "retry in remote transports"
1515 Remote transports do their own retry handling, since an address may be
1516 deliverable to one of a number of hosts, each of which may have a different
1517 retry time. If there have been previous temporary failures and no host has
1518 reached its retry time, no delivery is attempted, whether in a queue run or
1519 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1520 .next
1521 If there were any permanent errors, a bounce message is returned to an
1522 appropriate address (the sender in the common case), with details of the error
1523 for each failing address. Exim can be configured to send copies of bounce
1524 messages to other addresses.
1525 .next
1526 .cindex "delivery" "deferral"
1527 If one or more addresses suffered a temporary failure, the message is left on
1528 the queue, to be tried again later. Delivery of these addresses is said to be
1529 &'deferred'&.
1530 .next
1531 When all the recipient addresses have either been delivered or bounced,
1532 handling of the message is complete. The spool files and message log are
1533 deleted, though the message log can optionally be preserved if required.
1534 .endlist
1535
1536
1537
1538
1539 .section "Retry mechanism" "SECID19"
1540 .cindex "delivery" "retry mechanism"
1541 .cindex "retry" "description of mechanism"
1542 .cindex "queue runner"
1543 Exim's mechanism for retrying messages that fail to get delivered at the first
1544 attempt is the queue runner process. You must either run an Exim daemon that
1545 uses the &%-q%& option with a time interval to start queue runners at regular
1546 intervals, or use some other means (such as &'cron'&) to start them. If you do
1547 not arrange for queue runners to be run, messages that fail temporarily at the
1548 first attempt will remain on your queue for ever. A queue runner process works
1549 its way through the queue, one message at a time, trying each delivery that has
1550 passed its retry time.
1551 You can run several queue runners at once.
1552
1553 Exim uses a set of configured rules to determine when next to retry the failing
1554 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1555 should give up trying to deliver to the address, at which point it generates a
1556 bounce message. If no retry rules are set for a particular host, address, and
1557 error combination, no retries are attempted, and temporary errors are treated
1558 as permanent.
1559
1560
1561
1562 .section "Temporary delivery failure" "SECID20"
1563 .cindex "delivery" "temporary failure"
1564 There are many reasons why a message may not be immediately deliverable to a
1565 particular address. Failure to connect to a remote machine (because it, or the
1566 connection to it, is down) is one of the most common. Temporary failures may be
1567 detected during routing as well as during the transport stage of delivery.
1568 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1569 is on a file system where the user is over quota. Exim can be configured to
1570 impose its own quotas on local mailboxes; where system quotas are set they will
1571 also apply.
1572
1573 If a host is unreachable for a period of time, a number of messages may be
1574 waiting for it by the time it recovers, and sending them in a single SMTP
1575 connection is clearly beneficial. Whenever a delivery to a remote host is
1576 deferred,
1577 .cindex "hints database"
1578 Exim makes a note in its hints database, and whenever a successful
1579 SMTP delivery has happened, it looks to see if any other messages are waiting
1580 for the same host. If any are found, they are sent over the same SMTP
1581 connection, subject to a configuration limit as to the maximum number in any
1582 one connection.
1583
1584
1585
1586 .section "Permanent delivery failure" "SECID21"
1587 .cindex "delivery" "permanent failure"
1588 .cindex "bounce message" "when generated"
1589 When a message cannot be delivered to some or all of its intended recipients, a
1590 bounce message is generated. Temporary delivery failures turn into permanent
1591 errors when their timeout expires. All the addresses that fail in a given
1592 delivery attempt are listed in a single message. If the original message has
1593 many recipients, it is possible for some addresses to fail in one delivery
1594 attempt and others to fail subsequently, giving rise to more than one bounce
1595 message. The wording of bounce messages can be customized by the administrator.
1596 See chapter &<<CHAPemsgcust>>& for details.
1597
1598 .cindex "&'X-Failed-Recipients:'& header line"
1599 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1600 failed addresses, for the benefit of programs that try to analyse such messages
1601 automatically.
1602
1603 .cindex "bounce message" "recipient of"
1604 A bounce message is normally sent to the sender of the original message, as
1605 obtained from the message's envelope. For incoming SMTP messages, this is the
1606 address given in the MAIL command. However, when an address is expanded via a
1607 forward or alias file, an alternative address can be specified for delivery
1608 failures of the generated addresses. For a mailing list expansion (see section
1609 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1610 of the list.
1611
1612
1613
1614 .section "Failures to deliver bounce messages" "SECID22"
1615 .cindex "bounce message" "failure to deliver"
1616 If a bounce message (either locally generated or received from a remote host)
1617 itself suffers a permanent delivery failure, the message is left on the queue,
1618 but it is frozen, awaiting the attention of an administrator. There are options
1619 that can be used to make Exim discard such failed messages, or to keep them
1620 for only a short time (see &%timeout_frozen_after%& and
1621 &%ignore_bounce_errors_after%&).
1622
1623
1624
1625
1626
1627 . ////////////////////////////////////////////////////////////////////////////
1628 . ////////////////////////////////////////////////////////////////////////////
1629
1630 .chapter "Building and installing Exim" "CHID3"
1631 .scindex IIDbuex "building Exim"
1632
1633 .section "Unpacking" "SECID23"
1634 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1635 creates a directory with the name of the current release (for example,
1636 &_exim-&version()_&) into which the following files are placed:
1637
1638 .table2 140pt
1639 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1640 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1641   documented"
1642 .irow &_LICENCE_&         "the GNU General Public Licence"
1643 .irow &_Makefile_&        "top-level make file"
1644 .irow &_NOTICE_&          "conditions for the use of Exim"
1645 .irow &_README_&          "list of files, directories and simple build &&&
1646   instructions"
1647 .endtable
1648
1649 Other files whose names begin with &_README_& may also be present. The
1650 following subdirectories are created:
1651
1652 .table2 140pt
1653 .irow &_Local_&           "an empty directory for local configuration files"
1654 .irow &_OS_&              "OS-specific files"
1655 .irow &_doc_&             "documentation files"
1656 .irow &_exim_monitor_&    "source files for the Exim monitor"
1657 .irow &_scripts_&         "scripts used in the build process"
1658 .irow &_src_&             "remaining source files"
1659 .irow &_util_&            "independent utilities"
1660 .endtable
1661
1662 The main utility programs are contained in the &_src_& directory, and are built
1663 with the Exim binary. The &_util_& directory contains a few optional scripts
1664 that may be useful to some sites.
1665
1666
1667 .section "Multiple machine architectures and operating systems" "SECID24"
1668 .cindex "building Exim" "multiple OS/architectures"
1669 The building process for Exim is arranged to make it easy to build binaries for
1670 a number of different architectures and operating systems from the same set of
1671 source files. Compilation does not take place in the &_src_& directory.
1672 Instead, a &'build directory'& is created for each architecture and operating
1673 system.
1674 .cindex "symbolic link" "to build directory"
1675 Symbolic links to the sources are installed in this directory, which is where
1676 the actual building takes place. In most cases, Exim can discover the machine
1677 architecture and operating system for itself, but the defaults can be
1678 overridden if necessary.
1679
1680
1681 .section "PCRE library" "SECTpcre"
1682 .cindex "PCRE library"
1683 Exim no longer has an embedded PCRE library as the vast majority of
1684 modern systems include PCRE as a system library, although you may need
1685 to install the PCRE or PCRE development package for your operating
1686 system. If your system has a normal PCRE installation the Exim build
1687 process will need no further configuration. If the library or the
1688 headers are in an unusual location you will need to either set the PCRE_LIBS
1689 and INCLUDE directives appropriately,
1690 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1691 If your operating system has no
1692 PCRE support then you will need to obtain and build the current PCRE
1693 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1694 More information on PCRE is available at &url(http://www.pcre.org/).
1695
1696 .section "DBM libraries" "SECTdb"
1697 .cindex "DBM libraries" "discussion of"
1698 .cindex "hints database" "DBM files used for"
1699 Even if you do not use any DBM files in your configuration, Exim still needs a
1700 DBM library in order to operate, because it uses indexed files for its hints
1701 databases. Unfortunately, there are a number of DBM libraries in existence, and
1702 different operating systems often have different ones installed.
1703
1704 .cindex "Solaris" "DBM library for"
1705 .cindex "IRIX, DBM library for"
1706 .cindex "BSD, DBM library for"
1707 .cindex "Linux, DBM library for"
1708 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1709 Linux distribution, the DBM configuration should happen automatically, and you
1710 may be able to ignore this section. Otherwise, you may have to learn more than
1711 you would like about DBM libraries from what follows.
1712
1713 .cindex "&'ndbm'& DBM library"
1714 Licensed versions of Unix normally contain a library of DBM functions operating
1715 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1716 versions of Unix seem to vary in what they contain as standard. In particular,
1717 some early versions of Linux have no default DBM library, and different
1718 distributors have chosen to bundle different libraries with their packaged
1719 versions. However, the more recent releases seem to have standardized on the
1720 Berkeley DB library.
1721
1722 Different DBM libraries have different conventions for naming the files they
1723 use. When a program opens a file called &_dbmfile_&, there are several
1724 possibilities:
1725
1726 .olist
1727 A traditional &'ndbm'& implementation, such as that supplied as part of
1728 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1729 .next
1730 .cindex "&'gdbm'& DBM library"
1731 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1732 compatibility interface it makes two different hard links to it with names
1733 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1734 file name is used unmodified.
1735 .next
1736 .cindex "Berkeley DB library"
1737 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1738 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1739 programmer exactly the same as the traditional &'ndbm'& implementation.
1740 .next
1741 If the Berkeley package is used in its native mode, it operates on a single
1742 file called &_dbmfile_&; the programmer's interface is somewhat different to
1743 the traditional &'ndbm'& interface.
1744 .next
1745 To complicate things further, there are several very different versions of the
1746 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1747 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1748 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1749 versions of Berkeley DB can be obtained from
1750 &url(http://www.sleepycat.com/).
1751 .next
1752 .cindex "&'tdb'& DBM library"
1753 Yet another DBM library, called &'tdb'&, is available from
1754 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1755 operates on a single file.
1756 .endlist
1757
1758 .cindex "USE_DB"
1759 .cindex "DBM libraries" "configuration for building"
1760 Exim and its utilities can be compiled to use any of these interfaces. In order
1761 to use any version of the Berkeley DB package in native mode, you must set
1762 USE_DB in an appropriate configuration file (typically
1763 &_Local/Makefile_&). For example:
1764 .code
1765 USE_DB=yes
1766 .endd
1767 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1768 error is diagnosed if you set more than one of these.
1769
1770 At the lowest level, the build-time configuration sets none of these options,
1771 thereby assuming an interface of type (1). However, some operating system
1772 configuration files (for example, those for the BSD operating systems and
1773 Linux) assume type (4) by setting USE_DB as their default, and the
1774 configuration files for Cygwin set USE_GDBM. Anything you set in
1775 &_Local/Makefile_&, however, overrides these system defaults.
1776
1777 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1778 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1779 in one of these lines:
1780 .code
1781 DBMLIB = -ldb
1782 DBMLIB = -ltdb
1783 .endd
1784 Settings like that will work if the DBM library is installed in the standard
1785 place. Sometimes it is not, and the library's header file may also not be in
1786 the default path. You may need to set INCLUDE to specify where the header
1787 file is, and to specify the path to the library more fully in DBMLIB, as in
1788 this example:
1789 .code
1790 INCLUDE=-I/usr/local/include/db-4.1
1791 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1792 .endd
1793 There is further detailed discussion about the various DBM libraries in the
1794 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1795
1796
1797
1798 .section "Pre-building configuration" "SECID25"
1799 .cindex "building Exim" "pre-building configuration"
1800 .cindex "configuration for building Exim"
1801 .cindex "&_Local/Makefile_&"
1802 .cindex "&_src/EDITME_&"
1803 Before building Exim, a local configuration file that specifies options
1804 independent of any operating system has to be created with the name
1805 &_Local/Makefile_&. A template for this file is supplied as the file
1806 &_src/EDITME_&, and it contains full descriptions of all the option settings
1807 therein. These descriptions are therefore not repeated here. If you are
1808 building Exim for the first time, the simplest thing to do is to copy
1809 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1810
1811 There are three settings that you must supply, because Exim will not build
1812 without them. They are the location of the run time configuration file
1813 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1814 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1815 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1816 a colon-separated list of file names; Exim uses the first of them that exists.
1817
1818 There are a few other parameters that can be specified either at build time or
1819 at run time, to enable the same binary to be used on a number of different
1820 machines. However, if the locations of Exim's spool directory and log file
1821 directory (if not within the spool directory) are fixed, it is recommended that
1822 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1823 detected early in Exim's execution (such as a malformed configuration file) can
1824 be logged.
1825
1826 .cindex "content scanning" "specifying at build time"
1827 Exim's interfaces for calling virus and spam scanning software directly from
1828 access control lists are not compiled by default. If you want to include these
1829 facilities, you need to set
1830 .code
1831 WITH_CONTENT_SCAN=yes
1832 .endd
1833 in your &_Local/Makefile_&. For details of the facilities themselves, see
1834 chapter &<<CHAPexiscan>>&.
1835
1836
1837 .cindex "&_Local/eximon.conf_&"
1838 .cindex "&_exim_monitor/EDITME_&"
1839 If you are going to build the Exim monitor, a similar configuration process is
1840 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1841 your installation and saved under the name &_Local/eximon.conf_&. If you are
1842 happy with the default settings described in &_exim_monitor/EDITME_&,
1843 &_Local/eximon.conf_& can be empty, but it must exist.
1844
1845 This is all the configuration that is needed in straightforward cases for known
1846 operating systems. However, the building process is set up so that it is easy
1847 to override options that are set by default or by operating-system-specific
1848 configuration files, for example to change the name of the C compiler, which
1849 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1850 do this.
1851
1852
1853
1854 .section "Support for iconv()" "SECID26"
1855 .cindex "&[iconv()]& support"
1856 .cindex "RFC 2047"
1857 The contents of header lines in messages may be encoded according to the rules
1858 described RFC 2047. This makes it possible to transmit characters that are not
1859 in the ASCII character set, and to label them as being in a particular
1860 character set. When Exim is inspecting header lines by means of the &%$h_%&
1861 mechanism, it decodes them, and translates them into a specified character set
1862 (default ISO-8859-1). The translation is possible only if the operating system
1863 supports the &[iconv()]& function.
1864
1865 However, some of the operating systems that supply &[iconv()]& do not support
1866 very many conversions. The GNU &%libiconv%& library (available from
1867 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1868 systems to remedy this deficiency, as well as on systems that do not supply
1869 &[iconv()]& at all. After installing &%libiconv%&, you should add
1870 .code
1871 HAVE_ICONV=yes
1872 .endd
1873 to your &_Local/Makefile_& and rebuild Exim.
1874
1875
1876
1877 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1878 .cindex "TLS" "including support for TLS"
1879 .cindex "encryption" "including support for"
1880 .cindex "SUPPORT_TLS"
1881 .cindex "OpenSSL" "building Exim with"
1882 .cindex "GnuTLS" "building Exim with"
1883 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1884 command as per RFC 2487. It can also support legacy clients that expect to
1885 start a TLS session immediately on connection to a non-standard port (see the
1886 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1887 line option).
1888
1889 If you want to build Exim with TLS support, you must first install either the
1890 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1891 implementing SSL.
1892
1893 If OpenSSL is installed, you should set
1894 .code
1895 SUPPORT_TLS=yes
1896 TLS_LIBS=-lssl -lcrypto
1897 .endd
1898 in &_Local/Makefile_&. You may also need to specify the locations of the
1899 OpenSSL library and include files. For example:
1900 .code
1901 SUPPORT_TLS=yes
1902 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1903 TLS_INCLUDE=-I/usr/local/openssl/include/
1904 .endd
1905 .cindex "pkg-config" "OpenSSL"
1906 If you have &'pkg-config'& available, then instead you can just use:
1907 .code
1908 SUPPORT_TLS=yes
1909 USE_OPENSSL_PC=openssl
1910 .endd
1911 .cindex "USE_GNUTLS"
1912 If GnuTLS is installed, you should set
1913 .code
1914 SUPPORT_TLS=yes
1915 USE_GNUTLS=yes
1916 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1917 .endd
1918 in &_Local/Makefile_&, and again you may need to specify the locations of the
1919 library and include files. For example:
1920 .code
1921 SUPPORT_TLS=yes
1922 USE_GNUTLS=yes
1923 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1924 TLS_INCLUDE=-I/usr/gnu/include
1925 .endd
1926 .cindex "pkg-config" "GnuTLS"
1927 If you have &'pkg-config'& available, then instead you can just use:
1928 .code
1929 SUPPORT_TLS=yes
1930 USE_GNUTLS=yes
1931 USE_GNUTLS_PC=gnutls
1932 .endd
1933
1934 You do not need to set TLS_INCLUDE if the relevant directory is already
1935 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1936 given in chapter &<<CHAPTLS>>&.
1937
1938
1939
1940
1941 .section "Use of tcpwrappers" "SECID27"
1942
1943 .cindex "tcpwrappers, building Exim to support"
1944 .cindex "USE_TCP_WRAPPERS"
1945 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1946 .cindex "tcp_wrappers_daemon_name"
1947 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1948 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1949 alternative to Exim's own checking facilities for installations that are
1950 already making use of &'tcpwrappers'& for other purposes. To do this, you
1951 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1952 &_tcpd.h_& to be available at compile time, and also ensure that the library
1953 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1954 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1955 you might have
1956 .code
1957 USE_TCP_WRAPPERS=yes
1958 CFLAGS=-O -I/usr/local/include
1959 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1960 .endd
1961 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1962 files is &"exim"&. For example, the line
1963 .code
1964 exim : LOCAL  192.168.1.  .friendly.domain.example
1965 .endd
1966 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1967 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1968 All other connections are denied. The daemon name used by &'tcpwrappers'&
1969 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1970 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1971 configure file. Consult the &'tcpwrappers'& documentation for
1972 further details.
1973
1974
1975 .section "Including support for IPv6" "SECID28"
1976 .cindex "IPv6" "including support for"
1977 Exim contains code for use on systems that have IPv6 support. Setting
1978 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1979 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1980 where the IPv6 support is not fully integrated into the normal include and
1981 library files.
1982
1983 Two different types of DNS record for handling IPv6 addresses have been
1984 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1985 currently seen as the mainstream. Another record type called A6 was proposed
1986 as better than AAAA because it had more flexibility. However, it was felt to be
1987 over-complex, and its status was reduced to &"experimental"&. It is not known
1988 if anyone is actually using A6 records. Exim has support for A6 records, but
1989 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1990 support has not been tested for some time.
1991
1992
1993
1994 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1995 .cindex "lookup modules"
1996 .cindex "dynamic modules"
1997 .cindex ".so building"
1998 On some platforms, Exim supports not compiling all lookup types directly into
1999 the main binary, instead putting some into external modules which can be loaded
2000 on demand.
2001 This permits packagers to build Exim with support for lookups with extensive
2002 library dependencies without requiring all users to install all of those
2003 dependencies.
2004 Most, but not all, lookup types can be built this way.
2005
2006 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2007 installed; Exim will only load modules from that directory, as a security
2008 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2009 for your OS; see &_OS/Makefile-Linux_& for an example.
2010 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2011 see &_src/EDITME_& for details.
2012
2013 Then, for each module to be loaded dynamically, define the relevant
2014 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2015 For example, this will build in lsearch but load sqlite and mysql support
2016 on demand:
2017 .code
2018 LOOKUP_LSEARCH=yes
2019 LOOKUP_SQLITE=2
2020 LOOKUP_MYSQL=2
2021 .endd
2022
2023
2024 .section "The building process" "SECID29"
2025 .cindex "build directory"
2026 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2027 created, run &'make'& at the top level. It determines the architecture and
2028 operating system types, and creates a build directory if one does not exist.
2029 For example, on a Sun system running Solaris 8, the directory
2030 &_build-SunOS5-5.8-sparc_& is created.
2031 .cindex "symbolic link" "to source files"
2032 Symbolic links to relevant source files are installed in the build directory.
2033
2034 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2035 building process fails if it is set.
2036
2037 If this is the first time &'make'& has been run, it calls a script that builds
2038 a make file inside the build directory, using the configuration files from the
2039 &_Local_& directory. The new make file is then passed to another instance of
2040 &'make'&. This does the real work, building a number of utility scripts, and
2041 then compiling and linking the binaries for the Exim monitor (if configured), a
2042 number of utility programs, and finally Exim itself. The command &`make
2043 makefile`& can be used to force a rebuild of the make file in the build
2044 directory, should this ever be necessary.
2045
2046 If you have problems building Exim, check for any comments there may be in the
2047 &_README_& file concerning your operating system, and also take a look at the
2048 FAQ, where some common problems are covered.
2049
2050
2051
2052 .section 'Output from &"make"&' "SECID283"
2053 The output produced by the &'make'& process for compile lines is often very
2054 unreadable, because these lines can be very long. For this reason, the normal
2055 output is suppressed by default, and instead output similar to that which
2056 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2057 each module that is being compiled or linked. However, it is still possible to
2058 get the full output, by calling &'make'& like this:
2059 .code
2060 FULLECHO='' make -e
2061 .endd
2062 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2063 command reflection in &'make'&. When you ask for the full output, it is
2064 given in addition to the short output.
2065
2066
2067
2068 .section "Overriding build-time options for Exim" "SECToverride"
2069 .cindex "build-time options, overriding"
2070 The main make file that is created at the beginning of the building process
2071 consists of the concatenation of a number of files which set configuration
2072 values, followed by a fixed set of &'make'& instructions. If a value is set
2073 more than once, the last setting overrides any previous ones. This provides a
2074 convenient way of overriding defaults. The files that are concatenated are, in
2075 order:
2076 .display
2077 &_OS/Makefile-Default_&
2078 &_OS/Makefile-_&<&'ostype'&>
2079 &_Local/Makefile_&
2080 &_Local/Makefile-_&<&'ostype'&>
2081 &_Local/Makefile-_&<&'archtype'&>
2082 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2083 &_OS/Makefile-Base_&
2084 .endd
2085 .cindex "&_Local/Makefile_&"
2086 .cindex "building Exim" "operating system type"
2087 .cindex "building Exim" "architecture type"
2088 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2089 architecture type. &_Local/Makefile_& is required to exist, and the building
2090 process fails if it is absent. The other three &_Local_& files are optional,
2091 and are often not needed.
2092
2093 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2094 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2095 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2096 values are used, thereby providing a means of forcing particular settings.
2097 Otherwise, the scripts try to get values from the &%uname%& command. If this
2098 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2099 of &'ad hoc'& transformations are then applied, to produce the standard names
2100 that Exim expects. You can run these scripts directly from the shell in order
2101 to find out what values are being used on your system.
2102
2103
2104 &_OS/Makefile-Default_& contains comments about the variables that are set
2105 therein. Some (but not all) are mentioned below. If there is something that
2106 needs changing, review the contents of this file and the contents of the make
2107 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2108 default values are.
2109
2110
2111 .cindex "building Exim" "overriding default settings"
2112 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2113 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2114 need to change the original files. Instead, you should make the changes by
2115 putting the new values in an appropriate &_Local_& file. For example,
2116 .cindex "Tru64-Unix build-time settings"
2117 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2118 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2119 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2120 called with the option &%-std1%&, to make it recognize some of the features of
2121 Standard C that Exim uses. (Most other compilers recognize Standard C by
2122 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2123 containing the lines
2124 .code
2125 CC=cc
2126 CFLAGS=-std1
2127 .endd
2128 If you are compiling for just one operating system, it may be easier to put
2129 these lines directly into &_Local/Makefile_&.
2130
2131 Keeping all your local configuration settings separate from the distributed
2132 files makes it easy to transfer them to new versions of Exim simply by copying
2133 the contents of the &_Local_& directory.
2134
2135
2136 .cindex "NIS lookup type" "including support for"
2137 .cindex "NIS+ lookup type" "including support for"
2138 .cindex "LDAP" "including support for"
2139 .cindex "lookup" "inclusion in binary"
2140 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2141 lookup, but not all systems have these components installed, so the default is
2142 not to include the relevant code in the binary. All the different kinds of file
2143 and database lookup that Exim supports are implemented as separate code modules
2144 which are included only if the relevant compile-time options are set. In the
2145 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2146 .code
2147 LOOKUP_LDAP=yes
2148 LOOKUP_NIS=yes
2149 LOOKUP_NISPLUS=yes
2150 .endd
2151 and similar settings apply to the other lookup types. They are all listed in
2152 &_src/EDITME_&. In many cases the relevant include files and interface
2153 libraries need to be installed before compiling Exim.
2154 .cindex "cdb" "including support for"
2155 However, there are some optional lookup types (such as cdb) for which
2156 the code is entirely contained within Exim, and no external include
2157 files or libraries are required. When a lookup type is not included in the
2158 binary, attempts to configure Exim to use it cause run time configuration
2159 errors.
2160
2161 .cindex "pkg-config" "lookups"
2162 .cindex "pkg-config" "authenticators"
2163 Many systems now use a tool called &'pkg-config'& to encapsulate information
2164 about how to compile against a library; Exim has some initial support for
2165 being able to use pkg-config for lookups and authenticators.  For any given
2166 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2167 variable with the &`_PC`& suffix in the name and assign as the value the
2168 name of the package to be queried.  The results of querying via the
2169 &'pkg-config'& command will be added to the appropriate Makefile variables
2170 with &`+=`& directives, so your version of &'make'& will need to support that
2171 syntax.  For instance:
2172 .code
2173 LOOKUP_SQLITE=yes
2174 LOOKUP_SQLITE_PC=sqlite3
2175 AUTH_GSASL=yes
2176 AUTH_GSASL_PC=libgsasl
2177 AUTH_HEIMDAL_GSSAPI=yes
2178 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2179 .endd
2180
2181 .cindex "Perl" "including support for"
2182 Exim can be linked with an embedded Perl interpreter, allowing Perl
2183 subroutines to be called during string expansion. To enable this facility,
2184 .code
2185 EXIM_PERL=perl.o
2186 .endd
2187 must be defined in &_Local/Makefile_&. Details of this facility are given in
2188 chapter &<<CHAPperl>>&.
2189
2190 .cindex "X11 libraries, location of"
2191 The location of the X11 libraries is something that varies a lot between
2192 operating systems, and there may be different versions of X11 to cope
2193 with. Exim itself makes no use of X11, but if you are compiling the Exim
2194 monitor, the X11 libraries must be available.
2195 The following three variables are set in &_OS/Makefile-Default_&:
2196 .code
2197 X11=/usr/X11R6
2198 XINCLUDE=-I$(X11)/include
2199 XLFLAGS=-L$(X11)/lib
2200 .endd
2201 These are overridden in some of the operating-system configuration files. For
2202 example, in &_OS/Makefile-SunOS5_& there is
2203 .code
2204 X11=/usr/openwin
2205 XINCLUDE=-I$(X11)/include
2206 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2207 .endd
2208 If you need to override the default setting for your operating system, place a
2209 definition of all three of these variables into your
2210 &_Local/Makefile-<ostype>_& file.
2211
2212 .cindex "EXTRALIBS"
2213 If you need to add any extra libraries to the link steps, these can be put in a
2214 variable called EXTRALIBS, which appears in all the link commands, but by
2215 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2216 command for linking the main Exim binary, and not for any associated utilities.
2217
2218 .cindex "DBM libraries" "configuration for building"
2219 There is also DBMLIB, which appears in the link commands for binaries that
2220 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2221 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2222 binary, and which can be used, for example, to include additional X11
2223 libraries.
2224
2225 .cindex "configuration file" "editing"
2226 The make file copes with rebuilding Exim correctly if any of the configuration
2227 files are edited. However, if an optional configuration file is deleted, it is
2228 necessary to touch the associated non-optional file (that is,
2229 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2230
2231
2232 .section "OS-specific header files" "SECID30"
2233 .cindex "&_os.h_&"
2234 .cindex "building Exim" "OS-specific C header files"
2235 The &_OS_& directory contains a number of files with names of the form
2236 &_os.h-<ostype>_&. These are system-specific C header files that should not
2237 normally need to be changed. There is a list of macro settings that are
2238 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2239 are porting Exim to a new operating system.
2240
2241
2242
2243 .section "Overriding build-time options for the monitor" "SECID31"
2244 .cindex "building Eximon"
2245 A similar process is used for overriding things when building the Exim monitor,
2246 where the files that are involved are
2247 .display
2248 &_OS/eximon.conf-Default_&
2249 &_OS/eximon.conf-_&<&'ostype'&>
2250 &_Local/eximon.conf_&
2251 &_Local/eximon.conf-_&<&'ostype'&>
2252 &_Local/eximon.conf-_&<&'archtype'&>
2253 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2254 .endd
2255 .cindex "&_Local/eximon.conf_&"
2256 As with Exim itself, the final three files need not exist, and in this case the
2257 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2258 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2259 variables of the same name, preceded by EXIMON_. For example, setting
2260 EXIMON_LOG_DEPTH in the environment overrides the value of
2261 LOG_DEPTH at run time.
2262 .ecindex IIDbuex
2263
2264
2265 .section "Installing Exim binaries and scripts" "SECID32"
2266 .cindex "installing Exim"
2267 .cindex "BIN_DIRECTORY"
2268 The command &`make install`& runs the &(exim_install)& script with no
2269 arguments. The script copies binaries and utility scripts into the directory
2270 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2271 .cindex "setuid" "installing Exim with"
2272 The install script copies files only if they are newer than the files they are
2273 going to replace. The Exim binary is required to be owned by root and have the
2274 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2275 install`& as root so that it can set up the Exim binary in this way. However, in
2276 some special situations (for example, if a host is doing no local deliveries)
2277 it may be possible to run Exim without making the binary setuid root (see
2278 chapter &<<CHAPsecurity>>& for details).
2279
2280 .cindex "CONFIGURE_FILE"
2281 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2282 in &_Local/Makefile_&. If this names a single file, and the file does not
2283 exist, the default configuration file &_src/configure.default_& is copied there
2284 by the installation script. If a run time configuration file already exists, it
2285 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2286 alternative files, no default is installed.
2287
2288 .cindex "system aliases file"
2289 .cindex "&_/etc/aliases_&"
2290 One change is made to the default configuration file when it is installed: the
2291 default configuration contains a router that references a system aliases file.
2292 The path to this file is set to the value specified by
2293 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2294 If the system aliases file does not exist, the installation script creates it,
2295 and outputs a comment to the user.
2296
2297 The created file contains no aliases, but it does contain comments about the
2298 aliases a site should normally have. Mail aliases have traditionally been
2299 kept in &_/etc/aliases_&. However, some operating systems are now using
2300 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2301 Exim's configuration if necessary.
2302
2303 The default configuration uses the local host's name as the only local domain,
2304 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2305 running as the local user. System aliases and &_.forward_& files in users' home
2306 directories are supported, but no NIS or NIS+ support is configured. Domains
2307 other than the name of the local host are routed using the DNS, with delivery
2308 over SMTP.
2309
2310 It is possible to install Exim for special purposes (such as building a binary
2311 distribution) in a private part of the file system. You can do this by a
2312 command such as
2313 .code
2314 make DESTDIR=/some/directory/ install
2315 .endd
2316 This has the effect of pre-pending the specified directory to all the file
2317 paths, except the name of the system aliases file that appears in the default
2318 configuration. (If a default alias file is created, its name &'is'& modified.)
2319 For backwards compatibility, ROOT is used if DESTDIR is not set,
2320 but this usage is deprecated.
2321
2322 .cindex "installing Exim" "what is not installed"
2323 Running &'make install'& does not copy the Exim 4 conversion script
2324 &'convert4r4'&. You will probably run this only once if you are
2325 upgrading from Exim 3. None of the documentation files in the &_doc_&
2326 directory are copied, except for the info files when you have set
2327 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2328
2329 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2330 to their names. The Exim binary itself, however, is handled differently. It is
2331 installed under a name that includes the version number and the compile number,
2332 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2333 called &_exim_& to point to the binary. If you are updating a previous version
2334 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2335 from the directory (as seen by other processes).
2336
2337 .cindex "installing Exim" "testing the script"
2338 If you want to see what the &'make install'& will do before running it for
2339 real, you can pass the &%-n%& option to the installation script by this
2340 command:
2341 .code
2342 make INSTALL_ARG=-n install
2343 .endd
2344 The contents of the variable INSTALL_ARG are passed to the installation
2345 script. You do not need to be root to run this test. Alternatively, you can run
2346 the installation script directly, but this must be from within the build
2347 directory. For example, from the top-level Exim directory you could use this
2348 command:
2349 .code
2350 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2351 .endd
2352 .cindex "installing Exim" "install script options"
2353 There are two other options that can be supplied to the installation script.
2354
2355 .ilist
2356 &%-no_chown%& bypasses the call to change the owner of the installed binary
2357 to root, and the call to make it a setuid binary.
2358 .next
2359 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2360 installed binary.
2361 .endlist
2362
2363 INSTALL_ARG can be used to pass these options to the script. For example:
2364 .code
2365 make INSTALL_ARG=-no_symlink install
2366 .endd
2367 The installation script can also be given arguments specifying which files are
2368 to be copied. For example, to install just the Exim binary, and nothing else,
2369 without creating the symbolic link, you could use:
2370 .code
2371 make INSTALL_ARG='-no_symlink exim' install
2372 .endd
2373
2374
2375
2376 .section "Installing info documentation" "SECTinsinfdoc"
2377 .cindex "installing Exim" "&'info'& documentation"
2378 Not all systems use the GNU &'info'& system for documentation, and for this
2379 reason, the Texinfo source of Exim's documentation is not included in the main
2380 distribution. Instead it is available separately from the ftp site (see section
2381 &<<SECTavail>>&).
2382
2383 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2384 source of the documentation is found in the source tree, running &`make
2385 install`& automatically builds the info files and installs them.
2386
2387
2388
2389 .section "Setting up the spool directory" "SECID33"
2390 .cindex "spool directory" "creating"
2391 When it starts up, Exim tries to create its spool directory if it does not
2392 exist. The Exim uid and gid are used for the owner and group of the spool
2393 directory. Sub-directories are automatically created in the spool directory as
2394 necessary.
2395
2396
2397
2398
2399 .section "Testing" "SECID34"
2400 .cindex "testing" "installation"
2401 Having installed Exim, you can check that the run time configuration file is
2402 syntactically valid by running the following command, which assumes that the
2403 Exim binary directory is within your PATH environment variable:
2404 .code
2405 exim -bV
2406 .endd
2407 If there are any errors in the configuration file, Exim outputs error messages.
2408 Otherwise it outputs the version number and build date,
2409 the DBM library that is being used, and information about which drivers and
2410 other optional code modules are included in the binary.
2411 Some simple routing tests can be done by using the address testing option. For
2412 example,
2413 .display
2414 &`exim -bt`& <&'local username'&>
2415 .endd
2416 should verify that it recognizes a local mailbox, and
2417 .display
2418 &`exim -bt`& <&'remote address'&>
2419 .endd
2420 a remote one. Then try getting it to deliver mail, both locally and remotely.
2421 This can be done by passing messages directly to Exim, without going through a
2422 user agent. For example:
2423 .code
2424 exim -v postmaster@your.domain.example
2425 From: user@your.domain.example
2426 To: postmaster@your.domain.example
2427 Subject: Testing Exim
2428
2429 This is a test message.
2430 ^D
2431 .endd
2432 The &%-v%& option causes Exim to output some verification of what it is doing.
2433 In this case you should see copies of three log lines, one for the message's
2434 arrival, one for its delivery, and one containing &"Completed"&.
2435
2436 .cindex "delivery" "problems with"
2437 If you encounter problems, look at Exim's log files (&'mainlog'& and
2438 &'paniclog'&) to see if there is any relevant information there. Another source
2439 of information is running Exim with debugging turned on, by specifying the
2440 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2441 with debugging turned on by a command of the form
2442 .display
2443 &`exim -d -M`& <&'exim-message-id'&>
2444 .endd
2445 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2446 produces rather a lot of output, but you can cut this down to specific areas.
2447 For example, if you use &%-d-all+route%& only the debugging information
2448 relevant to routing is included. (See the &%-d%& option in chapter
2449 &<<CHAPcommandline>>& for more details.)
2450
2451 .cindex '&"sticky"& bit'
2452 .cindex "lock files"
2453 One specific problem that has shown up on some sites is the inability to do
2454 local deliveries into a shared mailbox directory, because it does not have the
2455 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2456 writing to a mailbox file, and if it cannot create the lock file, the delivery
2457 is deferred. You can get round this either by setting the &"sticky bit"& on the
2458 directory, or by setting a specific group for local deliveries and allowing
2459 that group to create files in the directory (see the comments above the
2460 &(local_delivery)& transport in the default configuration file). Another
2461 approach is to configure Exim not to use lock files, but just to rely on
2462 &[fcntl()]& locking instead. However, you should do this only if all user
2463 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2464 see chapter &<<CHAPappendfile>>&.
2465
2466 One thing that cannot be tested on a system that is already running an MTA is
2467 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2468 &%-oX%& option can be used to run an Exim daemon that listens on some other
2469 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2470 &'exim_checkaccess'& utility can be used to check out policy controls on
2471 incoming SMTP mail.
2472
2473 Testing a new version on a system that is already running Exim can most easily
2474 be done by building a binary with a different CONFIGURE_FILE setting. From
2475 within the run time configuration, all other file and directory names
2476 that Exim uses can be altered, in order to keep it entirely clear of the
2477 production version.
2478
2479
2480 .section "Replacing another MTA with Exim" "SECID35"
2481 .cindex "replacing another MTA"
2482 Building and installing Exim for the first time does not of itself put it in
2483 general use. The name by which the system's MTA is called by mail user agents
2484 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2485 operating system), and it is necessary to make this name point to the &'exim'&
2486 binary in order to get the user agents to pass messages to Exim. This is
2487 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2488 or &_/usr/lib/sendmail_&
2489 .cindex "symbolic link" "to &'exim'& binary"
2490 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2491 privilege and executable status from the old MTA. It is then necessary to stop
2492 and restart the mailer daemon, if one is running.
2493
2494 .cindex "FreeBSD, MTA indirection"
2495 .cindex "&_/etc/mail/mailer.conf_&"
2496 Some operating systems have introduced alternative ways of switching MTAs. For
2497 example, if you are running FreeBSD, you need to edit the file
2498 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2499 described. A typical example of the contents of this file for running Exim is
2500 as follows:
2501 .code
2502 sendmail            /usr/exim/bin/exim
2503 send-mail           /usr/exim/bin/exim
2504 mailq               /usr/exim/bin/exim -bp
2505 newaliases          /usr/bin/true
2506 .endd
2507 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2508 your Exim installation is &"live"&. Check it by sending a message from your
2509 favourite user agent.
2510
2511 You should consider what to tell your users about the change of MTA. Exim may
2512 have different capabilities to what was previously running, and there are
2513 various operational differences such as the text of messages produced by
2514 command line options and in bounce messages. If you allow your users to make
2515 use of Exim's filtering capabilities, you should make the document entitled
2516 &'Exim's interface to mail filtering'& available to them.
2517
2518
2519
2520 .section "Upgrading Exim" "SECID36"
2521 .cindex "upgrading Exim"
2522 If you are already running Exim on your host, building and installing a new
2523 version automatically makes it available to MUAs, or any other programs that
2524 call the MTA directly. However, if you are running an Exim daemon, you do need
2525 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2526 new binary. You do not need to stop processing mail in order to install a new
2527 version of Exim. The install script does not modify an existing runtime
2528 configuration file.
2529
2530
2531
2532
2533 .section "Stopping the Exim daemon on Solaris" "SECID37"
2534 .cindex "Solaris" "stopping Exim on"
2535 The standard command for stopping the mailer daemon on Solaris is
2536 .code
2537 /etc/init.d/sendmail stop
2538 .endd
2539 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2540 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2541 for the text &"sendmail"&; this is not present because the actual program name
2542 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2543 solution is to replace the line that finds the process id with something like
2544 .code
2545 pid=`cat /var/spool/exim/exim-daemon.pid`
2546 .endd
2547 to obtain the daemon's pid directly from the file that Exim saves it in.
2548
2549 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2550 still be received from local processes, and if automatic delivery is configured
2551 (the normal case), deliveries will still occur.
2552
2553
2554
2555
2556 . ////////////////////////////////////////////////////////////////////////////
2557 . ////////////////////////////////////////////////////////////////////////////
2558
2559 .chapter "The Exim command line" "CHAPcommandline"
2560 .scindex IIDclo1 "command line" "options"
2561 .scindex IIDclo2 "options" "command line"
2562 Exim's command line takes the standard Unix form of a sequence of options,
2563 each starting with a hyphen character, followed by a number of arguments. The
2564 options are compatible with the main options of Sendmail, and there are also
2565 some additional options, some of which are compatible with Smail 3. Certain
2566 combinations of options do not make sense, and provoke an error if used.
2567 The form of the arguments depends on which options are set.
2568
2569
2570 .section "Setting options by program name" "SECID38"
2571 .cindex "&'mailq'&"
2572 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2573 were present before any other options.
2574 The &%-bp%& option requests a listing of the contents of the mail queue on the
2575 standard output.
2576 This feature is for compatibility with some systems that contain a command of
2577 that name in one of the standard libraries, symbolically linked to
2578 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2579
2580 .cindex "&'rsmtp'&"
2581 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2582 were present before any other options, for compatibility with Smail. The
2583 &%-bS%& option is used for reading in a number of messages in batched SMTP
2584 format.
2585
2586 .cindex "&'rmail'&"
2587 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2588 &%-oee%& options were present before any other options, for compatibility with
2589 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2590
2591 .cindex "&'runq'&"
2592 .cindex "queue runner"
2593 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2594 were present before any other options, for compatibility with Smail. The &%-q%&
2595 option causes a single queue runner process to be started.
2596
2597 .cindex "&'newaliases'&"
2598 .cindex "alias file" "building"
2599 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2600 If Exim is called under the name &'newaliases'& it behaves as if the option
2601 &%-bi%& were present before any other options, for compatibility with Sendmail.
2602 This option is used for rebuilding Sendmail's alias file. Exim does not have
2603 the concept of a single alias file, but can be configured to run a given
2604 command if called with the &%-bi%& option.
2605
2606
2607 .section "Trusted and admin users" "SECTtrustedadmin"
2608 Some Exim options are available only to &'trusted users'& and others are
2609 available only to &'admin users'&. In the description below, the phrases &"Exim
2610 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2611 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2612 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2613
2614 .ilist
2615 .cindex "trusted users" "definition of"
2616 .cindex "user" "trusted definition of"
2617 The trusted users are root, the Exim user, any user listed in the
2618 &%trusted_users%& configuration option, and any user whose current group or any
2619 supplementary group is one of those listed in the &%trusted_groups%&
2620 configuration option. Note that the Exim group is not automatically trusted.
2621
2622 .cindex '&"From"& line'
2623 .cindex "envelope sender"
2624 Trusted users are always permitted to use the &%-f%& option or a leading
2625 &"From&~"& line to specify the envelope sender of a message that is passed to
2626 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2627 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2628 users to set envelope senders.
2629
2630 .cindex "&'From:'& header line"
2631 .cindex "&'Sender:'& header line"
2632 For a trusted user, there is never any check on the contents of the &'From:'&
2633 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2634 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2635
2636 Trusted users may also specify a host name, host address, interface address,
2637 protocol name, ident value, and authentication data when submitting a message
2638 locally. Thus, they are able to insert messages into Exim's queue locally that
2639 have the characteristics of messages received from a remote host. Untrusted
2640 users may in some circumstances use &%-f%&, but can never set the other values
2641 that are available to trusted users.
2642 .next
2643 .cindex "user" "admin definition of"
2644 .cindex "admin user" "definition of"
2645 The admin users are root, the Exim user, and any user that is a member of the
2646 Exim group or of any group listed in the &%admin_groups%& configuration option.
2647 The current group does not have to be one of these groups.
2648
2649 Admin users are permitted to list the queue, and to carry out certain
2650 operations on messages, for example, to force delivery failures. It is also
2651 necessary to be an admin user in order to see the full information provided by
2652 the Exim monitor, and full debugging output.
2653
2654 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2655 Exim to attempt delivery of messages on its queue is restricted to admin users.
2656 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2657 option false (that is, specifying &%no_prod_requires_admin%&).
2658
2659 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2660 is restricted to admin users unless &%queue_list_requires_admin%& is set
2661 false.
2662 .endlist
2663
2664
2665 &*Warning*&: If you configure your system so that admin users are able to
2666 edit Exim's configuration file, you are giving those users an easy way of
2667 getting root. There is further discussion of this issue at the start of chapter
2668 &<<CHAPconf>>&.
2669
2670
2671
2672
2673 .section "Command line options" "SECID39"
2674 Exim's command line options are described in alphabetical order below. If none
2675 of the options that specifies a specific action (such as starting the daemon or
2676 a queue runner, or testing an address, or receiving a message in a specific
2677 format, or listing the queue) are present, and there is at least one argument
2678 on the command line, &%-bm%& (accept a local message on the standard input,
2679 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2680 outputs a brief message about itself and exits.
2681
2682 . ////////////////////////////////////////////////////////////////////////////
2683 . Insert a stylized XML comment here, to identify the start of the command line
2684 . options. This is for the benefit of the Perl script that automatically
2685 . creates a man page for the options.
2686 . ////////////////////////////////////////////////////////////////////////////
2687
2688 .literal xml
2689 <!-- === Start of command line options === -->
2690 .literal off
2691
2692
2693 .vlist
2694 .vitem &%--%&
2695 .oindex "--"
2696 .cindex "options" "command line; terminating"
2697 This is a pseudo-option whose only purpose is to terminate the options and
2698 therefore to cause subsequent command line items to be treated as arguments
2699 rather than options, even if they begin with hyphens.
2700
2701 .vitem &%--help%&
2702 .oindex "&%--help%&"
2703 This option causes Exim to output a few sentences stating what it is.
2704 The same output is generated if the Exim binary is called with no options and
2705 no arguments.
2706
2707 .vitem &%--version%&
2708 .oindex "&%--version%&"
2709 This option is an alias for &%-bV%& and causes version information to be
2710 displayed.
2711
2712 .new
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 .wen
2720
2721 .vitem &%-B%&<&'type'&>
2722 .oindex "&%-B%&"
2723 .cindex "8-bit characters"
2724 .cindex "Sendmail compatibility" "8-bit characters"
2725 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2726 clean; it ignores this option.
2727
2728 .vitem &%-bd%&
2729 .oindex "&%-bd%&"
2730 .cindex "daemon"
2731 .cindex "SMTP" "listener"
2732 .cindex "queue runner"
2733 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2734 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2735 that the daemon should also initiate periodic queue runs.
2736
2737 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2738 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2739 disconnect from the controlling terminal. When running this way, it can be
2740 stopped by pressing ctrl-C.
2741
2742 By default, Exim listens for incoming connections to the standard SMTP port on
2743 all the host's running interfaces. However, it is possible to listen on other
2744 ports, on multiple ports, and only on specific interfaces. Chapter
2745 &<<CHAPinterfaces>>& contains a description of the options that control this.
2746
2747 When a listening daemon
2748 .cindex "daemon" "process id (pid)"
2749 .cindex "pid (process id)" "of daemon"
2750 is started without the use of &%-oX%& (that is, without overriding the normal
2751 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2752 in Exim's spool directory. This location can be overridden by setting
2753 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2754 running as root.
2755
2756 When &%-oX%& is used on the command line to start a listening daemon, the
2757 process id is not written to the normal pid file path. However, &%-oP%& can be
2758 used to specify a path on the command line if a pid file is required.
2759
2760 The SIGHUP signal
2761 .cindex "SIGHUP"
2762 .cindex "daemon" "restarting"
2763 can be used to cause the daemon to re-execute itself. This should be done
2764 whenever Exim's configuration file, or any file that is incorporated into it by
2765 means of the &%.include%& facility, is changed, and also whenever a new version
2766 of Exim is installed. It is not necessary to do this when other files that are
2767 referenced from the configuration (for example, alias files) are changed,
2768 because these are reread each time they are used.
2769
2770 .vitem &%-bdf%&
2771 .oindex "&%-bdf%&"
2772 This option has the same effect as &%-bd%& except that it never disconnects
2773 from the controlling terminal, even when no debugging is specified.
2774
2775 .vitem &%-be%&
2776 .oindex "&%-be%&"
2777 .cindex "testing" "string expansion"
2778 .cindex "expansion" "testing"
2779 Run Exim in expansion testing mode. Exim discards its root privilege, to
2780 prevent ordinary users from using this mode to read otherwise inaccessible
2781 files. If no arguments are given, Exim runs interactively, prompting for lines
2782 of data. Otherwise, it processes each argument in turn.
2783
2784 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2785 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2786 used without command line arguments. If successful, it uses the &[readline()]&
2787 function, which provides extensive line-editing facilities, for reading the
2788 test data. A line history is supported.
2789
2790 Long expansion expressions can be split over several lines by using backslash
2791 continuations. As in Exim's run time configuration, white space at the start of
2792 continuation lines is ignored. Each argument or data line is passed through the
2793 string expansion mechanism, and the result is output. Variable values from the
2794 configuration file (for example, &$qualify_domain$&) are available, but no
2795 message-specific values (such as &$sender_domain$&) are set, because no message
2796 is being processed (but see &%-bem%& and &%-Mset%&).
2797
2798 &*Note*&: If you use this mechanism to test lookups, and you change the data
2799 files or databases you are using, you must exit and restart Exim before trying
2800 the same lookup again. Otherwise, because each Exim process caches the results
2801 of lookups, you will just get the same result as before.
2802
2803 .vitem &%-bem%&&~<&'filename'&>
2804 .oindex "&%-bem%&"
2805 .cindex "testing" "string expansion"
2806 .cindex "expansion" "testing"
2807 This option operates like &%-be%& except that it must be followed by the name
2808 of a file. For example:
2809 .code
2810 exim -bem /tmp/testmessage
2811 .endd
2812 The file is read as a message (as if receiving a locally-submitted non-SMTP
2813 message) before any of the test expansions are done. Thus, message-specific
2814 variables such as &$message_size$& and &$header_from:$& are available. However,
2815 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2816 recipients are read from the headers in the normal way, and are shown in the
2817 &$recipients$& variable. Note that recipients cannot be given on the command
2818 line, because further arguments are taken as strings to expand (just like
2819 &%-be%&).
2820
2821 .vitem &%-bF%&&~<&'filename'&>
2822 .oindex "&%-bF%&"
2823 .cindex "system filter" "testing"
2824 .cindex "testing" "system filter"
2825 This option is the same as &%-bf%& except that it assumes that the filter being
2826 tested is a system filter. The additional commands that are available only in
2827 system filters are recognized.
2828
2829 .vitem &%-bf%&&~<&'filename'&>
2830 .oindex "&%-bf%&"
2831 .cindex "filter" "testing"
2832 .cindex "testing" "filter file"
2833 .cindex "forward file" "testing"
2834 .cindex "testing" "forward file"
2835 .cindex "Sieve filter" "testing"
2836 This option runs Exim in user filter testing mode; the file is the filter file
2837 to be tested, and a test message must be supplied on the standard input. If
2838 there are no message-dependent tests in the filter, an empty file can be
2839 supplied.
2840
2841 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2842 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2843 filter and a user filter in the same run. For example:
2844 .code
2845 exim -bF /system/filter -bf /user/filter </test/message
2846 .endd
2847 This is helpful when the system filter adds header lines or sets filter
2848 variables that are used by the user filter.
2849
2850 If the test filter file does not begin with one of the special lines
2851 .code
2852 # Exim filter
2853 # Sieve filter
2854 .endd
2855 it is taken to be a normal &_.forward_& file, and is tested for validity under
2856 that interpretation. See sections &<<SECTitenonfilred>>& to
2857 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2858 redirection lists.
2859
2860 The result of an Exim command that uses &%-bf%&, provided no errors are
2861 detected, is a list of the actions that Exim would try to take if presented
2862 with the message for real. More details of filter testing are given in the
2863 separate document entitled &'Exim's interfaces to mail filtering'&.
2864
2865 When testing a filter file,
2866 .cindex "&""From""& line"
2867 .cindex "envelope sender"
2868 .oindex "&%-f%&" "for filter testing"
2869 the envelope sender can be set by the &%-f%& option,
2870 or by a &"From&~"& line at the start of the test message. Various parameters
2871 that would normally be taken from the envelope recipient address of the message
2872 can be set by means of additional command line options (see the next four
2873 options).
2874
2875 .vitem &%-bfd%&&~<&'domain'&>
2876 .oindex "&%-bfd%&"
2877 .vindex "&$qualify_domain$&"
2878 This sets the domain of the recipient address when a filter file is being
2879 tested by means of the &%-bf%& option. The default is the value of
2880 &$qualify_domain$&.
2881
2882 .vitem &%-bfl%&&~<&'local&~part'&>
2883 .oindex "&%-bfl%&"
2884 This sets the local part of the recipient address when a filter file is being
2885 tested by means of the &%-bf%& option. The default is the username of the
2886 process that calls Exim. A local part should be specified with any prefix or
2887 suffix stripped, because that is how it appears to the filter when a message is
2888 actually being delivered.
2889
2890 .vitem &%-bfp%&&~<&'prefix'&>
2891 .oindex "&%-bfp%&"
2892 This sets the prefix of the local part of the recipient address when a filter
2893 file is being tested by means of the &%-bf%& option. The default is an empty
2894 prefix.
2895
2896 .vitem &%-bfs%&&~<&'suffix'&>
2897 .oindex "&%-bfs%&"
2898 This sets the suffix of the local part of the recipient address when a filter
2899 file is being tested by means of the &%-bf%& option. The default is an empty
2900 suffix.
2901
2902 .vitem &%-bh%&&~<&'IP&~address'&>
2903 .oindex "&%-bh%&"
2904 .cindex "testing" "incoming SMTP"
2905 .cindex "SMTP" "testing incoming"
2906 .cindex "testing" "relay control"
2907 .cindex "relaying" "testing configuration"
2908 .cindex "policy control" "testing"
2909 .cindex "debugging" "&%-bh%& option"
2910 This option runs a fake SMTP session as if from the given IP address, using the
2911 standard input and output. The IP address may include a port number at the end,
2912 after a full stop. For example:
2913 .code
2914 exim -bh 10.9.8.7.1234
2915 exim -bh fe80::a00:20ff:fe86:a061.5678
2916 .endd
2917 When an IPv6 address is given, it is converted into canonical form. In the case
2918 of the second example above, the value of &$sender_host_address$& after
2919 conversion to the canonical form is
2920 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2921
2922 Comments as to what is going on are written to the standard error file. These
2923 include lines beginning with &"LOG"& for anything that would have been logged.
2924 This facility is provided for testing configuration options for incoming
2925 messages, to make sure they implement the required policy. For example, you can
2926 test your relay controls using &%-bh%&.
2927
2928 &*Warning 1*&:
2929 .cindex "RFC 1413"
2930 You can test features of the configuration that rely on ident (RFC 1413)
2931 information by using the &%-oMt%& option. However, Exim cannot actually perform
2932 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2933 connection.
2934
2935 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2936 are also skipped when testing using &%-bh%&. If you want these callouts to
2937 occur, use &%-bhc%& instead.
2938
2939 Messages supplied during the testing session are discarded, and nothing is
2940 written to any of the real log files. There may be pauses when DNS (and other)
2941 lookups are taking place, and of course these may time out. The &%-oMi%& option
2942 can be used to specify a specific IP interface and port if this is important,
2943 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2944 session were authenticated.
2945
2946 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2947 output just states whether a given recipient address from a given host is
2948 acceptable or not. See section &<<SECTcheckaccess>>&.
2949
2950 Features such as authentication and encryption, where the client input is not
2951 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2952 specialized SMTP test program such as
2953 &url(http://jetmore.org/john/code/#swaks,swaks).
2954
2955 .vitem &%-bhc%&&~<&'IP&~address'&>
2956 .oindex "&%-bhc%&"
2957 This option operates in the same way as &%-bh%&, except that address
2958 verification callouts are performed if required. This includes consulting and
2959 updating the callout cache database.
2960
2961 .vitem &%-bi%&
2962 .oindex "&%-bi%&"
2963 .cindex "alias file" "building"
2964 .cindex "building alias file"
2965 .cindex "Sendmail compatibility" "&%-bi%& option"
2966 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2967 Exim does not have the concept of a single alias file, and so it cannot mimic
2968 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2969 tend to appear in various scripts such as NIS make files, so the option must be
2970 recognized.
2971
2972 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2973 configuration option is run, under the uid and gid of the caller of Exim. If
2974 the &%-oA%& option is used, its value is passed to the command as an argument.
2975 The command set by &%bi_command%& may not contain arguments. The command can
2976 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2977 if this is required. If the &%bi_command%& option is not set, calling Exim with
2978 &%-bi%& is a no-op.
2979
2980 .new
2981 . // Keep :help first, then the rest in alphabetical order
2982 .vitem &%-bI:help%&
2983 .oindex "&%-bI:help%&"
2984 .cindex "querying exim information"
2985 We shall provide various options starting &`-bI:`& for querying Exim for
2986 information.  The output of many of these will be intended for machine
2987 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2988 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2989 options shall cause Exim to exit after producing the requested output.
2990
2991 .vitem &%-bI:dscp%&
2992 .oindex "&%-bI:dscp%&"
2993 .cindex "DSCP" "values"
2994 This option causes Exim to emit an alphabetically sorted list of all
2995 recognised DSCP names.
2996
2997 .vitem &%-bI:sieve%&
2998 .oindex "&%-bI:sieve%&"
2999 .cindex "Sieve filter" "capabilities"
3000 This option causes Exim to emit an alphabetically sorted list of all supported
3001 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3002 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3003 &`SIEVE`& capability response line.  As the precise list may depend upon
3004 compile-time build options, which this option will adapt to, this is the only
3005 way to guarantee a correct response.
3006 .wen
3007
3008 .vitem &%-bm%&
3009 .oindex "&%-bm%&"
3010 .cindex "local message reception"
3011 This option runs an Exim receiving process that accepts an incoming,
3012 locally-generated message on the standard input. The recipients are given as the
3013 command arguments (except when &%-t%& is also present &-- see below). Each
3014 argument can be a comma-separated list of RFC 2822 addresses. This is the
3015 default option for selecting the overall action of an Exim call; it is assumed
3016 if no other conflicting option is present.
3017
3018 If any addresses in the message are unqualified (have no domain), they are
3019 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3020 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3021 suppressing this for special cases.
3022
3023 Policy checks on the contents of local messages can be enforced by means of
3024 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3025
3026 .cindex "return code" "for &%-bm%&"
3027 The return code is zero if the message is successfully accepted. Otherwise, the
3028 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3029
3030 The format
3031 .cindex "message" "format"
3032 .cindex "format" "message"
3033 .cindex "&""From""& line"
3034 .cindex "UUCP" "&""From""& line"
3035 .cindex "Sendmail compatibility" "&""From""& line"
3036 of the message must be as defined in RFC 2822, except that, for
3037 compatibility with Sendmail and Smail, a line in one of the forms
3038 .code
3039 From sender Fri Jan  5 12:55 GMT 1997
3040 From sender Fri, 5 Jan 97 12:55:01
3041 .endd
3042 (with the weekday optional, and possibly with additional text after the date)
3043 is permitted to appear at the start of the message. There appears to be no
3044 authoritative specification of the format of this line. Exim recognizes it by
3045 matching against the regular expression defined by the &%uucp_from_pattern%&
3046 option, which can be changed if necessary.
3047
3048 .oindex "&%-f%&" "overriding &""From""& line"
3049 The specified sender is treated as if it were given as the argument to the
3050 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3051 preference to the address taken from the message. The caller of Exim must be a
3052 trusted user for the sender of a message to be set in this way.
3053
3054 .vitem &%-bmalware%&&~<&'filename'&>
3055 .oindex "&%-bmalware%&"
3056 .cindex "testing", "malware"
3057 .cindex "malware scan test"
3058 This debugging option causes Exim to scan the given file,
3059 using the malware scanning framework.  The option of &%av_scanner%& influences
3060 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3061 the expansion should have defaults which apply to this invocation.  ACLs are
3062 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3063 will never be populated and &%-bmalware%& will fail.
3064
3065 Exim will have changed working directory before resolving the filename, so
3066 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3067 user when it tries to open the file, rather than as the invoking user.
3068 This option requires admin privileges.
3069
3070 The &%-bmalware%& option will not be extended to be more generally useful,
3071 there are better tools for file-scanning.  This option exists to help
3072 administrators verify their Exim and AV scanner configuration.
3073
3074 .vitem &%-bnq%&
3075 .oindex "&%-bnq%&"
3076 .cindex "address qualification, suppressing"
3077 By default, Exim automatically qualifies unqualified addresses (those
3078 without domains) that appear in messages that are submitted locally (that
3079 is, not over TCP/IP). This qualification applies both to addresses in
3080 envelopes, and addresses in header lines. Sender addresses are qualified using
3081 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3082 defaults to the value of &%qualify_domain%&).
3083
3084 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3085 being used to re-submit messages that originally came from remote hosts after
3086 content scanning, you probably do not want to qualify unqualified addresses in
3087 header lines. (Such lines will be present only if you have not enabled a header
3088 syntax check in the appropriate ACL.)
3089
3090 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3091 messages that originate on the local host. When this is used, unqualified
3092 addresses in the envelope provoke errors (causing message rejection) and
3093 unqualified addresses in header lines are left alone.
3094
3095
3096 .vitem &%-bP%&
3097 .oindex "&%-bP%&"
3098 .cindex "configuration options" "extracting"
3099 .cindex "options" "configuration &-- extracting"
3100 If this option is given with no arguments, it causes the values of all Exim's
3101 main configuration options to be written to the standard output. The values
3102 of one or more specific options can be requested by giving their names as
3103 arguments, for example:
3104 .code
3105 exim -bP qualify_domain hold_domains
3106 .endd
3107 .cindex "hiding configuration option values"
3108 .cindex "configuration options" "hiding value of"
3109 .cindex "options" "hiding value of"
3110 However, any option setting that is preceded by the word &"hide"& in the
3111 configuration file is not shown in full, except to an admin user. For other
3112 users, the output is as in this example:
3113 .code
3114 mysql_servers = <value not displayable>
3115 .endd
3116 If &%configure_file%& is given as an argument, the name of the run time
3117 configuration file is output.
3118 If a list of configuration files was supplied, the value that is output here
3119 is the name of the file that was actually used.
3120
3121 .new
3122 .cindex "options" "hiding name of"
3123 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3124 name will not be output.
3125 .wen
3126
3127 .cindex "daemon" "process id (pid)"
3128 .cindex "pid (process id)" "of daemon"
3129 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3130 directories where log files and daemon pid files are written are output,
3131 respectively. If these values are unset, log files are written in a
3132 sub-directory of the spool directory called &%log%&, and the pid file is
3133 written directly into the spool directory.
3134
3135 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3136 .code
3137 exim -bP +local_domains
3138 .endd
3139 it searches for a matching named list of any type (domain, host, address, or
3140 local part) and outputs what it finds.
3141
3142 .cindex "options" "router &-- extracting"
3143 .cindex "options" "transport &-- extracting"
3144 .cindex "options" "authenticator &-- extracting"
3145 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3146 followed by the name of an appropriate driver instance, the option settings for
3147 that driver are output. For example:
3148 .code
3149 exim -bP transport local_delivery
3150 .endd
3151 The generic driver options are output first, followed by the driver's private
3152 options. A list of the names of drivers of a particular type can be obtained by
3153 using one of the words &%router_list%&, &%transport_list%&, or
3154 &%authenticator_list%&, and a complete list of all drivers with their option
3155 settings can be obtained by using &%routers%&, &%transports%&, or
3156 &%authenticators%&.
3157
3158 .cindex "options" "macro &-- extracting"
3159 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3160 are available, similarly to the drivers.  Because macros are sometimes used
3161 for storing passwords, this option is restricted.
3162 The output format is one item per line.
3163
3164 .vitem &%-bp%&
3165 .oindex "&%-bp%&"
3166 .cindex "queue" "listing messages on"
3167 .cindex "listing" "messages on the queue"
3168 This option requests a listing of the contents of the mail queue on the
3169 standard output. If the &%-bp%& option is followed by a list of message ids,
3170 just those messages are listed. By default, this option can be used only by an
3171 admin user. However, the &%queue_list_requires_admin%& option can be set false
3172 to allow any user to see the queue.
3173
3174 Each message on the queue is displayed as in the following example:
3175 .code
3176 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3177           red.king@looking-glass.fict.example
3178           <other addresses>
3179 .endd
3180 .cindex "message" "size in queue listing"
3181 .cindex "size" "of message"
3182 The first line contains the length of time the message has been on the queue
3183 (in this case 25 minutes), the size of the message (2.9K), the unique local
3184 identifier for the message, and the message sender, as contained in the
3185 envelope. For bounce messages, the sender address is empty, and appears as
3186 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3187 the default sender address, the user's login name is shown in parentheses
3188 before the sender address.
3189
3190 .cindex "frozen messages" "in queue listing"
3191 If the message is frozen (attempts to deliver it are suspended) then the text
3192 &"*** frozen ***"& is displayed at the end of this line.
3193
3194 The recipients of the message (taken from the envelope, not the headers) are
3195 displayed on subsequent lines. Those addresses to which the message has already
3196 been delivered are marked with the letter D. If an original address gets
3197 expanded into several addresses via an alias or forward file, the original is
3198 displayed with a D only when deliveries for all of its child addresses are
3199 complete.
3200
3201
3202 .vitem &%-bpa%&
3203 .oindex "&%-bpa%&"
3204 This option operates like &%-bp%&, but in addition it shows delivered addresses
3205 that were generated from the original top level address(es) in each message by
3206 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3207 of just &"D"&.
3208
3209
3210 .vitem &%-bpc%&
3211 .oindex "&%-bpc%&"
3212 .cindex "queue" "count of messages on"
3213 This option counts the number of messages on the queue, and writes the total
3214 to the standard output. It is restricted to admin users, unless
3215 &%queue_list_requires_admin%& is set false.
3216
3217
3218 .vitem &%-bpr%&
3219 .oindex "&%-bpr%&"
3220 This option operates like &%-bp%&, but the output is not sorted into
3221 chronological order of message arrival. This can speed it up when there are
3222 lots of messages on the queue, and is particularly useful if the output is
3223 going to be post-processed in a way that doesn't need the sorting.
3224
3225 .vitem &%-bpra%&
3226 .oindex "&%-bpra%&"
3227 This option is a combination of &%-bpr%& and &%-bpa%&.
3228
3229 .vitem &%-bpru%&
3230 .oindex "&%-bpru%&"
3231 This option is a combination of &%-bpr%& and &%-bpu%&.
3232
3233
3234 .vitem &%-bpu%&
3235 .oindex "&%-bpu%&"
3236 This option operates like &%-bp%& but shows only undelivered top-level
3237 addresses for each message displayed. Addresses generated by aliasing or
3238 forwarding are not shown, unless the message was deferred after processing by a
3239 router with the &%one_time%& option set.
3240
3241
3242 .vitem &%-brt%&
3243 .oindex "&%-brt%&"
3244 .cindex "testing" "retry configuration"
3245 .cindex "retry" "configuration testing"
3246 This option is for testing retry rules, and it must be followed by up to three
3247 arguments. It causes Exim to look for a retry rule that matches the values
3248 and to write it to the standard output. For example:
3249 .code
3250 exim -brt bach.comp.mus.example
3251 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3252 .endd
3253 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3254 argument, which is required, can be a complete address in the form
3255 &'local_part@domain'&, or it can be just a domain name. If the second argument
3256 contains a dot, it is interpreted as an optional second domain name; if no
3257 retry rule is found for the first argument, the second is tried. This ties in
3258 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3259 rule is found that matches the host, one that matches the mail domain is
3260 sought. Finally, an argument that is the name of a specific delivery error, as
3261 used in setting up retry rules, can be given. For example:
3262 .code
3263 exim -brt haydn.comp.mus.example quota_3d
3264 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3265 .endd
3266
3267 .vitem &%-brw%&
3268 .oindex "&%-brw%&"
3269 .cindex "testing" "rewriting"
3270 .cindex "rewriting" "testing"
3271 This option is for testing address rewriting rules, and it must be followed by
3272 a single argument, consisting of either a local part without a domain, or a
3273 complete address with a fully qualified domain. Exim outputs how this address
3274 would be rewritten for each possible place it might appear. See chapter
3275 &<<CHAPrewrite>>& for further details.
3276
3277 .vitem &%-bS%&
3278 .oindex "&%-bS%&"
3279 .cindex "SMTP" "batched incoming"
3280 .cindex "batched SMTP input"
3281 This option is used for batched SMTP input, which is an alternative interface
3282 for non-interactive local message submission. A number of messages can be
3283 submitted in a single run. However, despite its name, this is not really SMTP
3284 input. Exim reads each message's envelope from SMTP commands on the standard
3285 input, but generates no responses. If the caller is trusted, or
3286 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3287 believed; otherwise the sender is always the caller of Exim.
3288
3289 The message itself is read from the standard input, in SMTP format (leading
3290 dots doubled), terminated by a line containing just a single dot. An error is
3291 provoked if the terminating dot is missing. A further message may then follow.
3292
3293 As for other local message submissions, the contents of incoming batch SMTP
3294 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3295 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3296 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3297
3298 Some other SMTP commands are recognized in the input. HELO and EHLO act
3299 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3300 QUIT quits, ignoring the rest of the standard input.
3301
3302 .cindex "return code" "for &%-bS%&"
3303 If any error is encountered, reports are written to the standard output and
3304 error streams, and Exim gives up immediately. The return code is 0 if no error
3305 was detected; it is 1 if one or more messages were accepted before the error
3306 was detected; otherwise it is 2.
3307
3308 More details of input using batched SMTP are given in section
3309 &<<SECTincomingbatchedSMTP>>&.
3310
3311 .vitem &%-bs%&
3312 .oindex "&%-bs%&"
3313 .cindex "SMTP" "local input"
3314 .cindex "local SMTP input"
3315 This option causes Exim to accept one or more messages by reading SMTP commands
3316 on the standard input, and producing SMTP replies on the standard output. SMTP
3317 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3318 Some user agents use this interface as a way of passing locally-generated
3319 messages to the MTA.
3320
3321 In
3322 .cindex "sender" "source of"
3323 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3324 set, the senders of messages are taken from the SMTP MAIL commands.
3325 Otherwise the content of these commands is ignored and the sender is set up as
3326 the calling user. Unqualified addresses are automatically qualified using
3327 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3328 &%-bnq%& option is used.
3329
3330 .cindex "inetd"
3331 The
3332 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3333 using a listening daemon. Exim can distinguish the two cases by checking
3334 whether the standard input is a TCP/IP socket. When Exim is called from
3335 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3336 above concerning senders and qualification do not apply. In this situation,
3337 Exim behaves in exactly the same way as it does when receiving a message via
3338 the listening daemon.
3339
3340 .vitem &%-bt%&
3341 .oindex "&%-bt%&"
3342 .cindex "testing" "addresses"
3343 .cindex "address" "testing"
3344 This option runs Exim in address testing mode, in which each argument is taken
3345 as a recipient address to be tested for deliverability. The results are
3346 written to the standard output. If a test fails, and the caller is not an admin
3347 user, no details of the failure are output, because these might contain
3348 sensitive information such as usernames and passwords for database lookups.
3349
3350 If no arguments are given, Exim runs in an interactive manner, prompting with a
3351 right angle bracket for addresses to be tested.
3352
3353 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3354 &[readline()]& function, because it is running as &'root'& and there are
3355 security issues.
3356
3357 Each address is handled as if it were the recipient address of a message
3358 (compare the &%-bv%& option). It is passed to the routers and the result is
3359 written to the standard output. However, any router that has
3360 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3361 genuine routing tests if your first router passes everything to a scanner
3362 program.
3363
3364 .cindex "return code" "for &%-bt%&"
3365 The return code is 2 if any address failed outright; it is 1 if no address
3366 failed outright but at least one could not be resolved for some reason. Return
3367 code 0 is given only when all addresses succeed.
3368
3369 .cindex "duplicate addresses"
3370 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3371 addresses after routing is complete, so that only one delivery takes place.
3372 This does not happen when testing with &%-bt%&; the full results of routing are
3373 always shown.
3374
3375 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3376 routers in the configuration makes any tests on the sender address of a
3377 message,
3378 .oindex "&%-f%&" "for address testing"
3379 you can use the &%-f%& option to set an appropriate sender when running
3380 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3381 default qualifying domain. However, if you have set up (for example) routers
3382 whose behaviour depends on the contents of an incoming message, you cannot test
3383 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3384 doing such tests.
3385
3386 .vitem &%-bV%&
3387 .oindex "&%-bV%&"
3388 .cindex "version number of Exim"
3389 This option causes Exim to write the current version number, compilation
3390 number, and compilation date of the &'exim'& binary to the standard output.
3391 It also lists the DBM library that is being used, the optional modules (such as
3392 specific lookup types), the drivers that are included in the binary, and the
3393 name of the run time configuration file that is in use.
3394
3395 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3396 configuration file. However, this is a static check only. It cannot check
3397 values that are to be expanded. For example, although a misspelt ACL verb is
3398 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3399 alone to discover (for example) all the typos in the configuration; some
3400 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3401 dynamic testing facilities.
3402
3403 .vitem &%-bv%&
3404 .oindex "&%-bv%&"
3405 .cindex "verifying address" "using &%-bv%&"
3406 .cindex "address" "verification"
3407 This option runs Exim in address verification mode, in which each argument is
3408 taken as a recipient address to be verified by the routers. (This does
3409 not involve any verification callouts). During normal operation, verification
3410 happens mostly as a consequence processing a &%verify%& condition in an ACL
3411 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3412 including callouts, see the &%-bh%& and &%-bhc%& options.
3413
3414 If verification fails, and the caller is not an admin user, no details of the
3415 failure are output, because these might contain sensitive information such as
3416 usernames and passwords for database lookups.
3417
3418 If no arguments are given, Exim runs in an interactive manner, prompting with a
3419 right angle bracket for addresses to be verified.
3420
3421 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3422 &[readline()]& function, because it is running as &'exim'& and there are
3423 security issues.
3424
3425 Verification differs from address testing (the &%-bt%& option) in that routers
3426 that have &%no_verify%& set are skipped, and if the address is accepted by a
3427 router that has &%fail_verify%& set, verification fails. The address is
3428 verified as a recipient if &%-bv%& is used; to test verification for a sender
3429 address, &%-bvs%& should be used.
3430
3431 If the &%-v%& option is not set, the output consists of a single line for each
3432 address, stating whether it was verified or not, and giving a reason in the
3433 latter case. Without &%-v%&, generating more than one address by redirection
3434 causes verification to end successfully, without considering the generated
3435 addresses. However, if just one address is generated, processing continues,
3436 and the generated address must verify successfully for the overall verification
3437 to succeed.
3438
3439 When &%-v%& is set, more details are given of how the address has been handled,
3440 and in the case of address redirection, all the generated addresses are also
3441 considered. Verification may succeed for some and fail for others.
3442
3443 The
3444 .cindex "return code" "for &%-bv%&"
3445 return code is 2 if any address failed outright; it is 1 if no address
3446 failed outright but at least one could not be resolved for some reason. Return
3447 code 0 is given only when all addresses succeed.
3448
3449 If any of the routers in the configuration makes any tests on the sender
3450 address of a message, you should use the &%-f%& option to set an appropriate
3451 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3452 calling user at the default qualifying domain.
3453
3454 .vitem &%-bvs%&
3455 .oindex "&%-bvs%&"
3456 This option acts like &%-bv%&, but verifies the address as a sender rather
3457 than a recipient address. This affects any rewriting and qualification that
3458 might happen.
3459
3460 .vitem &%-bw%&
3461 .oindex "&%-bw%&"
3462 .cindex "daemon"
3463 .cindex "inetd"
3464 .cindex "inetd" "wait mode"
3465 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3466 similarly to the &%-bd%& option.  All port specifications on the command-line
3467 and in the configuration file are ignored.  Queue-running may not be specified.
3468
3469 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3470 listening for connections.  This permits the system to start up and have
3471 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3472 each port only when the first connection is received.
3473
3474 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3475 which the daemon will exit, which should cause inetd to listen once more.
3476
3477 .vitem &%-C%&&~<&'filelist'&>
3478 .oindex "&%-C%&"
3479 .cindex "configuration file" "alternate"
3480 .cindex "CONFIGURE_FILE"
3481 .cindex "alternate configuration file"
3482 This option causes Exim to find the run time configuration file from the given
3483 list instead of from the list specified by the CONFIGURE_FILE
3484 compile-time setting. Usually, the list will consist of just a single file
3485 name, but it can be a colon-separated list of names. In this case, the first
3486 file that exists is used. Failure to open an existing file stops Exim from
3487 proceeding any further along the list, and an error is generated.
3488
3489 When this option is used by a caller other than root, and the list is different
3490 from the compiled-in list, Exim gives up its root privilege immediately, and
3491 runs with the real and effective uid and gid set to those of the caller.
3492 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3493 file contains a list of full pathnames, one per line, for configuration files
3494 which are trusted. Root privilege is retained for any configuration file so
3495 listed, as long as the caller is the Exim user (or the user specified in the
3496 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3497 not writeable by inappropriate users or groups.
3498
3499 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3500 configuration using &%-C%& right through message reception and delivery,
3501 even if the caller is root. The reception works, but by that time, Exim is
3502 running as the Exim user, so when it re-executes to regain privilege for the
3503 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3504 test reception and delivery using two separate commands (one to put a message
3505 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3506
3507 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3508 prefix string with which any file named in a &%-C%& command line option
3509 must start. In addition, the file name must not contain the sequence &`/../`&.
3510 However, if the value of the &%-C%& option is identical to the value of
3511 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3512 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3513 unset, any file name can be used with &%-C%&.
3514
3515 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3516 to a directory to which only root has access. This prevents someone who has
3517 broken into the Exim account from running a privileged Exim with an arbitrary
3518 configuration file.
3519
3520 The &%-C%& facility is useful for ensuring that configuration files are
3521 syntactically correct, but cannot be used for test deliveries, unless the
3522 caller is privileged, or unless it is an exotic configuration that does not
3523 require privilege. No check is made on the owner or group of the files
3524 specified by this option.
3525
3526
3527 .vitem &%-D%&<&'macro'&>=<&'value'&>
3528 .oindex "&%-D%&"
3529 .cindex "macro" "setting on command line"
3530 This option can be used to override macro definitions in the configuration file
3531 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3532 unprivileged caller, it causes Exim to give up its root privilege.
3533 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3534 completely disabled, and its use causes an immediate error exit.
3535
3536 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3537 colon-separated list of macros which are considered safe and, if &%-D%& only
3538 supplies macros from this list, and the values are acceptable, then Exim will
3539 not give up root privilege if the caller is root, the Exim run-time user, or
3540 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3541 to be removed in the future.  Acceptable values for the macros satisfy the
3542 regexp: &`^[A-Za-z0-9_/.-]*$`&
3543
3544 The entire option (including equals sign if present) must all be within one
3545 command line item. &%-D%& can be used to set the value of a macro to the empty
3546 string, in which case the equals sign is optional. These two commands are
3547 synonymous:
3548 .code
3549 exim -DABC  ...
3550 exim -DABC= ...
3551 .endd
3552 To include spaces in a macro definition item, quotes must be used. If you use
3553 quotes, spaces are permitted around the macro name and the equals sign. For
3554 example:
3555 .code
3556 exim '-D ABC = something' ...
3557 .endd
3558 &%-D%& may be repeated up to 10 times on a command line.
3559
3560
3561 .vitem &%-d%&<&'debug&~options'&>
3562 .oindex "&%-d%&"
3563 .cindex "debugging" "list of selectors"
3564 .cindex "debugging" "&%-d%& option"
3565 This option causes debugging information to be written to the standard
3566 error stream. It is restricted to admin users because debugging output may show
3567 database queries that contain password information. Also, the details of users'
3568 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3569 writes an error message to the standard error stream and exits with a non-zero
3570 return code.
3571
3572 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3573 standard debugging data is output. This can be reduced, or increased to include
3574 some more rarely needed information, by directly following &%-d%& with a string
3575 made up of names preceded by plus or minus characters. These add or remove sets
3576 of debugging data, respectively. For example, &%-d+filter%& adds filter
3577 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3578 no spaces are allowed in the debug setting. The available debugging categories
3579 are:
3580 .display
3581 &`acl            `& ACL interpretation
3582 &`auth           `& authenticators
3583 &`deliver        `& general delivery logic
3584 &`dns            `& DNS lookups (see also resolver)
3585 &`dnsbl          `& DNS black list (aka RBL) code
3586 &`exec           `& arguments for &[execv()]& calls
3587 &`expand         `& detailed debugging for string expansions
3588 &`filter         `& filter handling
3589 &`hints_lookup   `& hints data lookups
3590 &`host_lookup    `& all types of name-to-IP address handling
3591 &`ident          `& ident lookup
3592 &`interface      `& lists of local interfaces
3593 &`lists          `& matching things in lists
3594 &`load           `& system load checks
3595 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3596                     &<<CHAPlocalscan>>&)
3597 &`lookup         `& general lookup code and all lookups
3598 &`memory         `& memory handling
3599 &`pid            `& add pid to debug output lines
3600 &`process_info   `& setting info for the process log
3601 &`queue_run      `& queue runs
3602 &`receive        `& general message reception logic
3603 &`resolver       `& turn on the DNS resolver's debugging output
3604 &`retry          `& retry handling
3605 &`rewrite        `& address rewriting
3606 &`route          `& address routing
3607 &`timestamp      `& add timestamp to debug output lines
3608 &`tls            `& TLS logic
3609 &`transport      `& transports
3610 &`uid            `& changes of uid/gid and looking up uid/gid
3611 &`verify         `& address verification logic
3612 &`all            `& almost all of the above (see below), and also &%-v%&
3613 .endd
3614 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3615 for &`-all`&. The reason for this is that &`+all`& is something that people
3616 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3617 is included, an awful lot of output that is very rarely of interest is
3618 generated, so it now has to be explicitly requested. However, &`-all`& does
3619 turn everything off.
3620
3621 .cindex "resolver, debugging output"
3622 .cindex "DNS resolver, debugging output"
3623 The &`resolver`& option produces output only if the DNS resolver was compiled
3624 with DEBUG enabled. This is not the case in some operating systems. Also,
3625 unfortunately, debugging output from the DNS resolver is written to stdout
3626 rather than stderr.
3627
3628 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3629 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3630 However, the &`pid`& selector is forced when debugging is turned on for a
3631 daemon, which then passes it on to any re-executed Exims. Exim also
3632 automatically adds the pid to debug lines when several remote deliveries are
3633 run in parallel.
3634
3635 The &`timestamp`& selector causes the current time to be inserted at the start
3636 of all debug output lines. This can be useful when trying to track down delays
3637 in processing.
3638
3639 If the &%debug_print%& option is set in any driver, it produces output whenever
3640 any debugging is selected, or if &%-v%& is used.
3641
3642 .vitem &%-dd%&<&'debug&~options'&>
3643 .oindex "&%-dd%&"
3644 This option behaves exactly like &%-d%& except when used on a command that
3645 starts a daemon process. In that case, debugging is turned off for the
3646 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3647 behaviour of the daemon without creating as much output as full debugging does.
3648
3649 .vitem &%-dropcr%&
3650 .oindex "&%-dropcr%&"
3651 This is an obsolete option that is now a no-op. It used to affect the way Exim
3652 handled CR and LF characters in incoming messages. What happens now is
3653 described in section &<<SECTlineendings>>&.
3654
3655 .vitem &%-E%&
3656 .oindex "&%-E%&"
3657 .cindex "bounce message" "generating"
3658 This option specifies that an incoming message is a locally-generated delivery
3659 failure report. It is used internally by Exim when handling delivery failures
3660 and is not intended for external use. Its only effect is to stop Exim
3661 generating certain messages to the postmaster, as otherwise message cascades
3662 could occur in some situations. As part of the same option, a message id may
3663 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3664 new message contains the id, following &"R="&, as a cross-reference.
3665
3666 .vitem &%-e%&&'x'&
3667 .oindex "&%-e%&&'x'&"
3668 There are a number of Sendmail options starting with &%-oe%& which seem to be
3669 called by various programs without the leading &%o%& in the option. For
3670 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3671 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3672
3673 .vitem &%-F%&&~<&'string'&>
3674 .oindex "&%-F%&"
3675 .cindex "sender" "name"
3676 .cindex "name" "of sender"
3677 This option sets the sender's full name for use when a locally-generated
3678 message is being accepted. In the absence of this option, the user's &'gecos'&
3679 entry from the password data is used. As users are generally permitted to alter
3680 their &'gecos'& entries, no security considerations are involved. White space
3681 between &%-F%& and the <&'string'&> is optional.
3682
3683 .vitem &%-f%&&~<&'address'&>
3684 .oindex "&%-f%&"
3685 .cindex "sender" "address"
3686 .cindex "address" "sender"
3687 .cindex "trusted users"
3688 .cindex "envelope sender"
3689 .cindex "user" "trusted"
3690 This option sets the address of the envelope sender of a locally-generated
3691 message (also known as the return path). The option can normally be used only
3692 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3693 users to use it.
3694
3695 Processes running as root or the Exim user are always trusted. Other
3696 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3697 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3698 of a local message is set to the caller's login name at the default qualify
3699 domain.
3700
3701 There is one exception to the restriction on the use of &%-f%&: an empty sender
3702 can be specified by any user, trusted or not, to create a message that can
3703 never provoke a bounce. An empty sender can be specified either as an empty
3704 string, or as a pair of angle brackets with nothing between them, as in these
3705 examples of shell commands:
3706 .code
3707 exim -f '<>' user@domain
3708 exim -f "" user@domain
3709 .endd
3710 In addition, the use of &%-f%& is not restricted when testing a filter file
3711 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3712 &%-bv%& options.
3713
3714 Allowing untrusted users to change the sender address does not of itself make
3715 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3716 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3717 though this can be overridden by setting &%no_local_from_check%&.
3718
3719 White
3720 .cindex "&""From""& line"
3721 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3722 given as two arguments or one combined argument). The sender of a
3723 locally-generated message can also be set (when permitted) by an initial
3724 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3725 if &%-f%& is also present, it overrides &"From&~"&.
3726
3727 .vitem &%-G%&
3728 .oindex "&%-G%&"
3729 .cindex "submission fixups, suppressing (command-line)"
3730 .new
3731 This option is equivalent to an ACL applying:
3732 .code
3733 control = suppress_local_fixups
3734 .endd
3735 for every message received.  Note that Sendmail will complain about such
3736 bad formatting, where Exim silently just does not fix it up.  This may change
3737 in future.
3738
3739 As this affects audit information, the caller must be a trusted user to use
3740 this option.
3741 .wen
3742
3743 .vitem &%-h%&&~<&'number'&>
3744 .oindex "&%-h%&"
3745 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3746 This option is accepted for compatibility with Sendmail, but has no effect. (In
3747 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3748 headers.)
3749
3750 .vitem &%-i%&
3751 .oindex "&%-i%&"
3752 .cindex "Solaris" "&'mail'& command"
3753 .cindex "dot" "in incoming non-SMTP message"
3754 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3755 line by itself should not terminate an incoming, non-SMTP message. I can find
3756 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3757 command in Solaris 2.4 uses it. See also &%-ti%&.
3758
3759 .new
3760 .vitem &%-L%&&~<&'tag'&>
3761 .oindex "&%-L%&"
3762 .cindex "syslog" "process name; set with flag"
3763 This option is equivalent to setting &%syslog_processname%& in the config
3764 file and setting &%log_file_path%& to &`syslog`&.
3765 Its use is restricted to administrators.  The configuration file has to be
3766 read and parsed, to determine access rights, before this is set and takes
3767 effect, so early configuration file errors will not honour this flag.
3768
3769 The tag should not be longer than 32 characters.
3770 .wen
3771
3772 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3773 .oindex "&%-M%&"
3774 .cindex "forcing delivery"
3775 .cindex "delivery" "forcing attempt"
3776 .cindex "frozen messages" "forcing delivery"
3777 This option requests Exim to run a delivery attempt on each message in turn. If
3778 any of the messages are frozen, they are automatically thawed before the
3779 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3780 and &%hold_domains%& are ignored.
3781
3782 Retry
3783 .cindex "hints database" "overriding retry hints"
3784 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3785 the normal retry time has not yet been reached. This option requires the caller
3786 to be an admin user. However, there is an option called &%prod_requires_admin%&
3787 which can be set false to relax this restriction (and also the same requirement
3788 for the &%-q%&, &%-R%&, and &%-S%& options).
3789
3790 The deliveries happen synchronously, that is, the original Exim process does
3791 not terminate until all the delivery attempts have finished. No output is
3792 produced unless there is a serious error. If you want to see what is happening,
3793 use the &%-v%& option as well, or inspect Exim's main log.
3794
3795 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3796 .oindex "&%-Mar%&"
3797 .cindex "message" "adding recipients"
3798 .cindex "recipient" "adding"
3799 This option requests Exim to add the addresses to the list of recipients of the
3800 message (&"ar"& for &"add recipients"&). The first argument must be a message
3801 id, and the remaining ones must be email addresses. However, if the message is
3802 active (in the middle of a delivery attempt), it is not altered. This option
3803 can be used only by an admin user.
3804
3805 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3806         &~<&'message&~id'&>"
3807 .oindex "&%-MC%&"
3808 .cindex "SMTP" "passed connection"
3809 .cindex "SMTP" "multiple deliveries"
3810 .cindex "multiple SMTP deliveries"
3811 This option is not intended for use by external callers. It is used internally
3812 by Exim to invoke another instance of itself to deliver a waiting message using
3813 an existing SMTP connection, which is passed as the standard input. Details are
3814 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3815 must be root or the Exim user in order to use it.
3816
3817 .vitem &%-MCA%&
3818 .oindex "&%-MCA%&"
3819 This option is not intended for use by external callers. It is used internally
3820 by Exim in conjunction with the &%-MC%& option. It signifies that the
3821 connection to the remote host has been authenticated.
3822
3823 .vitem &%-MCP%&
3824 .oindex "&%-MCP%&"
3825 This option is not intended for use by external callers. It is used internally
3826 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3827 which Exim is connected supports pipelining.
3828
3829 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3830 .oindex "&%-MCQ%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option when the original delivery was
3833 started by a queue runner. It passes on the process id of the queue runner,
3834 together with the file descriptor number of an open pipe. Closure of the pipe
3835 signals the final completion of the sequence of processes that are passing
3836 messages through the same SMTP connection.
3837
3838 .vitem &%-MCS%&
3839 .oindex "&%-MCS%&"
3840 This option is not intended for use by external callers. It is used internally
3841 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3842 SMTP SIZE option should be used on messages delivered down the existing
3843 connection.
3844
3845 .vitem &%-MCT%&
3846 .oindex "&%-MCT%&"
3847 This option is not intended for use by external callers. It is used internally
3848 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3849 host to which Exim is connected supports TLS encryption.
3850
3851 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3852 .oindex "&%-Mc%&"
3853 .cindex "hints database" "not overridden by &%-Mc%&"
3854 .cindex "delivery" "manually started &-- not forced"
3855 This option requests Exim to run a delivery attempt on each message in turn,
3856 but unlike the &%-M%& option, it does check for retry hints, and respects any
3857 that are found. This option is not very useful to external callers. It is
3858 provided mainly for internal use by Exim when it needs to re-invoke itself in
3859 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3860 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3861 respects retry times and other options such as &%hold_domains%& that are
3862 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3863 If you want to run a specific delivery as if in a queue run, you should use
3864 &%-q%& with a message id argument. A distinction between queue run deliveries
3865 and other deliveries is made in one or two places.
3866
3867 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3868 .oindex "&%-Mes%&"
3869 .cindex "message" "changing sender"
3870 .cindex "sender" "changing"
3871 This option requests Exim to change the sender address in the message to the
3872 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3873 &"edit sender"&). There must be exactly two arguments. The first argument must
3874 be a message id, and the second one an email address. However, if the message
3875 is active (in the middle of a delivery attempt), its status is not altered.
3876 This option can be used only by an admin user.
3877
3878 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3879 .oindex "&%-Mf%&"
3880 .cindex "freezing messages"
3881 .cindex "message" "manually freezing"
3882 This option requests Exim to mark each listed message as &"frozen"&. This
3883 prevents any delivery attempts taking place until the message is &"thawed"&,
3884 either manually or as a result of the &%auto_thaw%& configuration option.
3885 However, if any of the messages are active (in the middle of a delivery
3886 attempt), their status is not altered. This option can be used only by an admin
3887 user.
3888
3889 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3890 .oindex "&%-Mg%&"
3891 .cindex "giving up on messages"
3892 .cindex "message" "abandoning delivery attempts"
3893 .cindex "delivery" "abandoning further attempts"
3894 This option requests Exim to give up trying to deliver the listed messages,
3895 including any that are frozen. However, if any of the messages are active,
3896 their status is not altered. For non-bounce messages, a delivery error message
3897 is sent to the sender, containing the text &"cancelled by administrator"&.
3898 Bounce messages are just discarded. This option can be used only by an admin
3899 user.
3900
3901 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3902 .oindex "&%-Mmad%&"
3903 .cindex "delivery" "cancelling all"
3904 This option requests Exim to mark all the recipient addresses in the messages
3905 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3906 message is active (in the middle of a delivery attempt), its status is not
3907 altered. This option can be used only by an admin user.
3908
3909 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3910 .oindex "&%-Mmd%&"
3911 .cindex "delivery" "cancelling by address"
3912 .cindex "recipient" "removing"
3913 .cindex "removing recipients"
3914 This option requests Exim to mark the given addresses as already delivered
3915 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3916 the remaining ones must be email addresses. These are matched to recipient
3917 addresses in the message in a case-sensitive manner. If the message is active
3918 (in the middle of a delivery attempt), its status is not altered. This option
3919 can be used only by an admin user.
3920
3921 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3922 .oindex "&%-Mrm%&"
3923 .cindex "removing messages"
3924 .cindex "abandoning mail"
3925 .cindex "message" "manually discarding"
3926 This option requests Exim to remove the given messages from the queue. No
3927 bounce messages are sent; each message is simply forgotten. However, if any of
3928 the messages are active, their status is not altered. This option can be used
3929 only by an admin user or by the user who originally caused the message to be
3930 placed on the queue.
3931
3932 .vitem &%-Mset%&&~<&'message&~id'&>
3933 .oindex "&%-Mset%&
3934 .cindex "testing" "string expansion"
3935 .cindex "expansion" "testing"
3936 This option is useful only in conjunction with &%-be%& (that is, when testing
3937 string expansions). Exim loads the given message from its spool before doing
3938 the test expansions, thus setting message-specific variables such as
3939 &$message_size$& and the header variables. The &$recipients$& variable is made
3940 available. This feature is provided to make it easier to test expansions that
3941 make use of these variables. However, this option can be used only by an admin
3942 user. See also &%-bem%&.
3943
3944 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3945 .oindex "&%-Mt%&"
3946 .cindex "thawing messages"
3947 .cindex "unfreezing messages"
3948 .cindex "frozen messages" "thawing"
3949 .cindex "message" "thawing frozen"
3950 This option requests Exim to &"thaw"& any of the listed messages that are
3951 &"frozen"&, so that delivery attempts can resume. However, if any of the
3952 messages are active, their status is not altered. This option can be used only
3953 by an admin user.
3954
3955 .vitem &%-Mvb%&&~<&'message&~id'&>
3956 .oindex "&%-Mvb%&"
3957 .cindex "listing" "message body"
3958 .cindex "message" "listing body of"
3959 This option causes the contents of the message body (-D) spool file to be
3960 written to the standard output. This option can be used only by an admin user.
3961
3962 .vitem &%-Mvc%&&~<&'message&~id'&>
3963 .oindex "&%-Mvc%&"
3964 .cindex "message" "listing in RFC 2822 format"
3965 .cindex "listing" "message in RFC 2822 format"
3966 This option causes a copy of the complete message (header lines plus body) to
3967 be written to the standard output in RFC 2822 format. This option can be used
3968 only by an admin user.
3969
3970 .vitem &%-Mvh%&&~<&'message&~id'&>
3971 .oindex "&%-Mvh%&"
3972 .cindex "listing" "message headers"
3973 .cindex "header lines" "listing"
3974 .cindex "message" "listing header lines"
3975 This option causes the contents of the message headers (-H) spool file to be
3976 written to the standard output. This option can be used only by an admin user.
3977
3978 .vitem &%-Mvl%&&~<&'message&~id'&>
3979 .oindex "&%-Mvl%&"
3980 .cindex "listing" "message log"
3981 .cindex "message" "listing message log"
3982 This option causes the contents of the message log spool file to be written to
3983 the standard output. This option can be used only by an admin user.
3984
3985 .vitem &%-m%&
3986 .oindex "&%-m%&"
3987 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3988 treats it that way too.
3989
3990 .vitem &%-N%&
3991 .oindex "&%-N%&"
3992 .cindex "debugging" "&%-N%& option"
3993 .cindex "debugging" "suppressing delivery"
3994 This is a debugging option that inhibits delivery of a message at the transport
3995 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3996 it just doesn't actually transport the message, but instead behaves as if it
3997 had successfully done so. However, it does not make any updates to the retry
3998 database, and the log entries for deliveries are flagged with &"*>"& rather
3999 than &"=>"&.
4000
4001 Because &%-N%& discards any message to which it applies, only root or the Exim
4002 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4003 words, an ordinary user can use it only when supplying an incoming message to
4004 which it will apply. Although transportation never fails when &%-N%& is set, an
4005 address may be deferred because of a configuration problem on a transport, or a
4006 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4007 the message, and applies to any subsequent delivery attempts that may happen
4008 for that message.
4009
4010 .vitem &%-n%&
4011 .oindex "&%-n%&"
4012 This option is interpreted by Sendmail to mean &"no aliasing"&.
4013 For normal modes of operation, it is ignored by Exim.
4014 When combined with &%-bP%& it suppresses the name of an option from being output.
4015
4016 .vitem &%-O%&&~<&'data'&>
4017 .oindex "&%-O%&"
4018 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4019 Exim.
4020
4021 .vitem &%-oA%&&~<&'file&~name'&>
4022 .oindex "&%-oA%&"
4023 .cindex "Sendmail compatibility" "&%-oA%& option"
4024 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4025 alternative alias file name. Exim handles &%-bi%& differently; see the
4026 description above.
4027
4028 .vitem &%-oB%&&~<&'n'&>
4029 .oindex "&%-oB%&"
4030 .cindex "SMTP" "passed connection"
4031 .cindex "SMTP" "multiple deliveries"
4032 .cindex "multiple SMTP deliveries"
4033 This is a debugging option which limits the maximum number of messages that can
4034 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4035 transport. If <&'n'&> is omitted, the limit is set to 1.
4036
4037 .vitem &%-odb%&
4038 .oindex "&%-odb%&"
4039 .cindex "background delivery"
4040 .cindex "delivery" "in the background"
4041 This option applies to all modes in which Exim accepts incoming messages,
4042 including the listening daemon. It requests &"background"& delivery of such
4043 messages, which means that the accepting process automatically starts a
4044 delivery process for each message received, but does not wait for the delivery
4045 processes to finish.
4046
4047 When all the messages have been received, the reception process exits,
4048 leaving the delivery processes to finish in their own time. The standard output
4049 and error streams are closed at the start of each delivery process.
4050 This is the default action if none of the &%-od%& options are present.
4051
4052 If one of the queueing options in the configuration file
4053 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4054 overrides it if &%queue_only_override%& is set true, which is the default
4055 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4056
4057 .vitem &%-odf%&
4058 .oindex "&%-odf%&"
4059 .cindex "foreground delivery"
4060 .cindex "delivery" "in the foreground"
4061 This option requests &"foreground"& (synchronous) delivery when Exim has
4062 accepted a locally-generated message. (For the daemon it is exactly the same as
4063 &%-odb%&.) A delivery process is automatically started to deliver the message,
4064 and Exim waits for it to complete before proceeding.
4065
4066 The original Exim reception process does not finish until the delivery
4067 process for the final message has ended. The standard error stream is left open
4068 during deliveries.
4069
4070 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4071 false and one of the queueing options in the configuration file is in effect.
4072
4073 If there is a temporary delivery error during foreground delivery, the
4074 message is left on the queue for later delivery, and the original reception
4075 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4076 restricted configuration that never queues messages.
4077
4078
4079 .vitem &%-odi%&
4080 .oindex "&%-odi%&"
4081 This option is synonymous with &%-odf%&. It is provided for compatibility with
4082 Sendmail.
4083
4084 .vitem &%-odq%&
4085 .oindex "&%-odq%&"
4086 .cindex "non-immediate delivery"
4087 .cindex "delivery" "suppressing immediate"
4088 .cindex "queueing incoming messages"
4089 This option applies to all modes in which Exim accepts incoming messages,
4090 including the listening daemon. It specifies that the accepting process should
4091 not automatically start a delivery process for each message received. Messages
4092 are placed on the queue, and remain there until a subsequent queue runner
4093 process encounters them. There are several configuration options (such as
4094 &%queue_only%&) that can be used to queue incoming messages under certain
4095 conditions. This option overrides all of them and also &%-odqs%&. It always
4096 forces queueing.
4097
4098 .vitem &%-odqs%&
4099 .oindex "&%-odqs%&"
4100 .cindex "SMTP" "delaying delivery"
4101 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4102 However, like &%-odb%& and &%-odi%&, this option has no effect if
4103 &%queue_only_override%& is false and one of the queueing options in the
4104 configuration file is in effect.
4105
4106 When &%-odqs%& does operate, a delivery process is started for each incoming
4107 message, in the background by default, but in the foreground if &%-odi%& is
4108 also present. The recipient addresses are routed, and local deliveries are done
4109 in the normal way. However, if any SMTP deliveries are required, they are not
4110 done at this time, so the message remains on the queue until a subsequent queue
4111 runner process encounters it. Because routing was done, Exim knows which
4112 messages are waiting for which hosts, and so a number of messages for the same
4113 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4114 configuration option has the same effect for specific domains. See also the
4115 &%-qq%& option.
4116
4117 .vitem &%-oee%&
4118 .oindex "&%-oee%&"
4119 .cindex "error" "reporting"
4120 If an error is detected while a non-SMTP message is being received (for
4121 example, a malformed address), the error is reported to the sender in a mail
4122 message.
4123
4124 .cindex "return code" "for &%-oee%&"
4125 Provided
4126 this error message is successfully sent, the Exim receiving process
4127 exits with a return code of zero. If not, the return code is 2 if the problem
4128 is that the original message has no recipients, or 1 for any other error.
4129 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4130
4131 .vitem &%-oem%&
4132 .oindex "&%-oem%&"
4133 .cindex "error" "reporting"
4134 .cindex "return code" "for &%-oem%&"
4135 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4136 return code, whether or not the error message was successfully sent.
4137 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4138
4139 .vitem &%-oep%&
4140 .oindex "&%-oep%&"
4141 .cindex "error" "reporting"
4142 If an error is detected while a non-SMTP message is being received, the
4143 error is reported by writing a message to the standard error file (stderr).
4144 .cindex "return code" "for &%-oep%&"
4145 The return code is 1 for all errors.
4146
4147 .vitem &%-oeq%&
4148 .oindex "&%-oeq%&"
4149 .cindex "error" "reporting"
4150 This option is supported for compatibility with Sendmail, but has the same
4151 effect as &%-oep%&.
4152
4153 .vitem &%-oew%&
4154 .oindex "&%-oew%&"
4155 .cindex "error" "reporting"
4156 This option is supported for compatibility with Sendmail, but has the same
4157 effect as &%-oem%&.
4158
4159 .vitem &%-oi%&
4160 .oindex "&%-oi%&"
4161 .cindex "dot" "in incoming non-SMTP message"
4162 This option, which has the same effect as &%-i%&, specifies that a dot on a
4163 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4164 single dot does terminate, though Exim does no special processing for other
4165 lines that start with a dot. This option is set by default if Exim is called as
4166 &'rmail'&. See also &%-ti%&.
4167
4168 .vitem &%-oitrue%&
4169 .oindex "&%-oitrue%&"
4170 This option is treated as synonymous with &%-oi%&.
4171
4172 .vitem &%-oMa%&&~<&'host&~address'&>
4173 .oindex "&%-oMa%&"
4174 .cindex "sender" "host address, specifying for local message"
4175 A number of options starting with &%-oM%& can be used to set values associated
4176 with remote hosts on locally-submitted messages (that is, messages not received
4177 over TCP/IP). These options can be used by any caller in conjunction with the
4178 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4179 other circumstances, they are ignored unless the caller is trusted.
4180
4181 The &%-oMa%& option sets the sender host address. This may include a port
4182 number at the end, after a full stop (period). For example:
4183 .code
4184 exim -bs -oMa 10.9.8.7.1234
4185 .endd
4186 An alternative syntax is to enclose the IP address in square brackets,
4187 followed by a colon and the port number:
4188 .code
4189 exim -bs -oMa [10.9.8.7]:1234
4190 .endd
4191 The IP address is placed in the &$sender_host_address$& variable, and the
4192 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4193 are present on the command line, the sender host IP address is taken from
4194 whichever one is last.
4195
4196 .vitem &%-oMaa%&&~<&'name'&>
4197 .oindex "&%-oMaa%&"
4198 .cindex "authentication" "name, specifying for local message"
4199 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4200 option sets the value of &$sender_host_authenticated$& (the authenticator
4201 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4202 This option can be used with &%-bh%& and &%-bs%& to set up an
4203 authenticated SMTP session without actually using the SMTP AUTH command.
4204
4205 .vitem &%-oMai%&&~<&'string'&>
4206 .oindex "&%-oMai%&"
4207 .cindex "authentication" "id, specifying for local message"
4208 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4209 option sets the value of &$authenticated_id$& (the id that was authenticated).
4210 This overrides the default value (the caller's login id, except with &%-bh%&,
4211 where there is no default) for messages from local sources. See chapter
4212 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4213
4214 .vitem &%-oMas%&&~<&'address'&>
4215 .oindex "&%-oMas%&"
4216 .cindex "authentication" "sender, specifying for local message"
4217 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4218 option sets the authenticated sender value in &$authenticated_sender$&. It
4219 overrides the sender address that is created from the caller's login id for
4220 messages from local sources, except when &%-bh%& is used, when there is no
4221 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4222 specified on a MAIL command overrides this value. See chapter
4223 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4224
4225 .vitem &%-oMi%&&~<&'interface&~address'&>
4226 .oindex "&%-oMi%&"
4227 .cindex "interface" "address, specifying for local message"
4228 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4229 option sets the IP interface address value. A port number may be included,
4230 using the same syntax as for &%-oMa%&. The interface address is placed in
4231 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4232
4233 .vitem &%-oMr%&&~<&'protocol&~name'&>
4234 .oindex "&%-oMr%&"
4235 .cindex "protocol, specifying for local message"
4236 .vindex "&$received_protocol$&"
4237 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4238 option sets the received protocol value that is stored in
4239 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4240 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4241 SMTP protocol names (see the description of &$received_protocol$& in section
4242 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4243 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4244 be set by &%-oMr%&.
4245
4246 .vitem &%-oMs%&&~<&'host&~name'&>
4247 .oindex "&%-oMs%&"
4248 .cindex "sender" "host name, specifying for local message"
4249 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4250 option sets the sender host name in &$sender_host_name$&. When this option is
4251 present, Exim does not attempt to look up a host name from an IP address; it
4252 uses the name it is given.
4253
4254 .vitem &%-oMt%&&~<&'ident&~string'&>
4255 .oindex "&%-oMt%&"
4256 .cindex "sender" "ident string, specifying for local message"
4257 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4258 option sets the sender ident value in &$sender_ident$&. The default setting for
4259 local callers is the login id of the calling process, except when &%-bh%& is
4260 used, when there is no default.
4261
4262 .vitem &%-om%&
4263 .oindex "&%-om%&"
4264 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4265 In Sendmail, this option means &"me too"&, indicating that the sender of a
4266 message should receive a copy of the message if the sender appears in an alias
4267 expansion. Exim always does this, so the option does nothing.
4268
4269 .vitem &%-oo%&
4270 .oindex "&%-oo%&"
4271 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4272 This option is ignored. In Sendmail it specifies &"old style headers"&,
4273 whatever that means.
4274
4275 .vitem &%-oP%&&~<&'path'&>
4276 .oindex "&%-oP%&"
4277 .cindex "pid (process id)" "of daemon"
4278 .cindex "daemon" "process id (pid)"
4279 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4280 value. The option specifies the file to which the process id of the daemon is
4281 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4282 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4283 because in those cases, the normal pid file is not used.
4284
4285 .vitem &%-or%&&~<&'time'&>
4286 .oindex "&%-or%&"
4287 .cindex "timeout" "for non-SMTP input"
4288 This option sets a timeout value for incoming non-SMTP messages. If it is not
4289 set, Exim will wait forever for the standard input. The value can also be set
4290 by the &%receive_timeout%& option. The format used for specifying times is
4291 described in section &<<SECTtimeformat>>&.
4292
4293 .vitem &%-os%&&~<&'time'&>
4294 .oindex "&%-os%&"
4295 .cindex "timeout" "for SMTP input"
4296 .cindex "SMTP" "input timeout"
4297 This option sets a timeout value for incoming SMTP messages. The timeout
4298 applies to each SMTP command and block of data. The value can also be set by
4299 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4300 for specifying times is described in section &<<SECTtimeformat>>&.
4301
4302 .vitem &%-ov%&
4303 .oindex "&%-ov%&"
4304 This option has exactly the same effect as &%-v%&.
4305
4306 .vitem &%-oX%&&~<&'number&~or&~string'&>
4307 .oindex "&%-oX%&"
4308 .cindex "TCP/IP" "setting listening ports"
4309 .cindex "TCP/IP" "setting listening interfaces"
4310 .cindex "port" "receiving TCP/IP"
4311 This option is relevant only when the &%-bd%& (start listening daemon) option
4312 is also given. It controls which ports and interfaces the daemon uses. Details
4313 of the syntax, and how it interacts with configuration file options, are given
4314 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4315 file is written unless &%-oP%& is also present to specify a pid file name.
4316
4317 .vitem &%-pd%&
4318 .oindex "&%-pd%&"
4319 .cindex "Perl" "starting the interpreter"
4320 This option applies when an embedded Perl interpreter is linked with Exim (see
4321 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4322 option, forcing the starting of the interpreter to be delayed until it is
4323 needed.
4324
4325 .vitem &%-ps%&
4326 .oindex "&%-ps%&"
4327 .cindex "Perl" "starting the interpreter"
4328 This option applies when an embedded Perl interpreter is linked with Exim (see
4329 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4330 option, forcing the starting of the interpreter to occur as soon as Exim is
4331 started.
4332
4333 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4334 .oindex "&%-p%&"
4335 For compatibility with Sendmail, this option is equivalent to
4336 .display
4337 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4338 .endd
4339 It sets the incoming protocol and host name (for trusted callers). The
4340 host name and its colon can be omitted when only the protocol is to be set.
4341 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4342 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4343 or &`s`& using this option (but that does not seem a real limitation).
4344
4345 .vitem &%-q%&
4346 .oindex "&%-q%&"
4347 .cindex "queue runner" "starting manually"
4348 This option is normally restricted to admin users. However, there is a
4349 configuration option called &%prod_requires_admin%& which can be set false to
4350 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4351 and &%-S%& options).
4352
4353 .cindex "queue runner" "description of operation"
4354 The &%-q%& option starts one queue runner process. This scans the queue of
4355 waiting messages, and runs a delivery process for each one in turn. It waits
4356 for each delivery process to finish before starting the next one. A delivery
4357 process may not actually do any deliveries if the retry times for the addresses
4358 have not been reached. Use &%-qf%& (see below) if you want to override this.
4359
4360 If
4361 .cindex "SMTP" "passed connection"
4362 .cindex "SMTP" "multiple deliveries"
4363 .cindex "multiple SMTP deliveries"
4364 the delivery process spawns other processes to deliver other messages down
4365 passed SMTP connections, the queue runner waits for these to finish before
4366 proceeding.
4367
4368 When all the queued messages have been considered, the original queue runner
4369 process terminates. In other words, a single pass is made over the waiting
4370 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4371 this to be repeated periodically.
4372
4373 Exim processes the waiting messages in an unpredictable order. It isn't very
4374 random, but it is likely to be different each time, which is all that matters.
4375 If one particular message screws up a remote MTA, other messages to the same
4376 MTA have a chance of getting through if they get tried first.
4377
4378 It is possible to cause the messages to be processed in lexical message id
4379 order, which is essentially the order in which they arrived, by setting the
4380 &%queue_run_in_order%& option, but this is not recommended for normal use.
4381
4382 .vitem &%-q%&<&'qflags'&>
4383 The &%-q%& option may be followed by one or more flag letters that change its
4384 behaviour. They are all optional, but if more than one is present, they must
4385 appear in the correct order. Each flag is described in a separate item below.
4386
4387 .vitem &%-qq...%&
4388 .oindex "&%-qq%&"
4389 .cindex "queue" "double scanning"
4390 .cindex "queue" "routing"
4391 .cindex "routing" "whole queue before delivery"
4392 An option starting with &%-qq%& requests a two-stage queue run. In the first
4393 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4394 every domain. Addresses are routed, local deliveries happen, but no remote
4395 transports are run.
4396
4397 .cindex "hints database" "remembering routing"
4398 The hints database that remembers which messages are waiting for specific hosts
4399 is updated, as if delivery to those hosts had been deferred. After this is
4400 complete, a second, normal queue scan happens, with routing and delivery taking
4401 place as normal. Messages that are routed to the same host should mostly be
4402 delivered down a single SMTP
4403 .cindex "SMTP" "passed connection"
4404 .cindex "SMTP" "multiple deliveries"
4405 .cindex "multiple SMTP deliveries"
4406 connection because of the hints that were set up during the first queue scan.
4407 This option may be useful for hosts that are connected to the Internet
4408 intermittently.
4409
4410 .vitem &%-q[q]i...%&
4411 .oindex "&%-qi%&"
4412 .cindex "queue" "initial delivery"
4413 If the &'i'& flag is present, the queue runner runs delivery processes only for
4414 those messages that haven't previously been tried. (&'i'& stands for &"initial
4415 delivery"&.) This can be helpful if you are putting messages on the queue using
4416 &%-odq%& and want a queue runner just to process the new messages.
4417
4418 .vitem &%-q[q][i]f...%&
4419 .oindex "&%-qf%&"
4420 .cindex "queue" "forcing delivery"
4421 .cindex "delivery" "forcing in queue run"
4422 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4423 message, whereas without &'f'& only those non-frozen addresses that have passed
4424 their retry times are tried.
4425
4426 .vitem &%-q[q][i]ff...%&
4427 .oindex "&%-qff%&"
4428 .cindex "frozen messages" "forcing delivery"
4429 If &'ff'& is present, a delivery attempt is forced for every message, whether
4430 frozen or not.
4431
4432 .vitem &%-q[q][i][f[f]]l%&
4433 .oindex "&%-ql%&"
4434 .cindex "queue" "local deliveries only"
4435 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4436 be done. If a message requires any remote deliveries, it remains on the queue
4437 for later delivery.
4438
4439 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4440 .cindex "queue" "delivering specific messages"
4441 When scanning the queue, Exim can be made to skip over messages whose ids are
4442 lexically less than a given value by following the &%-q%& option with a
4443 starting message id. For example:
4444 .code
4445 exim -q 0t5C6f-0000c8-00
4446 .endd
4447 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4448 second message id is given, messages whose ids are lexically greater than it
4449 are also skipped. If the same id is given twice, for example,
4450 .code
4451 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4452 .endd
4453 just one delivery process is started, for that message. This differs from
4454 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4455 that it counts as a delivery from a queue run. Note that the selection
4456 mechanism does not affect the order in which the messages are scanned. There
4457 are also other ways of selecting specific sets of messages for delivery in a
4458 queue run &-- see &%-R%& and &%-S%&.
4459
4460 .vitem &%-q%&<&'qflags'&><&'time'&>
4461 .cindex "queue runner" "starting periodically"
4462 .cindex "periodic queue running"
4463 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4464 starting a queue runner process at intervals specified by the given time value
4465 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4466 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4467 single daemon process handles both functions. A common way of starting up a
4468 combined daemon at system boot time is to use a command such as
4469 .code
4470 /usr/exim/bin/exim -bd -q30m
4471 .endd
4472 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4473 process every 30 minutes.
4474
4475 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4476 pid file is written unless one is explicitly requested by the &%-oP%& option.
4477
4478 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4479 .oindex "&%-qR%&"
4480 This option is synonymous with &%-R%&. It is provided for Sendmail
4481 compatibility.
4482
4483 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4484 .oindex "&%-qS%&"
4485 This option is synonymous with &%-S%&.
4486
4487 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4488 .oindex "&%-R%&"
4489 .cindex "queue runner" "for specific recipients"
4490 .cindex "delivery" "to given domain"
4491 .cindex "domain" "delivery to"
4492 The <&'rsflags'&> may be empty, in which case the white space before the string
4493 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4494 which are the possible values for <&'rsflags'&>. White space is required if
4495 <&'rsflags'&> is not empty.
4496
4497 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4498 perform a single queue run, except that, when scanning the messages on the
4499 queue, Exim processes only those that have at least one undelivered recipient
4500 address containing the given string, which is checked in a case-independent
4501 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4502 regular expression; otherwise it is a literal string.
4503
4504 If you want to do periodic queue runs for messages with specific recipients,
4505 you can combine &%-R%& with &%-q%& and a time value. For example:
4506 .code
4507 exim -q25m -R @special.domain.example
4508 .endd
4509 This example does a queue run for messages with recipients in the given domain
4510 every 25 minutes. Any additional flags that are specified with &%-q%& are
4511 applied to each queue run.
4512
4513 Once a message is selected for delivery by this mechanism, all its addresses
4514 are processed. For the first selected message, Exim overrides any retry
4515 information and forces a delivery attempt for each undelivered address. This
4516 means that if delivery of any address in the first message is successful, any
4517 existing retry information is deleted, and so delivery attempts for that
4518 address in subsequently selected messages (which are processed without forcing)
4519 will run. However, if delivery of any address does not succeed, the retry
4520 information is updated, and in subsequently selected messages, the failing
4521 address will be skipped.
4522
4523 .cindex "frozen messages" "forcing delivery"
4524 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4525 all selected messages, not just the first; frozen messages are included when
4526 &'ff'& is present.
4527
4528 The &%-R%& option makes it straightforward to initiate delivery of all messages
4529 to a given domain after a host has been down for some time. When the SMTP
4530 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4531 effect is to run Exim with the &%-R%& option, but it can be configured to run
4532 an arbitrary command instead.
4533
4534 .vitem &%-r%&
4535 .oindex "&%-r%&"
4536 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4537
4538 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4539 .oindex "&%-S%&"
4540 .cindex "delivery" "from given sender"
4541 .cindex "queue runner" "for specific senders"
4542 This option acts like &%-R%& except that it checks the string against each
4543 message's sender instead of against the recipients. If &%-R%& is also set, both
4544 conditions must be met for a message to be selected. If either of the options
4545 has &'f'& or &'ff'& in its flags, the associated action is taken.
4546
4547 .vitem &%-Tqt%&&~<&'times'&>
4548 .oindex "&%-Tqt%&"
4549 This is an option that is exclusively for use by the Exim testing suite. It is not
4550 recognized when Exim is run normally. It allows for the setting up of explicit
4551 &"queue times"& so that various warning/retry features can be tested.
4552
4553 .vitem &%-t%&
4554 .oindex "&%-t%&"
4555 .cindex "recipient" "extracting from header lines"
4556 .cindex "&'Bcc:'& header line"
4557 .cindex "&'Cc:'& header line"
4558 .cindex "&'To:'& header line"
4559 When Exim is receiving a locally-generated, non-SMTP message on its standard
4560 input, the &%-t%& option causes the recipients of the message to be obtained
4561 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4562 from the command arguments. The addresses are extracted before any rewriting
4563 takes place and the &'Bcc:'& header line, if present, is then removed.
4564
4565 .cindex "Sendmail compatibility" "&%-t%& option"
4566 If the command has any arguments, they specify addresses to which the message
4567 is &'not'& to be delivered. That is, the argument addresses are removed from
4568 the recipients list obtained from the headers. This is compatible with Smail 3
4569 and in accordance with the documented behaviour of several versions of
4570 Sendmail, as described in man pages on a number of operating systems (e.g.
4571 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4572 argument addresses to those obtained from the headers, and the O'Reilly
4573 Sendmail book documents it that way. Exim can be made to add argument addresses
4574 instead of subtracting them by setting the option
4575 &%extract_addresses_remove_arguments%& false.
4576
4577 .cindex "&%Resent-%& header lines" "with &%-t%&"
4578 If there are any &%Resent-%& header lines in the message, Exim extracts
4579 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4580 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4581 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4582 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4583
4584 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4585 message is resent several times). The RFC also specifies that they should be
4586 added at the front of the message, and separated by &'Received:'& lines. It is
4587 not at all clear how &%-t%& should operate in the present of multiple sets,
4588 nor indeed exactly what constitutes a &"set"&.
4589 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4590 are often added at the end of the header, and if a message is resent more than
4591 once, it is common for the original set of &%Resent-%& headers to be renamed as
4592 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4593
4594 .vitem &%-ti%&
4595 .oindex "&%-ti%&"
4596 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4597 compatibility with Sendmail.
4598
4599 .vitem &%-tls-on-connect%&
4600 .oindex "&%-tls-on-connect%&"
4601 .cindex "TLS" "use without STARTTLS"
4602 .cindex "TLS" "automatic start"
4603 This option is available when Exim is compiled with TLS support. It forces all
4604 incoming SMTP connections to behave as if the incoming port is listed in the
4605 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4606 &<<CHAPTLS>>& for further details.
4607
4608
4609 .vitem &%-U%&
4610 .oindex "&%-U%&"
4611 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4612 Sendmail uses this option for &"initial message submission"&, and its
4613 documentation states that in future releases, it may complain about
4614 syntactically invalid messages rather than fixing them when this flag is not
4615 set. Exim ignores this option.
4616
4617 .vitem &%-v%&
4618 .oindex "&%-v%&"
4619 This option causes Exim to write information to the standard error stream,
4620 describing what it is doing. In particular, it shows the log lines for
4621 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4622 dialogue is shown. Some of the log lines shown may not actually be written to
4623 the log if the setting of &%log_selector%& discards them. Any relevant
4624 selectors are shown with each log line. If none are shown, the logging is
4625 unconditional.
4626
4627 .vitem &%-x%&
4628 .oindex "&%-x%&"
4629 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4630 National Language Support extended characters in the body of the mail item"&).
4631 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4632 this option.
4633
4634 .new
4635 .vitem &%-X%&&~<&'logfile'&>
4636 .oindex "&%-X%&"
4637 This option is interpreted by Sendmail to cause debug information to be sent
4638 to the named file.  It is ignored by Exim.
4639 .wen
4640 .endlist
4641
4642 .ecindex IIDclo1
4643 .ecindex IIDclo2
4644
4645
4646 . ////////////////////////////////////////////////////////////////////////////
4647 . Insert a stylized DocBook comment here, to identify the end of the command
4648 . line options. This is for the benefit of the Perl script that automatically
4649 . creates a man page for the options.
4650 . ////////////////////////////////////////////////////////////////////////////
4651
4652 .literal xml
4653 <!-- === End of command line options === -->
4654 .literal off
4655
4656
4657
4658
4659
4660 . ////////////////////////////////////////////////////////////////////////////
4661 . ////////////////////////////////////////////////////////////////////////////
4662
4663
4664 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4665          "The runtime configuration file"
4666
4667 .cindex "run time configuration"
4668 .cindex "configuration file" "general description"
4669 .cindex "CONFIGURE_FILE"
4670 .cindex "configuration file" "errors in"
4671 .cindex "error" "in configuration file"
4672 .cindex "return code" "for bad configuration"
4673 Exim uses a single run time configuration file that is read whenever an Exim
4674 binary is executed. Note that in normal operation, this happens frequently,
4675 because Exim is designed to operate in a distributed manner, without central
4676 control.
4677
4678 If a syntax error is detected while reading the configuration file, Exim
4679 writes a message on the standard error, and exits with a non-zero return code.
4680 The message is also written to the panic log. &*Note*&: Only simple syntax
4681 errors can be detected at this time. The values of any expanded options are
4682 not checked until the expansion happens, even when the expansion does not
4683 actually alter the string.
4684
4685 The name of the configuration file is compiled into the binary for security
4686 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4687 most configurations, this specifies a single file. However, it is permitted to
4688 give a colon-separated list of file names, in which case Exim uses the first
4689 existing file in the list.
4690
4691 .cindex "EXIM_USER"
4692 .cindex "EXIM_GROUP"
4693 .cindex "CONFIGURE_OWNER"
4694 .cindex "CONFIGURE_GROUP"
4695 .cindex "configuration file" "ownership"
4696 .cindex "ownership" "configuration file"
4697 The run time configuration file must be owned by root or by the user that is
4698 specified at compile time by the CONFIGURE_OWNER option (if set). The
4699 configuration file must not be world-writeable, or group-writeable unless its
4700 group is the root group or the one specified at compile time by the
4701 CONFIGURE_GROUP option.
4702
4703 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4704 to root, anybody who is able to edit the run time configuration file has an
4705 easy way to run commands as root. If you specify a user or group in the
4706 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4707 who are members of that group will trivially be able to obtain root privileges.
4708
4709 Up to Exim version 4.72, the run time configuration file was also permitted to
4710 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4711 since it offered a simple privilege escalation for any attacker who managed to
4712 compromise the Exim user account.
4713
4714 A default configuration file, which will work correctly in simple situations,
4715 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4716 defines just one file name, the installation process copies the default
4717 configuration to a new file of that name if it did not previously exist. If
4718 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4719 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4720 configuration.
4721
4722
4723
4724 .section "Using a different configuration file" "SECID40"
4725 .cindex "configuration file" "alternate"
4726 A one-off alternate configuration can be specified by the &%-C%& command line
4727 option, which may specify a single file or a list of files. However, when
4728 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4729 unless the argument for &%-C%& is identical to the built-in value from
4730 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4731 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4732 is useful mainly for checking the syntax of configuration files before
4733 installing them. No owner or group checks are done on a configuration file
4734 specified by &%-C%&, if root privilege has been dropped.
4735
4736 Even the Exim user is not trusted to specify an arbitrary configuration file
4737 with the &%-C%& option to be used with root privileges, unless that file is
4738 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4739 testing a configuration using &%-C%& right through message reception and
4740 delivery, even if the caller is root. The reception works, but by that time,
4741 Exim is running as the Exim user, so when it re-execs to regain privilege for
4742 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4743 can test reception and delivery using two separate commands (one to put a
4744 message on the queue, using &%-odq%&, and another to do the delivery, using
4745 &%-M%&).
4746
4747 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4748 prefix string with which any file named in a &%-C%& command line option must
4749 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4750 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4751 name can be used with &%-C%&.
4752
4753 One-off changes to a configuration can be specified by the &%-D%& command line
4754 option, which defines and overrides values for macros used inside the
4755 configuration file. However, like &%-C%&, the use of this option by a
4756 non-privileged user causes Exim to discard its root privilege.
4757 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4758 completely disabled, and its use causes an immediate error exit.
4759
4760 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4761 to declare certain macro names trusted, such that root privilege will not
4762 necessarily be discarded.
4763 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4764 considered safe and, if &%-D%& only supplies macros from this list, and the
4765 values are acceptable, then Exim will not give up root privilege if the caller
4766 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4767 transition mechanism and is expected to be removed in the future.  Acceptable
4768 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4769
4770 Some sites may wish to use the same Exim binary on different machines that
4771 share a file system, but to use different configuration files on each machine.
4772 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4773 looks for a file whose name is the configuration file name followed by a dot
4774 and the machine's node name, as obtained from the &[uname()]& function. If this
4775 file does not exist, the standard name is tried. This processing occurs for
4776 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4777
4778 In some esoteric situations different versions of Exim may be run under
4779 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4780 help with this. See the comments in &_src/EDITME_& for details.
4781
4782
4783
4784 .section "Configuration file format" "SECTconffilfor"
4785 .cindex "configuration file" "format of"
4786 .cindex "format" "configuration file"
4787 Exim's configuration file is divided into a number of different parts. General
4788 option settings must always appear at the start of the file. The other parts
4789 are all optional, and may appear in any order. Each part other than the first
4790 is introduced by the word &"begin"& followed by the name of the part. The
4791 optional parts are:
4792
4793 .ilist
4794 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4795 &<<CHAPACL>>&).
4796 .next
4797 .cindex "AUTH" "configuration"
4798 &'authenticators'&: Configuration settings for the authenticator drivers. These
4799 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4800 .next
4801 &'routers'&: Configuration settings for the router drivers. Routers process
4802 addresses and determine how the message is to be delivered (see chapters
4803 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4804 .next
4805 &'transports'&: Configuration settings for the transport drivers. Transports
4806 define mechanisms for copying messages to destinations (see chapters
4807 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4808 .next
4809 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4810 If there is no retry section, or if it is empty (that is, no retry rules are
4811 defined), Exim will not retry deliveries. In this situation, temporary errors
4812 are treated the same as permanent errors. Retry rules are discussed in chapter
4813 &<<CHAPretry>>&.
4814 .next
4815 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4816 when new addresses are generated during delivery. Rewriting is discussed in
4817 chapter &<<CHAPrewrite>>&.
4818 .next
4819 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4820 want to use this feature, you must set
4821 .code
4822 LOCAL_SCAN_HAS_OPTIONS=yes
4823 .endd
4824 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4825 facility are given in chapter &<<CHAPlocalscan>>&.
4826 .endlist
4827
4828 .cindex "configuration file" "leading white space in"
4829 .cindex "configuration file" "trailing white space in"
4830 .cindex "white space" "in configuration file"
4831 Leading and trailing white space in configuration lines is always ignored.
4832
4833 Blank lines in the file, and lines starting with a # character (ignoring
4834 leading white space) are treated as comments and are ignored. &*Note*&: A
4835 # character other than at the beginning of a line is not treated specially,
4836 and does not introduce a comment.
4837
4838 Any non-comment line can be continued by ending it with a backslash. Note that
4839 the general rule for white space means that trailing white space after the
4840 backslash and leading white space at the start of continuation
4841 lines is ignored. Comment lines beginning with # (but not empty lines) may
4842 appear in the middle of a sequence of continuation lines.
4843
4844 A convenient way to create a configuration file is to start from the
4845 default, which is supplied in &_src/configure.default_&, and add, delete, or
4846 change settings as required.
4847
4848 The ACLs, retry rules, and rewriting rules have their own syntax which is
4849 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4850 respectively. The other parts of the configuration file have some syntactic
4851 items in common, and these are described below, from section &<<SECTcos>>&
4852 onwards. Before that, the inclusion, macro, and conditional facilities are
4853 described.
4854
4855
4856
4857 .section "File inclusions in the configuration file" "SECID41"
4858 .cindex "inclusions in configuration file"
4859 .cindex "configuration file" "including other files"
4860 .cindex "&`.include`& in configuration file"
4861 .cindex "&`.include_if_exists`& in configuration file"
4862 You can include other files inside Exim's run time configuration file by
4863 using this syntax:
4864 .display
4865 &`.include`& <&'file name'&>
4866 &`.include_if_exists`& <&'file name'&>
4867 .endd
4868 on a line by itself. Double quotes round the file name are optional. If you use
4869 the first form, a configuration error occurs if the file does not exist; the
4870 second form does nothing for non-existent files. In all cases, an absolute file
4871 name is required.
4872
4873 Includes may be nested to any depth, but remember that Exim reads its
4874 configuration file often, so it is a good idea to keep them to a minimum.
4875 If you change the contents of an included file, you must HUP the daemon,
4876 because an included file is read only when the configuration itself is read.
4877
4878 The processing of inclusions happens early, at a physical line level, so, like
4879 comment lines, an inclusion can be used in the middle of an option setting,
4880 for example:
4881 .code
4882 hosts_lookup = a.b.c \
4883                .include /some/file
4884 .endd
4885 Include processing happens after macro processing (see below). Its effect is to
4886 process the lines of the included file as if they occurred inline where the
4887 inclusion appears.
4888
4889
4890
4891 .section "Macros in the configuration file" "SECTmacrodefs"
4892 .cindex "macro" "description of"
4893 .cindex "configuration file" "macros"
4894 If a line in the main part of the configuration (that is, before the first
4895 &"begin"& line) begins with an upper case letter, it is taken as a macro
4896 definition, and must be of the form
4897 .display
4898 <&'name'&> = <&'rest of line'&>
4899 .endd
4900 The name must consist of letters, digits, and underscores, and need not all be
4901 in upper case, though that is recommended. The rest of the line, including any
4902 continuations, is the replacement text, and has leading and trailing white
4903 space removed. Quotes are not removed. The replacement text can never end with
4904 a backslash character, but this doesn't seem to be a serious limitation.
4905
4906 Macros may also be defined between router, transport, authenticator, or ACL
4907 definitions. They may not, however, be defined within an individual driver or
4908 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4909
4910 .section "Macro substitution" "SECID42"
4911 Once a macro is defined, all subsequent lines in the file (and any included
4912 files) are scanned for the macro name; if there are several macros, the line is
4913 scanned for each in turn, in the order in which the macros are defined. The
4914 replacement text is not re-scanned for the current macro, though it is scanned
4915 for subsequently defined macros. For this reason, a macro name may not contain
4916 the name of a previously defined macro as a substring. You could, for example,
4917 define
4918 .display
4919 &`ABCD_XYZ = `&<&'something'&>
4920 &`ABCD = `&<&'something else'&>
4921 .endd
4922 but putting the definitions in the opposite order would provoke a configuration
4923 error. Macro expansion is applied to individual physical lines from the file,
4924 before checking for line continuation or file inclusion (see above). If a line
4925 consists solely of a macro name, and the expansion of the macro is empty, the
4926 line is ignored. A macro at the start of a line may turn the line into a
4927 comment line or a &`.include`& line.
4928
4929
4930 .section "Redefining macros" "SECID43"
4931 Once defined, the value of a macro can be redefined later in the configuration
4932 (or in an included file). Redefinition is specified by using &'=='& instead of
4933 &'='&. For example:
4934 .code
4935 MAC =  initial value
4936 ...
4937 MAC == updated value
4938 .endd
4939 Redefinition does not alter the order in which the macros are applied to the
4940 subsequent lines of the configuration file. It is still the same order in which
4941 the macros were originally defined. All that changes is the macro's value.
4942 Redefinition makes it possible to accumulate values. For example:
4943 .code
4944 MAC =  initial value
4945 ...
4946 MAC == MAC and something added
4947 .endd
4948 This can be helpful in situations where the configuration file is built
4949 from a number of other files.
4950
4951 .section "Overriding macro values" "SECID44"
4952 The values set for macros in the configuration file can be overridden by the
4953 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4954 used, unless called by root or the Exim user. A definition on the command line
4955 using the &%-D%& option causes all definitions and redefinitions within the
4956 file to be ignored.
4957
4958
4959
4960 .section "Example of macro usage" "SECID45"
4961 As an example of macro usage, consider a configuration where aliases are looked
4962 up in a MySQL database. It helps to keep the file less cluttered if long
4963 strings such as SQL statements are defined separately as macros, for example:
4964 .code
4965 ALIAS_QUERY = select mailbox from user where \
4966               login='${quote_mysql:$local_part}';
4967 .endd
4968 This can then be used in a &(redirect)& router setting like this:
4969 .code
4970 data = ${lookup mysql{ALIAS_QUERY}}
4971 .endd
4972 In earlier versions of Exim macros were sometimes used for domain, host, or
4973 address lists. In Exim 4 these are handled better by named lists &-- see
4974 section &<<SECTnamedlists>>&.
4975
4976
4977 .section "Conditional skips in the configuration file" "SECID46"
4978 .cindex "configuration file" "conditional skips"
4979 .cindex "&`.ifdef`&"
4980 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4981 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4982 portions of the configuration file. The processing happens whenever the file is
4983 read (that is, when an Exim binary starts to run).
4984
4985 The implementation is very simple. Instances of the first four directives must
4986 be followed by text that includes the names of one or macros. The condition
4987 that is tested is whether or not any macro substitution has taken place in the
4988 line. Thus:
4989 .code
4990 .ifdef AAA
4991 message_size_limit = 50M
4992 .else
4993 message_size_limit = 100M
4994 .endif
4995 .endd
4996 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4997 otherwise. If there is more than one macro named on the line, the condition
4998 is true if any of them are defined. That is, it is an &"or"& condition. To
4999 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5000
5001 Although you can use a macro expansion to generate one of these directives,
5002 it is not very useful, because the condition &"there was a macro substitution
5003 in this line"& will always be true.
5004
5005 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5006 to clarify complicated nestings.
5007
5008
5009
5010 .section "Common option syntax" "SECTcos"
5011 .cindex "common option syntax"
5012 .cindex "syntax of common options"
5013 .cindex "configuration file" "common option syntax"
5014 For the main set of options, driver options, and &[local_scan()]& options,
5015 each setting is on a line by itself, and starts with a name consisting of
5016 lower-case letters and underscores. Many options require a data value, and in
5017 these cases the name must be followed by an equals sign (with optional white
5018 space) and then the value. For example:
5019 .code
5020 qualify_domain = mydomain.example.com
5021 .endd
5022 .cindex "hiding configuration option values"
5023 .cindex "configuration options" "hiding value of"
5024 .cindex "options" "hiding value of"
5025 Some option settings may contain sensitive data, for example, passwords for
5026 accessing databases. To stop non-admin users from using the &%-bP%& command
5027 line option to read these values, you can precede the option settings with the
5028 word &"hide"&. For example:
5029 .code
5030 hide mysql_servers = localhost/users/admin/secret-password
5031 .endd
5032 For non-admin users, such options are displayed like this:
5033 .code
5034 mysql_servers = <value not displayable>
5035 .endd
5036 If &"hide"& is used on a driver option, it hides the value of that option on
5037 all instances of the same driver.
5038
5039 The following sections describe the syntax used for the different data types
5040 that are found in option settings.
5041
5042
5043 .section "Boolean options" "SECID47"
5044 .cindex "format" "boolean"
5045 .cindex "boolean configuration values"
5046 .oindex "&%no_%&&'xxx'&"
5047 .oindex "&%not_%&&'xxx'&"
5048 Options whose type is given as boolean are on/off switches. There are two
5049 different ways of specifying such options: with and without a data value. If
5050 the option name is specified on its own without data, the switch is turned on;
5051 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5052 boolean options may be followed by an equals sign and one of the words
5053 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5054 the following two settings have exactly the same effect:
5055 .code
5056 queue_only
5057 queue_only = true
5058 .endd
5059 The following two lines also have the same (opposite) effect:
5060 .code
5061 no_queue_only
5062 queue_only = false
5063 .endd
5064 You can use whichever syntax you prefer.
5065
5066
5067
5068
5069 .section "Integer values" "SECID48"
5070 .cindex "integer configuration values"
5071 .cindex "format" "integer"
5072 If an option's type is given as &"integer"&, the value can be given in decimal,
5073 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5074 number is assumed. Otherwise, it is treated as an octal number unless it starts
5075 with the characters &"0x"&, in which case the remainder is interpreted as a
5076 hexadecimal number.
5077
5078 If an integer value is followed by the letter K, it is multiplied by 1024; if
5079 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5080 of integer option settings are output, values which are an exact multiple of
5081 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5082 and M. The printing style is independent of the actual input format that was
5083 used.
5084
5085
5086 .section "Octal integer values" "SECID49"
5087 .cindex "integer format"
5088 .cindex "format" "octal integer"
5089 If an option's type is given as &"octal integer"&, its value is always
5090 interpreted as an octal number, whether or not it starts with the digit zero.
5091 Such options are always output in octal.
5092
5093
5094 .section "Fixed point numbers" "SECID50"
5095 .cindex "fixed point configuration values"
5096 .cindex "format" "fixed point"
5097 If an option's type is given as &"fixed-point"&, its value must be a decimal
5098 integer, optionally followed by a decimal point and up to three further digits.
5099
5100
5101
5102 .section "Time intervals" "SECTtimeformat"
5103 .cindex "time interval" "specifying in configuration"
5104 .cindex "format" "time interval"
5105 A time interval is specified as a sequence of numbers, each followed by one of
5106 the following letters, with no intervening white space:
5107
5108 .table2 30pt
5109 .irow &%s%& seconds
5110 .irow &%m%& minutes
5111 .irow &%h%& hours
5112 .irow &%d%& days
5113 .irow &%w%& weeks
5114 .endtable
5115
5116 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5117 intervals are output in the same format. Exim does not restrict the values; it
5118 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5119
5120
5121
5122 .section "String values" "SECTstrings"
5123 .cindex "string" "format of configuration values"
5124 .cindex "format" "string"
5125 If an option's type is specified as &"string"&, the value can be specified with
5126 or without double-quotes. If it does not start with a double-quote, the value
5127 consists of the remainder of the line plus any continuation lines, starting at
5128 the first character after any leading white space, with trailing white space
5129 removed, and with no interpretation of the characters in the string. Because
5130 Exim removes comment lines (those beginning with #) at an early stage, they can
5131 appear in the middle of a multi-line string. The following two settings are
5132 therefore equivalent:
5133 .code
5134 trusted_users = uucp:mail
5135 trusted_users = uucp:\
5136                 # This comment line is ignored
5137                 mail
5138 .endd
5139 .cindex "string" "quoted"
5140 .cindex "escape characters in quoted strings"
5141 If a string does start with a double-quote, it must end with a closing
5142 double-quote, and any backslash characters other than those used for line
5143 continuation are interpreted as escape characters, as follows:
5144
5145 .table2 100pt
5146 .irow &`\\`&                     "single backslash"
5147 .irow &`\n`&                     "newline"
5148 .irow &`\r`&                     "carriage return"
5149 .irow &`\t`&                     "tab"
5150 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5151 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5152                                    character"
5153 .endtable
5154
5155 If a backslash is followed by some other character, including a double-quote
5156 character, that character replaces the pair.
5157
5158 Quoting is necessary only if you want to make use of the backslash escapes to
5159 insert special characters, or if you need to specify a value with leading or
5160 trailing spaces. These cases are rare, so quoting is almost never needed in
5161 current versions of Exim. In versions of Exim before 3.14, quoting was required
5162 in order to continue lines, so you may come across older configuration files
5163 and examples that apparently quote unnecessarily.
5164
5165
5166 .section "Expanded strings" "SECID51"
5167 .cindex "expansion" "definition of"
5168 Some strings in the configuration file are subjected to &'string expansion'&,
5169 by which means various parts of the string may be changed according to the
5170 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5171 is as just described; in particular, the handling of backslashes in quoted
5172 strings is done as part of the input process, before expansion takes place.
5173 However, backslash is also an escape character for the expander, so any
5174 backslashes that are required for that reason must be doubled if they are
5175 within a quoted configuration string.
5176
5177
5178 .section "User and group names" "SECID52"
5179 .cindex "user name" "format of"
5180 .cindex "format" "user name"
5181 .cindex "groups" "name format"
5182 .cindex "format" "group name"
5183 User and group names are specified as strings, using the syntax described
5184 above, but the strings are interpreted specially. A user or group name must
5185 either consist entirely of digits, or be a name that can be looked up using the
5186 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5187
5188
5189 .section "List construction" "SECTlistconstruct"
5190 .cindex "list" "syntax of in configuration"
5191 .cindex "format" "list item in configuration"
5192 .cindex "string" "list, definition of"
5193 The data for some configuration options is a list of items, with colon as the
5194 default separator. Many of these options are shown with type &"string list"& in
5195 the descriptions later in this document. Others are listed as &"domain list"&,
5196 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5197 are all the same; however, those other than &"string list"& are subject to
5198 particular kinds of interpretation, as described in chapter
5199 &<<CHAPdomhosaddlists>>&.
5200
5201 In all these cases, the entire list is treated as a single string as far as the
5202 input syntax is concerned. The &%trusted_users%& setting in section
5203 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5204 in a list, it must be entered as two colons. Leading and trailing white space
5205 on each item in a list is ignored. This makes it possible to include items that
5206 start with a colon, and in particular, certain forms of IPv6 address. For
5207 example, the list
5208 .code
5209 local_interfaces = 127.0.0.1 : ::::1
5210 .endd
5211 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5212
5213 &*Note*&: Although leading and trailing white space is ignored in individual
5214 list items, it is not ignored when parsing the list. The space after the first
5215 colon in the example above is necessary. If it were not there, the list would
5216 be interpreted as the two items 127.0.0.1:: and 1.
5217
5218 .section "Changing list separators" "SECID53"
5219 .cindex "list separator" "changing"
5220 .cindex "IPv6" "addresses in lists"
5221 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5222 introduced to allow the separator character to be changed. If a list begins
5223 with a left angle bracket, followed by any punctuation character, that
5224 character is used instead of colon as the list separator. For example, the list
5225 above can be rewritten to use a semicolon separator like this:
5226 .code
5227 local_interfaces = <; 127.0.0.1 ; ::1
5228 .endd
5229 This facility applies to all lists, with the exception of the list in
5230 &%log_file_path%&. It is recommended that the use of non-colon separators be
5231 confined to circumstances where they really are needed.
5232
5233 .cindex "list separator" "newline as"
5234 .cindex "newline" "as list separator"
5235 It is also possible to use newline and other control characters (those with
5236 code values less than 32, plus DEL) as separators in lists. Such separators
5237 must be provided literally at the time the list is processed. For options that
5238 are string-expanded, you can write the separator using a normal escape
5239 sequence. This will be processed by the expander before the string is
5240 interpreted as a list. For example, if a newline-separated list of domains is
5241 generated by a lookup, you can process it directly by a line such as this:
5242 .code
5243 domains = <\n ${lookup mysql{.....}}
5244 .endd
5245 This avoids having to change the list separator in such data. You are unlikely
5246 to want to use a control character as a separator in an option that is not
5247 expanded, because the value is literal text. However, it can be done by giving
5248 the value in quotes. For example:
5249 .code
5250 local_interfaces = "<\n 127.0.0.1 \n ::1"
5251 .endd
5252 Unlike printing character separators, which can be included in list items by
5253 doubling, it is not possible to include a control character as data when it is
5254 set as the separator. Two such characters in succession are interpreted as
5255 enclosing an empty list item.
5256
5257
5258
5259 .section "Empty items in lists" "SECTempitelis"
5260 .cindex "list" "empty item in"
5261 An empty item at the end of a list is always ignored. In other words, trailing
5262 separator characters are ignored. Thus, the list in
5263 .code
5264 senders = user@domain :
5265 .endd
5266 contains only a single item. If you want to include an empty string as one item
5267 in a list, it must not be the last item. For example, this list contains three
5268 items, the second of which is empty:
5269 .code
5270 senders = user1@domain : : user2@domain
5271 .endd
5272 &*Note*&: There must be white space between the two colons, as otherwise they
5273 are interpreted as representing a single colon data character (and the list
5274 would then contain just one item). If you want to specify a list that contains
5275 just one, empty item, you can do it as in this example:
5276 .code
5277 senders = :
5278 .endd
5279 In this case, the first item is empty, and the second is discarded because it
5280 is at the end of the list.
5281
5282
5283
5284
5285 .section "Format of driver configurations" "SECTfordricon"
5286 .cindex "drivers" "configuration format"
5287 There are separate parts in the configuration for defining routers, transports,
5288 and authenticators. In each part, you are defining a number of driver
5289 instances, each with its own set of options. Each driver instance is defined by
5290 a sequence of lines like this:
5291 .display
5292 <&'instance name'&>:
5293   <&'option'&>
5294   ...
5295   <&'option'&>
5296 .endd
5297 In the following example, the instance name is &(localuser)&, and it is
5298 followed by three options settings:
5299 .code
5300 localuser:
5301   driver = accept
5302   check_local_user
5303   transport = local_delivery
5304 .endd
5305 For each driver instance, you specify which Exim code module it uses &-- by the
5306 setting of the &%driver%& option &-- and (optionally) some configuration
5307 settings. For example, in the case of transports, if you want a transport to
5308 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5309 a local file you would use the &(appendfile)& driver. Each of the drivers is
5310 described in detail in its own separate chapter later in this manual.
5311
5312 You can have several routers, transports, or authenticators that are based on
5313 the same underlying driver (each must have a different instance name).
5314
5315 The order in which routers are defined is important, because addresses are
5316 passed to individual routers one by one, in order. The order in which
5317 transports are defined does not matter at all. The order in which
5318 authenticators are defined is used only when Exim, as a client, is searching
5319 them to find one that matches an authentication mechanism offered by the
5320 server.
5321
5322 .cindex "generic options"
5323 .cindex "options" "generic &-- definition of"
5324 Within a driver instance definition, there are two kinds of option: &'generic'&
5325 and &'private'&. The generic options are those that apply to all drivers of the
5326 same type (that is, all routers, all transports or all authenticators). The
5327 &%driver%& option is a generic option that must appear in every definition.
5328 .cindex "private options"
5329 The private options are special for each driver, and none need appear, because
5330 they all have default values.
5331
5332 The options may appear in any order, except that the &%driver%& option must
5333 precede any private options, since these depend on the particular driver. For
5334 this reason, it is recommended that &%driver%& always be the first option.
5335
5336 Driver instance names, which are used for reference in log entries and
5337 elsewhere, can be any sequence of letters, digits, and underscores (starting
5338 with a letter) and must be unique among drivers of the same type. A router and
5339 a transport (for example) can each have the same name, but no two router
5340 instances can have the same name. The name of a driver instance should not be
5341 confused with the name of the underlying driver module. For example, the
5342 configuration lines:
5343 .code
5344 remote_smtp:
5345   driver = smtp
5346 .endd
5347 create an instance of the &(smtp)& transport driver whose name is
5348 &(remote_smtp)&. The same driver code can be used more than once, with
5349 different instance names and different option settings each time. A second
5350 instance of the &(smtp)& transport, with different options, might be defined
5351 thus:
5352 .code
5353 special_smtp:
5354   driver = smtp
5355   port = 1234
5356   command_timeout = 10s
5357 .endd
5358 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5359 these transport instances from routers, and these names would appear in log
5360 lines.
5361
5362 Comment lines may be present in the middle of driver specifications. The full
5363 list of option settings for any particular driver instance, including all the
5364 defaulted values, can be extracted by making use of the &%-bP%& command line
5365 option.
5366
5367
5368
5369
5370
5371
5372 . ////////////////////////////////////////////////////////////////////////////
5373 . ////////////////////////////////////////////////////////////////////////////
5374
5375 .chapter "The default configuration file" "CHAPdefconfil"
5376 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5377 .cindex "default" "configuration file &""walk through""&"
5378 The default configuration file supplied with Exim as &_src/configure.default_&
5379 is sufficient for a host with simple mail requirements. As an introduction to
5380 the way Exim is configured, this chapter &"walks through"& the default
5381 configuration, giving brief explanations of the settings. Detailed descriptions
5382 of the options are given in subsequent chapters. The default configuration file
5383 itself contains extensive comments about ways you might want to modify the
5384 initial settings. However, note that there are many options that are not
5385 mentioned at all in the default configuration.
5386
5387
5388
5389 .section "Main configuration settings" "SECTdefconfmain"
5390 The main (global) configuration option settings must always come first in the
5391 file. The first thing you'll see in the file, after some initial comments, is
5392 the line
5393 .code
5394 # primary_hostname =
5395 .endd
5396 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5397 to know the official, fully qualified name of your host, and this is where you
5398 can specify it. However, in most cases you do not need to set this option. When
5399 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5400
5401 The first three non-comment configuration lines are as follows:
5402 .code
5403 domainlist local_domains    = @
5404 domainlist relay_to_domains =
5405 hostlist   relay_from_hosts = 127.0.0.1
5406 .endd
5407 These are not, in fact, option settings. They are definitions of two named
5408 domain lists and one named host list. Exim allows you to give names to lists of
5409 domains, hosts, and email addresses, in order to make it easier to manage the
5410 configuration file (see section &<<SECTnamedlists>>&).
5411
5412 The first line defines a domain list called &'local_domains'&; this is used
5413 later in the configuration to identify domains that are to be delivered
5414 on the local host.
5415
5416 .cindex "@ in a domain list"
5417 There is just one item in this list, the string &"@"&. This is a special form
5418 of entry which means &"the name of the local host"&. Thus, if the local host is
5419 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5420 be delivered locally. Because the local host's name is referenced indirectly,
5421 the same configuration file can be used on different hosts.
5422
5423 The second line defines a domain list called &'relay_to_domains'&, but the
5424 list itself is empty. Later in the configuration we will come to the part that
5425 controls mail relaying through the local host; it allows relaying to any
5426 domains in this list. By default, therefore, no relaying on the basis of a mail
5427 domain is permitted.
5428
5429 The third line defines a host list called &'relay_from_hosts'&. This list is
5430 used later in the configuration to permit relaying from any host or IP address
5431 that matches the list. The default contains just the IP address of the IPv4
5432 loopback interface, which means that processes on the local host are able to
5433 submit mail for relaying by sending it over TCP/IP to that interface. No other
5434 hosts are permitted to submit messages for relaying.
5435
5436 Just to be sure there's no misunderstanding: at this point in the configuration
5437 we aren't actually setting up any controls. We are just defining some domains
5438 and hosts that will be used in the controls that are specified later.
5439
5440 The next two configuration lines are genuine option settings:
5441 .code
5442 acl_smtp_rcpt = acl_check_rcpt
5443 acl_smtp_data = acl_check_data
5444 .endd
5445 These options specify &'Access Control Lists'& (ACLs) that are to be used
5446 during an incoming SMTP session for every recipient of a message (every RCPT
5447 command), and after the contents of the message have been received,
5448 respectively. The names of the lists are &'acl_check_rcpt'& and
5449 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5450 section of the configuration. The RCPT ACL controls which recipients are
5451 accepted for an incoming message &-- if a configuration does not provide an ACL
5452 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5453 contents of a message to be checked.
5454
5455 Two commented-out option settings are next:
5456 .code
5457 # av_scanner = clamd:/tmp/clamd
5458 # spamd_address = 127.0.0.1 783
5459 .endd
5460 These are example settings that can be used when Exim is compiled with the
5461 content-scanning extension. The first specifies the interface to the virus
5462 scanner, and the second specifies the interface to SpamAssassin. Further
5463 details are given in chapter &<<CHAPexiscan>>&.
5464
5465 Three more commented-out option settings follow:
5466 .code
5467 # tls_advertise_hosts = *
5468 # tls_certificate = /etc/ssl/exim.crt
5469 # tls_privatekey = /etc/ssl/exim.pem
5470 .endd
5471 These are example settings that can be used when Exim is compiled with
5472 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5473 first one specifies the list of clients that are allowed to use TLS when
5474 connecting to this server; in this case the wildcard means all clients. The
5475 other options specify where Exim should find its TLS certificate and private
5476 key, which together prove the server's identity to any clients that connect.
5477 More details are given in chapter &<<CHAPTLS>>&.
5478
5479 Another two commented-out option settings follow:
5480 .code
5481 # daemon_smtp_ports = 25 : 465 : 587
5482 # tls_on_connect_ports = 465
5483 .endd
5484 .cindex "port" "465 and 587"
5485 .cindex "port" "for message submission"
5486 .cindex "message" "submission, ports for"
5487 .cindex "ssmtp protocol"
5488 .cindex "smtps protocol"
5489 .cindex "SMTP" "ssmtp protocol"
5490 .cindex "SMTP" "smtps protocol"
5491 These options provide better support for roaming users who wish to use this
5492 server for message submission. They are not much use unless you have turned on
5493 TLS (as described in the previous paragraph) and authentication (about which
5494 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5495 on end-user networks, so RFC 4409 specifies that message submission should use
5496 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5497 configured to use port 587 correctly, so these settings also enable the
5498 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5499 &<<SECTsupobssmt>>&).
5500
5501 Two more commented-out options settings follow:
5502 .code
5503 # qualify_domain =
5504 # qualify_recipient =
5505 .endd
5506 The first of these specifies a domain that Exim uses when it constructs a
5507 complete email address from a local login name. This is often needed when Exim
5508 receives a message from a local process. If you do not set &%qualify_domain%&,
5509 the value of &%primary_hostname%& is used. If you set both of these options,
5510 you can have different qualification domains for sender and recipient
5511 addresses. If you set only the first one, its value is used in both cases.
5512
5513 .cindex "domain literal" "recognizing format"
5514 The following line must be uncommented if you want Exim to recognize
5515 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5516 (an IP address within square brackets) instead of a named domain.
5517 .code
5518 # allow_domain_literals
5519 .endd
5520 The RFCs still require this form, but many people think that in the modern
5521 Internet it makes little sense to permit mail to be sent to specific hosts by
5522 quoting their IP addresses. This ancient format has been used by people who
5523 try to abuse hosts by using them for unwanted relaying. However, some
5524 people believe there are circumstances (for example, messages addressed to
5525 &'postmaster'&) where domain literals are still useful.
5526
5527 The next configuration line is a kind of trigger guard:
5528 .code
5529 never_users = root
5530 .endd
5531 It specifies that no delivery must ever be run as the root user. The normal
5532 convention is to set up &'root'& as an alias for the system administrator. This
5533 setting is a guard against slips in the configuration.
5534 The list of users specified by &%never_users%& is not, however, the complete
5535 list; the build-time configuration in &_Local/Makefile_& has an option called
5536 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5537 contents of &%never_users%& are added to this list. By default
5538 FIXED_NEVER_USERS also specifies root.
5539
5540 When a remote host connects to Exim in order to send mail, the only information
5541 Exim has about the host's identity is its IP address. The next configuration
5542 line,
5543 .code
5544 host_lookup = *
5545 .endd
5546 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5547 in order to get a host name. This improves the quality of the logging
5548 information, but if you feel it is too expensive, you can remove it entirely,
5549 or restrict the lookup to hosts on &"nearby"& networks.
5550 Note that it is not always possible to find a host name from an IP address,
5551 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5552 unreachable.
5553
5554 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5555 1413 (hence their names):
5556 .code
5557 rfc1413_hosts = *
5558 rfc1413_query_timeout = 5s
5559 .endd
5560 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5561 You can limit the hosts to which these calls are made, or change the timeout
5562 that is used. If you set the timeout to zero, all ident calls are disabled.
5563 Although they are cheap and can provide useful information for tracing problem
5564 messages, some hosts and firewalls have problems with ident calls. This can
5565 result in a timeout instead of an immediate refused connection, leading to
5566 delays on starting up an incoming SMTP session.
5567
5568 When Exim receives messages over SMTP connections, it expects all addresses to
5569 be fully qualified with a domain, as required by the SMTP definition. However,
5570 if you are running a server to which simple clients submit messages, you may
5571 find that they send unqualified addresses. The two commented-out options:
5572 .code
5573 # sender_unqualified_hosts =
5574 # recipient_unqualified_hosts =
5575 .endd
5576 show how you can specify hosts that are permitted to send unqualified sender
5577 and recipient addresses, respectively.
5578
5579 The &%percent_hack_domains%& option is also commented out:
5580 .code
5581 # percent_hack_domains =
5582 .endd
5583 It provides a list of domains for which the &"percent hack"& is to operate.
5584 This is an almost obsolete form of explicit email routing. If you do not know
5585 anything about it, you can safely ignore this topic.
5586
5587 The last two settings in the main part of the default configuration are
5588 concerned with messages that have been &"frozen"& on Exim's queue. When a
5589 message is frozen, Exim no longer continues to try to deliver it. Freezing
5590 occurs when a bounce message encounters a permanent failure because the sender
5591 address of the original message that caused the bounce is invalid, so the
5592 bounce cannot be delivered. This is probably the most common case, but there
5593 are also other conditions that cause freezing, and frozen messages are not
5594 always bounce messages.
5595 .code
5596 ignore_bounce_errors_after = 2d
5597 timeout_frozen_after = 7d
5598 .endd
5599 The first of these options specifies that failing bounce messages are to be
5600 discarded after 2 days on the queue. The second specifies that any frozen
5601 message (whether a bounce message or not) is to be timed out (and discarded)
5602 after a week. In this configuration, the first setting ensures that no failing
5603 bounce message ever lasts a week.
5604
5605
5606
5607 .section "ACL configuration" "SECID54"
5608 .cindex "default" "ACLs"
5609 .cindex "&ACL;" "default configuration"
5610 In the default configuration, the ACL section follows the main configuration.
5611 It starts with the line
5612 .code
5613 begin acl
5614 .endd
5615 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5616 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5617 and &%acl_smtp_data%& above.
5618
5619 .cindex "RCPT" "ACL for"
5620 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5621 RCPT command specifies one of the message's recipients. The ACL statements
5622 are considered in order, until the recipient address is either accepted or
5623 rejected. The RCPT command is then accepted or rejected, according to the
5624 result of the ACL processing.
5625 .code
5626 acl_check_rcpt:
5627 .endd
5628 This line, consisting of a name terminated by a colon, marks the start of the
5629 ACL, and names it.
5630 .code
5631 accept  hosts = :
5632 .endd
5633 This ACL statement accepts the recipient if the sending host matches the list.
5634 But what does that strange list mean? It doesn't actually contain any host
5635 names or IP addresses. The presence of the colon puts an empty item in the
5636 list; Exim matches this only if the incoming message did not come from a remote
5637 host, because in that case, the remote hostname is empty. The colon is
5638 important. Without it, the list itself is empty, and can never match anything.
5639
5640 What this statement is doing is to accept unconditionally all recipients in
5641 messages that are submitted by SMTP from local processes using the standard
5642 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5643 manner.
5644 .code
5645 deny    message       = Restricted characters in address
5646         domains       = +local_domains
5647         local_parts   = ^[.] : ^.*[@%!/|]
5648
5649 deny    message       = Restricted characters in address
5650         domains       = !+local_domains
5651         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5652 .endd
5653 These statements are concerned with local parts that contain any of the
5654 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5655 Although these characters are entirely legal in local parts (in the case of
5656 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5657 in Internet mail addresses.
5658
5659 The first three have in the past been associated with explicitly routed
5660 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5661 option). Addresses containing these characters are regularly tried by spammers
5662 in an attempt to bypass relaying restrictions, and also by open relay testing
5663 programs. Unless you really need them it is safest to reject these characters
5664 at this early stage. This configuration is heavy-handed in rejecting these
5665 characters for all messages it accepts from remote hosts. This is a deliberate
5666 policy of being as safe as possible.
5667
5668 The first rule above is stricter, and is applied to messages that are addressed
5669 to one of the local domains handled by this host. This is implemented by the
5670 first condition, which restricts it to domains that are listed in the
5671 &'local_domains'& domain list. The &"+"& character is used to indicate a
5672 reference to a named list. In this configuration, there is just one domain in
5673 &'local_domains'&, but in general there may be many.
5674
5675 The second condition on the first statement uses two regular expressions to
5676 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5677 or &"|"&. If you have local accounts that include these characters, you will
5678 have to modify this rule.
5679
5680 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5681 allows them because they have been encountered in practice. (Consider the
5682 common convention of local parts constructed as
5683 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5684 the author of Exim, who has no second initial.) However, a local part starting
5685 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5686 file name (for example, for a mailing list). This is also true for local parts
5687 that contain slashes. A pipe symbol can also be troublesome if the local part
5688 is incorporated unthinkingly into a shell command line.
5689
5690 The second rule above applies to all other domains, and is less strict. This
5691 allows your own users to send outgoing messages to sites that use slashes
5692 and vertical bars in their local parts. It blocks local parts that begin
5693 with a dot, slash, or vertical bar, but allows these characters within the
5694 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5695 and &"!"& is blocked, as before. The motivation here is to prevent your users
5696 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5697 .code
5698 accept  local_parts   = postmaster
5699         domains       = +local_domains
5700 .endd
5701 This statement, which has two conditions, accepts an incoming address if the
5702 local part is &'postmaster'& and the domain is one of those listed in the
5703 &'local_domains'& domain list. The &"+"& character is used to indicate a
5704 reference to a named list. In this configuration, there is just one domain in
5705 &'local_domains'&, but in general there may be many.
5706
5707 The presence of this statement means that mail to postmaster is never blocked
5708 by any of the subsequent tests. This can be helpful while sorting out problems
5709 in cases where the subsequent tests are incorrectly denying access.
5710 .code
5711 require verify        = sender
5712 .endd
5713 This statement requires the sender address to be verified before any subsequent
5714 ACL statement can be used. If verification fails, the incoming recipient
5715 address is refused. Verification consists of trying to route the address, to
5716 see if a bounce message could be delivered to it. In the case of remote
5717 addresses, basic verification checks only the domain, but &'callouts'& can be
5718 used for more verification if required. Section &<<SECTaddressverification>>&
5719 discusses the details of address verification.
5720 .code
5721 accept  hosts         = +relay_from_hosts
5722         control       = submission
5723 .endd
5724 This statement accepts the address if the message is coming from one of the
5725 hosts that are defined as being allowed to relay through this host. Recipient
5726 verification is omitted here, because in many cases the clients are dumb MUAs
5727 that do not cope well with SMTP error responses. For the same reason, the
5728 second line specifies &"submission mode"& for messages that are accepted. This
5729 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5730 messages that are deficient in some way, for example, because they lack a
5731 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5732 probably add recipient verification here, and disable submission mode.
5733 .code
5734 accept  authenticated = *
5735         control       = submission
5736 .endd
5737 This statement accepts the address if the client host has authenticated itself.
5738 Submission mode is again specified, on the grounds that such messages are most
5739 likely to come from MUAs. The default configuration does not define any
5740 authenticators, though it does include some nearly complete commented-out
5741 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5742 fact authenticate until you complete the authenticator definitions.
5743 .code
5744 require message = relay not permitted
5745         domains = +local_domains : +relay_to_domains
5746 .endd
5747 This statement rejects the address if its domain is neither a local domain nor
5748 one of the domains for which this host is a relay.
5749 .code
5750 require verify = recipient
5751 .endd
5752 This statement requires the recipient address to be verified; if verification
5753 fails, the address is rejected.
5754 .code
5755 # deny    message     = rejected because $sender_host_address \
5756 #                       is in a black list at $dnslist_domain\n\
5757 #                       $dnslist_text
5758 #         dnslists    = black.list.example
5759 #
5760 # warn    dnslists    = black.list.example
5761 #         add_header  = X-Warning: $sender_host_address is in \
5762 #                       a black list at $dnslist_domain
5763 #         log_message = found in $dnslist_domain
5764 .endd
5765 These commented-out lines are examples of how you could configure Exim to check
5766 sending hosts against a DNS black list. The first statement rejects messages
5767 from blacklisted hosts, whereas the second just inserts a warning header
5768 line.
5769 .code
5770 # require verify = csa
5771 .endd
5772 This commented-out line is an example of how you could turn on client SMTP
5773 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5774 records.
5775 .code
5776 accept
5777 .endd
5778 The final statement in the first ACL unconditionally accepts any recipient
5779 address that has successfully passed all the previous tests.
5780 .code
5781 acl_check_data:
5782 .endd
5783 This line marks the start of the second ACL, and names it. Most of the contents
5784 of this ACL are commented out:
5785 .code
5786 # deny    malware   = *
5787 #         message   = This message contains a virus \
5788 #                     ($malware_name).
5789 .endd
5790 These lines are examples of how to arrange for messages to be scanned for
5791 viruses when Exim has been compiled with the content-scanning extension, and a
5792 suitable virus scanner is installed. If the message is found to contain a
5793 virus, it is rejected with the given custom error message.
5794 .code
5795 # warn    spam      = nobody
5796 #         message   = X-Spam_score: $spam_score\n\
5797 #                     X-Spam_score_int: $spam_score_int\n\
5798 #                     X-Spam_bar: $spam_bar\n\
5799 #                     X-Spam_report: $spam_report
5800 .endd
5801 These lines are an example of how to arrange for messages to be scanned by
5802 SpamAssassin when Exim has been compiled with the content-scanning extension,
5803 and SpamAssassin has been installed. The SpamAssassin check is run with
5804 &`nobody`& as its user parameter, and the results are added to the message as a
5805 series of extra header line. In this case, the message is not rejected,
5806 whatever the spam score.
5807 .code
5808 accept
5809 .endd
5810 This final line in the DATA ACL accepts the message unconditionally.
5811
5812
5813 .section "Router configuration" "SECID55"
5814 .cindex "default" "routers"
5815 .cindex "routers" "default"
5816 The router configuration comes next in the default configuration, introduced
5817 by the line
5818 .code
5819 begin routers
5820 .endd
5821 Routers are the modules in Exim that make decisions about where to send
5822 messages. An address is passed to each router in turn, until it is either
5823 accepted, or failed. This means that the order in which you define the routers
5824 matters. Each router is fully described in its own chapter later in this
5825 manual. Here we give only brief overviews.
5826 .code
5827 # domain_literal:
5828 #   driver = ipliteral
5829 #   domains = !+local_domains
5830 #   transport = remote_smtp
5831 .endd
5832 .cindex "domain literal" "default router"
5833 This router is commented out because the majority of sites do not want to
5834 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5835 you uncomment this router, you also need to uncomment the setting of
5836 &%allow_domain_literals%& in the main part of the configuration.
5837 .code
5838 dnslookup:
5839   driver = dnslookup
5840   domains = ! +local_domains
5841   transport = remote_smtp
5842   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5843   no_more
5844 .endd
5845 The first uncommented router handles addresses that do not involve any local
5846 domains. This is specified by the line
5847 .code
5848 domains = ! +local_domains
5849 .endd
5850 The &%domains%& option lists the domains to which this router applies, but the
5851 exclamation mark is a negation sign, so the router is used only for domains
5852 that are not in the domain list called &'local_domains'& (which was defined at
5853 the start of the configuration). The plus sign before &'local_domains'&
5854 indicates that it is referring to a named list. Addresses in other domains are
5855 passed on to the following routers.
5856
5857 The name of the router driver is &(dnslookup)&,
5858 and is specified by the &%driver%& option. Do not be confused by the fact that
5859 the name of this router instance is the same as the name of the driver. The
5860 instance name is arbitrary, but the name set in the &%driver%& option must be
5861 one of the driver modules that is in the Exim binary.
5862
5863 The &(dnslookup)& router routes addresses by looking up their domains in the
5864 DNS in order to obtain a list of hosts to which the address is routed. If the
5865 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5866 specified by the &%transport%& option. If the router does not find the domain
5867 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5868 the address fails and is bounced.
5869
5870 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5871 be entirely ignored. This option is present because a number of cases have been
5872 encountered where MX records in the DNS point to host names
5873 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5874 Completely ignoring these IP addresses causes Exim to fail to route the
5875 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5876 continue to try to deliver the message periodically until the address timed
5877 out.
5878 .code
5879 system_aliases:
5880   driver = redirect
5881   allow_fail
5882   allow_defer
5883   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5884 # user = exim
5885   file_transport = address_file
5886   pipe_transport = address_pipe
5887 .endd
5888 Control reaches this and subsequent routers only for addresses in the local
5889 domains. This router checks to see whether the local part is defined as an
5890 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5891 data that it looks up from that file. If no data is found for the local part,
5892 the value of the &%data%& option is empty, causing the address to be passed to
5893 the next router.
5894
5895 &_/etc/aliases_& is a conventional name for the system aliases file that is
5896 often used. That is why it is referenced by from the default configuration
5897 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5898 &_Local/Makefile_& before building Exim.
5899 .code
5900 userforward:
5901   driver = redirect
5902   check_local_user
5903 # local_part_suffix = +* : -*
5904 # local_part_suffix_optional
5905   file = $home/.forward
5906 # allow_filter
5907   no_verify
5908   no_expn
5909   check_ancestor
5910   file_transport = address_file
5911   pipe_transport = address_pipe
5912   reply_transport = address_reply
5913 .endd
5914 This is the most complicated router in the default configuration. It is another
5915 redirection router, but this time it is looking for forwarding data set up by
5916 individual users. The &%check_local_user%& setting specifies a check that the
5917 local part of the address is the login name of a local user. If it is not, the
5918 router is skipped. The two commented options that follow &%check_local_user%&,
5919 namely:
5920 .code
5921 # local_part_suffix = +* : -*
5922 # local_part_suffix_optional
5923 .endd
5924 .vindex "&$local_part_suffix$&"
5925 show how you can specify the recognition of local part suffixes. If the first
5926 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5927 by any sequence of characters, is removed from the local part and placed in the
5928 variable &$local_part_suffix$&. The second suffix option specifies that the
5929 presence of a suffix in the local part is optional. When a suffix is present,
5930 the check for a local login uses the local part with the suffix removed.
5931
5932 When a local user account is found, the file called &_.forward_& in the user's
5933 home directory is consulted. If it does not exist, or is empty, the router
5934 declines. Otherwise, the contents of &_.forward_& are interpreted as
5935 redirection data (see chapter &<<CHAPredirect>>& for more details).
5936
5937 .cindex "Sieve filter" "enabling in default router"
5938 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5939 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5940 is commented out by default), the contents of the file are interpreted as a set
5941 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5942 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5943 separate document entitled &'Exim's interfaces to mail filtering'&.
5944
5945 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5946 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5947 There are two reasons for doing this:
5948
5949 .olist
5950 Whether or not a local user has a &_.forward_& file is not really relevant when
5951 checking an address for validity; it makes sense not to waste resources doing
5952 unnecessary work.
5953 .next
5954 More importantly, when Exim is verifying addresses or handling an EXPN
5955 command during an SMTP session, it is running as the Exim user, not as root.
5956 The group is the Exim group, and no additional groups are set up.
5957 It may therefore not be possible for Exim to read users' &_.forward_& files at
5958 this time.
5959 .endlist
5960
5961 The setting of &%check_ancestor%& prevents the router from generating a new
5962 address that is the same as any previous address that was redirected. (This
5963 works round a problem concerning a bad interaction between aliasing and
5964 forwarding &-- see section &<<SECTredlocmai>>&).
5965
5966 The final three option settings specify the transports that are to be used when
5967 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5968 auto-reply, respectively. For example, if a &_.forward_& file contains
5969 .code
5970 a.nother@elsewhere.example, /home/spqr/archive
5971 .endd
5972 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5973 transport.
5974 .code
5975 localuser:
5976   driver = accept
5977   check_local_user
5978 # local_part_suffix = +* : -*
5979 # local_part_suffix_optional
5980   transport = local_delivery
5981 .endd
5982 The final router sets up delivery into local mailboxes, provided that the local
5983 part is the name of a local login, by accepting the address and assigning it to
5984 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5985 routers, so the address is bounced. The commented suffix settings fulfil the
5986 same purpose as they do for the &(userforward)& router.
5987
5988
5989 .section "Transport configuration" "SECID56"
5990 .cindex "default" "transports"
5991 .cindex "transports" "default"
5992 Transports define mechanisms for actually delivering messages. They operate
5993 only when referenced from routers, so the order in which they are defined does
5994 not matter. The transports section of the configuration starts with
5995 .code
5996 begin transports
5997 .endd
5998 One remote transport and four local transports are defined.
5999 .code
6000 remote_smtp:
6001   driver = smtp
6002 .endd
6003 This transport is used for delivering messages over SMTP connections. All its
6004 options are defaulted. The list of remote hosts comes from the router.
6005 .code
6006 local_delivery:
6007   driver = appendfile
6008   file = /var/mail/$local_part
6009   delivery_date_add
6010   envelope_to_add
6011   return_path_add
6012 # group = mail
6013 # mode = 0660
6014 .endd
6015 This &(appendfile)& transport is used for local delivery to user mailboxes in
6016 traditional BSD mailbox format. By default it runs under the uid and gid of the
6017 local user, which requires the sticky bit to be set on the &_/var/mail_&
6018 directory. Some systems use the alternative approach of running mail deliveries
6019 under a particular group instead of using the sticky bit. The commented options
6020 show how this can be done.
6021
6022 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6023 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6024 similarly-named options above.
6025 .code
6026 address_pipe:
6027   driver = pipe
6028   return_output
6029 .endd
6030 This transport is used for handling deliveries to pipes that are generated by
6031 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6032 option specifies that any output generated by the pipe is to be returned to the
6033 sender.
6034 .code
6035 address_file:
6036   driver = appendfile
6037   delivery_date_add
6038   envelope_to_add
6039   return_path_add
6040 .endd
6041 This transport is used for handling deliveries to files that are generated by
6042 redirection. The name of the file is not specified in this instance of
6043 &(appendfile)&, because it comes from the &(redirect)& router.
6044 .code
6045 address_reply:
6046   driver = autoreply
6047 .endd
6048 This transport is used for handling automatic replies generated by users'
6049 filter files.
6050
6051
6052
6053 .section "Default retry rule" "SECID57"
6054 .cindex "retry" "default rule"
6055 .cindex "default" "retry rule"
6056 The retry section of the configuration file contains rules which affect the way
6057 Exim retries deliveries that cannot be completed at the first attempt. It is
6058 introduced by the line
6059 .code
6060 begin retry
6061 .endd
6062 In the default configuration, there is just one rule, which applies to all
6063 errors:
6064 .code
6065 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6066 .endd
6067 This causes any temporarily failing address to be retried every 15 minutes for
6068 2 hours, then at intervals starting at one hour and increasing by a factor of
6069 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6070 is not delivered after 4 days of temporary failure, it is bounced.
6071
6072 If the retry section is removed from the configuration, or is empty (that is,
6073 if no retry rules are defined), Exim will not retry deliveries. This turns
6074 temporary errors into permanent errors.
6075
6076
6077 .section "Rewriting configuration" "SECID58"
6078 The rewriting section of the configuration, introduced by
6079 .code
6080 begin rewrite
6081 .endd
6082 contains rules for rewriting addresses in messages as they arrive. There are no
6083 rewriting rules in the default configuration file.
6084
6085
6086
6087 .section "Authenticators configuration" "SECTdefconfauth"
6088 .cindex "AUTH" "configuration"
6089 The authenticators section of the configuration, introduced by
6090 .code
6091 begin authenticators
6092 .endd
6093 defines mechanisms for the use of the SMTP AUTH command. The default
6094 configuration file contains two commented-out example authenticators
6095 which support plaintext username/password authentication using the
6096 standard PLAIN mechanism and the traditional but non-standard LOGIN
6097 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6098 to support most MUA software.
6099
6100 The example PLAIN authenticator looks like this:
6101 .code
6102 #PLAIN:
6103 #  driver                  = plaintext
6104 #  server_set_id           = $auth2
6105 #  server_prompts          = :
6106 #  server_condition        = Authentication is not yet configured
6107 #  server_advertise_condition = ${if def:tls_in_cipher }
6108 .endd
6109 And the example LOGIN authenticator looks like this:
6110 .code
6111 #LOGIN:
6112 #  driver                  = plaintext
6113 #  server_set_id           = $auth1
6114 #  server_prompts          = <| Username: | Password:
6115 #  server_condition        = Authentication is not yet configured
6116 #  server_advertise_condition = ${if def:tls_in_cipher }
6117 .endd
6118
6119 The &%server_set_id%& option makes Exim remember the authenticated username
6120 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6121 &%server_prompts%& option configures the &(plaintext)& authenticator so
6122 that it implements the details of the specific authentication mechanism,
6123 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6124 when Exim offers authentication to clients; in the examples, this is only
6125 when TLS or SSL has been started, so to enable the authenticators you also
6126 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6127
6128 The &%server_condition%& setting defines how to verify that the username and
6129 password are correct. In the examples it just produces an error message.
6130 To make the authenticators work, you can use a string expansion
6131 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6132
6133 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6134 usercode and password are in different positions.
6135 Chapter &<<CHAPplaintext>>& covers both.
6136
6137 .ecindex IIDconfiwal
6138
6139
6140
6141 . ////////////////////////////////////////////////////////////////////////////
6142 . ////////////////////////////////////////////////////////////////////////////
6143
6144 .chapter "Regular expressions" "CHAPregexp"
6145
6146 .cindex "regular expressions" "library"
6147 .cindex "PCRE"
6148 Exim supports the use of regular expressions in many of its options. It
6149 uses the PCRE regular expression library; this provides regular expression
6150 matching that is compatible with Perl 5. The syntax and semantics of
6151 regular expressions is discussed in many Perl reference books, and also in
6152 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6153 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6154
6155 The documentation for the syntax and semantics of the regular expressions that
6156 are supported by PCRE is included in the PCRE distribution, and no further
6157 description is included here. The PCRE functions are called from Exim using
6158 the default option settings (that is, with no PCRE options set), except that
6159 the PCRE_CASELESS option is set when the matching is required to be
6160 case-insensitive.
6161
6162 In most cases, when a regular expression is required in an Exim configuration,
6163 it has to start with a circumflex, in order to distinguish it from plain text
6164 or an &"ends with"& wildcard. In this example of a configuration setting, the
6165 second item in the colon-separated list is a regular expression.
6166 .code
6167 domains = a.b.c : ^\\d{3} : *.y.z : ...
6168 .endd
6169 The doubling of the backslash is required because of string expansion that
6170 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6171 of this issue, and a way of avoiding the need for doubling backslashes. The
6172 regular expression that is eventually used in this example contains just one
6173 backslash. The circumflex is included in the regular expression, and has the
6174 normal effect of &"anchoring"& it to the start of the string that is being
6175 matched.
6176
6177 There are, however, two cases where a circumflex is not required for the
6178 recognition of a regular expression: these are the &%match%& condition in a
6179 string expansion, and the &%matches%& condition in an Exim filter file. In
6180 these cases, the relevant string is always treated as a regular expression; if
6181 it does not start with a circumflex, the expression is not anchored, and can
6182 match anywhere in the subject string.
6183
6184 In all cases, if you want a regular expression to match at the end of a string,
6185 you must code the $ metacharacter to indicate this. For example:
6186 .code
6187 domains = ^\\d{3}\\.example
6188 .endd
6189 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6190 You need to use:
6191 .code
6192 domains = ^\\d{3}\\.example\$
6193 .endd
6194 if you want &'example'& to be the top-level domain. The backslash before the
6195 $ is needed because string expansion also interprets dollar characters.
6196
6197
6198
6199 . ////////////////////////////////////////////////////////////////////////////
6200 . ////////////////////////////////////////////////////////////////////////////
6201
6202 .chapter "File and database lookups" "CHAPfdlookup"
6203 .scindex IIDfidalo1 "file" "lookups"
6204 .scindex IIDfidalo2 "database" "lookups"
6205 .cindex "lookup" "description of"
6206 Exim can be configured to look up data in files or databases as it processes
6207 messages. Two different kinds of syntax are used:
6208
6209 .olist
6210 A string that is to be expanded may contain explicit lookup requests. These
6211 cause parts of the string to be replaced by data that is obtained from the
6212 lookup. Lookups of this type are conditional expansion items. Different results
6213 can be defined for the cases of lookup success and failure. See chapter
6214 &<<CHAPexpand>>&, where string expansions are described in detail.
6215 .next
6216 Lists of domains, hosts, and email addresses can contain lookup requests as a
6217 way of avoiding excessively long linear lists. In this case, the data that is
6218 returned by the lookup is often (but not always) discarded; whether the lookup
6219 succeeds or fails is what really counts. These kinds of list are described in
6220 chapter &<<CHAPdomhosaddlists>>&.
6221 .endlist
6222
6223 String expansions, lists, and lookups interact with each other in such a way
6224 that there is no order in which to describe any one of them that does not
6225 involve references to the others. Each of these three chapters makes more sense
6226 if you have read the other two first. If you are reading this for the first
6227 time, be aware that some of it will make a lot more sense after you have read
6228 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6229
6230 .section "Examples of different lookup syntax" "SECID60"
6231 It is easy to confuse the two different kinds of lookup, especially as the
6232 lists that may contain the second kind are always expanded before being
6233 processed as lists. Therefore, they may also contain lookups of the first kind.
6234 Be careful to distinguish between the following two examples:
6235 .code
6236 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6237 domains = lsearch;/some/file
6238 .endd
6239 The first uses a string expansion, the result of which must be a domain list.
6240 No strings have been specified for a successful or a failing lookup; the
6241 defaults in this case are the looked-up data and an empty string, respectively.
6242 The expansion takes place before the string is processed as a list, and the
6243 file that is searched could contain lines like this:
6244 .code
6245 192.168.3.4: domain1:domain2:...
6246 192.168.1.9: domain3:domain4:...
6247 .endd
6248 When the lookup succeeds, the result of the expansion is a list of domains (and
6249 possibly other types of item that are allowed in domain lists).
6250
6251 In the second example, the lookup is a single item in a domain list. It causes
6252 Exim to use a lookup to see if the domain that is being processed can be found
6253 in the file. The file could contains lines like this:
6254 .code
6255 domain1:
6256 domain2:
6257 .endd
6258 Any data that follows the keys is not relevant when checking that the domain
6259 matches the list item.
6260
6261 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6262 Consider a file containing lines like this:
6263 .code
6264 192.168.5.6: lsearch;/another/file
6265 .endd
6266 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6267 first &%domains%& setting above generates the second setting, which therefore
6268 causes a second lookup to occur.
6269
6270 The rest of this chapter describes the different lookup types that are
6271 available. Any of them can be used in any part of the configuration where a
6272 lookup is permitted.
6273
6274
6275 .section "Lookup types" "SECID61"
6276 .cindex "lookup" "types of"
6277 .cindex "single-key lookup" "definition of"
6278 Two different types of data lookup are implemented:
6279
6280 .ilist
6281 The &'single-key'& type requires the specification of a file in which to look,
6282 and a single key to search for. The key must be a non-empty string for the
6283 lookup to succeed. The lookup type determines how the file is searched.
6284 .next
6285 .cindex "query-style lookup" "definition of"
6286 The &'query-style'& type accepts a generalized database query. No particular
6287 key value is assumed by Exim for query-style lookups. You can use whichever
6288 Exim variables you need to construct the database query.
6289 .endlist
6290
6291 The code for each lookup type is in a separate source file that is included in
6292 the binary of Exim only if the corresponding compile-time option is set. The
6293 default settings in &_src/EDITME_& are:
6294 .code
6295 LOOKUP_DBM=yes
6296 LOOKUP_LSEARCH=yes
6297 .endd
6298 which means that only linear searching and DBM lookups are included by default.
6299 For some types of lookup (e.g. SQL databases), you need to install appropriate
6300 libraries and header files before building Exim.
6301
6302
6303
6304
6305 .section "Single-key lookup types" "SECTsinglekeylookups"
6306 .cindex "lookup" "single-key types"
6307 .cindex "single-key lookup" "list of types"
6308 The following single-key lookup types are implemented:
6309
6310 .ilist
6311 .cindex "cdb" "description of"
6312 .cindex "lookup" "cdb"
6313 .cindex "binary zero" "in lookup key"
6314 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6315 string without a terminating binary zero. The cdb format is designed for
6316 indexed files that are read frequently and never updated, except by total
6317 re-creation. As such, it is particularly suitable for large files containing
6318 aliases or other indexed data referenced by an MTA. Information about cdb can
6319 be found in several places:
6320 .display
6321 &url(http://www.pobox.com/~djb/cdb.html)
6322 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6323 &url(http://packages.debian.org/stable/utils/freecdb.html)
6324 .endd
6325 A cdb distribution is not needed in order to build Exim with cdb support,
6326 because the code for reading cdb files is included directly in Exim itself.
6327 However, no means of building or testing cdb files is provided with Exim, so
6328 you need to obtain a cdb distribution in order to do this.
6329 .next
6330 .cindex "DBM" "lookup type"
6331 .cindex "lookup" "dbm"
6332 .cindex "binary zero" "in lookup key"
6333 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6334 DBM file by looking up the record with the given key. A terminating binary
6335 zero is included in the key that is passed to the DBM library. See section
6336 &<<SECTdb>>& for a discussion of DBM libraries.
6337
6338 .cindex "Berkeley DB library" "file format"
6339 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6340 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6341 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6342 the DB_UNKNOWN option. This enables it to handle any of the types of database
6343 that the library supports, and can be useful for accessing DBM files created by
6344 other applications. (For earlier DB versions, DB_HASH is always used.)
6345 .next
6346 .cindex "lookup" "dbmjz"
6347 .cindex "lookup" "dbm &-- embedded NULs"
6348 .cindex "sasldb2"
6349 .cindex "dbmjz lookup type"
6350 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6351 interpreted as an Exim list; the elements of the list are joined together with
6352 ASCII NUL characters to form the lookup key.  An example usage would be to
6353 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6354 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6355 &(cram_md5)& authenticator.
6356 .next
6357 .cindex "lookup" "dbmnz"
6358 .cindex "lookup" "dbm &-- terminating zero"
6359 .cindex "binary zero" "in lookup key"
6360 .cindex "Courier"
6361 .cindex "&_/etc/userdbshadow.dat_&"
6362 .cindex "dbmnz lookup type"
6363 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6364 is not included in the key that is passed to the DBM library. You may need this
6365 if you want to look up data in files that are created by or shared with some
6366 other application that does not use terminating zeros. For example, you need to
6367 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6368 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6369 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6370 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6371 .next
6372 .cindex "lookup" "dsearch"
6373 .cindex "dsearch lookup type"
6374 &(dsearch)&: The given file must be a directory; this is searched for an entry
6375 whose name is the key by calling the &[lstat()]& function. The key may not
6376 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6377 the lookup is the name of the entry, which may be a file, directory,
6378 symbolic link, or any other kind of directory entry. An example of how this
6379 lookup can be used to support virtual domains is given in section
6380 &<<SECTvirtualdomains>>&.
6381 .next
6382 .cindex "lookup" "iplsearch"
6383 .cindex "iplsearch lookup type"
6384 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6385 terminated by a colon or white space or the end of the line. The keys in the
6386 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6387 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6388 being interpreted as a key terminator. For example:
6389 .code
6390 1.2.3.4:           data for 1.2.3.4
6391 192.168.0.0/16:    data for 192.168.0.0/16
6392 "abcd::cdab":      data for abcd::cdab
6393 "abcd:abcd::/32"   data for abcd:abcd::/32
6394 .endd
6395 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6396 file is searched linearly, using the CIDR masks where present, until a matching
6397 key is found. The first key that matches is used; there is no attempt to find a
6398 &"best"& match. Apart from the way the keys are matched, the processing for
6399 &(iplsearch)& is the same as for &(lsearch)&.
6400
6401 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6402 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6403 lookup types support only literal keys.
6404
6405 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6406 the implicit key is the host's IP address rather than its name (see section
6407 &<<SECThoslispatsikey>>&).
6408 .next
6409 .cindex "linear search"
6410 .cindex "lookup" "lsearch"
6411 .cindex "lsearch lookup type"
6412 .cindex "case sensitivity" "in lsearch lookup"
6413 &(lsearch)&: The given file is a text file that is searched linearly for a
6414 line beginning with the search key, terminated by a colon or white space or the
6415 end of the line. The search is case-insensitive; that is, upper and lower case
6416 letters are treated as the same. The first occurrence of the key that is found
6417 in the file is used.
6418
6419 White space between the key and the colon is permitted. The remainder of the
6420 line, with leading and trailing white space removed, is the data. This can be
6421 continued onto subsequent lines by starting them with any amount of white
6422 space, but only a single space character is included in the data at such a
6423 junction. If the data begins with a colon, the key must be terminated by a
6424 colon, for example:
6425 .code
6426 baduser:  :fail:
6427 .endd
6428 Empty lines and lines beginning with # are ignored, even if they occur in the
6429 middle of an item. This is the traditional textual format of alias files. Note
6430 that the keys in an &(lsearch)& file are literal strings. There is no
6431 wildcarding of any kind.
6432
6433 .cindex "lookup" "lsearch &-- colons in keys"
6434 .cindex "white space" "in lsearch key"
6435 In most &(lsearch)& files, keys are not required to contain colons or #
6436 characters, or white space. However, if you need this feature, it is available.
6437 If a key begins with a doublequote character, it is terminated only by a
6438 matching quote (or end of line), and the normal escaping rules apply to its
6439 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6440 quoted keys (exactly as for unquoted keys). There is no special handling of
6441 quotes for the data part of an &(lsearch)& line.
6442
6443 .next
6444 .cindex "NIS lookup type"
6445 .cindex "lookup" "NIS"
6446 .cindex "binary zero" "in lookup key"
6447 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6448 the given key, without a terminating binary zero. There is a variant called
6449 &(nis0)& which does include the terminating binary zero in the key. This is
6450 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6451 aliases; the full map names must be used.
6452
6453 .next
6454 .cindex "wildlsearch lookup type"
6455 .cindex "lookup" "wildlsearch"
6456 .cindex "nwildlsearch lookup type"
6457 .cindex "lookup" "nwildlsearch"
6458 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6459 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6460 the file may be wildcarded. The difference between these two lookup types is
6461 that for &(wildlsearch)&, each key in the file is string-expanded before being
6462 used, whereas for &(nwildlsearch)&, no expansion takes place.
6463
6464 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6465 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6466 file that are regular expressions can be made case-sensitive by the use of
6467 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6468
6469 . ==== As this is a nested list, any displays it contains must be indented
6470 . ==== as otherwise they are too far to the left.
6471
6472 .olist
6473 The string may begin with an asterisk to mean &"ends with"&. For example:
6474 .code
6475     *.a.b.c       data for anything.a.b.c
6476     *fish         data for anythingfish
6477 .endd
6478 .next
6479 The string may begin with a circumflex to indicate a regular expression. For
6480 example, for &(wildlsearch)&:
6481 .code
6482     ^\N\d+\.a\.b\N    data for <digits>.a.b
6483 .endd
6484 Note the use of &`\N`& to disable expansion of the contents of the regular
6485 expression. If you are using &(nwildlsearch)&, where the keys are not
6486 string-expanded, the equivalent entry is:
6487 .code
6488     ^\d+\.a\.b        data for <digits>.a.b
6489 .endd
6490 The case-insensitive flag is set at the start of compiling the regular
6491 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6492 For example, to make the entire pattern case-sensitive:
6493 .code
6494     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6495 .endd
6496
6497 If the regular expression contains white space or colon characters, you must
6498 either quote it (see &(lsearch)& above), or represent these characters in other
6499 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6500 colon. This may be easier than quoting, because if you quote, you have to
6501 escape all the backslashes inside the quotes.
6502
6503 &*Note*&: It is not possible to capture substrings in a regular expression
6504 match for later use, because the results of all lookups are cached. If a lookup
6505 is repeated, the result is taken from the cache, and no actual pattern matching
6506 takes place. The values of all the numeric variables are unset after a
6507 &((n)wildlsearch)& match.
6508
6509 .next
6510 Although I cannot see it being of much use, the general matching function that
6511 is used to implement &((n)wildlsearch)& means that the string may begin with a
6512 lookup name terminated by a semicolon, and followed by lookup data. For
6513 example:
6514 .code
6515     cdb;/some/file  data for keys that match the file
6516 .endd
6517 The data that is obtained from the nested lookup is discarded.
6518 .endlist olist
6519
6520 Keys that do not match any of these patterns are interpreted literally. The
6521 continuation rules for the data are the same as for &(lsearch)&, and keys may
6522 be followed by optional colons.
6523
6524 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6525 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6526 lookup types support only literal keys.
6527 .endlist ilist
6528
6529
6530 .section "Query-style lookup types" "SECID62"
6531 .cindex "lookup" "query-style types"
6532 .cindex "query-style lookup" "list of types"
6533 The supported query-style lookup types are listed below. Further details about
6534 many of them are given in later sections.
6535
6536 .ilist
6537 .cindex "DNS" "as a lookup type"
6538 .cindex "lookup" "DNS"
6539 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6540 are given in the supplied query. The resulting data is the contents of the
6541 records. See section &<<SECTdnsdb>>&.
6542 .next
6543 .cindex "InterBase lookup type"
6544 .cindex "lookup" "InterBase"
6545 &(ibase)&: This does a lookup in an InterBase database.
6546 .next
6547 .cindex "LDAP" "lookup type"
6548 .cindex "lookup" "LDAP"
6549 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6550 returns attributes from a single entry. There is a variant called &(ldapm)&
6551 that permits values from multiple entries to be returned. A third variant
6552 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6553 any attribute values. See section &<<SECTldap>>&.
6554 .next
6555 .cindex "MySQL" "lookup type"
6556 .cindex "lookup" "MySQL"
6557 &(mysql)&: The format of the query is an SQL statement that is passed to a
6558 MySQL database. See section &<<SECTsql>>&.
6559 .next
6560 .cindex "NIS+ lookup type"
6561 .cindex "lookup" "NIS+"
6562 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6563 the field to be returned. See section &<<SECTnisplus>>&.
6564 .next
6565 .cindex "Oracle" "lookup type"
6566 .cindex "lookup" "Oracle"
6567 &(oracle)&: The format of the query is an SQL statement that is passed to an
6568 Oracle database. See section &<<SECTsql>>&.
6569 .next
6570 .cindex "lookup" "passwd"
6571 .cindex "passwd lookup type"
6572 .cindex "&_/etc/passwd_&"
6573 &(passwd)& is a query-style lookup with queries that are just user names. The
6574 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6575 success, the result string is the same as you would get from an &(lsearch)&
6576 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6577 password value. For example:
6578 .code
6579 *:42:42:King Rat:/home/kr:/bin/bash
6580 .endd
6581 .next
6582 .cindex "PostgreSQL lookup type"
6583 .cindex "lookup" "PostgreSQL"
6584 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6585 PostgreSQL database. See section &<<SECTsql>>&.
6586
6587 .next
6588 .cindex "sqlite lookup type"
6589 .cindex "lookup" "sqlite"
6590 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6591 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6592
6593 .next
6594 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6595 not likely to be useful in normal operation.
6596 .next
6597 .cindex "whoson lookup type"
6598 .cindex "lookup" "whoson"
6599 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6600 allows a server to check whether a particular (dynamically allocated) IP
6601 address is currently allocated to a known (trusted) user and, optionally, to
6602 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6603 at one time for &"POP before SMTP"& authentication, but that approach has been
6604 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6605 &"POP before SMTP"& checking using ACL statements such as
6606 .code
6607 require condition = \
6608   ${lookup whoson {$sender_host_address}{yes}{no}}
6609 .endd
6610 The query consists of a single IP address. The value returned is the name of
6611 the authenticated user, which is stored in the variable &$value$&. However, in
6612 this example, the data in &$value$& is not used; the result of the lookup is
6613 one of the fixed strings &"yes"& or &"no"&.
6614 .endlist
6615
6616
6617
6618 .section "Temporary errors in lookups" "SECID63"
6619 .cindex "lookup" "temporary error in"
6620 Lookup functions can return temporary error codes if the lookup cannot be
6621 completed. For example, an SQL or LDAP database might be unavailable. For this
6622 reason, it is not advisable to use a lookup that might do this for critical
6623 options such as a list of local domains.
6624
6625 When a lookup cannot be completed in a router or transport, delivery
6626 of the message (to the relevant address) is deferred, as for any other
6627 temporary error. In other circumstances Exim may assume the lookup has failed,
6628 or may give up altogether.
6629
6630
6631
6632 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6633 .cindex "wildcard lookups"
6634 .cindex "lookup" "default values"
6635 .cindex "lookup" "wildcard"
6636 .cindex "lookup" "* added to type"
6637 .cindex "default" "in single-key lookups"
6638 In this context, a &"default value"& is a value specified by the administrator
6639 that is to be used if a lookup fails.
6640
6641 &*Note:*& This section applies only to single-key lookups. For query-style
6642 lookups, the facilities of the query language must be used. An attempt to
6643 specify a default for a query-style lookup provokes an error.
6644
6645 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6646 and the initial lookup fails, the key &"*"& is looked up in the file to
6647 provide a default value. See also the section on partial matching below.
6648
6649 .cindex "*@ with single-key lookup"
6650 .cindex "lookup" "*@ added to type"
6651 .cindex "alias file" "per-domain default"
6652 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6653 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6654 character, a second lookup is done with everything before the last @ replaced
6655 by *. This makes it possible to provide per-domain defaults in alias files
6656 that include the domains in the keys. If the second lookup fails (or doesn't
6657 take place because there is no @ in the key), &"*"& is looked up.
6658 For example, a &(redirect)& router might contain:
6659 .code
6660 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6661 .endd
6662 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6663 looks up these keys, in this order:
6664 .code
6665 jane@eyre.example
6666 *@eyre.example
6667 *
6668 .endd
6669 The data is taken from whichever key it finds first. &*Note*&: In an
6670 &(lsearch)& file, this does not mean the first of these keys in the file. A
6671 complete scan is done for each key, and only if it is not found at all does
6672 Exim move on to try the next key.
6673
6674
6675
6676 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6677 .cindex "partial matching"
6678 .cindex "wildcard lookups"
6679 .cindex "lookup" "partial matching"
6680 .cindex "lookup" "wildcard"
6681 .cindex "asterisk" "in search type"
6682 The normal operation of a single-key lookup is to search the file for an exact
6683 match with the given key. However, in a number of situations where domains are
6684 being looked up, it is useful to be able to do partial matching. In this case,
6685 information in the file that has a key starting with &"*."& is matched by any
6686 domain that ends with the components that follow the full stop. For example, if
6687 a key in a DBM file is
6688 .code
6689 *.dates.fict.example
6690 .endd
6691 then when partial matching is enabled this is matched by (amongst others)
6692 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6693 by &'dates.fict.example'&, if that does not appear as a separate key in the
6694 file.
6695
6696 &*Note*&: Partial matching is not available for query-style lookups. It is
6697 also not available for any lookup items in address lists (see section
6698 &<<SECTaddresslist>>&).
6699
6700 Partial matching is implemented by doing a series of separate lookups using
6701 keys constructed by modifying the original subject key. This means that it can
6702 be used with any of the single-key lookup types, provided that
6703 partial matching keys
6704 beginning with a special prefix (default &"*."&) are included in the data file.
6705 Keys in the file that do not begin with the prefix are matched only by
6706 unmodified subject keys when partial matching is in use.
6707
6708 Partial matching is requested by adding the string &"partial-"& to the front of
6709 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6710 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6711 is added at the start of the subject key, and it is looked up again. If that
6712 fails, further lookups are tried with dot-separated components removed from the
6713 start of the subject key, one-by-one, and &"*."& added on the front of what
6714 remains.
6715
6716 A minimum number of two non-* components are required. This can be adjusted
6717 by including a number before the hyphen in the search type. For example,
6718 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6719 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6720 subject key is &'2250.dates.fict.example'& then the following keys are looked
6721 up when the minimum number of non-* components is two:
6722 .code
6723 2250.dates.fict.example
6724 *.2250.dates.fict.example
6725 *.dates.fict.example
6726 *.fict.example
6727 .endd
6728 As soon as one key in the sequence is successfully looked up, the lookup
6729 finishes.
6730
6731 .cindex "lookup" "partial matching &-- changing prefix"
6732 .cindex "prefix" "for partial matching"
6733 The use of &"*."& as the partial matching prefix is a default that can be
6734 changed. The motivation for this feature is to allow Exim to operate with file
6735 formats that are used by other MTAs. A different prefix can be supplied in
6736 parentheses instead of the hyphen after &"partial"&. For example:
6737 .code
6738 domains = partial(.)lsearch;/some/file
6739 .endd
6740 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6741 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6742 components is unchanged). The prefix may consist of any punctuation characters
6743 other than a closing parenthesis. It may be empty, for example:
6744 .code
6745 domains = partial1()cdb;/some/file
6746 .endd
6747 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6748 &`a.b.c`&, &`b.c`&, and &`c`&.
6749
6750 If &"partial0"& is specified, what happens at the end (when the lookup with
6751 just one non-wild component has failed, and the original key is shortened right
6752 down to the null string) depends on the prefix:
6753
6754 .ilist
6755 If the prefix has zero length, the whole lookup fails.
6756 .next
6757 If the prefix has length 1, a lookup for just the prefix is done. For
6758 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6759 .next
6760 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6761 remainder is looked up. With the default prefix, therefore, the final lookup is
6762 for &"*"& on its own.
6763 .next
6764 Otherwise, the whole prefix is looked up.
6765 .endlist
6766
6767
6768 If the search type ends in &"*"& or &"*@"& (see section
6769 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6770 this implies happens after all partial lookups have failed. If &"partial0"& is
6771 specified, adding &"*"& to the search type has no effect with the default
6772 prefix, because the &"*"& key is already included in the sequence of partial
6773 lookups. However, there might be a use for lookup types such as
6774 &"partial0(.)lsearch*"&.
6775
6776 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6777 in domain lists and the like. Partial matching works only in terms of
6778 dot-separated components; a key such as &`*fict.example`&
6779 in a database file is useless, because the asterisk in a partial matching
6780 subject key is always followed by a dot.
6781
6782
6783
6784
6785 .section "Lookup caching" "SECID64"
6786 .cindex "lookup" "caching"
6787 .cindex "caching" "lookup data"
6788 Exim caches all lookup results in order to avoid needless repetition of
6789 lookups. However, because (apart from the daemon) Exim operates as a collection
6790 of independent, short-lived processes, this caching applies only within a
6791 single Exim process. There is no inter-process lookup caching facility.
6792
6793 For single-key lookups, Exim keeps the relevant files open in case there is
6794 another lookup that needs them. In some types of configuration this can lead to
6795 many files being kept open for messages with many recipients. To avoid hitting
6796 the operating system limit on the number of simultaneously open files, Exim
6797 closes the least recently used file when it needs to open more files than its
6798 own internal limit, which can be changed via the &%lookup_open_max%& option.
6799
6800 The single-key lookup files are closed and the lookup caches are flushed at
6801 strategic points during delivery &-- for example, after all routing is
6802 complete.
6803
6804
6805
6806
6807 .section "Quoting lookup data" "SECID65"
6808 .cindex "lookup" "quoting"
6809 .cindex "quoting" "in lookups"
6810 When data from an incoming message is included in a query-style lookup, there
6811 is the possibility of special characters in the data messing up the syntax of
6812 the query. For example, a NIS+ query that contains
6813 .code
6814 [name=$local_part]
6815 .endd
6816 will be broken if the local part happens to contain a closing square bracket.
6817 For NIS+, data can be enclosed in double quotes like this:
6818 .code
6819 [name="$local_part"]
6820 .endd
6821 but this still leaves the problem of a double quote in the data. The rule for
6822 NIS+ is that double quotes must be doubled. Other lookup types have different
6823 rules, and to cope with the differing requirements, an expansion operator
6824 of the following form is provided:
6825 .code
6826 ${quote_<lookup-type>:<string>}
6827 .endd
6828 For example, the safest way to write the NIS+ query is
6829 .code
6830 [name="${quote_nisplus:$local_part}"]
6831 .endd
6832 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6833 operator can be used for all lookup types, but has no effect for single-key
6834 lookups, since no quoting is ever needed in their key strings.
6835
6836
6837
6838
6839 .section "More about dnsdb" "SECTdnsdb"
6840 .cindex "dnsdb lookup"
6841 .cindex "lookup" "dnsdb"
6842 .cindex "DNS" "as a lookup type"
6843 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6844 of a record type and a domain name, separated by an equals sign. For example,
6845 an expansion string could contain:
6846 .code
6847 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6848 .endd
6849 If the lookup succeeds, the result is placed in &$value$&, which in this case
6850 is used on its own as the result. If the lookup does not succeed, the
6851 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6852 &<<SECTforexpfai>>& for an explanation of what this means.
6853
6854 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6855 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6856 configured). If no type is given, TXT is assumed. When the type is PTR,
6857 the data can be an IP address, written as normal; inversion and the addition of
6858 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6859 .code
6860 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6861 .endd
6862 If the data for a PTR record is not a syntactically valid IP address, it is not
6863 altered and nothing is added.
6864
6865 .cindex "MX record" "in &(dnsdb)& lookup"
6866 .cindex "SRV record" "in &(dnsdb)& lookup"
6867 For an MX lookup, both the preference value and the host name are returned for
6868 each record, separated by a space. For an SRV lookup, the priority, weight,
6869 port, and host name are returned for each record, separated by spaces.
6870
6871 For any record type, if multiple records are found (or, for A6 lookups, if a
6872 single record leads to multiple addresses), the data is returned as a
6873 concatenation, with newline as the default separator. The order, of course,
6874 depends on the DNS resolver. You can specify a different separator character
6875 between multiple records by putting a right angle-bracket followed immediately
6876 by the new separator at the start of the query. For example:
6877 .code
6878 ${lookup dnsdb{>: a=host1.example}}
6879 .endd
6880 It is permitted to specify a space as the separator character. Further
6881 white space is ignored.
6882
6883 .cindex "TXT record" "in &(dnsdb)& lookup"
6884 .cindex "SPF record" "in &(dnsdb)& lookup"
6885 For TXT records with multiple items of data, only the first item is returned,
6886 unless a separator for them is specified using a comma after the separator
6887 character followed immediately by the TXT record item separator. To concatenate
6888 items without a separator, use a semicolon instead. For SPF records the
6889 default behaviour is to concatenate multiple items without using a separator.
6890 .code
6891 ${lookup dnsdb{>\n,: txt=a.b.example}}
6892 ${lookup dnsdb{>\n; txt=a.b.example}}
6893 ${lookup dnsdb{spf=example.org}}
6894 .endd
6895 It is permitted to specify a space as the separator character. Further
6896 white space is ignored.
6897
6898 .section "Pseudo dnsdb record types" "SECID66"
6899 .cindex "MX record" "in &(dnsdb)& lookup"
6900 By default, both the preference value and the host name are returned for
6901 each MX record, separated by a space. If you want only host names, you can use
6902 the pseudo-type MXH:
6903 .code
6904 ${lookup dnsdb{mxh=a.b.example}}
6905 .endd
6906 In this case, the preference values are omitted, and just the host names are
6907 returned.
6908
6909 .cindex "name server for enclosing domain"
6910 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6911 records on the given domain, but if none are found, it removes the first
6912 component of the domain name, and tries again. This process continues until NS
6913 records are found or there are no more components left (or there is a DNS
6914 error). In other words, it may return the name servers for a top-level domain,
6915 but it never returns the root name servers. If there are no NS records for the
6916 top-level domain, the lookup fails. Consider these examples:
6917 .code
6918 ${lookup dnsdb{zns=xxx.quercite.com}}
6919 ${lookup dnsdb{zns=xxx.edu}}
6920 .endd
6921 Assuming that in each case there are no NS records for the full domain name,
6922 the first returns the name servers for &%quercite.com%&, and the second returns
6923 the name servers for &%edu%&.
6924
6925 You should be careful about how you use this lookup because, unless the
6926 top-level domain does not exist, the lookup always returns some host names. The
6927 sort of use to which this might be put is for seeing if the name servers for a
6928 given domain are on a blacklist. You can probably assume that the name servers
6929 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6930 such a list.
6931
6932 .cindex "CSA" "in &(dnsdb)& lookup"
6933 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6934 records according to the CSA rules, which are described in section
6935 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6936 not sufficient because of the extra parent domain search behaviour of CSA. The
6937 result of a successful lookup such as:
6938 .code
6939 ${lookup dnsdb {csa=$sender_helo_name}}
6940 .endd
6941 has two space-separated fields: an authorization code and a target host name.
6942 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6943 authorization required but absent, or &"?"& for unknown.
6944
6945 .cindex "A+" "in &(dnsdb)& lookup"
6946 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6947 and then an A lookup.  All results are returned; defer processing
6948 (see below) is handled separately for each lookup.  Example:
6949 .code
6950 ${lookup dnsdb {>; a+=$sender_helo_name}}
6951 .endd
6952
6953
6954 .section "Multiple dnsdb lookups" "SECID67"
6955 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6956 However, you can specify a list of domains or IP addresses in a single
6957 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6958 the default separator, but with the ability to change this. For example:
6959 .code
6960 ${lookup dnsdb{one.domain.com:two.domain.com}}
6961 ${lookup dnsdb{a=one.host.com:two.host.com}}
6962 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6963 .endd
6964 In order to retain backwards compatibility, there is one special case: if
6965 the lookup type is PTR and no change of separator is specified, Exim looks
6966 to see if the rest of the string is precisely one IPv6 address. In this
6967 case, it does not treat it as a list.
6968
6969 The data from each lookup is concatenated, with newline separators by default,
6970 in the same way that multiple DNS records for a single item are handled. A
6971 different separator can be specified, as described above.
6972
6973 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6974 temporary DNS error for any of them, the behaviour is controlled by
6975 an optional keyword followed by a comma that may appear before the record
6976 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6977 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6978 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6979 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6980 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6981 error causes the whole lookup to defer only if none of the other lookups
6982 succeed. The default is &"lax"&, so the following lookups are equivalent:
6983 .code
6984 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6985 ${lookup dnsdb{a=one.host.com:two.host.com}}
6986 .endd
6987 Thus, in the default case, as long as at least one of the DNS lookups
6988 yields some data, the lookup succeeds.
6989
6990
6991
6992
6993 .section "More about LDAP" "SECTldap"
6994 .cindex "LDAP" "lookup, more about"
6995 .cindex "lookup" "LDAP"
6996 .cindex "Solaris" "LDAP"
6997 The original LDAP implementation came from the University of Michigan; this has
6998 become &"Open LDAP"&, and there are now two different releases. Another
6999 implementation comes from Netscape, and Solaris 7 and subsequent releases
7000 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7001 the lookup function level, their error handling is different. For this reason
7002 it is necessary to set a compile-time variable when building Exim with LDAP, to
7003 indicate which LDAP library is in use. One of the following should appear in
7004 your &_Local/Makefile_&:
7005 .code
7006 LDAP_LIB_TYPE=UMICHIGAN
7007 LDAP_LIB_TYPE=OPENLDAP1
7008 LDAP_LIB_TYPE=OPENLDAP2
7009 LDAP_LIB_TYPE=NETSCAPE
7010 LDAP_LIB_TYPE=SOLARIS
7011 .endd
7012 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7013 same interface as the University of Michigan version.
7014
7015 There are three LDAP lookup types in Exim. These behave slightly differently in
7016 the way they handle the results of a query:
7017
7018 .ilist
7019 &(ldap)& requires the result to contain just one entry; if there are more, it
7020 gives an error.
7021 .next
7022 &(ldapdn)& also requires the result to contain just one entry, but it is the
7023 Distinguished Name that is returned rather than any attribute values.
7024 .next
7025 &(ldapm)& permits the result to contain more than one entry; the attributes
7026 from all of them are returned.
7027 .endlist
7028
7029
7030 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7031 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7032 the data returned by a successful lookup is described in the next section.
7033 First we explain how LDAP queries are coded.
7034
7035
7036 .section "Format of LDAP queries" "SECTforldaque"
7037 .cindex "LDAP" "query format"
7038 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7039 the configuration of a &(redirect)& router one might have this setting:
7040 .code
7041 data = ${lookup ldap \
7042   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7043   c=UK?mailbox?base?}}
7044 .endd
7045 .cindex "LDAP" "with TLS"
7046 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7047 secure (encrypted) LDAP connections. The second of these ensures that an
7048 encrypted TLS connection is used.
7049
7050 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7051 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7052 See the &%ldap_start_tls%& option.
7053
7054
7055 .section "LDAP quoting" "SECID68"
7056 .cindex "LDAP" "quoting"
7057 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7058 and the second because the LDAP query is represented as a URL. Furthermore,
7059 within an LDAP query, two different kinds of quoting are required. For this
7060 reason, there are two different LDAP-specific quoting operators.
7061
7062 The &%quote_ldap%& operator is designed for use on strings that are part of
7063 filter specifications. Conceptually, it first does the following conversions on
7064 the string:
7065 .code
7066 *   =>   \2A
7067 (   =>   \28
7068 )   =>   \29
7069 \   =>   \5C
7070 .endd
7071 in accordance with RFC 2254. The resulting string is then quoted according
7072 to the rules for URLs, that is, all non-alphanumeric characters except
7073 .code
7074 ! $ ' - . _ ( ) * +
7075 .endd
7076 are converted to their hex values, preceded by a percent sign. For example:
7077 .code
7078 ${quote_ldap: a(bc)*, a<yz>; }
7079 .endd
7080 yields
7081 .code
7082 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7083 .endd
7084 Removing the URL quoting, this is (with a leading and a trailing space):
7085 .code
7086 a\28bc\29\2A, a<yz>;
7087 .endd
7088 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7089 base DN specifications in queries. Conceptually, it first converts the string
7090 by inserting a backslash in front of any of the following characters:
7091 .code
7092 , + " \ < > ;
7093 .endd
7094 It also inserts a backslash before any leading spaces or # characters, and
7095 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7096 is then quoted according to the rules for URLs. For example:
7097 .code
7098 ${quote_ldap_dn: a(bc)*, a<yz>; }
7099 .endd
7100 yields
7101 .code
7102 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7103 .endd
7104 Removing the URL quoting, this is (with a trailing space):
7105 .code
7106 \ a(bc)*\, a\<yz\>\;\
7107 .endd
7108 There are some further comments about quoting in the section on LDAP
7109 authentication below.
7110
7111
7112 .section "LDAP connections" "SECID69"
7113 .cindex "LDAP" "connections"
7114 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7115 is in use, via a Unix domain socket. The example given above does not specify
7116 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7117 by starting it with
7118 .code
7119 ldap://<hostname>:<port>/...
7120 .endd
7121 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7122 used. When no server is specified in a query, a list of default servers is
7123 taken from the &%ldap_default_servers%& configuration option. This supplies a
7124 colon-separated list of servers which are tried in turn until one successfully
7125 handles a query, or there is a serious error. Successful handling either
7126 returns the requested data, or indicates that it does not exist. Serious errors
7127 are syntactical, or multiple values when only a single value is expected.
7128 Errors which cause the next server to be tried are connection failures, bind
7129 failures, and timeouts.
7130
7131 For each server name in the list, a port number can be given. The standard way
7132 of specifying a host and port is to use a colon separator (RFC 1738). Because
7133 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7134 doubled. For example
7135 .code
7136 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7137 .endd
7138 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7139 to the LDAP library with no server name, and the library's default (normally
7140 the local host) is used.
7141
7142 If you are using the OpenLDAP library, you can connect to an LDAP server using
7143 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7144 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7145 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7146 not available.
7147
7148 For this type of connection, instead of a host name for the server, a pathname
7149 for the socket is required, and the port number is not relevant. The pathname
7150 can be specified either as an item in &%ldap_default_servers%&, or inline in
7151 the query. In the former case, you can have settings such as
7152 .code
7153 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7154 .endd
7155 When the pathname is given in the query, you have to escape the slashes as
7156 &`%2F`& to fit in with the LDAP URL syntax. For example:
7157 .code
7158 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7159 .endd
7160 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7161 a pathname, it uses the Unix domain socket code, even if the query actually
7162 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7163 socket connection. This behaviour means that you can use a setting of
7164 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7165 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7166 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7167 backup host.
7168
7169 If an explicit &`ldapi`& type is given in a query when a host name is
7170 specified, an error is diagnosed. However, if there are more items in
7171 &%ldap_default_servers%&, they are tried. In other words:
7172
7173 .ilist
7174 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7175 interface.
7176 .next
7177 Using &`ldapi`& with a host name causes an error.
7178 .endlist
7179
7180
7181 Using &`ldapi`& with no host or path in the query, and no setting of
7182 &%ldap_default_servers%&, does whatever the library does by default.
7183
7184
7185
7186 .section "LDAP authentication and control information" "SECID70"
7187 .cindex "LDAP" "authentication"
7188 The LDAP URL syntax provides no way of passing authentication and other control
7189 information to the server. To make this possible, the URL in an LDAP query may
7190 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7191 spaces. If a value contains spaces it must be enclosed in double quotes, and
7192 when double quotes are used, backslash is interpreted in the usual way inside
7193 them. The following names are recognized:
7194 .display
7195 &`DEREFERENCE`&  set the dereferencing parameter
7196 &`NETTIME    `&  set a timeout for a network operation
7197 &`USER       `&  set the DN, for authenticating the LDAP bind
7198 &`PASS       `&  set the password, likewise
7199 &`REFERRALS  `&  set the referrals parameter
7200 &`SIZE       `&  set the limit for the number of entries returned
7201 &`TIME       `&  set the maximum waiting time for a query
7202 .endd
7203 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7204 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7205 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7206 library from trying to follow referrals issued by the LDAP server.
7207
7208 The name CONNECT is an obsolete name for NETTIME, retained for
7209 backwards compatibility. This timeout (specified as a number of seconds) is
7210 enforced from the client end for operations that can be carried out over a
7211 network. Specifically, it applies to network connections and calls to the
7212 &'ldap_result()'& function. If the value is greater than zero, it is used if
7213 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7214 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7215 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7216 Netscape SDK; for OpenLDAP no action is taken.
7217
7218 The TIME parameter (also a number of seconds) is passed to the server to
7219 set a server-side limit on the time taken to complete a search.
7220
7221
7222 Here is an example of an LDAP query in an Exim lookup that uses some of these
7223 values. This is a single line, folded to fit on the page:
7224 .code
7225 ${lookup ldap
7226   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7227   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7228   {$value}fail}
7229 .endd
7230 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7231 any of the auxiliary data. Exim configuration settings that include lookups
7232 which contain password information should be preceded by &"hide"& to prevent
7233 non-admin users from using the &%-bP%& option to see their values.
7234
7235 The auxiliary data items may be given in any order. The default is no
7236 connection timeout (the system timeout is used), no user or password, no limit
7237 on the number of entries returned, and no time limit on queries.
7238
7239 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7240 removes any URL quoting that it may contain before passing it LDAP. Apparently
7241 some libraries do this for themselves, but some do not. Removing the URL
7242 quoting has two advantages:
7243
7244 .ilist
7245 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7246 DNs as with DNs inside actual queries.
7247 .next
7248 It permits spaces inside USER= DNs.
7249 .endlist
7250
7251 For example, a setting such as
7252 .code
7253 USER=cn=${quote_ldap_dn:$1}
7254 .endd
7255 should work even if &$1$& contains spaces.
7256
7257 Expanded data for the PASS= value should be quoted using the &%quote%&
7258 expansion operator, rather than the LDAP quote operators. The only reason this
7259 field needs quoting is to ensure that it conforms to the Exim syntax, which
7260 does not allow unquoted spaces. For example:
7261 .code
7262 PASS=${quote:$3}
7263 .endd
7264 The LDAP authentication mechanism can be used to check passwords as part of
7265 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7266 &<<CHAPexpand>>&.
7267
7268
7269
7270 .section "Format of data returned by LDAP" "SECID71"
7271 .cindex "LDAP" "returned data formats"
7272 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7273 as a sequence of values, for example
7274 .code
7275 cn=manager, o=University of Cambridge, c=UK
7276 .endd
7277 The &(ldap)& lookup type generates an error if more than one entry matches the
7278 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7279 the result between the data from different entries. It is possible for multiple
7280 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7281 you know that whatever values are returned all came from a single entry in the
7282 directory.
7283
7284 In the common case where you specify a single attribute in your LDAP query, the
7285 result is not quoted, and does not contain the attribute name. If the attribute
7286 has multiple values, they are separated by commas.
7287
7288 If you specify multiple attributes, the result contains space-separated, quoted
7289 strings, each preceded by the attribute name and an equals sign. Within the
7290 quotes, the quote character, backslash, and newline are escaped with
7291 backslashes, and commas are used to separate multiple values for the attribute.
7292 Apart from the escaping, the string within quotes takes the same form as the
7293 output when a single attribute is requested. Specifying no attributes is the
7294 same as specifying all of an entry's attributes.
7295
7296 Here are some examples of the output format. The first line of each pair is an
7297 LDAP query, and the second is the data that is returned. The attribute called
7298 &%attr1%& has two values, whereas &%attr2%& has only one value:
7299 .code
7300 ldap:///o=base?attr1?sub?(uid=fred)
7301 value1.1, value1.2
7302
7303 ldap:///o=base?attr2?sub?(uid=fred)
7304 value two
7305
7306 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7307 attr1="value1.1, value1.2" attr2="value two"
7308
7309 ldap:///o=base??sub?(uid=fred)
7310 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7311 .endd
7312 The &%extract%& operator in string expansions can be used to pick out
7313 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7314 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7315 results of LDAP lookups.
7316
7317
7318
7319
7320 .section "More about NIS+" "SECTnisplus"
7321 .cindex "NIS+ lookup type"
7322 .cindex "lookup" "NIS+"
7323 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7324 and field name. If this is given, the result of a successful query is the
7325 contents of the named field; otherwise the result consists of a concatenation
7326 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7327 values containing spaces are quoted. For example, the query
7328 .code
7329 [name=mg1456],passwd.org_dir
7330 .endd
7331 might return the string
7332 .code
7333 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7334 home=/home/mg1456 shell=/bin/bash shadow=""
7335 .endd
7336 (split over two lines here to fit on the page), whereas
7337 .code
7338 [name=mg1456],passwd.org_dir:gcos
7339 .endd
7340 would just return
7341 .code
7342 Martin Guerre
7343 .endd
7344 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7345 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7346 operator is to double any quote characters within the text.
7347
7348
7349
7350 .section "SQL lookups" "SECTsql"
7351 .cindex "SQL lookup types"
7352 .cindex "MySQL" "lookup type"
7353 .cindex "PostgreSQL lookup type"
7354 .cindex "lookup" "MySQL"
7355 .cindex "lookup" "PostgreSQL"
7356 .cindex "Oracle" "lookup type"
7357 .cindex "lookup" "Oracle"
7358 .cindex "InterBase lookup type"
7359 .cindex "lookup" "InterBase"
7360 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7361 databases. Queries for these databases contain SQL statements, so an example
7362 might be
7363 .code
7364 ${lookup mysql{select mailbox from users where id='userx'}\
7365   {$value}fail}
7366 .endd
7367 If the result of the query contains more than one field, the data for each
7368 field in the row is returned, preceded by its name, so the result of
7369 .code
7370 ${lookup pgsql{select home,name from users where id='userx'}\
7371   {$value}}
7372 .endd
7373 might be
7374 .code
7375 home=/home/userx name="Mister X"
7376 .endd
7377 Empty values and values containing spaces are double quoted, with embedded
7378 quotes escaped by a backslash. If the result of the query contains just one
7379 field, the value is passed back verbatim, without a field name, for example:
7380 .code
7381 Mister X
7382 .endd
7383 If the result of the query yields more than one row, it is all concatenated,
7384 with a newline between the data for each row.
7385
7386
7387 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7388 .cindex "MySQL" "lookup type"
7389 .cindex "PostgreSQL lookup type"
7390 .cindex "lookup" "MySQL"
7391 .cindex "lookup" "PostgreSQL"
7392 .cindex "Oracle" "lookup type"
7393 .cindex "lookup" "Oracle"
7394 .cindex "InterBase lookup type"
7395 .cindex "lookup" "InterBase"
7396 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7397 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7398 option (as appropriate) must be set to a colon-separated list of server
7399 information.
7400 (For MySQL and PostgreSQL only, the global option need not be set if all
7401 queries contain their own server information &-- see section
7402 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7403 items: host name, database name, user name, and password. In the case of
7404 Oracle, the host name field is used for the &"service name"&, and the database
7405 name field is not used and should be empty. For example:
7406 .code
7407 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7408 .endd
7409 Because password data is sensitive, you should always precede the setting with
7410 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7411 option. Here is an example where two MySQL servers are listed:
7412 .code
7413 hide mysql_servers = localhost/users/root/secret:\
7414                      otherhost/users/root/othersecret
7415 .endd
7416 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7417 because this is a colon-separated list, the colon has to be doubled. For each
7418 query, these parameter groups are tried in order until a connection is made and
7419 a query is successfully processed. The result of a query may be that no data is
7420 found, but that is still a successful query. In other words, the list of
7421 servers provides a backup facility, not a list of different places to look.
7422
7423 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7424 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7425 respectively, and the characters single-quote, double-quote, and backslash
7426 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7427 addition, escapes the percent and underscore characters. This cannot be done
7428 for MySQL because these escapes are not recognized in contexts where these
7429 characters are not special.
7430
7431 .section "Specifying the server in the query" "SECTspeserque"
7432 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7433 it is possible to specify a list of servers with an individual query. This is
7434 done by starting the query with
7435 .display
7436 &`servers=`&&'server1:server2:server3:...'&&`;`&
7437 .endd
7438 Each item in the list may take one of two forms:
7439 .olist
7440 If it contains no slashes it is assumed to be just a host name. The appropriate
7441 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7442 of the same name, and the remaining parameters (database, user, password) are
7443 taken from there.
7444 .next
7445 If it contains any slashes, it is taken as a complete parameter set.
7446 .endlist
7447 The list of servers is used in exactly the same way as the global list.
7448 Once a connection to a server has happened and a query has been
7449 successfully executed, processing of the lookup ceases.
7450
7451 This feature is intended for use in master/slave situations where updates
7452 are occurring and you want to update the master rather than a slave. If the
7453 master is in the list as a backup for reading, you might have a global setting
7454 like this:
7455 .code
7456 mysql_servers = slave1/db/name/pw:\
7457                 slave2/db/name/pw:\
7458                 master/db/name/pw
7459 .endd
7460 In an updating lookup, you could then write:
7461 .code
7462 ${lookup mysql{servers=master; UPDATE ...} }
7463 .endd
7464 That query would then be sent only to the master server. If, on the other hand,
7465 the master is not to be used for reading, and so is not present in the global
7466 option, you can still update it by a query of this form:
7467 .code
7468 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7469 .endd
7470
7471
7472 .section "Special MySQL features" "SECID73"
7473 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7474 causes a connection to the server on the local host by means of a Unix domain
7475 socket. An alternate socket can be specified in parentheses. The full syntax of
7476 each item in &%mysql_servers%& is:
7477 .display
7478 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7479   <&'user'&>/<&'password'&>
7480 .endd
7481 Any of the three sub-parts of the first field can be omitted. For normal use on
7482 the local host it can be left blank or set to just &"localhost"&.
7483
7484 No database need be supplied &-- but if it is absent here, it must be given in
7485 the queries.
7486
7487 If a MySQL query is issued that does not request any data (an insert, update,
7488 or delete command), the result of the lookup is the number of rows affected.
7489
7490 &*Warning*&: This can be misleading. If an update does not actually change
7491 anything (for example, setting a field to the value it already has), the result
7492 is zero because no rows are affected.
7493
7494
7495 .section "Special PostgreSQL features" "SECID74"
7496 PostgreSQL lookups can also use Unix domain socket connections to the database.
7497 This is usually faster and costs less CPU time than a TCP/IP connection.
7498 However it can be used only if the mail server runs on the same machine as the
7499 database server. A configuration line for PostgreSQL via Unix domain sockets
7500 looks like this:
7501 .code
7502 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7503 .endd
7504 In other words, instead of supplying a host name, a path to the socket is
7505 given. The path name is enclosed in parentheses so that its slashes aren't
7506 visually confused with the delimiters for the other server parameters.
7507
7508 If a PostgreSQL query is issued that does not request any data (an insert,
7509 update, or delete command), the result of the lookup is the number of rows
7510 affected.
7511
7512 .section "More about SQLite" "SECTsqlite"
7513 .cindex "lookup" "SQLite"
7514 .cindex "sqlite lookup type"
7515 SQLite is different to the other SQL lookups because a file name is required in
7516 addition to the SQL query. An SQLite database is a single file, and there is no
7517 daemon as in the other SQL databases. The interface to Exim requires the name
7518 of the file, as an absolute path, to be given at the start of the query. It is
7519 separated from the query by white space. This means that the path name cannot
7520 contain white space. Here is a lookup expansion example:
7521 .code
7522 ${lookup sqlite {/some/thing/sqlitedb \
7523   select name from aliases where id='userx';}}
7524 .endd
7525 In a list, the syntax is similar. For example:
7526 .code
7527 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7528    select * from relays where ip='$sender_host_address';
7529 .endd
7530 The only character affected by the &%quote_sqlite%& operator is a single
7531 quote, which it doubles.
7532
7533 The SQLite library handles multiple simultaneous accesses to the database
7534 internally. Multiple readers are permitted, but only one process can
7535 update at once. Attempts to access the database while it is being updated
7536 are rejected after a timeout period, during which the SQLite library
7537 waits for the lock to be released. In Exim, the default timeout is set
7538 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7539 option.
7540 .ecindex IIDfidalo1
7541 .ecindex IIDfidalo2
7542
7543
7544 . ////////////////////////////////////////////////////////////////////////////
7545 . ////////////////////////////////////////////////////////////////////////////
7546
7547 .chapter "Domain, host, address, and local part lists" &&&
7548          "CHAPdomhosaddlists" &&&
7549          "Domain, host, and address lists"
7550 .scindex IIDdohoadli "lists of domains; hosts; etc."
7551 A number of Exim configuration options contain lists of domains, hosts,
7552 email addresses, or local parts. For example, the &%hold_domains%& option
7553 contains a list of domains whose delivery is currently suspended. These lists
7554 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7555 arguments to expansion conditions such as &%match_domain%&.
7556
7557 Each item in one of these lists is a pattern to be matched against a domain,
7558 host, email address, or local part, respectively. In the sections below, the
7559 different types of pattern for each case are described, but first we cover some
7560 general facilities that apply to all four kinds of list.
7561
7562
7563
7564 .section "Expansion of lists" "SECID75"
7565 .cindex "expansion" "of lists"
7566 Each list is expanded as a single string before it is used. The result of
7567 expansion must be a list, possibly containing empty items, which is split up
7568 into separate items for matching. By default, colon is the separator character,
7569 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7570 &<<SECTempitelis>>& for details of the list syntax; the second of these
7571 discusses the way to specify empty list items.
7572
7573
7574 If the string expansion is forced to fail, Exim behaves as if the item it is
7575 testing (domain, host, address, or local part) is not in the list. Other
7576 expansion failures cause temporary errors.
7577
7578 If an item in a list is a regular expression, backslashes, dollars and possibly
7579 other special characters in the expression must be protected against
7580 misinterpretation by the string expander. The easiest way to do this is to use
7581 the &`\N`& expansion feature to indicate that the contents of the regular
7582 expression should not be expanded. For example, in an ACL you might have:
7583 .code
7584 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7585                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7586 .endd
7587 The first item is a regular expression that is protected from expansion by
7588 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7589 senders based on the receiving domain.
7590
7591
7592
7593
7594 .section "Negated items in lists" "SECID76"
7595 .cindex "list" "negation"
7596 .cindex "negation" "in lists"
7597 Items in a list may be positive or negative. Negative items are indicated by a
7598 leading exclamation mark, which may be followed by optional white space. A list
7599 defines a set of items (domains, etc). When Exim processes one of these lists,
7600 it is trying to find out whether a domain, host, address, or local part
7601 (respectively) is in the set that is defined by the list. It works like this:
7602
7603 The list is scanned from left to right. If a positive item is matched, the
7604 subject that is being checked is in the set; if a negative item is matched, the
7605 subject is not in the set. If the end of the list is reached without the
7606 subject having matched any of the patterns, it is in the set if the last item
7607 was a negative one, but not if it was a positive one. For example, the list in
7608 .code
7609 domainlist relay_to_domains = !a.b.c : *.b.c
7610 .endd
7611 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7612 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7613 list is positive. However, if the setting were
7614 .code
7615 domainlist relay_to_domains = !a.b.c
7616 .endd
7617 then all domains other than &'a.b.c'& would match because the last item in the
7618 list is negative. In other words, a list that ends with a negative item behaves
7619 as if it had an extra item &`:*`& on the end.
7620
7621 Another way of thinking about positive and negative items in lists is to read
7622 the connector as &"or"& after a positive item and as &"and"& after a negative
7623 item.
7624
7625
7626
7627 .section "File names in lists" "SECTfilnamlis"
7628 .cindex "list" "file name in"
7629 If an item in a domain, host, address, or local part list is an absolute file
7630 name (beginning with a slash character), each line of the file is read and
7631 processed as if it were an independent item in the list, except that further
7632 file names are not allowed,
7633 and no expansion of the data from the file takes place.
7634 Empty lines in the file are ignored, and the file may also contain comment
7635 lines:
7636
7637 .ilist
7638 For domain and host lists, if a # character appears anywhere in a line of the
7639 file, it and all following characters are ignored.
7640 .next
7641 Because local parts may legitimately contain # characters, a comment in an
7642 address list or local part list file is recognized only if # is preceded by
7643 white space or the start of the line. For example:
7644 .code
7645 not#comment@x.y.z   # but this is a comment
7646 .endd
7647 .endlist
7648
7649 Putting a file name in a list has the same effect as inserting each line of the
7650 file as an item in the list (blank lines and comments excepted). However, there
7651 is one important difference: the file is read each time the list is processed,
7652 so if its contents vary over time, Exim's behaviour changes.
7653
7654 If a file name is preceded by an exclamation mark, the sense of any match
7655 within the file is inverted. For example, if
7656 .code
7657 hold_domains = !/etc/nohold-domains
7658 .endd
7659 and the file contains the lines
7660 .code
7661 !a.b.c
7662 *.b.c
7663 .endd
7664 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7665 any domain matching &`*.b.c`& is not.
7666
7667
7668
7669 .section "An lsearch file is not an out-of-line list" "SECID77"
7670 As will be described in the sections that follow, lookups can be used in lists
7671 to provide indexed methods of checking list membership. There has been some
7672 confusion about the way &(lsearch)& lookups work in lists. Because
7673 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7674 sometimes thought that it is allowed to contain wild cards and other kinds of
7675 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7676 always fixed strings, just as for any other single-key lookup type.
7677
7678 If you want to use a file to contain wild-card patterns that form part of a
7679 list, just give the file name on its own, without a search type, as described
7680 in the previous section. You could also use the &(wildlsearch)& or
7681 &(nwildlsearch)&, but there is no advantage in doing this.
7682
7683
7684
7685
7686 .section "Named lists" "SECTnamedlists"
7687 .cindex "named lists"
7688 .cindex "list" "named"
7689 A list of domains, hosts, email addresses, or local parts can be given a name
7690 which is then used to refer to the list elsewhere in the configuration. This is
7691 particularly convenient if the same list is required in several different
7692 places. It also allows lists to be given meaningful names, which can improve
7693 the readability of the configuration. For example, it is conventional to define
7694 a domain list called &'local_domains'& for all the domains that are handled
7695 locally on a host, using a configuration line such as
7696 .code
7697 domainlist local_domains = localhost:my.dom.example
7698 .endd
7699 Named lists are referenced by giving their name preceded by a plus sign, so,
7700 for example, a router that is intended to handle local domains would be
7701 configured with the line
7702 .code
7703 domains = +local_domains
7704 .endd
7705 The first router in a configuration is often one that handles all domains
7706 except the local ones, using a configuration with a negated item like this:
7707 .code
7708 dnslookup:
7709   driver = dnslookup
7710   domains = ! +local_domains
7711   transport = remote_smtp
7712   no_more
7713 .endd
7714 The four kinds of named list are created by configuration lines starting with
7715 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7716 respectively. Then there follows the name that you are defining, followed by an
7717 equals sign and the list itself. For example:
7718 .code
7719 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7720 addresslist bad_senders = cdb;/etc/badsenders
7721 .endd
7722 A named list may refer to other named lists:
7723 .code
7724 domainlist  dom1 = first.example : second.example
7725 domainlist  dom2 = +dom1 : third.example
7726 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7727 .endd
7728 &*Warning*&: If the last item in a referenced list is a negative one, the
7729 effect may not be what you intended, because the negation does not propagate
7730 out to the higher level. For example, consider:
7731 .code
7732 domainlist  dom1 = !a.b
7733 domainlist  dom2 = +dom1 : *.b
7734 .endd
7735 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7736 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7737 means it matches the second list as well. The effect is not the same as
7738 .code
7739 domainlist  dom2 = !a.b : *.b
7740 .endd
7741 where &'x.y'& does not match. It's best to avoid negation altogether in
7742 referenced lists if you can.
7743
7744 Named lists may have a performance advantage. When Exim is routing an
7745 address or checking an incoming message, it caches the result of tests on named
7746 lists. So, if you have a setting such as
7747 .code
7748 domains = +local_domains
7749 .endd
7750 on several of your routers
7751 or in several ACL statements,
7752 the actual test is done only for the first one. However, the caching works only
7753 if there are no expansions within the list itself or any sublists that it
7754 references. In other words, caching happens only for lists that are known to be
7755 the same each time they are referenced.
7756
7757 By default, there may be up to 16 named lists of each type. This limit can be
7758 extended by changing a compile-time variable. The use of domain and host lists
7759 is recommended for concepts such as local domains, relay domains, and relay
7760 hosts. The default configuration is set up like this.
7761
7762
7763
7764 .section "Named lists compared with macros" "SECID78"
7765 .cindex "list" "named compared with macro"
7766 .cindex "macro" "compared with named list"
7767 At first sight, named lists might seem to be no different from macros in the
7768 configuration file. However, macros are just textual substitutions. If you
7769 write
7770 .code
7771 ALIST = host1 : host2
7772 auth_advertise_hosts = !ALIST
7773 .endd
7774 it probably won't do what you want, because that is exactly the same as
7775 .code
7776 auth_advertise_hosts = !host1 : host2
7777 .endd
7778 Notice that the second host name is not negated. However, if you use a host
7779 list, and write
7780 .code
7781 hostlist alist = host1 : host2
7782 auth_advertise_hosts = ! +alist
7783 .endd
7784 the negation applies to the whole list, and so that is equivalent to
7785 .code
7786 auth_advertise_hosts = !host1 : !host2
7787 .endd
7788
7789
7790 .section "Named list caching" "SECID79"
7791 .cindex "list" "caching of named"
7792 .cindex "caching" "named lists"
7793 While processing a message, Exim caches the result of checking a named list if
7794 it is sure that the list is the same each time. In practice, this means that
7795 the cache operates only if the list contains no $ characters, which guarantees
7796 that it will not change when it is expanded. Sometimes, however, you may have
7797 an expanded list that you know will be the same each time within a given
7798 message. For example:
7799 .code
7800 domainlist special_domains = \
7801            ${lookup{$sender_host_address}cdb{/some/file}}
7802 .endd
7803 This provides a list of domains that depends only on the sending host's IP
7804 address. If this domain list is referenced a number of times (for example,
7805 in several ACL lines, or in several routers) the result of the check is not
7806 cached by default, because Exim does not know that it is going to be the
7807 same list each time.
7808
7809 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7810 cache the result anyway. For example:
7811 .code
7812 domainlist_cache special_domains = ${lookup{...
7813 .endd
7814 If you do this, you should be absolutely sure that caching is going to do
7815 the right thing in all cases. When in doubt, leave it out.
7816
7817
7818
7819 .section "Domain lists" "SECTdomainlist"
7820 .cindex "domain list" "patterns for"
7821 .cindex "list" "domain list"
7822 Domain lists contain patterns that are to be matched against a mail domain.
7823 The following types of item may appear in domain lists:
7824
7825 .ilist
7826 .cindex "primary host name"
7827 .cindex "host name" "matched in domain list"
7828 .oindex "&%primary_hostname%&"
7829 .cindex "domain list" "matching primary host name"
7830 .cindex "@ in a domain list"
7831 If a pattern consists of a single @ character, it matches the local host name,
7832 as set by the &%primary_hostname%& option (or defaulted). This makes it
7833 possible to use the same configuration file on several different hosts that
7834 differ only in their names.
7835 .next
7836 .cindex "@[] in a domain list"
7837 .cindex "domain list" "matching local IP interfaces"
7838 .cindex "domain literal"
7839 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7840 in square brackets (as in an email address that contains a domain literal), but
7841 only if that IP address is recognized as local for email routing purposes. The
7842 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7843 control which of a host's several IP addresses are treated as local.
7844 In today's Internet, the use of domain literals is controversial.
7845 .next
7846 .cindex "@mx_any"
7847 .cindex "@mx_primary"
7848 .cindex "@mx_secondary"
7849 .cindex "domain list" "matching MX pointers to local host"
7850 If a pattern consists of the string &`@mx_any`& it matches any domain that
7851 has an MX record pointing to the local host or to any host that is listed in
7852 .oindex "&%hosts_treat_as_local%&"
7853 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7854 are similar, except that the first matches only when a primary MX target is the
7855 local host, and the second only when no primary MX target is the local host,
7856 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7857 preference value &-- there may of course be more than one of them.
7858
7859 The MX lookup that takes place when matching a pattern of this type is
7860 performed with the resolver options for widening names turned off. Thus, for
7861 example, a single-component domain will &'not'& be expanded by adding the
7862 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7863 options of the &(dnslookup)& router for a discussion of domain widening.
7864
7865 Sometimes you may want to ignore certain IP addresses when using one of these
7866 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7867 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7868 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7869 on a router). For example:
7870 .code
7871 domains = @mx_any/ignore=127.0.0.1
7872 .endd
7873 This example matches any domain that has an MX record pointing to one of
7874 the local host's IP addresses other than 127.0.0.1.
7875
7876 The list of IP addresses is in fact processed by the same code that processes
7877 host lists, so it may contain CIDR-coded network specifications and it may also
7878 contain negative items.
7879
7880 Because the list of IP addresses is a sublist within a domain list, you have to
7881 be careful about delimiters if there is more than one address. Like any other
7882 list, the default delimiter can be changed. Thus, you might have:
7883 .code
7884 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7885           an.other.domain : ...
7886 .endd
7887 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7888 involved, it is easiest to change the delimiter for the main list as well:
7889 .code
7890 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7891           an.other.domain ? ...
7892 .endd
7893 .next
7894 .cindex "asterisk" "in domain list"
7895 .cindex "domain list" "asterisk in"
7896 .cindex "domain list" "matching &""ends with""&"
7897 If a pattern starts with an asterisk, the remaining characters of the pattern
7898 are compared with the terminating characters of the domain. The use of &"*"& in
7899 domain lists differs from its use in partial matching lookups. In a domain
7900 list, the character following the asterisk need not be a dot, whereas partial
7901 matching works only in terms of dot-separated components. For example, a domain
7902 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7903 &'cipher.key.ex'&.
7904
7905 .next
7906 .cindex "regular expressions" "in domain list"
7907 .cindex "domain list" "matching regular expression"
7908 If a pattern starts with a circumflex character, it is treated as a regular
7909 expression, and matched against the domain using a regular expression matching
7910 function. The circumflex is treated as part of the regular expression.
7911 Email domains are case-independent, so this regular expression match is by
7912 default case-independent, but you can make it case-dependent by starting it
7913 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7914 are given in chapter &<<CHAPregexp>>&.
7915
7916 &*Warning*&: Because domain lists are expanded before being processed, you
7917 must escape any backslash and dollar characters in the regular expression, or
7918 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7919 it is not to be expanded (unless you really do want to build a regular
7920 expression by expansion, of course).
7921 .next
7922 .cindex "lookup" "in domain list"
7923 .cindex "domain list" "matching by lookup"
7924 If a pattern starts with the name of a single-key lookup type followed by a
7925 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7926 must be a file name in a suitable format for the lookup type. For example, for
7927 &"cdb;"& it must be an absolute path:
7928 .code
7929 domains = cdb;/etc/mail/local_domains.cdb
7930 .endd
7931 The appropriate type of lookup is done on the file using the domain name as the
7932 key. In most cases, the data that is looked up is not used; Exim is interested
7933 only in whether or not the key is present in the file. However, when a lookup
7934 is used for the &%domains%& option on a router
7935 or a &%domains%& condition in an ACL statement, the data is preserved in the
7936 &$domain_data$& variable and can be referred to in other router options or
7937 other statements in the same ACL.
7938
7939 .next
7940 Any of the single-key lookup type names may be preceded by
7941 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7942 .code
7943 domains = partial-dbm;/partial/domains
7944 .endd
7945 This causes partial matching logic to be invoked; a description of how this
7946 works is given in section &<<SECTpartiallookup>>&.
7947
7948 .next
7949 .cindex "asterisk" "in lookup type"
7950 Any of the single-key lookup types may be followed by an asterisk. This causes
7951 a default lookup for a key consisting of a single asterisk to be done if the
7952 original lookup fails. This is not a useful feature when using a domain list to
7953 select particular domains (because any domain would match), but it might have
7954 value if the result of the lookup is being used via the &$domain_data$&
7955 expansion variable.
7956 .next
7957 If the pattern starts with the name of a query-style lookup type followed by a
7958 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7959 pattern must be an appropriate query for the lookup type, as described in
7960 chapter &<<CHAPfdlookup>>&. For example:
7961 .code
7962 hold_domains = mysql;select domain from holdlist \
7963   where domain = '${quote_mysql:$domain}';
7964 .endd
7965 In most cases, the data that is looked up is not used (so for an SQL query, for
7966 example, it doesn't matter what field you select). Exim is interested only in
7967 whether or not the query succeeds. However, when a lookup is used for the
7968 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7969 variable and can be referred to in other options.
7970 .next
7971 .cindex "domain list" "matching literal domain name"
7972 If none of the above cases apply, a caseless textual comparison is made
7973 between the pattern and the domain.
7974 .endlist
7975
7976 Here is an example that uses several different kinds of pattern:
7977 .code
7978 domainlist funny_domains = \
7979   @ : \
7980   lib.unseen.edu : \
7981   *.foundation.fict.example : \
7982   \N^[1-2]\d{3}\.fict\.example$\N : \
7983   partial-dbm;/opt/data/penguin/book : \
7984   nis;domains.byname : \
7985   nisplus;[name=$domain,status=local],domains.org_dir
7986 .endd
7987 There are obvious processing trade-offs among the various matching modes. Using
7988 an asterisk is faster than a regular expression, and listing a few names
7989 explicitly probably is too. The use of a file or database lookup is expensive,
7990 but may be the only option if hundreds of names are required. Because the
7991 patterns are tested in order, it makes sense to put the most commonly matched
7992 patterns earlier.
7993
7994
7995
7996 .section "Host lists" "SECThostlist"
7997 .cindex "host list" "patterns in"
7998 .cindex "list" "host list"
7999 Host lists are used to control what remote hosts are allowed to do. For
8000 example, some hosts may be allowed to use the local host as a relay, and some
8001 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8002 two different ways, by name or by IP address. In a host list, some types of
8003 pattern are matched to a host name, and some are matched to an IP address.
8004 You need to be particularly careful with this when single-key lookups are
8005 involved, to ensure that the right value is being used as the key.
8006
8007
8008 .section "Special host list patterns" "SECID80"
8009 .cindex "empty item in hosts list"
8010 .cindex "host list" "empty string in"
8011 If a host list item is the empty string, it matches only when no remote host is
8012 involved. This is the case when a message is being received from a local
8013 process using SMTP on the standard input, that is, when a TCP/IP connection is
8014 not used.
8015
8016 .cindex "asterisk" "in host list"
8017 The special pattern &"*"& in a host list matches any host or no host. Neither
8018 the IP address nor the name is actually inspected.
8019
8020
8021
8022 .section "Host list patterns that match by IP address" "SECThoslispatip"
8023 .cindex "host list" "matching IP addresses"
8024 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8025 the incoming address actually appears in the IPv6 host as
8026 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8027 list, it is converted into a traditional IPv4 address first. (Not all operating
8028 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8029 concerns.)
8030
8031 The following types of pattern in a host list check the remote host by
8032 inspecting its IP address:
8033
8034 .ilist
8035 If the pattern is a plain domain name (not a regular expression, not starting
8036 with *, not a lookup of any kind), Exim calls the operating system function
8037 to find the associated IP address(es). Exim uses the newer
8038 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8039 This typically causes a forward DNS lookup of the name. The result is compared
8040 with the IP address of the subject host.
8041
8042 If there is a temporary problem (such as a DNS timeout) with the host name
8043 lookup, a temporary error occurs. For example, if the list is being used in an
8044 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8045 temporary SMTP error code. If no IP address can be found for the host name,
8046 what happens is described in section &<<SECTbehipnot>>& below.
8047
8048 .next
8049 .cindex "@ in a host list"
8050 If the pattern is &"@"&, the primary host name is substituted and used as a
8051 domain name, as just described.
8052
8053 .next
8054 If the pattern is an IP address, it is matched against the IP address of the
8055 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8056 IPv6 addresses can be given in colon-separated format, but the colons have to
8057 be doubled so as not to be taken as item separators when the default list
8058 separator is used. IPv6 addresses are recognized even when Exim is compiled
8059 without IPv6 support. This means that if they appear in a host list on an
8060 IPv4-only host, Exim will not treat them as host names. They are just addresses
8061 that can never match a client host.
8062
8063 .next
8064 .cindex "@[] in a host list"
8065 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8066 the local host. For example, if the local host is an IPv4 host with one
8067 interface address 10.45.23.56, these two ACL statements have the same effect:
8068 .code
8069 accept hosts = 127.0.0.1 : 10.45.23.56
8070 accept hosts = @[]
8071 .endd
8072 .next
8073 .cindex "CIDR notation"
8074 If the pattern is an IP address followed by a slash and a mask length (for
8075 example 10.11.42.0/24), it is matched against the IP address of the subject
8076 host under the given mask. This allows, an entire network of hosts to be
8077 included (or excluded) by a single item. The mask uses CIDR notation; it
8078 specifies the number of address bits that must match, starting from the most
8079 significant end of the address.
8080
8081 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8082 of a range of addresses. It is the number of bits in the network portion of the
8083 address. The above example specifies a 24-bit netmask, so it matches all 256
8084 addresses in the 10.11.42.0 network. An item such as
8085 .code
8086 192.168.23.236/31
8087 .endd
8088 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8089 32 for an IPv4 address is the same as no mask at all; just a single address
8090 matches.
8091
8092 Here is another example which shows an IPv4 and an IPv6 network:
8093 .code
8094 recipient_unqualified_hosts = 192.168.0.0/16: \
8095                               3ffe::ffff::836f::::/48
8096 .endd
8097 The doubling of list separator characters applies only when these items
8098 appear inline in a host list. It is not required when indirecting via a file.
8099 For example:
8100 .code
8101 recipient_unqualified_hosts = /opt/exim/unqualnets
8102 .endd
8103 could make use of a file containing
8104 .code
8105 172.16.0.0/12
8106 3ffe:ffff:836f::/48
8107 .endd
8108 to have exactly the same effect as the previous example. When listing IPv6
8109 addresses inline, it is usually more convenient to use the facility for
8110 changing separator characters. This list contains the same two networks:
8111 .code
8112 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8113                                  3ffe:ffff:836f::/48
8114 .endd
8115 The separator is changed to semicolon by the leading &"<;"& at the start of the
8116 list.
8117 .endlist
8118
8119
8120
8121 .section "Host list patterns for single-key lookups by host address" &&&
8122          "SECThoslispatsikey"
8123 .cindex "host list" "lookup of IP address"
8124 When a host is to be identified by a single-key lookup of its complete IP
8125 address, the pattern takes this form:
8126 .display
8127 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8128 .endd
8129 For example:
8130 .code
8131 hosts_lookup = net-cdb;/hosts-by-ip.db
8132 .endd
8133 The text form of the IP address of the subject host is used as the lookup key.
8134 IPv6 addresses are converted to an unabbreviated form, using lower case
8135 letters, with dots as separators because colon is the key terminator in
8136 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8137 quoting the keys, but this is a facility that was added later.] The data
8138 returned by the lookup is not used.
8139
8140 .cindex "IP address" "masking"
8141 .cindex "host list" "masked IP address"
8142 Single-key lookups can also be performed using masked IP addresses, using
8143 patterns of this form:
8144 .display
8145 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8146 .endd
8147 For example:
8148 .code
8149 net24-dbm;/networks.db
8150 .endd
8151 The IP address of the subject host is masked using <&'number'&> as the mask
8152 length. A textual string is constructed from the masked value, followed by the
8153 mask, and this is used as the lookup key. For example, if the host's IP address
8154 is 192.168.34.6, the key that is looked up for the above example is
8155 &"192.168.34.0/24"&.
8156
8157 When an IPv6 address is converted to a string, dots are normally used instead
8158 of colons, so that keys in &(lsearch)& files need not contain colons (which
8159 terminate &(lsearch)& keys). This was implemented some time before the ability
8160 to quote keys was made available in &(lsearch)& files. However, the more
8161 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8162 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8163 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8164 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8165 addresses are always used.
8166
8167 Ideally, it would be nice to tidy up this anomalous situation by changing to
8168 colons in all cases, given that quoting is now available for &(lsearch)&.
8169 However, this would be an incompatible change that might break some existing
8170 configurations.
8171
8172 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8173 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8174 the former case the key strings include the mask value, whereas in the latter
8175 case the IP address is used on its own.
8176
8177
8178
8179 .section "Host list patterns that match by host name" "SECThoslispatnam"
8180 .cindex "host" "lookup failures"
8181 .cindex "unknown host name"
8182 .cindex "host list" "matching host name"
8183 There are several types of pattern that require Exim to know the name of the
8184 remote host. These are either wildcard patterns or lookups by name. (If a
8185 complete hostname is given without any wildcarding, it is used to find an IP
8186 address to match against, as described in section &<<SECThoslispatip>>&
8187 above.)
8188
8189 If the remote host name is not already known when Exim encounters one of these
8190 patterns, it has to be found from the IP address.
8191 Although many sites on the Internet are conscientious about maintaining reverse
8192 DNS data for their hosts, there are also many that do not do this.
8193 Consequently, a name cannot always be found, and this may lead to unwanted
8194 effects. Take care when configuring host lists with wildcarded name patterns.
8195 Consider what will happen if a name cannot be found.
8196
8197 Because of the problems of determining host names from IP addresses, matching
8198 against host names is not as common as matching against IP addresses.
8199
8200 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8201 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8202 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8203 are done can be changed by setting the &%host_lookup_order%& option. For
8204 security, once Exim has found one or more names, it looks up the IP addresses
8205 for these names and compares them with the IP address that it started with.
8206 Only those names whose IP addresses match are accepted. Any other names are
8207 discarded. If no names are left, Exim behaves as if the host name cannot be
8208 found. In the most common case there is only one name and one IP address.
8209
8210 There are some options that control what happens if a host name cannot be
8211 found. These are described in section &<<SECTbehipnot>>& below.
8212
8213 .cindex "host" "alias for"
8214 .cindex "alias for host"
8215 As a result of aliasing, hosts may have more than one name. When processing any
8216 of the following types of pattern, all the host's names are checked:
8217
8218 .ilist
8219 .cindex "asterisk" "in host list"
8220 If a pattern starts with &"*"& the remainder of the item must match the end of
8221 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8222 &'.b.c'&. This special simple form is provided because this is a very common
8223 requirement. Other kinds of wildcarding require the use of a regular
8224 expression.
8225 .next
8226 .cindex "regular expressions" "in host list"
8227 .cindex "host list" "regular expression in"
8228 If the item starts with &"^"& it is taken to be a regular expression which is
8229 matched against the host name. Host names are case-independent, so this regular
8230 expression match is by default case-independent, but you can make it
8231 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8232 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8233 example,
8234 .code
8235 ^(a|b)\.c\.d$
8236 .endd
8237 is a regular expression that matches either of the two hosts &'a.c.d'& or
8238 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8239 that backslash and dollar characters are not misinterpreted as part of the
8240 string expansion. The simplest way to do this is to use &`\N`& to mark that
8241 part of the string as non-expandable. For example:
8242 .code
8243 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8244 .endd
8245 &*Warning*&: If you want to match a complete host name, you must include the
8246 &`$`& terminating metacharacter in the regular expression, as in the above
8247 example. Without it, a match at the start of the host name is all that is
8248 required.
8249 .endlist
8250
8251
8252
8253
8254 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8255 .cindex "host" "lookup failures, permanent"
8256 While processing a host list, Exim may need to look up an IP address from a
8257 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8258 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8259 behaviour when it fails to find the information it is seeking is the same.
8260
8261 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8262 apply to temporary DNS errors, whose handling is described in the next section.
8263
8264 .cindex "&`+include_unknown`&"
8265 .cindex "&`+ignore_unknown`&"
8266 By default, Exim behaves as if the host does not match the list. This may not
8267 always be what you want to happen. To change Exim's behaviour, the special
8268 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8269 top level &-- they are not recognized in an indirected file).
8270
8271 .ilist
8272 If any item that follows &`+include_unknown`& requires information that
8273 cannot found, Exim behaves as if the host does match the list. For example,
8274 .code
8275 host_reject_connection = +include_unknown:*.enemy.ex
8276 .endd
8277 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8278 any hosts whose name it cannot find.
8279
8280 .next
8281 If any item that follows &`+ignore_unknown`& requires information that cannot
8282 be found, Exim ignores that item and proceeds to the rest of the list. For
8283 example:
8284 .code
8285 accept hosts = +ignore_unknown : friend.example : \
8286                192.168.4.5
8287 .endd
8288 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8289 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8290 name can be found for 192.168.4.5, it is rejected.
8291 .endlist
8292
8293 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8294 list. The effect of each one lasts until the next, or until the end of the
8295 list.
8296
8297
8298 .section "Temporary DNS errors when looking up host information" &&&
8299          "SECTtemdnserr"
8300 .cindex "host" "lookup failures, temporary"
8301 .cindex "&`+include_defer`&"
8302 .cindex "&`+ignore_defer`&"
8303 A temporary DNS lookup failure normally causes a defer action (except when
8304 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8305 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8306 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8307 section. These options should be used with care, probably only in non-critical
8308 host lists such as whitelists.
8309
8310
8311
8312 .section "Host list patterns for single-key lookups by host name" &&&
8313          "SECThoslispatnamsk"
8314 .cindex "unknown host name"
8315 .cindex "host list" "matching host name"
8316 If a pattern is of the form
8317 .display
8318 <&'single-key-search-type'&>;<&'search-data'&>
8319 .endd
8320 for example
8321 .code
8322 dbm;/host/accept/list
8323 .endd
8324 a single-key lookup is performed, using the host name as its key. If the
8325 lookup succeeds, the host matches the item. The actual data that is looked up
8326 is not used.
8327
8328 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8329 keys in the file, not IP addresses. If you want to do lookups based on IP
8330 addresses, you must precede the search type with &"net-"& (see section
8331 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8332 two items in the same list, one doing an address lookup and one doing a name
8333 lookup, both using the same file.
8334
8335
8336
8337 .section "Host list patterns for query-style lookups" "SECID81"
8338 If a pattern is of the form
8339 .display
8340 <&'query-style-search-type'&>;<&'query'&>
8341 .endd
8342 the query is obeyed, and if it succeeds, the host matches the item. The actual
8343 data that is looked up is not used. The variables &$sender_host_address$& and
8344 &$sender_host_name$& can be used in the query. For example:
8345 .code
8346 hosts_lookup = pgsql;\
8347   select ip from hostlist where ip='$sender_host_address'
8348 .endd
8349 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8350 can use the &%sg%& expansion item to change this if you need to. If you want to
8351 use masked IP addresses in database queries, you can use the &%mask%& expansion
8352 operator.
8353
8354 If the query contains a reference to &$sender_host_name$&, Exim automatically
8355 looks up the host name if it has not already done so. (See section
8356 &<<SECThoslispatnam>>& for comments on finding host names.)
8357
8358 Historical note: prior to release 4.30, Exim would always attempt to find a
8359 host name before running the query, unless the search type was preceded by
8360 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8361 still recognized for query-style lookups, but its presence or absence has no
8362 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8363 See section &<<SECThoslispatsikey>>&.)
8364
8365
8366
8367 .section "Mixing wildcarded host names and addresses in host lists" &&&
8368          "SECTmixwilhos"
8369 .cindex "host list" "mixing names and addresses in"
8370 If you have name lookups or wildcarded host names and IP addresses in the same
8371 host list, you should normally put the IP addresses first. For example, in an
8372 ACL you could have:
8373 .code
8374 accept hosts = 10.9.8.7 : *.friend.example
8375 .endd
8376 The reason for this lies in the left-to-right way that Exim processes lists.
8377 It can test IP addresses without doing any DNS lookups, but when it reaches an
8378 item that requires a host name, it fails if it cannot find a host name to
8379 compare with the pattern. If the above list is given in the opposite order, the
8380 &%accept%& statement fails for a host whose name cannot be found, even if its
8381 IP address is 10.9.8.7.
8382
8383 If you really do want to do the name check first, and still recognize the IP
8384 address, you can rewrite the ACL like this:
8385 .code
8386 accept hosts = *.friend.example
8387 accept hosts = 10.9.8.7
8388 .endd
8389 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8390 &<<CHAPACL>>& for details of ACLs.
8391
8392
8393
8394
8395
8396 .section "Address lists" "SECTaddresslist"
8397 .cindex "list" "address list"
8398 .cindex "address list" "empty item"
8399 .cindex "address list" "patterns"
8400 Address lists contain patterns that are matched against mail addresses. There
8401 is one special case to be considered: the sender address of a bounce message is
8402 always empty. You can test for this by providing an empty item in an address
8403 list. For example, you can set up a router to process bounce messages by
8404 using this option setting:
8405 .code
8406 senders = :
8407 .endd
8408 The presence of the colon creates an empty item. If you do not provide any
8409 data, the list is empty and matches nothing. The empty sender can also be
8410 detected by a regular expression that matches an empty string,
8411 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8412
8413 Non-empty items in an address list can be straightforward email addresses. For
8414 example:
8415 .code
8416 senders = jbc@askone.example : hs@anacreon.example
8417 .endd
8418 A certain amount of wildcarding is permitted. If a pattern contains an @
8419 character, but is not a regular expression and does not begin with a
8420 semicolon-terminated lookup type (described below), the local part of the
8421 subject address is compared with the local part of the pattern, which may start
8422 with an asterisk. If the local parts match, the domain is checked in exactly
8423 the same way as for a pattern in a domain list. For example, the domain can be
8424 wildcarded, refer to a named list, or be a lookup:
8425 .code
8426 deny senders = *@*.spamming.site:\
8427                *@+hostile_domains:\
8428                bozo@partial-lsearch;/list/of/dodgy/sites:\
8429                *@dbm;/bad/domains.db
8430 .endd
8431 .cindex "local part" "starting with !"
8432 .cindex "address list" "local part starting with !"
8433 If a local part that begins with an exclamation mark is required, it has to be
8434 specified using a regular expression, because otherwise the exclamation mark is
8435 treated as a sign of negation, as is standard in lists.
8436
8437 If a non-empty pattern that is not a regular expression or a lookup does not
8438 contain an @ character, it is matched against the domain part of the subject
8439 address. The only two formats that are recognized this way are a literal
8440 domain, or a domain pattern that starts with *. In both these cases, the effect
8441 is the same as if &`*@`& preceded the pattern. For example:
8442 .code
8443 deny senders = enemy.domain : *.enemy.domain
8444 .endd
8445
8446 The following kinds of more complicated address list pattern can match any
8447 address, including the empty address that is characteristic of bounce message
8448 senders:
8449
8450 .ilist
8451 .cindex "regular expressions" "in address list"
8452 .cindex "address list" "regular expression in"
8453 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8454 done against the complete address, with the pattern as the regular expression.
8455 You must take care that backslash and dollar characters are not misinterpreted
8456 as part of the string expansion. The simplest way to do this is to use &`\N`&
8457 to mark that part of the string as non-expandable. For example:
8458 .code
8459 deny senders = \N^.*this.*@example\.com$\N : \
8460                \N^\d{8}.+@spamhaus.example$\N : ...
8461 .endd
8462 The &`\N`& sequences are removed by the expansion, so these items do indeed
8463 start with &"^"& by the time they are being interpreted as address patterns.
8464
8465 .next
8466 .cindex "address list" "lookup for complete address"
8467 Complete addresses can be looked up by using a pattern that starts with a
8468 lookup type terminated by a semicolon, followed by the data for the lookup. For
8469 example:
8470 .code
8471 deny senders = cdb;/etc/blocked.senders : \
8472   mysql;select address from blocked where \
8473   address='${quote_mysql:$sender_address}'
8474 .endd
8475 Both query-style and single-key lookup types can be used. For a single-key
8476 lookup type, Exim uses the complete address as the key. However, empty keys are
8477 not supported for single-key lookups, so a match against the empty address
8478 always fails. This restriction does not apply to query-style lookups.
8479
8480 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8481 cannot be used, and is ignored if specified, with an entry being written to the
8482 panic log.
8483 .cindex "*@ with single-key lookup"
8484 However, you can configure lookup defaults, as described in section
8485 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8486 default. For example, with this lookup:
8487 .code
8488 accept senders = lsearch*@;/some/file
8489 .endd
8490 the file could contains lines like this:
8491 .code
8492 user1@domain1.example
8493 *@domain2.example
8494 .endd
8495 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8496 that are tried is:
8497 .code
8498 nimrod@jaeger.example
8499 *@jaeger.example
8500 *
8501 .endd
8502 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8503 would mean that every address matches, thus rendering the test useless.
8504
8505 &*Warning 2*&: Do not confuse these two kinds of item:
8506 .code
8507 deny recipients = dbm*@;/some/file
8508 deny recipients = *@dbm;/some/file
8509 .endd
8510 The first does a whole address lookup, with defaulting, as just described,
8511 because it starts with a lookup type. The second matches the local part and
8512 domain independently, as described in a bullet point below.
8513 .endlist
8514
8515
8516 The following kinds of address list pattern can match only non-empty addresses.
8517 If the subject address is empty, a match against any of these pattern types
8518 always fails.
8519
8520
8521 .ilist
8522 .cindex "@@ with single-key lookup"
8523 .cindex "address list" "@@ lookup type"
8524 .cindex "address list" "split local part and domain"
8525 If a pattern starts with &"@@"& followed by a single-key lookup item
8526 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8527 split into a local part and a domain. The domain is looked up in the file. If
8528 it is not found, there is no match. If it is found, the data that is looked up
8529 from the file is treated as a colon-separated list of local part patterns, each
8530 of which is matched against the subject local part in turn.
8531
8532 .cindex "asterisk" "in address list"
8533 The lookup may be a partial one, and/or one involving a search for a default
8534 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8535 patterns that are looked up can be regular expressions or begin with &"*"&, or
8536 even be further lookups. They may also be independently negated. For example,
8537 with
8538 .code
8539 deny senders = @@dbm;/etc/reject-by-domain
8540 .endd
8541 the data from which the DBM file is built could contain lines like
8542 .code
8543 baddomain.com:  !postmaster : *
8544 .endd
8545 to reject all senders except &%postmaster%& from that domain.
8546
8547 .cindex "local part" "starting with !"
8548 If a local part that actually begins with an exclamation mark is required, it
8549 has to be specified using a regular expression. In &(lsearch)& files, an entry
8550 may be split over several lines by indenting the second and subsequent lines,
8551 but the separating colon must still be included at line breaks. White space
8552 surrounding the colons is ignored. For example:
8553 .code
8554 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8555   spammer3 : spammer4
8556 .endd
8557 As in all colon-separated lists in Exim, a colon can be included in an item by
8558 doubling.
8559
8560 If the last item in the list starts with a right angle-bracket, the remainder
8561 of the item is taken as a new key to look up in order to obtain a continuation
8562 list of local parts. The new key can be any sequence of characters. Thus one
8563 might have entries like
8564 .code
8565 aol.com: spammer1 : spammer 2 : >*
8566 xyz.com: spammer3 : >*
8567 *:       ^\d{8}$
8568 .endd
8569 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8570 local parts for all domains, in addition to the specific local parts listed for
8571 each domain. Of course, using this feature costs another lookup each time a
8572 chain is followed, but the effort needed to maintain the data is reduced.
8573
8574 .cindex "loop" "in lookups"
8575 It is possible to construct loops using this facility, and in order to catch
8576 them, the chains may be no more than fifty items long.
8577
8578 .next
8579 The @@<&'lookup'&> style of item can also be used with a query-style
8580 lookup, but in this case, the chaining facility is not available. The lookup
8581 can only return a single list of local parts.
8582 .endlist
8583
8584 &*Warning*&: There is an important difference between the address list items
8585 in these two examples:
8586 .code
8587 senders = +my_list
8588 senders = *@+my_list
8589 .endd
8590 In the first one, &`my_list`& is a named address list, whereas in the second
8591 example it is a named domain list.
8592
8593
8594
8595
8596 .section "Case of letters in address lists" "SECTcasletadd"
8597 .cindex "case of local parts"
8598 .cindex "address list" "case forcing"
8599 .cindex "case forcing in address lists"
8600 Domains in email addresses are always handled caselessly, but for local parts
8601 case may be significant on some systems (see &%caseful_local_part%& for how
8602 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8603 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8604 blocking lists should be done in a case-independent manner. Since most address
8605 lists in Exim are used for this kind of control, Exim attempts to do this by
8606 default.
8607
8608 The domain portion of an address is always lowercased before matching it to an
8609 address list. The local part is lowercased by default, and any string
8610 comparisons that take place are done caselessly. This means that the data in
8611 the address list itself, in files included as plain file names, and in any file
8612 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8613 keys in files that are looked up by a search type other than &(lsearch)& (which
8614 works caselessly) must be in lower case, because these lookups are not
8615 case-independent.
8616
8617 .cindex "&`+caseful`&"
8618 To allow for the possibility of caseful address list matching, if an item in
8619 an address list is the string &"+caseful"&, the original case of the local
8620 part is restored for any comparisons that follow, and string comparisons are no
8621 longer case-independent. This does not affect the domain, which remains in
8622 lower case. However, although independent matches on the domain alone are still
8623 performed caselessly, regular expressions that match against an entire address
8624 become case-sensitive after &"+caseful"& has been seen.
8625
8626
8627
8628 .section "Local part lists" "SECTlocparlis"
8629 .cindex "list" "local part list"
8630 .cindex "local part" "list"
8631 Case-sensitivity in local part lists is handled in the same way as for address
8632 lists, as just described. The &"+caseful"& item can be used if required. In a
8633 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8634 set false, the subject is lowercased and the matching is initially
8635 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8636 matching in the local part list, but not elsewhere in the router. If
8637 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8638 option is case-sensitive from the start.
8639
8640 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8641 comments are handled in the same way as address lists &-- they are recognized
8642 only if the # is preceded by white space or the start of the line.
8643 Otherwise, local part lists are matched in the same way as domain lists, except
8644 that the special items that refer to the local host (&`@`&, &`@[]`&,
8645 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8646 Refer to section &<<SECTdomainlist>>& for details of the other available item
8647 types.
8648 .ecindex IIDdohoadli
8649
8650
8651
8652
8653 . ////////////////////////////////////////////////////////////////////////////
8654 . ////////////////////////////////////////////////////////////////////////////
8655
8656 .chapter "String expansions" "CHAPexpand"
8657 .scindex IIDstrexp "expansion" "of strings"
8658 Many strings in Exim's run time configuration are expanded before use. Some of
8659 them are expanded every time they are used; others are expanded only once.
8660
8661 When a string is being expanded it is copied verbatim from left to right except
8662 when a dollar or backslash character is encountered. A dollar specifies the
8663 start of a portion of the string that is interpreted and replaced as described
8664 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8665 escape character, as described in the following section.
8666
8667 Whether a string is expanded depends upon the context.  Usually this is solely
8668 dependent upon the option for which a value is sought; in this documentation,
8669 options for which string expansion is performed are marked with &dagger; after
8670 the data type.  ACL rules always expand strings.  A couple of expansion
8671 conditions do not expand some of the brace-delimited branches, for security
8672 reasons.
8673
8674
8675
8676 .section "Literal text in expanded strings" "SECTlittext"
8677 .cindex "expansion" "including literal text"
8678 An uninterpreted dollar can be included in an expanded string by putting a
8679 backslash in front of it. A backslash can be used to prevent any special
8680 character being treated specially in an expansion, including backslash itself.
8681 If the string appears in quotes in the configuration file, two backslashes are
8682 required because the quotes themselves cause interpretation of backslashes when
8683 the string is read in (see section &<<SECTstrings>>&).
8684
8685 .cindex "expansion" "non-expandable substrings"
8686 A portion of the string can specified as non-expandable by placing it between
8687 two occurrences of &`\N`&. This is particularly useful for protecting regular
8688 expressions, which often contain backslashes and dollar signs. For example:
8689 .code
8690 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8691 .endd
8692 On encountering the first &`\N`&, the expander copies subsequent characters
8693 without interpretation until it reaches the next &`\N`& or the end of the
8694 string.
8695
8696
8697
8698 .section "Character escape sequences in expanded strings" "SECID82"
8699 .cindex "expansion" "escape sequences"
8700 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8701 expanded string is recognized as an escape sequence for the character newline,
8702 carriage return, or tab, respectively. A backslash followed by up to three
8703 octal digits is recognized as an octal encoding for a single character, and a
8704 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8705 encoding.
8706
8707 These escape sequences are also recognized in quoted strings when they are read
8708 in. Their interpretation in expansions as well is useful for unquoted strings,
8709 and for other cases such as looked-up strings that are then expanded.
8710
8711
8712 .section "Testing string expansions" "SECID83"
8713 .cindex "expansion" "testing"
8714 .cindex "testing" "string expansion"
8715 .oindex "&%-be%&"
8716 Many expansions can be tested by calling Exim with the &%-be%& option. This
8717 takes the command arguments, or lines from the standard input if there are no
8718 arguments, runs them through the string expansion code, and writes the results
8719 to the standard output. Variables based on configuration values are set up, but
8720 since no message is being processed, variables such as &$local_part$& have no
8721 value. Nevertheless the &%-be%& option can be useful for checking out file and
8722 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8723 and &%nhash%&.
8724
8725 Exim gives up its root privilege when it is called with the &%-be%& option, and
8726 instead runs under the uid and gid it was called with, to prevent users from
8727 using &%-be%& for reading files to which they do not have access.
8728
8729 .oindex "&%-bem%&"
8730 If you want to test expansions that include variables whose values are taken
8731 from a message, there are two other options that can be used. The &%-bem%&
8732 option is like &%-be%& except that it is followed by a file name. The file is
8733 read as a message before doing the test expansions. For example:
8734 .code
8735 exim -bem /tmp/test.message '$h_subject:'
8736 .endd
8737 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8738 Exim message identifier. For example:
8739 .code
8740 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8741 .endd
8742 This loads the message from Exim's spool before doing the test expansions, and
8743 is therefore restricted to admin users.
8744
8745
8746 .section "Forced expansion failure" "SECTforexpfai"
8747 .cindex "expansion" "forced failure"
8748 A number of expansions that are described in the following section have
8749 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8750 (which are sometimes called &"curly brackets"&). Which of the two strings is
8751 used depends on some condition that is evaluated as part of the expansion. If,
8752 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8753 the entire string expansion fails in a way that can be detected by the code
8754 that requested the expansion. This is called &"forced expansion failure"&, and
8755 its consequences depend on the circumstances. In some cases it is no different
8756 from any other expansion failure, but in others a different action may be
8757 taken. Such variations are mentioned in the documentation of the option that is
8758 being expanded.
8759
8760
8761
8762
8763 .section "Expansion items" "SECTexpansionitems"
8764 The following items are recognized in expanded strings. White space may be used
8765 between sub-items that are keywords or substrings enclosed in braces inside an
8766 outer set of braces, to improve readability. &*Warning*&: Within braces,
8767 white space is significant.
8768
8769 .vlist
8770 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8771 .cindex "expansion" "variables"
8772 Substitute the contents of the named variable, for example:
8773 .code
8774 $local_part
8775 ${domain}
8776 .endd
8777 The second form can be used to separate the name from subsequent alphanumeric
8778 characters. This form (using braces) is available only for variables; it does
8779 &'not'& apply to message headers. The names of the variables are given in
8780 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8781 given, the expansion fails.
8782
8783 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8784 .cindex "expansion" "operators"
8785 The string is first itself expanded, and then the operation specified by
8786 <&'op'&> is applied to it. For example:
8787 .code
8788 ${lc:$local_part}
8789 .endd
8790 The string starts with the first character after the colon, which may be
8791 leading white space. A list of operators is given in section &<<SECTexpop>>&
8792 below. The operator notation is used for simple expansion items that have just
8793 one argument, because it reduces the number of braces and therefore makes the
8794 string easier to understand.
8795
8796 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8797 This item inserts &"basic"& header lines. It is described with the &%header%&
8798 expansion item below.
8799
8800
8801 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8802 .cindex "expansion" "calling an acl"
8803 .cindex "&%acl%&" "call from expansion"
8804 The name and zero to nine argument strings are first expanded separately.  The expanded
8805 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8806 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8807 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8808 and may use the variables; if another acl expansion is used the values
8809 are restored after it returns.  If the ACL sets
8810 a value using a "message =" modifier and returns accept or deny, the value becomes
8811 the result of the expansion.
8812 If no message is set and the ACL returns accept or deny
8813 the expansion result is an empty string.
8814 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8815
8816
8817 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8818        {*&<&'arg'&>&*}...}*&"
8819 .cindex &%dlfunc%&
8820 This expansion dynamically loads and then calls a locally-written C function.
8821 This functionality is available only if Exim is compiled with
8822 .code
8823 EXPAND_DLFUNC=yes
8824 .endd
8825 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8826 object so that it doesn't reload the same object file in the same Exim process
8827 (but of course Exim does start new processes frequently).
8828
8829 There may be from zero to eight arguments to the function. When compiling
8830 a local function that is to be called in this way, &_local_scan.h_& should be
8831 included. The Exim variables and functions that are defined by that API
8832 are also available for dynamically loaded functions. The function itself
8833 must have the following type:
8834 .code
8835 int dlfunction(uschar **yield, int argc, uschar *argv[])
8836 .endd
8837 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8838 function should return one of the following values:
8839
8840 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8841 into the expanded string that is being built.
8842
8843 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8844 from &'yield'&, if it is set.
8845
8846 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8847 taken from &'yield'& if it is set.
8848
8849 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8850
8851 When compiling a function that is to be used in this way with gcc,
8852 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8853 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8854
8855 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8856        {*&<&'string3'&>&*}}*&"
8857 .cindex "expansion" "extracting substrings by key"
8858 .cindex "&%extract%&" "substrings by key"
8859 The key and <&'string1'&> are first expanded separately. Leading and trailing
8860 white space is removed from the key (but not from any of the strings). The key
8861 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8862 form:
8863 .display
8864 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8865 .endd
8866 .vindex "&$value$&"
8867 where the equals signs and spaces (but not both) are optional. If any of the
8868 values contain white space, they must be enclosed in double quotes, and any
8869 values that are enclosed in double quotes are subject to escape processing as
8870 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8871 for the value that corresponds to the key. The search is case-insensitive. If
8872 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8873 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8874 variable &$value$& contains the value that has been extracted. Afterwards, it
8875 is restored to any previous value it might have had.
8876
8877 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8878 key is not found. If {<&'string2'&>} is also omitted, the value that was
8879 extracted is used. Thus, for example, these two expansions are identical, and
8880 yield &"2001"&:
8881 .code
8882 ${extract{gid}{uid=1984 gid=2001}}
8883 ${extract{gid}{uid=1984 gid=2001}{$value}}
8884 .endd
8885 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8886 appear, for example:
8887 .code
8888 ${extract{Z}{A=... B=...}{$value} fail }
8889 .endd
8890 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8891 {<&'string2'&>} must be present for &"fail"& to be recognized.
8892
8893
8894 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8895         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8896 .cindex "expansion" "extracting substrings by number"
8897 .cindex "&%extract%&" "substrings by number"
8898 The <&'number'&> argument must consist entirely of decimal digits,
8899 apart from leading and trailing white space, which is ignored.
8900 This is what distinguishes this form of &%extract%& from the previous kind. It
8901 behaves in the same way, except that, instead of extracting a named field, it
8902 extracts from <&'string1'&> the field whose number is given as the first
8903 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8904 <&'string3'&> as before.
8905
8906 The fields in the string are separated by any one of the characters in the
8907 separator string. These may include space or tab characters.
8908 The first field is numbered one. If the number is negative, the fields are
8909 counted from the end of the string, with the rightmost one numbered -1. If the
8910 number given is zero, the entire string is returned. If the modulus of the
8911 number is greater than the number of fields in the string, the result is the
8912 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8913 provided. For example:
8914 .code
8915 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8916 .endd
8917 yields &"42"&, and
8918 .code
8919 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8920 .endd
8921 yields &"99"&. Two successive separators mean that the field between them is
8922 empty (for example, the fifth field above).
8923
8924
8925 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8926 .cindex "list" "selecting by condition"
8927 .cindex "expansion" "selecting from list by condition"
8928 .vindex "&$item$&"
8929 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8930 default, but the separator can be changed in the usual way. For each item
8931 in this list, its value is place in &$item$&, and then the condition is
8932 evaluated. If the condition is true, &$item$& is added to the output as an
8933 item in a new list; if the condition is false, the item is discarded. The
8934 separator used for the output list is the same as the one used for the
8935 input, but a separator setting is not included in the output. For example:
8936 .code
8937 ${filter{a:b:c}{!eq{$item}{b}}
8938 .endd
8939 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8940 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8941
8942
8943 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8944 .cindex "hash function" "textual"
8945 .cindex "expansion" "textual hash"
8946 This is a textual hashing function, and was the first to be implemented in
8947 early versions of Exim. In current releases, there are other hashing functions
8948 (numeric, MD5, and SHA-1), which are described below.
8949
8950 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8951 <&'n'&>. If you are using fixed values for these numbers, that is, if
8952 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8953 use the simpler operator notation that avoids some of the braces:
8954 .code
8955 ${hash_<n>_<m>:<string>}
8956 .endd
8957 The second number is optional (in both notations). If <&'n'&> is greater than
8958 or equal to the length of the string, the expansion item returns the string.
8959 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8960 function to the string. The new string consists of characters taken from the
8961 first <&'m'&> characters of the string
8962 .code
8963 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8964 .endd
8965 If <&'m'&> is not present the value 26 is used, so that only lower case
8966 letters appear. For example:
8967 .display
8968 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8969 &`$hash{5}{monty}}           `&   yields  &`monty`&
8970 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8971 .endd
8972
8973 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8974         &*$h_*&<&'header&~name'&>&*:*&" &&&
8975        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8976         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8977        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8978         &*$rh_*&<&'header&~name'&>&*:*&"
8979 .cindex "expansion" "header insertion"
8980 .vindex "&$header_$&"
8981 .vindex "&$bheader_$&"
8982 .vindex "&$rheader_$&"
8983 .cindex "header lines" "in expansion strings"
8984 .cindex "header lines" "character sets"
8985 .cindex "header lines" "decoding"
8986 Substitute the contents of the named message header line, for example
8987 .code
8988 $header_reply-to:
8989 .endd
8990 The newline that terminates a header line is not included in the expansion, but
8991 internal newlines (caused by splitting the header line over several physical
8992 lines) may be present.
8993
8994 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8995 the data in the header line is interpreted.
8996
8997 .ilist
8998 .cindex "white space" "in header lines"
8999 &%rheader%& gives the original &"raw"& content of the header line, with no
9000 processing at all, and without the removal of leading and trailing white space.
9001
9002 .next
9003 .cindex "base64 encoding" "in header lines"
9004 &%bheader%& removes leading and trailing white space, and then decodes base64
9005 or quoted-printable MIME &"words"& within the header text, but does no
9006 character set translation. If decoding of what looks superficially like a MIME
9007 &"word"& fails, the raw string is returned. If decoding
9008 .cindex "binary zero" "in header line"
9009 produces a binary zero character, it is replaced by a question mark &-- this is
9010 what Exim does for binary zeros that are actually received in header lines.
9011
9012 .next
9013 &%header%& tries to translate the string as decoded by &%bheader%& to a
9014 standard character set. This is an attempt to produce the same string as would
9015 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9016 returned. Translation is attempted only on operating systems that support the
9017 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9018 a system Makefile or in &_Local/Makefile_&.
9019 .endlist ilist
9020
9021 In a filter file, the target character set for &%header%& can be specified by a
9022 command of the following form:
9023 .code
9024 headers charset "UTF-8"
9025 .endd
9026 This command affects all references to &$h_$& (or &$header_$&) expansions in
9027 subsequently obeyed filter commands. In the absence of this command, the target
9028 character set in a filter is taken from the setting of the &%headers_charset%&
9029 option in the runtime configuration. The value of this option defaults to the
9030 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9031 ISO-8859-1.
9032
9033 Header names follow the syntax of RFC 2822, which states that they may contain
9034 any printing characters except space and colon. Consequently, curly brackets
9035 &'do not'& terminate header names, and should not be used to enclose them as
9036 if they were variables. Attempting to do so causes a syntax error.
9037
9038 Only header lines that are common to all copies of a message are visible to
9039 this mechanism. These are the original header lines that are received with the
9040 message, and any that are added by an ACL statement or by a system
9041 filter. Header lines that are added to a particular copy of a message by a
9042 router or transport are not accessible.
9043
9044 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9045 before the DATA ACL, because the header structure is not set up until the
9046 message is received. Header lines that are added in a RCPT ACL (for example)
9047 are saved until the message's incoming header lines are available, at which
9048 point they are added. When a DATA ACL is running, however, header lines added
9049 by earlier ACLs are visible.
9050
9051 Upper case and lower case letters are synonymous in header names. If the
9052 following character is white space, the terminating colon may be omitted, but
9053 this is not recommended, because you may then forget it when it is needed. When
9054 white space terminates the header name, it is included in the expanded string.
9055 If the message does not contain the given header, the expansion item is
9056 replaced by an empty string. (See the &%def%& condition in section
9057 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9058
9059 If there is more than one header with the same name, they are all concatenated
9060 to form the substitution string, up to a maximum length of 64K. Unless
9061 &%rheader%& is being used, leading and trailing white space is removed from
9062 each header before concatenation, and a completely empty header is ignored. A
9063 newline character is then inserted between non-empty headers, but there is no
9064 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9065 those headers that contain lists of addresses, a comma is also inserted at the
9066 junctions between headers. This does not happen for the &%rheader%& expansion.
9067
9068
9069 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9070 .cindex "expansion" "hmac hashing"
9071 .cindex &%hmac%&
9072 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9073 shared secret and some text into a message authentication code, as specified in
9074 RFC 2104. This differs from &`${md5:secret_text...}`& or
9075 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9076 cryptographic hash, allowing for authentication that is not possible with MD5
9077 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9078 present. For example:
9079 .code
9080 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9081 .endd
9082 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9083 produces:
9084 .code
9085 dd97e3ba5d1a61b5006108f8c8252953
9086 .endd
9087 As an example of how this might be used, you might put in the main part of
9088 an Exim configuration:
9089 .code
9090 SPAMSCAN_SECRET=cohgheeLei2thahw
9091 .endd
9092 In a router or a transport you could then have:
9093 .code
9094 headers_add = \
9095   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9096   ${hmac{md5}{SPAMSCAN_SECRET}\
9097   {${primary_hostname},${message_exim_id},$h_message-id:}}
9098 .endd
9099 Then given a message, you can check where it was scanned by looking at the
9100 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9101 this header line is authentic by recomputing the authentication code from the
9102 host name, message ID and the &'Message-id:'& header line. This can be done
9103 using Exim's &%-be%& option, or by other means, for example by using the
9104 &'hmac_md5_hex()'& function in Perl.
9105
9106
9107 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9108 .cindex "expansion" "conditional"
9109 .cindex "&%if%&, expansion item"
9110 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9111 item; otherwise <&'string2'&> is used. The available conditions are described
9112 in section &<<SECTexpcond>>& below. For example:
9113 .code
9114 ${if eq {$local_part}{postmaster} {yes}{no} }
9115 .endd
9116 The second string need not be present; if it is not and the condition is not
9117 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9118 be present instead of the second string (without any curly brackets). In this
9119 case, the expansion is forced to fail if the condition is not true (see section
9120 &<<SECTforexpfai>>&).
9121
9122 If both strings are omitted, the result is the string &`true`& if the condition
9123 is true, and the empty string if the condition is false. This makes it less
9124 cumbersome to write custom ACL and router conditions. For example, instead of
9125 .code
9126 condition = ${if >{$acl_m4}{3}{true}{false}}
9127 .endd
9128 you can use
9129 .code
9130 condition = ${if >{$acl_m4}{3}}
9131 .endd
9132
9133 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9134 .cindex "expansion" "string truncation"
9135 .cindex "&%length%& expansion item"
9136 The &%length%& item is used to extract the initial portion of a string. Both
9137 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9138 you are using a fixed value for the number, that is, if <&'string1'&> does not
9139 change when expanded, you can use the simpler operator notation that avoids
9140 some of the braces:
9141 .code
9142 ${length_<n>:<string>}
9143 .endd
9144 The result of this item is either the first <&'n'&> characters or the whole
9145 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9146 &%strlen%&, which gives the length of a string.
9147
9148
9149 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9150         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9151 This is the first of one of two different types of lookup item, which are both
9152 described in the next item.
9153
9154 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9155         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9156 .cindex "expansion" "lookup in"
9157 .cindex "file" "lookups"
9158 .cindex "lookup" "in expanded string"
9159 The two forms of lookup item specify data lookups in files and databases, as
9160 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9161 lookups, and the second is used for query-style lookups. The <&'key'&>,
9162 <&'file'&>, and <&'query'&> strings are expanded before use.
9163
9164 If there is any white space in a lookup item which is part of a filter command,
9165 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9166 other place where white space is significant, the lookup item must be enclosed
9167 in double quotes. The use of data lookups in users' filter files may be locked
9168 out by the system administrator.
9169
9170 .vindex "&$value$&"
9171 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9172 During its expansion, the variable &$value$& contains the data returned by the
9173 lookup. Afterwards it reverts to the value it had previously (at the outer
9174 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9175 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9176 string on failure. If <&'string2'&> is provided, it can itself be a nested
9177 lookup, thus providing a mechanism for looking up a default value when the
9178 original lookup fails.
9179
9180 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9181 data for the outer lookup while the parameters of the second lookup are
9182 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9183 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9184 appear, and in this case, if the lookup fails, the entire expansion is forced
9185 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9186 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9187 successful lookup, and nothing in the case of failure.
9188
9189 For single-key lookups, the string &"partial"& is permitted to precede the
9190 search type in order to do partial matching, and * or *@ may follow a search
9191 type to request default lookups if the key does not match (see sections
9192 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9193
9194 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9195 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9196 and non-wild parts of the key during the expansion of the replacement text.
9197 They return to their previous values at the end of the lookup item.
9198
9199 This example looks up the postmaster alias in the conventional alias file:
9200 .code
9201 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9202 .endd
9203 This example uses NIS+ to look up the full name of the user corresponding to
9204 the local part of an address, forcing the expansion to fail if it is not found:
9205 .code
9206 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9207   {$value}fail}
9208 .endd
9209
9210
9211 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9212 .cindex "expansion" "list creation"
9213 .vindex "&$item$&"
9214 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9215 default, but the separator can be changed in the usual way. For each item
9216 in this list, its value is place in &$item$&, and then <&'string2'&> is
9217 expanded and added to the output as an item in a new list. The separator used
9218 for the output list is the same as the one used for the input, but a separator
9219 setting is not included in the output. For example:
9220 .code
9221 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9222 .endd
9223 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9224 value of &$item$& is restored to what it was before. See also the &*filter*&
9225 and &*reduce*& expansion items.
9226
9227 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9228 .cindex "expansion" "numeric hash"
9229 .cindex "hash function" "numeric"
9230 The three strings are expanded; the first two must yield numbers. Call them
9231 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9232 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9233 can use the simpler operator notation that avoids some of the braces:
9234 .code
9235 ${nhash_<n>_<m>:<string>}
9236 .endd
9237 The second number is optional (in both notations). If there is only one number,
9238 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9239 processed by a div/mod hash function that returns two numbers, separated by a
9240 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9241 example,
9242 .code
9243 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9244 .endd
9245 returns the string &"6/33"&.
9246
9247
9248
9249 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9250 .cindex "Perl" "use in expanded string"
9251 .cindex "expansion" "calling Perl from"
9252 This item is available only if Exim has been built to include an embedded Perl
9253 interpreter. The subroutine name and the arguments are first separately
9254 expanded, and then the Perl subroutine is called with those arguments. No
9255 additional arguments need be given; the maximum number permitted, including the
9256 name of the subroutine, is nine.
9257
9258 The return value of the subroutine is inserted into the expanded string, unless
9259 the return value is &%undef%&. In that case, the expansion fails in the same
9260 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9261 Whatever you return is evaluated in a scalar context. For example, if you
9262 return the name of a Perl vector, the return value is the size of the vector,
9263 not its contents.
9264
9265 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9266 with the error message that was passed to &%die%&. More details of the embedded
9267 Perl facility are given in chapter &<<CHAPperl>>&.
9268
9269 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9270 out the use of this expansion item in filter files.
9271
9272
9273 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9274 .cindex "&%prvs%& expansion item"
9275 The first argument is a complete email address and the second is secret
9276 keystring. The third argument, specifying a key number, is optional. If absent,
9277 it defaults to 0. The result of the expansion is a prvs-signed email address,
9278 to be typically used with the &%return_path%& option on an &(smtp)& transport
9279 as part of a bounce address tag validation (BATV) scheme. For more discussion
9280 and an example, see section &<<SECTverifyPRVS>>&.
9281
9282 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9283         {*&<&'string'&>&*}}*&"
9284 .cindex "&%prvscheck%& expansion item"
9285 This expansion item is the complement of the &%prvs%& item. It is used for
9286 checking prvs-signed addresses. If the expansion of the first argument does not
9287 yield a syntactically valid prvs-signed address, the whole item expands to the
9288 empty string. When the first argument does expand to a syntactically valid
9289 prvs-signed address, the second argument is expanded, with the prvs-decoded
9290 version of the address and the key number extracted from the address in the
9291 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9292
9293 These two variables can be used in the expansion of the second argument to
9294 retrieve the secret. The validity of the prvs-signed address is then checked
9295 against the secret. The result is stored in the variable &$prvscheck_result$&,
9296 which is empty for failure or &"1"& for success.
9297
9298 The third argument is optional; if it is missing, it defaults to an empty
9299 string. This argument is now expanded. If the result is an empty string, the
9300 result of the expansion is the decoded version of the address. This is the case
9301 whether or not the signature was valid. Otherwise, the result of the expansion
9302 is the expansion of the third argument.
9303
9304 All three variables can be used in the expansion of the third argument.
9305 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9306 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9307
9308 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9309 .cindex "expansion" "inserting an entire file"
9310 .cindex "file" "inserting into expansion"
9311 .cindex "&%readfile%& expansion item"
9312 The file name and end-of-line string are first expanded separately. The file is
9313 then read, and its contents replace the entire item. All newline characters in
9314 the file are replaced by the end-of-line string if it is present. Otherwise,
9315 newlines are left in the string.
9316 String expansion is not applied to the contents of the file. If you want this,
9317 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9318 the string expansion fails.
9319
9320 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9321 locks out the use of this expansion item in filter files.
9322
9323
9324
9325 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9326         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9327 .cindex "expansion" "inserting from a socket"
9328 .cindex "socket, use of in expansion"
9329 .cindex "&%readsocket%& expansion item"
9330 This item inserts data from a Unix domain or Internet socket into the expanded
9331 string. The minimal way of using it uses just two arguments, as in these
9332 examples:
9333 .code
9334 ${readsocket{/socket/name}{request string}}
9335 ${readsocket{inet:some.host:1234}{request string}}
9336 .endd
9337 For a Unix domain socket, the first substring must be the path to the socket.
9338 For an Internet socket, the first substring must contain &`inet:`& followed by
9339 a host name or IP address, followed by a colon and a port, which can be a
9340 number or the name of a TCP port in &_/etc/services_&. An IP address may
9341 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9342 example:
9343 .code
9344 ${readsocket{inet:[::1]:1234}{request string}}
9345 .endd
9346 Only a single host name may be given, but if looking it up yields more than
9347 one IP address, they are each tried in turn until a connection is made. For
9348 both kinds of socket, Exim makes a connection, writes the request string
9349 (unless it is an empty string) and reads from the socket until an end-of-file
9350 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9351 extend what can be done. Firstly, you can vary the timeout. For example:
9352 .code
9353 ${readsocket{/socket/name}{request string}{3s}}
9354 .endd
9355 A fourth argument allows you to change any newlines that are in the data
9356 that is read, in the same way as for &%readfile%& (see above). This example
9357 turns them into spaces:
9358 .code
9359 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9360 .endd
9361 As with all expansions, the substrings are expanded before the processing
9362 happens. Errors in these sub-expansions cause the expansion to fail. In
9363 addition, the following errors can occur:
9364
9365 .ilist
9366 Failure to create a socket file descriptor;
9367 .next
9368 Failure to connect the socket;
9369 .next
9370 Failure to write the request string;
9371 .next
9372 Timeout on reading from the socket.
9373 .endlist
9374
9375 By default, any of these errors causes the expansion to fail. However, if
9376 you supply a fifth substring, it is expanded and used when any of the above
9377 errors occurs. For example:
9378 .code
9379 ${readsocket{/socket/name}{request string}{3s}{\n}\
9380   {socket failure}}
9381 .endd
9382 You can test for the existence of a Unix domain socket by wrapping this
9383 expansion in &`${if exists`&, but there is a race condition between that test
9384 and the actual opening of the socket, so it is safer to use the fifth argument
9385 if you want to be absolutely sure of avoiding an expansion error for a
9386 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9387
9388 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9389 locks out the use of this expansion item in filter files.
9390
9391
9392 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9393 .cindex "expansion" "reducing a list to a scalar"
9394 .cindex "list" "reducing to a scalar"
9395 .vindex "&$value$&"
9396 .vindex "&$item$&"
9397 This operation reduces a list to a single, scalar string. After expansion,
9398 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9399 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9400 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9401 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9402 them. The result of that expansion is assigned to &$value$& before the next
9403 iteration. When the end of the list is reached, the final value of &$value$& is
9404 added to the expansion output. The &*reduce*& expansion item can be used in a
9405 number of ways. For example, to add up a list of numbers:
9406 .code
9407 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9408 .endd
9409 The result of that expansion would be &`6`&. The maximum of a list of numbers
9410 can be found:
9411 .code
9412 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9413 .endd
9414 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9415 restored to what they were before. See also the &*filter*& and &*map*&
9416 expansion items.
9417
9418 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9419 This item inserts &"raw"& header lines. It is described with the &%header%&
9420 expansion item above.
9421
9422 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9423         {*&<&'string2'&>&*}}*&"
9424 .cindex "expansion" "running a command"
9425 .cindex "&%run%& expansion item"
9426 The command and its arguments are first expanded separately, and then the
9427 command is run in a separate process, but under the same uid and gid. As in
9428 other command executions from Exim, a shell is not used by default. If you want
9429 a shell, you must explicitly code it.
9430
9431 The standard input for the command exists, but is empty. The standard output
9432 and standard error are set to the same file descriptor.
9433 .cindex "return code" "from &%run%& expansion"
9434 .vindex "&$value$&"
9435 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9436 and replaces the entire item; during this expansion, the standard output/error
9437 from the command is in the variable &$value$&. If the command fails,
9438 <&'string2'&>, if present, is expanded and used. Once again, during the
9439 expansion, the standard output/error from the command is in the variable
9440 &$value$&.
9441
9442 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9443 can be the word &"fail"& (not in braces) to force expansion failure if the
9444 command does not succeed. If both strings are omitted, the result is contents
9445 of the standard output/error on success, and nothing on failure.
9446
9447 .vindex "&$run_in_acl$&"
9448 The standard output/error of the command is put in the variable &$value$&.
9449 In this ACL example, the output of a command is logged for the admin to
9450 troubleshoot:
9451 .code
9452 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9453       log_message  = Output of id: $value
9454 .endd
9455 If the command requires shell idioms, such as the > redirect operator, the
9456 shell must be invoked directly, such as with:
9457 .code
9458 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9459 .endd
9460
9461 .vindex "&$runrc$&"
9462 The return code from the command is put in the variable &$runrc$&, and this
9463 remains set afterwards, so in a filter file you can do things like this:
9464 .code
9465 if "${run{x y z}{}}$runrc" is 1 then ...
9466   elif $runrc is 2 then ...
9467   ...
9468 endif
9469 .endd
9470 If execution of the command fails (for example, the command does not exist),
9471 the return code is 127 &-- the same code that shells use for non-existent
9472 commands.
9473
9474 &*Warning*&: In a router or transport, you cannot assume the order in which
9475 option values are expanded, except for those preconditions whose order of
9476 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9477 by the expansion of one option, and use it in another.
9478
9479 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9480 out the use of this expansion item in filter files.
9481
9482
9483 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9484 .cindex "expansion" "string substitution"
9485 .cindex "&%sg%& expansion item"
9486 This item works like Perl's substitution operator (s) with the global (/g)
9487 option; hence its name. However, unlike the Perl equivalent, Exim does not
9488 modify the subject string; instead it returns the modified string for insertion
9489 into the overall expansion. The item takes three arguments: the subject string,
9490 a regular expression, and a substitution string. For example:
9491 .code
9492 ${sg{abcdefabcdef}{abc}{xyz}}
9493 .endd
9494 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9495 if any $ or \ characters are required in the regular expression or in the
9496 substitution string, they have to be escaped. For example:
9497 .code
9498 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9499 .endd
9500 yields &"defabc"&, and
9501 .code
9502 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9503 .endd
9504 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9505 the regular expression from string expansion.
9506
9507
9508
9509 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9510 .cindex "&%substr%& expansion item"
9511 .cindex "substring extraction"
9512 .cindex "expansion" "substring extraction"
9513 The three strings are expanded; the first two must yield numbers. Call them
9514 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9515 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9516 can use the simpler operator notation that avoids some of the braces:
9517 .code
9518 ${substr_<n>_<m>:<string>}
9519 .endd
9520 The second number is optional (in both notations).
9521 If it is absent in the simpler format, the preceding underscore must also be
9522 omitted.
9523
9524 The &%substr%& item can be used to extract more general substrings than
9525 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9526 length required. For example
9527 .code
9528 ${substr{3}{2}{$local_part}}
9529 .endd
9530 If the starting offset is greater than the string length the result is the
9531 null string; if the length plus starting offset is greater than the string
9532 length, the result is the right-hand part of the string, starting from the
9533 given offset. The first character in the string has offset zero.
9534
9535 The &%substr%& expansion item can take negative offset values to count
9536 from the right-hand end of its operand. The last character is offset -1, the
9537 second-last is offset -2, and so on. Thus, for example,
9538 .code
9539 ${substr{-5}{2}{1234567}}
9540 .endd
9541 yields &"34"&. If the absolute value of a negative offset is greater than the
9542 length of the string, the substring starts at the beginning of the string, and
9543 the length is reduced by the amount of overshoot. Thus, for example,
9544 .code
9545 ${substr{-5}{2}{12}}
9546 .endd
9547 yields an empty string, but
9548 .code
9549 ${substr{-3}{2}{12}}
9550 .endd
9551 yields &"1"&.
9552
9553 When the second number is omitted from &%substr%&, the remainder of the string
9554 is taken if the offset is positive. If it is negative, all characters in the
9555 string preceding the offset point are taken. For example, an offset of -1 and
9556 no length, as in these semantically identical examples:
9557 .code
9558 ${substr_-1:abcde}
9559 ${substr{-1}{abcde}}
9560 .endd
9561 yields all but the last character of the string, that is, &"abcd"&.
9562
9563
9564
9565 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9566         {*&<&'replacements'&>&*}}*&"
9567 .cindex "expansion" "character translation"
9568 .cindex "&%tr%& expansion item"
9569 This item does single-character translation on its subject string. The second
9570 argument is a list of characters to be translated in the subject string. Each
9571 matching character is replaced by the corresponding character from the
9572 replacement list. For example
9573 .code
9574 ${tr{abcdea}{ac}{13}}
9575 .endd
9576 yields &`1b3de1`&. If there are duplicates in the second character string, the
9577 last occurrence is used. If the third string is shorter than the second, its
9578 last character is replicated. However, if it is empty, no translation takes
9579 place.
9580 .endlist
9581
9582
9583
9584 .section "Expansion operators" "SECTexpop"
9585 .cindex "expansion" "operators"
9586 For expansion items that perform transformations on a single argument string,
9587 the &"operator"& notation is used because it is simpler and uses fewer braces.
9588 The substring is first expanded before the operation is applied to it. The
9589 following operations can be performed:
9590
9591 .vlist
9592 .vitem &*${address:*&<&'string'&>&*}*&
9593 .cindex "expansion" "RFC 2822 address handling"
9594 .cindex "&%address%& expansion item"
9595 The string is interpreted as an RFC 2822 address, as it might appear in a
9596 header line, and the effective address is extracted from it. If the string does
9597 not parse successfully, the result is empty.
9598
9599
9600 .vitem &*${addresses:*&<&'string'&>&*}*&
9601 .cindex "expansion" "RFC 2822 address handling"
9602 .cindex "&%addresses%& expansion item"
9603 The string (after expansion) is interpreted as a list of addresses in RFC
9604 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9605 operative address (&'local-part@domain'&) is extracted from each item, and the
9606 result of the expansion is a colon-separated list, with appropriate
9607 doubling of colons should any happen to be present in the email addresses.
9608 Syntactically invalid RFC2822 address items are omitted from the output.
9609
9610 It is possible to specify a character other than colon for the output
9611 separator by starting the string with > followed by the new separator
9612 character. For example:
9613 .code
9614 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9615 .endd
9616 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9617 expansion item, which extracts the working address from a single RFC2822
9618 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9619 processing lists.
9620
9621
9622 .vitem &*${base62:*&<&'digits'&>&*}*&
9623 .cindex "&%base62%& expansion item"
9624 .cindex "expansion" "conversion to base 62"
9625 The string must consist entirely of decimal digits. The number is converted to
9626 base 62 and output as a string of six characters, including leading zeros. In
9627 the few operating environments where Exim uses base 36 instead of base 62 for
9628 its message identifiers (because those systems do not have case-sensitive file
9629 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9630 be absolutely clear: this is &'not'& base64 encoding.
9631
9632 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9633 .cindex "&%base62d%& expansion item"
9634 .cindex "expansion" "conversion to base 62"
9635 The string must consist entirely of base-62 digits, or, in operating
9636 environments where Exim uses base 36 instead of base 62 for its message
9637 identifiers, base-36 digits. The number is converted to decimal and output as a
9638 string.
9639
9640
9641 .vitem &*${domain:*&<&'string'&>&*}*&
9642 .cindex "domain" "extraction"
9643 .cindex "expansion" "domain extraction"
9644 The string is interpreted as an RFC 2822 address and the domain is extracted
9645 from it. If the string does not parse successfully, the result is empty.
9646
9647
9648 .vitem &*${escape:*&<&'string'&>&*}*&
9649 .cindex "expansion" "escaping non-printing characters"
9650 .cindex "&%escape%& expansion item"
9651 If the string contains any non-printing characters, they are converted to
9652 escape sequences starting with a backslash. Whether characters with the most
9653 significant bit set (so-called &"8-bit characters"&) count as printing or not
9654 is controlled by the &%print_topbitchars%& option.
9655
9656
9657 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9658 .cindex "expansion" "expression evaluation"
9659 .cindex "expansion" "arithmetic expression"
9660 .cindex "&%eval%& expansion item"
9661 These items supports simple arithmetic and bitwise logical operations in
9662 expansion strings. The string (after expansion) must be a conventional
9663 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9664 logical operators, and parentheses. All operations are carried out using
9665 integer arithmetic. The operator priorities are as follows (the same as in the
9666 C programming language):
9667 .table2 70pt 300pt
9668 .irow &'highest:'& "not (~), negate (-)"
9669 .irow ""   "multiply (*), divide (/), remainder (%)"
9670 .irow ""   "plus (+), minus (-)"
9671 .irow ""   "shift-left (<<), shift-right (>>)"
9672 .irow ""   "and (&&)"
9673 .irow ""   "xor (^)"
9674 .irow &'lowest:'&  "or (|)"
9675 .endtable
9676 Binary operators with the same priority are evaluated from left to right. White
9677 space is permitted before or after operators.
9678
9679 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9680 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9681 decimal, even if they start with a leading zero; hexadecimal numbers are not
9682 permitted. This can be useful when processing numbers extracted from dates or
9683 times, which often do have leading zeros.
9684
9685 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9686 or 1024*1024*1024,
9687 respectively. Negative numbers are supported. The result of the computation is
9688 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9689
9690 .display
9691 &`${eval:1+1}            `&  yields 2
9692 &`${eval:1+2*3}          `&  yields 7
9693 &`${eval:(1+2)*3}        `&  yields 9
9694 &`${eval:2+42%5}         `&  yields 4
9695 &`${eval:0xc&amp;5}          `&  yields 4
9696 &`${eval:0xc|5}          `&  yields 13
9697 &`${eval:0xc^5}          `&  yields 9
9698 &`${eval:0xc>>1}         `&  yields 6
9699 &`${eval:0xc<<1}         `&  yields 24
9700 &`${eval:~255&amp;0x1234}    `&  yields 4608
9701 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9702 .endd
9703
9704 As a more realistic example, in an ACL you might have
9705 .code
9706 deny   message = Too many bad recipients
9707        condition =                    \
9708          ${if and {                   \
9709            {>{$rcpt_count}{10}}       \
9710            {                          \
9711            <                          \
9712              {$recipients_count}      \
9713              {${eval:$rcpt_count/2}}  \
9714            }                          \
9715          }{yes}{no}}
9716 .endd
9717 The condition is true if there have been more than 10 RCPT commands and
9718 fewer than half of them have resulted in a valid recipient.
9719
9720
9721 .vitem &*${expand:*&<&'string'&>&*}*&
9722 .cindex "expansion" "re-expansion of substring"
9723 The &%expand%& operator causes a string to be expanded for a second time. For
9724 example,
9725 .code
9726 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9727 .endd
9728 first looks up a string in a file while expanding the operand for &%expand%&,
9729 and then re-expands what it has found.
9730
9731
9732 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9733 .cindex "Unicode"
9734 .cindex "UTF-8" "conversion from"
9735 .cindex "expansion" "UTF-8 conversion"
9736 .cindex "&%from_utf8%& expansion item"
9737 The world is slowly moving towards Unicode, although there are no standards for
9738 email yet. However, other applications (including some databases) are starting
9739 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9740 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9741 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9742 the result is an undefined sequence of bytes.
9743
9744 Unicode code points with values less than 256 are compatible with ASCII and
9745 ISO-8859-1 (also known as Latin-1).
9746 For example, character 169 is the copyright symbol in both cases, though the
9747 way it is encoded is different. In UTF-8, more than one byte is needed for
9748 characters with code values greater than 127, whereas ISO-8859-1 is a
9749 single-byte encoding (but thereby limited to 256 characters). This makes
9750 translation from UTF-8 to ISO-8859-1 straightforward.
9751
9752
9753 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9754 .cindex "hash function" "textual"
9755 .cindex "expansion" "textual hash"
9756 The &%hash%& operator is a simpler interface to the hashing function that can
9757 be used when the two parameters are fixed numbers (as opposed to strings that
9758 change when expanded). The effect is the same as
9759 .code
9760 ${hash{<n>}{<m>}{<string>}}
9761 .endd
9762 See the description of the general &%hash%& item above for details. The
9763 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9764
9765
9766
9767 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9768 .cindex "base64 encoding" "conversion from hex"
9769 .cindex "expansion" "hex to base64"
9770 .cindex "&%hex2b64%& expansion item"
9771 This operator converts a hex string into one that is base64 encoded. This can
9772 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9773
9774
9775
9776 .vitem &*${hexquote:*&<&'string'&>&*}*&
9777 .cindex "quoting" "hex-encoded unprintable characters"
9778 .cindex "&%hexquote%& expansion item"
9779 This operator converts non-printable characters in a string into a hex
9780 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
9781 as is, and other byte values are converted to &`\xNN`&, for example a
9782 byt value 127 is converted to &`\x7f`&.
9783
9784
9785 .vitem &*${lc:*&<&'string'&>&*}*&
9786 .cindex "case forcing in strings"
9787 .cindex "string" "case forcing"
9788 .cindex "lower casing"
9789 .cindex "expansion" "case forcing"
9790 .cindex "&%lc%& expansion item"
9791 This forces the letters in the string into lower-case, for example:
9792 .code
9793 ${lc:$local_part}
9794 .endd
9795
9796 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9797 .cindex "expansion" "string truncation"
9798 .cindex "&%length%& expansion item"
9799 The &%length%& operator is a simpler interface to the &%length%& function that
9800 can be used when the parameter is a fixed number (as opposed to a string that
9801 changes when expanded). The effect is the same as
9802 .code
9803 ${length{<number>}{<string>}}
9804 .endd
9805 See the description of the general &%length%& item above for details. Note that
9806 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9807 when &%length%& is used as an operator.
9808
9809
9810 .vitem &*${listcount:*&<&'string'&>&*}*&
9811 .cindex "expansion" "list item count"
9812 .cindex "list" "item count"
9813 .cindex "list" "count of items"
9814 .cindex "&%listcount%& expansion item"
9815 The string is interpreted as a list and the number of items is returned.
9816
9817
9818 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${list_*&<&'type'&>&*name*&>&*}*&
9819 .cindex "expansion" "named list"
9820 .cindex "&%listnamed%& expansion item"
9821 The name is interpreted as a named list and the content of the list is returned,
9822 expanding any referenced lists, re-quoting as needed for colon-separation.
9823 If the optional type if given it must be one of "a", "d", "h" or "l"
9824 and selects address-, domain-, host- or localpart- lists to search among respectively.
9825 Otherwise all types are searched in an undefined order and the first
9826 matching list is returned.
9827
9828
9829 .vitem &*${local_part:*&<&'string'&>&*}*&
9830 .cindex "expansion" "local part extraction"
9831 .cindex "&%local_part%& expansion item"
9832 The string is interpreted as an RFC 2822 address and the local part is
9833 extracted from it. If the string does not parse successfully, the result is
9834 empty.
9835
9836
9837 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9838 .cindex "masked IP address"
9839 .cindex "IP address" "masking"
9840 .cindex "CIDR notation"
9841 .cindex "expansion" "IP address masking"
9842 .cindex "&%mask%& expansion item"
9843 If the form of the string to be operated on is not an IP address followed by a
9844 slash and an integer (that is, a network address in CIDR notation), the
9845 expansion fails. Otherwise, this operator converts the IP address to binary,
9846 masks off the least significant bits according to the bit count, and converts
9847 the result back to text, with mask appended. For example,
9848 .code
9849 ${mask:10.111.131.206/28}
9850 .endd
9851 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9852 be mostly used for looking up masked addresses in files, the result for an IPv6
9853 address uses dots to separate components instead of colons, because colon
9854 terminates a key string in lsearch files. So, for example,
9855 .code
9856 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9857 .endd
9858 returns the string
9859 .code
9860 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9861 .endd
9862 Letters in IPv6 addresses are always output in lower case.
9863
9864
9865 .vitem &*${md5:*&<&'string'&>&*}*&
9866 .cindex "MD5 hash"
9867 .cindex "expansion" "MD5 hash"
9868 .cindex "&%md5%& expansion item"
9869 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9870 as a 32-digit hexadecimal number, in which any letters are in lower case.
9871
9872
9873 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9874 .cindex "expansion" "numeric hash"
9875 .cindex "hash function" "numeric"
9876 The &%nhash%& operator is a simpler interface to the numeric hashing function
9877 that can be used when the two parameters are fixed numbers (as opposed to
9878 strings that change when expanded). The effect is the same as
9879 .code
9880 ${nhash{<n>}{<m>}{<string>}}
9881 .endd
9882 See the description of the general &%nhash%& item above for details.
9883
9884
9885 .vitem &*${quote:*&<&'string'&>&*}*&
9886 .cindex "quoting" "in string expansions"
9887 .cindex "expansion" "quoting"
9888 .cindex "&%quote%& expansion item"
9889 The &%quote%& operator puts its argument into double quotes if it
9890 is an empty string or
9891 contains anything other than letters, digits, underscores, dots, and hyphens.
9892 Any occurrences of double quotes and backslashes are escaped with a backslash.
9893 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9894 respectively For example,
9895 .code
9896 ${quote:ab"*"cd}
9897 .endd
9898 becomes
9899 .code
9900 "ab\"*\"cd"
9901 .endd
9902 The place where this is useful is when the argument is a substitution from a
9903 variable or a message header.
9904
9905 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9906 .cindex "&%quote_local_part%& expansion item"
9907 This operator is like &%quote%&, except that it quotes the string only if
9908 required to do so by the rules of RFC 2822 for quoting local parts. For
9909 example, a plus sign would not cause quoting (but it would for &%quote%&).
9910 If you are creating a new email address from the contents of &$local_part$&
9911 (or any other unknown data), you should always use this operator.
9912
9913
9914 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9915 .cindex "quoting" "lookup-specific"
9916 This operator applies lookup-specific quoting rules to the string. Each
9917 query-style lookup type has its own quoting rules which are described with
9918 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9919 .code
9920 ${quote_ldap:two * two}
9921 .endd
9922 returns
9923 .code
9924 two%20%5C2A%20two
9925 .endd
9926 For single-key lookup types, no quoting is ever necessary and this operator
9927 yields an unchanged string.
9928
9929
9930 .vitem &*${randint:*&<&'n'&>&*}*&
9931 .cindex "random number"
9932 This operator returns a somewhat random number which is less than the
9933 supplied number and is at least 0.  The quality of this randomness depends
9934 on how Exim was built; the values are not suitable for keying material.
9935 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9936 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
9937 for versions of GnuTLS with that function.
9938 Otherwise, the implementation may be arc4random(), random() seeded by
9939 srandomdev() or srandom(), or a custom implementation even weaker than
9940 random().
9941
9942
9943 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9944 .cindex "expansion" "IP address"
9945 This operator reverses an IP address; for IPv4 addresses, the result is in
9946 dotted-quad decimal form, while for IPv6 addreses the result is in
9947 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9948 for DNS.  For example,
9949 .code
9950 ${reverse_ip:192.0.2.4}
9951 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
9952 .endd
9953 returns
9954 .code
9955 4.2.0.192
9956 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
9957 .endd
9958
9959
9960 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9961 .cindex "expansion" "RFC 2047"
9962 .cindex "RFC 2047" "expansion operator"
9963 .cindex "&%rfc2047%& expansion item"
9964 This operator encodes text according to the rules of RFC 2047. This is an
9965 encoding that is used in header lines to encode non-ASCII characters. It is
9966 assumed that the input string is in the encoding specified by the
9967 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9968 contains only characters in the range 33&--126, and no instances of the
9969 characters
9970 .code
9971 ? = ( ) < > @ , ; : \ " . [ ] _
9972 .endd
9973 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9974 string, using as many &"encoded words"& as necessary to encode all the
9975 characters.
9976
9977
9978 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9979 .cindex "expansion" "RFC 2047"
9980 .cindex "RFC 2047" "decoding"
9981 .cindex "&%rfc2047d%& expansion item"
9982 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9983 bytes are replaced by question marks. Characters are converted into the
9984 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9985 not recognized unless &%check_rfc2047_length%& is set false.
9986
9987 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9988 access a header line, RFC 2047 decoding is done automatically. You do not need
9989 to use this operator as well.
9990
9991
9992
9993 .vitem &*${rxquote:*&<&'string'&>&*}*&
9994 .cindex "quoting" "in regular expressions"
9995 .cindex "regular expressions" "quoting"
9996 .cindex "&%rxquote%& expansion item"
9997 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9998 characters in its argument. This is useful when substituting the values of
9999 variables or headers inside regular expressions.
10000
10001
10002 .vitem &*${sha1:*&<&'string'&>&*}*&
10003 .cindex "SHA-1 hash"
10004 .cindex "expansion" "SHA-1 hashing"
10005 .cindex "&%sha2%& expansion item"
10006 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10007 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10008
10009
10010 .vitem &*${stat:*&<&'string'&>&*}*&
10011 .cindex "expansion" "statting a file"
10012 .cindex "file" "extracting characteristics"
10013 .cindex "&%stat%& expansion item"
10014 The string, after expansion, must be a file path. A call to the &[stat()]&
10015 function is made for this path. If &[stat()]& fails, an error occurs and the
10016 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10017 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10018 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10019 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10020 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10021 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10022 can extract individual fields using the &%extract%& expansion item.
10023
10024 The use of the &%stat%& expansion in users' filter files can be locked out by
10025 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10026 systems for files larger than 2GB.
10027
10028 .vitem &*${str2b64:*&<&'string'&>&*}*&
10029 .cindex "expansion" "base64 encoding"
10030 .cindex "base64 encoding" "in string expansion"
10031 .cindex "&%str2b64%& expansion item"
10032 This operator converts a string into one that is base64 encoded.
10033
10034
10035
10036 .vitem &*${strlen:*&<&'string'&>&*}*&
10037 .cindex "expansion" "string length"
10038 .cindex "string" "length in expansion"
10039 .cindex "&%strlen%& expansion item"
10040 The item is replace by the length of the expanded string, expressed as a
10041 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10042
10043
10044 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10045 .cindex "&%substr%& expansion item"
10046 .cindex "substring extraction"
10047 .cindex "expansion" "substring expansion"
10048 The &%substr%& operator is a simpler interface to the &%substr%& function that
10049 can be used when the two parameters are fixed numbers (as opposed to strings
10050 that change when expanded). The effect is the same as
10051 .code
10052 ${substr{<start>}{<length>}{<string>}}
10053 .endd
10054 See the description of the general &%substr%& item above for details. The
10055 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10056
10057 .vitem &*${time_eval:*&<&'string'&>&*}*&
10058 .cindex "&%time_eval%& expansion item"
10059 .cindex "time interval" "decoding"
10060 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10061 seconds.
10062
10063 .vitem &*${time_interval:*&<&'string'&>&*}*&
10064 .cindex "&%time_interval%& expansion item"
10065 .cindex "time interval" "formatting"
10066 The argument (after sub-expansion) must be a sequence of decimal digits that
10067 represents an interval of time as a number of seconds. It is converted into a
10068 number of larger units and output in Exim's normal time format, for example,
10069 &`1w3d4h2m6s`&.
10070
10071 .vitem &*${uc:*&<&'string'&>&*}*&
10072 .cindex "case forcing in strings"
10073 .cindex "string" "case forcing"
10074 .cindex "upper casing"
10075 .cindex "expansion" "case forcing"
10076 .cindex "&%uc%& expansion item"
10077 This forces the letters in the string into upper-case.
10078 .endlist
10079
10080
10081
10082
10083
10084
10085 .section "Expansion conditions" "SECTexpcond"
10086 .scindex IIDexpcond "expansion" "conditions"
10087 The following conditions are available for testing by the &%${if%& construct
10088 while expanding strings:
10089
10090 .vlist
10091 .vitem &*!*&<&'condition'&>
10092 .cindex "expansion" "negating a condition"
10093 .cindex "negation" "in expansion condition"
10094 Preceding any condition with an exclamation mark negates the result of the
10095 condition.
10096
10097 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10098 .cindex "numeric comparison"
10099 .cindex "expansion" "numeric comparison"
10100 There are a number of symbolic operators for doing numeric comparisons. They
10101 are:
10102 .display
10103 &`=   `&   equal
10104 &`==  `&   equal
10105 &`>   `&   greater
10106 &`>=  `&   greater or equal
10107 &`<   `&   less
10108 &`<=  `&   less or equal
10109 .endd
10110 For example:
10111 .code
10112 ${if >{$message_size}{10M} ...
10113 .endd
10114 Note that the general negation operator provides for inequality testing. The
10115 two strings must take the form of optionally signed decimal integers,
10116 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10117 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10118 As a special case, the numerical value of an empty string is taken as
10119 zero.
10120
10121 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10122 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10123 10M, not if 10M is larger than &$message_size$&.
10124
10125
10126 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10127         {*&<&'arg2'&>&*}...}*&
10128 .cindex "expansion" "calling an acl"
10129 .cindex "&%acl%&" "expansion condition"
10130 The name and zero to nine argument strings are first expanded separately.  The expanded
10131 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10132 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10133 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10134 and may use the variables; if another acl expansion is used the values
10135 are restored after it returns.  If the ACL sets
10136 a value using a "message =" modifier the variable $value becomes
10137 the result of the expansion, otherwise it is empty.
10138 If the ACL returns accept the condition is true; if deny, false.
10139 If the ACL returns defer the result is a forced-fail.
10140
10141 .vitem &*bool&~{*&<&'string'&>&*}*&
10142 .cindex "expansion" "boolean parsing"
10143 .cindex "&%bool%& expansion condition"
10144 This condition turns a string holding a true or false representation into
10145 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10146 (case-insensitively); also positive integer numbers map to true if non-zero,
10147 false if zero.
10148 An empty string is treated as false.
10149 Leading and trailing whitespace is ignored;
10150 thus a string consisting only of whitespace is false.
10151 All other string values will result in expansion failure.
10152
10153 When combined with ACL variables, this expansion condition will let you
10154 make decisions in one place and act on those decisions in another place.
10155 For example:
10156 .code
10157 ${if bool{$acl_m_privileged_sender} ...
10158 .endd
10159
10160
10161 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10162 .cindex "expansion" "boolean parsing"
10163 .cindex "&%bool_lax%& expansion condition"
10164 Like &%bool%&, this condition turns a string into a boolean state.  But
10165 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10166 loose definition that the Router &%condition%& option uses.  The empty string
10167 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10168 true.  Leading and trailing whitespace is ignored.
10169
10170 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10171
10172 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10173 .cindex "expansion" "encrypted comparison"
10174 .cindex "encrypted strings, comparing"
10175 .cindex "&%crypteq%& expansion condition"
10176 This condition is included in the Exim binary if it is built to support any
10177 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10178 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10179 included in the binary.
10180
10181 The &%crypteq%& condition has two arguments. The first is encrypted and
10182 compared against the second, which is already encrypted. The second string may
10183 be in the LDAP form for storing encrypted strings, which starts with the
10184 encryption type in curly brackets, followed by the data. If the second string
10185 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10186 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10187 Typically this will be a field from a password file. An example of an encrypted
10188 string in LDAP form is:
10189 .code
10190 {md5}CY9rzUYh03PK3k6DJie09g==
10191 .endd
10192 If such a string appears directly in an expansion, the curly brackets have to
10193 be quoted, because they are part of the expansion syntax. For example:
10194 .code
10195 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10196 .endd
10197 The following encryption types (whose names are matched case-independently) are
10198 supported:
10199
10200 .ilist
10201 .cindex "MD5 hash"
10202 .cindex "base64 encoding" "in encrypted password"
10203 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10204 printable characters to compare with the remainder of the second string. If the
10205 length of the comparison string is 24, Exim assumes that it is base64 encoded
10206 (as in the above example). If the length is 32, Exim assumes that it is a
10207 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10208 comparison fails.
10209
10210 .next
10211 .cindex "SHA-1 hash"
10212 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10213 printable characters to compare with the remainder of the second string. If the
10214 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10215 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10216 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10217
10218 .next
10219 .cindex "&[crypt()]&"
10220 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10221 only the first eight characters of the password. However, in modern operating
10222 systems this is no longer true, and in many cases the entire password is used,
10223 whatever its length.
10224
10225 .next
10226 .cindex "&[crypt16()]&"
10227 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10228 use up to 16 characters of the password in some operating systems. Again, in
10229 modern operating systems, more characters may be used.
10230 .endlist
10231 Exim has its own version of &[crypt16()]&, which is just a double call to
10232 &[crypt()]&. For operating systems that have their own version, setting
10233 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10234 operating system version instead of its own. This option is set by default in
10235 the OS-dependent &_Makefile_& for those operating systems that are known to
10236 support &[crypt16()]&.
10237
10238 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10239 it was not using the same algorithm as some operating systems' versions. It
10240 turns out that as well as &[crypt16()]& there is a function called
10241 &[bigcrypt()]& in some operating systems. This may or may not use the same
10242 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10243
10244 However, since there is now a move away from the traditional &[crypt()]&
10245 functions towards using SHA1 and other algorithms, tidying up this area of
10246 Exim is seen as very low priority.
10247
10248 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10249 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10250 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10251 default is &`{crypt}`&. Whatever the default, you can always use either
10252 function by specifying it explicitly in curly brackets.
10253
10254 .vitem &*def:*&<&'variable&~name'&>
10255 .cindex "expansion" "checking for empty variable"
10256 .cindex "&%def%& expansion condition"
10257 The &%def%& condition must be followed by the name of one of the expansion
10258 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10259 variable does not contain the empty string. For example:
10260 .code
10261 ${if def:sender_ident {from $sender_ident}}
10262 .endd
10263 Note that the variable name is given without a leading &%$%& character. If the
10264 variable does not exist, the expansion fails.
10265
10266 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10267         &~&*def:h_*&<&'header&~name'&>&*:*&"
10268 .cindex "expansion" "checking header line existence"
10269 This condition is true if a message is being processed and the named header
10270 exists in the message. For example,
10271 .code
10272 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10273 .endd
10274 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10275 the header name must be terminated by a colon if white space does not follow.
10276
10277 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10278        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10279 .cindex "string" "comparison"
10280 .cindex "expansion" "string comparison"
10281 .cindex "&%eq%& expansion condition"
10282 .cindex "&%eqi%& expansion condition"
10283 The two substrings are first expanded. The condition is true if the two
10284 resulting strings are identical. For &%eq%& the comparison includes the case of
10285 letters, whereas for &%eqi%& the comparison is case-independent.
10286
10287 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10288 .cindex "expansion" "file existence test"
10289 .cindex "file" "existence test"
10290 .cindex "&%exists%&, expansion condition"
10291 The substring is first expanded and then interpreted as an absolute path. The
10292 condition is true if the named file (or directory) exists. The existence test
10293 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10294 users' filter files may be locked out by the system administrator.
10295
10296 .vitem &*first_delivery*&
10297 .cindex "delivery" "first"
10298 .cindex "first delivery"
10299 .cindex "expansion" "first delivery test"
10300 .cindex "&%first_delivery%& expansion condition"
10301 This condition, which has no data, is true during a message's first delivery
10302 attempt. It is false during any subsequent delivery attempts.
10303
10304
10305 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10306        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10307 .cindex "list" "iterative conditions"
10308 .cindex "expansion" "&*forall*& condition"
10309 .cindex "expansion" "&*forany*& condition"
10310 .vindex "&$item$&"
10311 These conditions iterate over a list. The first argument is expanded to form
10312 the list. By default, the list separator is a colon, but it can be changed by
10313 the normal method. The second argument is interpreted as a condition that is to
10314 be applied to each item in the list in turn. During the interpretation of the
10315 condition, the current list item is placed in a variable called &$item$&.
10316 .ilist
10317 For &*forany*&, interpretation stops if the condition is true for any item, and
10318 the result of the whole condition is true. If the condition is false for all
10319 items in the list, the overall condition is false.
10320 .next
10321 For &*forall*&, interpretation stops if the condition is false for any item,
10322 and the result of the whole condition is false. If the condition is true for
10323 all items in the list, the overall condition is true.
10324 .endlist
10325 Note that negation of &*forany*& means that the condition must be false for all
10326 items for the overall condition to succeed, and negation of &*forall*& means
10327 that the condition must be false for at least one item. In this example, the
10328 list separator is changed to a comma:
10329 .code
10330 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10331 .endd
10332 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10333 being processed, to enable these expansion items to be nested.
10334
10335 To scan a named list, expand it with the &*listnamed*& operator.
10336
10337
10338 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10339        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10340 .cindex "string" "comparison"
10341 .cindex "expansion" "string comparison"
10342 .cindex "&%ge%& expansion condition"
10343 .cindex "&%gei%& expansion condition"
10344 The two substrings are first expanded. The condition is true if the first
10345 string is lexically greater than or equal to the second string. For &%ge%& the
10346 comparison includes the case of letters, whereas for &%gei%& the comparison is
10347 case-independent.
10348
10349 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10350        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10351 .cindex "string" "comparison"
10352 .cindex "expansion" "string comparison"
10353 .cindex "&%gt%& expansion condition"
10354 .cindex "&%gti%& expansion condition"
10355 The two substrings are first expanded. The condition is true if the first
10356 string is lexically greater than the second string. For &%gt%& the comparison
10357 includes the case of letters, whereas for &%gti%& the comparison is
10358 case-independent.
10359
10360 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10361        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10362 .cindex "string" "comparison"
10363 .cindex "list" "iterative conditions"
10364 Both strings are expanded; the second string is treated as a list of simple
10365 strings; if the first string is a member of the second, then the condition
10366 is true.
10367
10368 These are simpler to use versions of the more powerful &*forany*& condition.
10369 Examples, and the &*forany*& equivalents:
10370 .code
10371 ${if inlist{needle}{foo:needle:bar}}
10372   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10373 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10374   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10375 .endd
10376
10377 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10378        &*isip4&~{*&<&'string'&>&*}*& &&&
10379        &*isip6&~{*&<&'string'&>&*}*&
10380 .cindex "IP address" "testing string format"
10381 .cindex "string" "testing for IP address"
10382 .cindex "&%isip%& expansion condition"
10383 .cindex "&%isip4%& expansion condition"
10384 .cindex "&%isip6%& expansion condition"
10385 The substring is first expanded, and then tested to see if it has the form of
10386 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10387 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10388
10389 For an IPv4 address, the test is for four dot-separated components, each of
10390 which consists of from one to three digits. For an IPv6 address, up to eight
10391 colon-separated components are permitted, each containing from one to four
10392 hexadecimal digits. There may be fewer than eight components if an empty
10393 component (adjacent colons) is present. Only one empty component is permitted.
10394
10395 &*Note*&: The checks are just on the form of the address; actual numerical
10396 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10397 check. The main use of these tests is to distinguish between IP addresses and
10398 host names, or between IPv4 and IPv6 addresses. For example, you could use
10399 .code
10400 ${if isip4{$sender_host_address}...
10401 .endd
10402 to test which IP version an incoming SMTP connection is using.
10403
10404 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10405 .cindex "LDAP" "use for authentication"
10406 .cindex "expansion" "LDAP authentication test"
10407 .cindex "&%ldapauth%& expansion condition"
10408 This condition supports user authentication using LDAP. See section
10409 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10410 queries. For this use, the query must contain a user name and password. The
10411 query itself is not used, and can be empty. The condition is true if the
10412 password is not empty, and the user name and password are accepted by the LDAP
10413 server. An empty password is rejected without calling LDAP because LDAP binds
10414 with an empty password are considered anonymous regardless of the username, and
10415 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10416 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10417 this can be used.
10418
10419
10420 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10421        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10422 .cindex "string" "comparison"
10423 .cindex "expansion" "string comparison"
10424 .cindex "&%le%& expansion condition"
10425 .cindex "&%lei%& expansion condition"
10426 The two substrings are first expanded. The condition is true if the first
10427 string is lexically less than or equal to the second string. For &%le%& the
10428 comparison includes the case of letters, whereas for &%lei%& the comparison is
10429 case-independent.
10430
10431 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10432        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10433 .cindex "string" "comparison"
10434 .cindex "expansion" "string comparison"
10435 .cindex "&%lt%& expansion condition"
10436 .cindex "&%lti%& expansion condition"
10437 The two substrings are first expanded. The condition is true if the first
10438 string is lexically less than the second string. For &%lt%& the comparison
10439 includes the case of letters, whereas for &%lti%& the comparison is
10440 case-independent.
10441
10442
10443 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10444 .cindex "expansion" "regular expression comparison"
10445 .cindex "regular expressions" "match in expanded string"
10446 .cindex "&%match%& expansion condition"
10447 The two substrings are first expanded. The second is then treated as a regular
10448 expression and applied to the first. Because of the pre-expansion, if the
10449 regular expression contains dollar, or backslash characters, they must be
10450 escaped. Care must also be taken if the regular expression contains braces
10451 (curly brackets). A closing brace must be escaped so that it is not taken as a
10452 premature termination of <&'string2'&>. The easiest approach is to use the
10453 &`\N`& feature to disable expansion of the regular expression.
10454 For example,
10455 .code
10456 ${if match {$local_part}{\N^\d{3}\N} ...
10457 .endd
10458 If the whole expansion string is in double quotes, further escaping of
10459 backslashes is also required.
10460
10461 The condition is true if the regular expression match succeeds.
10462 The regular expression is not required to begin with a circumflex
10463 metacharacter, but if there is no circumflex, the expression is not anchored,
10464 and it may match anywhere in the subject, not just at the start. If you want
10465 the pattern to match at the end of the subject, you must include the &`$`&
10466 metacharacter at an appropriate point.
10467
10468 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10469 At the start of an &%if%& expansion the values of the numeric variable
10470 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10471 succeeds causes them to be reset to the substrings of that condition and they
10472 will have these values during the expansion of the success string. At the end
10473 of the &%if%& expansion, the previous values are restored. After testing a
10474 combination of conditions using &%or%&, the subsequent values of the numeric
10475 variables are those of the condition that succeeded.
10476
10477 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10478 .cindex "&%match_address%& expansion condition"
10479 See &*match_local_part*&.
10480
10481 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10482 .cindex "&%match_domain%& expansion condition"
10483 See &*match_local_part*&.
10484
10485 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10486 .cindex "&%match_ip%& expansion condition"
10487 This condition matches an IP address to a list of IP address patterns. It must
10488 be followed by two argument strings. The first (after expansion) must be an IP
10489 address or an empty string. The second (not expanded) is a restricted host
10490 list that can match only an IP address, not a host name. For example:
10491 .code
10492 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10493 .endd
10494 The specific types of host list item that are permitted in the list are:
10495
10496 .ilist
10497 An IP address, optionally with a CIDR mask.
10498 .next
10499 A single asterisk, which matches any IP address.
10500 .next
10501 An empty item, which matches only if the IP address is empty. This could be
10502 useful for testing for a locally submitted message or one from specific hosts
10503 in a single test such as
10504 . ==== As this is a nested list, any displays it contains must be indented
10505 . ==== as otherwise they are too far to the left. This comment applies to
10506 . ==== the use of xmlto plus fop. There's no problem when formatting with
10507 . ==== sdop, with or without the extra indent.
10508 .code
10509   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10510 .endd
10511 where the first item in the list is the empty string.
10512 .next
10513 The item @[] matches any of the local host's interface addresses.
10514 .next
10515 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10516 even if &`net-`& is not specified. There is never any attempt to turn the IP
10517 address into a host name. The most common type of linear search for
10518 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10519 masks. For example:
10520 .code
10521   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10522 .endd
10523 It is of course possible to use other kinds of lookup, and in such a case, you
10524 do need to specify the &`net-`& prefix if you want to specify a specific
10525 address mask, for example:
10526 .code
10527   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10528 .endd
10529 However, unless you are combining a &%match_ip%& condition with others, it is
10530 just as easy to use the fact that a lookup is itself a condition, and write:
10531 .code
10532   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10533 .endd
10534 .endlist ilist
10535
10536 Note that <&'string2'&> is not itself subject to string expansion, unless
10537 Exim was built with the EXPAND_LISTMATCH_RHS option.
10538
10539 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10540
10541 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10542 .cindex "domain list" "in expansion condition"
10543 .cindex "address list" "in expansion condition"
10544 .cindex "local part" "list, in expansion condition"
10545 .cindex "&%match_local_part%& expansion condition"
10546 This condition, together with &%match_address%& and &%match_domain%&, make it
10547 possible to test domain, address, and local part lists within expansions. Each
10548 condition requires two arguments: an item and a list to match. A trivial
10549 example is:
10550 .code
10551 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10552 .endd
10553 In each case, the second argument may contain any of the allowable items for a
10554 list of the appropriate type. Also, because the second argument (after
10555 expansion) is a standard form of list, it is possible to refer to a named list.
10556 Thus, you can use conditions like this:
10557 .code
10558 ${if match_domain{$domain}{+local_domains}{...
10559 .endd
10560 .cindex "&`+caseful`&"
10561 For address lists, the matching starts off caselessly, but the &`+caseful`&
10562 item can be used, as in all address lists, to cause subsequent items to
10563 have their local parts matched casefully. Domains are always matched
10564 caselessly.
10565
10566 Note that <&'string2'&> is not itself subject to string expansion, unless
10567 Exim was built with the EXPAND_LISTMATCH_RHS option.
10568
10569 &*Note*&: Host lists are &'not'& supported in this way. This is because
10570 hosts have two identities: a name and an IP address, and it is not clear
10571 how to specify cleanly how such a test would work. However, IP addresses can be
10572 matched using &%match_ip%&.
10573
10574 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10575 .cindex "PAM authentication"
10576 .cindex "AUTH" "with PAM"
10577 .cindex "Solaris" "PAM support"
10578 .cindex "expansion" "PAM authentication test"
10579 .cindex "&%pam%& expansion condition"
10580 &'Pluggable Authentication Modules'&
10581 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10582 available in the latest releases of Solaris and in some GNU/Linux
10583 distributions. The Exim support, which is intended for use in conjunction with
10584 the SMTP AUTH command, is available only if Exim is compiled with
10585 .code
10586 SUPPORT_PAM=yes
10587 .endd
10588 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10589 in some releases of GNU/Linux &%-ldl%& is also needed.
10590
10591 The argument string is first expanded, and the result must be a
10592 colon-separated list of strings. Leading and trailing white space is ignored.
10593 The PAM module is initialized with the service name &"exim"& and the user name
10594 taken from the first item in the colon-separated data string (<&'string1'&>).
10595 The remaining items in the data string are passed over in response to requests
10596 from the authentication function. In the simple case there will only be one
10597 request, for a password, so the data consists of just two strings.
10598
10599 There can be problems if any of the strings are permitted to contain colon
10600 characters. In the usual way, these have to be doubled to avoid being taken as
10601 separators. If the data is being inserted from a variable, the &%sg%& expansion
10602 item can be used to double any existing colons. For example, the configuration
10603 of a LOGIN authenticator might contain this setting:
10604 .code
10605 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10606 .endd
10607 For a PLAIN authenticator you could use:
10608 .code
10609 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10610 .endd
10611 In some operating systems, PAM authentication can be done only from a process
10612 running as root. Since Exim is running as the Exim user when receiving
10613 messages, this means that PAM cannot be used directly in those systems.
10614 A patched version of the &'pam_unix'& module that comes with the
10615 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10616 The patched module allows one special uid/gid combination, in addition to root,
10617 to authenticate. If you build the patched module to allow the Exim user and
10618 group, PAM can then be used from an Exim authenticator.
10619
10620
10621 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10622 .cindex "&'pwcheck'& daemon"
10623 .cindex "Cyrus"
10624 .cindex "expansion" "&'pwcheck'& authentication test"
10625 .cindex "&%pwcheck%& expansion condition"
10626 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10627 This is one way of making it possible for passwords to be checked by a process
10628 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10629 deprecated. Its replacement is &'saslauthd'& (see below).
10630
10631 The pwcheck support is not included in Exim by default. You need to specify
10632 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10633 building Exim. For example:
10634 .code
10635 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10636 .endd
10637 You do not need to install the full Cyrus software suite in order to use
10638 the pwcheck daemon. You can compile and install just the daemon alone
10639 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10640 access to the &_/var/pwcheck_& directory.
10641
10642 The &%pwcheck%& condition takes one argument, which must be the user name and
10643 password, separated by a colon. For example, in a LOGIN authenticator
10644 configuration, you might have this:
10645 .code
10646 server_condition = ${if pwcheck{$auth1:$auth2}}
10647 .endd
10648 Again, for a PLAIN authenticator configuration, this would be:
10649 .code
10650 server_condition = ${if pwcheck{$auth2:$auth3}}
10651 .endd
10652 .vitem &*queue_running*&
10653 .cindex "queue runner" "detecting when delivering from"
10654 .cindex "expansion" "queue runner test"
10655 .cindex "&%queue_running%& expansion condition"
10656 This condition, which has no data, is true during delivery attempts that are
10657 initiated by queue runner processes, and false otherwise.
10658
10659
10660 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10661 .cindex "Radius"
10662 .cindex "expansion" "Radius authentication"
10663 .cindex "&%radius%& expansion condition"
10664 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10665 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10666 the Radius client configuration file in order to build Exim with Radius
10667 support.
10668
10669 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10670 library, using the original API. If you are using release 0.4.0 or later of
10671 this library, you need to set
10672 .code
10673 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10674 .endd
10675 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10676 &%libradius%& library that comes with FreeBSD. To do this, set
10677 .code
10678 RADIUS_LIB_TYPE=RADLIB
10679 .endd
10680 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10681 You may also have to supply a suitable setting in EXTRALIBS so that the
10682 Radius library can be found when Exim is linked.
10683
10684 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10685 Radius client library, which calls the Radius server. The condition is true if
10686 the authentication is successful. For example:
10687 .code
10688 server_condition = ${if radius{<arguments>}}
10689 .endd
10690
10691
10692 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10693         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10694 .cindex "&'saslauthd'& daemon"
10695 .cindex "Cyrus"
10696 .cindex "expansion" "&'saslauthd'& authentication test"
10697 .cindex "&%saslauthd%& expansion condition"
10698 This condition supports user authentication using the Cyrus &'saslauthd'&
10699 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10700 Using this daemon is one way of making it possible for passwords to be checked
10701 by a process that is not running as root.
10702
10703 The saslauthd support is not included in Exim by default. You need to specify
10704 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10705 building Exim. For example:
10706 .code
10707 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10708 .endd
10709 You do not need to install the full Cyrus software suite in order to use
10710 the saslauthd daemon. You can compile and install just the daemon alone
10711 from the Cyrus SASL library.
10712
10713 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10714 two are mandatory. For example:
10715 .code
10716 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10717 .endd
10718 The service and the realm are optional (which is why the arguments are enclosed
10719 in their own set of braces). For details of the meaning of the service and
10720 realm, and how to run the daemon, consult the Cyrus documentation.
10721 .endlist vlist
10722
10723
10724
10725 .section "Combining expansion conditions" "SECID84"
10726 .cindex "expansion" "combining conditions"
10727 Several conditions can be tested at once by combining them using the &%and%&
10728 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10729 conditions on their own, and precede their lists of sub-conditions. Each
10730 sub-condition must be enclosed in braces within the overall braces that contain
10731 the list. No repetition of &%if%& is used.
10732
10733
10734 .vlist
10735 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10736 .cindex "&""or""& expansion condition"
10737 .cindex "expansion" "&""or""& of conditions"
10738 The sub-conditions are evaluated from left to right. The condition is true if
10739 any one of the sub-conditions is true.
10740 For example,
10741 .code
10742 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10743 .endd
10744 When a true sub-condition is found, the following ones are parsed but not
10745 evaluated. If there are several &"match"& sub-conditions the values of the
10746 numeric variables afterwards are taken from the first one that succeeds.
10747
10748 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10749 .cindex "&""and""& expansion condition"
10750 .cindex "expansion" "&""and""& of conditions"
10751 The sub-conditions are evaluated from left to right. The condition is true if
10752 all of the sub-conditions are true. If there are several &"match"&
10753 sub-conditions, the values of the numeric variables afterwards are taken from
10754 the last one. When a false sub-condition is found, the following ones are
10755 parsed but not evaluated.
10756 .endlist
10757 .ecindex IIDexpcond
10758
10759
10760
10761
10762 .section "Expansion variables" "SECTexpvar"
10763 .cindex "expansion" "variables, list of"
10764 This section contains an alphabetical list of all the expansion variables. Some
10765 of them are available only when Exim is compiled with specific options such as
10766 support for TLS or the content scanning extension.
10767
10768 .vlist
10769 .vitem "&$0$&, &$1$&, etc"
10770 .cindex "numerical variables (&$1$& &$2$& etc)"
10771 When a &%match%& expansion condition succeeds, these variables contain the
10772 captured substrings identified by the regular expression during subsequent
10773 processing of the success string of the containing &%if%& expansion item.
10774 However, they do not retain their values afterwards; in fact, their previous
10775 values are restored at the end of processing an &%if%& item. The numerical
10776 variables may also be set externally by some other matching process which
10777 precedes the expansion of the string. For example, the commands available in
10778 Exim filter files include an &%if%& command with its own regular expression
10779 matching condition.
10780
10781 .vitem "&$acl_c...$&"
10782 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10783 can be given any name that starts with &$acl_c$& and is at least six characters
10784 long, but the sixth character must be either a digit or an underscore. For
10785 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10786 variables persist throughout the lifetime of an SMTP connection. They can be
10787 used to pass information between ACLs and between different invocations of the
10788 same ACL. When a message is received, the values of these variables are saved
10789 with the message, and can be accessed by filters, routers, and transports
10790 during subsequent delivery.
10791
10792 .vitem "&$acl_m...$&"
10793 These variables are like the &$acl_c...$& variables, except that their values
10794 are reset after a message has been received. Thus, if several messages are
10795 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10796 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10797 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10798 message is received, the values of these variables are saved with the message,
10799 and can be accessed by filters, routers, and transports during subsequent
10800 delivery.
10801
10802 .vitem &$acl_verify_message$&
10803 .vindex "&$acl_verify_message$&"
10804 After an address verification has failed, this variable contains the failure
10805 message. It retains its value for use in subsequent modifiers. The message can
10806 be preserved by coding like this:
10807 .code
10808 warn !verify = sender
10809      set acl_m0 = $acl_verify_message
10810 .endd
10811 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10812 &%log_message%& modifiers, to include information about the verification
10813 failure.
10814
10815 .vitem &$address_data$&
10816 .vindex "&$address_data$&"
10817 This variable is set by means of the &%address_data%& option in routers. The
10818 value then remains with the address while it is processed by subsequent routers
10819 and eventually a transport. If the transport is handling multiple addresses,
10820 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10821 for more details. &*Note*&: The contents of &$address_data$& are visible in
10822 user filter files.
10823
10824 If &$address_data$& is set when the routers are called from an ACL to verify
10825 a recipient address, the final value is still in the variable for subsequent
10826 conditions and modifiers of the ACL statement. If routing the address caused it
10827 to be redirected to just one address, the child address is also routed as part
10828 of the verification, and in this case the final value of &$address_data$& is
10829 from the child's routing.
10830
10831 If &$address_data$& is set when the routers are called from an ACL to verify a
10832 sender address, the final value is also preserved, but this time in
10833 &$sender_address_data$&, to distinguish it from data from a recipient
10834 address.
10835
10836 In both cases (recipient and sender verification), the value does not persist
10837 after the end of the current ACL statement. If you want to preserve
10838 these values for longer, you can save them in ACL variables.
10839
10840 .vitem &$address_file$&
10841 .vindex "&$address_file$&"
10842 When, as a result of aliasing, forwarding, or filtering, a message is directed
10843 to a specific file, this variable holds the name of the file when the transport
10844 is running. At other times, the variable is empty. For example, using the
10845 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10846 .code
10847 /home/r2d2/savemail
10848 .endd
10849 then when the &(address_file)& transport is running, &$address_file$&
10850 contains the text string &`/home/r2d2/savemail`&.
10851 .cindex "Sieve filter" "value of &$address_file$&"
10852 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10853 then up to the transport configuration to generate an appropriate absolute path
10854 to the relevant file.
10855
10856 .vitem &$address_pipe$&
10857 .vindex "&$address_pipe$&"
10858 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10859 this variable holds the pipe command when the transport is running.
10860
10861 .vitem "&$auth1$& &-- &$auth3$&"
10862 .vindex "&$auth1$&, &$auth2$&, etc"
10863 These variables are used in SMTP authenticators (see chapters
10864 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10865
10866 .vitem &$authenticated_id$&
10867 .cindex "authentication" "id"
10868 .vindex "&$authenticated_id$&"
10869 When a server successfully authenticates a client it may be configured to
10870 preserve some of the authentication information in the variable
10871 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10872 user/password authenticator configuration might preserve the user name for use
10873 in the routers. Note that this is not the same information that is saved in
10874 &$sender_host_authenticated$&.
10875 When a message is submitted locally (that is, not over a TCP connection)
10876 the value of &$authenticated_id$& is normally the login name of the calling
10877 process. However, a trusted user can override this by means of the &%-oMai%&
10878 command line option.
10879
10880 .vitem &$authenticated_fail_id$&
10881 .cindex "authentication" "fail" "id"
10882 .vindex "&$authenticated_fail_id$&"
10883 When an authentication attempt fails, the variable &$authenticated_fail_id$&
10884 will contain the failed authentication id. If more than one authentication
10885 id is attempted, it will contain only the last one. The variable is
10886 available for processing in the ACL's, generally the quit or notquit ACL.
10887 A message to a local recipient could still be accepted without requiring
10888 authentication, which means this variable could also be visible in all of
10889 the ACL's as well.
10890
10891
10892
10893 .vitem &$authenticated_sender$&
10894 .cindex "sender" "authenticated"
10895 .cindex "authentication" "sender"
10896 .cindex "AUTH" "on MAIL command"
10897 .vindex "&$authenticated_sender$&"
10898 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10899 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10900 described in section &<<SECTauthparamail>>&. Unless the data is the string
10901 &"<>"&, it is set as the authenticated sender of the message, and the value is
10902 available during delivery in the &$authenticated_sender$& variable. If the
10903 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10904
10905 .vindex "&$qualify_domain$&"
10906 When a message is submitted locally (that is, not over a TCP connection), the
10907 value of &$authenticated_sender$& is an address constructed from the login
10908 name of the calling process and &$qualify_domain$&, except that a trusted user
10909 can override this by means of the &%-oMas%& command line option.
10910
10911
10912 .vitem &$authentication_failed$&
10913 .cindex "authentication" "failure"
10914 .vindex "&$authentication_failed$&"
10915 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10916 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10917 possible to distinguish between &"did not try to authenticate"&
10918 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10919 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10920 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10921 negative response to an AUTH command, including (for example) an attempt to use
10922 an undefined mechanism.
10923
10924 .vitem &$av_failed$&
10925 .cindex "content scanning" "AV scanner failure"
10926 This variable is available when Exim is compiled with the content-scanning
10927 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10928 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10929 the ACL malware condition.
10930
10931 .vitem &$body_linecount$&
10932 .cindex "message body" "line count"
10933 .cindex "body of message" "line count"
10934 .vindex "&$body_linecount$&"
10935 When a message is being received or delivered, this variable contains the
10936 number of lines in the message's body. See also &$message_linecount$&.
10937
10938 .vitem &$body_zerocount$&
10939 .cindex "message body" "binary zero count"
10940 .cindex "body of message" "binary zero count"
10941 .cindex "binary zero" "in message body"
10942 .vindex "&$body_zerocount$&"
10943 When a message is being received or delivered, this variable contains the
10944 number of binary zero bytes (ASCII NULs) in the message's body.
10945
10946 .vitem &$bounce_recipient$&
10947 .vindex "&$bounce_recipient$&"
10948 This is set to the recipient address of a bounce message while Exim is creating
10949 it. It is useful if a customized bounce message text file is in use (see
10950 chapter &<<CHAPemsgcust>>&).
10951
10952 .vitem &$bounce_return_size_limit$&
10953 .vindex "&$bounce_return_size_limit$&"
10954 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10955 up to a multiple of 1000. It is useful when a customized error message text
10956 file is in use (see chapter &<<CHAPemsgcust>>&).
10957
10958 .vitem &$caller_gid$&
10959 .cindex "gid (group id)" "caller"
10960 .vindex "&$caller_gid$&"
10961 The real group id under which the process that called Exim was running. This is
10962 not the same as the group id of the originator of a message (see
10963 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10964 incarnation normally contains the Exim gid.
10965
10966 .vitem &$caller_uid$&
10967 .cindex "uid (user id)" "caller"
10968 .vindex "&$caller_uid$&"
10969 The real user id under which the process that called Exim was running. This is
10970 not the same as the user id of the originator of a message (see
10971 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10972 incarnation normally contains the Exim uid.
10973
10974 .vitem &$compile_date$&
10975 .vindex "&$compile_date$&"
10976 The date on which the Exim binary was compiled.
10977
10978 .vitem &$compile_number$&
10979 .vindex "&$compile_number$&"
10980 The building process for Exim keeps a count of the number
10981 of times it has been compiled. This serves to distinguish different
10982 compilations of the same version of the program.
10983
10984 .vitem &$demime_errorlevel$&
10985 .vindex "&$demime_errorlevel$&"
10986 This variable is available when Exim is compiled with
10987 the content-scanning extension and the obsolete &%demime%& condition. For
10988 details, see section &<<SECTdemimecond>>&.
10989
10990 .vitem &$demime_reason$&
10991 .vindex "&$demime_reason$&"
10992 This variable is available when Exim is compiled with the
10993 content-scanning extension and the obsolete &%demime%& condition. For details,
10994 see section &<<SECTdemimecond>>&.
10995
10996 .vitem &$dnslist_domain$& &&&
10997        &$dnslist_matched$& &&&
10998        &$dnslist_text$& &&&
10999        &$dnslist_value$&
11000 .vindex "&$dnslist_domain$&"
11001 .vindex "&$dnslist_matched$&"
11002 .vindex "&$dnslist_text$&"
11003 .vindex "&$dnslist_value$&"
11004 .cindex "black list (DNS)"
11005 When a DNS (black) list lookup succeeds, these variables are set to contain
11006 the following data from the lookup: the list's domain name, the key that was
11007 looked up, the contents of any associated TXT record, and the value from the
11008 main A record. See section &<<SECID204>>& for more details.
11009
11010 .vitem &$domain$&
11011 .vindex "&$domain$&"
11012 When an address is being routed, or delivered on its own, this variable
11013 contains the domain. Uppercase letters in the domain are converted into lower
11014 case for &$domain$&.
11015
11016 Global address rewriting happens when a message is received, so the value of
11017 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11018 is set during user filtering, but not during system filtering, because a
11019 message may have many recipients and the system filter is called just once.
11020
11021 When more than one address is being delivered at once (for example, several
11022 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11023 have the same domain. Transports can be restricted to handling only one domain
11024 at a time if the value of &$domain$& is required at transport time &-- this is
11025 the default for local transports. For further details of the environment in
11026 which local transports are run, see chapter &<<CHAPenvironment>>&.
11027
11028 .oindex "&%delay_warning_condition%&"
11029 At the end of a delivery, if all deferred addresses have the same domain, it is
11030 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11031
11032 The &$domain$& variable is also used in some other circumstances:
11033
11034 .ilist
11035 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11036 the recipient address. The domain of the &'sender'& address is in
11037 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11038 normally set during the running of the MAIL ACL. However, if the sender address
11039 is verified with a callout during the MAIL ACL, the sender domain is placed in
11040 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11041 the &(smtp)& transport.
11042
11043 .next
11044 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11045 &$domain$& contains the domain portion of the address that is being rewritten;
11046 it can be used in the expansion of the replacement address, for example, to
11047 rewrite domains by file lookup.
11048
11049 .next
11050 With one important exception, whenever a domain list is being scanned,
11051 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11052 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11053 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11054 that, in a RCPT ACL, the sender domain list can be dependent on the
11055 recipient domain (which is what is in &$domain$& at this time).
11056
11057 .next
11058 .cindex "ETRN" "value of &$domain$&"
11059 .oindex "&%smtp_etrn_command%&"
11060 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11061 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11062 .endlist
11063
11064
11065 .vitem &$domain_data$&
11066 .vindex "&$domain_data$&"
11067 When the &%domains%& option on a router matches a domain by
11068 means of a lookup, the data read by the lookup is available during the running
11069 of the router as &$domain_data$&. In addition, if the driver routes the
11070 address to a transport, the value is available in that transport. If the
11071 transport is handling multiple addresses, the value from the first address is
11072 used.
11073
11074 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11075 domain by means of a lookup. The data read by the lookup is available during
11076 the rest of the ACL statement. In all other situations, this variable expands
11077 to nothing.
11078
11079 .vitem &$exim_gid$&
11080 .vindex "&$exim_gid$&"
11081 This variable contains the numerical value of the Exim group id.
11082
11083 .vitem &$exim_path$&
11084 .vindex "&$exim_path$&"
11085 This variable contains the path to the Exim binary.
11086
11087 .vitem &$exim_uid$&
11088 .vindex "&$exim_uid$&"
11089 This variable contains the numerical value of the Exim user id.
11090
11091 .vitem &$found_extension$&
11092 .vindex "&$found_extension$&"
11093 This variable is available when Exim is compiled with the
11094 content-scanning extension and the obsolete &%demime%& condition. For details,
11095 see section &<<SECTdemimecond>>&.
11096
11097 .vitem &$header_$&<&'name'&>
11098 This is not strictly an expansion variable. It is expansion syntax for
11099 inserting the message header line with the given name. Note that the name must
11100 be terminated by colon or white space, because it may contain a wide variety of
11101 characters. Note also that braces must &'not'& be used.
11102
11103 .vitem &$headers_added$&
11104 .vindex "&$headers_added$&"
11105 Within an ACL this variable contains the headers added so far by
11106 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11107 The headers are a newline-separated list.
11108
11109 .vitem &$home$&
11110 .vindex "&$home$&"
11111 When the &%check_local_user%& option is set for a router, the user's home
11112 directory is placed in &$home$& when the check succeeds. In particular, this
11113 means it is set during the running of users' filter files. A router may also
11114 explicitly set a home directory for use by a transport; this can be overridden
11115 by a setting on the transport itself.
11116
11117 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11118 of the environment variable HOME.
11119
11120 .vitem &$host$&
11121 .vindex "&$host$&"
11122 If a router assigns an address to a transport (any transport), and passes a
11123 list of hosts with the address, the value of &$host$& when the transport starts
11124 to run is the name of the first host on the list. Note that this applies both
11125 to local and remote transports.
11126
11127 .cindex "transport" "filter"
11128 .cindex "filter" "transport filter"
11129 For the &(smtp)& transport, if there is more than one host, the value of
11130 &$host$& changes as the transport works its way through the list. In
11131 particular, when the &(smtp)& transport is expanding its options for encryption
11132 using TLS, or for specifying a transport filter (see chapter
11133 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11134 is connected.
11135
11136 When used in the client part of an authenticator configuration (see chapter
11137 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11138 client is connected.
11139
11140
11141 .vitem &$host_address$&
11142 .vindex "&$host_address$&"
11143 This variable is set to the remote host's IP address whenever &$host$& is set
11144 for a remote connection. It is also set to the IP address that is being checked
11145 when the &%ignore_target_hosts%& option is being processed.
11146
11147 .vitem &$host_data$&
11148 .vindex "&$host_data$&"
11149 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11150 result of the lookup is made available in the &$host_data$& variable. This
11151 allows you, for example, to do things like this:
11152 .code
11153 deny  hosts = net-lsearch;/some/file
11154 message = $host_data
11155 .endd
11156 .vitem &$host_lookup_deferred$&
11157 .cindex "host name" "lookup, failure of"
11158 .vindex "&$host_lookup_deferred$&"
11159 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11160 message comes from a remote host and there is an attempt to look up the host's
11161 name from its IP address, and the attempt is not successful, one of these
11162 variables is set to &"1"&.
11163
11164 .ilist
11165 If the lookup receives a definite negative response (for example, a DNS lookup
11166 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11167
11168 .next
11169 If there is any kind of problem during the lookup, such that Exim cannot
11170 tell whether or not the host name is defined (for example, a timeout for a DNS
11171 lookup), &$host_lookup_deferred$& is set to &"1"&.
11172 .endlist ilist
11173
11174 Looking up a host's name from its IP address consists of more than just a
11175 single reverse lookup. Exim checks that a forward lookup of at least one of the
11176 names it receives from a reverse lookup yields the original IP address. If this
11177 is not the case, Exim does not accept the looked up name(s), and
11178 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11179 IP address (for example, the existence of a PTR record in the DNS) is not
11180 sufficient on its own for the success of a host name lookup. If the reverse
11181 lookup succeeds, but there is a lookup problem such as a timeout when checking
11182 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11183 &"1"&. See also &$sender_host_name$&.
11184
11185 .vitem &$host_lookup_failed$&
11186 .vindex "&$host_lookup_failed$&"
11187 See &$host_lookup_deferred$&.
11188
11189
11190 .vitem &$inode$&
11191 .vindex "&$inode$&"
11192 The only time this variable is set is while expanding the &%directory_file%&
11193 option in the &(appendfile)& transport. The variable contains the inode number
11194 of the temporary file which is about to be renamed. It can be used to construct
11195 a unique name for the file.
11196
11197 .vitem &$interface_address$&
11198 .vindex "&$interface_address$&"
11199 This is an obsolete name for &$received_ip_address$&.
11200
11201 .vitem &$interface_port$&
11202 .vindex "&$interface_port$&"
11203 This is an obsolete name for &$received_port$&.
11204
11205 .vitem &$item$&
11206 .vindex "&$item$&"
11207 This variable is used during the expansion of &*forall*& and &*forany*&
11208 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11209 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11210 empty.
11211
11212 .vitem &$ldap_dn$&
11213 .vindex "&$ldap_dn$&"
11214 This variable, which is available only when Exim is compiled with LDAP support,
11215 contains the DN from the last entry in the most recently successful LDAP
11216 lookup.
11217
11218 .vitem &$load_average$&
11219 .vindex "&$load_average$&"
11220 This variable contains the system load average, multiplied by 1000 so that it
11221 is an integer. For example, if the load average is 0.21, the value of the
11222 variable is 210. The value is recomputed every time the variable is referenced.
11223
11224 .vitem &$local_part$&
11225 .vindex "&$local_part$&"
11226 When an address is being routed, or delivered on its own, this
11227 variable contains the local part. When a number of addresses are being
11228 delivered together (for example, multiple RCPT commands in an SMTP
11229 session), &$local_part$& is not set.
11230
11231 Global address rewriting happens when a message is received, so the value of
11232 &$local_part$& during routing and delivery is the value after rewriting.
11233 &$local_part$& is set during user filtering, but not during system filtering,
11234 because a message may have many recipients and the system filter is called just
11235 once.
11236
11237 .vindex "&$local_part_prefix$&"
11238 .vindex "&$local_part_suffix$&"
11239 If a local part prefix or suffix has been recognized, it is not included in the
11240 value of &$local_part$& during routing and subsequent delivery. The values of
11241 any prefix or suffix are in &$local_part_prefix$& and
11242 &$local_part_suffix$&, respectively.
11243
11244 When a message is being delivered to a file, pipe, or autoreply transport as a
11245 result of aliasing or forwarding, &$local_part$& is set to the local part of
11246 the parent address, not to the file name or command (see &$address_file$& and
11247 &$address_pipe$&).
11248
11249 When an ACL is running for a RCPT command, &$local_part$& contains the
11250 local part of the recipient address.
11251
11252 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11253 &$local_part$& contains the local part of the address that is being rewritten;
11254 it can be used in the expansion of the replacement address, for example.
11255
11256 In all cases, all quoting is removed from the local part. For example, for both
11257 the addresses
11258 .code
11259 "abc:xyz"@test.example
11260 abc\:xyz@test.example
11261 .endd
11262 the value of &$local_part$& is
11263 .code
11264 abc:xyz
11265 .endd
11266 If you use &$local_part$& to create another address, you should always wrap it
11267 inside a quoting operator. For example, in a &(redirect)& router you could
11268 have:
11269 .code
11270 data = ${quote_local_part:$local_part}@new.domain.example
11271 .endd
11272 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11273 to process local parts in a case-dependent manner in a router, you can set the
11274 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11275
11276 .vitem &$local_part_data$&
11277 .vindex "&$local_part_data$&"
11278 When the &%local_parts%& option on a router matches a local part by means of a
11279 lookup, the data read by the lookup is available during the running of the
11280 router as &$local_part_data$&. In addition, if the driver routes the address
11281 to a transport, the value is available in that transport. If the transport is
11282 handling multiple addresses, the value from the first address is used.
11283
11284 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11285 matches a local part by means of a lookup. The data read by the lookup is
11286 available during the rest of the ACL statement. In all other situations, this
11287 variable expands to nothing.
11288
11289 .vitem &$local_part_prefix$&
11290 .vindex "&$local_part_prefix$&"
11291 When an address is being routed or delivered, and a
11292 specific prefix for the local part was recognized, it is available in this
11293 variable, having been removed from &$local_part$&.
11294
11295 .vitem &$local_part_suffix$&
11296 .vindex "&$local_part_suffix$&"
11297 When an address is being routed or delivered, and a
11298 specific suffix for the local part was recognized, it is available in this
11299 variable, having been removed from &$local_part$&.
11300
11301 .vitem &$local_scan_data$&
11302 .vindex "&$local_scan_data$&"
11303 This variable contains the text returned by the &[local_scan()]& function when
11304 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11305
11306 .vitem &$local_user_gid$&
11307 .vindex "&$local_user_gid$&"
11308 See &$local_user_uid$&.
11309
11310 .vitem &$local_user_uid$&
11311 .vindex "&$local_user_uid$&"
11312 This variable and &$local_user_gid$& are set to the uid and gid after the
11313 &%check_local_user%& router precondition succeeds. This means that their values
11314 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11315 and &%condition%&), for the &%address_data%& expansion, and for any
11316 router-specific expansions. At all other times, the values in these variables
11317 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11318
11319 .vitem &$localhost_number$&
11320 .vindex "&$localhost_number$&"
11321 This contains the expanded value of the
11322 &%localhost_number%& option. The expansion happens after the main options have
11323 been read.
11324
11325 .vitem &$log_inodes$&
11326 .vindex "&$log_inodes$&"
11327 The number of free inodes in the disk partition where Exim's
11328 log files are being written. The value is recalculated whenever the variable is
11329 referenced. If the relevant file system does not have the concept of inodes,
11330 the value of is -1. See also the &%check_log_inodes%& option.
11331
11332 .vitem &$log_space$&
11333 .vindex "&$log_space$&"
11334 The amount of free space (as a number of kilobytes) in the disk
11335 partition where Exim's log files are being written. The value is recalculated
11336 whenever the variable is referenced. If the operating system does not have the
11337 ability to find the amount of free space (only true for experimental systems),
11338 the space value is -1. See also the &%check_log_space%& option.
11339
11340
11341 .vitem &$mailstore_basename$&
11342 .vindex "&$mailstore_basename$&"
11343 This variable is set only when doing deliveries in &"mailstore"& format in the
11344 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11345 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11346 contains the basename of the files that are being written, that is, the name
11347 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11348 variable is empty.
11349
11350 .vitem &$malware_name$&
11351 .vindex "&$malware_name$&"
11352 This variable is available when Exim is compiled with the
11353 content-scanning extension. It is set to the name of the virus that was found
11354 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11355
11356 .vitem &$max_received_linelength$&
11357 .vindex "&$max_received_linelength$&"
11358 .cindex "maximum" "line length"
11359 .cindex "line length" "maximum"
11360 This variable contains the number of bytes in the longest line that was
11361 received as part of the message, not counting the line termination
11362 character(s).
11363
11364 .vitem &$message_age$&
11365 .cindex "message" "age of"
11366 .vindex "&$message_age$&"
11367 This variable is set at the start of a delivery attempt to contain the number
11368 of seconds since the message was received. It does not change during a single
11369 delivery attempt.
11370
11371 .vitem &$message_body$&
11372 .cindex "body of message" "expansion variable"
11373 .cindex "message body" "in expansion"
11374 .cindex "binary zero" "in message body"
11375 .vindex "&$message_body$&"
11376 .oindex "&%message_body_visible%&"
11377 This variable contains the initial portion of a message's body while it is
11378 being delivered, and is intended mainly for use in filter files. The maximum
11379 number of characters of the body that are put into the variable is set by the
11380 &%message_body_visible%& configuration option; the default is 500.
11381
11382 .oindex "&%message_body_newlines%&"
11383 By default, newlines are converted into spaces in &$message_body$&, to make it
11384 easier to search for phrases that might be split over a line break. However,
11385 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11386 zeros are always converted into spaces.
11387
11388 .vitem &$message_body_end$&
11389 .cindex "body of message" "expansion variable"
11390 .cindex "message body" "in expansion"
11391 .vindex "&$message_body_end$&"
11392 This variable contains the final portion of a message's
11393 body while it is being delivered. The format and maximum size are as for
11394 &$message_body$&.
11395
11396 .vitem &$message_body_size$&
11397 .cindex "body of message" "size"
11398 .cindex "message body" "size"
11399 .vindex "&$message_body_size$&"
11400 When a message is being delivered, this variable contains the size of the body
11401 in bytes. The count starts from the character after the blank line that
11402 separates the body from the header. Newlines are included in the count. See
11403 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11404
11405 .vitem &$message_exim_id$&
11406 .vindex "&$message_exim_id$&"
11407 When a message is being received or delivered, this variable contains the
11408 unique message id that is generated and used by Exim to identify the message.
11409 An id is not created for a message until after its header has been successfully
11410 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11411 line; it is the local id that Exim assigns to the message, for example:
11412 &`1BXTIK-0001yO-VA`&.
11413
11414 .vitem &$message_headers$&
11415 .vindex &$message_headers$&
11416 This variable contains a concatenation of all the header lines when a message
11417 is being processed, except for lines added by routers or transports. The header
11418 lines are separated by newline characters. Their contents are decoded in the
11419 same way as a header line that is inserted by &%bheader%&.
11420
11421 .vitem &$message_headers_raw$&
11422 .vindex &$message_headers_raw$&
11423 This variable is like &$message_headers$& except that no processing of the
11424 contents of header lines is done.
11425
11426 .vitem &$message_id$&
11427 This is an old name for &$message_exim_id$&, which is now deprecated.
11428
11429 .vitem &$message_linecount$&
11430 .vindex "&$message_linecount$&"
11431 This variable contains the total number of lines in the header and body of the
11432 message. Compare &$body_linecount$&, which is the count for the body only.
11433 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11434 number of lines received. Before delivery happens (that is, before filters,
11435 routers, and transports run) the count is increased to include the
11436 &'Received:'& header line that Exim standardly adds, and also any other header
11437 lines that are added by ACLs. The blank line that separates the message header
11438 from the body is not counted.
11439
11440 As with the special case of &$message_size$&, during the expansion of the
11441 appendfile transport's maildir_tag option in maildir format, the value of
11442 &$message_linecount$& is the precise size of the number of newlines in the
11443 file that has been written (minus one for the blank line between the
11444 header and the body).
11445
11446 Here is an example of the use of this variable in a DATA ACL:
11447 .code
11448 deny message   = Too many lines in message header
11449      condition = \
11450       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11451 .endd
11452 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11453 message has not yet been received.
11454
11455 .vitem &$message_size$&
11456 .cindex "size" "of message"
11457 .cindex "message" "size"
11458 .vindex "&$message_size$&"
11459 When a message is being processed, this variable contains its size in bytes. In
11460 most cases, the size includes those headers that were received with the
11461 message, but not those (such as &'Envelope-to:'&) that are added to individual
11462 deliveries as they are written. However, there is one special case: during the
11463 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11464 doing a delivery in maildir format, the value of &$message_size$& is the
11465 precise size of the file that has been written. See also
11466 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11467
11468 .cindex "RCPT" "value of &$message_size$&"
11469 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11470 contains the size supplied on the MAIL command, or -1 if no size was given. The
11471 value may not, of course, be truthful.
11472
11473 .vitem &$mime_$&&'xxx'&
11474 A number of variables whose names start with &$mime$& are
11475 available when Exim is compiled with the content-scanning extension. For
11476 details, see section &<<SECTscanmimepart>>&.
11477
11478 .vitem "&$n0$& &-- &$n9$&"
11479 These variables are counters that can be incremented by means
11480 of the &%add%& command in filter files.
11481
11482 .vitem &$original_domain$&
11483 .vindex "&$domain$&"
11484 .vindex "&$original_domain$&"
11485 When a top-level address is being processed for delivery, this contains the
11486 same value as &$domain$&. However, if a &"child"& address (for example,
11487 generated by an alias, forward, or filter file) is being processed, this
11488 variable contains the domain of the original address (lower cased). This
11489 differs from &$parent_domain$& only when there is more than one level of
11490 aliasing or forwarding. When more than one address is being delivered in a
11491 single transport run, &$original_domain$& is not set.
11492
11493 If a new address is created by means of a &%deliver%& command in a system
11494 filter, it is set up with an artificial &"parent"& address. This has the local
11495 part &'system-filter'& and the default qualify domain.
11496
11497 .vitem &$original_local_part$&
11498 .vindex "&$local_part$&"
11499 .vindex "&$original_local_part$&"
11500 When a top-level address is being processed for delivery, this contains the
11501 same value as &$local_part$&, unless a prefix or suffix was removed from the
11502 local part, because &$original_local_part$& always contains the full local
11503 part. When a &"child"& address (for example, generated by an alias, forward, or
11504 filter file) is being processed, this variable contains the full local part of
11505 the original address.
11506
11507 If the router that did the redirection processed the local part
11508 case-insensitively, the value in &$original_local_part$& is in lower case.
11509 This variable differs from &$parent_local_part$& only when there is more than
11510 one level of aliasing or forwarding. When more than one address is being
11511 delivered in a single transport run, &$original_local_part$& is not set.
11512
11513 If a new address is created by means of a &%deliver%& command in a system
11514 filter, it is set up with an artificial &"parent"& address. This has the local
11515 part &'system-filter'& and the default qualify domain.
11516
11517 .vitem &$originator_gid$&
11518 .cindex "gid (group id)" "of originating user"
11519 .cindex "sender" "gid"
11520 .vindex "&$caller_gid$&"
11521 .vindex "&$originator_gid$&"
11522 This variable contains the value of &$caller_gid$& that was set when the
11523 message was received. For messages received via the command line, this is the
11524 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11525 normally the gid of the Exim user.
11526
11527 .vitem &$originator_uid$&
11528 .cindex "uid (user id)" "of originating user"
11529 .cindex "sender" "uid"
11530 .vindex "&$caller_uid$&"
11531 .vindex "&$originaltor_uid$&"
11532 The value of &$caller_uid$& that was set when the message was received. For
11533 messages received via the command line, this is the uid of the sending user.
11534 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11535 user.
11536
11537 .vitem &$parent_domain$&
11538 .vindex "&$parent_domain$&"
11539 This variable is similar to &$original_domain$& (see
11540 above), except that it refers to the immediately preceding parent address.
11541
11542 .vitem &$parent_local_part$&
11543 .vindex "&$parent_local_part$&"
11544 This variable is similar to &$original_local_part$&
11545 (see above), except that it refers to the immediately preceding parent address.
11546
11547 .vitem &$pid$&
11548 .cindex "pid (process id)" "of current process"
11549 .vindex "&$pid$&"
11550 This variable contains the current process id.
11551
11552 .vitem &$pipe_addresses$&
11553 .cindex "filter" "transport filter"
11554 .cindex "transport" "filter"
11555 .vindex "&$pipe_addresses$&"
11556 This is not an expansion variable, but is mentioned here because the string
11557 &`$pipe_addresses`& is handled specially in the command specification for the
11558 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11559 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11560 It cannot be used in general expansion strings, and provokes an &"unknown
11561 variable"& error if encountered.
11562
11563 .vitem &$primary_hostname$&
11564 .vindex "&$primary_hostname$&"
11565 This variable contains the value set by &%primary_hostname%& in the
11566 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11567 a single-component name, Exim calls &[gethostbyname()]& (or
11568 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11569 qualified host name. See also &$smtp_active_hostname$&.
11570
11571
11572 .vitem &$prvscheck_address$&
11573 This variable is used in conjunction with the &%prvscheck%& expansion item,
11574 which is described in sections &<<SECTexpansionitems>>& and
11575 &<<SECTverifyPRVS>>&.
11576
11577 .vitem &$prvscheck_keynum$&
11578 This variable is used in conjunction with the &%prvscheck%& expansion item,
11579 which is described in sections &<<SECTexpansionitems>>& and
11580 &<<SECTverifyPRVS>>&.
11581
11582 .vitem &$prvscheck_result$&
11583 This variable is used in conjunction with the &%prvscheck%& expansion item,
11584 which is described in sections &<<SECTexpansionitems>>& and
11585 &<<SECTverifyPRVS>>&.
11586
11587 .vitem &$qualify_domain$&
11588 .vindex "&$qualify_domain$&"
11589 The value set for the &%qualify_domain%& option in the configuration file.
11590
11591 .vitem &$qualify_recipient$&
11592 .vindex "&$qualify_recipient$&"
11593 The value set for the &%qualify_recipient%& option in the configuration file,
11594 or if not set, the value of &$qualify_domain$&.
11595
11596 .vitem &$rcpt_count$&
11597 .vindex "&$rcpt_count$&"
11598 When a message is being received by SMTP, this variable contains the number of
11599 RCPT commands received for the current message. If this variable is used in a
11600 RCPT ACL, its value includes the current command.
11601
11602 .vitem &$rcpt_defer_count$&
11603 .vindex "&$rcpt_defer_count$&"
11604 .cindex "4&'xx'& responses" "count of"
11605 When a message is being received by SMTP, this variable contains the number of
11606 RCPT commands in the current message that have previously been rejected with a
11607 temporary (4&'xx'&) response.
11608
11609 .vitem &$rcpt_fail_count$&
11610 .vindex "&$rcpt_fail_count$&"
11611 When a message is being received by SMTP, this variable contains the number of
11612 RCPT commands in the current message that have previously been rejected with a
11613 permanent (5&'xx'&) response.
11614
11615 .vitem &$received_count$&
11616 .vindex "&$received_count$&"
11617 This variable contains the number of &'Received:'& header lines in the message,
11618 including the one added by Exim (so its value is always greater than zero). It
11619 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11620 delivering.
11621
11622 .vitem &$received_for$&
11623 .vindex "&$received_for$&"
11624 If there is only a single recipient address in an incoming message, this
11625 variable contains that address when the &'Received:'& header line is being
11626 built. The value is copied after recipient rewriting has happened, but before
11627 the &[local_scan()]& function is run.
11628
11629 .vitem &$received_ip_address$&
11630 .vindex "&$received_ip_address$&"
11631 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11632 variable is set to the address of the local IP interface, and &$received_port$&
11633 is set to the local port number. (The remote IP address and port are in
11634 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11635 the port value is -1 unless it has been set using the &%-oMi%& command line
11636 option.
11637
11638 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11639 could be used, for example, to make the file name for a TLS certificate depend
11640 on which interface and/or port is being used for the incoming connection. The
11641 values of &$received_ip_address$& and &$received_port$& are saved with any
11642 messages that are received, thus making these variables available at delivery
11643 time.
11644
11645 &*Note:*& There are no equivalent variables for outgoing connections, because
11646 the values are unknown (unless they are explicitly set by options of the
11647 &(smtp)& transport).
11648
11649 .vitem &$received_port$&
11650 .vindex "&$received_port$&"
11651 See &$received_ip_address$&.
11652
11653 .vitem &$received_protocol$&
11654 .vindex "&$received_protocol$&"
11655 When a message is being processed, this variable contains the name of the
11656 protocol by which it was received. Most of the names used by Exim are defined
11657 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11658 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11659 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11660 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11661 connection and the client was successfully authenticated.
11662
11663 Exim uses the protocol name &"smtps"& for the case when encryption is
11664 automatically set up on connection without the use of STARTTLS (see
11665 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11666 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11667 where the client initially uses EHLO, sets up an encrypted connection using
11668 STARTTLS, and then uses HELO afterwards.
11669
11670 The &%-oMr%& option provides a way of specifying a custom protocol name for
11671 messages that are injected locally by trusted callers. This is commonly used to
11672 identify messages that are being re-injected after some kind of scanning.
11673
11674 .vitem &$received_time$&
11675 .vindex "&$received_time$&"
11676 This variable contains the date and time when the current message was received,
11677 as a number of seconds since the start of the Unix epoch.
11678
11679 .vitem &$recipient_data$&
11680 .vindex "&$recipient_data$&"
11681 This variable is set after an indexing lookup success in an ACL &%recipients%&
11682 condition. It contains the data from the lookup, and the value remains set
11683 until the next &%recipients%& test. Thus, you can do things like this:
11684 .display
11685 &`require recipients  = cdb*@;/some/file`&
11686 &`deny    `&&'some further test involving'& &`$recipient_data`&
11687 .endd
11688 &*Warning*&: This variable is set only when a lookup is used as an indexing
11689 method in the address list, using the semicolon syntax as in the example above.
11690 The variable is not set for a lookup that is used as part of the string
11691 expansion that all such lists undergo before being interpreted.
11692
11693 .vitem &$recipient_verify_failure$&
11694 .vindex "&$recipient_verify_failure$&"
11695 In an ACL, when a recipient verification fails, this variable contains
11696 information about the failure. It is set to one of the following words:
11697
11698 .ilist
11699 &"qualify"&: The address was unqualified (no domain), and the message
11700 was neither local nor came from an exempted host.
11701
11702 .next
11703 &"route"&: Routing failed.
11704
11705 .next
11706 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11707 or before the MAIL command (that is, on initial connection, HELO, or
11708 MAIL).
11709
11710 .next
11711 &"recipient"&: The RCPT command in a callout was rejected.
11712 .next
11713
11714 &"postmaster"&: The postmaster check in a callout was rejected.
11715 .endlist
11716
11717 The main use of this variable is expected to be to distinguish between
11718 rejections of MAIL and rejections of RCPT.
11719
11720 .vitem &$recipients$&
11721 .vindex "&$recipients$&"
11722 This variable contains a list of envelope recipients for a message. A comma and
11723 a space separate the addresses in the replacement text. However, the variable
11724 is not generally available, to prevent exposure of Bcc recipients in
11725 unprivileged users' filter files. You can use &$recipients$& only in these
11726 cases:
11727
11728 .olist
11729 In a system filter file.
11730 .next
11731 In the ACLs associated with the DATA command and with non-SMTP messages, that
11732 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11733 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11734 &%acl_not_smtp_mime%&.
11735 .next
11736 From within a &[local_scan()]& function.
11737 .endlist
11738
11739
11740 .vitem &$recipients_count$&
11741 .vindex "&$recipients_count$&"
11742 When a message is being processed, this variable contains the number of
11743 envelope recipients that came with the message. Duplicates are not excluded
11744 from the count. While a message is being received over SMTP, the number
11745 increases for each accepted recipient. It can be referenced in an ACL.
11746
11747
11748 .vitem &$regex_match_string$&
11749 .vindex "&$regex_match_string$&"
11750 This variable is set to contain the matching regular expression after a
11751 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11752
11753
11754 .vitem &$reply_address$&
11755 .vindex "&$reply_address$&"
11756 When a message is being processed, this variable contains the contents of the
11757 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11758 contents of the &'From:'& header line. Apart from the removal of leading
11759 white space, the value is not processed in any way. In particular, no RFC 2047
11760 decoding or character code translation takes place.
11761
11762 .vitem &$return_path$&
11763 .vindex "&$return_path$&"
11764 When a message is being delivered, this variable contains the return path &--
11765 the sender field that will be sent as part of the envelope. It is not enclosed
11766 in <> characters. At the start of routing an address, &$return_path$& has the
11767 same value as &$sender_address$&, but if, for example, an incoming message to a
11768 mailing list has been expanded by a router which specifies a different address
11769 for bounce messages, &$return_path$& subsequently contains the new bounce
11770 address, whereas &$sender_address$& always contains the original sender address
11771 that was received with the message. In other words, &$sender_address$& contains
11772 the incoming envelope sender, and &$return_path$& contains the outgoing
11773 envelope sender.
11774
11775 .vitem &$return_size_limit$&
11776 .vindex "&$return_size_limit$&"
11777 This is an obsolete name for &$bounce_return_size_limit$&.
11778
11779 .vitem &$router_name$&
11780 .cindex "router" "name"
11781 .cindex "name" "of router"
11782 .vindex "&$router_name$&"
11783 During the running of a router this variable contains its name.
11784
11785 .vitem &$runrc$&
11786 .cindex "return code" "from &%run%& expansion"
11787 .vindex "&$runrc$&"
11788 This variable contains the return code from a command that is run by the
11789 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11790 assume the order in which option values are expanded, except for those
11791 preconditions whose order of testing is documented. Therefore, you cannot
11792 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11793 another.
11794
11795 .vitem &$self_hostname$&
11796 .oindex "&%self%&" "value of host name"
11797 .vindex "&$self_hostname$&"
11798 When an address is routed to a supposedly remote host that turns out to be the
11799 local host, what happens is controlled by the &%self%& generic router option.
11800 One of its values causes the address to be passed to another router. When this
11801 happens, &$self_hostname$& is set to the name of the local host that the
11802 original router encountered. In other circumstances its contents are null.
11803
11804 .vitem &$sender_address$&
11805 .vindex "&$sender_address$&"
11806 When a message is being processed, this variable contains the sender's address
11807 that was received in the message's envelope. The case of letters in the address
11808 is retained, in both the local part and the domain. For bounce messages, the
11809 value of this variable is the empty string. See also &$return_path$&.
11810
11811 .vitem &$sender_address_data$&
11812 .vindex "&$address_data$&"
11813 .vindex "&$sender_address_data$&"
11814 If &$address_data$& is set when the routers are called from an ACL to verify a
11815 sender address, the final value is preserved in &$sender_address_data$&, to
11816 distinguish it from data from a recipient address. The value does not persist
11817 after the end of the current ACL statement. If you want to preserve it for
11818 longer, you can save it in an ACL variable.
11819
11820 .vitem &$sender_address_domain$&
11821 .vindex "&$sender_address_domain$&"
11822 The domain portion of &$sender_address$&.
11823
11824 .vitem &$sender_address_local_part$&
11825 .vindex "&$sender_address_local_part$&"
11826 The local part portion of &$sender_address$&.
11827
11828 .vitem &$sender_data$&
11829 .vindex "&$sender_data$&"
11830 This variable is set after a lookup success in an ACL &%senders%& condition or
11831 in a router &%senders%& option. It contains the data from the lookup, and the
11832 value remains set until the next &%senders%& test. Thus, you can do things like
11833 this:
11834 .display
11835 &`require senders      = cdb*@;/some/file`&
11836 &`deny    `&&'some further test involving'& &`$sender_data`&
11837 .endd
11838 &*Warning*&: This variable is set only when a lookup is used as an indexing
11839 method in the address list, using the semicolon syntax as in the example above.
11840 The variable is not set for a lookup that is used as part of the string
11841 expansion that all such lists undergo before being interpreted.
11842
11843 .vitem &$sender_fullhost$&
11844 .vindex "&$sender_fullhost$&"
11845 When a message is received from a remote host, this variable contains the host
11846 name and IP address in a single string. It ends with the IP address in square
11847 brackets, followed by a colon and a port number if the logging of ports is
11848 enabled. The format of the rest of the string depends on whether the host
11849 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11850 looking up its IP address. (Looking up the IP address can be forced by the
11851 &%host_lookup%& option, independent of verification.) A plain host name at the
11852 start of the string is a verified host name; if this is not present,
11853 verification either failed or was not requested. A host name in parentheses is
11854 the argument of a HELO or EHLO command. This is omitted if it is identical to
11855 the verified host name or to the host's IP address in square brackets.
11856
11857 .vitem &$sender_helo_name$&
11858 .vindex "&$sender_helo_name$&"
11859 When a message is received from a remote host that has issued a HELO or EHLO
11860 command, the argument of that command is placed in this variable. It is also
11861 set if HELO or EHLO is used when a message is received using SMTP locally via
11862 the &%-bs%& or &%-bS%& options.
11863
11864 .vitem &$sender_host_address$&
11865 .vindex "&$sender_host_address$&"
11866 When a message is received from a remote host, this variable contains that
11867 host's IP address. For locally submitted messages, it is empty.
11868
11869 .vitem &$sender_host_authenticated$&
11870 .vindex "&$sender_host_authenticated$&"
11871 This variable contains the name (not the public name) of the authenticator
11872 driver that successfully authenticated the client from which the message was
11873 received. It is empty if there was no successful authentication. See also
11874 &$authenticated_id$&.
11875
11876 .new
11877 .vitem &$sender_host_dnssec$&
11878 .vindex "&$sender_host_dnssec$&"
11879 If &$sender_host_name$& has been populated (by reference, &%hosts_lookup%& or
11880 otherwise) then this boolean will have been set true if, and only if, the
11881 resolver library states that the reverse DNS was authenticated data.  At all
11882 other times, this variable is false.
11883
11884 It is likely that you will need to coerce DNSSEC support on in the resolver
11885 library, by setting:
11886 .code
11887 dns_use_dnssec = 1
11888 .endd
11889
11890 Exim does not perform DNSSEC validation itself, instead leaving that to a
11891 validating resolver (eg, unbound, or bind with suitable configuration).
11892
11893 Exim does not (currently) check to see if the forward DNS was also secured
11894 with DNSSEC, only the reverse DNS.
11895
11896 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
11897 mechanism in the list, then this variable will be false.
11898 .wen
11899
11900
11901 .vitem &$sender_host_name$&
11902 .vindex "&$sender_host_name$&"
11903 When a message is received from a remote host, this variable contains the
11904 host's name as obtained by looking up its IP address. For messages received by
11905 other means, this variable is empty.
11906
11907 .vindex "&$host_lookup_failed$&"
11908 If the host name has not previously been looked up, a reference to
11909 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11910 A looked up name is accepted only if it leads back to the original IP address
11911 via a forward lookup. If either the reverse or the forward lookup fails to find
11912 any data, or if the forward lookup does not yield the original IP address,
11913 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11914
11915 .vindex "&$host_lookup_deferred$&"
11916 However, if either of the lookups cannot be completed (for example, there is a
11917 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11918 &$host_lookup_failed$& remains set to &"0"&.
11919
11920 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11921 host name again if there is a subsequent reference to &$sender_host_name$&
11922 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11923 is set to &"1"&.
11924
11925 Exim does not automatically look up every calling host's name. If you want
11926 maximum efficiency, you should arrange your configuration so that it avoids
11927 these lookups altogether. The lookup happens only if one or more of the
11928 following are true:
11929
11930 .ilist
11931 A string containing &$sender_host_name$& is expanded.
11932 .next
11933 The calling host matches the list in &%host_lookup%&. In the default
11934 configuration, this option is set to *, so it must be changed if lookups are
11935 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11936 .next
11937 Exim needs the host name in order to test an item in a host list. The items
11938 that require this are described in sections &<<SECThoslispatnam>>& and
11939 &<<SECThoslispatnamsk>>&.
11940 .next
11941 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11942 In this case, the host name is required to compare with the name quoted in any
11943 EHLO or HELO commands that the client issues.
11944 .next
11945 The remote host issues a EHLO or HELO command that quotes one of the
11946 domains in &%helo_lookup_domains%&. The default value of this option is
11947 . ==== As this is a nested list, any displays it contains must be indented
11948 . ==== as otherwise they are too far to the left.
11949 .code
11950   helo_lookup_domains = @ : @[]
11951 .endd
11952 which causes a lookup if a remote host (incorrectly) gives the server's name or
11953 IP address in an EHLO or HELO command.
11954 .endlist
11955
11956
11957 .vitem &$sender_host_port$&
11958 .vindex "&$sender_host_port$&"
11959 When a message is received from a remote host, this variable contains the port
11960 number that was used on the remote host.
11961
11962 .vitem &$sender_ident$&
11963 .vindex "&$sender_ident$&"
11964 When a message is received from a remote host, this variable contains the
11965 identification received in response to an RFC 1413 request. When a message has
11966 been received locally, this variable contains the login name of the user that
11967 called Exim.
11968
11969 .vitem &$sender_rate_$&&'xxx'&
11970 A number of variables whose names begin &$sender_rate_$& are set as part of the
11971 &%ratelimit%& ACL condition. Details are given in section
11972 &<<SECTratelimiting>>&.
11973
11974 .vitem &$sender_rcvhost$&
11975 .cindex "DNS" "reverse lookup"
11976 .cindex "reverse DNS lookup"
11977 .vindex "&$sender_rcvhost$&"
11978 This is provided specifically for use in &'Received:'& headers. It starts with
11979 either the verified host name (as obtained from a reverse DNS lookup) or, if
11980 there is no verified host name, the IP address in square brackets. After that
11981 there may be text in parentheses. When the first item is a verified host name,
11982 the first thing in the parentheses is the IP address in square brackets,
11983 followed by a colon and a port number if port logging is enabled. When the
11984 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11985 the parentheses.
11986
11987 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11988 was used and its argument was not identical to the real host name or IP
11989 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11990 all three items are present in the parentheses, a newline and tab are inserted
11991 into the string, to improve the formatting of the &'Received:'& header.
11992
11993 .vitem &$sender_verify_failure$&
11994 .vindex "&$sender_verify_failure$&"
11995 In an ACL, when a sender verification fails, this variable contains information
11996 about the failure. The details are the same as for
11997 &$recipient_verify_failure$&.
11998
11999 .vitem &$sending_ip_address$&
12000 .vindex "&$sending_ip_address$&"
12001 This variable is set whenever an outgoing SMTP connection to another host has
12002 been set up. It contains the IP address of the local interface that is being
12003 used. This is useful if a host that has more than one IP address wants to take
12004 on different personalities depending on which one is being used. For incoming
12005 connections, see &$received_ip_address$&.
12006
12007 .vitem &$sending_port$&
12008 .vindex "&$sending_port$&"
12009 This variable is set whenever an outgoing SMTP connection to another host has
12010 been set up. It contains the local port that is being used. For incoming
12011 connections, see &$received_port$&.
12012
12013 .vitem &$smtp_active_hostname$&
12014 .vindex "&$smtp_active_hostname$&"
12015 During an incoming SMTP session, this variable contains the value of the active
12016 host name, as specified by the &%smtp_active_hostname%& option. The value of
12017 &$smtp_active_hostname$& is saved with any message that is received, so its
12018 value can be consulted during routing and delivery.
12019
12020 .vitem &$smtp_command$&
12021 .vindex "&$smtp_command$&"
12022 During the processing of an incoming SMTP command, this variable contains the
12023 entire command. This makes it possible to distinguish between HELO and EHLO in
12024 the HELO ACL, and also to distinguish between commands such as these:
12025 .code
12026 MAIL FROM:<>
12027 MAIL FROM: <>
12028 .endd
12029 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12030 command, the address in &$smtp_command$& is the original address before any
12031 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12032 the address after SMTP-time rewriting.
12033
12034 .vitem &$smtp_command_argument$&
12035 .cindex "SMTP" "command, argument for"
12036 .vindex "&$smtp_command_argument$&"
12037 While an ACL is running to check an SMTP command, this variable contains the
12038 argument, that is, the text that follows the command name, with leading white
12039 space removed. Following the introduction of &$smtp_command$&, this variable is
12040 somewhat redundant, but is retained for backwards compatibility.
12041
12042 .vitem &$smtp_count_at_connection_start$&
12043 .vindex "&$smtp_count_at_connection_start$&"
12044 This variable is set greater than zero only in processes spawned by the Exim
12045 daemon for handling incoming SMTP connections. The name is deliberately long,
12046 in order to emphasize what the contents are. When the daemon accepts a new
12047 connection, it increments this variable. A copy of the variable is passed to
12048 the child process that handles the connection, but its value is fixed, and
12049 never changes. It is only an approximation of how many incoming connections
12050 there actually are, because many other connections may come and go while a
12051 single connection is being processed. When a child process terminates, the
12052 daemon decrements its copy of the variable.
12053
12054 .vitem "&$sn0$& &-- &$sn9$&"
12055 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12056 that were current at the end of the system filter file. This allows a system
12057 filter file to set values that can be tested in users' filter files. For
12058 example, a system filter could set a value indicating how likely it is that a
12059 message is junk mail.
12060
12061 .vitem &$spam_$&&'xxx'&
12062 A number of variables whose names start with &$spam$& are available when Exim
12063 is compiled with the content-scanning extension. For details, see section
12064 &<<SECTscanspamass>>&.
12065
12066
12067 .vitem &$spool_directory$&
12068 .vindex "&$spool_directory$&"
12069 The name of Exim's spool directory.
12070
12071 .vitem &$spool_inodes$&
12072 .vindex "&$spool_inodes$&"
12073 The number of free inodes in the disk partition where Exim's spool files are
12074 being written. The value is recalculated whenever the variable is referenced.
12075 If the relevant file system does not have the concept of inodes, the value of
12076 is -1. See also the &%check_spool_inodes%& option.
12077
12078 .vitem &$spool_space$&
12079 .vindex "&$spool_space$&"
12080 The amount of free space (as a number of kilobytes) in the disk partition where
12081 Exim's spool files are being written. The value is recalculated whenever the
12082 variable is referenced. If the operating system does not have the ability to
12083 find the amount of free space (only true for experimental systems), the space
12084 value is -1. For example, to check in an ACL that there is at least 50
12085 megabytes free on the spool, you could write:
12086 .code
12087 condition = ${if > {$spool_space}{50000}}
12088 .endd
12089 See also the &%check_spool_space%& option.
12090
12091
12092 .vitem &$thisaddress$&
12093 .vindex "&$thisaddress$&"
12094 This variable is set only during the processing of the &%foranyaddress%&
12095 command in a filter file. Its use is explained in the description of that
12096 command, which can be found in the separate document entitled &'Exim's
12097 interfaces to mail filtering'&.
12098
12099 .vitem &$tls_in_bits$&
12100 .vindex "&$tls_in_bits$&"
12101 Contains an approximation of the TLS cipher's bit-strength
12102 on the inbound connection; the meaning of
12103 this depends upon the TLS implementation used.
12104 If TLS has not been negotiated, the value will be 0.
12105 The value of this is automatically fed into the Cyrus SASL authenticator
12106 when acting as a server, to specify the "external SSF" (a SASL term).
12107
12108 The deprecated &$tls_bits$& variable refers to the inbound side
12109 except when used in the context of an outbound SMTP delivery, when it refers to
12110 the outbound.
12111
12112 .vitem &$tls_out_bits$&
12113 .vindex "&$tls_out_bits$&"
12114 Contains an approximation of the TLS cipher's bit-strength
12115 on an outbound SMTP connection; the meaning of
12116 this depends upon the TLS implementation used.
12117 If TLS has not been negotiated, the value will be 0.
12118
12119 .vitem &$tls_in_certificate_verified$&
12120 .vindex "&$tls_in_certificate_verified$&"
12121 This variable is set to &"1"& if a TLS certificate was verified when the
12122 message was received, and &"0"& otherwise.
12123
12124 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12125 except when used in the context of an outbound SMTP delivery, when it refers to
12126 the outbound.
12127
12128 .vitem &$tls_out_certificate_verified$&
12129 .vindex "&$tls_out_certificate_verified$&"
12130 This variable is set to &"1"& if a TLS certificate was verified when an
12131 outbound SMTP connection was made,
12132 and &"0"& otherwise.
12133
12134 .vitem &$tls_in_cipher$&
12135 .vindex "&$tls_in_cipher$&"
12136 .vindex "&$tls_cipher$&"
12137 When a message is received from a remote host over an encrypted SMTP
12138 connection, this variable is set to the cipher suite that was negotiated, for
12139 example DES-CBC3-SHA. In other circumstances, in particular, for message
12140 received over unencrypted connections, the variable is empty. Testing
12141 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12142 non-encrypted connections during ACL processing.
12143
12144 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12145 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12146 becomes the same as &$tls_out_cipher$&.
12147
12148 .vitem &$tls_out_cipher$&
12149 .vindex "&$tls_out_cipher$&"
12150 This variable is
12151 cleared before any outgoing SMTP connection is made,
12152 and then set to the outgoing cipher suite if one is negotiated. See chapter
12153 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12154 details of the &(smtp)& transport.
12155
12156 .vitem &$tls_in_peerdn$&
12157 .vindex "&$tls_in_peerdn$&"
12158 .vindex "&$tls_peerdn$&"
12159 When a message is received from a remote host over an encrypted SMTP
12160 connection, and Exim is configured to request a certificate from the client,
12161 the value of the Distinguished Name of the certificate is made available in the
12162 &$tls_in_peerdn$& during subsequent processing.
12163
12164 The deprecated &$tls_peerdn$& variable refers to the inbound side
12165 except when used in the context of an outbound SMTP delivery, when it refers to
12166 the outbound.
12167
12168 .vitem &$tls_out_peerdn$&
12169 .vindex "&$tls_out_peerdn$&"
12170 When a message is being delivered to a remote host over an encrypted SMTP
12171 connection, and Exim is configured to request a certificate from the server,
12172 the value of the Distinguished Name of the certificate is made available in the
12173 &$tls_out_peerdn$& during subsequent processing.
12174
12175 .vitem &$tls_in_sni$&
12176 .vindex "&$tls_in_sni$&"
12177 .vindex "&$tls_sni$&"
12178 .cindex "TLS" "Server Name Indication"
12179 When a TLS session is being established, if the client sends the Server
12180 Name Indication extension, the value will be placed in this variable.
12181 If the variable appears in &%tls_certificate%& then this option and
12182 some others, described in &<<SECTtlssni>>&,
12183 will be re-expanded early in the TLS session, to permit
12184 a different certificate to be presented (and optionally a different key to be
12185 used) to the client, based upon the value of the SNI extension.
12186
12187 The deprecated &$tls_sni$& variable refers to the inbound side
12188 except when used in the context of an outbound SMTP delivery, when it refers to
12189 the outbound.
12190
12191 .vitem &$tls_out_sni$&
12192 .vindex "&$tls_out_sni$&"
12193 .cindex "TLS" "Server Name Indication"
12194 During outbound
12195 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12196 the transport.
12197
12198 .vitem &$tod_bsdinbox$&
12199 .vindex "&$tod_bsdinbox$&"
12200 The time of day and the date, in the format required for BSD-style mailbox
12201 files, for example: Thu Oct 17 17:14:09 1995.
12202
12203 .vitem &$tod_epoch$&
12204 .vindex "&$tod_epoch$&"
12205 The time and date as a number of seconds since the start of the Unix epoch.
12206
12207 .vitem &$tod_epoch_l$&
12208 .vindex "&$tod_epoch_l$&"
12209 The time and date as a number of microseconds since the start of the Unix epoch.
12210
12211 .vitem &$tod_full$&
12212 .vindex "&$tod_full$&"
12213 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12214 +0100. The timezone is always given as a numerical offset from UTC, with
12215 positive values used for timezones that are ahead (east) of UTC, and negative
12216 values for those that are behind (west).
12217
12218 .vitem &$tod_log$&
12219 .vindex "&$tod_log$&"
12220 The time and date in the format used for writing Exim's log files, for example:
12221 1995-10-12 15:32:29, but without a timezone.
12222
12223 .vitem &$tod_logfile$&
12224 .vindex "&$tod_logfile$&"
12225 This variable contains the date in the format yyyymmdd. This is the format that
12226 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12227 flag.
12228
12229 .vitem &$tod_zone$&
12230 .vindex "&$tod_zone$&"
12231 This variable contains the numerical value of the local timezone, for example:
12232 -0500.
12233
12234 .vitem &$tod_zulu$&
12235 .vindex "&$tod_zulu$&"
12236 This variable contains the UTC date and time in &"Zulu"& format, as specified
12237 by ISO 8601, for example: 20030221154023Z.
12238
12239 .vitem &$transport_name$&
12240 .cindex "transport" "name"
12241 .cindex "name" "of transport"
12242 .vindex "&$transport_name$&"
12243 During the running of a transport, this variable contains its name.
12244
12245 .vitem &$value$&
12246 .vindex "&$value$&"
12247 This variable contains the result of an expansion lookup, extraction operation,
12248 or external command, as described above. It is also used during a
12249 &*reduce*& expansion.
12250
12251 .vitem &$version_number$&
12252 .vindex "&$version_number$&"
12253 The version number of Exim.
12254
12255 .vitem &$warn_message_delay$&
12256 .vindex "&$warn_message_delay$&"
12257 This variable is set only during the creation of a message warning about a
12258 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12259
12260 .vitem &$warn_message_recipients$&
12261 .vindex "&$warn_message_recipients$&"
12262 This variable is set only during the creation of a message warning about a
12263 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12264 .endlist
12265 .ecindex IIDstrexp
12266
12267
12268
12269 . ////////////////////////////////////////////////////////////////////////////
12270 . ////////////////////////////////////////////////////////////////////////////
12271
12272 .chapter "Embedded Perl" "CHAPperl"
12273 .scindex IIDperl "Perl" "calling from Exim"
12274 Exim can be built to include an embedded Perl interpreter. When this is done,
12275 Perl subroutines can be called as part of the string expansion process. To make
12276 use of the Perl support, you need version 5.004 or later of Perl installed on
12277 your system. To include the embedded interpreter in the Exim binary, include
12278 the line
12279 .code
12280 EXIM_PERL = perl.o
12281 .endd
12282 in your &_Local/Makefile_& and then build Exim in the normal way.
12283
12284
12285 .section "Setting up so Perl can be used" "SECID85"
12286 .oindex "&%perl_startup%&"
12287 Access to Perl subroutines is via a global configuration option called
12288 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12289 no &%perl_startup%& option in the Exim configuration file then no Perl
12290 interpreter is started and there is almost no overhead for Exim (since none of
12291 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12292 option then the associated value is taken to be Perl code which is executed in
12293 a newly created Perl interpreter.
12294
12295 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12296 need backslashes before any characters to escape special meanings. The option
12297 should usually be something like
12298 .code
12299 perl_startup = do '/etc/exim.pl'
12300 .endd
12301 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12302 use from Exim. Exim can be configured either to start up a Perl interpreter as
12303 soon as it is entered, or to wait until the first time it is needed. Starting
12304 the interpreter at the beginning ensures that it is done while Exim still has
12305 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12306 fact used in a particular run. Also, note that this does not mean that Exim is
12307 necessarily running as root when Perl is called at a later time. By default,
12308 the interpreter is started only when it is needed, but this can be changed in
12309 two ways:
12310
12311 .ilist
12312 .oindex "&%perl_at_start%&"
12313 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12314 a startup when Exim is entered.
12315 .next
12316 The command line option &%-ps%& also requests a startup when Exim is entered,
12317 overriding the setting of &%perl_at_start%&.
12318 .endlist
12319
12320 There is also a command line option &%-pd%& (for delay) which suppresses the
12321 initial startup, even if &%perl_at_start%& is set.
12322
12323
12324 .section "Calling Perl subroutines" "SECID86"
12325 When the configuration file includes a &%perl_startup%& option you can make use
12326 of the string expansion item to call the Perl subroutines that are defined
12327 by the &%perl_startup%& code. The operator is used in any of the following
12328 forms:
12329 .code
12330 ${perl{foo}}
12331 ${perl{foo}{argument}}
12332 ${perl{foo}{argument1}{argument2} ... }
12333 .endd
12334 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12335 arguments may be passed. Passing more than this results in an expansion failure
12336 with an error message of the form
12337 .code
12338 Too many arguments passed to Perl subroutine "foo" (max is 8)
12339 .endd
12340 The return value of the Perl subroutine is evaluated in a scalar context before
12341 it is passed back to Exim to be inserted into the expanded string. If the
12342 return value is &'undef'&, the expansion is forced to fail in the same way as
12343 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12344 by obeying Perl's &%die%& function, the expansion fails with the error message
12345 that was passed to &%die%&.
12346
12347
12348 .section "Calling Exim functions from Perl" "SECID87"
12349 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12350 is available to call back into Exim's string expansion function. For example,
12351 the Perl code
12352 .code
12353 my $lp = Exim::expand_string('$local_part');
12354 .endd
12355 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12356 Note those are single quotes and not double quotes to protect against
12357 &$local_part$& being interpolated as a Perl variable.
12358
12359 If the string expansion is forced to fail by a &"fail"& item, the result of
12360 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12361 expansion string, the Perl call from the original expansion string fails with
12362 an appropriate error message, in the same way as if &%die%& were used.
12363
12364 .cindex "debugging" "from embedded Perl"
12365 .cindex "log" "writing from embedded Perl"
12366 Two other Exim functions are available for use from within Perl code.
12367 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12368 debugging is enabled. If you want a newline at the end, you must supply it.
12369 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12370 timestamp. In this case, you should not supply a terminating newline.
12371
12372
12373 .section "Use of standard output and error by Perl" "SECID88"
12374 .cindex "Perl" "standard output and error"
12375 You should not write to the standard error or output streams from within your
12376 Perl code, as it is not defined how these are set up. In versions of Exim
12377 before 4.50, it is possible for the standard output or error to refer to the
12378 SMTP connection during message reception via the daemon. Writing to this stream
12379 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12380 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12381 avoided, but the output is lost.
12382
12383 .cindex "Perl" "use of &%warn%&"
12384 The Perl &%warn%& statement writes to the standard error stream by default.
12385 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12386 you have no control. When Exim starts up the Perl interpreter, it arranges for
12387 output from the &%warn%& statement to be written to the Exim main log. You can
12388 change this by including appropriate Perl magic somewhere in your Perl code.
12389 For example, to discard &%warn%& output completely, you need this:
12390 .code
12391 $SIG{__WARN__} = sub { };
12392 .endd
12393 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12394 example, the code for the subroutine is empty, so it does nothing, but you can
12395 include any Perl code that you like. The text of the &%warn%& message is passed
12396 as the first subroutine argument.
12397 .ecindex IIDperl
12398
12399
12400 . ////////////////////////////////////////////////////////////////////////////
12401 . ////////////////////////////////////////////////////////////////////////////
12402
12403 .chapter "Starting the daemon and the use of network interfaces" &&&
12404          "CHAPinterfaces" &&&
12405          "Starting the daemon"
12406 .cindex "daemon" "starting"
12407 .cindex "interface" "listening"
12408 .cindex "network interface"
12409 .cindex "interface" "network"
12410 .cindex "IP address" "for listening"
12411 .cindex "daemon" "listening IP addresses"
12412 .cindex "TCP/IP" "setting listening interfaces"
12413 .cindex "TCP/IP" "setting listening ports"
12414 A host that is connected to a TCP/IP network may have one or more physical
12415 hardware network interfaces. Each of these interfaces may be configured as one
12416 or more &"logical"& interfaces, which are the entities that a program actually
12417 works with. Each of these logical interfaces is associated with an IP address.
12418 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12419 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12420 knowledge about the host's interfaces for use in three different circumstances:
12421
12422 .olist
12423 When a listening daemon is started, Exim needs to know which interfaces
12424 and ports to listen on.
12425 .next
12426 When Exim is routing an address, it needs to know which IP addresses
12427 are associated with local interfaces. This is required for the correct
12428 processing of MX lists by removing the local host and others with the
12429 same or higher priority values. Also, Exim needs to detect cases
12430 when an address is routed to an IP address that in fact belongs to the
12431 local host. Unless the &%self%& router option or the &%allow_localhost%&
12432 option of the smtp transport is set (as appropriate), this is treated
12433 as an error situation.
12434 .next
12435 When Exim connects to a remote host, it may need to know which interface to use
12436 for the outgoing connection.
12437 .endlist
12438
12439
12440 Exim's default behaviour is likely to be appropriate in the vast majority
12441 of cases. If your host has only one interface, and you want all its IP
12442 addresses to be treated in the same way, and you are using only the
12443 standard SMTP port, you should not need to take any special action. The
12444 rest of this chapter does not apply to you.
12445
12446 In a more complicated situation you may want to listen only on certain
12447 interfaces, or on different ports, and for this reason there are a number of
12448 options that can be used to influence Exim's behaviour. The rest of this
12449 chapter describes how they operate.
12450
12451 When a message is received over TCP/IP, the interface and port that were
12452 actually used are set in &$received_ip_address$& and &$received_port$&.
12453
12454
12455
12456 .section "Starting a listening daemon" "SECID89"
12457 When a listening daemon is started (by means of the &%-bd%& command line
12458 option), the interfaces and ports on which it listens are controlled by the
12459 following options:
12460
12461 .ilist
12462 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12463 compatibility, this option can also be specified in the singular.)
12464 .next
12465 &%local_interfaces%& contains list of interface IP addresses on which to
12466 listen. Each item may optionally also specify a port.
12467 .endlist
12468
12469 The default list separator in both cases is a colon, but this can be changed as
12470 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12471 it is usually best to change the separator to avoid having to double all the
12472 colons. For example:
12473 .code
12474 local_interfaces = <; 127.0.0.1 ; \
12475                       192.168.23.65 ; \
12476                       ::1 ; \
12477                       3ffe:ffff:836f::fe86:a061
12478 .endd
12479 There are two different formats for specifying a port along with an IP address
12480 in &%local_interfaces%&:
12481
12482 .olist
12483 The port is added onto the address with a dot separator. For example, to listen
12484 on port 1234 on two different IP addresses:
12485 .code
12486 local_interfaces = <; 192.168.23.65.1234 ; \
12487                       3ffe:ffff:836f::fe86:a061.1234
12488 .endd
12489 .next
12490 The IP address is enclosed in square brackets, and the port is added
12491 with a colon separator, for example:
12492 .code
12493 local_interfaces = <; [192.168.23.65]:1234 ; \
12494                       [3ffe:ffff:836f::fe86:a061]:1234
12495 .endd
12496 .endlist
12497
12498 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12499 default setting contains just one port:
12500 .code
12501 daemon_smtp_ports = smtp
12502 .endd
12503 If more than one port is listed, each interface that does not have its own port
12504 specified listens on all of them. Ports that are listed in
12505 &%daemon_smtp_ports%& can be identified either by name (defined in
12506 &_/etc/services_&) or by number. However, when ports are given with individual
12507 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12508
12509
12510
12511 .section "Special IP listening addresses" "SECID90"
12512 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12513 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12514 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12515 instead of setting up separate listening sockets for each interface. The
12516 default value of &%local_interfaces%& is
12517 .code
12518 local_interfaces = 0.0.0.0
12519 .endd
12520 when Exim is built without IPv6 support; otherwise it is:
12521 .code
12522 local_interfaces = <; ::0 ; 0.0.0.0
12523 .endd
12524 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12525
12526
12527
12528 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12529 The &%-oX%& command line option can be used to override the values of
12530 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12531 instance. Another way of doing this would be to use macros and the &%-D%&
12532 option. However, &%-oX%& can be used by any admin user, whereas modification of
12533 the runtime configuration by &%-D%& is allowed only when the caller is root or
12534 exim.
12535
12536 The value of &%-oX%& is a list of items. The default colon separator can be
12537 changed in the usual way if required. If there are any items that do not
12538 contain dots or colons (that is, are not IP addresses), the value of
12539 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12540 items that do contain dots or colons, the value of &%local_interfaces%& is
12541 replaced by those items. Thus, for example,
12542 .code
12543 -oX 1225
12544 .endd
12545 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12546 whereas
12547 .code
12548 -oX 192.168.34.5.1125
12549 .endd
12550 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12551 (However, since &%local_interfaces%& now contains no items without ports, the
12552 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12553
12554
12555
12556 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12557 .cindex "ssmtp protocol"
12558 .cindex "smtps protocol"
12559 .cindex "SMTP" "ssmtp protocol"
12560 .cindex "SMTP" "smtps protocol"
12561 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12562 before the STARTTLS command was standardized for SMTP. Some legacy clients
12563 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12564 list of port numbers, connections to those ports must use SSMTP. The most
12565 common use of this option is expected to be
12566 .code
12567 tls_on_connect_ports = 465
12568 .endd
12569 because 465 is the usual port number used by the legacy clients. There is also
12570 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12571 this way when a daemon is started.
12572
12573 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12574 daemon to listen on those ports. You must still specify them in
12575 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12576 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12577 connections via the daemon.)
12578
12579
12580
12581
12582 .section "IPv6 address scopes" "SECID92"
12583 .cindex "IPv6" "address scopes"
12584 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12585 can, in principle, have the same link-local IPv6 address on different
12586 interfaces. Thus, additional information is needed, over and above the IP
12587 address, to distinguish individual interfaces. A convention of using a
12588 percent sign followed by something (often the interface name) has been
12589 adopted in some cases, leading to addresses like this:
12590 .code
12591 fe80::202:b3ff:fe03:45c1%eth0
12592 .endd
12593 To accommodate this usage, a percent sign followed by an arbitrary string is
12594 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12595 to convert a textual IPv6 address for actual use. This function recognizes the
12596 percent convention in operating systems that support it, and it processes the
12597 address appropriately. Unfortunately, some older libraries have problems with
12598 &[getaddrinfo()]&. If
12599 .code
12600 IPV6_USE_INET_PTON=yes
12601 .endd
12602 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12603 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12604 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12605 function.) Of course, this means that the additional functionality of
12606 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12607
12608 .section "Disabling IPv6" "SECID93"
12609 .cindex "IPv6" "disabling"
12610 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12611 run on a host whose kernel does not support IPv6. The binary will fall back to
12612 using IPv4, but it may waste resources looking up AAAA records, and trying to
12613 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12614 .oindex "&%disable_ipv6%&"
12615 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12616 activities take place. AAAA records are never looked up, and any IPv6 addresses
12617 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12618 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12619 to handle IPv6 literal addresses.
12620
12621 On the other hand, when IPv6 is in use, there may be times when you want to
12622 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12623 option to globally suppress the lookup of AAAA records for specified domains,
12624 and you can use the &%ignore_target_hosts%& generic router option to ignore
12625 IPv6 addresses in an individual router.
12626
12627
12628
12629 .section "Examples of starting a listening daemon" "SECID94"
12630 The default case in an IPv6 environment is
12631 .code
12632 daemon_smtp_ports = smtp
12633 local_interfaces = <; ::0 ; 0.0.0.0
12634 .endd
12635 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12636 Either one or two sockets may be used, depending on the characteristics of
12637 the TCP/IP stack. (This is complicated and messy; for more information,
12638 read the comments in the &_daemon.c_& source file.)
12639
12640 To specify listening on ports 25 and 26 on all interfaces:
12641 .code
12642 daemon_smtp_ports = 25 : 26
12643 .endd
12644 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12645 .code
12646 local_interfaces = <; ::0.25     ; ::0.26 \
12647                       0.0.0.0.25 ; 0.0.0.0.26
12648 .endd
12649 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12650 IPv4 loopback address only:
12651 .code
12652 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12653 .endd
12654 To specify listening on the default port on specific interfaces only:
12655 .code
12656 local_interfaces = 10.0.0.67 : 192.168.34.67
12657 .endd
12658 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12659
12660
12661
12662 .section "Recognizing the local host" "SECTreclocipadd"
12663 The &%local_interfaces%& option is also used when Exim needs to determine
12664 whether or not an IP address refers to the local host. That is, the IP
12665 addresses of all the interfaces on which a daemon is listening are always
12666 treated as local.
12667
12668 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12669 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12670 available interfaces from the operating system, and extracts the relevant
12671 (that is, IPv4 or IPv6) addresses to use for checking.
12672
12673 Some systems set up large numbers of virtual interfaces in order to provide
12674 many virtual web servers. In this situation, you may want to listen for
12675 email on only a few of the available interfaces, but nevertheless treat all
12676 interfaces as local when routing. You can do this by setting
12677 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12678 &"all"& wildcard values. These addresses are recognized as local, but are not
12679 used for listening. Consider this example:
12680 .code
12681 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12682                       192.168.53.235 ; \
12683                       3ffe:2101:12:1:a00:20ff:fe86:a061
12684
12685 extra_local_interfaces = <; ::0 ; 0.0.0.0
12686 .endd
12687 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12688 address, but all available interface addresses are treated as local when
12689 Exim is routing.
12690
12691 In some environments the local host name may be in an MX list, but with an IP
12692 address that is not assigned to any local interface. In other cases it may be
12693 desirable to treat other host names as if they referred to the local host. Both
12694 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12695 This contains host names rather than IP addresses. When a host is referenced
12696 during routing, either via an MX record or directly, it is treated as the local
12697 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12698 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12699
12700
12701
12702 .section "Delivering to a remote host" "SECID95"
12703 Delivery to a remote host is handled by the smtp transport. By default, it
12704 allows the system's TCP/IP functions to choose which interface to use (if
12705 there is more than one) when connecting to a remote host. However, the
12706 &%interface%& option can be set to specify which interface is used. See the
12707 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12708 details.
12709
12710
12711
12712
12713 . ////////////////////////////////////////////////////////////////////////////
12714 . ////////////////////////////////////////////////////////////////////////////
12715
12716 .chapter "Main configuration" "CHAPmainconfig"
12717 .scindex IIDconfima "configuration file" "main section"
12718 .scindex IIDmaiconf "main configuration"
12719 The first part of the run time configuration file contains three types of item:
12720
12721 .ilist
12722 Macro definitions: These lines start with an upper case letter. See section
12723 &<<SECTmacrodefs>>& for details of macro processing.
12724 .next
12725 Named list definitions: These lines start with one of the words &"domainlist"&,
12726 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12727 section &<<SECTnamedlists>>&.
12728 .next
12729 Main configuration settings: Each setting occupies one line of the file
12730 (with possible continuations). If any setting is preceded by the word
12731 &"hide"&, the &%-bP%& command line option displays its value to admin users
12732 only. See section &<<SECTcos>>& for a description of the syntax of these option
12733 settings.
12734 .endlist
12735
12736 This chapter specifies all the main configuration options, along with their
12737 types and default values. For ease of finding a particular option, they appear
12738 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12739 are now so many options, they are first listed briefly in functional groups, as
12740 an aid to finding the name of the option you are looking for. Some options are
12741 listed in more than one group.
12742
12743 .section "Miscellaneous" "SECID96"
12744 .table2
12745 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12746 .row &%disable_ipv6%&                "do no IPv6 processing"
12747 .row &%keep_malformed%&              "for broken files &-- should not happen"
12748 .row &%localhost_number%&            "for unique message ids in clusters"
12749 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12750 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12751 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12752 .row &%print_topbitchars%&           "top-bit characters are printing"
12753 .row &%timezone%&                    "force time zone"
12754 .endtable
12755
12756
12757 .section "Exim parameters" "SECID97"
12758 .table2
12759 .row &%exim_group%&                  "override compiled-in value"
12760 .row &%exim_path%&                   "override compiled-in value"
12761 .row &%exim_user%&                   "override compiled-in value"
12762 .row &%primary_hostname%&            "default from &[uname()]&"
12763 .row &%split_spool_directory%&       "use multiple directories"
12764 .row &%spool_directory%&             "override compiled-in value"
12765 .endtable
12766
12767
12768
12769 .section "Privilege controls" "SECID98"
12770 .table2
12771 .row &%admin_groups%&                "groups that are Exim admin users"
12772 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12773 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12774 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12775 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12776 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12777 .row &%never_users%&                 "do not run deliveries as these"
12778 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12779 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12780 .row &%trusted_groups%&              "groups that are trusted"
12781 .row &%trusted_users%&               "users that are trusted"
12782 .endtable
12783
12784
12785
12786 .section "Logging" "SECID99"
12787 .table2
12788 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12789 .row &%log_file_path%&               "override compiled-in value"
12790 .row &%log_selector%&                "set/unset optional logging"
12791 .row &%log_timezone%&                "add timezone to log lines"
12792 .row &%message_logs%&                "create per-message logs"
12793 .row &%preserve_message_logs%&       "after message completion"
12794 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12795 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12796 .row &%syslog_facility%&             "set syslog &""facility""& field"
12797 .row &%syslog_processname%&          "set syslog &""ident""& field"
12798 .row &%syslog_timestamp%&            "timestamp syslog lines"
12799 .row &%write_rejectlog%&             "control use of message log"
12800 .endtable
12801
12802
12803
12804 .section "Frozen messages" "SECID100"
12805 .table2
12806 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12807 .row &%freeze_tell%&                 "send message when freezing"
12808 .row &%move_frozen_messages%&        "to another directory"
12809 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12810 .endtable
12811
12812
12813
12814 .section "Data lookups" "SECID101"
12815 .table2
12816 .row &%ibase_servers%&               "InterBase servers"
12817 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12818 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12819 .row &%ldap_cert_file%&              "client cert file for LDAP"
12820 .row &%ldap_cert_key%&               "client key file for LDAP"
12821 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12822 .row &%ldap_default_servers%&        "used if no server in query"
12823 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12824 .row &%ldap_start_tls%&              "require TLS within LDAP"
12825 .row &%ldap_version%&                "set protocol version"
12826 .row &%lookup_open_max%&             "lookup files held open"
12827 .row &%mysql_servers%&               "default MySQL servers"
12828 .row &%oracle_servers%&              "Oracle servers"
12829 .row &%pgsql_servers%&               "default PostgreSQL servers"
12830 .row &%sqlite_lock_timeout%&         "as it says"
12831 .endtable
12832
12833
12834
12835 .section "Message ids" "SECID102"
12836 .table2
12837 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12838 .row &%message_id_header_text%&      "ditto"
12839 .endtable
12840
12841
12842
12843 .section "Embedded Perl Startup" "SECID103"
12844 .table2
12845 .row &%perl_at_start%&               "always start the interpreter"
12846 .row &%perl_startup%&                "code to obey when starting Perl"
12847 .endtable
12848
12849
12850
12851 .section "Daemon" "SECID104"
12852 .table2
12853 .row &%daemon_smtp_ports%&           "default ports"
12854 .row &%daemon_startup_retries%&      "number of times to retry"
12855 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12856 .row &%extra_local_interfaces%&      "not necessarily listened on"
12857 .row &%local_interfaces%&            "on which to listen, with optional ports"
12858 .row &%pid_file_path%&               "override compiled-in value"
12859 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12860 .endtable
12861
12862
12863
12864 .section "Resource control" "SECID105"
12865 .table2
12866 .row &%check_log_inodes%&            "before accepting a message"
12867 .row &%check_log_space%&             "before accepting a message"
12868 .row &%check_spool_inodes%&          "before accepting a message"
12869 .row &%check_spool_space%&           "before accepting a message"
12870 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12871 .row &%queue_only_load%&             "queue incoming if load high"
12872 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12873 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12874 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12875 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12876 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12877 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12878 .row &%smtp_accept_max_per_connection%& "messages per connection"
12879 .row &%smtp_accept_max_per_host%&    "connections from one host"
12880 .row &%smtp_accept_queue%&           "queue mail if more connections"
12881 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12882                                            connection"
12883 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12884 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12885 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12886 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12887 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12888 .endtable
12889
12890
12891
12892 .section "Policy controls" "SECID106"
12893 .table2
12894 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12895 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12896 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12897 .row &%acl_smtp_auth%&               "ACL for AUTH"
12898 .row &%acl_smtp_connect%&            "ACL for connection"
12899 .row &%acl_smtp_data%&               "ACL for DATA"
12900 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12901 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12902 .row &%acl_smtp_expn%&               "ACL for EXPN"
12903 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12904 .row &%acl_smtp_mail%&               "ACL for MAIL"
12905 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12906 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12907 .row &%acl_smtp_predata%&            "ACL for start of data"
12908 .row &%acl_smtp_quit%&               "ACL for QUIT"
12909 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12910 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12911 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12912 .row &%av_scanner%&                  "specify virus scanner"
12913 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12914                                       words""&"
12915 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12916 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12917 .row &%header_maxsize%&              "total size of message header"
12918 .row &%header_line_maxsize%&         "individual header line limit"
12919 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12920 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12921 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12922 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12923 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12924 .row &%host_lookup%&                 "host name looked up for these hosts"
12925 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12926 .row &%host_reject_connection%&      "reject connection from these hosts"
12927 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12928 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12929 .row &%message_size_limit%&          "for all messages"
12930 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12931 .row &%spamd_address%&               "set interface to SpamAssassin"
12932 .row &%strict_acl_vars%&             "object to unset ACL variables"
12933 .endtable
12934
12935
12936
12937 .section "Callout cache" "SECID107"
12938 .table2
12939 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12940                                          item"
12941 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12942                                          item"
12943 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12944 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12945 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12946 .endtable
12947
12948
12949
12950 .section "TLS" "SECID108"
12951 .table2
12952 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12953 .row &%gnutls_enable_pkcs11%&        "allow GnuTLS to autoload PKCS11 modules"
12954 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12955 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12956 .row &%tls_certificate%&             "location of server certificate"
12957 .row &%tls_crl%&                     "certificate revocation list"
12958 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
12959 .row &%tls_dhparam%&                 "DH parameters for server"
12960 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12961 .row &%tls_privatekey%&              "location of server private key"
12962 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12963 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12964 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12965 .row &%tls_verify_certificates%&     "expected client certificates"
12966 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12967 .endtable
12968
12969
12970
12971 .section "Local user handling" "SECID109"
12972 .table2
12973 .row &%finduser_retries%&            "useful in NIS environments"
12974 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12975 .row &%gecos_pattern%&               "ditto"
12976 .row &%max_username_length%&         "for systems that truncate"
12977 .row &%unknown_login%&               "used when no login name found"
12978 .row &%unknown_username%&            "ditto"
12979 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12980 .row &%uucp_from_sender%&            "ditto"
12981 .endtable
12982
12983
12984
12985 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12986 .table2
12987 .row &%header_maxsize%&              "total size of message header"
12988 .row &%header_line_maxsize%&         "individual header line limit"
12989 .row &%message_size_limit%&          "applies to all messages"
12990 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12991 .row &%received_header_text%&        "expanded to make &'Received:'&"
12992 .row &%received_headers_max%&        "for mail loop detection"
12993 .row &%recipients_max%&              "limit per message"
12994 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12995 .endtable
12996
12997
12998
12999
13000 .section "Non-SMTP incoming messages" "SECID111"
13001 .table2
13002 .row &%receive_timeout%&             "for non-SMTP messages"
13003 .endtable
13004
13005
13006
13007
13008
13009 .section "Incoming SMTP messages" "SECID112"
13010 See also the &'Policy controls'& section above.
13011
13012 .table2
13013 .row &%host_lookup%&                 "host name looked up for these hosts"
13014 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13015 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13016 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13017 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13018 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13019 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13020 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13021 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13022 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13023 .row &%smtp_accept_max_per_connection%& "messages per connection"
13024 .row &%smtp_accept_max_per_host%&    "connections from one host"
13025 .row &%smtp_accept_queue%&           "queue mail if more connections"
13026 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13027                                            connection"
13028 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13029 .row &%smtp_active_hostname%&        "host name to use in messages"
13030 .row &%smtp_banner%&                 "text for welcome banner"
13031 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13032 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13033 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13034 .row &%smtp_etrn_command%&           "what to run for ETRN"
13035 .row &%smtp_etrn_serialize%&         "only one at once"
13036 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13037 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13038 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13039 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13040 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13041 .row &%smtp_receive_timeout%&        "per command or data line"
13042 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13043 .row &%smtp_return_error_details%&   "give detail on rejections"
13044 .endtable
13045
13046
13047
13048 .section "SMTP extensions" "SECID113"
13049 .table2
13050 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13051 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13052 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13053 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13054 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13055 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13056 .endtable
13057
13058
13059
13060 .section "Processing messages" "SECID114"
13061 .table2
13062 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13063 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13064 .row &%allow_utf8_domains%&          "in addresses"
13065 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13066                                       words""&"
13067 .row &%delivery_date_remove%&        "from incoming messages"
13068 .row &%envelope_to_remove%&          "from incoming messages"
13069 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13070 .row &%headers_charset%&             "default for translations"
13071 .row &%qualify_domain%&              "default for senders"
13072 .row &%qualify_recipient%&           "default for recipients"
13073 .row &%return_path_remove%&          "from incoming messages"
13074 .row &%strip_excess_angle_brackets%& "in addresses"
13075 .row &%strip_trailing_dot%&          "at end of addresses"
13076 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13077 .endtable
13078
13079
13080
13081 .section "System filter" "SECID115"
13082 .table2
13083 .row &%system_filter%&               "locate system filter"
13084 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13085                                             directory"
13086 .row &%system_filter_file_transport%& "transport for delivery to a file"
13087 .row &%system_filter_group%&         "group for filter running"
13088 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13089 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13090 .row &%system_filter_user%&          "user for filter running"
13091 .endtable
13092
13093
13094
13095 .section "Routing and delivery" "SECID116"
13096 .table2
13097 .row &%disable_ipv6%&                "do no IPv6 processing"
13098 .row &%dns_again_means_nonexist%&    "for broken domains"
13099 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13100 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13101 .row &%dns_retrans%&                 "parameter for resolver"
13102 .row &%dns_retry%&                   "parameter for resolver"
13103 .row &%dns_use_dnssec%&              "parameter for resolver"
13104 .row &%dns_use_edns0%&               "parameter for resolver"
13105 .row &%hold_domains%&                "hold delivery for these domains"
13106 .row &%local_interfaces%&            "for routing checks"
13107 .row &%queue_domains%&               "no immediate delivery for these"
13108 .row &%queue_only%&                  "no immediate delivery at all"
13109 .row &%queue_only_file%&             "no immediate delivery if file exists"
13110 .row &%queue_only_load%&             "no immediate delivery if load is high"
13111 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13112 .row &%queue_only_override%&         "allow command line to override"
13113 .row &%queue_run_in_order%&          "order of arrival"
13114 .row &%queue_run_max%&               "of simultaneous queue runners"
13115 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13116 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13117 .row &%remote_sort_domains%&         "order of remote deliveries"
13118 .row &%retry_data_expire%&           "timeout for retry data"
13119 .row &%retry_interval_max%&          "safety net for retry rules"
13120 .endtable
13121
13122
13123
13124 .section "Bounce and warning messages" "SECID117"
13125 .table2
13126 .row &%bounce_message_file%&         "content of bounce"
13127 .row &%bounce_message_text%&         "content of bounce"
13128 .row &%bounce_return_body%&          "include body if returning message"
13129 .row &%bounce_return_message%&       "include original message in bounce"
13130 .row &%bounce_return_size_limit%&    "limit on returned message"
13131 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13132 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13133 .row &%errors_copy%&                 "copy bounce messages"
13134 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13135 .row &%delay_warning%&               "time schedule"
13136 .row &%delay_warning_condition%&     "condition for warning messages"
13137 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13138 .row &%smtp_return_error_details%&   "give detail on rejections"
13139 .row &%warn_message_file%&           "content of warning message"
13140 .endtable
13141
13142
13143
13144 .section "Alphabetical list of main options" "SECTalomo"
13145 Those options that undergo string expansion before use are marked with
13146 &dagger;.
13147
13148 .option accept_8bitmime main boolean true
13149 .cindex "8BITMIME"
13150 .cindex "8-bit characters"
13151 .cindex "log" "selectors"
13152 .cindex "log" "8BITMIME"
13153 This option causes Exim to send 8BITMIME in its response to an SMTP
13154 EHLO command, and to accept the BODY= parameter on MAIL commands.
13155 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13156 takes no steps to do anything special with messages received by this route.
13157
13158 Historically Exim kept this option off by default, but the maintainers
13159 feel that in today's Internet, this causes more problems than it solves.
13160 It now defaults to true.
13161 A more detailed analysis of the issues is provided by Dan Bernstein:
13162 .display
13163 &url(http://cr.yp.to/smtp/8bitmime.html)
13164 .endd
13165
13166 To log received 8BITMIME status use
13167 .code
13168 log_selector = +8bitmime
13169 .endd
13170
13171 .option acl_not_smtp main string&!! unset
13172 .cindex "&ACL;" "for non-SMTP messages"
13173 .cindex "non-SMTP messages" "ACLs for"
13174 This option defines the ACL that is run when a non-SMTP message has been
13175 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13176 further details.
13177
13178 .option acl_not_smtp_mime main string&!! unset
13179 This option defines the ACL that is run for individual MIME parts of non-SMTP
13180 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13181 SMTP messages.
13182
13183 .option acl_not_smtp_start main string&!! unset
13184 .cindex "&ACL;" "at start of non-SMTP message"
13185 .cindex "non-SMTP messages" "ACLs for"
13186 This option defines the ACL that is run before Exim starts reading a
13187 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13188
13189 .option acl_smtp_auth main string&!! unset
13190 .cindex "&ACL;" "setting up for SMTP commands"
13191 .cindex "AUTH" "ACL for"
13192 This option defines the ACL that is run when an SMTP AUTH command is
13193 received. See chapter &<<CHAPACL>>& for further details.
13194
13195 .option acl_smtp_connect main string&!! unset
13196 .cindex "&ACL;" "on SMTP connection"
13197 This option defines the ACL that is run when an SMTP connection is received.
13198 See chapter &<<CHAPACL>>& for further details.
13199
13200 .option acl_smtp_data main string&!! unset
13201 .cindex "DATA" "ACL for"
13202 This option defines the ACL that is run after an SMTP DATA command has been
13203 processed and the message itself has been received, but before the final
13204 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13205
13206 .option acl_smtp_etrn main string&!! unset
13207 .cindex "ETRN" "ACL for"
13208 This option defines the ACL that is run when an SMTP ETRN command is
13209 received. See chapter &<<CHAPACL>>& for further details.
13210
13211 .option acl_smtp_expn main string&!! unset
13212 .cindex "EXPN" "ACL for"
13213 This option defines the ACL that is run when an SMTP EXPN command is
13214 received. See chapter &<<CHAPACL>>& for further details.
13215
13216 .option acl_smtp_helo main string&!! unset
13217 .cindex "EHLO" "ACL for"
13218 .cindex "HELO" "ACL for"
13219 This option defines the ACL that is run when an SMTP EHLO or HELO
13220 command is received. See chapter &<<CHAPACL>>& for further details.
13221
13222
13223 .option acl_smtp_mail main string&!! unset
13224 .cindex "MAIL" "ACL for"
13225 This option defines the ACL that is run when an SMTP MAIL command is
13226 received. See chapter &<<CHAPACL>>& for further details.
13227
13228 .option acl_smtp_mailauth main string&!! unset
13229 .cindex "AUTH" "on MAIL command"
13230 This option defines the ACL that is run when there is an AUTH parameter on
13231 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13232 &<<CHAPSMTPAUTH>>& for details of authentication.
13233
13234 .option acl_smtp_mime main string&!! unset
13235 .cindex "MIME content scanning" "ACL for"
13236 This option is available when Exim is built with the content-scanning
13237 extension. It defines the ACL that is run for each MIME part in a message. See
13238 section &<<SECTscanmimepart>>& for details.
13239
13240 .option acl_smtp_predata main string&!! unset
13241 This option defines the ACL that is run when an SMTP DATA command is
13242 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13243 further details.
13244
13245 .option acl_smtp_quit main string&!! unset
13246 .cindex "QUIT, ACL for"
13247 This option defines the ACL that is run when an SMTP QUIT command is
13248 received. See chapter &<<CHAPACL>>& for further details.
13249
13250 .option acl_smtp_rcpt main string&!! unset
13251 .cindex "RCPT" "ACL for"
13252 This option defines the ACL that is run when an SMTP RCPT command is
13253 received. See chapter &<<CHAPACL>>& for further details.
13254
13255 .option acl_smtp_starttls main string&!! unset
13256 .cindex "STARTTLS, ACL for"
13257 This option defines the ACL that is run when an SMTP STARTTLS command is
13258 received. See chapter &<<CHAPACL>>& for further details.
13259
13260 .option acl_smtp_vrfy main string&!! unset
13261 .cindex "VRFY" "ACL for"
13262 This option defines the ACL that is run when an SMTP VRFY command is
13263 received. See chapter &<<CHAPACL>>& for further details.
13264
13265 .option admin_groups main "string list&!!" unset
13266 .cindex "admin user"
13267 This option is expanded just once, at the start of Exim's processing. If the
13268 current group or any of the supplementary groups of an Exim caller is in this
13269 colon-separated list, the caller has admin privileges. If all your system
13270 programmers are in a specific group, for example, you can give them all Exim
13271 admin privileges by putting that group in &%admin_groups%&. However, this does
13272 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13273 To permit this, you have to add individuals to the Exim group.
13274
13275 .option allow_domain_literals main boolean false
13276 .cindex "domain literal"
13277 If this option is set, the RFC 2822 domain literal format is permitted in
13278 email addresses. The option is not set by default, because the domain literal
13279 format is not normally required these days, and few people know about it. It
13280 has, however, been exploited by mail abusers.
13281
13282 Unfortunately, it seems that some DNS black list maintainers are using this
13283 format to report black listing to postmasters. If you want to accept messages
13284 addressed to your hosts by IP address, you need to set
13285 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13286 domains (defined in the named domain list &%local_domains%& in the default
13287 configuration). This &"magic string"& matches the domain literal form of all
13288 the local host's IP addresses.
13289
13290
13291 .option allow_mx_to_ip main boolean false
13292 .cindex "MX record" "pointing to IP address"
13293 It appears that more and more DNS zone administrators are breaking the rules
13294 and putting domain names that look like IP addresses on the right hand side of
13295 MX records. Exim follows the rules and rejects this, giving an error message
13296 that explains the mis-configuration. However, some other MTAs support this
13297 practice, so to avoid &"Why can't Exim do this?"& complaints,
13298 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13299 recommended, except when you have no other choice.
13300
13301 .option allow_utf8_domains main boolean false
13302 .cindex "domain" "UTF-8 characters in"
13303 .cindex "UTF-8" "in domain name"
13304 Lots of discussion is going on about internationalized domain names. One
13305 camp is strongly in favour of just using UTF-8 characters, and it seems
13306 that at least two other MTAs permit this. This option allows Exim users to
13307 experiment if they wish.
13308
13309 If it is set true, Exim's domain parsing function allows valid
13310 UTF-8 multicharacters to appear in domain name components, in addition to
13311 letters, digits, and hyphens. However, just setting this option is not
13312 enough; if you want to look up these domain names in the DNS, you must also
13313 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13314 suitable setting is:
13315 .code
13316 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13317   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13318 .endd
13319 Alternatively, you can just disable this feature by setting
13320 .code
13321 dns_check_names_pattern =
13322 .endd
13323 That is, set the option to an empty string so that no check is done.
13324
13325
13326 .option auth_advertise_hosts main "host list&!!" *
13327 .cindex "authentication" "advertising"
13328 .cindex "AUTH" "advertising"
13329 If any server authentication mechanisms are configured, Exim advertises them in
13330 response to an EHLO command only if the calling host matches this list.
13331 Otherwise, Exim does not advertise AUTH.
13332 Exim does not accept AUTH commands from clients to which it has not
13333 advertised the availability of AUTH. The advertising of individual
13334 authentication mechanisms can be controlled by the use of the
13335 &%server_advertise_condition%& generic authenticator option on the individual
13336 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13337
13338 Certain mail clients (for example, Netscape) require the user to provide a name
13339 and password for authentication if AUTH is advertised, even though it may
13340 not be needed (the host may accept messages from hosts on its local LAN without
13341 authentication, for example). The &%auth_advertise_hosts%& option can be used
13342 to make these clients more friendly by excluding them from the set of hosts to
13343 which Exim advertises AUTH.
13344
13345 .cindex "AUTH" "advertising when encrypted"
13346 If you want to advertise the availability of AUTH only when the connection
13347 is encrypted using TLS, you can make use of the fact that the value of this
13348 option is expanded, with a setting like this:
13349 .code
13350 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13351 .endd
13352 .vindex "&$tls_in_cipher$&"
13353 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13354 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13355 expansion is *, which matches all hosts.
13356
13357
13358 .option auto_thaw main time 0s
13359 .cindex "thawing messages"
13360 .cindex "unfreezing messages"
13361 If this option is set to a time greater than zero, a queue runner will try a
13362 new delivery attempt on any frozen message, other than a bounce message, if
13363 this much time has passed since it was frozen. This may result in the message
13364 being re-frozen if nothing has changed since the last attempt. It is a way of
13365 saying &"keep on trying, even though there are big problems"&.
13366
13367 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13368 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13369 thought to be very useful any more, and its use should probably be avoided.
13370
13371
13372 .option av_scanner main string "see below"
13373 This option is available if Exim is built with the content-scanning extension.
13374 It specifies which anti-virus scanner to use. The default value is:
13375 .code
13376 sophie:/var/run/sophie
13377 .endd
13378 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13379 before use. See section &<<SECTscanvirus>>& for further details.
13380
13381
13382 .option bi_command main string unset
13383 .oindex "&%-bi%&"
13384 This option supplies the name of a command that is run when Exim is called with
13385 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13386 just the command name, it is not a complete command line. If an argument is
13387 required, it must come from the &%-oA%& command line option.
13388
13389
13390 .option bounce_message_file main string unset
13391 .cindex "bounce message" "customizing"
13392 .cindex "customizing" "bounce message"
13393 This option defines a template file containing paragraphs of text to be used
13394 for constructing bounce messages.  Details of the file's contents are given in
13395 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13396
13397
13398 .option bounce_message_text main string unset
13399 When this option is set, its contents are included in the default bounce
13400 message immediately after &"This message was created automatically by mail
13401 delivery software."& It is not used if &%bounce_message_file%& is set.
13402
13403 .option bounce_return_body main boolean true
13404 .cindex "bounce message" "including body"
13405 This option controls whether the body of an incoming message is included in a
13406 bounce message when &%bounce_return_message%& is true. The default setting
13407 causes the entire message, both header and body, to be returned (subject to the
13408 value of &%bounce_return_size_limit%&). If this option is false, only the
13409 message header is included. In the case of a non-SMTP message containing an
13410 error that is detected during reception, only those header lines preceding the
13411 point at which the error was detected are returned.
13412 .cindex "bounce message" "including original"
13413
13414 .option bounce_return_message main boolean true
13415 If this option is set false, none of the original message is included in
13416 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13417 &%bounce_return_body%&.
13418
13419
13420 .option bounce_return_size_limit main integer 100K
13421 .cindex "size" "of bounce, limit"
13422 .cindex "bounce message" "size limit"
13423 .cindex "limit" "bounce message size"
13424 This option sets a limit in bytes on the size of messages that are returned to
13425 senders as part of bounce messages when &%bounce_return_message%& is true. The
13426 limit should be less than the value of the global &%message_size_limit%& and of
13427 any &%message_size_limit%& settings on transports, to allow for the bounce text
13428 that Exim generates. If this option is set to zero there is no limit.
13429
13430 When the body of any message that is to be included in a bounce message is
13431 greater than the limit, it is truncated, and a comment pointing this out is
13432 added at the top. The actual cutoff may be greater than the value given, owing
13433 to the use of buffering for transferring the message in chunks (typically 8K in
13434 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13435 messages.
13436
13437 .option bounce_sender_authentication main string unset
13438 .cindex "bounce message" "sender authentication"
13439 .cindex "authentication" "bounce message"
13440 .cindex "AUTH" "on bounce message"
13441 This option provides an authenticated sender address that is sent with any
13442 bounce messages generated by Exim that are sent over an authenticated SMTP
13443 connection. A typical setting might be:
13444 .code
13445 bounce_sender_authentication = mailer-daemon@my.domain.example
13446 .endd
13447 which would cause bounce messages to be sent using the SMTP command:
13448 .code
13449 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13450 .endd
13451 The value of &%bounce_sender_authentication%& must always be a complete email
13452 address.
13453
13454 .option callout_domain_negative_expire main time 3h
13455 .cindex "caching" "callout timeouts"
13456 .cindex "callout" "caching timeouts"
13457 This option specifies the expiry time for negative callout cache data for a
13458 domain. See section &<<SECTcallver>>& for details of callout verification, and
13459 section &<<SECTcallvercache>>& for details of the caching.
13460
13461
13462 .option callout_domain_positive_expire main time 7d
13463 This option specifies the expiry time for positive callout cache data for a
13464 domain. See section &<<SECTcallver>>& for details of callout verification, and
13465 section &<<SECTcallvercache>>& for details of the caching.
13466
13467
13468 .option callout_negative_expire main time 2h
13469 This option specifies the expiry time for negative callout cache data for an
13470 address. See section &<<SECTcallver>>& for details of callout verification, and
13471 section &<<SECTcallvercache>>& for details of the caching.
13472
13473
13474 .option callout_positive_expire main time 24h
13475 This option specifies the expiry time for positive callout cache data for an
13476 address. See section &<<SECTcallver>>& for details of callout verification, and
13477 section &<<SECTcallvercache>>& for details of the caching.
13478
13479
13480 .option callout_random_local_part main string&!! "see below"
13481 This option defines the &"random"& local part that can be used as part of
13482 callout verification. The default value is
13483 .code
13484 $primary_hostname-$tod_epoch-testing
13485 .endd
13486 See section &<<CALLaddparcall>>& for details of how this value is used.
13487
13488
13489 .option check_log_inodes main integer 0
13490 See &%check_spool_space%& below.
13491
13492
13493 .option check_log_space main integer 0
13494 See &%check_spool_space%& below.
13495
13496 .oindex "&%check_rfc2047_length%&"
13497 .cindex "RFC 2047" "disabling length check"
13498 .option check_rfc2047_length main boolean true
13499 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13500 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13501 word; strings to be encoded that exceed this length are supposed to use
13502 multiple encoded words. By default, Exim does not recognize encoded words that
13503 exceed the maximum length. However, it seems that some software, in violation
13504 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13505 set false, Exim recognizes encoded words of any length.
13506
13507
13508 .option check_spool_inodes main integer 0
13509 See &%check_spool_space%& below.
13510
13511
13512 .option check_spool_space main integer 0
13513 .cindex "checking disk space"
13514 .cindex "disk space, checking"
13515 .cindex "spool directory" "checking space"
13516 The four &%check_...%& options allow for checking of disk resources before a
13517 message is accepted.
13518
13519 .vindex "&$log_inodes$&"
13520 .vindex "&$log_space$&"
13521 .vindex "&$spool_inodes$&"
13522 .vindex "&$spool_space$&"
13523 When any of these options are set, they apply to all incoming messages. If you
13524 want to apply different checks to different kinds of message, you can do so by
13525 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13526 &$spool_space$& in an ACL with appropriate additional conditions.
13527
13528
13529 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13530 either value is greater than zero, for example:
13531 .code
13532 check_spool_space = 10M
13533 check_spool_inodes = 100
13534 .endd
13535 The spool partition is the one that contains the directory defined by
13536 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13537 transit.
13538
13539 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13540 files are written if either is greater than zero. These should be set only if
13541 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13542
13543 If there is less space or fewer inodes than requested, Exim refuses to accept
13544 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13545 error response to the MAIL command. If ESMTP is in use and there was a
13546 SIZE parameter on the MAIL command, its value is added to the
13547 &%check_spool_space%& value, and the check is performed even if
13548 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13549
13550 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13551 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13552
13553 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13554 failure a message is written to stderr and Exim exits with a non-zero code, as
13555 it obviously cannot send an error message of any kind.
13556
13557 .option daemon_smtp_ports main string &`smtp`&
13558 .cindex "port" "for daemon"
13559 .cindex "TCP/IP" "setting listening ports"
13560 This option specifies one or more default SMTP ports on which the Exim daemon
13561 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13562 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13563
13564 .option daemon_startup_retries main integer 9
13565 .cindex "daemon startup, retrying"
13566 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13567 the daemon at startup when it cannot immediately bind a listening socket
13568 (typically because the socket is already in use): &%daemon_startup_retries%&
13569 defines the number of retries after the first failure, and
13570 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13571
13572 .option daemon_startup_sleep main time 30s
13573 See &%daemon_startup_retries%&.
13574
13575 .option delay_warning main "time list" 24h
13576 .cindex "warning of delay"
13577 .cindex "delay warning, specifying"
13578 When a message is delayed, Exim sends a warning message to the sender at
13579 intervals specified by this option. The data is a colon-separated list of times
13580 after which to send warning messages. If the value of the option is an empty
13581 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13582 message has been on the queue for longer than the last time, the last interval
13583 between the times is used to compute subsequent warning times. For example,
13584 with
13585 .code
13586 delay_warning = 4h:8h:24h
13587 .endd
13588 the first message is sent after 4 hours, the second after 8 hours, and
13589 the third one after 24 hours. After that, messages are sent every 16 hours,
13590 because that is the interval between the last two times on the list. If you set
13591 just one time, it specifies the repeat interval. For example, with:
13592 .code
13593 delay_warning = 6h
13594 .endd
13595 messages are repeated every six hours. To stop warnings after a given time, set
13596 a very large time at the end of the list. For example:
13597 .code
13598 delay_warning = 2h:12h:99d
13599 .endd
13600
13601 .option delay_warning_condition main string&!! "see below"
13602 .vindex "&$domain$&"
13603 The string is expanded at the time a warning message might be sent. If all the
13604 deferred addresses have the same domain, it is set in &$domain$& during the
13605 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13606 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13607 &"false"& (the comparison being done caselessly) then the warning message is
13608 not sent. The default is:
13609 .code
13610 delay_warning_condition = ${if or {\
13611   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13612   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13613   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13614   } {no}{yes}}
13615 .endd
13616 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13617 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13618 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13619 &"auto-replied"& in an &'Auto-Submitted:'& header.
13620
13621 .option deliver_drop_privilege main boolean false
13622 .cindex "unprivileged delivery"
13623 .cindex "delivery" "unprivileged"
13624 If this option is set true, Exim drops its root privilege at the start of a
13625 delivery process, and runs as the Exim user throughout. This severely restricts
13626 the kinds of local delivery that are possible, but is viable in certain types
13627 of configuration. There is a discussion about the use of root privilege in
13628 chapter &<<CHAPsecurity>>&.
13629
13630 .option deliver_queue_load_max main fixed-point unset
13631 .cindex "load average"
13632 .cindex "queue runner" "abandoning"
13633 When this option is set, a queue run is abandoned if the system load average
13634 becomes greater than the value of the option. The option has no effect on
13635 ancient operating systems on which Exim cannot determine the load average.
13636 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13637
13638
13639 .option delivery_date_remove main boolean true
13640 .cindex "&'Delivery-date:'& header line"
13641 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13642 message when it is delivered, in exactly the same way as &'Return-path:'& is
13643 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13644 should not be present in incoming messages, and this option causes them to be
13645 removed at the time the message is received, to avoid any problems that might
13646 occur when a delivered message is subsequently sent on to some other recipient.
13647
13648 .option disable_fsync main boolean false
13649 .cindex "&[fsync()]&, disabling"
13650 This option is available only if Exim was built with the compile-time option
13651 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13652 a runtime configuration generates an &"unknown option"& error. You should not
13653 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13654 really, really, really understand what you are doing. &'No pre-compiled
13655 distributions of Exim should ever make this option available.'&
13656
13657 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13658 updated files' data to be written to disc before continuing. Unexpected events
13659 such as crashes and power outages may cause data to be lost or scrambled.
13660 Here be Dragons. &*Beware.*&
13661
13662
13663 .option disable_ipv6 main boolean false
13664 .cindex "IPv6" "disabling"
13665 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13666 activities take place. AAAA records are never looked up, and any IPv6 addresses
13667 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13668 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13669 to handle IPv6 literal addresses.
13670
13671
13672 .option dns_again_means_nonexist main "domain list&!!" unset
13673 .cindex "DNS" "&""try again""& response; overriding"
13674 DNS lookups give a &"try again"& response for the DNS errors
13675 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13676 keep trying to deliver a message, or to give repeated temporary errors to
13677 incoming mail. Sometimes the effect is caused by a badly set up name server and
13678 may persist for a long time. If a domain which exhibits this problem matches
13679 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13680 This option should be used with care. You can make it apply to reverse lookups
13681 by a setting such as this:
13682 .code
13683 dns_again_means_nonexist = *.in-addr.arpa
13684 .endd
13685 This option applies to all DNS lookups that Exim does. It also applies when the
13686 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13687 since these are most likely to be caused by DNS lookup problems. The
13688 &(dnslookup)& router has some options of its own for controlling what happens
13689 when lookups for MX or SRV records give temporary errors. These more specific
13690 options are applied after this global option.
13691
13692 .option dns_check_names_pattern main string "see below"
13693 .cindex "DNS" "pre-check of name syntax"
13694 When this option is set to a non-empty string, it causes Exim to check domain
13695 names for characters that are not allowed in host names before handing them to
13696 the DNS resolver, because some resolvers give temporary errors for names that
13697 contain unusual characters. If a domain name contains any unwanted characters,
13698 a &"not found"& result is forced, and the resolver is not called. The check is
13699 done by matching the domain name against a regular expression, which is the
13700 value of this option. The default pattern is
13701 .code
13702 dns_check_names_pattern = \
13703   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13704 .endd
13705 which permits only letters, digits, slashes, and hyphens in components, but
13706 they must start and end with a letter or digit. Slashes are not, in fact,
13707 permitted in host names, but they are found in certain NS records (which can be
13708 accessed in Exim by using a &%dnsdb%& lookup). If you set
13709 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13710 empty string.
13711
13712 .option dns_csa_search_limit main integer 5
13713 This option controls the depth of parental searching for CSA SRV records in the
13714 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13715
13716 .option dns_csa_use_reverse main boolean true
13717 This option controls whether or not an IP address, given as a CSA domain, is
13718 reversed and looked up in the reverse DNS, as described in more detail in
13719 section &<<SECTverifyCSA>>&.
13720
13721 .option dns_ipv4_lookup main "domain list&!!" unset
13722 .cindex "IPv6" "DNS lookup for AAAA records"
13723 .cindex "DNS" "IPv6 lookup for AAAA records"
13724 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13725 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13726 (A records) when trying to find IP addresses for hosts, unless the host's
13727 domain matches this list.
13728
13729 This is a fudge to help with name servers that give big delays or otherwise do
13730 not work for the AAAA record type. In due course, when the world's name
13731 servers have all been upgraded, there should be no need for this option.
13732
13733
13734 .option dns_retrans main time 0s
13735 .cindex "DNS" "resolver options"
13736 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13737 retransmission and retry parameters for DNS lookups. Values of zero (the
13738 defaults) leave the system default settings unchanged. The first value is the
13739 time between retries, and the second is the number of retries. It isn't
13740 totally clear exactly how these settings affect the total time a DNS lookup may
13741 take. I haven't found any documentation about timeouts on DNS lookups; these
13742 parameter values are available in the external resolver interface structure,
13743 but nowhere does it seem to describe how they are used or what you might want
13744 to set in them.
13745
13746
13747 .option dns_retry main integer 0
13748 See &%dns_retrans%& above.
13749
13750
13751 .new
13752 .option dns_use_dnssec main integer -1
13753 .cindex "DNS" "resolver options"
13754 .cindex "DNS" "DNSSEC"
13755 If this option is set to a non-negative number then Exim will initialise the
13756 DNS resolver library to either use or not use DNSSEC, overriding the system
13757 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
13758
13759 If the resolver library does not support DNSSEC then this option has no effect.
13760 .wen
13761
13762
13763 .option dns_use_edns0 main integer -1
13764 .cindex "DNS" "resolver options"
13765 .cindex "DNS" "EDNS0"
13766 If this option is set to a non-negative number then Exim will initialise the
13767 DNS resolver library to either use or not use EDNS0 extensions, overriding
13768 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13769 on.
13770
13771 If the resolver library does not support EDNS0 then this option has no effect.
13772
13773
13774 .option drop_cr main boolean false
13775 This is an obsolete option that is now a no-op. It used to affect the way Exim
13776 handled CR and LF characters in incoming messages. What happens now is
13777 described in section &<<SECTlineendings>>&.
13778
13779 .option dsn_from main "string&!!" "see below"
13780 .cindex "&'From:'& header line" "in bounces"
13781 .cindex "bounce messages" "&'From:'& line, specifying"
13782 This option can be used to vary the contents of &'From:'& header lines in
13783 bounces and other automatically generated messages (&"Delivery Status
13784 Notifications"& &-- hence the name of the option). The default setting is:
13785 .code
13786 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13787 .endd
13788 The value is expanded every time it is needed. If the expansion fails, a
13789 panic is logged, and the default value is used.
13790
13791 .option envelope_to_remove main boolean true
13792 .cindex "&'Envelope-to:'& header line"
13793 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13794 message when it is delivered, in exactly the same way as &'Return-path:'& is
13795 handled. &'Envelope-to:'& records the original recipient address from the
13796 messages's envelope that caused the delivery to happen. Such headers should not
13797 be present in incoming messages, and this option causes them to be removed at
13798 the time the message is received, to avoid any problems that might occur when a
13799 delivered message is subsequently sent on to some other recipient.
13800
13801
13802 .option errors_copy main "string list&!!" unset
13803 .cindex "bounce message" "copy to other address"
13804 .cindex "copy of bounce message"
13805 Setting this option causes Exim to send bcc copies of bounce messages that it
13806 generates to other addresses. &*Note*&: This does not apply to bounce messages
13807 coming from elsewhere. The value of the option is a colon-separated list of
13808 items. Each item consists of a pattern, terminated by white space, followed by
13809 a comma-separated list of email addresses. If a pattern contains spaces, it
13810 must be enclosed in double quotes.
13811
13812 Each pattern is processed in the same way as a single item in an address list
13813 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13814 the bounce message, the message is copied to the addresses on the list. The
13815 items are scanned in order, and once a matching one is found, no further items
13816 are examined. For example:
13817 .code
13818 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13819               rqps@mydomain   hostmaster@mydomain.example,\
13820                               postmaster@mydomain.example
13821 .endd
13822 .vindex "&$domain$&"
13823 .vindex "&$local_part$&"
13824 The address list is expanded before use. The expansion variables &$local_part$&
13825 and &$domain$& are set from the original recipient of the error message, and if
13826 there was any wildcard matching in the pattern, the expansion
13827 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13828 variables &$0$&, &$1$&, etc. are set in the normal way.
13829
13830
13831 .option errors_reply_to main string unset
13832 .cindex "bounce message" "&'Reply-to:'& in"
13833 By default, Exim's bounce and delivery warning messages contain the header line
13834 .display
13835 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13836 .endd
13837 .oindex &%quota_warn_message%&
13838 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13839 A warning message that is generated by the &%quota_warn_message%& option in an
13840 &(appendfile)& transport may contain its own &'From:'& header line that
13841 overrides the default.
13842
13843 Experience shows that people reply to bounce messages. If the
13844 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13845 and warning messages. For example:
13846 .code
13847 errors_reply_to = postmaster@my.domain.example
13848 .endd
13849 The value of the option is not expanded. It must specify a valid RFC 2822
13850 address. However, if a warning message that is generated by the
13851 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13852 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13853 not used.
13854
13855
13856 .option exim_group main string "compile-time configured"
13857 .cindex "gid (group id)" "Exim's own"
13858 .cindex "Exim group"
13859 This option changes the gid under which Exim runs when it gives up root
13860 privilege. The default value is compiled into the binary. The value of this
13861 option is used only when &%exim_user%& is also set. Unless it consists entirely
13862 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13863 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13864 security issues.
13865
13866
13867 .option exim_path main string "see below"
13868 .cindex "Exim binary, path name"
13869 This option specifies the path name of the Exim binary, which is used when Exim
13870 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13871 the directory configured at compile time by the BIN_DIRECTORY setting. It
13872 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13873 other place.
13874 &*Warning*&: Do not use a macro to define the value of this option, because
13875 you will break those Exim utilities that scan the configuration file to find
13876 where the binary is. (They then use the &%-bP%& option to extract option
13877 settings such as the value of &%spool_directory%&.)
13878
13879
13880 .option exim_user main string "compile-time configured"
13881 .cindex "uid (user id)" "Exim's own"
13882 .cindex "Exim user"
13883 This option changes the uid under which Exim runs when it gives up root
13884 privilege. The default value is compiled into the binary. Ownership of the run
13885 time configuration file and the use of the &%-C%& and &%-D%& command line
13886 options is checked against the values in the binary, not what is set here.
13887
13888 Unless it consists entirely of digits, the string is looked up using
13889 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13890 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13891 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13892
13893
13894 .option extra_local_interfaces main "string list" unset
13895 This option defines network interfaces that are to be considered local when
13896 routing, but which are not used for listening by the daemon. See section
13897 &<<SECTreclocipadd>>& for details.
13898
13899
13900 . Allow this long option name to split; give it unsplit as a fifth argument
13901 . for the automatic .oindex that is generated by .option.
13902
13903 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13904          extract_addresses_remove_arguments
13905 .oindex "&%-t%&"
13906 .cindex "command line" "addresses with &%-t%&"
13907 .cindex "Sendmail compatibility" "&%-t%& option"
13908 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13909 are present on the command line when the &%-t%& option is used to build an
13910 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13911 line addresses are removed from the recipients list. This is also how Smail
13912 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13913 command line addresses are added to those obtained from the header lines. When
13914 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13915 argument headers. If it is set false, Exim adds rather than removes argument
13916 addresses.
13917
13918
13919 .option finduser_retries main integer 0
13920 .cindex "NIS, retrying user lookups"
13921 On systems running NIS or other schemes in which user and group information is
13922 distributed from a remote system, there can be times when &[getpwnam()]& and
13923 related functions fail, even when given valid data, because things time out.
13924 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13925 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13926 many extra times to find a user or a group, waiting for one second between
13927 retries.
13928
13929 .cindex "&_/etc/passwd_&" "multiple reading of"
13930 You should not set this option greater than zero if your user information is in
13931 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13932 search the file multiple times for non-existent users, and also cause delay.
13933
13934
13935
13936 .option freeze_tell main "string list, comma separated" unset
13937 .cindex "freezing messages" "sending a message when freezing"
13938 On encountering certain errors, or when configured to do so in a system filter,
13939 ACL, or special router, Exim freezes a message. This means that no further
13940 delivery attempts take place until an administrator thaws the message, or the
13941 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13942 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13943 warning message whenever it freezes something, unless the message it is
13944 freezing is a locally-generated bounce message. (Without this exception there
13945 is the possibility of looping.) The warning message is sent to the addresses
13946 supplied as the comma-separated value of this option. If several of the
13947 message's addresses cause freezing, only a single message is sent. If the
13948 freezing was automatic, the reason(s) for freezing can be found in the message
13949 log. If you configure freezing in a filter or ACL, you must arrange for any
13950 logging that you require.
13951
13952
13953 .option gecos_name main string&!! unset
13954 .cindex "HP-UX"
13955 .cindex "&""gecos""& field, parsing"
13956 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13957 password file to hold other information in addition to users' real names. Exim
13958 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13959 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13960 of the field are used unchanged, except that, if an ampersand is encountered,
13961 it is replaced by the user's login name with the first character forced to
13962 upper case, since this is a convention that is observed on many systems.
13963
13964 When these options are set, &%gecos_pattern%& is treated as a regular
13965 expression that is to be applied to the field (again with && replaced by the
13966 login name), and if it matches, &%gecos_name%& is expanded and used as the
13967 user's name.
13968
13969 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13970 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13971 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13972 name terminates at the first comma, the following can be used:
13973 .code
13974 gecos_pattern = ([^,]*)
13975 gecos_name = $1
13976 .endd
13977
13978 .option gecos_pattern main string unset
13979 See &%gecos_name%& above.
13980
13981
13982 .option gnutls_compat_mode main boolean unset
13983 This option controls whether GnuTLS is used in compatibility mode in an Exim
13984 server. This reduces security slightly, but improves interworking with older
13985 implementations of TLS.
13986
13987
13988 .new
13989 option gnutls_enable_pkcs11 main boolean unset
13990 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
13991 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
13992
13993 See
13994 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
13995 for documentation.
13996 .wen
13997
13998
13999
14000 .option headers_charset main string "see below"
14001 This option sets a default character set for translating from encoded MIME
14002 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14003 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14004 ultimate default is ISO-8859-1. For more details see the description of header
14005 insertions in section &<<SECTexpansionitems>>&.
14006
14007
14008
14009 .option header_maxsize main integer "see below"
14010 .cindex "header section" "maximum size of"
14011 .cindex "limit" "size of message header section"
14012 This option controls the overall maximum size of a message's header
14013 section. The default is the value of HEADER_MAXSIZE in
14014 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14015 sections are rejected.
14016
14017
14018 .option header_line_maxsize main integer 0
14019 .cindex "header lines" "maximum size of"
14020 .cindex "limit" "size of one header line"
14021 This option limits the length of any individual header line in a message, after
14022 all the continuations have been joined together. Messages with individual
14023 header lines that are longer than the limit are rejected. The default value of
14024 zero means &"no limit"&.
14025
14026
14027
14028
14029 .option helo_accept_junk_hosts main "host list&!!" unset
14030 .cindex "HELO" "accepting junk data"
14031 .cindex "EHLO" "accepting junk data"
14032 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14033 mail, and gives an error response for invalid data. Unfortunately, there are
14034 some SMTP clients that send syntactic junk. They can be accommodated by setting
14035 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14036 if you want to do semantic checking.
14037 See also &%helo_allow_chars%& for a way of extending the permitted character
14038 set.
14039
14040
14041 .option helo_allow_chars main string unset
14042 .cindex "HELO" "underscores in"
14043 .cindex "EHLO" "underscores in"
14044 .cindex "underscore in EHLO/HELO"
14045 This option can be set to a string of rogue characters that are permitted in
14046 all EHLO and HELO names in addition to the standard letters, digits,
14047 hyphens, and dots. If you really must allow underscores, you can set
14048 .code
14049 helo_allow_chars = _
14050 .endd
14051 Note that the value is one string, not a list.
14052
14053
14054 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14055 .cindex "HELO" "forcing reverse lookup"
14056 .cindex "EHLO" "forcing reverse lookup"
14057 If the domain given by a client in a HELO or EHLO command matches this
14058 list, a reverse lookup is done in order to establish the host's true name. The
14059 default forces a lookup if the client host gives the server's name or any of
14060 its IP addresses (in brackets), something that broken clients have been seen to
14061 do.
14062
14063
14064 .option helo_try_verify_hosts main "host list&!!" unset
14065 .cindex "HELO verifying" "optional"
14066 .cindex "EHLO" "verifying, optional"
14067 By default, Exim just checks the syntax of HELO and EHLO commands (see
14068 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14069 to do more extensive checking of the data supplied by these commands. The ACL
14070 condition &`verify = helo`& is provided to make this possible.
14071 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14072 to force the check to occur. From release 4.53 onwards, this is no longer
14073 necessary. If the check has not been done before &`verify = helo`& is
14074 encountered, it is done at that time. Consequently, this option is obsolete.
14075 Its specification is retained here for backwards compatibility.
14076
14077 When an EHLO or HELO command is received, if the calling host matches
14078 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14079 EHLO command either:
14080
14081 .ilist
14082 is an IP literal matching the calling address of the host, or
14083 .next
14084 .cindex "DNS" "reverse lookup"
14085 .cindex "reverse DNS lookup"
14086 matches the host name that Exim obtains by doing a reverse lookup of the
14087 calling host address, or
14088 .next
14089 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14090 available) yields the calling host address.
14091 .endlist
14092
14093 However, the EHLO or HELO command is not rejected if any of the checks
14094 fail. Processing continues, but the result of the check is remembered, and can
14095 be detected later in an ACL by the &`verify = helo`& condition.
14096
14097 .option helo_verify_hosts main "host list&!!" unset
14098 .cindex "HELO verifying" "mandatory"
14099 .cindex "EHLO" "verifying, mandatory"
14100 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14101 backwards compatibility. For hosts that match this option, Exim checks the host
14102 name given in the HELO or EHLO in the same way as for
14103 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14104 rejected with a 550 error, and entries are written to the main and reject logs.
14105 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14106 error.
14107
14108 .option hold_domains main "domain list&!!" unset
14109 .cindex "domain" "delaying delivery"
14110 .cindex "delivery" "delaying certain domains"
14111 This option allows mail for particular domains to be held on the queue
14112 manually. The option is overridden if a message delivery is forced with the
14113 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14114 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14115 item in &%hold_domains%&, no routing or delivery for that address is done, and
14116 it is deferred every time the message is looked at.
14117
14118 This option is intended as a temporary operational measure for delaying the
14119 delivery of mail while some problem is being sorted out, or some new
14120 configuration tested. If you just want to delay the processing of some
14121 domains until a queue run occurs, you should use &%queue_domains%& or
14122 &%queue_smtp_domains%&, not &%hold_domains%&.
14123
14124 A setting of &%hold_domains%& does not override Exim's code for removing
14125 messages from the queue if they have been there longer than the longest retry
14126 time in any retry rule. If you want to hold messages for longer than the normal
14127 retry times, insert a dummy retry rule with a long retry time.
14128
14129
14130 .option host_lookup main "host list&!!" unset
14131 .cindex "host name" "lookup, forcing"
14132 Exim does not look up the name of a calling host from its IP address unless it
14133 is required to compare against some host list, or the host matches
14134 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14135 option (which normally contains IP addresses rather than host names). The
14136 default configuration file contains
14137 .code
14138 host_lookup = *
14139 .endd
14140 which causes a lookup to happen for all hosts. If the expense of these lookups
14141 is felt to be too great, the setting can be changed or removed.
14142
14143 After a successful reverse lookup, Exim does a forward lookup on the name it
14144 has obtained, to verify that it yields the IP address that it started with. If
14145 this check fails, Exim behaves as if the name lookup failed.
14146
14147 .vindex "&$host_lookup_failed$&"
14148 .vindex "&$sender_host_name$&"
14149 After any kind of failure, the host name (in &$sender_host_name$&) remains
14150 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14151 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14152 &`verify = reverse_host_lookup`& in ACLs.
14153
14154
14155 .option host_lookup_order main "string list" &`bydns:byaddr`&
14156 This option specifies the order of different lookup methods when Exim is trying
14157 to find a host name from an IP address. The default is to do a DNS lookup
14158 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14159 if that fails. You can change the order of these lookups, or omit one entirely,
14160 if you want.
14161
14162 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14163 multiple PTR records in the DNS and the IP address is not listed in
14164 &_/etc/hosts_&. Different operating systems give different results in this
14165 case. That is why the default tries a DNS lookup first.
14166
14167
14168
14169 .option host_reject_connection main "host list&!!" unset
14170 .cindex "host" "rejecting connections from"
14171 If this option is set, incoming SMTP calls from the hosts listed are rejected
14172 as soon as the connection is made.
14173 This option is obsolete, and retained only for backward compatibility, because
14174 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14175 connections immediately.
14176
14177 The ability to give an immediate rejection (either by this option or using an
14178 ACL) is provided for use in unusual cases. Many hosts will just try again,
14179 sometimes without much delay. Normally, it is better to use an ACL to reject
14180 incoming messages at a later stage, such as after RCPT commands. See
14181 chapter &<<CHAPACL>>&.
14182
14183
14184 .option hosts_connection_nolog main "host list&!!" unset
14185 .cindex "host" "not logging connections from"
14186 This option defines a list of hosts for which connection logging does not
14187 happen, even though the &%smtp_connection%& log selector is set. For example,
14188 you might want not to log SMTP connections from local processes, or from
14189 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14190 the daemon; you should therefore strive to restrict its value to a short inline
14191 list of IP addresses and networks. To disable logging SMTP connections from
14192 local processes, you must create a host list with an empty item. For example:
14193 .code
14194 hosts_connection_nolog = :
14195 .endd
14196 If the &%smtp_connection%& log selector is not set, this option has no effect.
14197
14198
14199
14200 .option hosts_treat_as_local main "domain list&!!" unset
14201 .cindex "local host" "domains treated as"
14202 .cindex "host" "treated as local"
14203 If this option is set, any host names that match the domain list are treated as
14204 if they were the local host when Exim is scanning host lists obtained from MX
14205 records
14206 or other sources. Note that the value of this option is a domain list, not a
14207 host list, because it is always used to check host names, not IP addresses.
14208
14209 This option also applies when Exim is matching the special items
14210 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14211 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14212 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14213 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14214 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14215 interfaces and recognizing the local host.
14216
14217
14218 .option ibase_servers main "string list" unset
14219 .cindex "InterBase" "server list"
14220 This option provides a list of InterBase servers and associated connection data,
14221 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14222 The option is available only if Exim has been built with InterBase support.
14223
14224
14225
14226 .option ignore_bounce_errors_after main time 10w
14227 .cindex "bounce message" "discarding"
14228 .cindex "discarding bounce message"
14229 This option affects the processing of bounce messages that cannot be delivered,
14230 that is, those that suffer a permanent delivery failure. (Bounce messages that
14231 suffer temporary delivery failures are of course retried in the usual way.)
14232
14233 After a permanent delivery failure, bounce messages are frozen,
14234 because there is no sender to whom they can be returned. When a frozen bounce
14235 message has been on the queue for more than the given time, it is unfrozen at
14236 the next queue run, and a further delivery is attempted. If delivery fails
14237 again, the bounce message is discarded. This makes it possible to keep failed
14238 bounce messages around for a shorter time than the normal maximum retry time
14239 for frozen messages. For example,
14240 .code
14241 ignore_bounce_errors_after = 12h
14242 .endd
14243 retries failed bounce message deliveries after 12 hours, discarding any further
14244 failures. If the value of this option is set to a zero time period, bounce
14245 failures are discarded immediately. Setting a very long time (as in the default
14246 value) has the effect of disabling this option. For ways of automatically
14247 dealing with other kinds of frozen message, see &%auto_thaw%& and
14248 &%timeout_frozen_after%&.
14249
14250
14251 .option ignore_fromline_hosts main "host list&!!" unset
14252 .cindex "&""From""& line"
14253 .cindex "UUCP" "&""From""& line"
14254 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14255 the headers of a message. By default this is treated as the start of the
14256 message's body, which means that any following headers are not recognized as
14257 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14258 match those hosts that insist on sending it. If the sender is actually a local
14259 process rather than a remote host, and is using &%-bs%& to inject the messages,
14260 &%ignore_fromline_local%& must be set to achieve this effect.
14261
14262
14263 .option ignore_fromline_local main boolean false
14264 See &%ignore_fromline_hosts%& above.
14265
14266
14267 .option keep_malformed main time 4d
14268 This option specifies the length of time to keep messages whose spool files
14269 have been corrupted in some way. This should, of course, never happen. At the
14270 next attempt to deliver such a message, it gets removed. The incident is
14271 logged.
14272
14273
14274 .option ldap_ca_cert_dir main string unset
14275 .cindex "LDAP", "TLS CA certificate directory"
14276 This option indicates which directory contains CA certificates for verifying
14277 a TLS certificate presented by an LDAP server.
14278 While Exim does not provide a default value, your SSL library may.
14279 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14280 and constrained to be a directory.
14281
14282
14283 .option ldap_ca_cert_file main string unset
14284 .cindex "LDAP", "TLS CA certificate file"
14285 This option indicates which file contains CA certificates for verifying
14286 a TLS certificate presented by an LDAP server.
14287 While Exim does not provide a default value, your SSL library may.
14288 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14289 and constrained to be a file.
14290
14291
14292 .option ldap_cert_file main string unset
14293 .cindex "LDAP" "TLS client certificate file"
14294 This option indicates which file contains an TLS client certificate which
14295 Exim should present to the LDAP server during TLS negotiation.
14296 Should be used together with &%ldap_cert_key%&.
14297
14298
14299 .option ldap_cert_key main string unset
14300 .cindex "LDAP" "TLS client key file"
14301 This option indicates which file contains the secret/private key to use
14302 to prove identity to the LDAP server during TLS negotiation.
14303 Should be used together with &%ldap_cert_file%&, which contains the
14304 identity to be proven.
14305
14306
14307 .option ldap_cipher_suite main string unset
14308 .cindex "LDAP" "TLS cipher suite"
14309 This controls the TLS cipher-suite negotiation during TLS negotiation with
14310 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14311 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14312
14313
14314 .option ldap_default_servers main "string list" unset
14315 .cindex "LDAP" "default servers"
14316 This option provides a list of LDAP servers which are tried in turn when an
14317 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14318 details of LDAP queries. This option is available only when Exim has been built
14319 with LDAP support.
14320
14321
14322 .option ldap_require_cert main string unset.
14323 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14324 This should be one of the values "hard", "demand", "allow", "try" or "never".
14325 A value other than one of these is interpreted as "never".
14326 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14327 Although Exim does not set a default, the LDAP library probably defaults
14328 to hard/demand.
14329
14330
14331 .option ldap_start_tls main boolean false
14332 .cindex "LDAP" "whether or not to negotiate TLS"
14333 If set, Exim will attempt to negotiate TLS with the LDAP server when
14334 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14335 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14336 of SSL-on-connect.
14337 In the event of failure to negotiate TLS, the action taken is controlled
14338 by &%ldap_require_cert%&.
14339
14340
14341 .option ldap_version main integer unset
14342 .cindex "LDAP" "protocol version, forcing"
14343 This option can be used to force Exim to set a specific protocol version for
14344 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14345 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14346 the LDAP headers; otherwise it is 2. This option is available only when Exim
14347 has been built with LDAP support.
14348
14349
14350
14351 .option local_from_check main boolean true
14352 .cindex "&'Sender:'& header line" "disabling addition of"
14353 .cindex "&'From:'& header line" "disabling checking of"
14354 When a message is submitted locally (that is, not over a TCP/IP connection) by
14355 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14356 checks that the &'From:'& header line matches the login of the calling user and
14357 the domain specified by &%qualify_domain%&.
14358
14359 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14360 locally submitted message is automatically qualified by Exim, unless the
14361 &%-bnq%& command line option is used.
14362
14363 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14364 on the local part. If the &'From:'& header line does not match, Exim adds a
14365 &'Sender:'& header with an address constructed from the calling user's login
14366 and the default qualify domain.
14367
14368 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14369 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14370 &'Sender:'& header lines supplied by untrusted users, you must also set
14371 &%local_sender_retain%& to be true.
14372
14373 .cindex "envelope sender"
14374 These options affect only the header lines in the message. The envelope sender
14375 is still forced to be the login id at the qualify domain unless
14376 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14377
14378 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14379 request similar header line checking. See section &<<SECTthesenhea>>&, which
14380 has more details about &'Sender:'& processing.
14381
14382
14383
14384
14385 .option local_from_prefix main string unset
14386 When Exim checks the &'From:'& header line of locally submitted messages for
14387 matching the login id (see &%local_from_check%& above), it can be configured to
14388 ignore certain prefixes and suffixes in the local part of the address. This is
14389 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14390 appropriate lists, in the same form as the &%local_part_prefix%& and
14391 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14392 example, if
14393 .code
14394 local_from_prefix = *-
14395 .endd
14396 is set, a &'From:'& line containing
14397 .code
14398 From: anything-user@your.domain.example
14399 .endd
14400 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14401 matches the actual sender address that is constructed from the login name and
14402 qualify domain.
14403
14404
14405 .option local_from_suffix main string unset
14406 See &%local_from_prefix%& above.
14407
14408
14409 .option local_interfaces main "string list" "see below"
14410 This option controls which network interfaces are used by the daemon for
14411 listening; they are also used to identify the local host when routing. Chapter
14412 &<<CHAPinterfaces>>& contains a full description of this option and the related
14413 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14414 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14415 &%local_interfaces%& is
14416 .code
14417 local_interfaces = 0.0.0.0
14418 .endd
14419 when Exim is built without IPv6 support; otherwise it is
14420 .code
14421 local_interfaces = <; ::0 ; 0.0.0.0
14422 .endd
14423
14424 .option local_scan_timeout main time 5m
14425 .cindex "timeout" "for &[local_scan()]& function"
14426 .cindex "&[local_scan()]& function" "timeout"
14427 This timeout applies to the &[local_scan()]& function (see chapter
14428 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14429 the incoming message is rejected with a temporary error if it is an SMTP
14430 message. For a non-SMTP message, the message is dropped and Exim ends with a
14431 non-zero code. The incident is logged on the main and reject logs.
14432
14433
14434
14435 .option local_sender_retain main boolean false
14436 .cindex "&'Sender:'& header line" "retaining from local submission"
14437 When a message is submitted locally (that is, not over a TCP/IP connection) by
14438 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14439 do not want this to happen, you must set &%local_sender_retain%&, and you must
14440 also set &%local_from_check%& to be false (Exim will complain if you do not).
14441 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14442 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14443
14444
14445
14446
14447 .option localhost_number main string&!! unset
14448 .cindex "host" "locally unique number for"
14449 .cindex "message ids" "with multiple hosts"
14450 .vindex "&$localhost_number$&"
14451 Exim's message ids are normally unique only within the local host. If
14452 uniqueness among a set of hosts is required, each host must set a different
14453 value for the &%localhost_number%& option. The string is expanded immediately
14454 after reading the configuration file (so that a number can be computed from the
14455 host name, for example) and the result of the expansion must be a number in the
14456 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14457 systems). This is available in subsequent string expansions via the variable
14458 &$localhost_number$&. When &%localhost_number is set%&, the final two
14459 characters of the message id, instead of just being a fractional part of the
14460 time, are computed from the time and the local host number as described in
14461 section &<<SECTmessiden>>&.
14462
14463
14464
14465 .option log_file_path main "string list&!!" "set at compile time"
14466 .cindex "log" "file path for"
14467 This option sets the path which is used to determine the names of Exim's log
14468 files, or indicates that logging is to be to syslog, or both. It is expanded
14469 when Exim is entered, so it can, for example, contain a reference to the host
14470 name. If no specific path is set for the log files at compile or run time, they
14471 are written in a sub-directory called &_log_& in Exim's spool directory.
14472 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14473 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14474 used. If this string is fixed at your installation (contains no expansion
14475 variables) it is recommended that you do not set this option in the
14476 configuration file, but instead supply the path using LOG_FILE_PATH in
14477 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14478 early on &-- in particular, failure to read the configuration file.
14479
14480
14481 .option log_selector main string unset
14482 .cindex "log" "selectors"
14483 This option can be used to reduce or increase the number of things that Exim
14484 writes to its log files. Its argument is made up of names preceded by plus or
14485 minus characters. For example:
14486 .code
14487 log_selector = +arguments -retry_defer
14488 .endd
14489 A list of possible names and what they control is given in the chapter on
14490 logging, in section &<<SECTlogselector>>&.
14491
14492
14493 .option log_timezone main boolean false
14494 .cindex "log" "timezone for entries"
14495 .vindex "&$tod_log$&"
14496 .vindex "&$tod_zone$&"
14497 By default, the timestamps on log lines are in local time without the
14498 timezone. This means that if your timezone changes twice a year, the timestamps
14499 in log lines are ambiguous for an hour when the clocks go back. One way of
14500 avoiding this problem is to set the timezone to UTC. An alternative is to set
14501 &%log_timezone%& true. This turns on the addition of the timezone offset to
14502 timestamps in log lines. Turning on this option can add quite a lot to the size
14503 of log files because each line is extended by 6 characters. Note that the
14504 &$tod_log$& variable contains the log timestamp without the zone, but there is
14505 another variable called &$tod_zone$& that contains just the timezone offset.
14506
14507
14508 .option lookup_open_max main integer 25
14509 .cindex "too many open files"
14510 .cindex "open files, too many"
14511 .cindex "file" "too many open"
14512 .cindex "lookup" "maximum open files"
14513 .cindex "limit" "open files for lookups"
14514 This option limits the number of simultaneously open files for single-key
14515 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14516 Exim normally keeps these files open during routing, because often the same
14517 file is required several times. If the limit is reached, Exim closes the least
14518 recently used file. Note that if you are using the &'ndbm'& library, it
14519 actually opens two files for each logical DBM database, though it still counts
14520 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14521 open files"& errors with NDBM, you need to reduce the value of
14522 &%lookup_open_max%&.
14523
14524
14525 .option max_username_length main integer 0
14526 .cindex "length of login name"
14527 .cindex "user name" "maximum length"
14528 .cindex "limit" "user name length"
14529 Some operating systems are broken in that they truncate long arguments to
14530 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14531 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14532 an argument that is longer behaves as if &[getpwnam()]& failed.
14533
14534
14535 .option message_body_newlines main bool false
14536 .cindex "message body" "newlines in variables"
14537 .cindex "newline" "in message body variables"
14538 .vindex "&$message_body$&"
14539 .vindex "&$message_body_end$&"
14540 By default, newlines in the message body are replaced by spaces when setting
14541 the &$message_body$& and &$message_body_end$& expansion variables. If this
14542 option is set true, this no longer happens.
14543
14544
14545 .option message_body_visible main integer 500
14546 .cindex "body of message" "visible size"
14547 .cindex "message body" "visible size"
14548 .vindex "&$message_body$&"
14549 .vindex "&$message_body_end$&"
14550 This option specifies how much of a message's body is to be included in the
14551 &$message_body$& and &$message_body_end$& expansion variables.
14552
14553
14554 .option message_id_header_domain main string&!! unset
14555 .cindex "&'Message-ID:'& header line"
14556 If this option is set, the string is expanded and used as the right hand side
14557 (domain) of the &'Message-ID:'& header that Exim creates if a
14558 locally-originated incoming message does not have one. &"Locally-originated"&
14559 means &"not received over TCP/IP."&
14560 Otherwise, the primary host name is used.
14561 Only letters, digits, dot and hyphen are accepted; any other characters are
14562 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14563 empty string, the option is ignored.
14564
14565
14566 .option message_id_header_text main string&!! unset
14567 If this variable is set, the string is expanded and used to augment the text of
14568 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14569 message does not have one. The text of this header is required by RFC 2822 to
14570 take the form of an address. By default, Exim uses its internal message id as
14571 the local part, and the primary host name as the domain. If this option is set,
14572 it is expanded, and provided the expansion is not forced to fail, and does not
14573 yield an empty string, the result is inserted into the header immediately
14574 before the @, separated from the internal message id by a dot. Any characters
14575 that are illegal in an address are automatically converted into hyphens. This
14576 means that variables such as &$tod_log$& can be used, because the spaces and
14577 colons will become hyphens.
14578
14579
14580 .option message_logs main boolean true
14581 .cindex "message logs" "disabling"
14582 .cindex "log" "message log; disabling"
14583 If this option is turned off, per-message log files are not created in the
14584 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14585 Exim, by reducing the number of files involved in handling a message from a
14586 minimum of four (header spool file, body spool file, delivery journal, and
14587 per-message log) to three. The other major I/O activity is Exim's main log,
14588 which is not affected by this option.
14589
14590
14591 .option message_size_limit main string&!! 50M
14592 .cindex "message" "size limit"
14593 .cindex "limit" "message size"
14594 .cindex "size" "of message, limit"
14595 This option limits the maximum size of message that Exim will process. The
14596 value is expanded for each incoming connection so, for example, it can be made
14597 to depend on the IP address of the remote host for messages arriving via
14598 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14599 optionally followed by K or M.
14600
14601 &*Note*&: This limit cannot be made to depend on a message's sender or any
14602 other properties of an individual message, because it has to be advertised in
14603 the server's response to EHLO. String expansion failure causes a temporary
14604 error. A value of zero means no limit, but its use is not recommended. See also
14605 &%bounce_return_size_limit%&.
14606
14607 Incoming SMTP messages are failed with a 552 error if the limit is
14608 exceeded; locally-generated messages either get a stderr message or a delivery
14609 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14610 an oversized message is logged in both the main and the reject logs. See also
14611 the generic transport option &%message_size_limit%&, which limits the size of
14612 message that an individual transport can process.
14613
14614 If you use a virus-scanner and set this option to to a value larger than the
14615 maximum size that your virus-scanner is configured to support, you may get
14616 failures triggered by large mails.  The right size to configure for the
14617 virus-scanner depends upon what data is passed and the options in use but it's
14618 probably safest to just set it to a little larger than this value.  Eg, with a
14619 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14620 some problems may result.
14621
14622 A value of 0 will disable size limit checking; Exim will still advertise the
14623 SIZE extension in an EHLO response, but without a limit, so as to permit
14624 SMTP clients to still indicate the message size along with the MAIL verb.
14625
14626
14627 .option move_frozen_messages main boolean false
14628 .cindex "frozen messages" "moving"
14629 This option, which is available only if Exim has been built with the setting
14630 .code
14631 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14632 .endd
14633 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14634 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14635 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14636 standard utilities for handling such moved messages, and they do not show up in
14637 lists generated by &%-bp%& or by the Exim monitor.
14638
14639
14640 .option mua_wrapper main boolean false
14641 Setting this option true causes Exim to run in a very restrictive mode in which
14642 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14643 contains a full description of this facility.
14644
14645
14646
14647 .option mysql_servers main "string list" unset
14648 .cindex "MySQL" "server list"
14649 This option provides a list of MySQL servers and associated connection data, to
14650 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14651 option is available only if Exim has been built with MySQL support.
14652
14653
14654 .option never_users main "string list&!!" unset
14655 This option is expanded just once, at the start of Exim's processing. Local
14656 message deliveries are normally run in processes that are setuid to the
14657 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14658 It is usually desirable to prevent any deliveries from running as root, as a
14659 safety precaution.
14660
14661 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14662 list of users that must not be used for local deliveries. This list is fixed in
14663 the binary and cannot be overridden by the configuration file. By default, it
14664 contains just the single user name &"root"&. The &%never_users%& runtime option
14665 can be used to add more users to the fixed list.
14666
14667 If a message is to be delivered as one of the users on the fixed list or the
14668 &%never_users%& list, an error occurs, and delivery is deferred. A common
14669 example is
14670 .code
14671 never_users = root:daemon:bin
14672 .endd
14673 Including root is redundant if it is also on the fixed list, but it does no
14674 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14675 transport driver.
14676
14677
14678 .option openssl_options main "string list" "+no_sslv2"
14679 .cindex "OpenSSL "compatibility options"
14680 This option allows an administrator to adjust the SSL options applied
14681 by OpenSSL to connections.  It is given as a space-separated list of items,
14682 each one to be +added or -subtracted from the current value.
14683
14684 This option is only available if Exim is built against OpenSSL.  The values
14685 available for this option vary according to the age of your OpenSSL install.
14686 The &"all"& value controls a subset of flags which are available, typically
14687 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14688 list the values known on your system and Exim should support all the
14689 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14690 names lose the leading &"SSL_OP_"& and are lower-cased.
14691
14692 Note that adjusting the options can have severe impact upon the security of
14693 SSL as used by Exim.  It is possible to disable safety checks and shoot
14694 yourself in the foot in various unpleasant ways.  This option should not be
14695 adjusted lightly.  An unrecognised item will be detected at startup, by
14696 invoking Exim with the &%-bV%& flag.
14697
14698 Historical note: prior to release 4.80, Exim defaulted this value to
14699 "+dont_insert_empty_fragments", which may still be needed for compatibility
14700 with some clients, but which lowers security by increasing exposure to
14701 some now infamous attacks.
14702
14703 An example:
14704 .code
14705 # Make both old MS and old Eudora happy:
14706 openssl_options = -all +microsoft_big_sslv3_buffer \
14707                        +dont_insert_empty_fragments
14708 .endd
14709
14710 Possible options may include:
14711 .ilist
14712 &`all`&
14713 .next
14714 &`allow_unsafe_legacy_renegotiation`&
14715 .next
14716 &`cipher_server_preference`&
14717 .next
14718 &`dont_insert_empty_fragments`&
14719 .next
14720 &`ephemeral_rsa`&
14721 .next
14722 &`legacy_server_connect`&
14723 .next
14724 &`microsoft_big_sslv3_buffer`&
14725 .next
14726 &`microsoft_sess_id_bug`&
14727 .next
14728 &`msie_sslv2_rsa_padding`&
14729 .next
14730 &`netscape_challenge_bug`&
14731 .next
14732 &`netscape_reuse_cipher_change_bug`&
14733 .next
14734 &`no_compression`&
14735 .next
14736 &`no_session_resumption_on_renegotiation`&
14737 .next
14738 &`no_sslv2`&
14739 .next
14740 &`no_sslv3`&
14741 .next
14742 &`no_ticket`&
14743 .next
14744 &`no_tlsv1`&
14745 .next
14746 &`no_tlsv1_1`&
14747 .next
14748 &`no_tlsv1_2`&
14749 .next
14750 &`safari_ecdhe_ecdsa_bug`&
14751 .next
14752 &`single_dh_use`&
14753 .next
14754 &`single_ecdh_use`&
14755 .next
14756 &`ssleay_080_client_dh_bug`&
14757 .next
14758 &`sslref2_reuse_cert_type_bug`&
14759 .next
14760 &`tls_block_padding_bug`&
14761 .next
14762 &`tls_d5_bug`&
14763 .next
14764 &`tls_rollback_bug`&
14765 .endlist
14766
14767 .new
14768 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
14769 all clients connecting using the MacOS SecureTransport TLS facility prior
14770 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
14771 to negotiate TLS then this option value might help, provided that your OpenSSL
14772 release is new enough to contain this work-around.  This may be a situation
14773 where you have to upgrade OpenSSL to get buggy clients working.
14774 .wen
14775
14776
14777 .option oracle_servers main "string list" unset
14778 .cindex "Oracle" "server list"
14779 This option provides a list of Oracle servers and associated connection data,
14780 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14781 The option is available only if Exim has been built with Oracle support.
14782
14783
14784 .option percent_hack_domains main "domain list&!!" unset
14785 .cindex "&""percent hack""&"
14786 .cindex "source routing" "in email address"
14787 .cindex "address" "source-routed"
14788 The &"percent hack"& is the convention whereby a local part containing a
14789 percent sign is re-interpreted as a new email address, with the percent
14790 replaced by @. This is sometimes called &"source routing"&, though that term is
14791 also applied to RFC 2822 addresses that begin with an @ character. If this
14792 option is set, Exim implements the percent facility for those domains listed,
14793 but no others. This happens before an incoming SMTP address is tested against
14794 an ACL.
14795
14796 &*Warning*&: The &"percent hack"& has often been abused by people who are
14797 trying to get round relaying restrictions. For this reason, it is best avoided
14798 if at all possible. Unfortunately, a number of less security-conscious MTAs
14799 implement it unconditionally. If you are running Exim on a gateway host, and
14800 routing mail through to internal MTAs without processing the local parts, it is
14801 a good idea to reject recipient addresses with percent characters in their
14802 local parts. Exim's default configuration does this.
14803
14804
14805 .option perl_at_start main boolean false
14806 This option is available only when Exim is built with an embedded Perl
14807 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14808
14809
14810 .option perl_startup main string unset
14811 This option is available only when Exim is built with an embedded Perl
14812 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14813
14814
14815 .option pgsql_servers main "string list" unset
14816 .cindex "PostgreSQL lookup type" "server list"
14817 This option provides a list of PostgreSQL servers and associated connection
14818 data, to be used in conjunction with &(pgsql)& lookups (see section
14819 &<<SECID72>>&). The option is available only if Exim has been built with
14820 PostgreSQL support.
14821
14822
14823 .option pid_file_path main string&!! "set at compile time"
14824 .cindex "daemon" "pid file path"
14825 .cindex "pid file, path for"
14826 This option sets the name of the file to which the Exim daemon writes its
14827 process id. The string is expanded, so it can contain, for example, references
14828 to the host name:
14829 .code
14830 pid_file_path = /var/log/$primary_hostname/exim.pid
14831 .endd
14832 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14833 spool directory.
14834 The value set by the option can be overridden by the &%-oP%& command line
14835 option. A pid file is not written if a &"non-standard"& daemon is run by means
14836 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14837
14838
14839 .option pipelining_advertise_hosts main "host list&!!" *
14840 .cindex "PIPELINING" "suppressing advertising"
14841 This option can be used to suppress the advertisement of the SMTP
14842 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14843 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14844 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14845 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14846 that clients will use it; &"out of order"& commands that are &"expected"& do
14847 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14848
14849
14850 .option preserve_message_logs main boolean false
14851 .cindex "message logs" "preserving"
14852 If this option is set, message log files are not deleted when messages are
14853 completed. Instead, they are moved to a sub-directory of the spool directory
14854 called &_msglog.OLD_&, where they remain available for statistical or debugging
14855 purposes. This is a dangerous option to set on systems with any appreciable
14856 volume of mail. Use with care!
14857
14858
14859 .option primary_hostname main string "see below"
14860 .cindex "name" "of local host"
14861 .cindex "host" "name of local"
14862 .cindex "local host" "name of"
14863 .vindex "&$primary_hostname$&"
14864 This specifies the name of the current host. It is used in the default EHLO or
14865 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14866 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14867 The value is also used by default in some SMTP response messages from an Exim
14868 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14869
14870 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14871 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14872 contains only one component, Exim passes it to &[gethostbyname()]& (or
14873 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14874 version. The variable &$primary_hostname$& contains the host name, whether set
14875 explicitly by this option, or defaulted.
14876
14877
14878 .option print_topbitchars main boolean false
14879 .cindex "printing characters"
14880 .cindex "8-bit characters"
14881 By default, Exim considers only those characters whose codes lie in the range
14882 32&--126 to be printing characters. In a number of circumstances (for example,
14883 when writing log entries) non-printing characters are converted into escape
14884 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14885 is set, code values of 128 and above are also considered to be printing
14886 characters.
14887
14888 This option also affects the header syntax checks performed by the
14889 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14890 the user's full name when constructing From: and Sender: addresses (as
14891 described in section &<<SECTconstr>>&). Setting this option can cause
14892 Exim to generate eight bit message headers that do not conform to the
14893 standards.
14894
14895
14896 .option process_log_path main string unset
14897 .cindex "process log path"
14898 .cindex "log" "process log"
14899 .cindex "&'exiwhat'&"
14900 This option sets the name of the file to which an Exim process writes its
14901 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14902 utility script. If this option is unset, the file called &_exim-process.info_&
14903 in Exim's spool directory is used. The ability to specify the name explicitly
14904 can be useful in environments where two different Exims are running, using
14905 different spool directories.
14906
14907
14908 .option prod_requires_admin main boolean true
14909 .oindex "&%-M%&"
14910 .oindex "&%-R%&"
14911 .oindex "&%-q%&"
14912 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14913 admin user unless &%prod_requires_admin%& is set false. See also
14914 &%queue_list_requires_admin%&.
14915
14916
14917 .option qualify_domain main string "see below"
14918 .cindex "domain" "for qualifying addresses"
14919 .cindex "address" "qualification"
14920 This option specifies the domain name that is added to any envelope sender
14921 addresses that do not have a domain qualification. It also applies to
14922 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14923 are accepted by default only for locally-generated messages. Qualification is
14924 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14925 locally-generated messages, unless the &%-bnq%& command line option is used.
14926
14927 Messages from external sources must always contain fully qualified addresses,
14928 unless the sending host matches &%sender_unqualified_hosts%& or
14929 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14930 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14931 necessary. Internally, Exim always works with fully qualified envelope
14932 addresses. If &%qualify_domain%& is not set, it defaults to the
14933 &%primary_hostname%& value.
14934
14935
14936 .option qualify_recipient main string "see below"
14937 This option allows you to specify a different domain for qualifying recipient
14938 addresses to the one that is used for senders. See &%qualify_domain%& above.
14939
14940
14941
14942 .option queue_domains main "domain list&!!" unset
14943 .cindex "domain" "specifying non-immediate delivery"
14944 .cindex "queueing incoming messages"
14945 .cindex "message" "queueing certain domains"
14946 This option lists domains for which immediate delivery is not required.
14947 A delivery process is started whenever a message is received, but only those
14948 domains that do not match are processed. All other deliveries wait until the
14949 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14950
14951
14952 .option queue_list_requires_admin main boolean true
14953 .oindex "&%-bp%&"
14954 The &%-bp%& command-line option, which lists the messages that are on the
14955 queue, requires the caller to be an admin user unless
14956 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14957
14958
14959 .option queue_only main boolean false
14960 .cindex "queueing incoming messages"
14961 .cindex "message" "queueing unconditionally"
14962 If &%queue_only%& is set, a delivery process is not automatically started
14963 whenever a message is received. Instead, the message waits on the queue for the
14964 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14965 delivered immediately when certain conditions (such as heavy load) occur.
14966
14967 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14968 and &%-odi%& command line options override &%queue_only%& unless
14969 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14970 &%queue_only_load%&, and &%smtp_accept_queue%&.
14971
14972
14973 .option queue_only_file main string unset
14974 .cindex "queueing incoming messages"
14975 .cindex "message" "queueing by file existence"
14976 This option can be set to a colon-separated list of absolute path names, each
14977 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14978 it tests for the existence of each listed path using a call to &[stat()]&. For
14979 each path that exists, the corresponding queueing option is set.
14980 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14981 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14982 .code
14983 queue_only_file = smtp/some/file
14984 .endd
14985 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14986 &_/some/file_& exists.
14987
14988
14989 .option queue_only_load main fixed-point unset
14990 .cindex "load average"
14991 .cindex "queueing incoming messages"
14992 .cindex "message" "queueing by load"
14993 If the system load average is higher than this value, incoming messages from
14994 all sources are queued, and no automatic deliveries are started. If this
14995 happens during local or remote SMTP input, all subsequent messages received on
14996 the same SMTP connection are queued by default, whatever happens to the load in
14997 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14998 false.
14999
15000 Deliveries will subsequently be performed by queue runner processes. This
15001 option has no effect on ancient operating systems on which Exim cannot
15002 determine the load average. See also &%deliver_queue_load_max%& and
15003 &%smtp_load_reserve%&.
15004
15005
15006 .option queue_only_load_latch main boolean true
15007 .cindex "load average" "re-evaluating per message"
15008 When this option is true (the default), once one message has been queued
15009 because the load average is higher than the value set by &%queue_only_load%&,
15010 all subsequent messages received on the same SMTP connection are also queued.
15011 This is a deliberate choice; even though the load average may fall below the
15012 threshold, it doesn't seem right to deliver later messages on the same
15013 connection when not delivering earlier ones. However, there are special
15014 circumstances such as very long-lived connections from scanning appliances
15015 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15016 should be set false. This causes the value of the load average to be
15017 re-evaluated for each message.
15018
15019
15020 .option queue_only_override main boolean true
15021 .cindex "queueing incoming messages"
15022 When this option is true, the &%-od%&&'x'& command line options override the
15023 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15024 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15025 to override; they are accepted, but ignored.
15026
15027
15028 .option queue_run_in_order main boolean false
15029 .cindex "queue runner" "processing messages in order"
15030 If this option is set, queue runs happen in order of message arrival instead of
15031 in an arbitrary order. For this to happen, a complete list of the entire queue
15032 must be set up before the deliveries start. When the queue is all held in a
15033 single directory (the default), a single list is created for both the ordered
15034 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15035 single list is not created when &%queue_run_in_order%& is false. In this case,
15036 the sub-directories are processed one at a time (in a random order), and this
15037 avoids setting up one huge list for the whole queue. Thus, setting
15038 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15039 when the queue is large, because of the extra work in setting up the single,
15040 large list. In most situations, &%queue_run_in_order%& should not be set.
15041
15042
15043
15044 .option queue_run_max main integer 5
15045 .cindex "queue runner" "maximum number of"
15046 This controls the maximum number of queue runner processes that an Exim daemon
15047 can run simultaneously. This does not mean that it starts them all at once,
15048 but rather that if the maximum number are still running when the time comes to
15049 start another one, it refrains from starting another one. This can happen with
15050 very large queues and/or very sluggish deliveries. This option does not,
15051 however, interlock with other processes, so additional queue runners can be
15052 started by other means, or by killing and restarting the daemon.
15053
15054 Setting this option to zero does not suppress queue runs; rather, it disables
15055 the limit, allowing any number of simultaneous queue runner processes to be
15056 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15057 the daemon's command line.
15058
15059 .option queue_smtp_domains main "domain list&!!" unset
15060 .cindex "queueing incoming messages"
15061 .cindex "message" "queueing remote deliveries"
15062 When this option is set, a delivery process is started whenever a message is
15063 received, routing is performed, and local deliveries take place.
15064 However, if any SMTP deliveries are required for domains that match
15065 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15066 message waits on the queue for the next queue run. Since routing of the message
15067 has taken place, Exim knows to which remote hosts it must be delivered, and so
15068 when the queue run happens, multiple messages for the same host are delivered
15069 over a single SMTP connection. The &%-odqs%& command line option causes all
15070 SMTP deliveries to be queued in this way, and is equivalent to setting
15071 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15072 &%queue_domains%&.
15073
15074
15075 .option receive_timeout main time 0s
15076 .cindex "timeout" "for non-SMTP input"
15077 This option sets the timeout for accepting a non-SMTP message, that is, the
15078 maximum time that Exim waits when reading a message on the standard input. If
15079 the value is zero, it will wait for ever. This setting is overridden by the
15080 &%-or%& command line option. The timeout for incoming SMTP messages is
15081 controlled by &%smtp_receive_timeout%&.
15082
15083 .option received_header_text main string&!! "see below"
15084 .cindex "customizing" "&'Received:'& header"
15085 .cindex "&'Received:'& header line" "customizing"
15086 This string defines the contents of the &'Received:'& message header that is
15087 added to each message, except for the timestamp, which is automatically added
15088 on at the end (preceded by a semicolon). The string is expanded each time it is
15089 used. If the expansion yields an empty string, no &'Received:'& header line is
15090 added to the message. Otherwise, the string should start with the text
15091 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15092 header lines. The default setting is:
15093
15094 .code
15095 received_header_text = Received: \
15096   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15097   {${if def:sender_ident \
15098   {from ${quote_local_part:$sender_ident} }}\
15099   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15100   by $primary_hostname \
15101   ${if def:received_protocol {with $received_protocol}} \
15102   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15103   (Exim $version_number)\n\t\
15104   ${if def:sender_address \
15105   {(envelope-from <$sender_address>)\n\t}}\
15106   id $message_exim_id\
15107   ${if def:received_for {\n\tfor $received_for}}
15108 .endd
15109
15110 The reference to the TLS cipher is omitted when Exim is built without TLS
15111 support. The use of conditional expansions ensures that this works for both
15112 locally generated messages and messages received from remote hosts, giving
15113 header lines such as the following:
15114 .code
15115 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15116 by marley.carol.example with esmtp (Exim 4.00)
15117 (envelope-from <bob@carol.example>)
15118 id 16IOWa-00019l-00
15119 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15120 Received: by scrooge.carol.example with local (Exim 4.00)
15121 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15122 .endd
15123 Until the body of the message has been received, the timestamp is the time when
15124 the message started to be received. Once the body has arrived, and all policy
15125 checks have taken place, the timestamp is updated to the time at which the
15126 message was accepted.
15127
15128
15129 .option received_headers_max main integer 30
15130 .cindex "loop" "prevention"
15131 .cindex "mail loop prevention"
15132 .cindex "&'Received:'& header line" "counting"
15133 When a message is to be delivered, the number of &'Received:'& headers is
15134 counted, and if it is greater than this parameter, a mail loop is assumed to
15135 have occurred, the delivery is abandoned, and an error message is generated.
15136 This applies to both local and remote deliveries.
15137
15138
15139 .option recipient_unqualified_hosts main "host list&!!" unset
15140 .cindex "unqualified addresses"
15141 .cindex "host" "unqualified addresses from"
15142 This option lists those hosts from which Exim is prepared to accept unqualified
15143 recipient addresses in message envelopes. The addresses are made fully
15144 qualified by the addition of the &%qualify_recipient%& value. This option also
15145 affects message header lines. Exim does not reject unqualified recipient
15146 addresses in headers, but it qualifies them only if the message came from a
15147 host that matches &%recipient_unqualified_hosts%&,
15148 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15149 option was not set.
15150
15151
15152 .option recipients_max main integer 0
15153 .cindex "limit" "number of recipients"
15154 .cindex "recipient" "maximum number"
15155 If this option is set greater than zero, it specifies the maximum number of
15156 original recipients for any message. Additional recipients that are generated
15157 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15158 all recipients over the limit; earlier recipients are delivered as normal.
15159 Non-SMTP messages with too many recipients are failed, and no deliveries are
15160 done.
15161
15162 .cindex "RCPT" "maximum number of incoming"
15163 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15164 RCPT commands in a single message.
15165
15166
15167 .option recipients_max_reject main boolean false
15168 If this option is set true, Exim rejects SMTP messages containing too many
15169 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15170 error to the eventual DATA command. Otherwise (the default) it gives a 452
15171 error to the surplus RCPT commands and accepts the message on behalf of the
15172 initial set of recipients. The remote server should then re-send the message
15173 for the remaining recipients at a later time.
15174
15175
15176 .option remote_max_parallel main integer 2
15177 .cindex "delivery" "parallelism for remote"
15178 This option controls parallel delivery of one message to a number of remote
15179 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15180 does all the remote deliveries for a message one by one. Otherwise, if a single
15181 message has to be delivered to more than one remote host, or if several copies
15182 have to be sent to the same remote host, up to &%remote_max_parallel%&
15183 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15184 deliveries are required, the maximum number of processes are started, and as
15185 each one finishes, another is begun. The order of starting processes is the
15186 same as if sequential delivery were being done, and can be controlled by the
15187 &%remote_sort_domains%& option. If parallel delivery takes place while running
15188 with debugging turned on, the debugging output from each delivery process is
15189 tagged with its process id.
15190
15191 This option controls only the maximum number of parallel deliveries for one
15192 message in one Exim delivery process. Because Exim has no central queue
15193 manager, there is no way of controlling the total number of simultaneous
15194 deliveries if the configuration allows a delivery attempt as soon as a message
15195 is received.
15196
15197 .cindex "number of deliveries"
15198 .cindex "delivery" "maximum number of"
15199 If you want to control the total number of deliveries on the system, you
15200 need to set the &%queue_only%& option. This ensures that all incoming messages
15201 are added to the queue without starting a delivery process. Then set up an Exim
15202 daemon to start queue runner processes at appropriate intervals (probably
15203 fairly often, for example, every minute), and limit the total number of queue
15204 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15205 delivers only one message at a time, the maximum number of deliveries that can
15206 then take place at once is &%queue_run_max%& multiplied by
15207 &%remote_max_parallel%&.
15208
15209 If it is purely remote deliveries you want to control, use
15210 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15211 doing the SMTP routing before queueing, so that several messages for the same
15212 host will eventually get delivered down the same connection.
15213
15214
15215 .option remote_sort_domains main "domain list&!!" unset
15216 .cindex "sorting remote deliveries"
15217 .cindex "delivery" "sorting remote"
15218 When there are a number of remote deliveries for a message, they are sorted by
15219 domain into the order given by this list. For example,
15220 .code
15221 remote_sort_domains = *.cam.ac.uk:*.uk
15222 .endd
15223 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15224 then to those in the &%uk%& domain, then to any others.
15225
15226
15227 .option retry_data_expire main time 7d
15228 .cindex "hints database" "data expiry"
15229 This option sets a &"use before"& time on retry information in Exim's hints
15230 database. Any older retry data is ignored. This means that, for example, once a
15231 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15232 past failures.
15233
15234
15235 .option retry_interval_max main time 24h
15236 .cindex "retry" "limit on interval"
15237 .cindex "limit" "on retry interval"
15238 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15239 intervals between delivery attempts for messages that cannot be delivered
15240 straight away. This option sets an overall limit to the length of time between
15241 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15242 the default value.
15243
15244
15245 .option return_path_remove main boolean true
15246 .cindex "&'Return-path:'& header line" "removing"
15247 RFC 2821, section 4.4, states that an SMTP server must insert a
15248 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15249 The &'Return-path:'& header preserves the sender address as received in the
15250 MAIL command. This description implies that this header should not be present
15251 in an incoming message. If &%return_path_remove%& is true, any existing
15252 &'Return-path:'& headers are removed from messages at the time they are
15253 received. Exim's transports have options for adding &'Return-path:'& headers at
15254 the time of delivery. They are normally used only for final local deliveries.
15255
15256
15257 .option return_size_limit main integer 100K
15258 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15259
15260
15261 .option rfc1413_hosts main "host list&!!" *
15262 .cindex "RFC 1413"
15263 .cindex "host" "for RFC 1413 calls"
15264 RFC 1413 identification calls are made to any client host which matches an item
15265 in the list.
15266
15267 .option rfc1413_query_timeout main time 5s
15268 .cindex "RFC 1413" "query timeout"
15269 .cindex "timeout" "for RFC 1413 call"
15270 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15271 no RFC 1413 calls are ever made.
15272
15273
15274 .option sender_unqualified_hosts main "host list&!!" unset
15275 .cindex "unqualified addresses"
15276 .cindex "host" "unqualified addresses from"
15277 This option lists those hosts from which Exim is prepared to accept unqualified
15278 sender addresses. The addresses are made fully qualified by the addition of
15279 &%qualify_domain%&. This option also affects message header lines. Exim does
15280 not reject unqualified addresses in headers that contain sender addresses, but
15281 it qualifies them only if the message came from a host that matches
15282 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15283 using TCP/IP), and the &%-bnq%& option was not set.
15284
15285
15286 .option smtp_accept_keepalive main boolean true
15287 .cindex "keepalive" "on incoming connection"
15288 This option controls the setting of the SO_KEEPALIVE option on incoming
15289 TCP/IP socket connections. When set, it causes the kernel to probe idle
15290 connections periodically, by sending packets with &"old"& sequence numbers. The
15291 other end of the connection should send an acknowledgment if the connection is
15292 still okay or a reset if the connection has been aborted. The reason for doing
15293 this is that it has the beneficial effect of freeing up certain types of
15294 connection that can get stuck when the remote host is disconnected without
15295 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15296 hours to detect unreachable hosts.
15297
15298
15299
15300 .option smtp_accept_max main integer 20
15301 .cindex "limit" "incoming SMTP connections"
15302 .cindex "SMTP" "incoming connection count"
15303 .cindex "inetd"
15304 This option specifies the maximum number of simultaneous incoming SMTP calls
15305 that Exim will accept. It applies only to the listening daemon; there is no
15306 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15307 value is set to zero, no limit is applied. However, it is required to be
15308 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15309 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15310
15311 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15312 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15313 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15314 and &%smtp_load_reserve%& are then checked before accepting the connection.
15315
15316
15317 .option smtp_accept_max_nonmail main integer 10
15318 .cindex "limit" "non-mail SMTP commands"
15319 .cindex "SMTP" "limiting non-mail commands"
15320 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15321 the connection if there are too many. This option defines &"too many"&. The
15322 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15323 client looping sending EHLO, for example. The check is applied only if the
15324 client host matches &%smtp_accept_max_nonmail_hosts%&.
15325
15326 When a new message is expected, one occurrence of RSET is not counted. This
15327 allows a client to send one RSET between messages (this is not necessary,
15328 but some clients do it). Exim also allows one uncounted occurrence of HELO
15329 or EHLO, and one occurrence of STARTTLS between messages. After
15330 starting up a TLS session, another EHLO is expected, and so it too is not
15331 counted. The first occurrence of AUTH in a connection, or immediately
15332 following STARTTLS is not counted. Otherwise, all commands other than
15333 MAIL, RCPT, DATA, and QUIT are counted.
15334
15335
15336 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15337 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15338 check by setting this option. The default value makes it apply to all hosts. By
15339 changing the value, you can exclude any badly-behaved hosts that you have to
15340 live with.
15341
15342
15343 . Allow this long option name to split; give it unsplit as a fifth argument
15344 . for the automatic .oindex that is generated by .option.
15345
15346 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15347          smtp_accept_max_per_connection
15348 .cindex "SMTP" "limiting incoming message count"
15349 .cindex "limit" "messages per SMTP connection"
15350 The value of this option limits the number of MAIL commands that Exim is
15351 prepared to accept over a single SMTP connection, whether or not each command
15352 results in the transfer of a message. After the limit is reached, a 421
15353 response is given to subsequent MAIL commands. This limit is a safety
15354 precaution against a client that goes mad (incidents of this type have been
15355 seen).
15356
15357
15358 .option smtp_accept_max_per_host main string&!! unset
15359 .cindex "limit" "SMTP connections from one host"
15360 .cindex "host" "limiting SMTP connections from"
15361 This option restricts the number of simultaneous IP connections from a single
15362 host (strictly, from a single IP address) to the Exim daemon. The option is
15363 expanded, to enable different limits to be applied to different hosts by
15364 reference to &$sender_host_address$&. Once the limit is reached, additional
15365 connection attempts from the same host are rejected with error code 421. This
15366 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15367 of zero imposes no limit. If this option is set greater than zero, it is
15368 required that &%smtp_accept_max%& be non-zero.
15369
15370 &*Warning*&: When setting this option you should not use any expansion
15371 constructions that take an appreciable amount of time. The expansion and test
15372 happen in the main daemon loop, in order to reject additional connections
15373 without forking additional processes (otherwise a denial-of-service attack
15374 could cause a vast number or processes to be created). While the daemon is
15375 doing this processing, it cannot accept any other incoming connections.
15376
15377
15378
15379 .option smtp_accept_queue main integer 0
15380 .cindex "SMTP" "incoming connection count"
15381 .cindex "queueing incoming messages"
15382 .cindex "message" "queueing by SMTP connection count"
15383 If the number of simultaneous incoming SMTP connections being handled via the
15384 listening daemon exceeds this value, messages received by SMTP are just placed
15385 on the queue; no delivery processes are started automatically. The count is
15386 fixed at the start of an SMTP connection. It cannot be updated in the
15387 subprocess that receives messages, and so the queueing or not queueing applies
15388 to all messages received in the same connection.
15389
15390 A value of zero implies no limit, and clearly any non-zero value is useful only
15391 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15392 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15393 various &%-od%&&'x'& command line options.
15394
15395
15396 . Allow this long option name to split; give it unsplit as a fifth argument
15397 . for the automatic .oindex that is generated by .option.
15398
15399 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15400          smtp_accept_queue_per_connection
15401 .cindex "queueing incoming messages"
15402 .cindex "message" "queueing by message count"
15403 This option limits the number of delivery processes that Exim starts
15404 automatically when receiving messages via SMTP, whether via the daemon or by
15405 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15406 and the number of messages received in a single SMTP session exceeds this
15407 number, subsequent messages are placed on the queue, but no delivery processes
15408 are started. This helps to limit the number of Exim processes when a server
15409 restarts after downtime and there is a lot of mail waiting for it on other
15410 systems. On large systems, the default should probably be increased, and on
15411 dial-in client systems it should probably be set to zero (that is, disabled).
15412
15413
15414 .option smtp_accept_reserve main integer 0
15415 .cindex "SMTP" "incoming call count"
15416 .cindex "host" "reserved"
15417 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15418 number of SMTP connections that are reserved for connections from the hosts
15419 that are specified in &%smtp_reserve_hosts%&. The value set in
15420 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15421 restricted to this number of connections; the option specifies a minimum number
15422 of connection slots for them, not a maximum. It is a guarantee that this group
15423 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15424 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15425 individual host.
15426
15427 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15428 set to 5, once there are 45 active connections (from any hosts), new
15429 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15430 provided the other criteria for acceptance are met.
15431
15432
15433 .option smtp_active_hostname main string&!! unset
15434 .cindex "host" "name in SMTP responses"
15435 .cindex "SMTP" "host name in responses"
15436 .vindex "&$primary_hostname$&"
15437 This option is provided for multi-homed servers that want to masquerade as
15438 several different hosts. At the start of an incoming SMTP connection, its value
15439 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15440 responses. For example, it is used as domain name in the response to an
15441 incoming HELO or EHLO command.
15442
15443 .vindex "&$smtp_active_hostname$&"
15444 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15445 is saved with any messages that are received. It is therefore available for use
15446 in routers and transports when the message is later delivered.
15447
15448 If this option is unset, or if its expansion is forced to fail, or if the
15449 expansion results in an empty string, the value of &$primary_hostname$& is
15450 used. Other expansion failures cause a message to be written to the main and
15451 panic logs, and the SMTP command receives a temporary error. Typically, the
15452 value of &%smtp_active_hostname%& depends on the incoming interface address.
15453 For example:
15454 .code
15455 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15456   {cox.mydomain}{box.mydomain}}
15457 .endd
15458
15459 Although &$smtp_active_hostname$& is primarily concerned with incoming
15460 messages, it is also used as the default for HELO commands in callout
15461 verification if there is no remote transport from which to obtain a
15462 &%helo_data%& value.
15463
15464 .option smtp_banner main string&!! "see below"
15465 .cindex "SMTP" "welcome banner"
15466 .cindex "banner for SMTP"
15467 .cindex "welcome banner for SMTP"
15468 .cindex "customizing" "SMTP banner"
15469 This string, which is expanded every time it is used, is output as the initial
15470 positive response to an SMTP connection. The default setting is:
15471 .code
15472 smtp_banner = $smtp_active_hostname ESMTP Exim \
15473   $version_number $tod_full
15474 .endd
15475 Failure to expand the string causes a panic error. If you want to create a
15476 multiline response to the initial SMTP connection, use &"\n"& in the string at
15477 appropriate points, but not at the end. Note that the 220 code is not included
15478 in this string. Exim adds it automatically (several times in the case of a
15479 multiline response).
15480
15481
15482 .option smtp_check_spool_space main boolean true
15483 .cindex "checking disk space"
15484 .cindex "disk space, checking"
15485 .cindex "spool directory" "checking space"
15486 When this option is set, if an incoming SMTP session encounters the SIZE
15487 option on a MAIL command, it checks that there is enough space in the
15488 spool directory's partition to accept a message of that size, while still
15489 leaving free the amount specified by &%check_spool_space%& (even if that value
15490 is zero). If there isn't enough space, a temporary error code is returned.
15491
15492
15493 .option smtp_connect_backlog main integer 20
15494 .cindex "connection backlog"
15495 .cindex "SMTP" "connection backlog"
15496 .cindex "backlog of connections"
15497 This option specifies a maximum number of waiting SMTP connections. Exim passes
15498 this value to the TCP/IP system when it sets up its listener. Once this number
15499 of connections are waiting for the daemon's attention, subsequent connection
15500 attempts are refused at the TCP/IP level. At least, that is what the manuals
15501 say; in some circumstances such connection attempts have been observed to time
15502 out instead. For large systems it is probably a good idea to increase the
15503 value (to 50, say). It also gives some protection against denial-of-service
15504 attacks by SYN flooding.
15505
15506
15507 .option smtp_enforce_sync main boolean true
15508 .cindex "SMTP" "synchronization checking"
15509 .cindex "synchronization checking in SMTP"
15510 The SMTP protocol specification requires the client to wait for a response from
15511 the server at certain points in the dialogue. Without PIPELINING these
15512 synchronization points are after every command; with PIPELINING they are
15513 fewer, but they still exist.
15514
15515 Some spamming sites send out a complete set of SMTP commands without waiting
15516 for any response. Exim protects against this by rejecting a message if the
15517 client has sent further input when it should not have. The error response &"554
15518 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15519 for this error cannot be perfect because of transmission delays (unexpected
15520 input may be on its way but not yet received when Exim checks). However, it
15521 does detect many instances.
15522
15523 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15524 If you want to disable the check selectively (for example, only for certain
15525 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15526 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15527
15528
15529
15530 .option smtp_etrn_command main string&!! unset
15531 .cindex "ETRN" "command to be run"
15532 .vindex "&$domain$&"
15533 If this option is set, the given command is run whenever an SMTP ETRN
15534 command is received from a host that is permitted to issue such commands (see
15535 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15536 are independently expanded. The expansion variable &$domain$& is set to the
15537 argument of the ETRN command, and no syntax checking is done on it. For
15538 example:
15539 .code
15540 smtp_etrn_command = /etc/etrn_command $domain \
15541                     $sender_host_address
15542 .endd
15543 A new process is created to run the command, but Exim does not wait for it to
15544 complete. Consequently, its status cannot be checked. If the command cannot be
15545 run, a line is written to the panic log, but the ETRN caller still receives
15546 a 250 success response. Exim is normally running under its own uid when
15547 receiving SMTP, so it is not possible for it to change the uid before running
15548 the command.
15549
15550
15551 .option smtp_etrn_serialize main boolean true
15552 .cindex "ETRN" "serializing"
15553 When this option is set, it prevents the simultaneous execution of more than
15554 one identical command as a result of ETRN in an SMTP connection. See
15555 section &<<SECTETRN>>& for details.
15556
15557
15558 .option smtp_load_reserve main fixed-point unset
15559 .cindex "load average"
15560 If the system load average ever gets higher than this, incoming SMTP calls are
15561 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15562 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15563 the load is over the limit. The option has no effect on ancient operating
15564 systems on which Exim cannot determine the load average. See also
15565 &%deliver_queue_load_max%& and &%queue_only_load%&.
15566
15567
15568
15569 .option smtp_max_synprot_errors main integer 3
15570 .cindex "SMTP" "limiting syntax and protocol errors"
15571 .cindex "limit" "SMTP syntax and protocol errors"
15572 Exim rejects SMTP commands that contain syntax or protocol errors. In
15573 particular, a syntactically invalid email address, as in this command:
15574 .code
15575 RCPT TO:<abc xyz@a.b.c>
15576 .endd
15577 causes immediate rejection of the command, before any other tests are done.
15578 (The ACL cannot be run if there is no valid address to set up for it.) An
15579 example of a protocol error is receiving RCPT before MAIL. If there are
15580 too many syntax or protocol errors in one SMTP session, the connection is
15581 dropped. The limit is set by this option.
15582
15583 .cindex "PIPELINING" "expected errors"
15584 When the PIPELINING extension to SMTP is in use, some protocol errors are
15585 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15586 Exim assumes that PIPELINING will be used if it advertises it (see
15587 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15588 not count towards the limit.
15589
15590
15591
15592 .option smtp_max_unknown_commands main integer 3
15593 .cindex "SMTP" "limiting unknown commands"
15594 .cindex "limit" "unknown SMTP commands"
15595 If there are too many unrecognized commands in an incoming SMTP session, an
15596 Exim server drops the connection. This is a defence against some kinds of abuse
15597 that subvert web
15598 clients
15599 into making connections to SMTP ports; in these circumstances, a number of
15600 non-SMTP command lines are sent first.
15601
15602
15603
15604 .option smtp_ratelimit_hosts main "host list&!!" unset
15605 .cindex "SMTP" "rate limiting"
15606 .cindex "limit" "rate of message arrival"
15607 .cindex "RCPT" "rate limiting"
15608 Some sites find it helpful to be able to limit the rate at which certain hosts
15609 can send them messages, and the rate at which an individual message can specify
15610 recipients.
15611
15612 Exim has two rate-limiting facilities. This section describes the older
15613 facility, which can limit rates within a single connection. The newer
15614 &%ratelimit%& ACL condition can limit rates across all connections. See section
15615 &<<SECTratelimiting>>& for details of the newer facility.
15616
15617 When a host matches &%smtp_ratelimit_hosts%&, the values of
15618 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15619 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15620 respectively. Each option, if set, must contain a set of four comma-separated
15621 values:
15622
15623 .ilist
15624 A threshold, before which there is no rate limiting.
15625 .next
15626 An initial time delay. Unlike other times in Exim, numbers with decimal
15627 fractional parts are allowed here.
15628 .next
15629 A factor by which to increase the delay each time.
15630 .next
15631 A maximum value for the delay. This should normally be less than 5 minutes,
15632 because after that time, the client is liable to timeout the SMTP command.
15633 .endlist
15634
15635 For example, these settings have been used successfully at the site which
15636 first suggested this feature, for controlling mail from their customers:
15637 .code
15638 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15639 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15640 .endd
15641 The first setting specifies delays that are applied to MAIL commands after
15642 two have been received over a single connection. The initial delay is 0.5
15643 seconds, increasing by a factor of 1.05 each time. The second setting applies
15644 delays to RCPT commands when more than four occur in a single message.
15645
15646
15647 .option smtp_ratelimit_mail main string unset
15648 See &%smtp_ratelimit_hosts%& above.
15649
15650
15651 .option smtp_ratelimit_rcpt main string unset
15652 See &%smtp_ratelimit_hosts%& above.
15653
15654
15655 .option smtp_receive_timeout main time 5m
15656 .cindex "timeout" "for SMTP input"
15657 .cindex "SMTP" "input timeout"
15658 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15659 input, including batch SMTP. If a line of input (either an SMTP command or a
15660 data line) is not received within this time, the SMTP connection is dropped and
15661 the message is abandoned.
15662 A line is written to the log containing one of the following messages:
15663 .code
15664 SMTP command timeout on connection from...
15665 SMTP data timeout on connection from...
15666 .endd
15667 The former means that Exim was expecting to read an SMTP command; the latter
15668 means that it was in the DATA phase, reading the contents of a message.
15669
15670
15671 .oindex "&%-os%&"
15672 The value set by this option can be overridden by the
15673 &%-os%& command-line option. A setting of zero time disables the timeout, but
15674 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15675 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15676 timeout is controlled by &%receive_timeout%& and &%-or%&.
15677
15678
15679 .option smtp_reserve_hosts main "host list&!!" unset
15680 This option defines hosts for which SMTP connections are reserved; see
15681 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15682
15683
15684 .option smtp_return_error_details main boolean false
15685 .cindex "SMTP" "details policy failures"
15686 .cindex "policy control" "rejection, returning details"
15687 In the default state, Exim uses bland messages such as
15688 &"Administrative prohibition"& when it rejects SMTP commands for policy
15689 reasons. Many sysadmins like this because it gives away little information
15690 to spammers. However, some other sysadmins who are applying strict checking
15691 policies want to give out much fuller information about failures. Setting
15692 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15693 example, instead of &"Administrative prohibition"&, it might give:
15694 .code
15695 550-Rejected after DATA: '>' missing at end of address:
15696 550 failing address in "From" header is: <user@dom.ain
15697 .endd
15698
15699 .option spamd_address main string "see below"
15700 This option is available when Exim is compiled with the content-scanning
15701 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15702 The default value is
15703 .code
15704 127.0.0.1 783
15705 .endd
15706 See section &<<SECTscanspamass>>& for more details.
15707
15708
15709
15710 .option split_spool_directory main boolean false
15711 .cindex "multiple spool directories"
15712 .cindex "spool directory" "split"
15713 .cindex "directories, multiple"
15714 If this option is set, it causes Exim to split its input directory into 62
15715 subdirectories, each with a single alphanumeric character as its name. The
15716 sixth character of the message id is used to allocate messages to
15717 subdirectories; this is the least significant base-62 digit of the time of
15718 arrival of the message.
15719
15720 Splitting up the spool in this way may provide better performance on systems
15721 where there are long mail queues, by reducing the number of files in any one
15722 directory. The msglog directory is also split up in a similar way to the input
15723 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15724 are still placed in the single directory &_msglog.OLD_&.
15725
15726 It is not necessary to take any special action for existing messages when
15727 changing &%split_spool_directory%&. Exim notices messages that are in the
15728 &"wrong"& place, and continues to process them. If the option is turned off
15729 after a period of being on, the subdirectories will eventually empty and be
15730 automatically deleted.
15731
15732 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15733 changes. Instead of creating a list of all messages in the queue, and then
15734 trying to deliver each one in turn, it constructs a list of those in one
15735 sub-directory and tries to deliver them, before moving on to the next
15736 sub-directory. The sub-directories are processed in a random order. This
15737 spreads out the scanning of the input directories, and uses less memory. It is
15738 particularly beneficial when there are lots of messages on the queue. However,
15739 if &%queue_run_in_order%& is set, none of this new processing happens. The
15740 entire queue has to be scanned and sorted before any deliveries can start.
15741
15742
15743 .option spool_directory main string&!! "set at compile time"
15744 .cindex "spool directory" "path to"
15745 This defines the directory in which Exim keeps its spool, that is, the messages
15746 it is waiting to deliver. The default value is taken from the compile-time
15747 configuration setting, if there is one. If not, this option must be set. The
15748 string is expanded, so it can contain, for example, a reference to
15749 &$primary_hostname$&.
15750
15751 If the spool directory name is fixed on your installation, it is recommended
15752 that you set it at build time rather than from this option, particularly if the
15753 log files are being written to the spool directory (see &%log_file_path%&).
15754 Otherwise log files cannot be used for errors that are detected early on, such
15755 as failures in the configuration file.
15756
15757 By using this option to override the compiled-in path, it is possible to run
15758 tests of Exim without using the standard spool.
15759
15760 .option sqlite_lock_timeout main time 5s
15761 .cindex "sqlite lookup type" "lock timeout"
15762 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15763 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15764
15765 .option strict_acl_vars main boolean false
15766 .cindex "&ACL;" "variables, handling unset"
15767 This option controls what happens if a syntactically valid but undefined ACL
15768 variable is referenced. If it is false (the default), an empty string
15769 is substituted; if it is true, an error is generated. See section
15770 &<<SECTaclvariables>>& for details of ACL variables.
15771
15772 .option strip_excess_angle_brackets main boolean false
15773 .cindex "angle brackets, excess"
15774 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15775 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15776 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15777 passed on to another MTA, the excess angle brackets are not passed on. If this
15778 option is not set, multiple pairs of angle brackets cause a syntax error.
15779
15780
15781 .option strip_trailing_dot main boolean false
15782 .cindex "trailing dot on domain"
15783 .cindex "dot" "trailing on domain"
15784 If this option is set, a trailing dot at the end of a domain in an address is
15785 ignored. If this is in the envelope and the message is passed on to another
15786 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15787 domain causes a syntax error.
15788 However, addresses in header lines are checked only when an ACL requests header
15789 syntax checking.
15790
15791
15792 .option syslog_duplication main boolean true
15793 .cindex "syslog" "duplicate log lines; suppressing"
15794 When Exim is logging to syslog, it writes the log lines for its three
15795 separate logs at different syslog priorities so that they can in principle
15796 be separated on the logging hosts. Some installations do not require this
15797 separation, and in those cases, the duplication of certain log lines is a
15798 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15799 particular log line is written to syslog. For lines that normally go to
15800 both the main log and the reject log, the reject log version (possibly
15801 containing message header lines) is written, at LOG_NOTICE priority.
15802 Lines that normally go to both the main and the panic log are written at
15803 the LOG_ALERT priority.
15804
15805
15806 .option syslog_facility main string unset
15807 .cindex "syslog" "facility; setting"
15808 This option sets the syslog &"facility"& name, used when Exim is logging to
15809 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15810 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15811 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15812 details of Exim's logging.
15813
15814
15815
15816 .option syslog_processname main string &`exim`&
15817 .cindex "syslog" "process name; setting"
15818 This option sets the syslog &"ident"& name, used when Exim is logging to
15819 syslog. The value must be no longer than 32 characters. See chapter
15820 &<<CHAPlog>>& for details of Exim's logging.
15821
15822
15823
15824 .option syslog_timestamp main boolean true
15825 .cindex "syslog" "timestamps"
15826 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15827 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15828 details of Exim's logging.
15829
15830
15831 .option system_filter main string&!! unset
15832 .cindex "filter" "system filter"
15833 .cindex "system filter" "specifying"
15834 .cindex "Sieve filter" "not available for system filter"
15835 This option specifies an Exim filter file that is applied to all messages at
15836 the start of each delivery attempt, before any routing is done. System filters
15837 must be Exim filters; they cannot be Sieve filters. If the system filter
15838 generates any deliveries to files or pipes, or any new mail messages, the
15839 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15840 which transports are to be used. Details of this facility are given in chapter
15841 &<<CHAPsystemfilter>>&.
15842
15843
15844 .option system_filter_directory_transport main string&!! unset
15845 .vindex "&$address_file$&"
15846 This sets the name of the transport driver that is to be used when the
15847 &%save%& command in a system message filter specifies a path ending in &"/"&,
15848 implying delivery of each message into a separate file in some directory.
15849 During the delivery, the variable &$address_file$& contains the path name.
15850
15851
15852 .option system_filter_file_transport main string&!! unset
15853 .cindex "file" "transport for system filter"
15854 This sets the name of the transport driver that is to be used when the &%save%&
15855 command in a system message filter specifies a path not ending in &"/"&. During
15856 the delivery, the variable &$address_file$& contains the path name.
15857
15858 .option system_filter_group main string unset
15859 .cindex "gid (group id)" "system filter"
15860 This option is used only when &%system_filter_user%& is also set. It sets the
15861 gid under which the system filter is run, overriding any gid that is associated
15862 with the user. The value may be numerical or symbolic.
15863
15864 .option system_filter_pipe_transport main string&!! unset
15865 .cindex "&(pipe)& transport" "for system filter"
15866 .vindex "&$address_pipe$&"
15867 This specifies the transport driver that is to be used when a &%pipe%& command
15868 is used in a system filter. During the delivery, the variable &$address_pipe$&
15869 contains the pipe command.
15870
15871
15872 .option system_filter_reply_transport main string&!! unset
15873 .cindex "&(autoreply)& transport" "for system filter"
15874 This specifies the transport driver that is to be used when a &%mail%& command
15875 is used in a system filter.
15876
15877
15878 .option system_filter_user main string unset
15879 .cindex "uid (user id)" "system filter"
15880 If this option is set to root, the system filter is run in the main Exim
15881 delivery process, as root.  Otherwise, the system filter runs in a separate
15882 process, as the given user, defaulting to the Exim run-time user.
15883 Unless the string consists entirely of digits, it
15884 is looked up in the password data. Failure to find the named user causes a
15885 configuration error. The gid is either taken from the password data, or
15886 specified by &%system_filter_group%&. When the uid is specified numerically,
15887 &%system_filter_group%& is required to be set.
15888
15889 If the system filter generates any pipe, file, or reply deliveries, the uid
15890 under which the filter is run is used when transporting them, unless a
15891 transport option overrides.
15892
15893
15894 .option tcp_nodelay main boolean true
15895 .cindex "daemon" "TCP_NODELAY on sockets"
15896 .cindex "Nagle algorithm"
15897 .cindex "TCP_NODELAY on listening sockets"
15898 If this option is set false, it stops the Exim daemon setting the
15899 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15900 turns off the &"Nagle algorithm"&, which is a way of improving network
15901 performance in interactive (character-by-character) situations. Turning it off
15902 should improve Exim's performance a bit, so that is what happens by default.
15903 However, it appears that some broken clients cannot cope, and time out. Hence
15904 this option. It affects only those sockets that are set up for listening by the
15905 daemon. Sockets created by the smtp transport for delivering mail always set
15906 TCP_NODELAY.
15907
15908
15909 .option timeout_frozen_after main time 0s
15910 .cindex "frozen messages" "timing out"
15911 .cindex "timeout" "frozen messages"
15912 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15913 message of any kind that has been on the queue for longer than the given time
15914 is automatically cancelled at the next queue run. If the frozen message is a
15915 bounce message, it is just discarded; otherwise, a bounce is sent to the
15916 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15917 If you want to timeout frozen bounce messages earlier than other kinds of
15918 frozen message, see &%ignore_bounce_errors_after%&.
15919
15920 &*Note:*& the default value of zero means no timeouts; with this setting,
15921 frozen messages remain on the queue forever (except for any frozen bounce
15922 messages that are released by &%ignore_bounce_errors_after%&).
15923
15924
15925 .option timezone main string unset
15926 .cindex "timezone, setting"
15927 The value of &%timezone%& is used to set the environment variable TZ while
15928 running Exim (if it is different on entry). This ensures that all timestamps
15929 created by Exim are in the required timezone. If you want all your timestamps
15930 to be in UTC (aka GMT) you should set
15931 .code
15932 timezone = UTC
15933 .endd
15934 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15935 or, if that is not set, from the value of the TZ environment variable when Exim
15936 is built. If &%timezone%& is set to the empty string, either at build or run
15937 time, any existing TZ variable is removed from the environment when Exim
15938 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15939 unfortunately not all, operating systems.
15940
15941
15942 .option tls_advertise_hosts main "host list&!!" unset
15943 .cindex "TLS" "advertising"
15944 .cindex "encryption" "on SMTP connection"
15945 .cindex "SMTP" "encrypted connection"
15946 When Exim is built with support for TLS encrypted connections, the availability
15947 of the STARTTLS command to set up an encrypted session is advertised in
15948 response to EHLO only to those client hosts that match this option. See
15949 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15950
15951
15952 .option tls_certificate main string&!! unset
15953 .cindex "TLS" "server certificate; location of"
15954 .cindex "certificate" "server, location of"
15955 The value of this option is expanded, and must then be the absolute path to a
15956 file which contains the server's certificates. The server's private key is also
15957 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15958 &<<CHAPTLS>>& for further details.
15959
15960 &*Note*&: The certificates defined by this option are used only when Exim is
15961 receiving incoming messages as a server. If you want to supply certificates for
15962 use when sending messages as a client, you must set the &%tls_certificate%&
15963 option in the relevant &(smtp)& transport.
15964
15965 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
15966 if the OpenSSL build supports TLS extensions and the TLS client sends the
15967 Server Name Indication extension, then this option and others documented in
15968 &<<SECTtlssni>>& will be re-expanded.
15969
15970 .option tls_crl main string&!! unset
15971 .cindex "TLS" "server certificate revocation list"
15972 .cindex "certificate" "revocation list for server"
15973 This option specifies a certificate revocation list. The expanded value must
15974 be the name of a file that contains a CRL in PEM format.
15975
15976 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15977
15978
15979 .option tls_dh_max_bits main integer 2236
15980 .cindex "TLS" "D-H bit count"
15981 The number of bits used for Diffie-Hellman key-exchange may be suggested by
15982 the chosen TLS library.  That value might prove to be too high for
15983 interoperability.  This option provides a maximum clamp on the value
15984 suggested, trading off security for interoperability.
15985
15986 The value must be at least 1024.
15987
15988 The value 2236 was chosen because, at time of adding the option, it was the
15989 hard-coded maximum value supported by the NSS cryptographic library, as used
15990 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
15991
15992 If you prefer more security and are willing to break some clients, raise this
15993 number.
15994
15995 Note that the value passed to GnuTLS for *generating* a new prime may be a
15996 little less than this figure, because GnuTLS is inexact and may produce a
15997 larger prime than requested.
15998
15999
16000 .option tls_dhparam main string&!! unset
16001 .cindex "TLS" "D-H parameters for server"
16002 The value of this option is expanded and indicates the source of DH parameters
16003 to be used by Exim.
16004
16005 If it is a filename starting with a &`/`&, then it names a file from which DH
16006 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16007 PKCS#3 representation of the DH prime.  If the file does not exist, for
16008 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16009 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16010 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16011 and treated as though the &%tls_dhparam%& were set to "none".
16012
16013 If this option expands to the string "none", then no DH parameters will be
16014 loaded by Exim.
16015
16016 If this option expands to the string "historic" and Exim is using GnuTLS, then
16017 Exim will attempt to load a file from inside the spool directory.  If the file
16018 does not exist, Exim will attempt to create it.
16019 See section &<<SECTgnutlsparam>>& for further details.
16020
16021 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16022 a default DH prime; the default is the 2048 bit prime described in section
16023 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16024 in IKE is assigned number 23.
16025
16026 Otherwise, the option must expand to the name used by Exim for any of a number
16027 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16028 "ike" followed by the number used by IKE, of "default" which corresponds to
16029 "ike23".
16030
16031 The available primes are:
16032 &`ike1`&, &`ike2`&, &`ike5`&,
16033 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16034 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16035
16036 Some of these will be too small to be accepted by clients.
16037 Some may be too large to be accepted by clients.
16038
16039 The TLS protocol does not negotiate an acceptable size for this; clients tend
16040 to hard-drop connections if what is offered by the server is unacceptable,
16041 whether too large or too small, and there's no provision for the client to
16042 tell the server what these constraints are.  Thus, as a server operator, you
16043 need to make an educated guess as to what is most likely to work for your
16044 userbase.
16045
16046 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16047 is most likely to maximise interoperability.  The upper bound comes from
16048 applications using the Mozilla Network Security Services (NSS) library, which
16049 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16050 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16051 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16052 acceptable bound from 1024 to 2048.
16053
16054
16055 .option tls_on_connect_ports main "string list" unset
16056 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16057 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16058 set up without waiting for the client to issue a STARTTLS command. For
16059 further details, see section &<<SECTsupobssmt>>&.
16060
16061
16062
16063 .option tls_privatekey main string&!! unset
16064 .cindex "TLS" "server private key; location of"
16065 The value of this option is expanded, and must then be the absolute path to a
16066 file which contains the server's private key. If this option is unset, or if
16067 the expansion is forced to fail, or the result is an empty string, the private
16068 key is assumed to be in the same file as the server's certificates. See chapter
16069 &<<CHAPTLS>>& for further details.
16070
16071 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16072
16073
16074 .option tls_remember_esmtp main boolean false
16075 .cindex "TLS" "esmtp state; remembering"
16076 .cindex "TLS" "broken clients"
16077 If this option is set true, Exim violates the RFCs by remembering that it is in
16078 &"esmtp"& state after successfully negotiating a TLS session. This provides
16079 support for broken clients that fail to send a new EHLO after starting a
16080 TLS session.
16081
16082
16083 .option tls_require_ciphers main string&!! unset
16084 .cindex "TLS" "requiring specific ciphers"
16085 .cindex "cipher" "requiring specific"
16086 This option controls which ciphers can be used for incoming TLS connections.
16087 The &(smtp)& transport has an option of the same name for controlling outgoing
16088 connections. This option is expanded for each connection, so can be varied for
16089 different clients if required. The value of this option must be a list of
16090 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16091 in somewhat different ways. If GnuTLS is being used, the client controls the
16092 preference order of the available ciphers. Details are given in sections
16093 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16094
16095
16096 .option tls_try_verify_hosts main "host list&!!" unset
16097 .cindex "TLS" "client certificate verification"
16098 .cindex "certificate" "verification of client"
16099 See &%tls_verify_hosts%& below.
16100
16101
16102 .option tls_verify_certificates main string&!! unset
16103 .cindex "TLS" "client certificate verification"
16104 .cindex "certificate" "verification of client"
16105 The value of this option is expanded, and must then be the absolute path to
16106 a file containing permitted certificates for clients that
16107 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16108 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
16109 directory containing certificate files. This does not work with GnuTLS; the
16110 option must be set to the name of a single file if you are using GnuTLS.
16111
16112 These certificates should be for the certificate authorities trusted, rather
16113 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16114 the value is a file then the certificates are sent by Exim as a server to
16115 connecting clients, defining the list of accepted certificate authorities.
16116 Thus the values defined should be considered public data.  To avoid this,
16117 use OpenSSL with a directory.
16118
16119 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16120
16121 A forced expansion failure or setting to an empty string is equivalent to
16122 being unset.
16123
16124
16125 .option tls_verify_hosts main "host list&!!" unset
16126 .cindex "TLS" "client certificate verification"
16127 .cindex "certificate" "verification of client"
16128 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16129 certificates from clients. The expected certificates are defined by
16130 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16131 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16132 &%tls_verify_certificates%& is not set.
16133
16134 Any client that matches &%tls_verify_hosts%& is constrained by
16135 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16136 present one of the listed certificates. If it does not, the connection is
16137 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16138 the host to use TLS. It can still send SMTP commands through unencrypted
16139 connections. Forcing a client to use TLS has to be done separately using an
16140 ACL to reject inappropriate commands when the connection is not encrypted.
16141
16142 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16143 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16144 certificate and checks it against &%tls_verify_certificates%&, but does not
16145 abort the connection if there is no certificate or if it does not match. This
16146 state can be detected in an ACL, which makes it possible to implement policies
16147 such as &"accept for relay only if a verified certificate has been received,
16148 but accept for local delivery if encrypted, even without a verified
16149 certificate"&.
16150
16151 Client hosts that match neither of these lists are not asked to present
16152 certificates.
16153
16154
16155 .option trusted_groups main "string list&!!" unset
16156 .cindex "trusted groups"
16157 .cindex "groups" "trusted"
16158 This option is expanded just once, at the start of Exim's processing. If this
16159 option is set, any process that is running in one of the listed groups, or
16160 which has one of them as a supplementary group, is trusted. The groups can be
16161 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16162 details of what trusted callers are permitted to do. If neither
16163 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16164 are trusted.
16165
16166 .option trusted_users main "string list&!!" unset
16167 .cindex "trusted users"
16168 .cindex "user" "trusted"
16169 This option is expanded just once, at the start of Exim's processing. If this
16170 option is set, any process that is running as one of the listed users is
16171 trusted. The users can be specified numerically or by name. See section
16172 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16173 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16174 Exim user are trusted.
16175
16176 .option unknown_login main string&!! unset
16177 .cindex "uid (user id)" "unknown caller"
16178 .vindex "&$caller_uid$&"
16179 This is a specialized feature for use in unusual configurations. By default, if
16180 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16181 gives up. The &%unknown_login%& option can be used to set a login name to be
16182 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16183 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16184 is used for the user's real name (gecos field), unless this has been set by the
16185 &%-F%& option.
16186
16187 .option unknown_username main string unset
16188 See &%unknown_login%&.
16189
16190 .option untrusted_set_sender main "address list&!!" unset
16191 .cindex "trusted users"
16192 .cindex "sender" "setting by untrusted user"
16193 .cindex "untrusted user setting sender"
16194 .cindex "user" "untrusted setting sender"
16195 .cindex "envelope sender"
16196 When an untrusted user submits a message to Exim using the standard input, Exim
16197 normally creates an envelope sender address from the user's login and the
16198 default qualification domain. Data from the &%-f%& option (for setting envelope
16199 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16200 is used) is ignored.
16201
16202 However, untrusted users are permitted to set an empty envelope sender address,
16203 to declare that a message should never generate any bounces. For example:
16204 .code
16205 exim -f '<>' user@domain.example
16206 .endd
16207 .vindex "&$sender_ident$&"
16208 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16209 other envelope sender addresses in a controlled way. When it is set, untrusted
16210 users are allowed to set envelope sender addresses that match any of the
16211 patterns in the list. Like all address lists, the string is expanded. The
16212 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16213 users to setting senders that start with their login ids
16214 followed by a hyphen
16215 by a setting like this:
16216 .code
16217 untrusted_set_sender = ^$sender_ident-
16218 .endd
16219 If you want to allow untrusted users to set envelope sender addresses without
16220 restriction, you can use
16221 .code
16222 untrusted_set_sender = *
16223 .endd
16224 The &%untrusted_set_sender%& option applies to all forms of local input, but
16225 only to the setting of the envelope sender. It does not permit untrusted users
16226 to use the other options which trusted user can use to override message
16227 parameters. Furthermore, it does not stop Exim from removing an existing
16228 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16229 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16230 overriding these actions. The handling of the &'Sender:'& header is also
16231 described in section &<<SECTthesenhea>>&.
16232
16233 The log line for a message's arrival shows the envelope sender following
16234 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16235 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16236 envelope sender address, the user's login is shown in parentheses after the
16237 sender address.
16238
16239
16240 .option uucp_from_pattern main string "see below"
16241 .cindex "&""From""& line"
16242 .cindex "UUCP" "&""From""& line"
16243 Some applications that pass messages to an MTA via a command line interface use
16244 an initial line starting with &"From&~"& to pass the envelope sender. In
16245 particular, this is used by UUCP software. Exim recognizes such a line by means
16246 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16247 matches, the sender address is constructed by expanding the contents of
16248 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16249 default pattern recognizes lines in the following two forms:
16250 .code
16251 From ph10 Fri Jan  5 12:35 GMT 1996
16252 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16253 .endd
16254 The pattern can be seen by running
16255 .code
16256 exim -bP uucp_from_pattern
16257 .endd
16258 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16259 year in the second case. The first word after &"From&~"& is matched in the
16260 regular expression by a parenthesized subpattern. The default value for
16261 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16262 (&"ph10"& in the example above) as the message's sender. See also
16263 &%ignore_fromline_hosts%&.
16264
16265
16266 .option uucp_from_sender main string&!! &`$1`&
16267 See &%uucp_from_pattern%& above.
16268
16269
16270 .option warn_message_file main string unset
16271 .cindex "warning of delay" "customizing the message"
16272 .cindex "customizing" "warning message"
16273 This option defines a template file containing paragraphs of text to be used
16274 for constructing the warning message which is sent by Exim when a message has
16275 been on the queue for a specified amount of time, as specified by
16276 &%delay_warning%&. Details of the file's contents are given in chapter
16277 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16278
16279
16280 .option write_rejectlog main boolean true
16281 .cindex "reject log" "disabling"
16282 If this option is set false, Exim no longer writes anything to the reject log.
16283 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16284 .ecindex IIDconfima
16285 .ecindex IIDmaiconf
16286
16287
16288
16289
16290 . ////////////////////////////////////////////////////////////////////////////
16291 . ////////////////////////////////////////////////////////////////////////////
16292
16293 .chapter "Generic options for routers" "CHAProutergeneric"
16294 .scindex IIDgenoprou1 "options" "generic; for routers"
16295 .scindex IIDgenoprou2 "generic options" "router"
16296 This chapter describes the generic options that apply to all routers.
16297 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16298
16299 For a general description of how a router operates, see sections
16300 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16301 which the preconditions are tested. The order of expansion of the options that
16302 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16303 &%headers_remove%&, &%transport%&.
16304
16305
16306
16307 .option address_data routers string&!! unset
16308 .cindex "router" "data attached to address"
16309 The string is expanded just before the router is run, that is, after all the
16310 precondition tests have succeeded. If the expansion is forced to fail, the
16311 router declines, the value of &%address_data%& remains unchanged, and the
16312 &%more%& option controls what happens next. Other expansion failures cause
16313 delivery of the address to be deferred.
16314
16315 .vindex "&$address_data$&"
16316 When the expansion succeeds, the value is retained with the address, and can be
16317 accessed using the variable &$address_data$& in the current router, subsequent
16318 routers, and the eventual transport.
16319
16320 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16321 that runs a user's filter file, the contents of &$address_data$& are accessible
16322 in the filter. This is not normally a problem, because such data is usually
16323 either not confidential or it &"belongs"& to the current user, but if you do
16324 put confidential data into &$address_data$& you need to remember this point.
16325
16326 Even if the router declines or passes, the value of &$address_data$& remains
16327 with the address, though it can be changed by another &%address_data%& setting
16328 on a subsequent router. If a router generates child addresses, the value of
16329 &$address_data$& propagates to them. This also applies to the special kind of
16330 &"child"& that is generated by a router with the &%unseen%& option.
16331
16332 The idea of &%address_data%& is that you can use it to look up a lot of data
16333 for the address once, and then pick out parts of the data later. For example,
16334 you could use a single LDAP lookup to return a string of the form
16335 .code
16336 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16337 .endd
16338 In the transport you could pick out the mailbox by a setting such as
16339 .code
16340 file = ${extract{mailbox}{$address_data}}
16341 .endd
16342 This makes the configuration file less messy, and also reduces the number of
16343 lookups (though Exim does cache lookups).
16344
16345 .vindex "&$sender_address_data$&"
16346 .vindex "&$address_data$&"
16347 The &%address_data%& facility is also useful as a means of passing information
16348 from one router to another, and from a router to a transport. In addition, if
16349 &$address_data$& is set by a router when verifying a recipient address from an
16350 ACL, it remains available for use in the rest of the ACL statement. After
16351 verifying a sender, the value is transferred to &$sender_address_data$&.
16352
16353
16354
16355 .option address_test routers&!? boolean true
16356 .oindex "&%-bt%&"
16357 .cindex "router" "skipping when address testing"
16358 If this option is set false, the router is skipped when routing is being tested
16359 by means of the &%-bt%& command line option. This can be a convenience when
16360 your first router sends messages to an external scanner, because it saves you
16361 having to set the &"already scanned"& indicator when testing real address
16362 routing.
16363
16364
16365
16366 .option cannot_route_message routers string&!! unset
16367 .cindex "router" "customizing &""cannot route""& message"
16368 .cindex "customizing" "&""cannot route""& message"
16369 This option specifies a text message that is used when an address cannot be
16370 routed because Exim has run out of routers. The default message is
16371 &"Unrouteable address"&. This option is useful only on routers that have
16372 &%more%& set false, or on the very last router in a configuration, because the
16373 value that is used is taken from the last router that is considered. This
16374 includes a router that is skipped because its preconditions are not met, as
16375 well as a router that declines. For example, using the default configuration,
16376 you could put:
16377 .code
16378 cannot_route_message = Remote domain not found in DNS
16379 .endd
16380 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16381 and
16382 .code
16383 cannot_route_message = Unknown local user
16384 .endd
16385 on the final router that checks for local users. If string expansion fails for
16386 this option, the default message is used. Unless the expansion failure was
16387 explicitly forced, a message about the failure is written to the main and panic
16388 logs, in addition to the normal message about the routing failure.
16389
16390
16391 .option caseful_local_part routers boolean false
16392 .cindex "case of local parts"
16393 .cindex "router" "case of local parts"
16394 By default, routers handle the local parts of addresses in a case-insensitive
16395 manner, though the actual case is preserved for transmission with the message.
16396 If you want the case of letters to be significant in a router, you must set
16397 this option true. For individual router options that contain address or local
16398 part lists (for example, &%local_parts%&), case-sensitive matching can be
16399 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16400 more details.
16401
16402 .vindex "&$local_part$&"
16403 .vindex "&$original_local_part$&"
16404 .vindex "&$parent_local_part$&"
16405 The value of the &$local_part$& variable is forced to lower case while a
16406 router is running unless &%caseful_local_part%& is set. When a router assigns
16407 an address to a transport, the value of &$local_part$& when the transport runs
16408 is the same as it was in the router. Similarly, when a router generates child
16409 addresses by aliasing or forwarding, the values of &$original_local_part$&
16410 and &$parent_local_part$& are those that were used by the redirecting router.
16411
16412 This option applies to the processing of an address by a router. When a
16413 recipient address is being processed in an ACL, there is a separate &%control%&
16414 modifier that can be used to specify case-sensitive processing within the ACL
16415 (see section &<<SECTcontrols>>&).
16416
16417
16418
16419 .option check_local_user routers&!? boolean false
16420 .cindex "local user, checking in router"
16421 .cindex "router" "checking for local user"
16422 .cindex "&_/etc/passwd_&"
16423 .vindex "&$home$&"
16424 When this option is true, Exim checks that the local part of the recipient
16425 address (with affixes removed if relevant) is the name of an account on the
16426 local system. The check is done by calling the &[getpwnam()]& function rather
16427 than trying to read &_/etc/passwd_& directly. This means that other methods of
16428 holding password data (such as NIS) are supported. If the local part is a local
16429 user, &$home$& is set from the password data, and can be tested in other
16430 preconditions that are evaluated after this one (the order of evaluation is
16431 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16432 overridden by &%router_home_directory%&. If the local part is not a local user,
16433 the router is skipped.
16434
16435 If you want to check that the local part is either the name of a local user
16436 or matches something else, you cannot combine &%check_local_user%& with a
16437 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16438 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16439 setting to achieve this. For example:
16440 .code
16441 local_parts = passwd;$local_part : lsearch;/etc/other/users
16442 .endd
16443 Note, however, that the side effects of &%check_local_user%& (such as setting
16444 up a home directory) do not occur when a &(passwd)& lookup is used in a
16445 &%local_parts%& (or any other) precondition.
16446
16447
16448
16449 .option condition routers&!? string&!! unset
16450 .cindex "router" "customized precondition"
16451 This option specifies a general precondition test that has to succeed for the
16452 router to be called. The &%condition%& option is the last precondition to be
16453 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16454 result is a forced failure, or an empty string, or one of the strings &"0"& or
16455 &"no"& or &"false"& (checked without regard to the case of the letters), the
16456 router is skipped, and the address is offered to the next one.
16457
16458 If the result is any other value, the router is run (as this is the last
16459 precondition to be evaluated, all the other preconditions must be true).
16460
16461 This option is unusual in that multiple &%condition%& options may be present.
16462 All &%condition%& options must succeed.
16463
16464 The &%condition%& option provides a means of applying custom conditions to the
16465 running of routers. Note that in the case of a simple conditional expansion,
16466 the default expansion values are exactly what is wanted. For example:
16467 .code
16468 condition = ${if >{$message_age}{600}}
16469 .endd
16470 Because of the default behaviour of the string expansion, this is equivalent to
16471 .code
16472 condition = ${if >{$message_age}{600}{true}{}}
16473 .endd
16474
16475 A multiple condition example, which succeeds:
16476 .code
16477 condition = ${if >{$message_age}{600}}
16478 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16479 condition = foobar
16480 .endd
16481
16482 If the expansion fails (other than forced failure) delivery is deferred. Some
16483 of the other precondition options are common special cases that could in fact
16484 be specified using &%condition%&.
16485
16486
16487 .option debug_print routers string&!! unset
16488 .cindex "testing" "variables in drivers"
16489 If this option is set and debugging is enabled (see the &%-d%& command line
16490 option) or in address-testing mode (see the &%-bt%& command line option),
16491 the string is expanded and included in the debugging output.
16492 If expansion of the string fails, the error message is written to the debugging
16493 output, and Exim carries on processing.
16494 This option is provided to help with checking out the values of variables and
16495 so on when debugging router configurations. For example, if a &%condition%&
16496 option appears not to be working, &%debug_print%& can be used to output the
16497 variables it references. The output happens after checks for &%domains%&,
16498 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16499 are tested. A newline is added to the text if it does not end with one.
16500 The variable &$router_name$& contains the name of the router.
16501
16502
16503
16504 .option disable_logging routers boolean false
16505 If this option is set true, nothing is logged for any routing errors
16506 or for any deliveries caused by this router. You should not set this option
16507 unless you really, really know what you are doing. See also the generic
16508 transport option of the same name.
16509
16510
16511 .option domains routers&!? "domain list&!!" unset
16512 .cindex "router" "restricting to specific domains"
16513 .vindex "&$domain_data$&"
16514 If this option is set, the router is skipped unless the current domain matches
16515 the list. If the match is achieved by means of a file lookup, the data that the
16516 lookup returned for the domain is placed in &$domain_data$& for use in string
16517 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16518 a list of the order in which preconditions are evaluated.
16519
16520
16521
16522 .option driver routers string unset
16523 This option must always be set. It specifies which of the available routers is
16524 to be used.
16525
16526
16527
16528 .option errors_to routers string&!! unset
16529 .cindex "envelope sender"
16530 .cindex "router" "changing address for errors"
16531 If a router successfully handles an address, it may assign the address to a
16532 transport for delivery or it may generate child addresses. In both cases, if
16533 there is a delivery problem during later processing, the resulting bounce
16534 message is sent to the address that results from expanding this string,
16535 provided that the address verifies successfully. The &%errors_to%& option is
16536 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16537
16538 The &%errors_to%& setting associated with an address can be overridden if it
16539 subsequently passes through other routers that have their own &%errors_to%&
16540 settings, or if the message is delivered by a transport with a &%return_path%&
16541 setting.
16542
16543 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16544 the expansion fails to verify, the errors address associated with the incoming
16545 address is used. At top level, this is the envelope sender. A non-forced
16546 expansion failure causes delivery to be deferred.
16547
16548 If an address for which &%errors_to%& has been set ends up being delivered over
16549 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16550 any bounces that are generated by other MTAs on the delivery route are also
16551 sent there. You can set &%errors_to%& to the empty string by either of these
16552 settings:
16553 .code
16554 errors_to =
16555 errors_to = ""
16556 .endd
16557 An expansion item that yields an empty string has the same effect. If you do
16558 this, a locally detected delivery error for addresses processed by this router
16559 no longer gives rise to a bounce message; the error is discarded. If the
16560 address is delivered to a remote host, the return path is set to &`<>`&, unless
16561 overridden by the &%return_path%& option on the transport.
16562
16563 .vindex "&$address_data$&"
16564 If for some reason you want to discard local errors, but use a non-empty
16565 MAIL command for remote delivery, you can preserve the original return
16566 path in &$address_data$& in the router, and reinstate it in the transport by
16567 setting &%return_path%&.
16568
16569 The most common use of &%errors_to%& is to direct mailing list bounces to the
16570 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16571 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16572
16573
16574
16575 .option expn routers&!? boolean true
16576 .cindex "address" "testing"
16577 .cindex "testing" "addresses"
16578 .cindex "EXPN" "router skipping"
16579 .cindex "router" "skipping for EXPN"
16580 If this option is turned off, the router is skipped when testing an address
16581 as a result of processing an SMTP EXPN command. You might, for example,
16582 want to turn it off on a router for users' &_.forward_& files, while leaving it
16583 on for the system alias file.
16584 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16585 are evaluated.
16586
16587 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16588 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16589 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16590
16591
16592
16593 .option fail_verify routers boolean false
16594 .cindex "router" "forcing verification failure"
16595 Setting this option has the effect of setting both &%fail_verify_sender%& and
16596 &%fail_verify_recipient%& to the same value.
16597
16598
16599
16600 .option fail_verify_recipient routers boolean false
16601 If this option is true and an address is accepted by this router when
16602 verifying a recipient, verification fails.
16603
16604
16605
16606 .option fail_verify_sender routers boolean false
16607 If this option is true and an address is accepted by this router when
16608 verifying a sender, verification fails.
16609
16610
16611
16612 .option fallback_hosts routers "string list" unset
16613 .cindex "router" "fallback hosts"
16614 .cindex "fallback" "hosts specified on router"
16615 String expansion is not applied to this option. The argument must be a
16616 colon-separated list of host names or IP addresses. The list separator can be
16617 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16618 each name or address. In fact, the format of each item is exactly the same as
16619 defined for the list of hosts in a &(manualroute)& router (see section
16620 &<<SECTformatonehostitem>>&).
16621
16622 If a router queues an address for a remote transport, this host list is
16623 associated with the address, and used instead of the transport's fallback host
16624 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16625 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16626 transport for further details.
16627
16628
16629 .option group routers string&!! "see below"
16630 .cindex "gid (group id)" "local delivery"
16631 .cindex "local transports" "uid and gid"
16632 .cindex "transport" "local"
16633 .cindex "router" "setting group"
16634 When a router queues an address for a transport, and the transport does not
16635 specify a group, the group given here is used when running the delivery
16636 process.
16637 The group may be specified numerically or by name. If expansion fails, the
16638 error is logged and delivery is deferred.
16639 The default is unset, unless &%check_local_user%& is set, when the default
16640 is taken from the password information. See also &%initgroups%& and &%user%&
16641 and the discussion in chapter &<<CHAPenvironment>>&.
16642
16643
16644
16645 .option headers_add routers string&!! unset
16646 .cindex "header lines" "adding"
16647 .cindex "router" "adding header lines"
16648 This option specifies a string of text that is expanded at routing time, and
16649 associated with any addresses that are accepted by the router. However, this
16650 option has no effect when an address is just being verified. The way in which
16651 the text is used to add header lines at transport time is described in section
16652 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16653 message is in the process of being transported. This means that references to
16654 header lines in string expansions in the transport's configuration do not
16655 &"see"& the added header lines.
16656
16657 The &%headers_add%& option is expanded after &%errors_to%&, but before
16658 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16659 the expansion is forced to fail, the option has no effect. Other expansion
16660 failures are treated as configuration errors.
16661
16662 Unlike most options, &%headers_add%& can be specified multiple times
16663 for a router; all listed headers are added.
16664
16665 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16666 router that has the &%one_time%& option set.
16667
16668 .cindex "duplicate addresses"
16669 .oindex "&%unseen%&"
16670 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16671 additions are deleted when the address is passed on to subsequent routers.
16672 For a &%redirect%& router, if a generated address is the same as the incoming
16673 address, this can lead to duplicate addresses with different header
16674 modifications. Exim does not do duplicate deliveries (except, in certain
16675 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16676 which of the duplicates is discarded, so this ambiguous situation should be
16677 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16678
16679
16680
16681 .option headers_remove routers string&!! unset
16682 .cindex "header lines" "removing"
16683 .cindex "router" "removing header lines"
16684 This option specifies a string of text that is expanded at routing time, and
16685 associated with any addresses that are accepted by the router. However, this
16686 option has no effect when an address is just being verified. The way in which
16687 the text is used to remove header lines at transport time is described in
16688 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16689 the message is in the process of being transported. This means that references
16690 to header lines in string expansions in the transport's configuration still
16691 &"see"& the original header lines.
16692
16693 The &%headers_remove%& option is expanded after &%errors_to%& and
16694 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16695 the option has no effect. Other expansion failures are treated as configuration
16696 errors.
16697
16698 Unlike most options, &%headers_remove%& can be specified multiple times
16699 for a router; all listed headers are removed.
16700
16701 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16702 router that has the &%one_time%& option set.
16703
16704 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16705 removal requests are deleted when the address is passed on to subsequent
16706 routers, and this can lead to problems with duplicates -- see the similar
16707 warning for &%headers_add%& above.
16708
16709
16710 .option ignore_target_hosts routers "host list&!!" unset
16711 .cindex "IP address" "discarding"
16712 .cindex "router" "discarding IP addresses"
16713 Although this option is a host list, it should normally contain IP address
16714 entries rather than names. If any host that is looked up by the router has an
16715 IP address that matches an item in this list, Exim behaves as if that IP
16716 address did not exist. This option allows you to cope with rogue DNS entries
16717 like
16718 .code
16719 remote.domain.example.  A  127.0.0.1
16720 .endd
16721 by setting
16722 .code
16723 ignore_target_hosts = 127.0.0.1
16724 .endd
16725 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16726 discarded in this way, the router declines. In a conventional configuration, an
16727 attempt to mail to such a domain would normally provoke the &"unrouteable
16728 domain"& error, and an attempt to verify an address in the domain would fail.
16729 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16730 router declines if presented with one of the listed addresses.
16731
16732 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16733 means of the first or the second of the following settings, respectively:
16734 .code
16735 ignore_target_hosts = 0.0.0.0/0
16736 ignore_target_hosts = <; 0::0/0
16737 .endd
16738 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16739 in the second line matches all IPv6 addresses.
16740
16741 This option may also be useful for ignoring link-local and site-local IPv6
16742 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16743 is expanded before use as a list, it is possible to make it dependent on the
16744 domain that is being routed.
16745
16746 .vindex "&$host_address$&"
16747 During its expansion, &$host_address$& is set to the IP address that is being
16748 checked.
16749
16750 .option initgroups routers boolean false
16751 .cindex "additional groups"
16752 .cindex "groups" "additional"
16753 .cindex "local transports" "uid and gid"
16754 .cindex "transport" "local"
16755 If the router queues an address for a transport, and this option is true, and
16756 the uid supplied by the router is not overridden by the transport, the
16757 &[initgroups()]& function is called when running the transport to ensure that
16758 any additional groups associated with the uid are set up. See also &%group%&
16759 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16760
16761
16762
16763 .option local_part_prefix routers&!? "string list" unset
16764 .cindex "router" "prefix for local part"
16765 .cindex "prefix" "for local part, used in router"
16766 If this option is set, the router is skipped unless the local part starts with
16767 one of the given strings, or &%local_part_prefix_optional%& is true. See
16768 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16769 evaluated.
16770
16771 The list is scanned from left to right, and the first prefix that matches is
16772 used. A limited form of wildcard is available; if the prefix begins with an
16773 asterisk, it matches the longest possible sequence of arbitrary characters at
16774 the start of the local part. An asterisk should therefore always be followed by
16775 some character that does not occur in normal local parts.
16776 .cindex "multiple mailboxes"
16777 .cindex "mailbox" "multiple"
16778 Wildcarding can be used to set up multiple user mailboxes, as described in
16779 section &<<SECTmulbox>>&.
16780
16781 .vindex "&$local_part$&"
16782 .vindex "&$local_part_prefix$&"
16783 During the testing of the &%local_parts%& option, and while the router is
16784 running, the prefix is removed from the local part, and is available in the
16785 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16786 the router accepts the address, this remains true during subsequent delivery by
16787 a transport. In particular, the local part that is transmitted in the RCPT
16788 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16789 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16790 the relevant transport.
16791
16792 When an address is being verified, &%local_part_prefix%& affects only the
16793 behaviour of the router. If the callout feature of verification is in use, this
16794 means that the full address, including the prefix, will be used during the
16795 callout.
16796
16797 The prefix facility is commonly used to handle local parts of the form
16798 &%owner-something%&. Another common use is to support local parts of the form
16799 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16800 to tell a user their forwarding is broken &-- by placing a router like this one
16801 immediately before the router that handles &_.forward_& files:
16802 .code
16803 real_localuser:
16804   driver = accept
16805   local_part_prefix = real-
16806   check_local_user
16807   transport = local_delivery
16808 .endd
16809 For security, it would probably be a good idea to restrict the use of this
16810 router to locally-generated messages, using a condition such as this:
16811 .code
16812   condition = ${if match {$sender_host_address}\
16813                          {\N^(|127\.0\.0\.1)$\N}}
16814 .endd
16815
16816 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16817 both conditions must be met if not optional. Care must be taken if wildcards
16818 are used in both a prefix and a suffix on the same router. Different
16819 separator characters must be used to avoid ambiguity.
16820
16821
16822 .option local_part_prefix_optional routers boolean false
16823 See &%local_part_prefix%& above.
16824
16825
16826
16827 .option local_part_suffix routers&!? "string list" unset
16828 .cindex "router" "suffix for local part"
16829 .cindex "suffix for local part" "used in router"
16830 This option operates in the same way as &%local_part_prefix%&, except that the
16831 local part must end (rather than start) with the given string, the
16832 &%local_part_suffix_optional%& option determines whether the suffix is
16833 mandatory, and the wildcard * character, if present, must be the last
16834 character of the suffix. This option facility is commonly used to handle local
16835 parts of the form &%something-request%& and multiple user mailboxes of the form
16836 &%username-foo%&.
16837
16838
16839 .option local_part_suffix_optional routers boolean false
16840 See &%local_part_suffix%& above.
16841
16842
16843
16844 .option local_parts routers&!? "local part list&!!" unset
16845 .cindex "router" "restricting to specific local parts"
16846 .cindex "local part" "checking in router"
16847 The router is run only if the local part of the address matches the list.
16848 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16849 are evaluated, and
16850 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16851 string is expanded, it is possible to make it depend on the domain, for
16852 example:
16853 .code
16854 local_parts = dbm;/usr/local/specials/$domain
16855 .endd
16856 .vindex "&$local_part_data$&"
16857 If the match is achieved by a lookup, the data that the lookup returned
16858 for the local part is placed in the variable &$local_part_data$& for use in
16859 expansions of the router's private options. You might use this option, for
16860 example, if you have a large number of local virtual domains, and you want to
16861 send all postmaster mail to the same place without having to set up an alias in
16862 each virtual domain:
16863 .code
16864 postmaster:
16865   driver = redirect
16866   local_parts = postmaster
16867   data = postmaster@real.domain.example
16868 .endd
16869
16870
16871 .option log_as_local routers boolean "see below"
16872 .cindex "log" "delivery line"
16873 .cindex "delivery" "log line format"
16874 Exim has two logging styles for delivery, the idea being to make local
16875 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16876 recipient address is given just as the local part, without a domain. The use of
16877 this style is controlled by this option. It defaults to true for the &(accept)&
16878 router, and false for all the others. This option applies only when a
16879 router assigns an address to a transport. It has no effect on routers that
16880 redirect addresses.
16881
16882
16883
16884 .option more routers boolean&!! true
16885 The result of string expansion for this option must be a valid boolean value,
16886 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16887 result causes an error, and delivery is deferred. If the expansion is forced to
16888 fail, the default value for the option (true) is used. Other failures cause
16889 delivery to be deferred.
16890
16891 If this option is set false, and the router declines to handle the address, no
16892 further routers are tried, routing fails, and the address is bounced.
16893 .oindex "&%self%&"
16894 However, if the router explicitly passes an address to the following router by
16895 means of the setting
16896 .code
16897 self = pass
16898 .endd
16899 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16900 does not affect the behaviour if one of the precondition tests fails. In that
16901 case, the address is always passed to the next router.
16902
16903 Note that &%address_data%& is not considered to be a precondition. If its
16904 expansion is forced to fail, the router declines, and the value of &%more%&
16905 controls what happens next.
16906
16907
16908 .option pass_on_timeout routers boolean false
16909 .cindex "timeout" "of router"
16910 .cindex "router" "timeout"
16911 If a router times out during a host lookup, it normally causes deferral of the
16912 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16913 router, overriding &%no_more%&. This may be helpful for systems that are
16914 intermittently connected to the Internet, or those that want to pass to a smart
16915 host any messages that cannot immediately be delivered.
16916
16917 There are occasional other temporary errors that can occur while doing DNS
16918 lookups. They are treated in the same way as a timeout, and this option
16919 applies to all of them.
16920
16921
16922
16923 .option pass_router routers string unset
16924 .cindex "router" "go to after &""pass""&"
16925 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16926 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16927 routing to continue, and overriding a false setting of &%more%&. When one of
16928 these routers returns &"pass"&, the address is normally handed on to the next
16929 router in sequence. This can be changed by setting &%pass_router%& to the name
16930 of another router. However (unlike &%redirect_router%&) the named router must
16931 be below the current router, to avoid loops. Note that this option applies only
16932 to the special case of &"pass"&. It does not apply when a router returns
16933 &"decline"& because it cannot handle an address.
16934
16935
16936
16937 .option redirect_router routers string unset
16938 .cindex "router" "start at after redirection"
16939 Sometimes an administrator knows that it is pointless to reprocess addresses
16940 generated from alias or forward files with the same router again. For
16941 example, if an alias file translates real names into login ids there is no
16942 point searching the alias file a second time, especially if it is a large file.
16943
16944 The &%redirect_router%& option can be set to the name of any router instance.
16945 It causes the routing of any generated addresses to start at the named router
16946 instead of at the first router. This option has no effect if the router in
16947 which it is set does not generate new addresses.
16948
16949
16950
16951 .option require_files routers&!? "string list&!!" unset
16952 .cindex "file" "requiring for router"
16953 .cindex "router" "requiring file existence"
16954 This option provides a general mechanism for predicating the running of a
16955 router on the existence or non-existence of certain files or directories.
16956 Before running a router, as one of its precondition tests, Exim works its way
16957 through the &%require_files%& list, expanding each item separately.
16958
16959 Because the list is split before expansion, any colons in expansion items must
16960 be doubled, or the facility for using a different list separator must be used.
16961 If any expansion is forced to fail, the item is ignored. Other expansion
16962 failures cause routing of the address to be deferred.
16963
16964 If any expanded string is empty, it is ignored. Otherwise, except as described
16965 below, each string must be a fully qualified file path, optionally preceded by
16966 &"!"&. The paths are passed to the &[stat()]& function to test for the
16967 existence of the files or directories. The router is skipped if any paths not
16968 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16969
16970 .cindex "NFS"
16971 If &[stat()]& cannot determine whether a file exists or not, delivery of
16972 the message is deferred. This can happen when NFS-mounted filesystems are
16973 unavailable.
16974
16975 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16976 options, so you cannot use it to check for the existence of a file in which to
16977 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16978 full list of the order in which preconditions are evaluated.) However, as
16979 these options are all expanded, you can use the &%exists%& expansion condition
16980 to make such tests. The &%require_files%& option is intended for checking files
16981 that the router may be going to use internally, or which are needed by a
16982 transport (for example &_.procmailrc_&).
16983
16984 During delivery, the &[stat()]& function is run as root, but there is a
16985 facility for some checking of the accessibility of a file by another user.
16986 This is not a proper permissions check, but just a &"rough"& check that
16987 operates as follows:
16988
16989 If an item in a &%require_files%& list does not contain any forward slash
16990 characters, it is taken to be the user (and optional group, separated by a
16991 comma) to be checked for subsequent files in the list. If no group is specified
16992 but the user is specified symbolically, the gid associated with the uid is
16993 used. For example:
16994 .code
16995 require_files = mail:/some/file
16996 require_files = $local_part:$home/.procmailrc
16997 .endd
16998 If a user or group name in a &%require_files%& list does not exist, the
16999 &%require_files%& condition fails.
17000
17001 Exim performs the check by scanning along the components of the file path, and
17002 checking the access for the given uid and gid. It checks for &"x"& access on
17003 directories, and &"r"& access on the final file. Note that this means that file
17004 access control lists, if the operating system has them, are ignored.
17005
17006 &*Warning 1*&: When the router is being run to verify addresses for an
17007 incoming SMTP message, Exim is not running as root, but under its own uid. This
17008 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17009 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17010 user is not permitted to read one of the directories on the file's path.
17011
17012 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17013 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17014 without root access. In this case, if a check for access by a particular user
17015 is requested, Exim creates a subprocess that runs as that user, and tries the
17016 check again in that process.
17017
17018 The default action for handling an unresolved EACCES is to consider it to
17019 be caused by a configuration error, and routing is deferred because the
17020 existence or non-existence of the file cannot be determined. However, in some
17021 circumstances it may be desirable to treat this condition as if the file did
17022 not exist. If the file name (or the exclamation mark that precedes the file
17023 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17024 as if the file did not exist. For example:
17025 .code
17026 require_files = +/some/file
17027 .endd
17028 If the router is not an essential part of verification (for example, it
17029 handles users' &_.forward_& files), another solution is to set the &%verify%&
17030 option false so that the router is skipped when verifying.
17031
17032
17033
17034 .option retry_use_local_part routers boolean "see below"
17035 .cindex "hints database" "retry keys"
17036 .cindex "local part" "in retry keys"
17037 When a delivery suffers a temporary routing failure, a retry record is created
17038 in Exim's hints database. For addresses whose routing depends only on the
17039 domain, the key for the retry record should not involve the local part, but for
17040 other addresses, both the domain and the local part should be included.
17041 Usually, remote routing is of the former kind, and local routing is of the
17042 latter kind.
17043
17044 This option controls whether the local part is used to form the key for retry
17045 hints for addresses that suffer temporary errors while being handled by this
17046 router. The default value is true for any router that has &%check_local_user%&
17047 set, and false otherwise. Note that this option does not apply to hints keys
17048 for transport delays; they are controlled by a generic transport option of the
17049 same name.
17050
17051 The setting of &%retry_use_local_part%& applies only to the router on which it
17052 appears. If the router generates child addresses, they are routed
17053 independently; this setting does not become attached to them.
17054
17055
17056
17057 .option router_home_directory routers string&!! unset
17058 .cindex "router" "home directory for"
17059 .cindex "home directory" "for router"
17060 .vindex "&$home$&"
17061 This option sets a home directory for use while the router is running. (Compare
17062 &%transport_home_directory%&, which sets a home directory for later
17063 transporting.) In particular, if used on a &(redirect)& router, this option
17064 sets a value for &$home$& while a filter is running. The value is expanded;
17065 forced expansion failure causes the option to be ignored &-- other failures
17066 cause the router to defer.
17067
17068 Expansion of &%router_home_directory%& happens immediately after the
17069 &%check_local_user%& test (if configured), before any further expansions take
17070 place.
17071 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17072 are evaluated.)
17073 While the router is running, &%router_home_directory%& overrides the value of
17074 &$home$& that came from &%check_local_user%&.
17075
17076 When a router accepts an address and assigns it to a local transport (including
17077 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17078 delivery), the home directory setting for the transport is taken from the first
17079 of these values that is set:
17080
17081 .ilist
17082 The &%home_directory%& option on the transport;
17083 .next
17084 The &%transport_home_directory%& option on the router;
17085 .next
17086 The password data if &%check_local_user%& is set on the router;
17087 .next
17088 The &%router_home_directory%& option on the router.
17089 .endlist
17090
17091 In other words, &%router_home_directory%& overrides the password data for the
17092 router, but not for the transport.
17093
17094
17095
17096 .option self routers string freeze
17097 .cindex "MX record" "pointing to local host"
17098 .cindex "local host" "MX pointing to"
17099 This option applies to those routers that use a recipient address to find a
17100 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17101 and &(manualroute)& routers.
17102 Certain configurations of the &(queryprogram)& router can also specify a list
17103 of remote hosts.
17104 Usually such routers are configured to send the message to a remote host via an
17105 &(smtp)& transport. The &%self%& option specifies what happens when the first
17106 host on the list turns out to be the local host.
17107 The way in which Exim checks for the local host is described in section
17108 &<<SECTreclocipadd>>&.
17109
17110 Normally this situation indicates either an error in Exim's configuration (for
17111 example, the router should be configured not to process this domain), or an
17112 error in the DNS (for example, the MX should not point to this host). For this
17113 reason, the default action is to log the incident, defer the address, and
17114 freeze the message. The following alternatives are provided for use in special
17115 cases:
17116
17117 .vlist
17118 .vitem &%defer%&
17119 Delivery of the message is tried again later, but the message is not frozen.
17120
17121 .vitem "&%reroute%&: <&'domain'&>"
17122 The domain is changed to the given domain, and the address is passed back to
17123 be reprocessed by the routers. No rewriting of headers takes place. This
17124 behaviour is essentially a redirection.
17125
17126 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17127 The domain is changed to the given domain, and the address is passed back to be
17128 reprocessed by the routers. Any headers that contain the original domain are
17129 rewritten.
17130
17131 .vitem &%pass%&
17132 .oindex "&%more%&"
17133 .vindex "&$self_hostname$&"
17134 The router passes the address to the next router, or to the router named in the
17135 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17136 subsequent routing and delivery, the variable &$self_hostname$& contains the
17137 name of the local host that the router encountered. This can be used to
17138 distinguish between different cases for hosts with multiple names. The
17139 combination
17140 .code
17141 self = pass
17142 no_more
17143 .endd
17144 ensures that only those addresses that routed to the local host are passed on.
17145 Without &%no_more%&, addresses that were declined for other reasons would also
17146 be passed to the next router.
17147
17148 .vitem &%fail%&
17149 Delivery fails and an error report is generated.
17150
17151 .vitem &%send%&
17152 .cindex "local host" "sending to"
17153 The anomaly is ignored and the address is queued for the transport. This
17154 setting should be used with extreme caution. For an &(smtp)& transport, it
17155 makes sense only in cases where the program that is listening on the SMTP port
17156 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17157 different configuration file that handles the domain in another way.
17158 .endlist
17159
17160
17161
17162 .option senders routers&!? "address list&!!" unset
17163 .cindex "router" "checking senders"
17164 If this option is set, the router is skipped unless the message's sender
17165 address matches something on the list.
17166 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17167 are evaluated.
17168
17169 There are issues concerning verification when the running of routers is
17170 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17171 setting, it sets the sender to the null string. When using the &%-bt%& option
17172 to check a configuration file, it is necessary also to use the &%-f%& option to
17173 set an appropriate sender. For incoming mail, the sender is unset when
17174 verifying the sender, but is available when verifying any recipients. If the
17175 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17176 matters.
17177
17178
17179 .option translate_ip_address routers string&!! unset
17180 .cindex "IP address" "translating"
17181 .cindex "packet radio"
17182 .cindex "router" "IP address translation"
17183 There exist some rare networking situations (for example, packet radio) where
17184 it is helpful to be able to translate IP addresses generated by normal routing
17185 mechanisms into other IP addresses, thus performing a kind of manual IP
17186 routing. This should be done only if the normal IP routing of the TCP/IP stack
17187 is inadequate or broken. Because this is an extremely uncommon requirement, the
17188 code to support this option is not included in the Exim binary unless
17189 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17190
17191 .vindex "&$host_address$&"
17192 The &%translate_ip_address%& string is expanded for every IP address generated
17193 by the router, with the generated address set in &$host_address$&. If the
17194 expansion is forced to fail, no action is taken.
17195 For any other expansion error, delivery of the message is deferred.
17196 If the result of the expansion is an IP address, that replaces the original
17197 address; otherwise the result is assumed to be a host name &-- this is looked
17198 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17199 produce one or more replacement IP addresses. For example, to subvert all IP
17200 addresses in some specific networks, this could be added to a router:
17201 .code
17202 translate_ip_address = \
17203   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17204     {$value}fail}}
17205 .endd
17206 The file would contain lines like
17207 .code
17208 10.2.3.128/26    some.host
17209 10.8.4.34/26     10.44.8.15
17210 .endd
17211 You should not make use of this facility unless you really understand what you
17212 are doing.
17213
17214
17215
17216 .option transport routers string&!! unset
17217 This option specifies the transport to be used when a router accepts an address
17218 and sets it up for delivery. A transport is never needed if a router is used
17219 only for verification. The value of the option is expanded at routing time,
17220 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17221 and result must be the name of one of the configured transports. If it is not,
17222 delivery is deferred.
17223
17224 The &%transport%& option is not used by the &(redirect)& router, but it does
17225 have some private options that set up transports for pipe and file deliveries
17226 (see chapter &<<CHAPredirect>>&).
17227
17228
17229
17230 .option transport_current_directory routers string&!! unset
17231 .cindex "current directory for local transport"
17232 This option associates a current directory with any address that is routed
17233 to a local transport. This can happen either because a transport is
17234 explicitly configured for the router, or because it generates a delivery to a
17235 file or a pipe. During the delivery process (that is, at transport time), this
17236 option string is expanded and is set as the current directory, unless
17237 overridden by a setting on the transport.
17238 If the expansion fails for any reason, including forced failure, an error is
17239 logged, and delivery is deferred.
17240 See chapter &<<CHAPenvironment>>& for details of the local delivery
17241 environment.
17242
17243
17244
17245
17246 .option transport_home_directory routers string&!! "see below"
17247 .cindex "home directory" "for local transport"
17248 This option associates a home directory with any address that is routed to a
17249 local transport. This can happen either because a transport is explicitly
17250 configured for the router, or because it generates a delivery to a file or a
17251 pipe. During the delivery process (that is, at transport time), the option
17252 string is expanded and is set as the home directory, unless overridden by a
17253 setting of &%home_directory%& on the transport.
17254 If the expansion fails for any reason, including forced failure, an error is
17255 logged, and delivery is deferred.
17256
17257 If the transport does not specify a home directory, and
17258 &%transport_home_directory%& is not set for the router, the home directory for
17259 the transport is taken from the password data if &%check_local_user%& is set for
17260 the router. Otherwise it is taken from &%router_home_directory%& if that option
17261 is set; if not, no home directory is set for the transport.
17262
17263 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17264 environment.
17265
17266
17267
17268
17269 .option unseen routers boolean&!! false
17270 .cindex "router" "carrying on after success"
17271 The result of string expansion for this option must be a valid boolean value,
17272 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17273 result causes an error, and delivery is deferred. If the expansion is forced to
17274 fail, the default value for the option (false) is used. Other failures cause
17275 delivery to be deferred.
17276
17277 When this option is set true, routing does not cease if the router accepts the
17278 address. Instead, a copy of the incoming address is passed to the next router,
17279 overriding a false setting of &%more%&. There is little point in setting
17280 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17281 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17282 sometimes true and sometimes false).
17283
17284 .cindex "copy of message (&%unseen%& option)"
17285 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17286 qualifier in filter files. It can be used to cause copies of messages to be
17287 delivered to some other destination, while also carrying out a normal delivery.
17288 In effect, the current address is made into a &"parent"& that has two children
17289 &-- one that is delivered as specified by this router, and a clone that goes on
17290 to be routed further. For this reason, &%unseen%& may not be combined with the
17291 &%one_time%& option in a &(redirect)& router.
17292
17293 &*Warning*&: Header lines added to the address (or specified for removal) by
17294 this router or by previous routers affect the &"unseen"& copy of the message
17295 only. The clone that continues to be processed by further routers starts with
17296 no added headers and none specified for removal. For a &%redirect%& router, if
17297 a generated address is the same as the incoming address, this can lead to
17298 duplicate addresses with different header modifications. Exim does not do
17299 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17300 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17301 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17302 &%redirect%& router may be of help.
17303
17304 Unlike the handling of header modifications, any data that was set by the
17305 &%address_data%& option in the current or previous routers &'is'& passed on to
17306 subsequent routers.
17307
17308
17309 .option user routers string&!! "see below"
17310 .cindex "uid (user id)" "local delivery"
17311 .cindex "local transports" "uid and gid"
17312 .cindex "transport" "local"
17313 .cindex "router" "user for filter processing"
17314 .cindex "filter" "user for processing"
17315 When a router queues an address for a transport, and the transport does not
17316 specify a user, the user given here is used when running the delivery process.
17317 The user may be specified numerically or by name. If expansion fails, the
17318 error is logged and delivery is deferred.
17319 This user is also used by the &(redirect)& router when running a filter file.
17320 The default is unset, except when &%check_local_user%& is set. In this case,
17321 the default is taken from the password information. If the user is specified as
17322 a name, and &%group%& is not set, the group associated with the user is used.
17323 See also &%initgroups%& and &%group%& and the discussion in chapter
17324 &<<CHAPenvironment>>&.
17325
17326
17327
17328 .option verify routers&!? boolean true
17329 Setting this option has the effect of setting &%verify_sender%& and
17330 &%verify_recipient%& to the same value.
17331
17332
17333 .option verify_only routers&!? boolean false
17334 .cindex "EXPN" "with &%verify_only%&"
17335 .oindex "&%-bv%&"
17336 .cindex "router" "used only when verifying"
17337 If this option is set, the router is used only when verifying an address,
17338 delivering in cutthrough mode or
17339 testing with the &%-bv%& option, not when actually doing a delivery, testing
17340 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17341 restricted to verifying only senders or recipients by means of
17342 &%verify_sender%& and &%verify_recipient%&.
17343
17344 &*Warning*&: When the router is being run to verify addresses for an incoming
17345 SMTP message, Exim is not running as root, but under its own uid. If the router
17346 accesses any files, you need to make sure that they are accessible to the Exim
17347 user or group.
17348
17349
17350 .option verify_recipient routers&!? boolean true
17351 If this option is false, the router is skipped when verifying recipient
17352 addresses,
17353 delivering in cutthrough mode
17354 or testing recipient verification using &%-bv%&.
17355 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17356 are evaluated.
17357
17358
17359 .option verify_sender routers&!? boolean true
17360 If this option is false, the router is skipped when verifying sender addresses
17361 or testing sender verification using &%-bvs%&.
17362 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17363 are evaluated.
17364 .ecindex IIDgenoprou1
17365 .ecindex IIDgenoprou2
17366
17367
17368
17369
17370
17371
17372 . ////////////////////////////////////////////////////////////////////////////
17373 . ////////////////////////////////////////////////////////////////////////////
17374
17375 .chapter "The accept router" "CHID4"
17376 .cindex "&(accept)& router"
17377 .cindex "routers" "&(accept)&"
17378 The &(accept)& router has no private options of its own. Unless it is being
17379 used purely for verification (see &%verify_only%&) a transport is required to
17380 be defined by the generic &%transport%& option. If the preconditions that are
17381 specified by generic options are met, the router accepts the address and queues
17382 it for the given transport. The most common use of this router is for setting
17383 up deliveries to local mailboxes. For example:
17384 .code
17385 localusers:
17386   driver = accept
17387   domains = mydomain.example
17388   check_local_user
17389   transport = local_delivery
17390 .endd
17391 The &%domains%& condition in this example checks the domain of the address, and
17392 &%check_local_user%& checks that the local part is the login of a local user.
17393 When both preconditions are met, the &(accept)& router runs, and queues the
17394 address for the &(local_delivery)& transport.
17395
17396
17397
17398
17399
17400
17401 . ////////////////////////////////////////////////////////////////////////////
17402 . ////////////////////////////////////////////////////////////////////////////
17403
17404 .chapter "The dnslookup router" "CHAPdnslookup"
17405 .scindex IIDdnsrou1 "&(dnslookup)& router"
17406 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17407 The &(dnslookup)& router looks up the hosts that handle mail for the
17408 recipient's domain in the DNS. A transport must always be set for this router,
17409 unless &%verify_only%& is set.
17410
17411 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17412 SRV records. If none are found, or if SRV support is not configured,
17413 MX records are looked up. If no MX records exist, address records are sought.
17414 However, &%mx_domains%& can be set to disable the direct use of address
17415 records.
17416
17417 MX records of equal priority are sorted by Exim into a random order. Exim then
17418 looks for address records for the host names obtained from MX or SRV records.
17419 When a host has more than one IP address, they are sorted into a random order,
17420 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17421 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17422 generic option, the router declines.
17423
17424 Unless they have the highest priority (lowest MX value), MX records that point
17425 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17426 are discarded, together with any other MX records of equal or lower priority.
17427
17428 .cindex "MX record" "pointing to local host"
17429 .cindex "local host" "MX pointing to"
17430 .oindex "&%self%&" "in &(dnslookup)& router"
17431 If the host pointed to by the highest priority MX record, or looked up as an
17432 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17433 happens is controlled by the generic &%self%& option.
17434
17435
17436 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17437 There have been problems with DNS servers when SRV records are looked up.
17438 Some mis-behaving servers return a DNS error or timeout when a non-existent
17439 SRV record is sought. Similar problems have in the past been reported for
17440 MX records. The global &%dns_again_means_nonexist%& option can help with this
17441 problem, but it is heavy-handed because it is a global option.
17442
17443 For this reason, there are two options, &%srv_fail_domains%& and
17444 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17445 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17446 an attempt to look up an SRV or MX record causes one of these results, and the
17447 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17448 such record"&. In the case of an SRV lookup, this means that the router
17449 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17450 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17451 case routing fails.
17452
17453
17454 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17455 .cindex "&(dnslookup)& router" "declines"
17456 There are a few cases where a &(dnslookup)& router will decline to accept
17457 an address; if such a router is expected to handle "all remaining non-local
17458 domains", then it is important to set &%no_more%&.
17459
17460 Reasons for a &(dnslookup)& router to decline currently include:
17461 .ilist
17462 The domain does not exist in DNS
17463 .next
17464 The domain exists but the MX record's host part is just "."; this is a common
17465 convention (borrowed from SRV) used to indicate that there is no such service
17466 for this domain and to not fall back to trying A/AAAA records.
17467 .next
17468 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17469 .next
17470 MX record points to a non-existent host.
17471 .next
17472 MX record points to an IP address and the main section option
17473 &%allow_mx_to_ip%& is not set.
17474 .next
17475 MX records exist and point to valid hosts, but all hosts resolve only to
17476 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17477 .next
17478 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17479 &%dns_check_names_pattern%& for handling one variant of this)
17480 .next
17481 &%check_secondary_mx%& is set on this router but the local host can
17482 not be found in the MX records (see below)
17483 .endlist
17484
17485
17486
17487
17488 .section "Private options for dnslookup" "SECID118"
17489 .cindex "options" "&(dnslookup)& router"
17490 The private options for the &(dnslookup)& router are as follows:
17491
17492 .option check_secondary_mx dnslookup boolean false
17493 .cindex "MX record" "checking for secondary"
17494 If this option is set, the router declines unless the local host is found in
17495 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17496 process domains for which the local host is a secondary mail exchanger
17497 differently to other domains. The way in which Exim decides whether a host is
17498 the local host is described in section &<<SECTreclocipadd>>&.
17499
17500
17501 .option check_srv dnslookup string&!! unset
17502 .cindex "SRV record" "enabling use of"
17503 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17504 addition to MX and address records. The support is disabled by default. To
17505 enable SRV support, set the &%check_srv%& option to the name of the service
17506 required. For example,
17507 .code
17508 check_srv = smtp
17509 .endd
17510 looks for SRV records that refer to the normal smtp service. The option is
17511 expanded, so the service name can vary from message to message or address
17512 to address. This might be helpful if SRV records are being used for a
17513 submission service. If the expansion is forced to fail, the &%check_srv%&
17514 option is ignored, and the router proceeds to look for MX records in the
17515 normal way.
17516
17517 When the expansion succeeds, the router searches first for SRV records for
17518 the given service (it assumes TCP protocol). A single SRV record with a
17519 host name that consists of just a single dot indicates &"no such service for
17520 this domain"&; if this is encountered, the router declines. If other kinds of
17521 SRV record are found, they are used to construct a host list for delivery
17522 according to the rules of RFC 2782. MX records are not sought in this case.
17523
17524 When no SRV records are found, MX records (and address records) are sought in
17525 the traditional way. In other words, SRV records take precedence over MX
17526 records, just as MX records take precedence over address records. Note that
17527 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17528 defined it. It is apparently believed that MX records are sufficient for email
17529 and that SRV records should not be used for this purpose. However, SRV records
17530 have an additional &"weight"& feature which some people might find useful when
17531 trying to split an SMTP load between hosts of different power.
17532
17533 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17534 when there is a DNS lookup error.
17535
17536
17537
17538 .option mx_domains dnslookup "domain list&!!" unset
17539 .cindex "MX record" "required to exist"
17540 .cindex "SRV record" "required to exist"
17541 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17542 record in order to be recognized. (The name of this option could be improved.)
17543 For example, if all the mail hosts in &'fict.example'& are known to have MX
17544 records, except for those in &'discworld.fict.example'&, you could use this
17545 setting:
17546 .code
17547 mx_domains = ! *.discworld.fict.example : *.fict.example
17548 .endd
17549 This specifies that messages addressed to a domain that matches the list but
17550 has no MX record should be bounced immediately instead of being routed using
17551 the address record.
17552
17553
17554 .option mx_fail_domains dnslookup "domain list&!!" unset
17555 If the DNS lookup for MX records for one of the domains in this list causes a
17556 DNS lookup error, Exim behaves as if no MX records were found. See section
17557 &<<SECTprowitdnsloo>>& for more discussion.
17558
17559
17560
17561
17562 .option qualify_single dnslookup boolean true
17563 .cindex "DNS" "resolver options"
17564 .cindex "DNS" "qualifying single-component names"
17565 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17566 lookups. Typically, but not standardly, this causes the resolver to qualify
17567 single-component names with the default domain. For example, on a machine
17568 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17569 &'thesaurus.ref.example'& inside the resolver. For details of what your
17570 resolver actually does, consult your man pages for &'resolver'& and
17571 &'resolv.conf'&.
17572
17573
17574
17575 .option rewrite_headers dnslookup boolean true
17576 .cindex "rewriting" "header lines"
17577 .cindex "header lines" "rewriting"
17578 If the domain name in the address that is being processed is not fully
17579 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17580 an address is specified as &'dormouse@teaparty'&, the domain might be
17581 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17582 occur as a result of setting the &%widen_domains%& option. If
17583 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17584 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17585 header lines of the message are rewritten with the full domain name.
17586
17587 This option should be turned off only when it is known that no message is
17588 ever going to be sent outside an environment where the abbreviation makes
17589 sense.
17590
17591 When an MX record is looked up in the DNS and matches a wildcard record, name
17592 servers normally return a record containing the name that has been looked up,
17593 making it impossible to detect whether a wildcard was present or not. However,
17594 some name servers have recently been seen to return the wildcard entry. If the
17595 name returned by a DNS lookup begins with an asterisk, it is not used for
17596 header rewriting.
17597
17598
17599 .option same_domain_copy_routing dnslookup boolean false
17600 .cindex "address" "copying routing"
17601 Addresses with the same domain are normally routed by the &(dnslookup)& router
17602 to the same list of hosts. However, this cannot be presumed, because the router
17603 options and preconditions may refer to the local part of the address. By
17604 default, therefore, Exim routes each address in a message independently. DNS
17605 servers run caches, so repeated DNS lookups are not normally expensive, and in
17606 any case, personal messages rarely have more than a few recipients.
17607
17608 If you are running mailing lists with large numbers of subscribers at the same
17609 domain, and you are using a &(dnslookup)& router which is independent of the
17610 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17611 lookups for identical domains in one message. In this case, when &(dnslookup)&
17612 routes an address to a remote transport, any other unrouted addresses in the
17613 message that have the same domain are automatically given the same routing
17614 without processing them independently,
17615 provided the following conditions are met:
17616
17617 .ilist
17618 No router that processed the address specified &%headers_add%& or
17619 &%headers_remove%&.
17620 .next
17621 The router did not change the address in any way, for example, by &"widening"&
17622 the domain.
17623 .endlist
17624
17625
17626
17627
17628 .option search_parents dnslookup boolean false
17629 .cindex "DNS" "resolver options"
17630 When this option is true, the resolver option RES_DNSRCH is set for DNS
17631 lookups. This is different from the &%qualify_single%& option in that it
17632 applies to domains containing dots. Typically, but not standardly, it causes
17633 the resolver to search for the name in the current domain and in parent
17634 domains. For example, on a machine in the &'fict.example'& domain, if looking
17635 up &'teaparty.wonderland'& failed, the resolver would try
17636 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17637 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17638
17639 Setting this option true can cause problems in domains that have a wildcard MX
17640 record, because any domain that does not have its own MX record matches the
17641 local wildcard.
17642
17643
17644
17645 .option srv_fail_domains dnslookup "domain list&!!" unset
17646 If the DNS lookup for SRV records for one of the domains in this list causes a
17647 DNS lookup error, Exim behaves as if no SRV records were found. See section
17648 &<<SECTprowitdnsloo>>& for more discussion.
17649
17650
17651
17652
17653 .option widen_domains dnslookup "string list" unset
17654 .cindex "domain" "partial; widening"
17655 If a DNS lookup fails and this option is set, each of its strings in turn is
17656 added onto the end of the domain, and the lookup is tried again. For example,
17657 if
17658 .code
17659 widen_domains = fict.example:ref.example
17660 .endd
17661 is set and a lookup of &'klingon.dictionary'& fails,
17662 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17663 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17664 and &%search_parents%& options can cause some widening to be undertaken inside
17665 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17666 when verifying, unless &%rewrite_headers%& is false (not the default).
17667
17668
17669 .section "Effect of qualify_single and search_parents" "SECID119"
17670 When a domain from an envelope recipient is changed by the resolver as a result
17671 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17672 corresponding address in the message's header lines unless &%rewrite_headers%&
17673 is set false. Exim then re-routes the address, using the full domain.
17674
17675 These two options affect only the DNS lookup that takes place inside the router
17676 for the domain of the address that is being routed. They do not affect lookups
17677 such as that implied by
17678 .code
17679 domains = @mx_any
17680 .endd
17681 that may happen while processing a router precondition before the router is
17682 entered. No widening ever takes place for these lookups.
17683 .ecindex IIDdnsrou1
17684 .ecindex IIDdnsrou2
17685
17686
17687
17688
17689
17690
17691
17692
17693
17694 . ////////////////////////////////////////////////////////////////////////////
17695 . ////////////////////////////////////////////////////////////////////////////
17696
17697 .chapter "The ipliteral router" "CHID5"
17698 .cindex "&(ipliteral)& router"
17699 .cindex "domain literal" "routing"
17700 .cindex "routers" "&(ipliteral)&"
17701 This router has no private options. Unless it is being used purely for
17702 verification (see &%verify_only%&) a transport is required to be defined by the
17703 generic &%transport%& option. The router accepts the address if its domain part
17704 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17705 router handles the address
17706 .code
17707 root@[192.168.1.1]
17708 .endd
17709 by setting up delivery to the host with that IP address. IPv4 domain literals
17710 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17711 are similar, but the address is preceded by &`ipv6:`&. For example:
17712 .code
17713 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17714 .endd
17715 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17716 grounds that sooner or later somebody will try it.
17717
17718 .oindex "&%self%&" "in &(ipliteral)& router"
17719 If the IP address matches something in &%ignore_target_hosts%&, the router
17720 declines. If an IP literal turns out to refer to the local host, the generic
17721 &%self%& option determines what happens.
17722
17723 The RFCs require support for domain literals; however, their use is
17724 controversial in today's Internet. If you want to use this router, you must
17725 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17726 Exim will not recognize the domain literal syntax in addresses.
17727
17728
17729
17730 . ////////////////////////////////////////////////////////////////////////////
17731 . ////////////////////////////////////////////////////////////////////////////
17732
17733 .chapter "The iplookup router" "CHID6"
17734 .cindex "&(iplookup)& router"
17735 .cindex "routers" "&(iplookup)&"
17736 The &(iplookup)& router was written to fulfil a specific requirement in
17737 Cambridge University (which in fact no longer exists). For this reason, it is
17738 not included in the binary of Exim by default. If you want to include it, you
17739 must set
17740 .code
17741 ROUTER_IPLOOKUP=yes
17742 .endd
17743 in your &_Local/Makefile_& configuration file.
17744
17745 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17746 connection to one or more specific hosts. The host can then return the same or
17747 a different address &-- in effect rewriting the recipient address in the
17748 message's envelope. The new address is then passed on to subsequent routers. If
17749 this process fails, the address can be passed on to other routers, or delivery
17750 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17751 must not be specified for it.
17752
17753 .cindex "options" "&(iplookup)& router"
17754 .option hosts iplookup string unset
17755 This option must be supplied. Its value is a colon-separated list of host
17756 names. The hosts are looked up using &[gethostbyname()]&
17757 (or &[getipnodebyname()]& when available)
17758 and are tried in order until one responds to the query. If none respond, what
17759 happens is controlled by &%optional%&.
17760
17761
17762 .option optional iplookup boolean false
17763 If &%optional%& is true, if no response is obtained from any host, the address
17764 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17765 delivery to the address is deferred.
17766
17767
17768 .option port iplookup integer 0
17769 .cindex "port" "&(iplookup)& router"
17770 This option must be supplied. It specifies the port number for the TCP or UDP
17771 call.
17772
17773
17774 .option protocol iplookup string udp
17775 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17776 protocols is to be used.
17777
17778
17779 .option query iplookup string&!! "see below"
17780 This defines the content of the query that is sent to the remote hosts. The
17781 default value is:
17782 .code
17783 $local_part@$domain $local_part@$domain
17784 .endd
17785 The repetition serves as a way of checking that a response is to the correct
17786 query in the default case (see &%response_pattern%& below).
17787
17788
17789 .option reroute iplookup string&!! unset
17790 If this option is not set, the rerouted address is precisely the byte string
17791 returned by the remote host, up to the first white space, if any. If set, the
17792 string is expanded to form the rerouted address. It can include parts matched
17793 in the response by &%response_pattern%& by means of numeric variables such as
17794 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17795 whether or not a pattern is in use. In all cases, the rerouted address must end
17796 up in the form &'local_part@domain'&.
17797
17798
17799 .option response_pattern iplookup string unset
17800 This option can be set to a regular expression that is applied to the string
17801 returned from the remote host. If the pattern does not match the response, the
17802 router declines. If &%response_pattern%& is not set, no checking of the
17803 response is done, unless the query was defaulted, in which case there is a
17804 check that the text returned after the first white space is the original
17805 address. This checks that the answer that has been received is in response to
17806 the correct question. For example, if the response is just a new domain, the
17807 following could be used:
17808 .code
17809 response_pattern = ^([^@]+)$
17810 reroute = $local_part@$1
17811 .endd
17812
17813 .option timeout iplookup time 5s
17814 This specifies the amount of time to wait for a response from the remote
17815 machine. The same timeout is used for the &[connect()]& function for a TCP
17816 call. It does not apply to UDP.
17817
17818
17819
17820
17821 . ////////////////////////////////////////////////////////////////////////////
17822 . ////////////////////////////////////////////////////////////////////////////
17823
17824 .chapter "The manualroute router" "CHID7"
17825 .scindex IIDmanrou1 "&(manualroute)& router"
17826 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17827 .cindex "domain" "manually routing"
17828 The &(manualroute)& router is so-called because it provides a way of manually
17829 routing an address according to its domain. It is mainly used when you want to
17830 route addresses to remote hosts according to your own rules, bypassing the
17831 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17832 route to local transports, a facility that may be useful if you want to save
17833 messages for dial-in hosts in local files.
17834
17835 The &(manualroute)& router compares a list of domain patterns with the domain
17836 it is trying to route. If there is no match, the router declines. Each pattern
17837 has associated with it a list of hosts and some other optional data, which may
17838 include a transport. The combination of a pattern and its data is called a
17839 &"routing rule"&. For patterns that do not have an associated transport, the
17840 generic &%transport%& option must specify a transport, unless the router is
17841 being used purely for verification (see &%verify_only%&).
17842
17843 .vindex "&$host$&"
17844 In the case of verification, matching the domain pattern is sufficient for the
17845 router to accept the address. When actually routing an address for delivery,
17846 an address that matches a domain pattern is queued for the associated
17847 transport. If the transport is not a local one, a host list must be associated
17848 with the pattern; IP addresses are looked up for the hosts, and these are
17849 passed to the transport along with the mail address. For local transports, a
17850 host list is optional. If it is present, it is passed in &$host$& as a single
17851 text string.
17852
17853 The list of routing rules can be provided as an inline string in
17854 &%route_list%&, or the data can be obtained by looking up the domain in a file
17855 or database by setting &%route_data%&. Only one of these settings may appear in
17856 any one instance of &(manualroute)&. The format of routing rules is described
17857 below, following the list of private options.
17858
17859
17860 .section "Private options for manualroute" "SECTprioptman"
17861
17862 .cindex "options" "&(manualroute)& router"
17863 The private options for the &(manualroute)& router are as follows:
17864
17865 .option host_all_ignored manualroute string defer
17866 See &%host_find_failed%&.
17867
17868 .option host_find_failed manualroute string freeze
17869 This option controls what happens when &(manualroute)& tries to find an IP
17870 address for a host, and the host does not exist. The option can be set to one
17871 of the following values:
17872 .code
17873 decline
17874 defer
17875 fail
17876 freeze
17877 ignore
17878 pass
17879 .endd
17880 The default (&"freeze"&) assumes that this state is a serious configuration
17881 error. The difference between &"pass"& and &"decline"& is that the former
17882 forces the address to be passed to the next router (or the router defined by
17883 &%pass_router%&),
17884 .oindex "&%more%&"
17885 overriding &%no_more%&, whereas the latter passes the address to the next
17886 router only if &%more%& is true.
17887
17888 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17889 cannot be found. If all the hosts in the list are ignored, the behaviour is
17890 controlled by the &%host_all_ignored%& option. This takes the same values
17891 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17892
17893 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17894 state; if a host lookup gets a temporary error, delivery is deferred unless the
17895 generic &%pass_on_timeout%& option is set.
17896
17897
17898 .option hosts_randomize manualroute boolean false
17899 .cindex "randomized host list"
17900 .cindex "host" "list of; randomized"
17901 If this option is set, the order of the items in a host list in a routing rule
17902 is randomized each time the list is used, unless an option in the routing rule
17903 overrides (see below). Randomizing the order of a host list can be used to do
17904 crude load sharing. However, if more than one mail address is routed by the
17905 same router to the same host list, the host lists are considered to be the same
17906 (even though they may be randomized into different orders) for the purpose of
17907 deciding whether to batch the deliveries into a single SMTP transaction.
17908
17909 When &%hosts_randomize%& is true, a host list may be split
17910 into groups whose order is separately randomized. This makes it possible to
17911 set up MX-like behaviour. The boundaries between groups are indicated by an
17912 item that is just &`+`& in the host list. For example:
17913 .code
17914 route_list = * host1:host2:host3:+:host4:host5
17915 .endd
17916 The order of the first three hosts and the order of the last two hosts is
17917 randomized for each use, but the first three always end up before the last two.
17918 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17919 randomized host list is passed to an &(smtp)& transport that also has
17920 &%hosts_randomize set%&, the list is not re-randomized.
17921
17922
17923 .option route_data manualroute string&!! unset
17924 If this option is set, it must expand to yield the data part of a routing rule.
17925 Typically, the expansion string includes a lookup based on the domain. For
17926 example:
17927 .code
17928 route_data = ${lookup{$domain}dbm{/etc/routes}}
17929 .endd
17930 If the expansion is forced to fail, or the result is an empty string, the
17931 router declines. Other kinds of expansion failure cause delivery to be
17932 deferred.
17933
17934
17935 .option route_list manualroute "string list" unset
17936 This string is a list of routing rules, in the form defined below. Note that,
17937 unlike most string lists, the items are separated by semicolons. This is so
17938 that they may contain colon-separated host lists.
17939
17940
17941 .option same_domain_copy_routing manualroute boolean false
17942 .cindex "address" "copying routing"
17943 Addresses with the same domain are normally routed by the &(manualroute)&
17944 router to the same list of hosts. However, this cannot be presumed, because the
17945 router options and preconditions may refer to the local part of the address. By
17946 default, therefore, Exim routes each address in a message independently. DNS
17947 servers run caches, so repeated DNS lookups are not normally expensive, and in
17948 any case, personal messages rarely have more than a few recipients.
17949
17950 If you are running mailing lists with large numbers of subscribers at the same
17951 domain, and you are using a &(manualroute)& router which is independent of the
17952 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17953 lookups for identical domains in one message. In this case, when
17954 &(manualroute)& routes an address to a remote transport, any other unrouted
17955 addresses in the message that have the same domain are automatically given the
17956 same routing without processing them independently. However, this is only done
17957 if &%headers_add%& and &%headers_remove%& are unset.
17958
17959
17960
17961
17962 .section "Routing rules in route_list" "SECID120"
17963 The value of &%route_list%& is a string consisting of a sequence of routing
17964 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17965 entered as two semicolons. Alternatively, the list separator can be changed as
17966 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17967 Empty rules are ignored. The format of each rule is
17968 .display
17969 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17970 .endd
17971 The following example contains two rules, each with a simple domain pattern and
17972 no options:
17973 .code
17974 route_list = \
17975   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17976   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17977 .endd
17978 The three parts of a rule are separated by white space. The pattern and the
17979 list of hosts can be enclosed in quotes if necessary, and if they are, the
17980 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17981 single domain pattern, which is the only mandatory item in the rule. The
17982 pattern is in the same format as one item in a domain list (see section
17983 &<<SECTdomainlist>>&),
17984 except that it may not be the name of an interpolated file.
17985 That is, it may be wildcarded, or a regular expression, or a file or database
17986 lookup (with semicolons doubled, because of the use of semicolon as a separator
17987 in a &%route_list%&).
17988
17989 The rules in &%route_list%& are searched in order until one of the patterns
17990 matches the domain that is being routed. The list of hosts and then options are
17991 then used as described below. If there is no match, the router declines. When
17992 &%route_list%& is set, &%route_data%& must not be set.
17993
17994
17995
17996 .section "Routing rules in route_data" "SECID121"
17997 The use of &%route_list%& is convenient when there are only a small number of
17998 routing rules. For larger numbers, it is easier to use a file or database to
17999 hold the routing information, and use the &%route_data%& option instead.
18000 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18001 Most commonly, &%route_data%& is set as a string that contains an
18002 expansion lookup. For example, suppose we place two routing rules in a file
18003 like this:
18004 .code
18005 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18006 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18007 .endd
18008 This data can be accessed by setting
18009 .code
18010 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18011 .endd
18012 Failure of the lookup results in an empty string, causing the router to
18013 decline. However, you do not have to use a lookup in &%route_data%&. The only
18014 requirement is that the result of expanding the string is a list of hosts,
18015 possibly followed by options, separated by white space. The list of hosts must
18016 be enclosed in quotes if it contains white space.
18017
18018
18019
18020
18021 .section "Format of the list of hosts" "SECID122"
18022 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18023 always separately expanded before use. If the expansion fails, the router
18024 declines. The result of the expansion must be a colon-separated list of names
18025 and/or IP addresses, optionally also including ports. The format of each item
18026 in the list is described in the next section. The list separator can be changed
18027 as described in section &<<SECTlistconstruct>>&.
18028
18029 If the list of hosts was obtained from a &%route_list%& item, the following
18030 variables are set during its expansion:
18031
18032 .ilist
18033 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18034 If the domain was matched against a regular expression, the numeric variables
18035 &$1$&, &$2$&, etc. may be set. For example:
18036 .code
18037 route_list = ^domain(\d+)   host-$1.text.example
18038 .endd
18039 .next
18040 &$0$& is always set to the entire domain.
18041 .next
18042 &$1$& is also set when partial matching is done in a file lookup.
18043
18044 .next
18045 .vindex "&$value$&"
18046 If the pattern that matched the domain was a lookup item, the data that was
18047 looked up is available in the expansion variable &$value$&. For example:
18048 .code
18049 route_list = lsearch;;/some/file.routes  $value
18050 .endd
18051 .endlist
18052
18053 Note the doubling of the semicolon in the pattern that is necessary because
18054 semicolon is the default route list separator.
18055
18056
18057
18058 .section "Format of one host item" "SECTformatonehostitem"
18059 Each item in the list of hosts is either a host name or an IP address,
18060 optionally with an attached port number. When no port is given, an IP address
18061 is not enclosed in brackets. When a port is specified, it overrides the port
18062 specification on the transport. The port is separated from the name or address
18063 by a colon. This leads to some complications:
18064
18065 .ilist
18066 Because colon is the default separator for the list of hosts, either
18067 the colon that specifies a port must be doubled, or the list separator must
18068 be changed. The following two examples have the same effect:
18069 .code
18070 route_list = * "host1.tld::1225 : host2.tld::1226"
18071 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18072 .endd
18073 .next
18074 When IPv6 addresses are involved, it gets worse, because they contain
18075 colons of their own. To make this case easier, it is permitted to
18076 enclose an IP address (either v4 or v6) in square brackets if a port
18077 number follows. For example:
18078 .code
18079 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18080 .endd
18081 .endlist
18082
18083 .section "How the list of hosts is used" "SECThostshowused"
18084 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18085 the hosts is tried, in the order specified, when carrying out the SMTP
18086 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18087 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18088 transport.
18089
18090 Hosts may be listed by name or by IP address. An unadorned name in the list of
18091 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18092 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18093 records in the DNS. For example:
18094 .code
18095 route_list = *  x.y.z:p.q.r/MX:e.f.g
18096 .endd
18097 If this feature is used with a port specifier, the port must come last. For
18098 example:
18099 .code
18100 route_list = *  dom1.tld/mx::1225
18101 .endd
18102 If the &%hosts_randomize%& option is set, the order of the items in the list is
18103 randomized before any lookups are done. Exim then scans the list; for any name
18104 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18105 be an interface on the local host and the item is not the first in the list,
18106 Exim discards it and any subsequent items. If it is the first item, what
18107 happens is controlled by the
18108 .oindex "&%self%&" "in &(manualroute)& router"
18109 &%self%& option of the router.
18110
18111 A name on the list that is followed by &`/MX`& is replaced with the list of
18112 hosts obtained by looking up MX records for the name. This is always a DNS
18113 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18114 below) are not relevant here. The order of these hosts is determined by the
18115 preference values in the MX records, according to the usual rules. Because
18116 randomizing happens before the MX lookup, it does not affect the order that is
18117 defined by MX preferences.
18118
18119 If the local host is present in the sublist obtained from MX records, but is
18120 not the most preferred host in that list, it and any equally or less
18121 preferred hosts are removed before the sublist is inserted into the main list.
18122
18123 If the local host is the most preferred host in the MX list, what happens
18124 depends on where in the original list of hosts the &`/MX`& item appears. If it
18125 is not the first item (that is, there are previous hosts in the main list),
18126 Exim discards this name and any subsequent items in the main list.
18127
18128 If the MX item is first in the list of hosts, and the local host is the
18129 most preferred host, what happens is controlled by the &%self%& option of the
18130 router.
18131
18132 DNS failures when lookup up the MX records are treated in the same way as DNS
18133 failures when looking up IP addresses: &%pass_on_timeout%& and
18134 &%host_find_failed%& are used when relevant.
18135
18136 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18137 whether obtained from an MX lookup or not.
18138
18139
18140
18141 .section "How the options are used" "SECThowoptused"
18142 The options are a sequence of words; in practice no more than three are ever
18143 present. One of the words can be the name of a transport; this overrides the
18144 &%transport%& option on the router for this particular routing rule only. The
18145 other words (if present) control randomization of the list of hosts on a
18146 per-rule basis, and how the IP addresses of the hosts are to be found when
18147 routing to a remote transport. These options are as follows:
18148
18149 .ilist
18150 &%randomize%&: randomize the order of the hosts in this list, overriding the
18151 setting of &%hosts_randomize%& for this routing rule only.
18152 .next
18153 &%no_randomize%&: do not randomize the order of the hosts in this list,
18154 overriding the setting of &%hosts_randomize%& for this routing rule only.
18155 .next
18156 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18157 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18158 also look in &_/etc/hosts_& or other sources of information.
18159 .next
18160 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18161 no address records are found. If there is a temporary DNS error (such as a
18162 timeout), delivery is deferred.
18163 .endlist
18164
18165 For example:
18166 .code
18167 route_list = domain1  host1:host2:host3  randomize bydns;\
18168              domain2  host4:host5
18169 .endd
18170 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18171 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18172 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18173 or &[gethostbyname()]&, and the result of the lookup is the result of that
18174 call.
18175
18176 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18177 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18178 instead of TRY_AGAIN. That is why the default action is to try a DNS
18179 lookup first. Only if that gives a definite &"no such host"& is the local
18180 function called.
18181
18182
18183
18184 If no IP address for a host can be found, what happens is controlled by the
18185 &%host_find_failed%& option.
18186
18187 .vindex "&$host$&"
18188 When an address is routed to a local transport, IP addresses are not looked up.
18189 The host list is passed to the transport in the &$host$& variable.
18190
18191
18192
18193 .section "Manualroute examples" "SECID123"
18194 In some of the examples that follow, the presence of the &%remote_smtp%&
18195 transport, as defined in the default configuration file, is assumed:
18196
18197 .ilist
18198 .cindex "smart host" "example router"
18199 The &(manualroute)& router can be used to forward all external mail to a
18200 &'smart host'&. If you have set up, in the main part of the configuration, a
18201 named domain list that contains your local domains, for example:
18202 .code
18203 domainlist local_domains = my.domain.example
18204 .endd
18205 You can arrange for all other domains to be routed to a smart host by making
18206 your first router something like this:
18207 .code
18208 smart_route:
18209   driver = manualroute
18210   domains = !+local_domains
18211   transport = remote_smtp
18212   route_list = * smarthost.ref.example
18213 .endd
18214 This causes all non-local addresses to be sent to the single host
18215 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18216 they are tried in order
18217 (but you can use &%hosts_randomize%& to vary the order each time).
18218 Another way of configuring the same thing is this:
18219 .code
18220 smart_route:
18221   driver = manualroute
18222   transport = remote_smtp
18223   route_list = !+local_domains  smarthost.ref.example
18224 .endd
18225 There is no difference in behaviour between these two routers as they stand.
18226 However, they behave differently if &%no_more%& is added to them. In the first
18227 example, the router is skipped if the domain does not match the &%domains%&
18228 precondition; the following router is always tried. If the router runs, it
18229 always matches the domain and so can never decline. Therefore, &%no_more%&
18230 would have no effect. In the second case, the router is never skipped; it
18231 always runs. However, if it doesn't match the domain, it declines. In this case
18232 &%no_more%& would prevent subsequent routers from running.
18233
18234 .next
18235 .cindex "mail hub example"
18236 A &'mail hub'& is a host which receives mail for a number of domains via MX
18237 records in the DNS and delivers it via its own private routing mechanism. Often
18238 the final destinations are behind a firewall, with the mail hub being the one
18239 machine that can connect to machines both inside and outside the firewall. The
18240 &(manualroute)& router is usually used on a mail hub to route incoming messages
18241 to the correct hosts. For a small number of domains, the routing can be inline,
18242 using the &%route_list%& option, but for a larger number a file or database
18243 lookup is easier to manage.
18244
18245 If the domain names are in fact the names of the machines to which the mail is
18246 to be sent by the mail hub, the configuration can be quite simple. For
18247 example:
18248 .code
18249 hub_route:
18250   driver = manualroute
18251   transport = remote_smtp
18252   route_list = *.rhodes.tvs.example  $domain
18253 .endd
18254 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18255 whose names are the same as the mail domains. A similar approach can be taken
18256 if the host name can be obtained from the domain name by a string manipulation
18257 that the expansion facilities can handle. Otherwise, a lookup based on the
18258 domain can be used to find the host:
18259 .code
18260 through_firewall:
18261   driver = manualroute
18262   transport = remote_smtp
18263   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18264 .endd
18265 The result of the lookup must be the name or IP address of the host (or
18266 hosts) to which the address is to be routed. If the lookup fails, the route
18267 data is empty, causing the router to decline. The address then passes to the
18268 next router.
18269
18270 .next
18271 .cindex "batched SMTP output example"
18272 .cindex "SMTP" "batched outgoing; example"
18273 You can use &(manualroute)& to deliver messages to pipes or files in batched
18274 SMTP format for onward transportation by some other means. This is one way of
18275 storing mail for a dial-up host when it is not connected. The route list entry
18276 can be as simple as a single domain name in a configuration like this:
18277 .code
18278 save_in_file:
18279   driver = manualroute
18280   transport = batchsmtp_appendfile
18281   route_list = saved.domain.example
18282 .endd
18283 though often a pattern is used to pick up more than one domain. If there are
18284 several domains or groups of domains with different transport requirements,
18285 different transports can be listed in the routing information:
18286 .code
18287 save_in_file:
18288   driver = manualroute
18289   route_list = \
18290     *.saved.domain1.example  $domain  batch_appendfile; \
18291     *.saved.domain2.example  \
18292       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18293       batch_pipe
18294 .endd
18295 .vindex "&$domain$&"
18296 .vindex "&$host$&"
18297 The first of these just passes the domain in the &$host$& variable, which
18298 doesn't achieve much (since it is also in &$domain$&), but the second does a
18299 file lookup to find a value to pass, causing the router to decline to handle
18300 the address if the lookup fails.
18301
18302 .next
18303 .cindex "UUCP" "example of router for"
18304 Routing mail directly to UUCP software is a specific case of the use of
18305 &(manualroute)& in a gateway to another mail environment. This is an example of
18306 one way it can be done:
18307 .code
18308 # Transport
18309 uucp:
18310   driver = pipe
18311   user = nobody
18312   command = /usr/local/bin/uux -r - \
18313     ${substr_-5:$host}!rmail ${local_part}
18314   return_fail_output = true
18315
18316 # Router
18317 uucphost:
18318   transport = uucp
18319   driver = manualroute
18320   route_data = \
18321     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18322 .endd
18323 The file &_/usr/local/exim/uucphosts_& contains entries like
18324 .code
18325 darksite.ethereal.example:           darksite.UUCP
18326 .endd
18327 It can be set up more simply without adding and removing &".UUCP"& but this way
18328 makes clear the distinction between the domain name
18329 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18330 .endlist
18331 .ecindex IIDmanrou1
18332 .ecindex IIDmanrou2
18333
18334
18335
18336
18337
18338
18339
18340
18341 . ////////////////////////////////////////////////////////////////////////////
18342 . ////////////////////////////////////////////////////////////////////////////
18343
18344 .chapter "The queryprogram router" "CHAPdriverlast"
18345 .scindex IIDquerou1 "&(queryprogram)& router"
18346 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18347 .cindex "routing" "by external program"
18348 The &(queryprogram)& router routes an address by running an external command
18349 and acting on its output. This is an expensive way to route, and is intended
18350 mainly for use in lightly-loaded systems, or for performing experiments.
18351 However, if it is possible to use the precondition options (&%domains%&,
18352 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18353 be used in special cases, even on a busy host. There are the following private
18354 options:
18355 .cindex "options" "&(queryprogram)& router"
18356
18357 .option command queryprogram string&!! unset
18358 This option must be set. It specifies the command that is to be run. The
18359 command is split up into a command name and arguments, and then each is
18360 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18361 &<<CHAPpipetransport>>&).
18362
18363
18364 .option command_group queryprogram string unset
18365 .cindex "gid (group id)" "in &(queryprogram)& router"
18366 This option specifies a gid to be set when running the command while routing an
18367 address for deliver. It must be set if &%command_user%& specifies a numerical
18368 uid. If it begins with a digit, it is interpreted as the numerical value of the
18369 gid. Otherwise it is looked up using &[getgrnam()]&.
18370
18371
18372 .option command_user queryprogram string unset
18373 .cindex "uid (user id)" "for &(queryprogram)&"
18374 This option must be set. It specifies the uid which is set when running the
18375 command while routing an address for delivery. If the value begins with a digit,
18376 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18377 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18378 not set, a value for the gid also.
18379
18380 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18381 root, which it does during a normal delivery in a conventional configuration.
18382 However, when an address is being verified during message reception, Exim is
18383 usually running as the Exim user, not as root. If the &(queryprogram)& router
18384 is called from a non-root process, Exim cannot change uid or gid before running
18385 the command. In this circumstance the command runs under the current uid and
18386 gid.
18387
18388
18389 .option current_directory queryprogram string /
18390 This option specifies an absolute path which is made the current directory
18391 before running the command.
18392
18393
18394 .option timeout queryprogram time 1h
18395 If the command does not complete within the timeout period, its process group
18396 is killed and the message is frozen. A value of zero time specifies no
18397 timeout.
18398
18399
18400 The standard output of the command is connected to a pipe, which is read when
18401 the command terminates. It should consist of a single line of output,
18402 containing up to five fields, separated by white space. The maximum length of
18403 the line is 1023 characters. Longer lines are silently truncated. The first
18404 field is one of the following words (case-insensitive):
18405
18406 .ilist
18407 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18408 below).
18409 .next
18410 &'Decline'&: the router declines; pass the address to the next router, unless
18411 &%no_more%& is set.
18412 .next
18413 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18414 subsequent text on the line is an error message. If the router is run as part
18415 of address verification during an incoming SMTP message, the message is
18416 included in the SMTP response.
18417 .next
18418 &'Defer'&: routing could not be completed at this time; try again later. Any
18419 subsequent text on the line is an error message which is logged. It is not
18420 included in any SMTP response.
18421 .next
18422 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18423 .next
18424 &'Pass'&: pass the address to the next router (or the router specified by
18425 &%pass_router%&), overriding &%no_more%&.
18426 .next
18427 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18428 new addresses, which are routed independently, starting with the first router,
18429 or the router specified by &%redirect_router%&, if set.
18430 .endlist
18431
18432 When the first word is &'accept'&, the remainder of the line consists of a
18433 number of keyed data values, as follows (split into two lines here, to fit on
18434 the page):
18435 .code
18436 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18437 LOOKUP=byname|bydns DATA=<text>
18438 .endd
18439 The data items can be given in any order, and all are optional. If no transport
18440 is included, the transport specified by the generic &%transport%& option is
18441 used. The list of hosts and the lookup type are needed only if the transport is
18442 an &(smtp)& transport that does not itself supply a list of hosts.
18443
18444 The format of the list of hosts is the same as for the &(manualroute)& router.
18445 As well as host names and IP addresses with optional port numbers, as described
18446 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18447 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18448 (see section &<<SECThostshowused>>&).
18449
18450 If the lookup type is not specified, Exim behaves as follows when trying to
18451 find an IP address for each host: First, a DNS lookup is done. If this yields
18452 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18453 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18454 result of the lookup is the result of that call.
18455
18456 .vindex "&$address_data$&"
18457 If the DATA field is set, its value is placed in the &$address_data$&
18458 variable. For example, this return line
18459 .code
18460 accept hosts=x1.y.example:x2.y.example data="rule1"
18461 .endd
18462 routes the address to the default transport, passing a list of two hosts. When
18463 the transport runs, the string &"rule1"& is in &$address_data$&.
18464 .ecindex IIDquerou1
18465 .ecindex IIDquerou2
18466
18467
18468
18469
18470 . ////////////////////////////////////////////////////////////////////////////
18471 . ////////////////////////////////////////////////////////////////////////////
18472
18473 .chapter "The redirect router" "CHAPredirect"
18474 .scindex IIDredrou1 "&(redirect)& router"
18475 .scindex IIDredrou2 "routers" "&(redirect)&"
18476 .cindex "alias file" "in a &(redirect)& router"
18477 .cindex "address redirection" "&(redirect)& router"
18478 The &(redirect)& router handles several kinds of address redirection. Its most
18479 common uses are for resolving local part aliases from a central alias file
18480 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18481 files, but it has many other potential uses. The incoming address can be
18482 redirected in several different ways:
18483
18484 .ilist
18485 It can be replaced by one or more new addresses which are themselves routed
18486 independently.
18487 .next
18488 It can be routed to be delivered to a given file or directory.
18489 .next
18490 It can be routed to be delivered to a specified pipe command.
18491 .next
18492 It can cause an automatic reply to be generated.
18493 .next
18494 It can be forced to fail, optionally with a custom error message.
18495 .next
18496 It can be temporarily deferred, optionally with a custom message.
18497 .next
18498 It can be discarded.
18499 .endlist
18500
18501 The generic &%transport%& option must not be set for &(redirect)& routers.
18502 However, there are some private options which define transports for delivery to
18503 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18504 &%pipe_transport%& and &%reply_transport%& descriptions below.
18505
18506
18507
18508 .section "Redirection data" "SECID124"
18509 The router operates by interpreting a text string which it obtains either by
18510 expanding the contents of the &%data%& option, or by reading the entire
18511 contents of a file whose name is given in the &%file%& option. These two
18512 options are mutually exclusive. The first is commonly used for handling system
18513 aliases, in a configuration like this:
18514 .code
18515 system_aliases:
18516   driver = redirect
18517   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18518 .endd
18519 If the lookup fails, the expanded string in this example is empty. When the
18520 expansion of &%data%& results in an empty string, the router declines. A forced
18521 expansion failure also causes the router to decline; other expansion failures
18522 cause delivery to be deferred.
18523
18524 A configuration using &%file%& is commonly used for handling users'
18525 &_.forward_& files, like this:
18526 .code
18527 userforward:
18528   driver = redirect
18529   check_local_user
18530   file = $home/.forward
18531   no_verify
18532 .endd
18533 If the file does not exist, or causes no action to be taken (for example, it is
18534 empty or consists only of comments), the router declines. &*Warning*&: This
18535 is not the case when the file contains syntactically valid items that happen to
18536 yield empty addresses, for example, items containing only RFC 2822 address
18537 comments.
18538
18539
18540
18541 .section "Forward files and address verification" "SECID125"
18542 .cindex "address redirection" "while verifying"
18543 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18544 &_.forward_& files, as in the example above. There are two reasons for this:
18545
18546 .ilist
18547 When Exim is receiving an incoming SMTP message from a remote host, it is
18548 running under the Exim uid, not as root. Exim is unable to change uid to read
18549 the file as the user, and it may not be able to read it as the Exim user. So in
18550 practice the router may not be able to operate.
18551 .next
18552 However, even when the router can operate, the existence of a &_.forward_& file
18553 is unimportant when verifying an address. What should be checked is whether the
18554 local part is a valid user name or not. Cutting out the redirection processing
18555 saves some resources.
18556 .endlist
18557
18558
18559
18560
18561
18562
18563 .section "Interpreting redirection data" "SECID126"
18564 .cindex "Sieve filter" "specifying in redirection data"
18565 .cindex "filter" "specifying in redirection data"
18566 The contents of the data string, whether obtained from &%data%& or &%file%&,
18567 can be interpreted in two different ways:
18568
18569 .ilist
18570 If the &%allow_filter%& option is set true, and the data begins with the text
18571 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18572 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18573 respectively. Details of the syntax and semantics of filter files are described
18574 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18575 document is intended for use by end users.
18576 .next
18577 Otherwise, the data must be a comma-separated list of redirection items, as
18578 described in the next section.
18579 .endlist
18580
18581 When a message is redirected to a file (a &"mail folder"&), the file name given
18582 in a non-filter redirection list must always be an absolute path. A filter may
18583 generate a relative path &-- how this is handled depends on the transport's
18584 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18585 for the &(appendfile)& transport.
18586
18587
18588
18589 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18590 .cindex "address redirection" "non-filter list items"
18591 When the redirection data is not an Exim or Sieve filter, for example, if it
18592 comes from a conventional alias or forward file, it consists of a list of
18593 addresses, file names, pipe commands, or certain special items (see section
18594 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18595 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18596 depending on their default values. The items in the list are separated by
18597 commas or newlines.
18598 If a comma is required in an item, the entire item must be enclosed in double
18599 quotes.
18600
18601 Lines starting with a # character are comments, and are ignored, and # may
18602 also appear following a comma, in which case everything between the # and the
18603 next newline character is ignored.
18604
18605 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18606 double quotes are retained because some forms of mail address require their use
18607 (but never to enclose the entire address). In the following description,
18608 &"item"& refers to what remains after any surrounding double quotes have been
18609 removed.
18610
18611 .vindex "&$local_part$&"
18612 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18613 and the expansion contains a reference to &$local_part$&, you should make use
18614 of the &%quote_local_part%& expansion operator, in case the local part contains
18615 special characters. For example, to redirect all mail for the domain
18616 &'obsolete.example'&, retaining the existing local part, you could use this
18617 setting:
18618 .code
18619 data = ${quote_local_part:$local_part}@newdomain.example
18620 .endd
18621
18622
18623 .section "Redirecting to a local mailbox" "SECTredlocmai"
18624 .cindex "routing" "loops in"
18625 .cindex "loop" "while routing, avoidance of"
18626 .cindex "address redirection" "to local mailbox"
18627 A redirection item may safely be the same as the address currently under
18628 consideration. This does not cause a routing loop, because a router is
18629 automatically skipped if any ancestor of the address that is being processed
18630 is the same as the current address and was processed by the current router.
18631 Such an address is therefore passed to the following routers, so it is handled
18632 as if there were no redirection. When making this loop-avoidance test, the
18633 complete local part, including any prefix or suffix, is used.
18634
18635 .cindex "address redirection" "local part without domain"
18636 Specifying the same local part without a domain is a common usage in personal
18637 filter files when the user wants to have messages delivered to the local
18638 mailbox and also forwarded elsewhere. For example, the user whose login is
18639 &'cleo'& might have a &_.forward_& file containing this:
18640 .code
18641 cleo, cleopatra@egypt.example
18642 .endd
18643 .cindex "backslash in alias file"
18644 .cindex "alias file" "backslash in"
18645 For compatibility with other MTAs, such unqualified local parts may be
18646 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18647 it does make a difference if more than one domain is being handled
18648 synonymously.
18649
18650 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18651 2822 address that does not include a domain, the item is qualified using the
18652 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18653 addresses are qualified using the value in &%qualify_recipient%&, but you can
18654 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18655
18656 Care must be taken if there are alias names for local users.
18657 Consider an MTA handling a single local domain where the system alias file
18658 contains:
18659 .code
18660 Sam.Reman: spqr
18661 .endd
18662 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18663 messages in the local mailbox, and also forward copies elsewhere. He creates
18664 this forward file:
18665 .code
18666 Sam.Reman, spqr@reme.elsewhere.example
18667 .endd
18668 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18669 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18670 second time round, because it has previously routed it,
18671 and the following routers presumably cannot handle the alias. The forward file
18672 should really contain
18673 .code
18674 spqr, spqr@reme.elsewhere.example
18675 .endd
18676 but because this is such a common error, the &%check_ancestor%& option (see
18677 below) exists to provide a way to get round it. This is normally set on a
18678 &(redirect)& router that is handling users' &_.forward_& files.
18679
18680
18681
18682 .section "Special items in redirection lists" "SECTspecitredli"
18683 In addition to addresses, the following types of item may appear in redirection
18684 lists (that is, in non-filter redirection data):
18685
18686 .ilist
18687 .cindex "pipe" "in redirection list"
18688 .cindex "address redirection" "to pipe"
18689 An item is treated as a pipe command if it begins with &"|"& and does not parse
18690 as a valid RFC 2822 address that includes a domain. A transport for running the
18691 command must be specified by the &%pipe_transport%& option.
18692 Normally, either the router or the transport specifies a user and a group under
18693 which to run the delivery. The default is to use the Exim user and group.
18694
18695 Single or double quotes can be used for enclosing the individual arguments of
18696 the pipe command; no interpretation of escapes is done for single quotes. If
18697 the command contains a comma character, it is necessary to put the whole item
18698 in double quotes, for example:
18699 .code
18700 "|/some/command ready,steady,go"
18701 .endd
18702 since items in redirection lists are terminated by commas. Do not, however,
18703 quote just the command. An item such as
18704 .code
18705 |"/some/command ready,steady,go"
18706 .endd
18707 is interpreted as a pipe with a rather strange command name, and no arguments.
18708
18709 .new
18710 Note that the above example assumes that the text comes from a lookup source
18711 of some sort, so that the quotes are part of the data.  If composing a
18712 redirect router with a &%data%& option directly specifying this command, the
18713 quotes will be used by the configuration parser to define the extent of one
18714 string, but will not be passed down into the redirect router itself.  There
18715 are two main approaches to get around this: escape quotes to be part of the
18716 data itself, or avoid using this mechanism and instead create a custom
18717 transport with the &%command%& option set and reference that transport from
18718 an &%accept%& router.
18719 .wen
18720
18721 .next
18722 .cindex "file" "in redirection list"
18723 .cindex "address redirection" "to file"
18724 An item is interpreted as a path name if it begins with &"/"& and does not
18725 parse as a valid RFC 2822 address that includes a domain. For example,
18726 .code
18727 /home/world/minbari
18728 .endd
18729 is treated as a file name, but
18730 .code
18731 /s=molari/o=babylon/@x400gate.way
18732 .endd
18733 is treated as an address. For a file name, a transport must be specified using
18734 the &%file_transport%& option. However, if the generated path name ends with a
18735 forward slash character, it is interpreted as a directory name rather than a
18736 file name, and &%directory_transport%& is used instead.
18737
18738 Normally, either the router or the transport specifies a user and a group under
18739 which to run the delivery. The default is to use the Exim user and group.
18740
18741 .cindex "&_/dev/null_&"
18742 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18743 bypassed at a high level, and the log entry shows &"**bypassed**"&
18744 instead of a transport name. In this case the user and group are not used.
18745
18746 .next
18747 .cindex "included address list"
18748 .cindex "address redirection" "included external list"
18749 If an item is of the form
18750 .code
18751 :include:<path name>
18752 .endd
18753 a list of further items is taken from the given file and included at that
18754 point. &*Note*&: Such a file can not be a filter file; it is just an
18755 out-of-line addition to the list. The items in the included list are separated
18756 by commas or newlines and are not subject to expansion. If this is the first
18757 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18758 the alias name. This example is incorrect:
18759 .code
18760 list1    :include:/opt/lists/list1
18761 .endd
18762 It must be given as
18763 .code
18764 list1:   :include:/opt/lists/list1
18765 .endd
18766 .next
18767 .cindex "address redirection" "to black hole"
18768 Sometimes you want to throw away mail to a particular local part. Making the
18769 &%data%& option expand to an empty string does not work, because that causes
18770 the router to decline. Instead, the alias item
18771 .cindex "black hole"
18772 .cindex "abandoning mail"
18773 &':blackhole:'& can be used. It does what its name implies. No delivery is
18774 done, and no error message is generated. This has the same effect as specifing
18775 &_/dev/null_& as a destination, but it can be independently disabled.
18776
18777 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18778 delivery is done for the original local part, even if other redirection items
18779 are present. If you are generating a multi-item list (for example, by reading a
18780 database) and need the ability to provide a no-op item, you must use
18781 &_/dev/null_&.
18782
18783 .next
18784 .cindex "delivery" "forcing failure"
18785 .cindex "delivery" "forcing deferral"
18786 .cindex "failing delivery" "forcing"
18787 .cindex "deferred delivery, forcing"
18788 .cindex "customizing" "failure message"
18789 An attempt to deliver a particular address can be deferred or forced to fail by
18790 redirection items of the form
18791 .code
18792 :defer:
18793 :fail:
18794 .endd
18795 respectively. When a redirection list contains such an item, it applies
18796 to the entire redirection; any other items in the list are ignored. Any
18797 text following &':fail:'& or &':defer:'& is placed in the error text
18798 associated with the failure. For example, an alias file might contain:
18799 .code
18800 X.Employee:  :fail: Gone away, no forwarding address
18801 .endd
18802 In the case of an address that is being verified from an ACL or as the subject
18803 of a
18804 .cindex "VRFY" "error text, display of"
18805 VRFY command, the text is included in the SMTP error response by
18806 default.
18807 .cindex "EXPN" "error text, display of"
18808 The text is not included in the response to an EXPN command. In non-SMTP cases
18809 the text is included in the error message that Exim generates.
18810
18811 .cindex "SMTP" "error codes"
18812 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18813 &':fail:'&. However, if the message starts with three digits followed by a
18814 space, optionally followed by an extended code of the form &'n.n.n'&, also
18815 followed by a space, and the very first digit is the same as the default error
18816 code, the code from the message is used instead. If the very first digit is
18817 incorrect, a panic error is logged, and the default code is used. You can
18818 suppress the use of the supplied code in a redirect router by setting the
18819 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18820 ignored.
18821
18822 .vindex "&$acl_verify_message$&"
18823 In an ACL, an explicitly provided message overrides the default, but the
18824 default message is available in the variable &$acl_verify_message$& and can
18825 therefore be included in a custom message if this is desired.
18826
18827 Normally the error text is the rest of the redirection list &-- a comma does
18828 not terminate it &-- but a newline does act as a terminator. Newlines are not
18829 normally present in alias expansions. In &(lsearch)& lookups they are removed
18830 as part of the continuation process, but they may exist in other kinds of
18831 lookup and in &':include:'& files.
18832
18833 During routing for message delivery (as opposed to verification), a redirection
18834 containing &':fail:'& causes an immediate failure of the incoming address,
18835 whereas &':defer:'& causes the message to remain on the queue so that a
18836 subsequent delivery attempt can happen at a later time. If an address is
18837 deferred for too long, it will ultimately fail, because the normal retry
18838 rules still apply.
18839
18840 .next
18841 .cindex "alias file" "exception to default"
18842 Sometimes it is useful to use a single-key search type with a default (see
18843 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18844 for exceptions to the default. These can be handled by aliasing them to
18845 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18846 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18847 results in an empty redirection list has the same effect.
18848 .endlist
18849
18850
18851 .section "Duplicate addresses" "SECTdupaddr"
18852 .cindex "duplicate addresses"
18853 .cindex "address duplicate, discarding"
18854 .cindex "pipe" "duplicated"
18855 Exim removes duplicate addresses from the list to which it is delivering, so as
18856 to deliver just one copy to each address. This does not apply to deliveries
18857 routed to pipes by different immediate parent addresses, but an indirect
18858 aliasing scheme of the type
18859 .code
18860 pipe:       |/some/command $local_part
18861 localpart1: pipe
18862 localpart2: pipe
18863 .endd
18864 does not work with a message that is addressed to both local parts, because
18865 when the second is aliased to the intermediate local part &"pipe"& it gets
18866 discarded as being the same as a previously handled address. However, a scheme
18867 such as
18868 .code
18869 localpart1: |/some/command $local_part
18870 localpart2: |/some/command $local_part
18871 .endd
18872 does result in two different pipe deliveries, because the immediate parents of
18873 the pipes are distinct.
18874
18875
18876
18877 .section "Repeated redirection expansion" "SECID128"
18878 .cindex "repeated redirection expansion"
18879 .cindex "address redirection" "repeated for each delivery attempt"
18880 When a message cannot be delivered to all of its recipients immediately,
18881 leading to two or more delivery attempts, redirection expansion is carried out
18882 afresh each time for those addresses whose children were not all previously
18883 delivered. If redirection is being used as a mailing list, this can lead to new
18884 members of the list receiving copies of old messages. The &%one_time%& option
18885 can be used to avoid this.
18886
18887
18888 .section "Errors in redirection lists" "SECID129"
18889 .cindex "address redirection" "errors"
18890 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18891 error is skipped, and an entry is written to the main log. This may be useful
18892 for mailing lists that are automatically managed. Otherwise, if an error is
18893 detected while generating the list of new addresses, the original address is
18894 deferred. See also &%syntax_errors_to%&.
18895
18896
18897
18898 .section "Private options for the redirect router" "SECID130"
18899
18900 .cindex "options" "&(redirect)& router"
18901 The private options for the &(redirect)& router are as follows:
18902
18903
18904 .option allow_defer redirect boolean false
18905 Setting this option allows the use of &':defer:'& in non-filter redirection
18906 data, or the &%defer%& command in an Exim filter file.
18907
18908
18909 .option allow_fail redirect boolean false
18910 .cindex "failing delivery" "from filter"
18911 If this option is true, the &':fail:'& item can be used in a redirection list,
18912 and the &%fail%& command may be used in an Exim filter file.
18913
18914
18915 .option allow_filter redirect boolean false
18916 .cindex "filter" "enabling use of"
18917 .cindex "Sieve filter" "enabling use of"
18918 Setting this option allows Exim to interpret redirection data that starts with
18919 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18920 are some features of Exim filter files that some administrators may wish to
18921 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18922
18923 It is also possible to lock out Exim filters or Sieve filters while allowing
18924 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18925
18926
18927 The filter is run using the uid and gid set by the generic &%user%& and
18928 &%group%& options. These take their defaults from the password data if
18929 &%check_local_user%& is set, so in the normal case of users' personal filter
18930 files, the filter is run as the relevant user. When &%allow_filter%& is set
18931 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18932
18933
18934
18935 .option allow_freeze redirect boolean false
18936 .cindex "freezing messages" "allowing in filter"
18937 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18938 This command is more normally encountered in system filters, and is disabled by
18939 default for redirection filters because it isn't something you usually want to
18940 let ordinary users do.
18941
18942
18943
18944 .option check_ancestor redirect boolean false
18945 This option is concerned with handling generated addresses that are the same
18946 as some address in the list of redirection ancestors of the current address.
18947 Although it is turned off by default in the code, it is set in the default
18948 configuration file for handling users' &_.forward_& files. It is recommended
18949 for this use of the &(redirect)& router.
18950
18951 When &%check_ancestor%& is set, if a generated address (including the domain)
18952 is the same as any ancestor of the current address, it is replaced by a copy of
18953 the current address. This helps in the case where local part A is aliased to B,
18954 and B has a &_.forward_& file pointing back to A. For example, within a single
18955 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18956 &_&~jb/.forward_& contains:
18957 .code
18958 \Joe.Bloggs, <other item(s)>
18959 .endd
18960 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18961 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18962 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18963 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18964 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18965 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18966 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18967 original address. See also the &%repeat_use%& option below.
18968
18969
18970 .option check_group redirect boolean "see below"
18971 When the &%file%& option is used, the group owner of the file is checked only
18972 when this option is set. The permitted groups are those listed in the
18973 &%owngroups%& option, together with the user's default group if
18974 &%check_local_user%& is set. If the file has the wrong group, routing is
18975 deferred. The default setting for this option is true if &%check_local_user%&
18976 is set and the &%modemask%& option permits the group write bit, or if the
18977 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18978
18979
18980
18981 .option check_owner redirect boolean "see below"
18982 When the &%file%& option is used, the owner of the file is checked only when
18983 this option is set. If &%check_local_user%& is set, the local user is
18984 permitted; otherwise the owner must be one of those listed in the &%owners%&
18985 option. The default value for this option is true if &%check_local_user%& or
18986 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18987
18988
18989 .option data redirect string&!! unset
18990 This option is mutually exclusive with &%file%&. One or other of them must be
18991 set, but not both. The contents of &%data%& are expanded, and then used as the
18992 list of forwarding items, or as a set of filtering instructions. If the
18993 expansion is forced to fail, or the result is an empty string or a string that
18994 has no effect (consists entirely of comments), the router declines.
18995
18996 When filtering instructions are used, the string must begin with &"#Exim
18997 filter"&, and all comments in the string, including this initial one, must be
18998 terminated with newline characters. For example:
18999 .code
19000 data = #Exim filter\n\
19001        if $h_to: contains Exim then save $home/mail/exim endif
19002 .endd
19003 If you are reading the data from a database where newlines cannot be included,
19004 you can use the &${sg}$& expansion item to turn the escape string of your
19005 choice into a newline.
19006
19007
19008 .option directory_transport redirect string&!! unset
19009 A &(redirect)& router sets up a direct delivery to a directory when a path name
19010 ending with a slash is specified as a new &"address"&. The transport used is
19011 specified by this option, which, after expansion, must be the name of a
19012 configured transport. This should normally be an &(appendfile)& transport.
19013
19014
19015 .option file redirect string&!! unset
19016 This option specifies the name of a file that contains the redirection data. It
19017 is mutually exclusive with the &%data%& option. The string is expanded before
19018 use; if the expansion is forced to fail, the router declines. Other expansion
19019 failures cause delivery to be deferred. The result of a successful expansion
19020 must be an absolute path. The entire file is read and used as the redirection
19021 data. If the data is an empty string or a string that has no effect (consists
19022 entirely of comments), the router declines.
19023
19024 .cindex "NFS" "checking for file existence"
19025 If the attempt to open the file fails with a &"does not exist"& error, Exim
19026 runs a check on the containing directory,
19027 unless &%ignore_enotdir%& is true (see below).
19028 If the directory does not appear to exist, delivery is deferred. This can
19029 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19030 is a mount problem. If the containing directory does exist, but the file does
19031 not, the router declines.
19032
19033
19034 .option file_transport redirect string&!! unset
19035 .vindex "&$address_file$&"
19036 A &(redirect)& router sets up a direct delivery to a file when a path name not
19037 ending in a slash is specified as a new &"address"&. The transport used is
19038 specified by this option, which, after expansion, must be the name of a
19039 configured transport. This should normally be an &(appendfile)& transport. When
19040 it is running, the file name is in &$address_file$&.
19041
19042
19043 .option filter_prepend_home redirect boolean true
19044 When this option is true, if a &(save)& command in an Exim filter specifies a
19045 relative path, and &$home$& is defined, it is automatically prepended to the
19046 relative path. If this option is set false, this action does not happen. The
19047 relative path is then passed to the transport unmodified.
19048
19049
19050 .option forbid_blackhole redirect boolean false
19051 If this option is true, the &':blackhole:'& item may not appear in a
19052 redirection list.
19053
19054
19055 .option forbid_exim_filter redirect boolean false
19056 If this option is set true, only Sieve filters are permitted when
19057 &%allow_filter%& is true.
19058
19059
19060
19061
19062 .option forbid_file redirect boolean false
19063 .cindex "delivery" "to file; forbidding"
19064 .cindex "Sieve filter" "forbidding delivery to a file"
19065 .cindex "Sieve filter" "&""keep""& facility; disabling"
19066 If this option is true, this router may not generate a new address that
19067 specifies delivery to a local file or directory, either from a filter or from a
19068 conventional forward file. This option is forced to be true if &%one_time%& is
19069 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19070 locks out the Sieve's &"keep"& facility.
19071
19072
19073 .option forbid_filter_dlfunc redirect boolean false
19074 .cindex "filter" "locking out certain features"
19075 If this option is true, string expansions in Exim filters are not allowed to
19076 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19077 functions.
19078
19079 .option forbid_filter_existstest redirect boolean false
19080 .cindex "expansion" "statting a file"
19081 If this option is true, string expansions in Exim filters are not allowed to
19082 make use of the &%exists%& condition or the &%stat%& expansion item.
19083
19084 .option forbid_filter_logwrite redirect boolean false
19085 If this option is true, use of the logging facility in Exim filters is not
19086 permitted. Logging is in any case available only if the filter is being run
19087 under some unprivileged uid (which is normally the case for ordinary users'
19088 &_.forward_& files).
19089
19090
19091 .option forbid_filter_lookup redirect boolean false
19092 If this option is true, string expansions in Exim filter files are not allowed
19093 to make use of &%lookup%& items.
19094
19095
19096 .option forbid_filter_perl redirect boolean false
19097 This option has an effect only if Exim is built with embedded Perl support. If
19098 it is true, string expansions in Exim filter files are not allowed to make use
19099 of the embedded Perl support.
19100
19101
19102 .option forbid_filter_readfile redirect boolean false
19103 If this option is true, string expansions in Exim filter files are not allowed
19104 to make use of &%readfile%& items.
19105
19106
19107 .option forbid_filter_readsocket redirect boolean false
19108 If this option is true, string expansions in Exim filter files are not allowed
19109 to make use of &%readsocket%& items.
19110
19111
19112 .option forbid_filter_reply redirect boolean false
19113 If this option is true, this router may not generate an automatic reply
19114 message. Automatic replies can be generated only from Exim or Sieve filter
19115 files, not from traditional forward files. This option is forced to be true if
19116 &%one_time%& is set.
19117
19118
19119 .option forbid_filter_run redirect boolean false
19120 If this option is true, string expansions in Exim filter files are not allowed
19121 to make use of &%run%& items.
19122
19123
19124 .option forbid_include redirect boolean false
19125 If this option is true, items of the form
19126 .code
19127 :include:<path name>
19128 .endd
19129 are not permitted in non-filter redirection lists.
19130
19131
19132 .option forbid_pipe redirect boolean false
19133 .cindex "delivery" "to pipe; forbidding"
19134 If this option is true, this router may not generate a new address which
19135 specifies delivery to a pipe, either from an Exim filter or from a conventional
19136 forward file. This option is forced to be true if &%one_time%& is set.
19137
19138
19139 .option forbid_sieve_filter redirect boolean false
19140 If this option is set true, only Exim filters are permitted when
19141 &%allow_filter%& is true.
19142
19143
19144 .cindex "SMTP" "error codes"
19145 .option forbid_smtp_code redirect boolean false
19146 If this option is set true, any SMTP error codes that are present at the start
19147 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19148 the default codes (451 and 550, respectively) are always used.
19149
19150
19151
19152
19153 .option hide_child_in_errmsg redirect boolean false
19154 .cindex "bounce message" "redirection details; suppressing"
19155 If this option is true, it prevents Exim from quoting a child address if it
19156 generates a bounce or delay message for it. Instead it says &"an address
19157 generated from <&'the top level address'&>"&. Of course, this applies only to
19158 bounces generated locally. If a message is forwarded to another host, &'its'&
19159 bounce may well quote the generated address.
19160
19161
19162 .option ignore_eacces redirect boolean false
19163 .cindex "EACCES"
19164 If this option is set and an attempt to open a redirection file yields the
19165 EACCES error (permission denied), the &(redirect)& router behaves as if the
19166 file did not exist.
19167
19168
19169 .option ignore_enotdir redirect boolean false
19170 .cindex "ENOTDIR"
19171 If this option is set and an attempt to open a redirection file yields the
19172 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19173 router behaves as if the file did not exist.
19174
19175 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19176 router that has the &%file%& option set discovers that the file does not exist
19177 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19178 against unmounted NFS directories. If the parent can not be statted, delivery
19179 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19180 is set, because that option tells Exim to ignore &"something on the path is not
19181 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19182 that some operating systems give ENOENT where others give ENOTDIR.
19183
19184
19185
19186 .option include_directory redirect string unset
19187 If this option is set, the path names of any &':include:'& items in a
19188 redirection list must start with this directory.
19189
19190
19191 .option modemask redirect "octal integer" 022
19192 This specifies mode bits which must not be set for a file specified by the
19193 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19194
19195
19196 .option one_time redirect boolean false
19197 .cindex "one-time aliasing/forwarding expansion"
19198 .cindex "alias file" "one-time expansion"
19199 .cindex "forward file" "one-time expansion"
19200 .cindex "mailing lists" "one-time expansion"
19201 .cindex "address redirection" "one-time expansion"
19202 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19203 files each time it tries to deliver a message causes a problem when one or more
19204 of the generated addresses fails be delivered at the first attempt. The problem
19205 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19206 but of what happens when the redirection list changes during the time that the
19207 message is on Exim's queue. This is particularly true in the case of mailing
19208 lists, where new subscribers might receive copies of messages that were posted
19209 before they subscribed.
19210
19211 If &%one_time%& is set and any addresses generated by the router fail to
19212 deliver at the first attempt, the failing addresses are added to the message as
19213 &"top level"& addresses, and the parent address that generated them is marked
19214 &"delivered"&. Thus, redirection does not happen again at the next delivery
19215 attempt.
19216
19217 &*Warning 1*&: Any header line addition or removal that is specified by this
19218 router would be lost if delivery did not succeed at the first attempt. For this
19219 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19220 permitted when &%one_time%& is set.
19221
19222 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19223 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19224 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19225
19226 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19227 &%one_time%&.
19228
19229 The original top-level address is remembered with each of the generated
19230 addresses, and is output in any log messages. However, any intermediate parent
19231 addresses are not recorded. This makes a difference to the log only if
19232 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19233 typically be used for mailing lists, where there is normally just one level of
19234 expansion.
19235
19236
19237 .option owners redirect "string list" unset
19238 .cindex "ownership" "alias file"
19239 .cindex "ownership" "forward file"
19240 .cindex "alias file" "ownership"
19241 .cindex "forward file" "ownership"
19242 This specifies a list of permitted owners for the file specified by &%file%&.
19243 This list is in addition to the local user when &%check_local_user%& is set.
19244 See &%check_owner%& above.
19245
19246
19247 .option owngroups redirect "string list" unset
19248 This specifies a list of permitted groups for the file specified by &%file%&.
19249 The list is in addition to the local user's primary group when
19250 &%check_local_user%& is set. See &%check_group%& above.
19251
19252
19253 .option pipe_transport redirect string&!! unset
19254 .vindex "&$address_pipe$&"
19255 A &(redirect)& router sets up a direct delivery to a pipe when a string
19256 starting with a vertical bar character is specified as a new &"address"&. The
19257 transport used is specified by this option, which, after expansion, must be the
19258 name of a configured transport. This should normally be a &(pipe)& transport.
19259 When the transport is run, the pipe command is in &$address_pipe$&.
19260
19261
19262 .option qualify_domain redirect string&!! unset
19263 .vindex "&$qualify_recipient$&"
19264 If this option is set, and an unqualified address (one without a domain) is
19265 generated, and that address would normally be qualified by the global setting
19266 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19267 expanding this string. If the expansion fails, the router declines. If you want
19268 to revert to the default, you can have the expansion generate
19269 &$qualify_recipient$&.
19270
19271 This option applies to all unqualified addresses generated by Exim filters,
19272 but for traditional &_.forward_& files, it applies only to addresses that are
19273 not preceded by a backslash. Sieve filters cannot generate unqualified
19274 addresses.
19275
19276 .option qualify_preserve_domain redirect boolean false
19277 .cindex "domain" "in redirection; preserving"
19278 .cindex "preserving domain in redirection"
19279 .cindex "address redirection" "domain; preserving"
19280 If this option is set, the router's local &%qualify_domain%& option must not be
19281 set (a configuration error occurs if it is). If an unqualified address (one
19282 without a domain) is generated, it is qualified with the domain of the parent
19283 address (the immediately preceding ancestor) instead of the global
19284 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19285 this applies whether or not the address is preceded by a backslash.
19286
19287
19288 .option repeat_use redirect boolean true
19289 If this option is set false, the router is skipped for a child address that has
19290 any ancestor that was routed by this router. This test happens before any of
19291 the other preconditions are tested. Exim's default anti-looping rules skip
19292 only when the ancestor is the same as the current address. See also
19293 &%check_ancestor%& above and the generic &%redirect_router%& option.
19294
19295
19296 .option reply_transport redirect string&!! unset
19297 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19298 &%vacation%& command is used in a filter file. The transport used is specified
19299 by this option, which, after expansion, must be the name of a configured
19300 transport. This should normally be an &(autoreply)& transport. Other transports
19301 are unlikely to do anything sensible or useful.
19302
19303
19304 .option rewrite redirect boolean true
19305 .cindex "address redirection" "disabling rewriting"
19306 If this option is set false, addresses generated by the router are not
19307 subject to address rewriting. Otherwise, they are treated like new addresses
19308 and are rewritten according to the global rewriting rules.
19309
19310
19311 .option sieve_subaddress redirect string&!! unset
19312 The value of this option is passed to a Sieve filter to specify the
19313 :subaddress part of an address.
19314
19315 .option sieve_useraddress redirect string&!! unset
19316 The value of this option is passed to a Sieve filter to specify the :user part
19317 of an address. However, if it is unset, the entire original local part
19318 (including any prefix or suffix) is used for :user.
19319
19320
19321 .option sieve_vacation_directory redirect string&!! unset
19322 .cindex "Sieve filter" "vacation directory"
19323 To enable the &"vacation"& extension for Sieve filters, you must set
19324 &%sieve_vacation_directory%& to the directory where vacation databases are held
19325 (do not put anything else in that directory), and ensure that the
19326 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19327 needs their own directory; Exim will create it if necessary.
19328
19329
19330
19331 .option skip_syntax_errors redirect boolean false
19332 .cindex "forward file" "broken"
19333 .cindex "address redirection" "broken files"
19334 .cindex "alias file" "broken"
19335 .cindex "broken alias or forward files"
19336 .cindex "ignoring faulty addresses"
19337 .cindex "skipping faulty addresses"
19338 .cindex "error" "skipping bad syntax"
19339 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19340 non-filter redirection data are skipped, and each failing address is logged. If
19341 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19342 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19343 are expanded and placed at the head of the error message generated by
19344 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19345 be the same address as the generic &%errors_to%& option. The
19346 &%skip_syntax_errors%& option is often used when handling mailing lists.
19347
19348 If all the addresses in a redirection list are skipped because of syntax
19349 errors, the router declines to handle the original address, and it is passed to
19350 the following routers.
19351
19352 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19353 error in the filter causes filtering to be abandoned without any action being
19354 taken. The incident is logged, and the router declines to handle the address,
19355 so it is passed to the following routers.
19356
19357 .cindex "Sieve filter" "syntax errors in"
19358 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19359 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19360 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19361
19362 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19363 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19364 option, used with an address that does not get redirected, can be used to
19365 notify users of these errors, by means of a router like this:
19366 .code
19367 userforward:
19368   driver = redirect
19369   allow_filter
19370   check_local_user
19371   file = $home/.forward
19372   file_transport = address_file
19373   pipe_transport = address_pipe
19374   reply_transport = address_reply
19375   no_verify
19376   skip_syntax_errors
19377   syntax_errors_to = real-$local_part@$domain
19378   syntax_errors_text = \
19379    This is an automatically generated message. An error has\n\
19380    been found in your .forward file. Details of the error are\n\
19381    reported below. While this error persists, you will receive\n\
19382    a copy of this message for every message that is addressed\n\
19383    to you. If your .forward file is a filter file, or if it is\n\
19384    a non-filter file containing no valid forwarding addresses,\n\
19385    a copy of each incoming message will be put in your normal\n\
19386    mailbox. If a non-filter file contains at least one valid\n\
19387    forwarding address, forwarding to the valid addresses will\n\
19388    happen, and those will be the only deliveries that occur.
19389 .endd
19390 You also need a router to ensure that local addresses that are prefixed by
19391 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19392 put this immediately before the &(userforward)& router:
19393 .code
19394 real_localuser:
19395   driver = accept
19396   check_local_user
19397   local_part_prefix = real-
19398   transport = local_delivery
19399 .endd
19400 For security, it would probably be a good idea to restrict the use of this
19401 router to locally-generated messages, using a condition such as this:
19402 .code
19403   condition = ${if match {$sender_host_address}\
19404                          {\N^(|127\.0\.0\.1)$\N}}
19405 .endd
19406
19407
19408 .option syntax_errors_text redirect string&!! unset
19409 See &%skip_syntax_errors%& above.
19410
19411
19412 .option syntax_errors_to redirect string unset
19413 See &%skip_syntax_errors%& above.
19414 .ecindex IIDredrou1
19415 .ecindex IIDredrou2
19416
19417
19418
19419
19420
19421
19422 . ////////////////////////////////////////////////////////////////////////////
19423 . ////////////////////////////////////////////////////////////////////////////
19424
19425 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19426          "Environment for local transports"
19427 .scindex IIDenvlotra1 "local transports" "environment for"
19428 .scindex IIDenvlotra2 "environment for local transports"
19429 .scindex IIDenvlotra3 "transport" "local; environment for"
19430 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19431 transport can be thought of as similar to a pipe.) Exim always runs transports
19432 in subprocesses, under specified uids and gids. Typical deliveries to local
19433 mailboxes run under the uid and gid of the local user.
19434
19435 Exim also sets a specific current directory while running the transport; for
19436 some transports a home directory setting is also relevant. The &(pipe)&
19437 transport is the only one that sets up environment variables; see section
19438 &<<SECTpipeenv>>& for details.
19439
19440 The values used for the uid, gid, and the directories may come from several
19441 different places. In many cases, the router that handles the address associates
19442 settings with that address as a result of its &%check_local_user%&, &%group%&,
19443 or &%user%& options. However, values may also be given in the transport's own
19444 configuration, and these override anything that comes from the router.
19445
19446
19447
19448 .section "Concurrent deliveries" "SECID131"
19449 .cindex "concurrent deliveries"
19450 .cindex "simultaneous deliveries"
19451 If two different messages for the same local recipient arrive more or less
19452 simultaneously, the two delivery processes are likely to run concurrently. When
19453 the &(appendfile)& transport is used to write to a file, Exim applies locking
19454 rules to stop concurrent processes from writing to the same file at the same
19455 time.
19456
19457 However, when you use a &(pipe)& transport, it is up to you to arrange any
19458 locking that is needed. Here is a silly example:
19459 .code
19460 my_transport:
19461   driver = pipe
19462   command = /bin/sh -c 'cat >>/some/file'
19463 .endd
19464 This is supposed to write the message at the end of the file. However, if two
19465 messages arrive at the same time, the file will be scrambled. You can use the
19466 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19467 file using the same algorithm that Exim itself uses.
19468
19469
19470
19471
19472 .section "Uids and gids" "SECTenvuidgid"
19473 .cindex "local transports" "uid and gid"
19474 .cindex "transport" "local; uid and gid"
19475 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19476 overrides any group that the router set in the address, even if &%user%& is not
19477 set for the transport. This makes it possible, for example, to run local mail
19478 delivery under the uid of the recipient (set by the router), but in a special
19479 group (set by the transport). For example:
19480 .code
19481 # Routers ...
19482 # User/group are set by check_local_user in this router
19483 local_users:
19484   driver = accept
19485   check_local_user
19486   transport = group_delivery
19487
19488 # Transports ...
19489 # This transport overrides the group
19490 group_delivery:
19491   driver = appendfile
19492   file = /var/spool/mail/$local_part
19493   group = mail
19494 .endd
19495 If &%user%& is set for a transport, its value overrides what is set in the
19496 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19497 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19498 set.
19499
19500 .oindex "&%initgroups%&"
19501 When the uid is taken from the transport's configuration, the &[initgroups()]&
19502 function is called for the groups associated with that uid if the
19503 &%initgroups%& option is set for the transport. When the uid is not specified
19504 by the transport, but is associated with the address by a router, the option
19505 for calling &[initgroups()]& is taken from the router configuration.
19506
19507 .cindex "&(pipe)& transport" "uid for"
19508 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19509 is set and &%user%& is not set, the uid of the process that called Exim to
19510 receive the message is used, and if &%group%& is not set, the corresponding
19511 original gid is also used.
19512
19513 This is the detailed preference order for obtaining a gid; the first of the
19514 following that is set is used:
19515
19516 .ilist
19517 A &%group%& setting of the transport;
19518 .next
19519 A &%group%& setting of the router;
19520 .next
19521 A gid associated with a user setting of the router, either as a result of
19522 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19523 .next
19524 The group associated with a non-numeric &%user%& setting of the transport;
19525 .next
19526 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19527 the uid is the creator's uid;
19528 .next
19529 The Exim gid if the Exim uid is being used as a default.
19530 .endlist
19531
19532 If, for example, the user is specified numerically on the router and there are
19533 no group settings, no gid is available. In this situation, an error occurs.
19534 This is different for the uid, for which there always is an ultimate default.
19535 The first of the following that is set is used:
19536
19537 .ilist
19538 A &%user%& setting of the transport;
19539 .next
19540 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19541 .next
19542 A &%user%& setting of the router;
19543 .next
19544 A &%check_local_user%& setting of the router;
19545 .next
19546 The Exim uid.
19547 .endlist
19548
19549 Of course, an error will still occur if the uid that is chosen is on the
19550 &%never_users%& list.
19551
19552
19553
19554
19555
19556 .section "Current and home directories" "SECID132"
19557 .cindex "current directory for local transport"
19558 .cindex "home directory" "for local transport"
19559 .cindex "transport" "local; home directory for"
19560 .cindex "transport" "local; current directory for"
19561 Routers may set current and home directories for local transports by means of
19562 the &%transport_current_directory%& and &%transport_home_directory%& options.
19563 However, if the transport's &%current_directory%& or &%home_directory%& options
19564 are set, they override the router's values. In detail, the home directory
19565 for a local transport is taken from the first of these values that is set:
19566
19567 .ilist
19568 The &%home_directory%& option on the transport;
19569 .next
19570 The &%transport_home_directory%& option on the router;
19571 .next
19572 The password data if &%check_local_user%& is set on the router;
19573 .next
19574 The &%router_home_directory%& option on the router.
19575 .endlist
19576
19577 The current directory is taken from the first of these values that is set:
19578
19579 .ilist
19580 The &%current_directory%& option on the transport;
19581 .next
19582 The &%transport_current_directory%& option on the router.
19583 .endlist
19584
19585
19586 If neither the router nor the transport sets a current directory, Exim uses the
19587 value of the home directory, if it is set. Otherwise it sets the current
19588 directory to &_/_& before running a local transport.
19589
19590
19591
19592 .section "Expansion variables derived from the address" "SECID133"
19593 .vindex "&$domain$&"
19594 .vindex "&$local_part$&"
19595 .vindex "&$original_domain$&"
19596 Normally a local delivery is handling a single address, and in that case the
19597 variables such as &$domain$& and &$local_part$& are set during local
19598 deliveries. However, in some circumstances more than one address may be handled
19599 at once (for example, while writing batch SMTP for onward transmission by some
19600 other means). In this case, the variables associated with the local part are
19601 never set, &$domain$& is set only if all the addresses have the same domain,
19602 and &$original_domain$& is never set.
19603 .ecindex IIDenvlotra1
19604 .ecindex IIDenvlotra2
19605 .ecindex IIDenvlotra3
19606
19607
19608
19609
19610
19611
19612
19613 . ////////////////////////////////////////////////////////////////////////////
19614 . ////////////////////////////////////////////////////////////////////////////
19615
19616 .chapter "Generic options for transports" "CHAPtransportgeneric"
19617 .scindex IIDgenoptra1 "generic options" "transport"
19618 .scindex IIDgenoptra2 "options" "generic; for transports"
19619 .scindex IIDgenoptra3 "transport" "generic options for"
19620 The following generic options apply to all transports:
19621
19622
19623 .option body_only transports boolean false
19624 .cindex "transport" "body only"
19625 .cindex "message" "transporting body only"
19626 .cindex "body of message" "transporting"
19627 If this option is set, the message's headers are not transported. It is
19628 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19629 or &(pipe)& transports, the settings of &%message_prefix%& and
19630 &%message_suffix%& should be checked, because this option does not
19631 automatically suppress them.
19632
19633
19634 .option current_directory transports string&!! unset
19635 .cindex "transport" "current directory for"
19636 This specifies the current directory that is to be set while running the
19637 transport, overriding any value that may have been set by the router.
19638 If the expansion fails for any reason, including forced failure, an error is
19639 logged, and delivery is deferred.
19640
19641
19642 .option disable_logging transports boolean false
19643 If this option is set true, nothing is logged for any
19644 deliveries by the transport or for any
19645 transport errors. You should not set this option unless you really, really know
19646 what you are doing.
19647
19648
19649 .option debug_print transports string&!! unset
19650 .cindex "testing" "variables in drivers"
19651 If this option is set and debugging is enabled (see the &%-d%& command line
19652 option), the string is expanded and included in the debugging output when the
19653 transport is run.
19654 If expansion of the string fails, the error message is written to the debugging
19655 output, and Exim carries on processing.
19656 This facility is provided to help with checking out the values of variables and
19657 so on when debugging driver configurations. For example, if a &%headers_add%&
19658 option is not working properly, &%debug_print%& could be used to output the
19659 variables it references. A newline is added to the text if it does not end with
19660 one.
19661 The variables &$transport_name$& and &$router_name$& contain the name of the
19662 transport and the router that called it.
19663
19664
19665 .option delivery_date_add transports boolean false
19666 .cindex "&'Delivery-date:'& header line"
19667 If this option is true, a &'Delivery-date:'& header is added to the message.
19668 This gives the actual time the delivery was made. As this is not a standard
19669 header, Exim has a configuration option (&%delivery_date_remove%&) which
19670 requests its removal from incoming messages, so that delivered messages can
19671 safely be resent to other recipients.
19672
19673
19674 .option driver transports string unset
19675 This specifies which of the available transport drivers is to be used.
19676 There is no default, and this option must be set for every transport.
19677
19678
19679 .option envelope_to_add transports boolean false
19680 .cindex "&'Envelope-to:'& header line"
19681 If this option is true, an &'Envelope-to:'& header is added to the message.
19682 This gives the original address(es) in the incoming envelope that caused this
19683 delivery to happen. More than one address may be present if the transport is
19684 configured to handle several addresses at once, or if more than one original
19685 address was redirected to the same final address. As this is not a standard
19686 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19687 its removal from incoming messages, so that delivered messages can safely be
19688 resent to other recipients.
19689
19690
19691 .option group transports string&!! "Exim group"
19692 .cindex "transport" "group; specifying"
19693 This option specifies a gid for running the transport process, overriding any
19694 value that the router supplies, and also overriding any value associated with
19695 &%user%& (see below).
19696
19697
19698 .option headers_add transports string&!! unset
19699 .cindex "header lines" "adding in transport"
19700 .cindex "transport" "header lines; adding"
19701 This option specifies a string of text that is expanded and added to the header
19702 portion of a message as it is transported, as described in section
19703 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19704 routers. If the result of the expansion is an empty string, or if the expansion
19705 is forced to fail, no action is taken. Other expansion failures are treated as
19706 errors and cause the delivery to be deferred.
19707
19708 Unlike most options, &%headers_add%& can be specified multiple times
19709 for a transport; all listed headers are added.
19710
19711
19712
19713 .option headers_only transports boolean false
19714 .cindex "transport" "header lines only"
19715 .cindex "message" "transporting headers only"
19716 .cindex "header lines" "transporting"
19717 If this option is set, the message's body is not transported. It is mutually
19718 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19719 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19720 checked, since this option does not automatically suppress them.
19721
19722
19723 .option headers_remove transports string&!! unset
19724 .cindex "header lines" "removing"
19725 .cindex "transport" "header lines; removing"
19726 This option specifies a string that is expanded into a list of header names;
19727 these headers are omitted from the message as it is transported, as described
19728 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19729 routers. If the result of the expansion is an empty string, or if the expansion
19730 is forced to fail, no action is taken. Other expansion failures are treated as
19731 errors and cause the delivery to be deferred.
19732
19733 Unlike most options, &%headers_remove%& can be specified multiple times
19734 for a router; all listed headers are added.
19735
19736
19737
19738 .option headers_rewrite transports string unset
19739 .cindex "transport" "header lines; rewriting"
19740 .cindex "rewriting" "at transport time"
19741 This option allows addresses in header lines to be rewritten at transport time,
19742 that is, as the message is being copied to its destination. The contents of the
19743 option are a colon-separated list of rewriting rules. Each rule is in exactly
19744 the same form as one of the general rewriting rules that are applied when a
19745 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19746 example,
19747 .code
19748 headers_rewrite = a@b c@d f : \
19749                   x@y w@z
19750 .endd
19751 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19752 &'w@z'& in all address-bearing header lines. The rules are applied to the
19753 header lines just before they are written out at transport time, so they affect
19754 only those copies of the message that pass through the transport. However, only
19755 the message's original header lines, and any that were added by a system
19756 filter, are rewritten. If a router or transport adds header lines, they are not
19757 affected by this option. These rewriting rules are &'not'& applied to the
19758 envelope. You can change the return path using &%return_path%&, but you cannot
19759 change envelope recipients at this time.
19760
19761
19762 .option home_directory transports string&!! unset
19763 .cindex "transport" "home directory for"
19764 .vindex "&$home$&"
19765 This option specifies a home directory setting for a local transport,
19766 overriding any value that may be set by the router. The home directory is
19767 placed in &$home$& while expanding the transport's private options. It is also
19768 used as the current directory if no current directory is set by the
19769 &%current_directory%& option on the transport or the
19770 &%transport_current_directory%& option on the router. If the expansion fails
19771 for any reason, including forced failure, an error is logged, and delivery is
19772 deferred.
19773
19774
19775 .option initgroups transports boolean false
19776 .cindex "additional groups"
19777 .cindex "groups" "additional"
19778 .cindex "transport" "group; additional"
19779 If this option is true and the uid for the delivery process is provided by the
19780 transport, the &[initgroups()]& function is called when running the transport
19781 to ensure that any additional groups associated with the uid are set up.
19782
19783
19784 .option message_size_limit transports string&!! 0
19785 .cindex "limit" "message size per transport"
19786 .cindex "size" "of message, limit"
19787 .cindex "transport" "message size; limiting"
19788 This option controls the size of messages passed through the transport. It is
19789 expanded before use; the result of the expansion must be a sequence of decimal
19790 digits, optionally followed by K or M. If the expansion fails for any reason,
19791 including forced failure, or if the result is not of the required form,
19792 delivery is deferred. If the value is greater than zero and the size of a
19793 message exceeds this limit, the address is failed. If there is any chance that
19794 the resulting bounce message could be routed to the same transport, you should
19795 ensure that &%return_size_limit%& is less than the transport's
19796 &%message_size_limit%&, as otherwise the bounce message will fail to get
19797 delivered.
19798
19799
19800
19801 .option rcpt_include_affixes transports boolean false
19802 .cindex "prefix" "for local part, including in envelope"
19803 .cindex "suffix for local part" "including in envelope"
19804 .cindex "local part" "prefix"
19805 .cindex "local part" "suffix"
19806 When this option is false (the default), and an address that has had any
19807 affixes (prefixes or suffixes) removed from the local part is delivered by any
19808 form of SMTP or LMTP, the affixes are not included. For example, if a router
19809 that contains
19810 .code
19811 local_part_prefix = *-
19812 .endd
19813 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19814 is delivered with
19815 .code
19816 RCPT TO:<xyz@some.domain>
19817 .endd
19818 This is also the case when an ACL-time callout is being used to verify a
19819 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19820 whole local part is included in the RCPT command. This option applies to BSMTP
19821 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19822 &(lmtp)& and &(smtp)& transports.
19823
19824
19825 .option retry_use_local_part transports boolean "see below"
19826 .cindex "hints database" "retry keys"
19827 When a delivery suffers a temporary failure, a retry record is created
19828 in Exim's hints database. For remote deliveries, the key for the retry record
19829 is based on the name and/or IP address of the failing remote host. For local
19830 deliveries, the key is normally the entire address, including both the local
19831 part and the domain. This is suitable for most common cases of local delivery
19832 temporary failure &-- for example, exceeding a mailbox quota should delay only
19833 deliveries to that mailbox, not to the whole domain.
19834
19835 However, in some special cases you may want to treat a temporary local delivery
19836 as a failure associated with the domain, and not with a particular local part.
19837 (For example, if you are storing all mail for some domain in files.) You can do
19838 this by setting &%retry_use_local_part%& false.
19839
19840 For all the local transports, its default value is true. For remote transports,
19841 the default value is false for tidiness, but changing the value has no effect
19842 on a remote transport in the current implementation.
19843
19844
19845 .option return_path transports string&!! unset
19846 .cindex "envelope sender"
19847 .cindex "transport" "return path; changing"
19848 .cindex "return path" "changing in transport"
19849 If this option is set, the string is expanded at transport time and replaces
19850 the existing return path (envelope sender) value in the copy of the message
19851 that is being delivered. An empty return path is permitted. This feature is
19852 designed for remote deliveries, where the value of this option is used in the
19853 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19854 only effect is to change the address that is placed in the &'Return-path:'&
19855 header line, if one is added to the message (see the next option).
19856
19857 &*Note:*& A changed return path is not logged unless you add
19858 &%return_path_on_delivery%& to the log selector.
19859
19860 .vindex "&$return_path$&"
19861 The expansion can refer to the existing value via &$return_path$&. This is
19862 either the message's envelope sender, or an address set by the
19863 &%errors_to%& option on a router. If the expansion is forced to fail, no
19864 replacement occurs; if it fails for another reason, delivery is deferred. This
19865 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19866 section &<<SECTverp>>&.
19867
19868 &*Note*&: If a delivery error is detected locally, including the case when a
19869 remote server rejects a message at SMTP time, the bounce message is not sent to
19870 the value of this option. It is sent to the previously set errors address.
19871 This defaults to the incoming sender address, but can be changed by setting
19872 &%errors_to%& in a router.
19873
19874
19875
19876 .option return_path_add transports boolean false
19877 .cindex "&'Return-path:'& header line"
19878 If this option is true, a &'Return-path:'& header is added to the message.
19879 Although the return path is normally available in the prefix line of BSD
19880 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19881 have easy access to it.
19882
19883 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19884 the delivery SMTP server makes the final delivery"&. This implies that this
19885 header should not be present in incoming messages. Exim has a configuration
19886 option, &%return_path_remove%&, which requests removal of this header from
19887 incoming messages, so that delivered messages can safely be resent to other
19888 recipients.
19889
19890
19891 .option shadow_condition transports string&!! unset
19892 See &%shadow_transport%& below.
19893
19894
19895 .option shadow_transport transports string unset
19896 .cindex "shadow transport"
19897 .cindex "transport" "shadow"
19898 A local transport may set the &%shadow_transport%& option to the name of
19899 another local transport. Shadow remote transports are not supported.
19900
19901 Whenever a delivery to the main transport succeeds, and either
19902 &%shadow_condition%& is unset, or its expansion does not result in the empty
19903 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19904 passed to the shadow transport, with the same delivery address or addresses. If
19905 expansion fails, no action is taken except that non-forced expansion failures
19906 cause a log line to be written.
19907
19908 The result of the shadow transport is discarded and does not affect the
19909 subsequent processing of the message. Only a single level of shadowing is
19910 provided; the &%shadow_transport%& option is ignored on any transport when it
19911 is running as a shadow. Options concerned with output from pipes are also
19912 ignored. The log line for the successful delivery has an item added on the end,
19913 of the form
19914 .code
19915 ST=<shadow transport name>
19916 .endd
19917 If the shadow transport did not succeed, the error message is put in
19918 parentheses afterwards. Shadow transports can be used for a number of different
19919 purposes, including keeping more detailed log information than Exim normally
19920 provides, and implementing automatic acknowledgment policies based on message
19921 headers that some sites insist on.
19922
19923
19924 .option transport_filter transports string&!! unset
19925 .cindex "transport" "filter"
19926 .cindex "filter" "transport filter"
19927 This option sets up a filtering (in the Unix shell sense) process for messages
19928 at transport time. It should not be confused with mail filtering as set up by
19929 individual users or via a system filter.
19930
19931 When the message is about to be written out, the command specified by
19932 &%transport_filter%& is started up in a separate, parallel process, and
19933 the entire message, including the header lines, is passed to it on its standard
19934 input (this in fact is done from a third process, to avoid deadlock). The
19935 command must be specified as an absolute path.
19936
19937 The lines of the message that are written to the transport filter are
19938 terminated by newline (&"\n"&). The message is passed to the filter before any
19939 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19940 lines beginning with a dot, and also before any processing implied by the
19941 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19942 &(pipe)& transports.
19943
19944 The standard error for the filter process is set to the same destination as its
19945 standard output; this is read and written to the message's ultimate
19946 destination. The process that writes the message to the filter, the
19947 filter itself, and the original process that reads the result and delivers it
19948 are all run in parallel, like a shell pipeline.
19949
19950 The filter can perform any transformations it likes, but of course should take
19951 care not to break RFC 2822 syntax. Exim does not check the result, except to
19952 test for a final newline when SMTP is in use. All messages transmitted over
19953 SMTP must end with a newline, so Exim supplies one if it is missing.
19954
19955 .cindex "content scanning" "per user"
19956 A transport filter can be used to provide content-scanning on a per-user basis
19957 at delivery time if the only required effect of the scan is to modify the
19958 message. For example, a content scan could insert a new header line containing
19959 a spam score. This could be interpreted by a filter in the user's MUA. It is
19960 not possible to discard a message at this stage.
19961
19962 .cindex "SMTP" "SIZE"
19963 A problem might arise if the filter increases the size of a message that is
19964 being sent down an SMTP connection. If the receiving SMTP server has indicated
19965 support for the SIZE parameter, Exim will have sent the size of the message
19966 at the start of the SMTP session. If what is actually sent is substantially
19967 more, the server might reject the message. This can be worked round by setting
19968 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19969 additions to the message, or to disable the use of SIZE altogether.
19970
19971 .vindex "&$pipe_addresses$&"
19972 The value of the &%transport_filter%& option is the command string for starting
19973 the filter, which is run directly from Exim, not under a shell. The string is
19974 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19975 Exim breaks it up into arguments and then expands each argument separately (see
19976 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19977 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19978 of arguments, one for each address that applies to this delivery. (This isn't
19979 an ideal name for this feature here, but as it was already implemented for the
19980 &(pipe)& transport, it seemed sensible not to change it.)
19981
19982 .vindex "&$host$&"
19983 .vindex "&$host_address$&"
19984 The expansion variables &$host$& and &$host_address$& are available when the
19985 transport is a remote one. They contain the name and IP address of the host to
19986 which the message is being sent. For example:
19987 .code
19988 transport_filter = /some/directory/transport-filter.pl \
19989   $host $host_address $sender_address $pipe_addresses
19990 .endd
19991
19992 Two problems arise if you want to use more complicated expansion items to
19993 generate transport filter commands, both of which due to the fact that the
19994 command is split up &'before'& expansion.
19995 .ilist
19996 If an expansion item contains white space, you must quote it, so that it is all
19997 part of the same command item. If the entire option setting is one such
19998 expansion item, you have to take care what kind of quoting you use. For
19999 example:
20000 .code
20001 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20002 .endd
20003 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20004 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20005 stripped by Exim when it read the option's value. When the value is used, if
20006 the single quotes were missing, the line would be split into two items,
20007 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20008 Exim tried to expand the first one.
20009 .next
20010 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20011 expansion cannot generate multiple arguments, or a command name followed by
20012 arguments. Consider this example:
20013 .code
20014 transport_filter = ${lookup{$host}lsearch{/a/file}\
20015                     {$value}{/bin/cat}}
20016 .endd
20017 The result of the lookup is interpreted as the name of the command, even
20018 if it contains white space. The simplest way round this is to use a shell:
20019 .code
20020 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20021                                {$value}{/bin/cat}}
20022 .endd
20023 .endlist
20024
20025 The filter process is run under the same uid and gid as the normal delivery.
20026 For remote deliveries this is the Exim uid/gid by default. The command should
20027 normally yield a zero return code. Transport filters are not supposed to fail.
20028 A non-zero code is taken to mean that the transport filter encountered some
20029 serious problem. Delivery of the message is deferred; the message remains on
20030 the queue and is tried again later. It is not possible to cause a message to be
20031 bounced from a transport filter.
20032
20033 If a transport filter is set on an autoreply transport, the original message is
20034 passed through the filter as it is being copied into the newly generated
20035 message, which happens if the &%return_message%& option is set.
20036
20037
20038 .option transport_filter_timeout transports time 5m
20039 .cindex "transport" "filter, timeout"
20040 When Exim is reading the output of a transport filter, it applies a timeout
20041 that can be set by this option. Exceeding the timeout is normally treated as a
20042 temporary delivery failure. However, if a transport filter is used with a
20043 &(pipe)& transport, a timeout in the transport filter is treated in the same
20044 way as a timeout in the pipe command itself. By default, a timeout is a hard
20045 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20046 becomes a temporary error.
20047
20048
20049 .option user transports string&!! "Exim user"
20050 .cindex "uid (user id)" "local delivery"
20051 .cindex "transport" "user, specifying"
20052 This option specifies the user under whose uid the delivery process is to be
20053 run, overriding any uid that may have been set by the router. If the user is
20054 given as a name, the uid is looked up from the password data, and the
20055 associated group is taken as the value of the gid to be used if the &%group%&
20056 option is not set.
20057
20058 For deliveries that use local transports, a user and group are normally
20059 specified explicitly or implicitly (for example, as a result of
20060 &%check_local_user%&) by the router or transport.
20061
20062 .cindex "hints database" "access by remote transport"
20063 For remote transports, you should leave this option unset unless you really are
20064 sure you know what you are doing. When a remote transport is running, it needs
20065 to be able to access Exim's hints databases, because each host may have its own
20066 retry data.
20067 .ecindex IIDgenoptra1
20068 .ecindex IIDgenoptra2
20069 .ecindex IIDgenoptra3
20070
20071
20072
20073
20074
20075
20076 . ////////////////////////////////////////////////////////////////////////////
20077 . ////////////////////////////////////////////////////////////////////////////
20078
20079 .chapter "Address batching in local transports" "CHAPbatching" &&&
20080          "Address batching"
20081 .cindex "transport" "local; address batching in"
20082 The only remote transport (&(smtp)&) is normally configured to handle more than
20083 one address at a time, so that when several addresses are routed to the same
20084 remote host, just one copy of the message is sent. Local transports, however,
20085 normally handle one address at a time. That is, a separate instance of the
20086 transport is run for each address that is routed to the transport. A separate
20087 copy of the message is delivered each time.
20088
20089 .cindex "batched local delivery"
20090 .oindex "&%batch_max%&"
20091 .oindex "&%batch_id%&"
20092 In special cases, it may be desirable to handle several addresses at once in a
20093 local transport, for example:
20094
20095 .ilist
20096 In an &(appendfile)& transport, when storing messages in files for later
20097 delivery by some other means, a single copy of the message with multiple
20098 recipients saves space.
20099 .next
20100 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20101 a single copy saves time, and is the normal way LMTP is expected to work.
20102 .next
20103 In a &(pipe)& transport, when passing the message
20104 to a scanner program or
20105 to some other delivery mechanism such as UUCP, multiple recipients may be
20106 acceptable.
20107 .endlist
20108
20109 These three local transports all have the same options for controlling multiple
20110 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20111 repeating the information for each transport, these options are described here.
20112
20113 The &%batch_max%& option specifies the maximum number of addresses that can be
20114 delivered together in a single run of the transport. Its default value is one
20115 (no batching). When more than one address is routed to a transport that has a
20116 &%batch_max%& value greater than one, the addresses are delivered in a batch
20117 (that is, in a single run of the transport with multiple recipients), subject
20118 to certain conditions:
20119
20120 .ilist
20121 .vindex "&$local_part$&"
20122 If any of the transport's options contain a reference to &$local_part$&, no
20123 batching is possible.
20124 .next
20125 .vindex "&$domain$&"
20126 If any of the transport's options contain a reference to &$domain$&, only
20127 addresses with the same domain are batched.
20128 .next
20129 .cindex "customizing" "batching condition"
20130 If &%batch_id%& is set, it is expanded for each address, and only those
20131 addresses with the same expanded value are batched. This allows you to specify
20132 customized batching conditions. Failure of the expansion for any reason,
20133 including forced failure, disables batching, but it does not stop the delivery
20134 from taking place.
20135 .next
20136 Batched addresses must also have the same errors address (where to send
20137 delivery errors), the same header additions and removals, the same user and
20138 group for the transport, and if a host list is present, the first host must
20139 be the same.
20140 .endlist
20141
20142 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20143 both when the file or pipe command is specified in the transport, and when it
20144 is specified by a &(redirect)& router, but all the batched addresses must of
20145 course be routed to the same file or pipe command. These two transports have an
20146 option called &%use_bsmtp%&, which causes them to deliver the message in
20147 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20148 &%check_string%& and &%escape_string%& options are forced to the values
20149 .code
20150 check_string = "."
20151 escape_string = ".."
20152 .endd
20153 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20154 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20155 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20156
20157 .cindex "&'Envelope-to:'& header line"
20158 If the generic &%envelope_to_add%& option is set for a batching transport, the
20159 &'Envelope-to:'& header that is added to the message contains all the addresses
20160 that are being processed together. If you are using a batching &(appendfile)&
20161 transport without &%use_bsmtp%&, the only way to preserve the recipient
20162 addresses is to set the &%envelope_to_add%& option.
20163
20164 .cindex "&(pipe)& transport" "with multiple addresses"
20165 .vindex "&$pipe_addresses$&"
20166 If you are using a &(pipe)& transport without BSMTP, and setting the
20167 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20168 the command. This is not a true variable; it is a bit of magic that causes each
20169 of the recipient addresses to be inserted into the command as a separate
20170 argument. This provides a way of accessing all the addresses that are being
20171 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20172 are specified by a &(redirect)& router.
20173
20174
20175
20176
20177 . ////////////////////////////////////////////////////////////////////////////
20178 . ////////////////////////////////////////////////////////////////////////////
20179
20180 .chapter "The appendfile transport" "CHAPappendfile"
20181 .scindex IIDapptra1 "&(appendfile)& transport"
20182 .scindex IIDapptra2 "transports" "&(appendfile)&"
20183 .cindex "directory creation"
20184 .cindex "creating directories"
20185 The &(appendfile)& transport delivers a message by appending it to an existing
20186 file, or by creating an entirely new file in a specified directory. Single
20187 files to which messages are appended can be in the traditional Unix mailbox
20188 format, or optionally in the MBX format supported by the Pine MUA and
20189 University of Washington IMAP daemon, &'inter alia'&. When each message is
20190 being delivered as a separate file, &"maildir"& format can optionally be used
20191 to give added protection against failures that happen part-way through the
20192 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20193 supported. For all file formats, Exim attempts to create as many levels of
20194 directory as necessary, provided that &%create_directory%& is set.
20195
20196 The code for the optional formats is not included in the Exim binary by
20197 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20198 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20199 included.
20200
20201 .cindex "quota" "system"
20202 Exim recognizes system quota errors, and generates an appropriate message. Exim
20203 also supports its own quota control within the transport, for use when the
20204 system facility is unavailable or cannot be used for some reason.
20205
20206 If there is an error while appending to a file (for example, quota exceeded or
20207 partition filled), Exim attempts to reset the file's length and last
20208 modification time back to what they were before. If there is an error while
20209 creating an entirely new file, the new file is removed.
20210
20211 Before appending to a file, a number of security checks are made, and the
20212 file is locked. A detailed description is given below, after the list of
20213 private options.
20214
20215 The &(appendfile)& transport is most commonly used for local deliveries to
20216 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20217 putting messages into files for remote delivery by some means other than Exim.
20218 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20219 option).
20220
20221
20222
20223 .section "The file and directory options" "SECTfildiropt"
20224 The &%file%& option specifies a single file, to which the message is appended;
20225 the &%directory%& option specifies a directory, in which a new file containing
20226 the message is created. Only one of these two options can be set, and for
20227 normal deliveries to mailboxes, one of them &'must'& be set.
20228
20229 .vindex "&$address_file$&"
20230 .vindex "&$local_part$&"
20231 However, &(appendfile)& is also used for delivering messages to files or
20232 directories whose names (or parts of names) are obtained from alias,
20233 forwarding, or filtering operations (for example, a &%save%& command in a
20234 user's Exim filter). When such a transport is running, &$local_part$& contains
20235 the local part that was aliased or forwarded, and &$address_file$& contains the
20236 name (or partial name) of the file or directory generated by the redirection
20237 operation. There are two cases:
20238
20239 .ilist
20240 If neither &%file%& nor &%directory%& is set, the redirection operation
20241 must specify an absolute path (one that begins with &`/`&). This is the most
20242 common case when users with local accounts use filtering to sort mail into
20243 different folders. See for example, the &(address_file)& transport in the
20244 default configuration. If the path ends with a slash, it is assumed to be the
20245 name of a directory. A delivery to a directory can also be forced by setting
20246 &%maildir_format%& or &%mailstore_format%&.
20247 .next
20248 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20249 used to determine the file or directory name for the delivery. Normally, the
20250 contents of &$address_file$& are used in some way in the string expansion.
20251 .endlist
20252
20253
20254 .cindex "Sieve filter" "configuring &(appendfile)&"
20255 .cindex "Sieve filter" "relative mailbox path handling"
20256 As an example of the second case, consider an environment where users do not
20257 have home directories. They may be permitted to use Exim filter commands of the
20258 form:
20259 .code
20260 save folder23
20261 .endd
20262 or Sieve filter commands of the form:
20263 .code
20264 require "fileinto";
20265 fileinto "folder23";
20266 .endd
20267 In this situation, the expansion of &%file%& or &%directory%& in the transport
20268 must transform the relative path into an appropriate absolute file name. In the
20269 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20270 is used as a result of a &"keep"& action in the filter. This example shows one
20271 way of handling this requirement:
20272 .code
20273 file = ${if eq{$address_file}{inbox} \
20274             {/var/mail/$local_part} \
20275             {${if eq{${substr_0_1:$address_file}}{/} \
20276                   {$address_file} \
20277                   {$home/mail/$address_file} \
20278             }} \
20279        }
20280 .endd
20281 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20282 location, absolute paths are used without change, and other folders are in the
20283 &_mail_& directory within the home directory.
20284
20285 &*Note 1*&: While processing an Exim filter, a relative path such as
20286 &_folder23_& is turned into an absolute path if a home directory is known to
20287 the router. In particular, this is the case if &%check_local_user%& is set. If
20288 you want to prevent this happening at routing time, you can set
20289 &%router_home_directory%& empty. This forces the router to pass the relative
20290 path to the transport.
20291
20292 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20293 the &%file%& or &%directory%& option is still used if it is set.
20294
20295
20296
20297
20298 .section "Private options for appendfile" "SECID134"
20299 .cindex "options" "&(appendfile)& transport"
20300
20301
20302
20303 .option allow_fifo appendfile boolean false
20304 .cindex "fifo (named pipe)"
20305 .cindex "named pipe (fifo)"
20306 .cindex "pipe" "named (fifo)"
20307 Setting this option permits delivery to named pipes (FIFOs) as well as to
20308 regular files. If no process is reading the named pipe at delivery time, the
20309 delivery is deferred.
20310
20311
20312 .option allow_symlink appendfile boolean false
20313 .cindex "symbolic link" "to mailbox"
20314 .cindex "mailbox" "symbolic link"
20315 By default, &(appendfile)& will not deliver if the path name for the file is
20316 that of a symbolic link. Setting this option relaxes that constraint, but there
20317 are security issues involved in the use of symbolic links. Be sure you know
20318 what you are doing if you set this. Details of exactly what this option affects
20319 are included in the discussion which follows this list of options.
20320
20321
20322 .option batch_id appendfile string&!! unset
20323 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20324 However, batching is automatically disabled for &(appendfile)& deliveries that
20325 happen as a result of forwarding or aliasing or other redirection directly to a
20326 file.
20327
20328
20329 .option batch_max appendfile integer 1
20330 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20331
20332
20333 .option check_group appendfile boolean false
20334 When this option is set, the group owner of the file defined by the &%file%&
20335 option is checked to see that it is the same as the group under which the
20336 delivery process is running. The default setting is false because the default
20337 file mode is 0600, which means that the group is irrelevant.
20338
20339
20340 .option check_owner appendfile boolean true
20341 When this option is set, the owner of the file defined by the &%file%& option
20342 is checked to ensure that it is the same as the user under which the delivery
20343 process is running.
20344
20345
20346 .option check_string appendfile string "see below"
20347 .cindex "&""From""& line"
20348 As &(appendfile)& writes the message, the start of each line is tested for
20349 matching &%check_string%&, and if it does, the initial matching characters are
20350 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20351 a literal string, not a regular expression, and the case of any letters it
20352 contains is significant.
20353
20354 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20355 are forced to &"."& and &".."& respectively, and any settings in the
20356 configuration are ignored. Otherwise, they default to &"From&~"& and
20357 &">From&~"& when the &%file%& option is set, and unset when any of the
20358 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20359
20360 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20361 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20362 &"From&~"& indicates the start of a new message. All four options need changing
20363 if another format is used. For example, to deliver to mailboxes in MMDF format:
20364 .cindex "MMDF format mailbox"
20365 .cindex "mailbox" "MMDF format"
20366 .code
20367 check_string = "\1\1\1\1\n"
20368 escape_string = "\1\1\1\1 \n"
20369 message_prefix = "\1\1\1\1\n"
20370 message_suffix = "\1\1\1\1\n"
20371 .endd
20372 .option create_directory appendfile boolean true
20373 .cindex "directory creation"
20374 When this option is true, Exim attempts to create any missing superior
20375 directories for the file that it is about to write. A created directory's mode
20376 is given by the &%directory_mode%& option.
20377
20378 The group ownership of a newly created directory is highly dependent on the
20379 operating system (and possibly the file system) that is being used. For
20380 example, in Solaris, if the parent directory has the setgid bit set, its group
20381 is propagated to the child; if not, the currently set group is used. However,
20382 in FreeBSD, the parent's group is always used.
20383
20384
20385
20386 .option create_file appendfile string anywhere
20387 This option constrains the location of files and directories that are created
20388 by this transport. It applies to files defined by the &%file%& option and
20389 directories defined by the &%directory%& option. In the case of maildir
20390 delivery, it applies to the top level directory, not the maildir directories
20391 beneath.
20392
20393 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20394 &"belowhome"&. In the second and third cases, a home directory must have been
20395 set for the transport. This option is not useful when an explicit file name is
20396 given for normal mailbox deliveries. It is intended for the case when file
20397 names are generated from users' &_.forward_& files. These are usually handled
20398 by an &(appendfile)& transport called &%address_file%&. See also
20399 &%file_must_exist%&.
20400
20401
20402 .option directory appendfile string&!! unset
20403 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20404 or &%directory%& must be set, unless the delivery is the direct result of a
20405 redirection (see section &<<SECTfildiropt>>&).
20406
20407 When &%directory%& is set, the string is expanded, and the message is delivered
20408 into a new file or files in or below the given directory, instead of being
20409 appended to a single mailbox file. A number of different formats are provided
20410 (see &%maildir_format%& and &%mailstore_format%&), and see section
20411 &<<SECTopdir>>& for further details of this form of delivery.
20412
20413
20414 .option directory_file appendfile string&!! "see below"
20415 .cindex "base62"
20416 .vindex "&$inode$&"
20417 When &%directory%& is set, but neither &%maildir_format%& nor
20418 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20419 whose name is obtained by expanding this string. The default value is:
20420 .code
20421 q${base62:$tod_epoch}-$inode
20422 .endd
20423 This generates a unique name from the current time, in base 62 form, and the
20424 inode of the file. The variable &$inode$& is available only when expanding this
20425 option.
20426
20427
20428 .option directory_mode appendfile "octal integer" 0700
20429 If &(appendfile)& creates any directories as a result of the
20430 &%create_directory%& option, their mode is specified by this option.
20431
20432
20433 .option escape_string appendfile string "see description"
20434 See &%check_string%& above.
20435
20436
20437 .option file appendfile string&!! unset
20438 This option is mutually exclusive with the &%directory%& option, but one of
20439 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20440 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20441 specifies a single file, to which the message is appended. One or more of
20442 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20443 &%file%&.
20444
20445 .cindex "NFS" "lock file"
20446 .cindex "locking files"
20447 .cindex "lock files"
20448 If you are using more than one host to deliver over NFS into the same
20449 mailboxes, you should always use lock files.
20450
20451 The string value is expanded for each delivery, and must yield an absolute
20452 path. The most common settings of this option are variations on one of these
20453 examples:
20454 .code
20455 file = /var/spool/mail/$local_part
20456 file = /home/$local_part/inbox
20457 file = $home/inbox
20458 .endd
20459 .cindex "&""sticky""& bit"
20460 In the first example, all deliveries are done into the same directory. If Exim
20461 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20462 create a file in the directory, so the &"sticky"& bit must be turned on for
20463 deliveries to be possible, or alternatively the &%group%& option can be used to
20464 run the delivery under a group id which has write access to the directory.
20465
20466
20467
20468 .option file_format appendfile string unset
20469 .cindex "file" "mailbox; checking existing format"
20470 This option requests the transport to check the format of an existing file
20471 before adding to it. The check consists of matching a specific string at the
20472 start of the file. The value of the option consists of an even number of
20473 colon-separated strings. The first of each pair is the test string, and the
20474 second is the name of a transport. If the transport associated with a matched
20475 string is not the current transport, control is passed over to the other
20476 transport. For example, suppose the standard &(local_delivery)& transport has
20477 this added to it:
20478 .code
20479 file_format = "From       : local_delivery :\
20480                \1\1\1\1\n : local_mmdf_delivery"
20481 .endd
20482 Mailboxes that begin with &"From"& are still handled by this transport, but if
20483 a mailbox begins with four binary ones followed by a newline, control is passed
20484 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20485 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20486 is assumed to match the current transport. If the start of a mailbox doesn't
20487 match any string, or if the transport named for a given string is not defined,
20488 delivery is deferred.
20489
20490
20491 .option file_must_exist appendfile boolean false
20492 If this option is true, the file specified by the &%file%& option must exist.
20493 A temporary error occurs if it does not, causing delivery to be deferred.
20494 If this option is false, the file is created if it does not exist.
20495
20496
20497 .option lock_fcntl_timeout appendfile time 0s
20498 .cindex "timeout" "mailbox locking"
20499 .cindex "mailbox" "locking, blocking and non-blocking"
20500 .cindex "locking files"
20501 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20502 when locking an open mailbox file. If the call fails, the delivery process
20503 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20504 Non-blocking calls are used so that the file is not kept open during the wait
20505 for the lock; the reason for this is to make it as safe as possible for
20506 deliveries over NFS in the case when processes might be accessing an NFS
20507 mailbox without using a lock file. This should not be done, but
20508 misunderstandings and hence misconfigurations are not unknown.
20509
20510 On a busy system, however, the performance of a non-blocking lock approach is
20511 not as good as using a blocking lock with a timeout. In this case, the waiting
20512 is done inside the system call, and Exim's delivery process acquires the lock
20513 and can proceed as soon as the previous lock holder releases it.
20514
20515 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20516 timeout, are used. There may still be some retrying: the maximum number of
20517 retries is
20518 .code
20519 (lock_retries * lock_interval) / lock_fcntl_timeout
20520 .endd
20521 rounded up to the next whole number. In other words, the total time during
20522 which &(appendfile)& is trying to get a lock is roughly the same, unless
20523 &%lock_fcntl_timeout%& is set very large.
20524
20525 You should consider setting this option if you are getting a lot of delayed
20526 local deliveries because of errors of the form
20527 .code
20528 failed to lock mailbox /some/file (fcntl)
20529 .endd
20530
20531 .option lock_flock_timeout appendfile time 0s
20532 This timeout applies to file locking when using &[flock()]& (see
20533 &%use_flock%&); the timeout operates in a similar manner to
20534 &%lock_fcntl_timeout%&.
20535
20536
20537 .option lock_interval appendfile time 3s
20538 This specifies the time to wait between attempts to lock the file. See below
20539 for details of locking.
20540
20541
20542 .option lock_retries appendfile integer 10
20543 This specifies the maximum number of attempts to lock the file. A value of zero
20544 is treated as 1. See below for details of locking.
20545
20546
20547 .option lockfile_mode appendfile "octal integer" 0600
20548 This specifies the mode of the created lock file, when a lock file is being
20549 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20550
20551
20552 .option lockfile_timeout appendfile time 30m
20553 .cindex "timeout" "mailbox locking"
20554 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20555 exists and is older than this value, it is assumed to have been left behind by
20556 accident, and Exim attempts to remove it.
20557
20558
20559 .option mailbox_filecount appendfile string&!! unset
20560 .cindex "mailbox" "specifying size of"
20561 .cindex "size" "of mailbox"
20562 If this option is set, it is expanded, and the result is taken as the current
20563 number of files in the mailbox. It must be a decimal number, optionally
20564 followed by K or M. This provides a way of obtaining this information from an
20565 external source that maintains the data.
20566
20567
20568 .option mailbox_size appendfile string&!! unset
20569 .cindex "mailbox" "specifying size of"
20570 .cindex "size" "of mailbox"
20571 If this option is set, it is expanded, and the result is taken as the current
20572 size the mailbox. It must be a decimal number, optionally followed by K or M.
20573 This provides a way of obtaining this information from an external source that
20574 maintains the data. This is likely to be helpful for maildir deliveries where
20575 it is computationally expensive to compute the size of a mailbox.
20576
20577
20578
20579 .option maildir_format appendfile boolean false
20580 .cindex "maildir format" "specifying"
20581 If this option is set with the &%directory%& option, the delivery is into a new
20582 file, in the &"maildir"& format that is used by other mail software. When the
20583 transport is activated directly from a &(redirect)& router (for example, the
20584 &(address_file)& transport in the default configuration), setting
20585 &%maildir_format%& causes the path received from the router to be treated as a
20586 directory, whether or not it ends with &`/`&. This option is available only if
20587 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20588 &<<SECTmaildirdelivery>>& below for further details.
20589
20590
20591 .option maildir_quota_directory_regex appendfile string "See below"
20592 .cindex "maildir format" "quota; directories included in"
20593 .cindex "quota" "maildir; directories included in"
20594 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20595 a regular expression for specifying directories, relative to the quota
20596 directory (see &%quota_directory%&), that should be included in the quota
20597 calculation. The default value is:
20598 .code
20599 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20600 .endd
20601 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20602 (directories whose names begin with a dot). If you want to exclude the
20603 &_Trash_&
20604 folder from the count (as some sites do), you need to change this setting to
20605 .code
20606 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20607 .endd
20608 This uses a negative lookahead in the regular expression to exclude the
20609 directory whose name is &_.Trash_&. When a directory is excluded from quota
20610 calculations, quota processing is bypassed for any messages that are delivered
20611 directly into that directory.
20612
20613
20614 .option maildir_retries appendfile integer 10
20615 This option specifies the number of times to retry when writing a file in
20616 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20617
20618
20619 .option maildir_tag appendfile string&!! unset
20620 This option applies only to deliveries in maildir format, and is described in
20621 section &<<SECTmaildirdelivery>>& below.
20622
20623
20624 .option maildir_use_size_file appendfile&!! boolean false
20625 .cindex "maildir format" "&_maildirsize_& file"
20626 The result of string expansion for this option must be a valid boolean value.
20627 If it is true, it enables support for &_maildirsize_& files. Exim
20628 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20629 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20630 value is zero. See &%maildir_quota_directory_regex%& above and section
20631 &<<SECTmaildirdelivery>>& below for further details.
20632
20633 .option maildirfolder_create_regex appendfile string unset
20634 .cindex "maildir format" "&_maildirfolder_& file"
20635 .cindex "&_maildirfolder_&, creating"
20636 The value of this option is a regular expression. If it is unset, it has no
20637 effect. Otherwise, before a maildir delivery takes place, the pattern is
20638 matched against the name of the maildir directory, that is, the directory
20639 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20640 delivery. If there is a match, Exim checks for the existence of a file called
20641 &_maildirfolder_& in the directory, and creates it if it does not exist.
20642 See section &<<SECTmaildirdelivery>>& for more details.
20643
20644
20645 .option mailstore_format appendfile boolean false
20646 .cindex "mailstore format" "specifying"
20647 If this option is set with the &%directory%& option, the delivery is into two
20648 new files in  &"mailstore"& format. The option is available only if
20649 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20650 below for further details.
20651
20652
20653 .option mailstore_prefix appendfile string&!! unset
20654 This option applies only to deliveries in mailstore format, and is described in
20655 section &<<SECTopdir>>& below.
20656
20657
20658 .option mailstore_suffix appendfile string&!! unset
20659 This option applies only to deliveries in mailstore format, and is described in
20660 section &<<SECTopdir>>& below.
20661
20662
20663 .option mbx_format appendfile boolean false
20664 .cindex "locking files"
20665 .cindex "file" "locking"
20666 .cindex "file" "MBX format"
20667 .cindex "MBX format, specifying"
20668 This option is available only if Exim has been compiled with SUPPORT_MBX
20669 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20670 the message is appended to the mailbox file in MBX format instead of
20671 traditional Unix format. This format is supported by Pine4 and its associated
20672 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20673
20674 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20675 automatically changed by the use of &%mbx_format%&. They should normally be set
20676 empty when using MBX format, so this option almost always appears in this
20677 combination:
20678 .code
20679 mbx_format = true
20680 message_prefix =
20681 message_suffix =
20682 .endd
20683 If none of the locking options are mentioned in the configuration,
20684 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20685 is possible to specify the other kinds of locking with &%mbx_format%&, but
20686 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20687 interworks with &'c-client'&, providing for shared access to the mailbox. It
20688 should not be used if any program that does not use this form of locking is
20689 going to access the mailbox, nor should it be used if the mailbox file is NFS
20690 mounted, because it works only when the mailbox is accessed from a single host.
20691
20692 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20693 the standard version of &'c-client'&, because as long as it has a mailbox open
20694 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20695 append messages to it.
20696
20697
20698 .option message_prefix appendfile string&!! "see below"
20699 .cindex "&""From""& line"
20700 The string specified here is expanded and output at the start of every message.
20701 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20702 in which case it is:
20703 .code
20704 message_prefix = "From ${if def:return_path{$return_path}\
20705   {MAILER-DAEMON}} $tod_bsdinbox\n"
20706 .endd
20707 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20708 &`\n`& to &`\r\n`& in &%message_prefix%&.
20709
20710 .option message_suffix appendfile string&!! "see below"
20711 The string specified here is expanded and output at the end of every message.
20712 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20713 in which case it is a single newline character. The suffix can be suppressed by
20714 setting
20715 .code
20716 message_suffix =
20717 .endd
20718 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20719 &`\n`& to &`\r\n`& in &%message_suffix%&.
20720
20721 .option mode appendfile "octal integer" 0600
20722 If the output file is created, it is given this mode. If it already exists and
20723 has wider permissions, they are reduced to this mode. If it has narrower
20724 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20725 if the delivery is the result of a &%save%& command in a filter file specifying
20726 a particular mode, the mode of the output file is always forced to take that
20727 value, and this option is ignored.
20728
20729
20730 .option mode_fail_narrower appendfile boolean true
20731 This option applies in the case when an existing mailbox file has a narrower
20732 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20733 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20734 continues with the delivery attempt, using the existing mode of the file.
20735
20736
20737 .option notify_comsat appendfile boolean false
20738 If this option is true, the &'comsat'& daemon is notified after every
20739 successful delivery to a user mailbox. This is the daemon that notifies logged
20740 on users about incoming mail.
20741
20742
20743 .option quota appendfile string&!! unset
20744 .cindex "quota" "imposed by Exim"
20745 This option imposes a limit on the size of the file to which Exim is appending,
20746 or to the total space used in the directory tree when the &%directory%& option
20747 is set. In the latter case, computation of the space used is expensive, because
20748 all the files in the directory (and any sub-directories) have to be
20749 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20750 &%maildir_use_size_file%& for ways to avoid this in environments where users
20751 have no shell access to their mailboxes).
20752
20753 As there is no interlock against two simultaneous deliveries into a
20754 multi-file mailbox, it is possible for the quota to be overrun in this case.
20755 For single-file mailboxes, of course, an interlock is a necessity.
20756
20757 A file's size is taken as its &'used'& value. Because of blocking effects, this
20758 may be a lot less than the actual amount of disk space allocated to the file.
20759 If the sizes of a number of files are being added up, the rounding effect can
20760 become quite noticeable, especially on systems that have large block sizes.
20761 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20762 the obvious value which users understand most easily.
20763
20764 The value of the option is expanded, and must then be a numerical value
20765 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20766 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20767 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20768 be handled.
20769
20770 &*Note*&: A value of zero is interpreted as &"no quota"&.
20771
20772 The expansion happens while Exim is running as root, before it changes uid for
20773 the delivery. This means that files that are inaccessible to the end user can
20774 be used to hold quota values that are looked up in the expansion. When delivery
20775 fails because this quota is exceeded, the handling of the error is as for
20776 system quota failures.
20777
20778 By default, Exim's quota checking mimics system quotas, and restricts the
20779 mailbox to the specified maximum size, though the value is not accurate to the
20780 last byte, owing to separator lines and additional headers that may get added
20781 during message delivery. When a mailbox is nearly full, large messages may get
20782 refused even though small ones are accepted, because the size of the current
20783 message is added to the quota when the check is made. This behaviour can be
20784 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20785 for exceeding the quota does not include the current message. Thus, deliveries
20786 continue until the quota has been exceeded; thereafter, no further messages are
20787 delivered. See also &%quota_warn_threshold%&.
20788
20789
20790 .option quota_directory appendfile string&!! unset
20791 This option defines the directory to check for quota purposes when delivering
20792 into individual files. The default is the delivery directory, or, if a file
20793 called &_maildirfolder_& exists in a maildir directory, the parent of the
20794 delivery directory.
20795
20796
20797 .option quota_filecount appendfile string&!! 0
20798 This option applies when the &%directory%& option is set. It limits the total
20799 number of files in the directory (compare the inode limit in system quotas). It
20800 can only be used if &%quota%& is also set. The value is expanded; an expansion
20801 failure causes delivery to be deferred. A value of zero is interpreted as
20802 &"no quota"&.
20803
20804
20805 .option quota_is_inclusive appendfile boolean true
20806 See &%quota%& above.
20807
20808
20809 .option quota_size_regex appendfile string unset
20810 This option applies when one of the delivery modes that writes a separate file
20811 for each message is being used. When Exim wants to find the size of one of
20812 these files in order to test the quota, it first checks &%quota_size_regex%&.
20813 If this is set to a regular expression that matches the file name, and it
20814 captures one string, that string is interpreted as a representation of the
20815 file's size. The value of &%quota_size_regex%& is not expanded.
20816
20817 This feature is useful only when users have no shell access to their mailboxes
20818 &-- otherwise they could defeat the quota simply by renaming the files. This
20819 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20820 the file length to the file name. For example:
20821 .code
20822 maildir_tag = ,S=$message_size
20823 quota_size_regex = ,S=(\d+)
20824 .endd
20825 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20826 number of lines in the message.
20827
20828 The regular expression should not assume that the length is at the end of the
20829 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20830 sometimes add other information onto the ends of message file names.
20831
20832 Section &<<SECID136>>& contains further information.
20833
20834
20835 .option quota_warn_message appendfile string&!! "see below"
20836 See below for the use of this option. If it is not set when
20837 &%quota_warn_threshold%& is set, it defaults to
20838 .code
20839 quota_warn_message = "\
20840   To: $local_part@$domain\n\
20841   Subject: Your mailbox\n\n\
20842   This message is automatically created \
20843   by mail delivery software.\n\n\
20844   The size of your mailbox has exceeded \
20845   a warning threshold that is\n\
20846   set by the system administrator.\n"
20847 .endd
20848
20849
20850 .option quota_warn_threshold appendfile string&!! 0
20851 .cindex "quota" "warning threshold"
20852 .cindex "mailbox" "size warning"
20853 .cindex "size" "of mailbox"
20854 This option is expanded in the same way as &%quota%& (see above). If the
20855 resulting value is greater than zero, and delivery of the message causes the
20856 size of the file or total space in the directory tree to cross the given
20857 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20858 may be specified as a percentage of it by following the value with a percent
20859 sign. For example:
20860 .code
20861 quota = 10M
20862 quota_warn_threshold = 75%
20863 .endd
20864 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20865 percent sign is ignored.
20866
20867 The warning message itself is specified by the &%quota_warn_message%& option,
20868 and it must start with a &'To:'& header line containing the recipient(s) of the
20869 warning message. These do not necessarily have to include the recipient(s) of
20870 the original message. A &'Subject:'& line should also normally be supplied. You
20871 can include any other header lines that you want. If you do not include a
20872 &'From:'& line, the default is:
20873 .code
20874 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20875 .endd
20876 .oindex &%errors_reply_to%&
20877 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20878 option.
20879
20880 The &%quota%& option does not have to be set in order to use this option; they
20881 are independent of one another except when the threshold is specified as a
20882 percentage.
20883
20884
20885 .option use_bsmtp appendfile boolean false
20886 .cindex "envelope sender"
20887 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20888 format, with the envelope sender and recipient(s) included as SMTP commands. If
20889 you want to include a leading HELO command with such messages, you can do
20890 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20891 for details of batch SMTP.
20892
20893
20894 .option use_crlf appendfile boolean false
20895 .cindex "carriage return"
20896 .cindex "linefeed"
20897 This option causes lines to be terminated with the two-character CRLF sequence
20898 (carriage return, linefeed) instead of just a linefeed character. In the case
20899 of batched SMTP, the byte sequence written to the file is then an exact image
20900 of what would be sent down a real SMTP connection.
20901
20902 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20903 (which are used to supply the traditional &"From&~"& and blank line separators
20904 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20905 carriage return characters if these are needed. In cases where these options
20906 have non-empty defaults, the values end with a single linefeed, so they must be
20907 changed to end with &`\r\n`& if &%use_crlf%& is set.
20908
20909
20910 .option use_fcntl_lock appendfile boolean "see below"
20911 This option controls the use of the &[fcntl()]& function to lock a file for
20912 exclusive use when a message is being appended. It is set by default unless
20913 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20914 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20915 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20916
20917
20918 .option use_flock_lock appendfile boolean false
20919 This option is provided to support the use of &[flock()]& for file locking, for
20920 the few situations where it is needed. Most modern operating systems support
20921 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20922 each other. Exim uses &[fcntl()]& locking by default.
20923
20924 This option is required only if you are using an operating system where
20925 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20926 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20927 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20928
20929 .cindex "Solaris" "&[flock()]& support"
20930 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20931 have it (and some, I think, provide a not quite right version built on top of
20932 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20933 the ability to use it, and any attempt to do so will cause a configuration
20934 error.
20935
20936 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20937 is just being mapped onto &[fcntl()]& by the OS).
20938
20939
20940 .option use_lockfile appendfile boolean "see below"
20941 If this option is turned off, Exim does not attempt to create a lock file when
20942 appending to a mailbox file. In this situation, the only locking is by
20943 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20944 sure that every MUA that is ever going to look at your users' mailboxes uses
20945 &[fcntl()]& rather than a lock file, and even then only when you are not
20946 delivering over NFS from more than one host.
20947
20948 .cindex "NFS" "lock file"
20949 In order to append to an NFS file safely from more than one host, it is
20950 necessary to take out a lock &'before'& opening the file, and the lock file
20951 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20952 file corruption.
20953
20954 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20955 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20956 except when &%mbx_format%& is set.
20957
20958
20959 .option use_mbx_lock appendfile boolean "see below"
20960 This option is available only if Exim has been compiled with SUPPORT_MBX
20961 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20962 locking rules be used. It is set by default if &%mbx_format%& is set and none
20963 of the locking options are mentioned in the configuration. The locking rules
20964 are the same as are used by the &'c-client'& library that underlies Pine and
20965 the IMAP4 and POP daemons that come with it (see the discussion below). The
20966 rules allow for shared access to the mailbox. However, this kind of locking
20967 does not work when the mailbox is NFS mounted.
20968
20969 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20970 &%use_flock_lock%& to control what kind of locking is used in implementing the
20971 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20972 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20973
20974
20975
20976
20977 .section "Operational details for appending" "SECTopappend"
20978 .cindex "appending to a file"
20979 .cindex "file" "appending"
20980 Before appending to a file, the following preparations are made:
20981
20982 .ilist
20983 If the name of the file is &_/dev/null_&, no action is taken, and a success
20984 return is given.
20985
20986 .next
20987 .cindex "directory creation"
20988 If any directories on the file's path are missing, Exim creates them if the
20989 &%create_directory%& option is set. A created directory's mode is given by the
20990 &%directory_mode%& option.
20991
20992 .next
20993 If &%file_format%& is set, the format of an existing file is checked. If this
20994 indicates that a different transport should be used, control is passed to that
20995 transport.
20996
20997 .next
20998 .cindex "file" "locking"
20999 .cindex "locking files"
21000 .cindex "NFS" "lock file"
21001 If &%use_lockfile%& is set, a lock file is built in a way that will work
21002 reliably over NFS, as follows:
21003
21004 .olist
21005 Create a &"hitching post"& file whose name is that of the lock file with the
21006 current time, primary host name, and process id added, by opening for writing
21007 as a new file. If this fails with an access error, delivery is deferred.
21008 .next
21009 Close the hitching post file, and hard link it to the lock file name.
21010 .next
21011 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21012 Unlink the hitching post name.
21013 .next
21014 Otherwise, use &[stat()]& to get information about the hitching post file, and
21015 then unlink hitching post name. If the number of links is exactly two, creation
21016 of the lock file succeeded but something (for example, an NFS server crash and
21017 restart) caused this fact not to be communicated to the &[link()]& call.
21018 .next
21019 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21020 up to &%lock_retries%& times. However, since any program that writes to a
21021 mailbox should complete its task very quickly, it is reasonable to time out old
21022 lock files that are normally the result of user agent and system crashes. If an
21023 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21024 it before trying again.
21025 .endlist olist
21026
21027 .next
21028 A call is made to &[lstat()]& to discover whether the main file exists, and if
21029 so, what its characteristics are. If &[lstat()]& fails for any reason other
21030 than non-existence, delivery is deferred.
21031
21032 .next
21033 .cindex "symbolic link" "to mailbox"
21034 .cindex "mailbox" "symbolic link"
21035 If the file does exist and is a symbolic link, delivery is deferred, unless the
21036 &%allow_symlink%& option is set, in which case the ownership of the link is
21037 checked, and then &[stat()]& is called to find out about the real file, which
21038 is then subjected to the checks below. The check on the top-level link
21039 ownership prevents one user creating a link for another's mailbox in a sticky
21040 directory, though allowing symbolic links in this case is definitely not a good
21041 idea. If there is a chain of symbolic links, the intermediate ones are not
21042 checked.
21043
21044 .next
21045 If the file already exists but is not a regular file, or if the file's owner
21046 and group (if the group is being checked &-- see &%check_group%& above) are
21047 different from the user and group under which the delivery is running,
21048 delivery is deferred.
21049
21050 .next
21051 If the file's permissions are more generous than specified, they are reduced.
21052 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21053 is set false, in which case the delivery is tried using the existing
21054 permissions.
21055
21056 .next
21057 The file's inode number is saved, and the file is then opened for appending.
21058 If this fails because the file has vanished, &(appendfile)& behaves as if it
21059 hadn't existed (see below). For any other failures, delivery is deferred.
21060
21061 .next
21062 If the file is opened successfully, check that the inode number hasn't
21063 changed, that it is still a regular file, and that the owner and permissions
21064 have not changed. If anything is wrong, defer delivery and freeze the message.
21065
21066 .next
21067 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21068 option is set. Otherwise, check that the file is being created in a permitted
21069 directory if the &%create_file%& option is set (deferring on failure), and then
21070 open for writing as a new file, with the O_EXCL and O_CREAT options,
21071 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21072 set). In this case, which can happen if the link points to a non-existent file,
21073 the file is opened for writing using O_CREAT but not O_EXCL, because
21074 that prevents link following.
21075
21076 .next
21077 .cindex "loop" "while file testing"
21078 If opening fails because the file exists, obey the tests given above for
21079 existing files. However, to avoid looping in a situation where the file is
21080 being continuously created and destroyed, the exists/not-exists loop is broken
21081 after 10 repetitions, and the message is then frozen.
21082
21083 .next
21084 If opening fails with any other error, defer delivery.
21085
21086 .next
21087 .cindex "file" "locking"
21088 .cindex "locking files"
21089 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21090 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21091 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21092 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21093 file, and an exclusive lock on the file whose name is
21094 .code
21095 /tmp/.<device-number>.<inode-number>
21096 .endd
21097 using the device and inode numbers of the open mailbox file, in accordance with
21098 the MBX locking rules. This file is created with a mode that is specified by
21099 the &%lockfile_mode%& option.
21100
21101 If Exim fails to lock the file, there are two possible courses of action,
21102 depending on the value of the locking timeout. This is obtained from
21103 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21104
21105 If the timeout value is zero, the file is closed, Exim waits for
21106 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21107 to lock it again. This happens up to &%lock_retries%& times, after which the
21108 delivery is deferred.
21109
21110 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21111 &[flock()]& are used (with the given timeout), so there has already been some
21112 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21113 immediately. It retries up to
21114 .code
21115 (lock_retries * lock_interval) / <timeout>
21116 .endd
21117 times (rounded up).
21118 .endlist
21119
21120 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21121 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21122
21123
21124 .section "Operational details for delivery to a new file" "SECTopdir"
21125 .cindex "delivery" "to single file"
21126 .cindex "&""From""& line"
21127 When the &%directory%& option is set instead of &%file%&, each message is
21128 delivered into a newly-created file or set of files. When &(appendfile)& is
21129 activated directly from a &(redirect)& router, neither &%file%& nor
21130 &%directory%& is normally set, because the path for delivery is supplied by the
21131 router. (See for example, the &(address_file)& transport in the default
21132 configuration.) In this case, delivery is to a new file if either the path name
21133 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21134
21135 No locking is required while writing the message to a new file, so the various
21136 locking options of the transport are ignored. The &"From"& line that by default
21137 separates messages in a single file is not normally needed, nor is the escaping
21138 of message lines that start with &"From"&, and there is no need to ensure a
21139 newline at the end of each message. Consequently, the default values for
21140 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21141 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21142
21143 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21144 the files in the delivery directory by default. However, you can specify a
21145 different directory by setting &%quota_directory%&. Also, for maildir
21146 deliveries (see below) the &_maildirfolder_& convention is honoured.
21147
21148
21149 .cindex "maildir format"
21150 .cindex "mailstore format"
21151 There are three different ways in which delivery to individual files can be
21152 done, controlled by the settings of the &%maildir_format%& and
21153 &%mailstore_format%& options. Note that code to support maildir or mailstore
21154 formats is not included in the binary unless SUPPORT_MAILDIR or
21155 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21156
21157 .cindex "directory creation"
21158 In all three cases an attempt is made to create the directory and any necessary
21159 sub-directories if they do not exist, provided that the &%create_directory%&
21160 option is set (the default). The location of a created directory can be
21161 constrained by setting &%create_file%&. A created directory's mode is given by
21162 the &%directory_mode%& option. If creation fails, or if the
21163 &%create_directory%& option is not set when creation is required, delivery is
21164 deferred.
21165
21166
21167
21168 .section "Maildir delivery" "SECTmaildirdelivery"
21169 .cindex "maildir format" "description of"
21170 If the &%maildir_format%& option is true, Exim delivers each message by writing
21171 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21172 directory that is defined by the &%directory%& option (the &"delivery
21173 directory"&). If the delivery is successful, the file is renamed into the
21174 &_new_& subdirectory.
21175
21176 In the file name, <&'stime'&> is the current time of day in seconds, and
21177 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21178 Exim checks that the time-of-day clock has moved on by at least one microsecond
21179 before terminating the delivery process. This guarantees uniqueness for the
21180 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21181 opening it. If any response other than ENOENT (does not exist) is given,
21182 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21183
21184 Before Exim carries out a maildir delivery, it ensures that subdirectories
21185 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21186 do not exist, Exim tries to create them and any superior directories in their
21187 path, subject to the &%create_directory%& and &%create_file%& options. If the
21188 &%maildirfolder_create_regex%& option is set, and the regular expression it
21189 contains matches the delivery directory, Exim also ensures that a file called
21190 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21191 &_maildirfolder_& file cannot be created, delivery is deferred.
21192
21193 These features make it possible to use Exim to create all the necessary files
21194 and directories in a maildir mailbox, including subdirectories for maildir++
21195 folders. Consider this example:
21196 .code
21197 maildir_format = true
21198 directory = /var/mail/$local_part\
21199            ${if eq{$local_part_suffix}{}{}\
21200            {/.${substr_1:$local_part_suffix}}}
21201 maildirfolder_create_regex = /\.[^/]+$
21202 .endd
21203 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21204 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21205 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21206 not match this name, so Exim will not look for or create the file
21207 &_/var/mail/pimbo/maildirfolder_&, though it will create
21208 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21209
21210 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21211 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21212 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21213 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21214 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21215
21216 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21217 not inadvertently match the toplevel maildir directory, because a
21218 &_maildirfolder_& file at top level would completely break quota calculations.
21219
21220 .cindex "quota" "in maildir delivery"
21221 .cindex "maildir++"
21222 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21223 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21224 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21225 Exim assumes the directory is a maildir++ folder directory, which is one level
21226 down from the user's top level mailbox directory. This causes it to start at
21227 the parent directory instead of the current directory when calculating the
21228 amount of space used.
21229
21230 One problem with delivering into a multi-file mailbox is that it is
21231 computationally expensive to compute the size of the mailbox for quota
21232 checking. Various approaches have been taken to reduce the amount of work
21233 needed. The next two sections describe two of them. A third alternative is to
21234 use some external process for maintaining the size data, and use the expansion
21235 of the &%mailbox_size%& option as a way of importing it into Exim.
21236
21237
21238
21239
21240 .section "Using tags to record message sizes" "SECID135"
21241 If &%maildir_tag%& is set, the string is expanded for each delivery.
21242 When the maildir file is renamed into the &_new_& sub-directory, the
21243 tag is added to its name. However, if adding the tag takes the length of the
21244 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21245 the tag is dropped and the maildir file is created with no tag.
21246
21247
21248 .vindex "&$message_size$&"
21249 Tags can be used to encode the size of files in their names; see
21250 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21251 happens after the message has been written. The value of the &$message_size$&
21252 variable is set to the number of bytes actually written. If the expansion is
21253 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21254 be deferred. The expanded tag may contain any printing characters except &"/"&.
21255 Non-printing characters in the string are ignored; if the resulting string is
21256 empty, it is ignored. If it starts with an alphanumeric character, a leading
21257 colon is inserted; this default has not proven to be the path that popular
21258 maildir implementations have chosen (but changing it in Exim would break
21259 backwards compatibility).
21260
21261 For one common implementation, you might set:
21262 .code
21263 maildir_tag = ,S=${message_size}
21264 .endd
21265 but you should check the documentation of the other software to be sure.
21266
21267 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21268 as this allows Exim to extract the size from your tag, instead of having to
21269 &[stat()]& each message file.
21270
21271
21272 .section "Using a maildirsize file" "SECID136"
21273 .cindex "quota" "in maildir delivery"
21274 .cindex "maildir format" "&_maildirsize_& file"
21275 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21276 storing quota and message size information in a file called &_maildirsize_&
21277 within the toplevel maildir directory. If this file does not exist, Exim
21278 creates it, setting the quota from the &%quota%& option of the transport. If
21279 the maildir directory itself does not exist, it is created before any attempt
21280 to write a &_maildirsize_& file.
21281
21282 The &_maildirsize_& file is used to hold information about the sizes of
21283 messages in the maildir, thus speeding up quota calculations. The quota value
21284 in the file is just a cache; if the quota is changed in the transport, the new
21285 value overrides the cached value when the next message is delivered. The cache
21286 is maintained for the benefit of other programs that access the maildir and
21287 need to know the quota.
21288
21289 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21290 file is maintained (with a zero quota setting), but no quota is imposed.
21291
21292 A regular expression is available for controlling which directories in the
21293 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21294 See the description of the &%maildir_quota_directory_regex%& option above for
21295 details.
21296
21297
21298 .section "Mailstore delivery" "SECID137"
21299 .cindex "mailstore format" "description of"
21300 If the &%mailstore_format%& option is true, each message is written as two
21301 files in the given directory. A unique base name is constructed from the
21302 message id and the current delivery process, and the files that are written use
21303 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21304 contains the message's envelope, and the &_.msg_& file contains the message
21305 itself. The base name is placed in the variable &$mailstore_basename$&.
21306
21307 During delivery, the envelope is first written to a file with the suffix
21308 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21309 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21310 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21311 file before accessing either of them. An alternative approach is to wait for
21312 the absence of a &_.tmp_& file.
21313
21314 The envelope file starts with any text defined by the &%mailstore_prefix%&
21315 option, expanded and terminated by a newline if there isn't one. Then follows
21316 the sender address on one line, then all the recipient addresses, one per line.
21317 There can be more than one recipient only if the &%batch_max%& option is set
21318 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21319 appended to the file, followed by a newline if it does not end with one.
21320
21321 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21322 failure, it is ignored. Other expansion errors are treated as serious
21323 configuration errors, and delivery is deferred. The variable
21324 &$mailstore_basename$& is available for use during these expansions.
21325
21326
21327 .section "Non-special new file delivery" "SECID138"
21328 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21329 file is created directly in the named directory. For example, when delivering
21330 messages into files in batched SMTP format for later delivery to some host (see
21331 section &<<SECTbatchSMTP>>&), a setting such as
21332 .code
21333 directory = /var/bsmtp/$host
21334 .endd
21335 might be used. A message is written to a file with a temporary name, which is
21336 then renamed when the delivery is complete. The final name is obtained by
21337 expanding the contents of the &%directory_file%& option.
21338 .ecindex IIDapptra1
21339 .ecindex IIDapptra2
21340
21341
21342
21343
21344
21345
21346 . ////////////////////////////////////////////////////////////////////////////
21347 . ////////////////////////////////////////////////////////////////////////////
21348
21349 .chapter "The autoreply transport" "CHID8"
21350 .scindex IIDauttra1 "transports" "&(autoreply)&"
21351 .scindex IIDauttra2 "&(autoreply)& transport"
21352 The &(autoreply)& transport is not a true transport in that it does not cause
21353 the message to be transmitted. Instead, it generates a new mail message as an
21354 automatic reply to the incoming message. &'References:'& and
21355 &'Auto-Submitted:'& header lines are included. These are constructed according
21356 to the rules in RFCs 2822 and 3834, respectively.
21357
21358 If the router that passes the message to this transport does not have the
21359 &%unseen%& option set, the original message (for the current recipient) is not
21360 delivered anywhere. However, when the &%unseen%& option is set on the router
21361 that passes the message to this transport, routing of the address continues, so
21362 another router can set up a normal message delivery.
21363
21364
21365 The &(autoreply)& transport is usually run as the result of mail filtering, a
21366 &"vacation"& message being the standard example. However, it can also be run
21367 directly from a router like any other transport. To reduce the possibility of
21368 message cascades, messages created by the &(autoreply)& transport always have
21369 empty envelope sender addresses, like bounce messages.
21370
21371 The parameters of the message to be sent can be specified in the configuration
21372 by options described below. However, these are used only when the address
21373 passed to the transport does not contain its own reply information. When the
21374 transport is run as a consequence of a
21375 &%mail%&
21376 or &%vacation%& command in a filter file, the parameters of the message are
21377 supplied by the filter, and passed with the address. The transport's options
21378 that define the message are then ignored (so they are not usually set in this
21379 case). The message is specified entirely by the filter or by the transport; it
21380 is never built from a mixture of options. However, the &%file_optional%&,
21381 &%mode%&, and &%return_message%& options apply in all cases.
21382
21383 &(Autoreply)& is implemented as a local transport. When used as a result of a
21384 command in a user's filter file, &(autoreply)& normally runs under the uid and
21385 gid of the user, and with appropriate current and home directories (see chapter
21386 &<<CHAPenvironment>>&).
21387
21388 There is a subtle difference between routing a message to a &(pipe)& transport
21389 that generates some text to be returned to the sender, and routing it to an
21390 &(autoreply)& transport. This difference is noticeable only if more than one
21391 address from the same message is so handled. In the case of a pipe, the
21392 separate outputs from the different addresses are gathered up and returned to
21393 the sender in a single message, whereas if &(autoreply)& is used, a separate
21394 message is generated for each address that is passed to it.
21395
21396 Non-printing characters are not permitted in the header lines generated for the
21397 message that &(autoreply)& creates, with the exception of newlines that are
21398 immediately followed by white space. If any non-printing characters are found,
21399 the transport defers.
21400 Whether characters with the top bit set count as printing characters or not is
21401 controlled by the &%print_topbitchars%& global option.
21402
21403 If any of the generic options for manipulating headers (for example,
21404 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21405 of the original message that is included in the generated message when
21406 &%return_message%& is set. They do not apply to the generated message itself.
21407
21408 .vindex "&$sender_address$&"
21409 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21410 the message, indicating that there were no recipients, it does not treat this
21411 as an error. This means that autoreplies sent to &$sender_address$& when this
21412 is empty (because the incoming message is a bounce message) do not cause
21413 problems. They are just discarded.
21414
21415
21416
21417 .section "Private options for autoreply" "SECID139"
21418 .cindex "options" "&(autoreply)& transport"
21419
21420 .option bcc autoreply string&!! unset
21421 This specifies the addresses that are to receive &"blind carbon copies"& of the
21422 message when the message is specified by the transport.
21423
21424
21425 .option cc autoreply string&!! unset
21426 This specifies recipients of the message and the contents of the &'Cc:'& header
21427 when the message is specified by the transport.
21428
21429
21430 .option file autoreply string&!! unset
21431 The contents of the file are sent as the body of the message when the message
21432 is specified by the transport. If both &%file%& and &%text%& are set, the text
21433 string comes first.
21434
21435
21436 .option file_expand autoreply boolean false
21437 If this is set, the contents of the file named by the &%file%& option are
21438 subjected to string expansion as they are added to the message.
21439
21440
21441 .option file_optional autoreply boolean false
21442 If this option is true, no error is generated if the file named by the &%file%&
21443 option or passed with the address does not exist or cannot be read.
21444
21445
21446 .option from autoreply string&!! unset
21447 This specifies the contents of the &'From:'& header when the message is
21448 specified by the transport.
21449
21450
21451 .option headers autoreply string&!! unset
21452 This specifies additional RFC 2822 headers that are to be added to the message
21453 when the message is specified by the transport. Several can be given by using
21454 &"\n"& to separate them. There is no check on the format.
21455
21456
21457 .option log autoreply string&!! unset
21458 This option names a file in which a record of every message sent is logged when
21459 the message is specified by the transport.
21460
21461
21462 .option mode autoreply "octal integer" 0600
21463 If either the log file or the &"once"& file has to be created, this mode is
21464 used.
21465
21466
21467 .option never_mail autoreply "address list&!!" unset
21468 If any run of the transport creates a message with a recipient that matches any
21469 item in the list, that recipient is quietly discarded. If all recipients are
21470 discarded, no message is created. This applies both when the recipients are
21471 generated by a filter and when they are specified in the transport.
21472
21473
21474
21475 .option once autoreply string&!! unset
21476 This option names a file or DBM database in which a record of each &'To:'&
21477 recipient is kept when the message is specified by the transport. &*Note*&:
21478 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21479
21480 If &%once%& is unset, or is set to an empty string, the message is always sent.
21481 By default, if &%once%& is set to a non-empty file name, the message
21482 is not sent if a potential recipient is already listed in the database.
21483 However, if the &%once_repeat%& option specifies a time greater than zero, the
21484 message is sent if that much time has elapsed since a message was last sent to
21485 this recipient. A setting of zero time for &%once_repeat%& (the default)
21486 prevents a message from being sent a second time &-- in this case, zero means
21487 infinity.
21488
21489 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21490 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21491 greater than zero, it changes the way Exim implements the &%once%& option.
21492 Instead of using a DBM file to record every recipient it sends to, it uses a
21493 regular file, whose size will never get larger than the given value.
21494
21495 In the file, Exim keeps a linear list of recipient addresses and the times at
21496 which they were sent messages. If the file is full when a new address needs to
21497 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21498 means that a given recipient may receive multiple messages, but at
21499 unpredictable intervals that depend on the rate of turnover of addresses in the
21500 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21501
21502
21503 .option once_file_size autoreply integer 0
21504 See &%once%& above.
21505
21506
21507 .option once_repeat autoreply time&!! 0s
21508 See &%once%& above.
21509 After expansion, the value of this option must be a valid time value.
21510
21511
21512 .option reply_to autoreply string&!! unset
21513 This specifies the contents of the &'Reply-To:'& header when the message is
21514 specified by the transport.
21515
21516
21517 .option return_message autoreply boolean false
21518 If this is set, a copy of the original message is returned with the new
21519 message, subject to the maximum size set in the &%return_size_limit%& global
21520 configuration option.
21521
21522
21523 .option subject autoreply string&!! unset
21524 This specifies the contents of the &'Subject:'& header when the message is
21525 specified by the transport. It is tempting to quote the original subject in
21526 automatic responses. For example:
21527 .code
21528 subject = Re: $h_subject:
21529 .endd
21530 There is a danger in doing this, however. It may allow a third party to
21531 subscribe your users to an opt-in mailing list, provided that the list accepts
21532 bounce messages as subscription confirmations. Well-managed lists require a
21533 non-bounce message to confirm a subscription, so the danger is relatively
21534 small.
21535
21536
21537
21538 .option text autoreply string&!! unset
21539 This specifies a single string to be used as the body of the message when the
21540 message is specified by the transport. If both &%text%& and &%file%& are set,
21541 the text comes first.
21542
21543
21544 .option to autoreply string&!! unset
21545 This specifies recipients of the message and the contents of the &'To:'& header
21546 when the message is specified by the transport.
21547 .ecindex IIDauttra1
21548 .ecindex IIDauttra2
21549
21550
21551
21552
21553 . ////////////////////////////////////////////////////////////////////////////
21554 . ////////////////////////////////////////////////////////////////////////////
21555
21556 .chapter "The lmtp transport" "CHAPLMTP"
21557 .cindex "transports" "&(lmtp)&"
21558 .cindex "&(lmtp)& transport"
21559 .cindex "LMTP" "over a pipe"
21560 .cindex "LMTP" "over a socket"
21561 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21562 specified command
21563 or by interacting with a Unix domain socket.
21564 This transport is something of a cross between the &(pipe)& and &(smtp)&
21565 transports. Exim also has support for using LMTP over TCP/IP; this is
21566 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21567 to be of minority interest, the default build-time configure in &_src/EDITME_&
21568 has it commented out. You need to ensure that
21569 .code
21570 TRANSPORT_LMTP=yes
21571 .endd
21572 .cindex "options" "&(lmtp)& transport"
21573 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21574 included in the Exim binary. The private options of the &(lmtp)& transport are
21575 as follows:
21576
21577 .option batch_id lmtp string&!! unset
21578 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21579
21580
21581 .option batch_max lmtp integer 1
21582 This limits the number of addresses that can be handled in a single delivery.
21583 Most LMTP servers can handle several addresses at once, so it is normally a
21584 good idea to increase this value. See the description of local delivery
21585 batching in chapter &<<CHAPbatching>>&.
21586
21587
21588 .option command lmtp string&!! unset
21589 This option must be set if &%socket%& is not set. The string is a command which
21590 is run in a separate process. It is split up into a command name and list of
21591 arguments, each of which is separately expanded (so expansion cannot change the
21592 number of arguments). The command is run directly, not via a shell. The message
21593 is passed to the new process using the standard input and output to operate the
21594 LMTP protocol.
21595
21596 .option ignore_quota lmtp boolean false
21597 .cindex "LMTP" "ignoring quota errors"
21598 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21599 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21600 in its response to the LHLO command.
21601
21602 .option socket lmtp string&!! unset
21603 This option must be set if &%command%& is not set. The result of expansion must
21604 be the name of a Unix domain socket. The transport connects to the socket and
21605 delivers the message to it using the LMTP protocol.
21606
21607
21608 .option timeout lmtp time 5m
21609 The transport is aborted if the created process or Unix domain socket does not
21610 respond to LMTP commands or message input within this timeout. Delivery
21611 is deferred, and will be tried again later. Here is an example of a typical
21612 LMTP transport:
21613 .code
21614 lmtp:
21615   driver = lmtp
21616   command = /some/local/lmtp/delivery/program
21617   batch_max = 20
21618   user = exim
21619 .endd
21620 This delivers up to 20 addresses at a time, in a mixture of domains if
21621 necessary, running as the user &'exim'&.
21622
21623
21624
21625 . ////////////////////////////////////////////////////////////////////////////
21626 . ////////////////////////////////////////////////////////////////////////////
21627
21628 .chapter "The pipe transport" "CHAPpipetransport"
21629 .scindex IIDpiptra1 "transports" "&(pipe)&"
21630 .scindex IIDpiptra2 "&(pipe)& transport"
21631 The &(pipe)& transport is used to deliver messages via a pipe to a command
21632 running in another process. One example is the use of &(pipe)& as a
21633 pseudo-remote transport for passing messages to some other delivery mechanism
21634 (such as UUCP). Another is the use by individual users to automatically process
21635 their incoming messages. The &(pipe)& transport can be used in one of the
21636 following ways:
21637
21638 .ilist
21639 .vindex "&$local_part$&"
21640 A router routes one address to a transport in the normal way, and the
21641 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21642 contains the local part of the address (as usual), and the command that is run
21643 is specified by the &%command%& option on the transport.
21644 .next
21645 .vindex "&$pipe_addresses$&"
21646 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21647 transport can handle more than one address in a single run. In this case, when
21648 more than one address is routed to the transport, &$local_part$& is not set
21649 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21650 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21651 that are routed to the transport.
21652 .next
21653 .vindex "&$address_pipe$&"
21654 A router redirects an address directly to a pipe command (for example, from an
21655 alias or forward file). In this case, &$address_pipe$& contains the text of the
21656 pipe command, and the &%command%& option on the transport is ignored unless
21657 &%force_command%& is set. If only one address is being transported
21658 (&%batch_max%& is not greater than one, or only one address was redirected to
21659 this pipe command), &$local_part$& contains the local part that was redirected.
21660 .endlist
21661
21662
21663 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21664 deliver messages over pipes using the LMTP interactive protocol. This is
21665 implemented by the &(lmtp)& transport.
21666
21667 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21668 &_.forward_& file, the command runs under the uid and gid of that user. In
21669 other cases, the uid and gid have to be specified explicitly, either on the
21670 transport or on the router that handles the address. Current and &"home"&
21671 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21672 details of the local delivery environment and chapter &<<CHAPbatching>>&
21673 for a discussion of local delivery batching.
21674
21675
21676 .section "Concurrent delivery" "SECID140"
21677 If two messages arrive at almost the same time, and both are routed to a pipe
21678 delivery, the two pipe transports may be run concurrently. You must ensure that
21679 any pipe commands you set up are robust against this happening. If the commands
21680 write to a file, the &%exim_lock%& utility might be of use.
21681
21682
21683
21684
21685 .section "Returned status and data" "SECID141"
21686 .cindex "&(pipe)& transport" "returned data"
21687 If the command exits with a non-zero return code, the delivery is deemed to
21688 have failed, unless either the &%ignore_status%& option is set (in which case
21689 the return code is treated as zero), or the return code is one of those listed
21690 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21691 later"&. In this case, delivery is deferred. Details of a permanent failure are
21692 logged, but are not included in the bounce message, which merely contains
21693 &"local delivery failed"&.
21694
21695 If the command exits on a signal and the &%freeze_signal%& option is set then
21696 the message will be frozen in the queue. If that option is not set, a bounce
21697 will be sent as normal.
21698
21699 If the return code is greater than 128 and the command being run is a shell
21700 script, it normally means that the script was terminated by a signal whose
21701 value is the return code minus 128. The &%freeze_signal%& option does not
21702 apply in this case.
21703
21704 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21705 return code is set to 127. This is the value that a shell returns if it is
21706 asked to run a non-existent command. The wording for the log line suggests that
21707 a non-existent command may be the problem.
21708
21709 The &%return_output%& option can affect the result of a pipe delivery. If it is
21710 set and the command produces any output on its standard output or standard
21711 error streams, the command is considered to have failed, even if it gave a zero
21712 return code or if &%ignore_status%& is set. The output from the command is
21713 included as part of the bounce message. The &%return_fail_output%& option is
21714 similar, except that output is returned only when the command exits with a
21715 failure return code, that is, a value other than zero or a code that matches
21716 &%temp_errors%&.
21717
21718
21719
21720 .section "How the command is run" "SECThowcommandrun"
21721 .cindex "&(pipe)& transport" "path for command"
21722 The command line is (by default) broken down into a command name and arguments
21723 by the &(pipe)& transport itself. The &%allow_commands%& and
21724 &%restrict_to_path%& options can be used to restrict the commands that may be
21725 run.
21726
21727 .cindex "quoting" "in pipe command"
21728 Unquoted arguments are delimited by white space. If an argument appears in
21729 double quotes, backslash is interpreted as an escape character in the usual
21730 way. If an argument appears in single quotes, no escaping is done.
21731
21732 String expansion is applied to the command line except when it comes from a
21733 traditional &_.forward_& file (commands from a filter file are expanded). The
21734 expansion is applied to each argument in turn rather than to the whole line.
21735 For this reason, any string expansion item that contains white space must be
21736 quoted so as to be contained within a single argument. A setting such as
21737 .code
21738 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21739 .endd
21740 will not work, because the expansion item gets split between several
21741 arguments. You have to write
21742 .code
21743 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21744 .endd
21745 to ensure that it is all in one argument. The expansion is done in this way,
21746 argument by argument, so that the number of arguments cannot be changed as a
21747 result of expansion, and quotes or backslashes in inserted variables do not
21748 interact with external quoting. However, this leads to problems if you want to
21749 generate multiple arguments (or the command name plus arguments) from a single
21750 expansion. In this situation, the simplest solution is to use a shell. For
21751 example:
21752 .code
21753 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21754 .endd
21755
21756 .cindex "transport" "filter"
21757 .cindex "filter" "transport filter"
21758 .vindex "&$pipe_addresses$&"
21759 Special handling takes place when an argument consists of precisely the text
21760 &`$pipe_addresses`&. This is not a general expansion variable; the only
21761 place this string is recognized is when it appears as an argument for a pipe or
21762 transport filter command. It causes each address that is being handled to be
21763 inserted in the argument list at that point &'as a separate argument'&. This
21764 avoids any problems with spaces or shell metacharacters, and is of use when a
21765 &(pipe)& transport is handling groups of addresses in a batch.
21766
21767 If &%force_command%& is enabled on the transport, Special handling takes place
21768 for an argument that consists of precisely the text &`$address_pipe`&.  It
21769 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
21770 argument is inserted in the argument list at that point
21771 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
21772 the only item in the argument; in fact, if it were then &%force_command%&
21773 should behave as a no-op.  Rather, it should be used to adjust the command
21774 run while preserving the argument vector separation.
21775
21776 After splitting up into arguments and expansion, the resulting command is run
21777 in a subprocess directly from the transport, &'not'& under a shell. The
21778 message that is being delivered is supplied on the standard input, and the
21779 standard output and standard error are both connected to a single pipe that is
21780 read by Exim. The &%max_output%& option controls how much output the command
21781 may produce, and the &%return_output%& and &%return_fail_output%& options
21782 control what is done with it.
21783
21784 Not running the command under a shell (by default) lessens the security risks
21785 in cases when a command from a user's filter file is built out of data that was
21786 taken from an incoming message. If a shell is required, it can of course be
21787 explicitly specified as the command to be run. However, there are circumstances
21788 where existing commands (for example, in &_.forward_& files) expect to be run
21789 under a shell and cannot easily be modified. To allow for these cases, there is
21790 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21791 works. Instead of breaking up the command line as just described, it expands it
21792 as a single string and passes the result to &_/bin/sh_&. The
21793 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21794 with &%use_shell%&, and the whole mechanism is inherently less secure.
21795
21796
21797
21798 .section "Environment variables" "SECTpipeenv"
21799 .cindex "&(pipe)& transport" "environment for command"
21800 .cindex "environment for pipe transport"
21801 The environment variables listed below are set up when the command is invoked.
21802 This list is a compromise for maximum compatibility with other MTAs. Note that
21803 the &%environment%& option can be used to add additional variables to this
21804 environment.
21805 .display
21806 &`DOMAIN            `&   the domain of the address
21807 &`HOME              `&   the home directory, if set
21808 &`HOST              `&   the host name when called from a router (see below)
21809 &`LOCAL_PART        `&   see below
21810 &`LOCAL_PART_PREFIX `&   see below
21811 &`LOCAL_PART_SUFFIX `&   see below
21812 &`LOGNAME           `&   see below
21813 &`MESSAGE_ID        `&   Exim's local ID for the message
21814 &`PATH              `&   as specified by the &%path%& option below
21815 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21816 &`RECIPIENT         `&   the complete recipient address
21817 &`SENDER            `&   the sender of the message (empty if a bounce)
21818 &`SHELL             `&   &`/bin/sh`&
21819 &`TZ                `&   the value of the &%timezone%& option, if set
21820 &`USER              `&   see below
21821 .endd
21822 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21823 router, LOCAL_PART is set to the local part of the address. When it is
21824 called as a result of a forward or alias expansion, LOCAL_PART is set to
21825 the local part of the address that was expanded. In both cases, any affixes are
21826 removed from the local part, and made available in LOCAL_PART_PREFIX and
21827 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21828 same value as LOCAL_PART for compatibility with other MTAs.
21829
21830 .cindex "HOST"
21831 HOST is set only when a &(pipe)& transport is called from a router that
21832 associates hosts with an address, typically when using &(pipe)& as a
21833 pseudo-remote transport. HOST is set to the first host name specified by
21834 the router.
21835
21836 .cindex "HOME"
21837 If the transport's generic &%home_directory%& option is set, its value is used
21838 for the HOME environment variable. Otherwise, a home directory may be set
21839 by the router's &%transport_home_directory%& option, which defaults to the
21840 user's home directory if &%check_local_user%& is set.
21841
21842
21843 .section "Private options for pipe" "SECID142"
21844 .cindex "options" "&(pipe)& transport"
21845
21846
21847
21848 .option allow_commands pipe "string list&!!" unset
21849 .cindex "&(pipe)& transport" "permitted commands"
21850 The string is expanded, and is then interpreted as a colon-separated list of
21851 permitted commands. If &%restrict_to_path%& is not set, the only commands
21852 permitted are those in the &%allow_commands%& list. They need not be absolute
21853 paths; the &%path%& option is still used for relative paths. If
21854 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21855 in the &%allow_commands%& list, or a name without any slashes that is found on
21856 the path. In other words, if neither &%allow_commands%& nor
21857 &%restrict_to_path%& is set, there is no restriction on the command, but
21858 otherwise only commands that are permitted by one or the other are allowed. For
21859 example, if
21860 .code
21861 allow_commands = /usr/bin/vacation
21862 .endd
21863 and &%restrict_to_path%& is not set, the only permitted command is
21864 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21865 &%use_shell%& is set.
21866
21867
21868 .option batch_id pipe string&!! unset
21869 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21870
21871
21872 .option batch_max pipe integer 1
21873 This limits the number of addresses that can be handled in a single delivery.
21874 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21875
21876
21877 .option check_string pipe string unset
21878 As &(pipe)& writes the message, the start of each line is tested for matching
21879 &%check_string%&, and if it does, the initial matching characters are replaced
21880 by the contents of &%escape_string%&, provided both are set. The value of
21881 &%check_string%& is a literal string, not a regular expression, and the case of
21882 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21883 of &%check_string%& and &%escape_string%& are forced to values that implement
21884 the SMTP escaping protocol. Any settings made in the configuration file are
21885 ignored.
21886
21887
21888 .option command pipe string&!! unset
21889 This option need not be set when &(pipe)& is being used to deliver to pipes
21890 obtained directly from address redirections. In other cases, the option must be
21891 set, to provide a command to be run. It need not yield an absolute path (see
21892 the &%path%& option below). The command is split up into separate arguments by
21893 Exim, and each argument is separately expanded, as described in section
21894 &<<SECThowcommandrun>>& above.
21895
21896
21897 .option environment pipe string&!! unset
21898 .cindex "&(pipe)& transport" "environment for command"
21899 .cindex "environment for &(pipe)& transport"
21900 This option is used to add additional variables to the environment in which the
21901 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21902 a string which is expanded, and then interpreted as a colon-separated list of
21903 environment settings of the form <&'name'&>=<&'value'&>.
21904
21905
21906 .option escape_string pipe string unset
21907 See &%check_string%& above.
21908
21909
21910 .option freeze_exec_fail pipe boolean false
21911 .cindex "exec failure"
21912 .cindex "failure of exec"
21913 .cindex "&(pipe)& transport" "failure of exec"
21914 Failure to exec the command in a pipe transport is by default treated like
21915 any other failure while running the command. However, if &%freeze_exec_fail%&
21916 is set, failure to exec is treated specially, and causes the message to be
21917 frozen, whatever the setting of &%ignore_status%&.
21918
21919
21920 .option freeze_signal pipe boolean false
21921 .cindex "signal exit"
21922 .cindex "&(pipe)& transport", "signal exit"
21923 Normally if the process run by a command in a pipe transport exits on a signal,
21924 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21925 frozen in Exim's queue instead.
21926
21927
21928 .option force_command pipe boolean false
21929 .cindex "force command"
21930 .cindex "&(pipe)& transport", "force command"
21931 Normally when a router redirects an address directly to a pipe command
21932 the &%command%& option on the transport is ignored.  If &%force_command%&
21933 is set, the &%command%& option will used. This is especially
21934 useful for forcing a wrapper or additional argument to be added to the
21935 command. For example:
21936 .code
21937 command = /usr/bin/remote_exec myhost -- $address_pipe
21938 force_command
21939 .endd
21940
21941 Note that &$address_pipe$& is handled specially in &%command%& when
21942 &%force_command%& is set, expanding out to the original argument vector as
21943 separate items, similarly to a Unix shell &`"$@"`& construct.
21944
21945 .option ignore_status pipe boolean false
21946 If this option is true, the status returned by the subprocess that is set up to
21947 run the command is ignored, and Exim behaves as if zero had been returned.
21948 Otherwise, a non-zero status or termination by signal causes an error return
21949 from the transport unless the status value is one of those listed in
21950 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21951
21952 &*Note*&: This option does not apply to timeouts, which do not return a status.
21953 See the &%timeout_defer%& option for how timeouts are handled.
21954
21955 .option log_defer_output pipe boolean false
21956 .cindex "&(pipe)& transport" "logging output"
21957 If this option is set, and the status returned by the command is
21958 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21959 and any output was produced, the first line of it is written to the main log.
21960
21961
21962 .option log_fail_output pipe boolean false
21963 If this option is set, and the command returns any output, and also ends with a
21964 return code that is neither zero nor one of the return codes listed in
21965 &%temp_errors%& (that is, the delivery failed), the first line of output is
21966 written to the main log. This option and &%log_output%& are mutually exclusive.
21967 Only one of them may be set.
21968
21969
21970
21971 .option log_output pipe boolean false
21972 If this option is set and the command returns any output, the first line of
21973 output is written to the main log, whatever the return code. This option and
21974 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21975
21976
21977
21978 .option max_output pipe integer 20K
21979 This specifies the maximum amount of output that the command may produce on its
21980 standard output and standard error file combined. If the limit is exceeded, the
21981 process running the command is killed. This is intended as a safety measure to
21982 catch runaway processes. The limit is applied independently of the settings of
21983 the options that control what is done with such output (for example,
21984 &%return_output%&). Because of buffering effects, the amount of output may
21985 exceed the limit by a small amount before Exim notices.
21986
21987
21988 .option message_prefix pipe string&!! "see below"
21989 The string specified here is expanded and output at the start of every message.
21990 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21991 .code
21992 message_prefix = \
21993   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21994   ${tod_bsdinbox}\n
21995 .endd
21996 .cindex "Cyrus"
21997 .cindex "&%tmail%&"
21998 .cindex "&""From""& line"
21999 This is required by the commonly used &_/usr/bin/vacation_& program.
22000 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22001 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22002 setting
22003 .code
22004 message_prefix =
22005 .endd
22006 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22007 &`\n`& to &`\r\n`& in &%message_prefix%&.
22008
22009
22010 .option message_suffix pipe string&!! "see below"
22011 The string specified here is expanded and output at the end of every message.
22012 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22013 The suffix can be suppressed by setting
22014 .code
22015 message_suffix =
22016 .endd
22017 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22018 &`\n`& to &`\r\n`& in &%message_suffix%&.
22019
22020
22021 .option path pipe string "see below"
22022 This option specifies the string that is set up in the PATH environment
22023 variable of the subprocess. The default is:
22024 .code
22025 /bin:/usr/bin
22026 .endd
22027 If the &%command%& option does not yield an absolute path name, the command is
22028 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22029 apply to a command specified as a transport filter.
22030
22031
22032 .option permit_coredump pipe boolean false
22033 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22034 a core-dump of a pipe command, enable this command.  This enables core-dumps
22035 during delivery and affects both the Exim binary and the pipe command run.
22036 It is recommended that this option remain off unless and until you have a need
22037 for it and that this only be enabled when needed, as the risk of excessive
22038 resource consumption can be quite high.  Note also that Exim is typically
22039 installed as a setuid binary and most operating systems will inhibit coredumps
22040 of these by default, so further OS-specific action may be required.
22041
22042
22043 .option pipe_as_creator pipe boolean false
22044 .cindex "uid (user id)" "local delivery"
22045 If the generic &%user%& option is not set and this option is true, the delivery
22046 process is run under the uid that was in force when Exim was originally called
22047 to accept the message. If the group id is not otherwise set (via the generic
22048 &%group%& option), the gid that was in force when Exim was originally called to
22049 accept the message is used.
22050
22051
22052 .option restrict_to_path pipe boolean false
22053 When this option is set, any command name not listed in &%allow_commands%& must
22054 contain no slashes. The command is searched for only in the directories listed
22055 in the &%path%& option. This option is intended for use in the case when a pipe
22056 command has been generated from a user's &_.forward_& file. This is usually
22057 handled by a &(pipe)& transport called &%address_pipe%&.
22058
22059
22060 .option return_fail_output pipe boolean false
22061 If this option is true, and the command produced any output and ended with a
22062 return code other than zero or one of the codes listed in &%temp_errors%& (that
22063 is, the delivery failed), the output is returned in the bounce message.
22064 However, if the message has a null sender (that is, it is itself a bounce
22065 message), output from the command is discarded. This option and
22066 &%return_output%& are mutually exclusive. Only one of them may be set.
22067
22068
22069
22070 .option return_output pipe boolean false
22071 If this option is true, and the command produced any output, the delivery is
22072 deemed to have failed whatever the return code from the command, and the output
22073 is returned in the bounce message. Otherwise, the output is just discarded.
22074 However, if the message has a null sender (that is, it is a bounce message),
22075 output from the command is always discarded, whatever the setting of this
22076 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22077 of them may be set.
22078
22079
22080
22081 .option temp_errors pipe "string list" "see below"
22082 .cindex "&(pipe)& transport" "temporary failure"
22083 This option contains either a colon-separated list of numbers, or a single
22084 asterisk. If &%ignore_status%& is false
22085 and &%return_output%& is not set,
22086 and the command exits with a non-zero return code, the failure is treated as
22087 temporary and the delivery is deferred if the return code matches one of the
22088 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22089 codes are treated as permanent errors. The default setting contains the codes
22090 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22091 compiled on a system that does not define these macros, it assumes values of 75
22092 and 73, respectively.
22093
22094
22095 .option timeout pipe time 1h
22096 If the command fails to complete within this time, it is killed. This normally
22097 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22098 specifies no timeout. In order to ensure that any subprocesses created by the
22099 command are also killed, Exim makes the initial process a process group leader,
22100 and kills the whole process group on a timeout. However, this can be defeated
22101 if one of the processes starts a new process group.
22102
22103 .option timeout_defer pipe boolean false
22104 A timeout in a &(pipe)& transport, either in the command that the transport
22105 runs, or in a transport filter that is associated with it, is by default
22106 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22107 is set true, both kinds of timeout become temporary errors, causing the
22108 delivery to be deferred.
22109
22110 .option umask pipe "octal integer" 022
22111 This specifies the umask setting for the subprocess that runs the command.
22112
22113
22114 .option use_bsmtp pipe boolean false
22115 .cindex "envelope sender"
22116 If this option is set true, the &(pipe)& transport writes messages in &"batch
22117 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22118 commands. If you want to include a leading HELO command with such messages,
22119 you can do so by setting the &%message_prefix%& option. See section
22120 &<<SECTbatchSMTP>>& for details of batch SMTP.
22121
22122 .option use_classresources pipe boolean false
22123 .cindex "class resources (BSD)"
22124 This option is available only when Exim is running on FreeBSD, NetBSD, or
22125 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22126 resource limits when a &(pipe)& transport is run to perform a delivery. The
22127 limits for the uid under which the pipe is to run are obtained from the login
22128 class database.
22129
22130
22131 .option use_crlf pipe boolean false
22132 .cindex "carriage return"
22133 .cindex "linefeed"
22134 This option causes lines to be terminated with the two-character CRLF sequence
22135 (carriage return, linefeed) instead of just a linefeed character. In the case
22136 of batched SMTP, the byte sequence written to the pipe is then an exact image
22137 of what would be sent down a real SMTP connection.
22138
22139 The contents of the &%message_prefix%& and &%message_suffix%& options are
22140 written verbatim, so must contain their own carriage return characters if these
22141 are needed. When &%use_bsmtp%& is not set, the default values for both
22142 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22143 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22144
22145
22146 .option use_shell pipe boolean false
22147 .vindex "&$pipe_addresses$&"
22148 If this option is set, it causes the command to be passed to &_/bin/sh_&
22149 instead of being run directly from the transport, as described in section
22150 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22151 where the command is expected to be run under a shell and cannot easily be
22152 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22153 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22154 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22155 its &%-c%& option.
22156
22157
22158
22159 .section "Using an external local delivery agent" "SECID143"
22160 .cindex "local delivery" "using an external agent"
22161 .cindex "&'procmail'&"
22162 .cindex "external local delivery"
22163 .cindex "delivery" "&'procmail'&"
22164 .cindex "delivery" "by external agent"
22165 The &(pipe)& transport can be used to pass all messages that require local
22166 delivery to a separate local delivery agent such as &%procmail%&. When doing
22167 this, care must be taken to ensure that the pipe is run under an appropriate
22168 uid and gid. In some configurations one wants this to be a uid that is trusted
22169 by the delivery agent to supply the correct sender of the message. It may be
22170 necessary to recompile or reconfigure the delivery agent so that it trusts an
22171 appropriate user. The following is an example transport and router
22172 configuration for &%procmail%&:
22173 .code
22174 # transport
22175 procmail_pipe:
22176   driver = pipe
22177   command = /usr/local/bin/procmail -d $local_part
22178   return_path_add
22179   delivery_date_add
22180   envelope_to_add
22181   check_string = "From "
22182   escape_string = ">From "
22183   umask = 077
22184   user = $local_part
22185   group = mail
22186
22187 # router
22188 procmail:
22189   driver = accept
22190   check_local_user
22191   transport = procmail_pipe
22192 .endd
22193 In this example, the pipe is run as the local user, but with the group set to
22194 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22195 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22196 user to supply a correct sender address. If you do not specify either a
22197 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22198 home directory is the user's home directory by default.
22199
22200 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22201 .code
22202 IFS=" "
22203 .endd
22204 as shown in some &%procmail%& documentation, because Exim does not by default
22205 use a shell to run pipe commands.
22206
22207 .cindex "Cyrus"
22208 The next example shows a transport and a router for a system where local
22209 deliveries are handled by the Cyrus IMAP server.
22210 .code
22211 # transport
22212 local_delivery_cyrus:
22213   driver = pipe
22214   command = /usr/cyrus/bin/deliver \
22215             -m ${substr_1:$local_part_suffix} -- $local_part
22216   user = cyrus
22217   group = mail
22218   return_output
22219   log_output
22220   message_prefix =
22221   message_suffix =
22222
22223 # router
22224 local_user_cyrus:
22225   driver = accept
22226   check_local_user
22227   local_part_suffix = .*
22228   transport = local_delivery_cyrus
22229 .endd
22230 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22231 &%return_output%& to cause any text written by Cyrus to be returned to the
22232 sender.
22233 .ecindex IIDpiptra1
22234 .ecindex IIDpiptra2
22235
22236
22237 . ////////////////////////////////////////////////////////////////////////////
22238 . ////////////////////////////////////////////////////////////////////////////
22239
22240 .chapter "The smtp transport" "CHAPsmtptrans"
22241 .scindex IIDsmttra1 "transports" "&(smtp)&"
22242 .scindex IIDsmttra2 "&(smtp)& transport"
22243 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22244 or LMTP protocol. The list of hosts to try can either be taken from the address
22245 that is being processed (having been set up by the router), or specified
22246 explicitly for the transport. Timeout and retry processing (see chapter
22247 &<<CHAPretry>>&) is applied to each IP address independently.
22248
22249
22250 .section "Multiple messages on a single connection" "SECID144"
22251 The sending of multiple messages over a single TCP/IP connection can arise in
22252 two ways:
22253
22254 .ilist
22255 If a message contains more than &%max_rcpt%& (see below) addresses that are
22256 routed to the same host, more than one copy of the message has to be sent to
22257 that host. In this situation, multiple copies may be sent in a single run of
22258 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22259 does when it has too many addresses to send in one message also depends on the
22260 value of the global &%remote_max_parallel%& option. Details are given in
22261 section &<<SECToutSMTPTCP>>&.)
22262 .next
22263 .cindex "hints database" "remembering routing"
22264 When a message has been successfully delivered over a TCP/IP connection, Exim
22265 looks in its hints database to see if there are any other messages awaiting a
22266 connection to the same host. If there are, a new delivery process is started
22267 for one of them, and the current TCP/IP connection is passed on to it. The new
22268 process may in turn send multiple copies and possibly create yet another
22269 process.
22270 .endlist
22271
22272
22273 For each copy sent over the same TCP/IP connection, a sequence counter is
22274 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22275 no further messages are sent over that connection.
22276
22277
22278
22279 .section "Use of the $host and $host_address variables" "SECID145"
22280 .vindex "&$host$&"
22281 .vindex "&$host_address$&"
22282 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22283 &$host_address$& are the name and IP address of the first host on the host list
22284 passed by the router. However, when the transport is about to connect to a
22285 specific host, and while it is connected to that host, &$host$& and
22286 &$host_address$& are set to the values for that host. These are the values
22287 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22288 &%serialize_hosts%&, and the various TLS options are expanded.
22289
22290
22291 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22292 .vindex &$tls_bits$&
22293 .vindex &$tls_cipher$&
22294 .vindex &$tls_peerdn$&
22295 .vindex &$tls_sni$&
22296 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22297 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22298 are the values that were set when the message was received.
22299 These are the values that are used for options that are expanded before any
22300 SMTP connections are made. Just before each connection is made, these four
22301 variables are emptied. If TLS is subsequently started, they are set to the
22302 appropriate values for the outgoing connection, and these are the values that
22303 are in force when any authenticators are run and when the
22304 &%authenticated_sender%& option is expanded.
22305
22306 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22307 and will be removed in a future release.
22308
22309
22310 .section "Private options for smtp" "SECID146"
22311 .cindex "options" "&(smtp)& transport"
22312 The private options of the &(smtp)& transport are as follows:
22313
22314
22315 .option address_retry_include_sender smtp boolean true
22316 .cindex "4&'xx'& responses" "retrying after"
22317 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22318 is the combination of sender and recipient that is delayed in subsequent queue
22319 runs until the retry time is reached. You can delay the recipient without
22320 reference to the sender (which is what earlier versions of Exim did), by
22321 setting &%address_retry_include_sender%& false. However, this can lead to
22322 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22323
22324 .option allow_localhost smtp boolean false
22325 .cindex "local host" "sending to"
22326 .cindex "fallback" "hosts specified on transport"
22327 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22328 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22329 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22330 the delivery anyway. This should be used only in special cases when the
22331 configuration ensures that no looping will result (for example, a differently
22332 configured Exim is listening on the port to which the message is sent).
22333
22334
22335 .option authenticated_sender smtp string&!! unset
22336 .cindex "Cyrus"
22337 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22338 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22339 overriding any existing authenticated sender value. If the string expansion is
22340 forced to fail, the option is ignored. Other expansion failures cause delivery
22341 to be deferred. If the result of expansion is an empty string, that is also
22342 ignored.
22343
22344 The expansion happens after the outgoing connection has been made and TLS
22345 started, if required. This means that the &$host$&, &$host_address$&,
22346 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22347 particular connection.
22348
22349 If the SMTP session is not authenticated, the expansion of
22350 &%authenticated_sender%& still happens (and can cause the delivery to be
22351 deferred if it fails), but no AUTH= item is added to MAIL commands
22352 unless &%authenticated_sender_force%& is true.
22353
22354 This option allows you to use the &(smtp)& transport in LMTP mode to
22355 deliver mail to Cyrus IMAP and provide the proper local part as the
22356 &"authenticated sender"&, via a setting such as:
22357 .code
22358 authenticated_sender = $local_part
22359 .endd
22360 This removes the need for IMAP subfolders to be assigned special ACLs to
22361 allow direct delivery to those subfolders.
22362
22363 Because of expected uses such as that just described for Cyrus (when no
22364 domain is involved), there is no checking on the syntax of the provided
22365 value.
22366
22367
22368 .option authenticated_sender_force smtp boolean false
22369 If this option is set true, the &%authenticated_sender%& option's value
22370 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22371 authenticated as a client.
22372
22373
22374 .option command_timeout smtp time 5m
22375 This sets a timeout for receiving a response to an SMTP command that has been
22376 sent out. It is also used when waiting for the initial banner line from the
22377 remote host. Its value must not be zero.
22378
22379
22380 .option connect_timeout smtp time 5m
22381 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22382 to a remote host. A setting of zero allows the system timeout (typically
22383 several minutes) to act. To have any effect, the value of this option must be
22384 less than the system timeout. However, it has been observed that on some
22385 systems there is no system timeout, which is why the default value for this
22386 option is 5 minutes, a value recommended by RFC 1123.
22387
22388
22389 .option connection_max_messages smtp integer 500
22390 .cindex "SMTP" "passed connection"
22391 .cindex "SMTP" "multiple deliveries"
22392 .cindex "multiple SMTP deliveries"
22393 This controls the maximum number of separate message deliveries that are sent
22394 over a single TCP/IP connection. If the value is zero, there is no limit.
22395 For testing purposes, this value can be overridden by the &%-oB%& command line
22396 option.
22397
22398
22399 .option data_timeout smtp time 5m
22400 This sets a timeout for the transmission of each block in the data portion of
22401 the message. As a result, the overall timeout for a message depends on the size
22402 of the message. Its value must not be zero. See also &%final_timeout%&.
22403
22404
22405 .option delay_after_cutoff smtp boolean true
22406 This option controls what happens when all remote IP addresses for a given
22407 domain have been inaccessible for so long that they have passed their retry
22408 cutoff times.
22409
22410 In the default state, if the next retry time has not been reached for any of
22411 them, the address is bounced without trying any deliveries. In other words,
22412 Exim delays retrying an IP address after the final cutoff time until a new
22413 retry time is reached, and can therefore bounce an address without ever trying
22414 a delivery, when machines have been down for a long time. Some people are
22415 unhappy at this prospect, so...
22416
22417 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22418 addresses are past their final cutoff time, Exim tries to deliver to those
22419 IP addresses that have not been tried since the message arrived. If there are
22420 none, of if they all fail, the address is bounced. In other words, it does not
22421 delay when a new message arrives, but immediately tries those expired IP
22422 addresses that haven't been tried since the message arrived. If there is a
22423 continuous stream of messages for the dead hosts, unsetting
22424 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22425 to them.
22426
22427
22428 .option dns_qualify_single smtp boolean true
22429 If the &%hosts%& or &%fallback_hosts%& option is being used,
22430 and the &%gethostbyname%& option is false,
22431 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22432 in chapter &<<CHAPdnslookup>>& for more details.
22433
22434
22435 .option dns_search_parents smtp boolean false
22436 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22437 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22438 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22439 details.
22440
22441
22442 .new
22443 .option dscp smtp string&!! unset
22444 .cindex "DCSP" "outbound"
22445 This option causes the DSCP value associated with a socket to be set to one
22446 of a number of fixed strings or to numeric value.
22447 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22448 Common values include &`throughput`&, &`mincost`&, and on newer systems
22449 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22450
22451 The outbound packets from Exim will be marked with this value in the header
22452 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22453 that these values will have any effect, not be stripped by networking
22454 equipment, or do much of anything without cooperation with your Network
22455 Engineer and those of all network operators between the source and destination.
22456 .wen
22457
22458
22459 .option fallback_hosts smtp "string list" unset
22460 .cindex "fallback" "hosts specified on transport"
22461 String expansion is not applied to this option. The argument must be a
22462 colon-separated list of host names or IP addresses, optionally also including
22463 port numbers, though the separator can be changed, as described in section
22464 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22465 item in a &%route_list%& setting for the &(manualroute)& router, as described
22466 in section &<<SECTformatonehostitem>>&.
22467
22468 Fallback hosts can also be specified on routers, which associate them with the
22469 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22470 &%fallback_hosts%& specified on the transport is used only if the address does
22471 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22472 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22473 However, &%hosts_randomize%& does apply to fallback host lists.
22474
22475 If Exim is unable to deliver to any of the hosts for a particular address, and
22476 the errors are not permanent rejections, the address is put on a separate
22477 transport queue with its host list replaced by the fallback hosts, unless the
22478 address was routed via MX records and the current host was in the original MX
22479 list. In that situation, the fallback host list is not used.
22480
22481 Once normal deliveries are complete, the fallback queue is delivered by
22482 re-running the same transports with the new host lists. If several failing
22483 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22484 copy of the message is sent.
22485
22486 The resolution of the host names on the fallback list is controlled by the
22487 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22488 both to cases when the host list comes with the address and when it is taken
22489 from &%hosts%&. This option provides a &"use a smart host only if delivery
22490 fails"& facility.
22491
22492
22493 .option final_timeout smtp time 10m
22494 This is the timeout that applies while waiting for the response to the final
22495 line containing just &"."& that terminates a message. Its value must not be
22496 zero.
22497
22498 .option gethostbyname smtp boolean false
22499 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22500 being used, names are looked up using &[gethostbyname()]&
22501 (or &[getipnodebyname()]& when available)
22502 instead of using the DNS. Of course, that function may in fact use the DNS, but
22503 it may also consult other sources of information such as &_/etc/hosts_&.
22504
22505 .option gnutls_compat_mode smtp boolean unset
22506 This option controls whether GnuTLS is used in compatibility mode in an Exim
22507 server. This reduces security slightly, but improves interworking with older
22508 implementations of TLS.
22509
22510 .option helo_data smtp string&!! "see below"
22511 .cindex "HELO" "argument, setting"
22512 .cindex "EHLO" "argument, setting"
22513 .cindex "LHLO argument setting"
22514 The value of this option is expanded after a connection to a another host has
22515 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22516 command that starts the outgoing SMTP or LMTP session. The default value of the
22517 option is:
22518 .code
22519 $primary_hostname
22520 .endd
22521 During the expansion, the variables &$host$& and &$host_address$& are set to
22522 the identity of the remote host, and the variables &$sending_ip_address$& and
22523 &$sending_port$& are set to the local IP address and port number that are being
22524 used. These variables can be used to generate different values for different
22525 servers or different local IP addresses. For example, if you want the string
22526 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22527 interface address, you could use this:
22528 .code
22529 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22530   {$primary_hostname}}
22531 .endd
22532 The use of &%helo_data%& applies both to sending messages and when doing
22533 callouts.
22534
22535 .option hosts smtp "string list&!!" unset
22536 Hosts are associated with an address by a router such as &(dnslookup)&, which
22537 finds the hosts by looking up the address domain in the DNS, or by
22538 &(manualroute)&, which has lists of hosts in its configuration. However,
22539 email addresses can be passed to the &(smtp)& transport by any router, and not
22540 all of them can provide an associated list of hosts.
22541
22542 The &%hosts%& option specifies a list of hosts to be used if the address being
22543 processed does not have any hosts associated with it. The hosts specified by
22544 &%hosts%& are also used, whether or not the address has its own hosts, if
22545 &%hosts_override%& is set.
22546
22547 The string is first expanded, before being interpreted as a colon-separated
22548 list of host names or IP addresses, possibly including port numbers. The
22549 separator may be changed to something other than colon, as described in section
22550 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22551 item in a &%route_list%& setting for the &(manualroute)& router, as described
22552 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22553 of the &(manualroute)& router is not available here.
22554
22555 If the expansion fails, delivery is deferred. Unless the failure was caused by
22556 the inability to complete a lookup, the error is logged to the panic log as
22557 well as the main log. Host names are looked up either by searching directly for
22558 address records in the DNS or by calling &[gethostbyname()]& (or
22559 &[getipnodebyname()]& when available), depending on the setting of the
22560 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22561 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22562 address are used.
22563
22564 During delivery, the hosts are tried in order, subject to their retry status,
22565 unless &%hosts_randomize%& is set.
22566
22567
22568 .option hosts_avoid_esmtp smtp "host list&!!" unset
22569 .cindex "ESMTP, avoiding use of"
22570 .cindex "HELO" "forcing use of"
22571 .cindex "EHLO" "avoiding use of"
22572 .cindex "PIPELINING" "avoiding the use of"
22573 This option is for use with broken hosts that announce ESMTP facilities (for
22574 example, PIPELINING) and then fail to implement them properly. When a host
22575 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22576 start of the SMTP session. This means that it cannot use any of the ESMTP
22577 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22578
22579
22580 .option hosts_avoid_pipelining smtp "host list&!!" unset
22581 .cindex "PIPELINING" "avoiding the use of"
22582 Exim will not use the SMTP PIPELINING extension when delivering to any host
22583 that matches this list, even if the server host advertises PIPELINING support.
22584
22585
22586 .option hosts_avoid_tls smtp "host list&!!" unset
22587 .cindex "TLS" "avoiding for certain hosts"
22588 Exim will not try to start a TLS session when delivering to any host that
22589 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22590
22591 .option hosts_verify_avoid_tls smtp "host list&!!" *
22592 .cindex "TLS" "avoiding for certain hosts"
22593 Exim will not try to start a TLS session for a verify callout,
22594 or when delivering in cutthrough mode,
22595 to any host that matches this list.
22596 Note that the default is to not use TLS.
22597
22598
22599 .option hosts_max_try smtp integer 5
22600 .cindex "host" "maximum number to try"
22601 .cindex "limit" "number of hosts tried"
22602 .cindex "limit" "number of MX tried"
22603 .cindex "MX record" "maximum tried"
22604 This option limits the number of IP addresses that are tried for any one
22605 delivery in cases where there are temporary delivery errors. Section
22606 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22607
22608
22609 .option hosts_max_try_hardlimit smtp integer 50
22610 This is an additional check on the maximum number of IP addresses that Exim
22611 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22612 why it exists.
22613
22614
22615
22616 .option hosts_nopass_tls smtp "host list&!!" unset
22617 .cindex "TLS" "passing connection"
22618 .cindex "multiple SMTP deliveries"
22619 .cindex "TLS" "multiple message deliveries"
22620 For any host that matches this list, a connection on which a TLS session has
22621 been started will not be passed to a new delivery process for sending another
22622 message on the same connection. See section &<<SECTmulmessam>>& for an
22623 explanation of when this might be needed.
22624
22625
22626 .option hosts_override smtp boolean false
22627 If this option is set and the &%hosts%& option is also set, any hosts that are
22628 attached to the address are ignored, and instead the hosts specified by the
22629 &%hosts%& option are always used. This option does not apply to
22630 &%fallback_hosts%&.
22631
22632
22633 .option hosts_randomize smtp boolean false
22634 .cindex "randomized host list"
22635 .cindex "host" "list of; randomized"
22636 .cindex "fallback" "randomized hosts"
22637 If this option is set, and either the list of hosts is taken from the
22638 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22639 were not obtained from MX records (this includes fallback hosts from the
22640 router), and were not randomized by the router, the order of trying the hosts
22641 is randomized each time the transport runs. Randomizing the order of a host
22642 list can be used to do crude load sharing.
22643
22644 When &%hosts_randomize%& is true, a host list may be split into groups whose
22645 order is separately randomized. This makes it possible to set up MX-like
22646 behaviour. The boundaries between groups are indicated by an item that is just
22647 &`+`& in the host list. For example:
22648 .code
22649 hosts = host1:host2:host3:+:host4:host5
22650 .endd
22651 The order of the first three hosts and the order of the last two hosts is
22652 randomized for each use, but the first three always end up before the last two.
22653 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22654
22655 .option hosts_require_auth smtp "host list&!!" unset
22656 .cindex "authentication" "required by client"
22657 This option provides a list of servers for which authentication must succeed
22658 before Exim will try to transfer a message. If authentication fails for
22659 servers which are not in this list, Exim tries to send unauthenticated. If
22660 authentication fails for one of these servers, delivery is deferred. This
22661 temporary error is detectable in the retry rules, so it can be turned into a
22662 hard failure if required. See also &%hosts_try_auth%&, and chapter
22663 &<<CHAPSMTPAUTH>>& for details of authentication.
22664
22665
22666 .option hosts_require_tls smtp "host list&!!" unset
22667 .cindex "TLS" "requiring for certain servers"
22668 Exim will insist on using a TLS session when delivering to any host that
22669 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22670 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22671 incoming messages, use an appropriate ACL.
22672
22673 .option hosts_try_auth smtp "host list&!!" unset
22674 .cindex "authentication" "optional in client"
22675 This option provides a list of servers to which, provided they announce
22676 authentication support, Exim will attempt to authenticate as a client when it
22677 connects. If authentication fails, Exim will try to transfer the message
22678 unauthenticated. See also &%hosts_require_auth%&, and chapter
22679 &<<CHAPSMTPAUTH>>& for details of authentication.
22680
22681 .option interface smtp "string list&!!" unset
22682 .cindex "bind IP address"
22683 .cindex "IP address" "binding"
22684 .vindex "&$host$&"
22685 .vindex "&$host_address$&"
22686 This option specifies which interface to bind to when making an outgoing SMTP
22687 call. The value is an IP address, not an interface name such as
22688 &`eth0`&. Do not confuse this with the interface address that was used when a
22689 message was received, which is in &$received_ip_address$&, formerly known as
22690 &$interface_address$&. The name was changed to minimize confusion with the
22691 outgoing interface address. There is no variable that contains an outgoing
22692 interface address because, unless it is set by this option, its value is
22693 unknown.
22694
22695 During the expansion of the &%interface%& option the variables &$host$& and
22696 &$host_address$& refer to the host to which a connection is about to be made
22697 during the expansion of the string. Forced expansion failure, or an empty
22698 string result causes the option to be ignored. Otherwise, after expansion, the
22699 string must be a list of IP addresses, colon-separated by default, but the
22700 separator can be changed in the usual way. For example:
22701 .code
22702 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22703 .endd
22704 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22705 connection. If none of them are the correct type, the option is ignored. If
22706 &%interface%& is not set, or is ignored, the system's IP functions choose which
22707 interface to use if the host has more than one.
22708
22709
22710 .option keepalive smtp boolean true
22711 .cindex "keepalive" "on outgoing connection"
22712 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22713 connections. When set, it causes the kernel to probe idle connections
22714 periodically, by sending packets with &"old"& sequence numbers. The other end
22715 of the connection should send a acknowledgment if the connection is still okay
22716 or a reset if the connection has been aborted. The reason for doing this is
22717 that it has the beneficial effect of freeing up certain types of connection
22718 that can get stuck when the remote host is disconnected without tidying up the
22719 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22720 unreachable hosts.
22721
22722
22723 .option lmtp_ignore_quota smtp boolean false
22724 .cindex "LMTP" "ignoring quota errors"
22725 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22726 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22727 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22728
22729 .option max_rcpt smtp integer 100
22730 .cindex "RCPT" "maximum number of outgoing"
22731 This option limits the number of RCPT commands that are sent in a single
22732 SMTP message transaction. Each set of addresses is treated independently, and
22733 so can cause parallel connections to the same host if &%remote_max_parallel%&
22734 permits this.
22735
22736
22737 .option multi_domain smtp boolean true
22738 .vindex "&$domain$&"
22739 When this option is set, the &(smtp)& transport can handle a number of
22740 addresses containing a mixture of different domains provided they all resolve
22741 to the same list of hosts. Turning the option off restricts the transport to
22742 handling only one domain at a time. This is useful if you want to use
22743 &$domain$& in an expansion for the transport, because it is set only when there
22744 is a single domain involved in a remote delivery.
22745
22746
22747 .option port smtp string&!! "see below"
22748 .cindex "port" "sending TCP/IP"
22749 .cindex "TCP/IP" "setting outgoing port"
22750 This option specifies the TCP/IP port on the server to which Exim connects.
22751 &*Note:*& Do not confuse this with the port that was used when a message was
22752 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22753 The name was changed to minimize confusion with the outgoing port. There is no
22754 variable that contains an outgoing port.
22755
22756 If the value of this option begins with a digit it is taken as a port number;
22757 otherwise it is looked up using &[getservbyname()]&. The default value is
22758 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22759 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22760 is deferred.
22761
22762
22763
22764 .option protocol smtp string smtp
22765 .cindex "LMTP" "over TCP/IP"
22766 .cindex "ssmtp protocol" "outbound"
22767 .cindex "TLS" "SSL-on-connect outbound"
22768 .vindex "&$port$&"
22769 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22770 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22771 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22772 deliveries into closed message stores. Exim also has support for running LMTP
22773 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22774
22775 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22776 changes to &"smtps"&, and the transport initiates TLS immediately after
22777 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22778 The Internet standards bodies strongly discourage use of this mode.
22779
22780
22781 .option retry_include_ip_address smtp boolean true
22782 Exim normally includes both the host name and the IP address in the key it
22783 constructs for indexing retry data after a temporary delivery failure. This
22784 means that when one of several IP addresses for a host is failing, it gets
22785 tried periodically (controlled by the retry rules), but use of the other IP
22786 addresses is not affected.
22787
22788 However, in some dialup environments hosts are assigned a different IP address
22789 each time they connect. In this situation the use of the IP address as part of
22790 the retry key leads to undesirable behaviour. Setting this option false causes
22791 Exim to use only the host name. This should normally be done on a separate
22792 instance of the &(smtp)& transport, set up specially to handle the dialup
22793 hosts.
22794
22795
22796 .option serialize_hosts smtp "host list&!!" unset
22797 .cindex "serializing connections"
22798 .cindex "host" "serializing connections"
22799 Because Exim operates in a distributed manner, if several messages for the same
22800 host arrive at around the same time, more than one simultaneous connection to
22801 the remote host can occur. This is not usually a problem except when there is a
22802 slow link between the hosts. In that situation it may be helpful to restrict
22803 Exim to one connection at a time. This can be done by setting
22804 &%serialize_hosts%& to match the relevant hosts.
22805
22806 .cindex "hints database" "serializing deliveries to a host"
22807 Exim implements serialization by means of a hints database in which a record is
22808 written whenever a process connects to one of the restricted hosts. The record
22809 is deleted when the connection is completed. Obviously there is scope for
22810 records to get left lying around if there is a system or program crash. To
22811 guard against this, Exim ignores any records that are more than six hours old.
22812
22813 If you set up this kind of serialization, you should also arrange to delete the
22814 relevant hints database whenever your system reboots. The names of the files
22815 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22816 may be one or two files, depending on the type of DBM in use. The same files
22817 are used for ETRN serialization.
22818
22819
22820 .option size_addition smtp integer 1024
22821 .cindex "SMTP" "SIZE"
22822 .cindex "message" "size issue for transport filter"
22823 .cindex "size" "of message"
22824 .cindex "transport" "filter"
22825 .cindex "filter" "transport filter"
22826 If a remote SMTP server indicates that it supports the SIZE option of the
22827 MAIL command, Exim uses this to pass over the message size at the start of
22828 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22829 sends, to allow for headers and other text that may be added during delivery by
22830 configuration options or in a transport filter. It may be necessary to increase
22831 this if a lot of text is added to messages.
22832
22833 Alternatively, if the value of &%size_addition%& is set negative, it disables
22834 the use of the SIZE option altogether.
22835
22836
22837 .option tls_certificate smtp string&!! unset
22838 .cindex "TLS" "client certificate, location of"
22839 .cindex "certificate" "client, location of"
22840 .vindex "&$host$&"
22841 .vindex "&$host_address$&"
22842 The value of this option must be the absolute path to a file which contains the
22843 client's certificate, for possible use when sending a message over an encrypted
22844 connection. The values of &$host$& and &$host_address$& are set to the name and
22845 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22846 details of TLS.
22847
22848 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22849 certificate when sending messages as a client. The global option of the same
22850 name specifies the certificate for Exim as a server; it is not automatically
22851 assumed that the same certificate should be used when Exim is operating as a
22852 client.
22853
22854
22855 .option tls_crl smtp string&!! unset
22856 .cindex "TLS" "client certificate revocation list"
22857 .cindex "certificate" "revocation list for client"
22858 This option specifies a certificate revocation list. The expanded value must
22859 be the name of a file that contains a CRL in PEM format.
22860
22861
22862 .new
22863 .option tls_dh_min_bits smtp integer 1024
22864 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
22865 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
22866 key agreement is negotiated, the server will provide a large prime number
22867 for use.  This option establishes the minimum acceptable size of that number.
22868 If the parameter offered by the server is too small, then the TLS handshake
22869 will fail.
22870
22871 Only supported when using GnuTLS.
22872 .wen
22873
22874
22875 .option tls_privatekey smtp string&!! unset
22876 .cindex "TLS" "client private key, location of"
22877 .vindex "&$host$&"
22878 .vindex "&$host_address$&"
22879 The value of this option must be the absolute path to a file which contains the
22880 client's private key. This is used when sending a message over an encrypted
22881 connection using a client certificate. The values of &$host$& and
22882 &$host_address$& are set to the name and address of the server during the
22883 expansion. If this option is unset, or the expansion is forced to fail, or the
22884 result is an empty string, the private key is assumed to be in the same file as
22885 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22886
22887
22888 .option tls_require_ciphers smtp string&!! unset
22889 .cindex "TLS" "requiring specific ciphers"
22890 .cindex "cipher" "requiring specific"
22891 .vindex "&$host$&"
22892 .vindex "&$host_address$&"
22893 The value of this option must be a list of permitted cipher suites, for use
22894 when setting up an outgoing encrypted connection. (There is a global option of
22895 the same name for controlling incoming connections.) The values of &$host$& and
22896 &$host_address$& are set to the name and address of the server during the
22897 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22898 is used in different ways by OpenSSL and GnuTLS (see sections
22899 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22900 ciphers is a preference order.
22901
22902
22903
22904 .option tls_sni smtp string&!! unset
22905 .cindex "TLS" "Server Name Indication"
22906 .vindex "&$tls_sni$&"
22907 If this option is set then it sets the $tls_out_sni variable and causes any
22908 TLS session to pass this value as the Server Name Indication extension to
22909 the remote side, which can be used by the remote side to select an appropriate
22910 certificate and private key for the session.
22911
22912 See &<<SECTtlssni>>& for more information.
22913
22914 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
22915 TLS extensions.
22916
22917
22918
22919
22920 .option tls_tempfail_tryclear smtp boolean true
22921 .cindex "4&'xx'& responses" "to STARTTLS"
22922 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22923 setting up a TLS session, this option determines whether or not Exim should try
22924 to deliver the message unencrypted. If it is set false, delivery to the
22925 current host is deferred; if there are other hosts, they are tried. If this
22926 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22927 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22928 TLS negotiation fails, Exim closes the current connection (because it is in an
22929 unknown state), opens a new one to the same host, and then tries the delivery
22930 in clear.
22931
22932
22933 .option tls_verify_certificates smtp string&!! unset
22934 .cindex "TLS" "server certificate verification"
22935 .cindex "certificate" "verification of server"
22936 .vindex "&$host$&"
22937 .vindex "&$host_address$&"
22938 The value of this option must be the absolute path to a file containing
22939 permitted server certificates, for use when setting up an encrypted connection.
22940 Alternatively, if you are using OpenSSL, you can set
22941 &%tls_verify_certificates%& to the name of a directory containing certificate
22942 files. This does not work with GnuTLS; the option must be set to the name of a
22943 single file if you are using GnuTLS. The values of &$host$& and
22944 &$host_address$& are set to the name and address of the server during the
22945 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22946
22947
22948
22949
22950 .section "How the limits for the number of hosts to try are used" &&&
22951          "SECTvalhosmax"
22952 .cindex "host" "maximum number to try"
22953 .cindex "limit" "hosts; maximum number tried"
22954 There are two options that are concerned with the number of hosts that are
22955 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22956 &%hosts_max_try_hardlimit%&.
22957
22958
22959 The &%hosts_max_try%& option limits the number of hosts that are tried
22960 for a single delivery. However, despite the term &"host"& in its name, the
22961 option actually applies to each IP address independently. In other words, a
22962 multihomed host is treated as several independent hosts, just as it is for
22963 retrying.
22964
22965 Many of the larger ISPs have multiple MX records which often point to
22966 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22967 created as a result of routing one of these domains.
22968
22969 Trying every single IP address on such a long list does not seem sensible; if
22970 several at the top of the list fail, it is reasonable to assume there is some
22971 problem that is likely to affect all of them. Roughly speaking, the value of
22972 &%hosts_max_try%& is the maximum number that are tried before deferring the
22973 delivery. However, the logic cannot be quite that simple.
22974
22975 Firstly, IP addresses that are skipped because their retry times have not
22976 arrived do not count, and in addition, addresses that are past their retry
22977 limits are also not counted, even when they are tried. This means that when
22978 some IP addresses are past their retry limits, more than the value of
22979 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22980 that all IP addresses are considered before timing out an email address (but
22981 see below for an exception).
22982
22983 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22984 list to see if there is a subsequent host with a different (higher valued) MX.
22985 If there is, that host is considered next, and the current IP address is used
22986 but not counted. This behaviour helps in the case of a domain with a retry rule
22987 that hardly ever delays any hosts, as is now explained:
22988
22989 Consider the case of a long list of hosts with one MX value, and a few with a
22990 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22991 hosts at the top of the list are tried at first. With the default retry rule,
22992 which specifies increasing retry times, the higher MX hosts are eventually
22993 tried when those at the top of the list are skipped because they have not
22994 reached their retry times.
22995
22996 However, it is common practice to put a fixed short retry time on domains for
22997 large ISPs, on the grounds that their servers are rarely down for very long.
22998 Unfortunately, these are exactly the domains that tend to resolve to long lists
22999 of hosts. The short retry time means that the lowest MX hosts are tried every
23000 time. The attempts may be in a different order because of random sorting, but
23001 without the special MX check, the higher MX hosts would never be tried until
23002 all the lower MX hosts had timed out (which might be several days), because
23003 there are always some lower MX hosts that have reached their retry times. With
23004 the special check, Exim considers at least one IP address from each MX value at
23005 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23006 reached.
23007
23008 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23009 particular, Exim normally eventually tries all the IP addresses before timing
23010 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23011 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23012 been set up with hundreds of IP addresses for some domains. It can
23013 take a very long time indeed for an address to time out in these cases.
23014
23015 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23016 Exim never tries more than this number of IP addresses; if it hits this limit
23017 and they are all timed out, the email address is bounced, even though not all
23018 possible IP addresses have been tried.
23019 .ecindex IIDsmttra1
23020 .ecindex IIDsmttra2
23021
23022
23023
23024
23025
23026 . ////////////////////////////////////////////////////////////////////////////
23027 . ////////////////////////////////////////////////////////////////////////////
23028
23029 .chapter "Address rewriting" "CHAPrewrite"
23030 .scindex IIDaddrew "rewriting" "addresses"
23031 There are some circumstances in which Exim automatically rewrites domains in
23032 addresses. The two most common are when an address is given without a domain
23033 (referred to as an &"unqualified address"&) or when an address contains an
23034 abbreviated domain that is expanded by DNS lookup.
23035
23036 Unqualified envelope addresses are accepted only for locally submitted
23037 messages, or for messages that are received from hosts matching
23038 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23039 appropriate. Unqualified addresses in header lines are qualified if they are in
23040 locally submitted messages, or messages from hosts that are permitted to send
23041 unqualified envelope addresses. Otherwise, unqualified addresses in header
23042 lines are neither qualified nor rewritten.
23043
23044 One situation in which Exim does &'not'& automatically rewrite a domain is
23045 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23046 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23047 do this. The new RFCs do not contain this suggestion.
23048
23049
23050 .section "Explicitly configured address rewriting" "SECID147"
23051 This chapter describes the rewriting rules that can be used in the
23052 main rewrite section of the configuration file, and also in the generic
23053 &%headers_rewrite%& option that can be set on any transport.
23054
23055 Some people believe that configured address rewriting is a Mortal Sin.
23056 Others believe that life is not possible without it. Exim provides the
23057 facility; you do not have to use it.
23058
23059 The main rewriting rules that appear in the &"rewrite"& section of the
23060 configuration file are applied to addresses in incoming messages, both envelope
23061 addresses and addresses in header lines. Each rule specifies the types of
23062 address to which it applies.
23063
23064 Whether or not addresses in header lines are rewritten depends on the origin of
23065 the headers and the type of rewriting. Global rewriting, that is, rewriting
23066 rules from the rewrite section of the configuration file, is applied only to
23067 those headers that were received with the message. Header lines that are added
23068 by ACLs or by a system filter or by individual routers or transports (which
23069 are specific to individual recipient addresses) are not rewritten by the global
23070 rules.
23071
23072 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23073 applies all headers except those added by routers and transports. That is, as
23074 well as the headers that were received with the message, it also applies to
23075 headers that were added by an ACL or a system filter.
23076
23077
23078 In general, rewriting addresses from your own system or domain has some
23079 legitimacy. Rewriting other addresses should be done only with great care and
23080 in special circumstances. The author of Exim believes that rewriting should be
23081 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23082 Although it can sometimes be used as a routing tool, this is very strongly
23083 discouraged.
23084
23085 There are two commonly encountered circumstances where rewriting is used, as
23086 illustrated by these examples:
23087
23088 .ilist
23089 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23090 exchange mail with each other behind a firewall, but there is only a single
23091 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23092 &'hitch.fict.example'& when sending mail off-site.
23093 .next
23094 A host rewrites the local parts of its own users so that, for example,
23095 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23096 .endlist
23097
23098
23099
23100 .section "When does rewriting happen?" "SECID148"
23101 .cindex "rewriting" "timing of"
23102 .cindex "&ACL;" "rewriting addresses in"
23103 Configured address rewriting can take place at several different stages of a
23104 message's processing.
23105
23106 .vindex "&$sender_address$&"
23107 At the start of an ACL for MAIL, the sender address may have been rewritten
23108 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23109 ordinary rewrite rules have yet been applied. If, however, the sender address
23110 is verified in the ACL, it is rewritten before verification, and remains
23111 rewritten thereafter. The subsequent value of &$sender_address$& is the
23112 rewritten address. This also applies if sender verification happens in a
23113 RCPT ACL. Otherwise, when the sender address is not verified, it is
23114 rewritten as soon as a message's header lines have been received.
23115
23116 .vindex "&$domain$&"
23117 .vindex "&$local_part$&"
23118 Similarly, at the start of an ACL for RCPT, the current recipient's address
23119 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23120 rewrite rules have yet been applied to it. However, the behaviour is different
23121 from the sender address when a recipient is verified. The address is rewritten
23122 for the verification, but the rewriting is not remembered at this stage. The
23123 value of &$local_part$& and &$domain$& after verification are always the same
23124 as they were before (that is, they contain the unrewritten &-- except for
23125 SMTP-time rewriting &-- address).
23126
23127 As soon as a message's header lines have been received, all the envelope
23128 recipient addresses are permanently rewritten, and rewriting is also applied to
23129 the addresses in the header lines (if configured). This happens before adding
23130 any header lines that were specified in MAIL or RCPT ACLs, and
23131 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23132 before the DATA ACL and &[local_scan()]& functions are run.
23133
23134 When an address is being routed, either for delivery or for verification,
23135 rewriting is applied immediately to child addresses that are generated by
23136 redirection, unless &%no_rewrite%& is set on the router.
23137
23138 .cindex "envelope sender" "rewriting at transport time"
23139 .cindex "rewriting" "at transport time"
23140 .cindex "header lines" "rewriting at transport time"
23141 At transport time, additional rewriting of addresses in header lines can be
23142 specified by setting the generic &%headers_rewrite%& option on a transport.
23143 This option contains rules that are identical in form to those in the rewrite
23144 section of the configuration file. They are applied to the original message
23145 header lines and any that were added by ACLs or a system filter. They are not
23146 applied to header lines that are added by routers or the transport.
23147
23148 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23149 transport option. However, it is not possible to rewrite envelope recipients at
23150 transport time.
23151
23152
23153
23154
23155 .section "Testing the rewriting rules that apply on input" "SECID149"
23156 .cindex "rewriting" "testing"
23157 .cindex "testing" "rewriting"
23158 Exim's input rewriting configuration appears in a part of the run time
23159 configuration file headed by &"begin rewrite"&. It can be tested by the
23160 &%-brw%& command line option. This takes an address (which can be a full RFC
23161 2822 address) as its argument. The output is a list of how the address would be
23162 transformed by the rewriting rules for each of the different places it might
23163 appear in an incoming message, that is, for each different header and for the
23164 envelope sender and recipient fields. For example,
23165 .code
23166 exim -brw ph10@exim.workshop.example
23167 .endd
23168 might produce the output
23169 .code
23170 sender: Philip.Hazel@exim.workshop.example
23171 from: Philip.Hazel@exim.workshop.example
23172 to: ph10@exim.workshop.example
23173 cc: ph10@exim.workshop.example
23174 bcc: ph10@exim.workshop.example
23175 reply-to: Philip.Hazel@exim.workshop.example
23176 env-from: Philip.Hazel@exim.workshop.example
23177 env-to: ph10@exim.workshop.example
23178 .endd
23179 which shows that rewriting has been set up for that address when used in any of
23180 the source fields, but not when it appears as a recipient address. At the
23181 present time, there is no equivalent way of testing rewriting rules that are
23182 set for a particular transport.
23183
23184
23185 .section "Rewriting rules" "SECID150"
23186 .cindex "rewriting" "rules"
23187 The rewrite section of the configuration file consists of lines of rewriting
23188 rules in the form
23189 .display
23190 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23191 .endd
23192 Rewriting rules that are specified for the &%headers_rewrite%& generic
23193 transport option are given as a colon-separated list. Each item in the list
23194 takes the same form as a line in the main rewriting configuration (except that
23195 any colons must be doubled, of course).
23196
23197 The formats of source patterns and replacement strings are described below.
23198 Each is terminated by white space, unless enclosed in double quotes, in which
23199 case normal quoting conventions apply inside the quotes. The flags are single
23200 characters which may appear in any order. Spaces and tabs between them are
23201 ignored.
23202
23203 For each address that could potentially be rewritten, the rules are scanned in
23204 order, and replacements for the address from earlier rules can themselves be
23205 replaced by later rules (but see the &"q"& and &"R"& flags).
23206
23207 The order in which addresses are rewritten is undefined, may change between
23208 releases, and must not be relied on, with one exception: when a message is
23209 received, the envelope sender is always rewritten first, before any header
23210 lines are rewritten. For example, the replacement string for a rewrite of an
23211 address in &'To:'& must not assume that the message's address in &'From:'& has
23212 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23213 that the envelope sender has already been rewritten.
23214
23215 .vindex "&$domain$&"
23216 .vindex "&$local_part$&"
23217 The variables &$local_part$& and &$domain$& can be used in the replacement
23218 string to refer to the address that is being rewritten. Note that lookup-driven
23219 rewriting can be done by a rule of the form
23220 .code
23221 *@*   ${lookup ...
23222 .endd
23223 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23224 refer to the address that is being rewritten.
23225
23226
23227 .section "Rewriting patterns" "SECID151"
23228 .cindex "rewriting" "patterns"
23229 .cindex "address list" "in a rewriting pattern"
23230 The source pattern in a rewriting rule is any item which may appear in an
23231 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23232 single-item address list, which means that it is expanded before being tested
23233 against the address. As always, if you use a regular expression as a pattern,
23234 you must take care to escape dollar and backslash characters, or use the &`\N`&
23235 facility to suppress string expansion within the regular expression.
23236
23237 Domains in patterns should be given in lower case. Local parts in patterns are
23238 case-sensitive. If you want to do case-insensitive matching of local parts, you
23239 can use a regular expression that starts with &`^(?i)`&.
23240
23241 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23242 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23243 depending on the type of match which occurred. These can be used in the
23244 replacement string to insert portions of the incoming address. &$0$& always
23245 refers to the complete incoming address. When a regular expression is used, the
23246 numerical variables are set from its capturing subexpressions. For other types
23247 of pattern they are set as follows:
23248
23249 .ilist
23250 If a local part or domain starts with an asterisk, the numerical variables
23251 refer to the character strings matched by asterisks, with &$1$& associated with
23252 the first asterisk, and &$2$& with the second, if present. For example, if the
23253 pattern
23254 .code
23255 *queen@*.fict.example
23256 .endd
23257 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23258 .code
23259 $0 = hearts-queen@wonderland.fict.example
23260 $1 = hearts-
23261 $2 = wonderland
23262 .endd
23263 Note that if the local part does not start with an asterisk, but the domain
23264 does, it is &$1$& that contains the wild part of the domain.
23265
23266 .next
23267 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23268 of the domain are placed in the next available numerical variables. Suppose,
23269 for example, that the address &'foo@bar.baz.example'& is processed by a
23270 rewriting rule of the form
23271 .display
23272 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23273 .endd
23274 and the key in the file that matches the domain is &`*.baz.example`&. Then
23275 .code
23276 $1 = foo
23277 $2 = bar
23278 $3 = baz.example
23279 .endd
23280 If the address &'foo@baz.example'& is looked up, this matches the same
23281 wildcard file entry, and in this case &$2$& is set to the empty string, but
23282 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23283 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23284 whole domain. For non-partial domain lookups, no numerical variables are set.
23285 .endlist
23286
23287
23288 .section "Rewriting replacements" "SECID152"
23289 .cindex "rewriting" "replacements"
23290 If the replacement string for a rule is a single asterisk, addresses that
23291 match the pattern and the flags are &'not'& rewritten, and no subsequent
23292 rewriting rules are scanned. For example,
23293 .code
23294 hatta@lookingglass.fict.example  *  f
23295 .endd
23296 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23297 &'From:'& headers.
23298
23299 .vindex "&$domain$&"
23300 .vindex "&$local_part$&"
23301 If the replacement string is not a single asterisk, it is expanded, and must
23302 yield a fully qualified address. Within the expansion, the variables
23303 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23304 Any letters they contain retain their original case &-- they are not lower
23305 cased. The numerical variables are set up according to the type of pattern that
23306 matched the address, as described above. If the expansion is forced to fail by
23307 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23308 current rule is abandoned, but subsequent rules may take effect. Any other
23309 expansion failure causes the entire rewriting operation to be abandoned, and an
23310 entry written to the panic log.
23311
23312
23313
23314 .section "Rewriting flags" "SECID153"
23315 There are three different kinds of flag that may appear on rewriting rules:
23316
23317 .ilist
23318 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23319 c, f, h, r, s, t.
23320 .next
23321 A flag that specifies rewriting at SMTP time: S.
23322 .next
23323 Flags that control the rewriting process: Q, q, R, w.
23324 .endlist
23325
23326 For rules that are part of the &%headers_rewrite%& generic transport option,
23327 E, F, T, and S are not permitted.
23328
23329
23330
23331 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23332          "SECID154"
23333 .cindex "rewriting" "flags"
23334 If none of the following flag letters, nor the &"S"& flag (see section
23335 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23336 and to both the sender and recipient fields of the envelope, whereas a
23337 transport-time rewriting rule just applies to all headers. Otherwise, the
23338 rewriting rule is skipped unless the relevant addresses are being processed.
23339 .display
23340 &`E`&       rewrite all envelope fields
23341 &`F`&       rewrite the envelope From field
23342 &`T`&       rewrite the envelope To field
23343 &`b`&       rewrite the &'Bcc:'& header
23344 &`c`&       rewrite the &'Cc:'& header
23345 &`f`&       rewrite the &'From:'& header
23346 &`h`&       rewrite all headers
23347 &`r`&       rewrite the &'Reply-To:'& header
23348 &`s`&       rewrite the &'Sender:'& header
23349 &`t`&       rewrite the &'To:'& header
23350 .endd
23351 "All headers" means all of the headers listed above that can be selected
23352 individually, plus their &'Resent-'& versions. It does not include
23353 other headers such as &'Subject:'& etc.
23354
23355 You should be particularly careful about rewriting &'Sender:'& headers, and
23356 restrict this to special known cases in your own domains.
23357
23358
23359 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23360 .cindex "SMTP" "rewriting malformed addresses"
23361 .cindex "RCPT" "rewriting argument of"
23362 .cindex "MAIL" "rewriting argument of"
23363 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23364 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23365 before any other processing; even before syntax checking. The pattern is
23366 required to be a regular expression, and it is matched against the whole of the
23367 data for the command, including any surrounding angle brackets.
23368
23369 .vindex "&$domain$&"
23370 .vindex "&$local_part$&"
23371 This form of rewrite rule allows for the handling of addresses that are not
23372 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23373 input). Because the input is not required to be a syntactically valid address,
23374 the variables &$local_part$& and &$domain$& are not available during the
23375 expansion of the replacement string. The result of rewriting replaces the
23376 original address in the MAIL or RCPT command.
23377
23378
23379 .section "Flags controlling the rewriting process" "SECID155"
23380 There are four flags which control the way the rewriting process works. These
23381 take effect only when a rule is invoked, that is, when the address is of the
23382 correct type (matches the flags) and matches the pattern:
23383
23384 .ilist
23385 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23386 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23387 absence of &"Q"& the rewritten address must always include a domain.
23388 .next
23389 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23390 even if no rewriting actually takes place because of a &"fail"& in the
23391 expansion. The &"q"& flag is not effective if the address is of the wrong type
23392 (does not match the flags) or does not match the pattern.
23393 .next
23394 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23395 address, up to ten times. It can be combined with the &"q"& flag, to stop
23396 rewriting once it fails to match (after at least one successful rewrite).
23397 .next
23398 .cindex "rewriting" "whole addresses"
23399 When an address in a header is rewritten, the rewriting normally applies only
23400 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23401 left unchanged. For example, rewriting might change
23402 .code
23403 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23404 .endd
23405 into
23406 .code
23407 From: Ford Prefect <prefectf@hitch.fict.example>
23408 .endd
23409 .cindex "RFC 2047"
23410 Sometimes there is a need to replace the whole address item, and this can be
23411 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23412 causes an address in a header line to be rewritten, the entire address is
23413 replaced, not just the working part. The replacement must be a complete RFC
23414 2822 address, including the angle brackets if necessary. If text outside angle
23415 brackets contains a character whose value is greater than 126 or less than 32
23416 (except for tab), the text is encoded according to RFC 2047. The character set
23417 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23418
23419 When the &"w"& flag is set on a rule that causes an envelope address to be
23420 rewritten, all but the working part of the replacement address is discarded.
23421 .endlist
23422
23423
23424 .section "Rewriting examples" "SECID156"
23425 Here is an example of the two common rewriting paradigms:
23426 .code
23427 *@*.hitch.fict.example  $1@hitch.fict.example
23428 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23429                      {$value}fail}@hitch.fict.example bctfrF
23430 .endd
23431 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23432 the string expansion to fail if the lookup does not succeed. In this context it
23433 has the effect of leaving the original address unchanged, but Exim goes on to
23434 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23435 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23436 explicitly, which would cause the rewritten address to be the same as before,
23437 at the cost of a small bit of processing. Not supplying either of these is an
23438 error, since the rewritten address would then contain no local part.
23439
23440 The first example above replaces the domain with a superior, more general
23441 domain. This may not be desirable for certain local parts. If the rule
23442 .code
23443 root@*.hitch.fict.example  *
23444 .endd
23445 were inserted before the first rule, rewriting would be suppressed for the
23446 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23447
23448 Rewriting can be made conditional on a number of tests, by making use of
23449 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23450 messages that originate outside the local host:
23451 .code
23452 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23453                          {$1@hitch.fict.example}fail}"
23454 .endd
23455 The replacement string is quoted in this example because it contains white
23456 space.
23457
23458 .cindex "rewriting" "bang paths"
23459 .cindex "bang paths" "rewriting"
23460 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23461 an address it treats it as an unqualified local part which it qualifies with
23462 the local qualification domain (if the source of the message is local or if the
23463 remote host is permitted to send unqualified addresses). Rewriting can
23464 sometimes be used to handle simple bang paths with a fixed number of
23465 components. For example, the rule
23466 .code
23467 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23468 .endd
23469 rewrites a two-component bang path &'host.name!user'& as the domain address
23470 &'user@host.name'&. However, there is a security implication in using this as
23471 a global rewriting rule for envelope addresses. It can provide a backdoor
23472 method for using your system as a relay, because the incoming addresses appear
23473 to be local. If the bang path addresses are received via SMTP, it is safer to
23474 use the &"S"& flag to rewrite them as they are received, so that relay checking
23475 can be done on the rewritten addresses.
23476 .ecindex IIDaddrew
23477
23478
23479
23480
23481
23482 . ////////////////////////////////////////////////////////////////////////////
23483 . ////////////////////////////////////////////////////////////////////////////
23484
23485 .chapter "Retry configuration" "CHAPretry"
23486 .scindex IIDretconf1 "retry" "configuration, description of"
23487 .scindex IIDregconf2 "configuration file" "retry section"
23488 The &"retry"& section of the runtime configuration file contains a list of
23489 retry rules that control how often Exim tries to deliver messages that cannot
23490 be delivered at the first attempt. If there are no retry rules (the section is
23491 empty or not present), there are no retries. In this situation, temporary
23492 errors are treated as permanent. The default configuration contains a single,
23493 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23494 line option can be used to test which retry rule will be used for a given
23495 address, domain and error.
23496
23497 The most common cause of retries is temporary failure to deliver to a remote
23498 host because the host is down, or inaccessible because of a network problem.
23499 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23500 address) basis, not on a per-message basis. Thus, if one message has recently
23501 been delayed, delivery of a new message to the same host is not immediately
23502 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23503 log selector is set, the message
23504 .cindex "retry" "time not reached"
23505 &"retry time not reached"& is written to the main log whenever a delivery is
23506 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23507 the handling of errors during remote deliveries.
23508
23509 Retry processing applies to routing as well as to delivering, except as covered
23510 in the next paragraph. The retry rules do not distinguish between these
23511 actions. It is not possible, for example, to specify different behaviour for
23512 failures to route the domain &'snark.fict.example'& and failures to deliver to
23513 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23514 added complication, so did not implement it. However, although they share the
23515 same retry rule, the actual retry times for routing and transporting a given
23516 domain are maintained independently.
23517
23518 When a delivery is not part of a queue run (typically an immediate delivery on
23519 receipt of a message), the routers are always run, and local deliveries are
23520 always attempted, even if retry times are set for them. This makes for better
23521 behaviour if one particular message is causing problems (for example, causing
23522 quota overflow, or provoking an error in a filter file). If such a delivery
23523 suffers a temporary failure, the retry data is updated as normal, and
23524 subsequent delivery attempts from queue runs occur only when the retry time for
23525 the local address is reached.
23526
23527 .section "Changing retry rules" "SECID157"
23528 If you change the retry rules in your configuration, you should consider
23529 whether or not to delete the retry data that is stored in Exim's spool area in
23530 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23531 always safe; that is why they are called &"hints"&.
23532
23533 The hints retry data contains suggested retry times based on the previous
23534 rules. In the case of a long-running problem with a remote host, it might
23535 record the fact that the host has timed out. If your new rules increase the
23536 timeout time for such a host, you should definitely remove the old retry data
23537 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23538 messages that it should now be retaining.
23539
23540
23541
23542 .section "Format of retry rules" "SECID158"
23543 .cindex "retry" "rules"
23544 Each retry rule occupies one line and consists of three or four parts,
23545 separated by white space: a pattern, an error name, an optional list of sender
23546 addresses, and a list of retry parameters. The pattern and sender lists must be
23547 enclosed in double quotes if they contain white space. The rules are searched
23548 in order until one is found where the pattern, error name, and sender list (if
23549 present) match the failing host or address, the error that occurred, and the
23550 message's sender, respectively.
23551
23552
23553 The pattern is any single item that may appear in an address list (see section
23554 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23555 which means that it is expanded before being tested against the address that
23556 has been delayed. A negated address list item is permitted. Address
23557 list processing treats a plain domain name as if it were preceded by &"*@"&,
23558 which makes it possible for many retry rules to start with just a domain. For
23559 example,
23560 .code
23561 lookingglass.fict.example        *  F,24h,30m;
23562 .endd
23563 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23564 whereas
23565 .code
23566 alice@lookingglass.fict.example  *  F,24h,30m;
23567 .endd
23568 applies only to temporary failures involving the local part &%alice%&.
23569 In practice, almost all rules start with a domain name pattern without a local
23570 part.
23571
23572 .cindex "regular expressions" "in retry rules"
23573 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23574 must match a complete address, not just a domain, because that is how regular
23575 expressions work in address lists.
23576 .display
23577 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23578 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23579 .endd
23580
23581
23582 .section "Choosing which retry rule to use for address errors" "SECID159"
23583 When Exim is looking for a retry rule after a routing attempt has failed (for
23584 example, after a DNS timeout), each line in the retry configuration is tested
23585 against the complete address only if &%retry_use_local_part%& is set for the
23586 router. Otherwise, only the domain is used, except when matching against a
23587 regular expression, when the local part of the address is replaced with &"*"&.
23588 A domain on its own can match a domain pattern, or a pattern that starts with
23589 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23590 &%check_local_user%& is true, and false for other routers.
23591
23592 Similarly, when Exim is looking for a retry rule after a local delivery has
23593 failed (for example, after a mailbox full error), each line in the retry
23594 configuration is tested against the complete address only if
23595 &%retry_use_local_part%& is set for the transport (it defaults true for all
23596 local transports).
23597
23598 .cindex "4&'xx'& responses" "retry rules for"
23599 However, when Exim is looking for a retry rule after a remote delivery attempt
23600 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23601 whole address is always used as the key when searching the retry rules. The
23602 rule that is found is used to create a retry time for the combination of the
23603 failing address and the message's sender. It is the combination of sender and
23604 recipient that is delayed in subsequent queue runs until its retry time is
23605 reached. You can delay the recipient without regard to the sender by setting
23606 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23607 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23608 commands.
23609
23610
23611
23612 .section "Choosing which retry rule to use for host and message errors" &&&
23613          "SECID160"
23614 For a temporary error that is not related to an individual address (for
23615 example, a connection timeout), each line in the retry configuration is checked
23616 twice. First, the name of the remote host is used as a domain name (preceded by
23617 &"*@"& when matching a regular expression). If this does not match the line,
23618 the domain from the email address is tried in a similar fashion. For example,
23619 suppose the MX records for &'a.b.c.example'& are
23620 .code
23621 a.b.c.example  MX  5  x.y.z.example
23622                MX  6  p.q.r.example
23623                MX  7  m.n.o.example
23624 .endd
23625 and the retry rules are
23626 .code
23627 p.q.r.example    *      F,24h,30m;
23628 a.b.c.example    *      F,4d,45m;
23629 .endd
23630 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23631 first rule matches neither the host nor the domain, so Exim looks at the second
23632 rule. This does not match the host, but it does match the domain, so it is used
23633 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23634 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23635 first retry rule is used, because it matches the host.
23636
23637 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23638 first rule to determine retry times, but for all the other hosts for the domain
23639 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23640 routing to &'a.b.c.example'& suffers a temporary failure.
23641
23642 &*Note*&: The host name is used when matching the patterns, not its IP address.
23643 However, if a message is routed directly to an IP address without the use of a
23644 host name, for example, if a &(manualroute)& router contains a setting such as:
23645 .code
23646 route_list = *.a.example  192.168.34.23
23647 .endd
23648 then the &"host name"& that is used when searching for a retry rule is the
23649 textual form of the IP address.
23650
23651 .section "Retry rules for specific errors" "SECID161"
23652 .cindex "retry" "specific errors; specifying"
23653 The second field in a retry rule is the name of a particular error, or an
23654 asterisk, which matches any error. The errors that can be tested for are:
23655
23656 .vlist
23657 .vitem &%auth_failed%&
23658 Authentication failed when trying to send to a host in the
23659 &%hosts_require_auth%& list in an &(smtp)& transport.
23660
23661 .vitem &%data_4xx%&
23662 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23663 after the command, or after sending the message's data.
23664
23665 .vitem &%mail_4xx%&
23666 A 4&'xx'& error was received for an outgoing MAIL command.
23667
23668 .vitem &%rcpt_4xx%&
23669 A 4&'xx'& error was received for an outgoing RCPT command.
23670 .endlist
23671
23672 For the three 4&'xx'& errors, either the first or both of the x's can be given
23673 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23674 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23675 and have retries every ten minutes with a one-hour timeout, you could set up a
23676 retry rule of this form:
23677 .code
23678 the.domain.name  rcpt_452   F,1h,10m
23679 .endd
23680 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23681 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23682
23683 .vlist
23684 .vitem &%lost_connection%&
23685 A server unexpectedly closed the SMTP connection. There may, of course,
23686 legitimate reasons for this (host died, network died), but if it repeats a lot
23687 for the same host, it indicates something odd.
23688
23689 .vitem &%refused_MX%&
23690 A connection to a host obtained from an MX record was refused.
23691
23692 .vitem &%refused_A%&
23693 A connection to a host not obtained from an MX record was refused.
23694
23695 .vitem &%refused%&
23696 A connection was refused.
23697
23698 .vitem &%timeout_connect_MX%&
23699 A connection attempt to a host obtained from an MX record timed out.
23700
23701 .vitem &%timeout_connect_A%&
23702 A connection attempt to a host not obtained from an MX record timed out.
23703
23704 .vitem &%timeout_connect%&
23705 A connection attempt timed out.
23706
23707 .vitem &%timeout_MX%&
23708 There was a timeout while connecting or during an SMTP session with a host
23709 obtained from an MX record.
23710
23711 .vitem &%timeout_A%&
23712 There was a timeout while connecting or during an SMTP session with a host not
23713 obtained from an MX record.
23714
23715 .vitem &%timeout%&
23716 There was a timeout while connecting or during an SMTP session.
23717
23718 .vitem &%tls_required%&
23719 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23720 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23721 to STARTTLS, or there was a problem setting up the TLS connection.
23722
23723 .vitem &%quota%&
23724 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23725 transport.
23726
23727 .vitem &%quota_%&<&'time'&>
23728 .cindex "quota" "error testing in retry rule"
23729 .cindex "retry" "quota error testing"
23730 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23731 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23732 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23733 for four days.
23734 .endlist
23735
23736 .cindex "mailbox" "time of last read"
23737 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23738 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23739 it should be based on the last time that the user accessed the mailbox.
23740 However, it is not always possible to determine this. Exim uses the following
23741 heuristic rules:
23742
23743 .ilist
23744 If the mailbox is a single file, the time of last access (the &"atime"&) is
23745 used. As no new messages are being delivered (because the mailbox is over
23746 quota), Exim does not access the file, so this is the time of last user access.
23747 .next
23748 .cindex "maildir format" "time of last read"
23749 For a maildir delivery, the time of last modification of the &_new_&
23750 subdirectory is used. As the mailbox is over quota, no new files are created in
23751 the &_new_& subdirectory, because no new messages are being delivered. Any
23752 change to the &_new_& subdirectory is therefore assumed to be the result of an
23753 MUA moving a new message to the &_cur_& directory when it is first read. The
23754 time that is used is therefore the last time that the user read a new message.
23755 .next
23756 For other kinds of multi-file mailbox, the time of last access cannot be
23757 obtained, so a retry rule that uses this type of error field is never matched.
23758 .endlist
23759
23760 The quota errors apply both to system-enforced quotas and to Exim's own quota
23761 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23762 when a local delivery is deferred because a partition is full (the ENOSPC
23763 error).
23764
23765
23766
23767 .section "Retry rules for specified senders" "SECID162"
23768 .cindex "retry" "rules; sender-specific"
23769 You can specify retry rules that apply only when the failing message has a
23770 specific sender. In particular, this can be used to define retry rules that
23771 apply only to bounce messages. The third item in a retry rule can be of this
23772 form:
23773 .display
23774 &`senders=`&<&'address list'&>
23775 .endd
23776 The retry timings themselves are then the fourth item. For example:
23777 .code
23778 *   rcpt_4xx   senders=:   F,1h,30m
23779 .endd
23780 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23781 host. If the address list contains white space, it must be enclosed in quotes.
23782 For example:
23783 .code
23784 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23785 .endd
23786 &*Warning*&: This facility can be unhelpful if it is used for host errors
23787 (which do not depend on the recipient). The reason is that the sender is used
23788 only to match the retry rule. Once the rule has been found for a host error,
23789 its contents are used to set a retry time for the host, and this will apply to
23790 all messages, not just those with specific senders.
23791
23792 When testing retry rules using &%-brt%&, you can supply a sender using the
23793 &%-f%& command line option, like this:
23794 .code
23795 exim -f "" -brt user@dom.ain
23796 .endd
23797 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23798 list is never matched.
23799
23800
23801
23802
23803
23804 .section "Retry parameters" "SECID163"
23805 .cindex "retry" "parameters in rules"
23806 The third (or fourth, if a senders list is present) field in a retry rule is a
23807 sequence of retry parameter sets, separated by semicolons. Each set consists of
23808 .display
23809 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23810 .endd
23811 The letter identifies the algorithm for computing a new retry time; the cutoff
23812 time is the time beyond which this algorithm no longer applies, and the
23813 arguments vary the algorithm's action. The cutoff time is measured from the
23814 time that the first failure for the domain (combined with the local part if
23815 relevant) was detected, not from the time the message was received.
23816
23817 .cindex "retry" "algorithms"
23818 .cindex "retry" "fixed intervals"
23819 .cindex "retry" "increasing intervals"
23820 .cindex "retry" "random intervals"
23821 The available algorithms are:
23822
23823 .ilist
23824 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23825 the interval.
23826 .next
23827 &'G'&: retry at geometrically increasing intervals. The first argument
23828 specifies a starting value for the interval, and the second a multiplier, which
23829 is used to increase the size of the interval at each retry.
23830 .next
23831 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23832 retry, the previous interval is multiplied by the factor in order to get a
23833 maximum for the next interval. The minimum interval is the first argument of
23834 the parameter, and an actual interval is chosen randomly between them. Such a
23835 rule has been found to be helpful in cluster configurations when all the
23836 members of the cluster restart at once, and may therefore synchronize their
23837 queue processing times.
23838 .endlist
23839
23840 When computing the next retry time, the algorithm definitions are scanned in
23841 order until one whose cutoff time has not yet passed is reached. This is then
23842 used to compute a new retry time that is later than the current time. In the
23843 case of fixed interval retries, this simply means adding the interval to the
23844 current time. For geometrically increasing intervals, retry intervals are
23845 computed from the rule's parameters until one that is greater than the previous
23846 interval is found. The main configuration variable
23847 .cindex "limit" "retry interval"
23848 .cindex "retry" "interval, maximum"
23849 .oindex "&%retry_interval_max%&"
23850 &%retry_interval_max%& limits the maximum interval between retries. It
23851 cannot be set greater than &`24h`&, which is its default value.
23852
23853 A single remote domain may have a number of hosts associated with it, and each
23854 host may have more than one IP address. Retry algorithms are selected on the
23855 basis of the domain name, but are applied to each IP address independently. If,
23856 for example, a host has two IP addresses and one is unusable, Exim will
23857 generate retry times for it and will not try to use it until its next retry
23858 time comes. Thus the good IP address is likely to be tried first most of the
23859 time.
23860
23861 .cindex "hints database" "use for retrying"
23862 Retry times are hints rather than promises. Exim does not make any attempt to
23863 run deliveries exactly at the computed times. Instead, a queue runner process
23864 starts delivery processes for delayed messages periodically, and these attempt
23865 new deliveries only for those addresses that have passed their next retry time.
23866 If a new message arrives for a deferred address, an immediate delivery attempt
23867 occurs only if the address has passed its retry time. In the absence of new
23868 messages, the minimum time between retries is the interval between queue runner
23869 processes. There is not much point in setting retry times of five minutes if
23870 your queue runners happen only once an hour, unless there are a significant
23871 number of incoming messages (which might be the case on a system that is
23872 sending everything to a smart host, for example).
23873
23874 The data in the retry hints database can be inspected by using the
23875 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23876 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23877 &'exinext'& utility script can be used to find out what the next retry times
23878 are for the hosts associated with a particular mail domain, and also for local
23879 deliveries that have been deferred.
23880
23881
23882 .section "Retry rule examples" "SECID164"
23883 Here are some example retry rules:
23884 .code
23885 alice@wonderland.fict.example quota_5d  F,7d,3h
23886 wonderland.fict.example       quota_5d
23887 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23888 lookingglass.fict.example     *         F,24h,30m;
23889 *                 refused_A   F,2h,20m;
23890 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23891 .endd
23892 The first rule sets up special handling for mail to
23893 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23894 mailbox has not been read for at least 5 days. Retries continue every three
23895 hours for 7 days. The second rule handles over-quota errors for all other local
23896 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23897 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23898 fail are bounced immediately if the mailbox has not been read for at least 5
23899 days.
23900
23901 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23902 happen every 15 minutes for an hour, then with geometrically increasing
23903 intervals until two days have passed since a delivery first failed. After the
23904 first hour there is a delay of one hour, then two hours, then four hours, and
23905 so on (this is a rather extreme example).
23906
23907 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23908 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23909 all other domains, with special action for connection refusal from hosts that
23910 were not obtained from an MX record.
23911
23912 The final rule in a retry configuration should always have asterisks in the
23913 first two fields so as to provide a general catch-all for any addresses that do
23914 not have their own special handling. This example tries every 15 minutes for 2
23915 hours, then with intervals starting at one hour and increasing by a factor of
23916 1.5 up to 16 hours, then every 8 hours up to 5 days.
23917
23918
23919
23920 .section "Timeout of retry data" "SECID165"
23921 .cindex "timeout" "of retry data"
23922 .oindex "&%retry_data_expire%&"
23923 .cindex "hints database" "data expiry"
23924 .cindex "retry" "timeout of data"
23925 Exim timestamps the data that it writes to its retry hints database. When it
23926 consults the data during a delivery it ignores any that is older than the value
23927 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23928 been tried for 7 days, Exim will try to deliver to it immediately a message
23929 arrives, and if that fails, it will calculate a retry time as if it were
23930 failing for the first time.
23931
23932 This improves the behaviour for messages routed to rarely-used hosts such as MX
23933 backups. If such a host was down at one time, and happens to be down again when
23934 Exim tries a month later, using the old retry data would imply that it had been
23935 down all the time, which is not a justified assumption.
23936
23937 If a host really is permanently dead, this behaviour causes a burst of retries
23938 every now and again, but only if messages routed to it are rare. If there is a
23939 message at least once every 7 days the retry data never expires.
23940
23941
23942
23943
23944 .section "Long-term failures" "SECID166"
23945 .cindex "delivery failure, long-term"
23946 .cindex "retry" "after long-term failure"
23947 Special processing happens when an email address has been failing for so long
23948 that the cutoff time for the last algorithm is reached. For example, using the
23949 default retry rule:
23950 .code
23951 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23952 .endd
23953 the cutoff time is four days. Reaching the retry cutoff is independent of how
23954 long any specific message has been failing; it is the length of continuous
23955 failure for the recipient address that counts.
23956
23957 When the cutoff time is reached for a local delivery, or for all the IP
23958 addresses associated with a remote delivery, a subsequent delivery failure
23959 causes Exim to give up on the address, and a bounce message is generated.
23960 In order to cater for new messages that use the failing address, a next retry
23961 time is still computed from the final algorithm, and is used as follows:
23962
23963 For local deliveries, one delivery attempt is always made for any subsequent
23964 messages. If this delivery fails, the address fails immediately. The
23965 post-cutoff retry time is not used.
23966
23967 If the delivery is remote, there are two possibilities, controlled by the
23968 .oindex "&%delay_after_cutoff%&"
23969 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23970 default. Until the post-cutoff retry time for one of the IP addresses is
23971 reached, the failing email address is bounced immediately, without a delivery
23972 attempt taking place. After that time, one new delivery attempt is made to
23973 those IP addresses that are past their retry times, and if that still fails,
23974 the address is bounced and new retry times are computed.
23975
23976 In other words, when all the hosts for a given email address have been failing
23977 for a long time, Exim bounces rather then defers until one of the hosts' retry
23978 times is reached. Then it tries once, and bounces if that attempt fails. This
23979 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23980 to a broken destination, but if the host does recover, Exim will eventually
23981 notice.
23982
23983 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23984 addresses are past their final cutoff time, Exim tries to deliver to those IP
23985 addresses that have not been tried since the message arrived. If there are
23986 no suitable IP addresses, or if they all fail, the address is bounced. In other
23987 words, it does not delay when a new message arrives, but tries the expired
23988 addresses immediately, unless they have been tried since the message arrived.
23989 If there is a continuous stream of messages for the failing domains, setting
23990 &%delay_after_cutoff%& false means that there will be many more attempts to
23991 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23992 true.
23993
23994 .section "Deliveries that work intermittently" "SECID167"
23995 .cindex "retry" "intermittently working deliveries"
23996 Some additional logic is needed to cope with cases where a host is
23997 intermittently available, or when a message has some attribute that prevents
23998 its delivery when others to the same address get through. In this situation,
23999 because some messages are successfully delivered, the &"retry clock"& for the
24000 host or address keeps getting reset by the successful deliveries, and so
24001 failing messages remain on the queue for ever because the cutoff time is never
24002 reached.
24003
24004 Two exceptional actions are applied to prevent this happening. The first
24005 applies to errors that are related to a message rather than a remote host.
24006 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24007 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24008 commands, and quota failures. For this type of error, if a message's arrival
24009 time is earlier than the &"first failed"& time for the error, the earlier time
24010 is used when scanning the retry rules to decide when to try next and when to
24011 time out the address.
24012
24013 The exceptional second action applies in all cases. If a message has been on
24014 the queue for longer than the cutoff time of any applicable retry rule for a
24015 given address, a delivery is attempted for that address, even if it is not yet
24016 time, and if this delivery fails, the address is timed out. A new retry time is
24017 not computed in this case, so that other messages for the same address are
24018 considered immediately.
24019 .ecindex IIDretconf1
24020 .ecindex IIDregconf2
24021
24022
24023
24024
24025
24026
24027 . ////////////////////////////////////////////////////////////////////////////
24028 . ////////////////////////////////////////////////////////////////////////////
24029
24030 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24031 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24032 .scindex IIDauthconf2 "authentication"
24033 The &"authenticators"& section of Exim's run time configuration is concerned
24034 with SMTP authentication. This facility is an extension to the SMTP protocol,
24035 described in RFC 2554, which allows a client SMTP host to authenticate itself
24036 to a server. This is a common way for a server to recognize clients that are
24037 permitted to use it as a relay. SMTP authentication is not of relevance to the
24038 transfer of mail between servers that have no managerial connection with each
24039 other.
24040
24041 .cindex "AUTH" "description of"
24042 Very briefly, the way SMTP authentication works is as follows:
24043
24044 .ilist
24045 The server advertises a number of authentication &'mechanisms'& in response to
24046 the client's EHLO command.
24047 .next
24048 The client issues an AUTH command, naming a specific mechanism. The command
24049 may, optionally, contain some authentication data.
24050 .next
24051 The server may issue one or more &'challenges'&, to which the client must send
24052 appropriate responses. In simple authentication mechanisms, the challenges are
24053 just prompts for user names and passwords. The server does not have to issue
24054 any challenges &-- in some mechanisms the relevant data may all be transmitted
24055 with the AUTH command.
24056 .next
24057 The server either accepts or denies authentication.
24058 .next
24059 If authentication succeeds, the client may optionally make use of the AUTH
24060 option on the MAIL command to pass an authenticated sender in subsequent
24061 mail transactions. Authentication lasts for the remainder of the SMTP
24062 connection.
24063 .next
24064 If authentication fails, the client may give up, or it may try a different
24065 authentication mechanism, or it may try transferring mail over the
24066 unauthenticated connection.
24067 .endlist
24068
24069 If you are setting up a client, and want to know which authentication
24070 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24071 SMTP port) on the server, and issue an EHLO command. The response to this
24072 includes the list of supported mechanisms. For example:
24073 .display
24074 &`$ `&&*&`telnet server.example 25`&*&
24075 &`Trying 192.168.34.25...`&
24076 &`Connected to server.example.`&
24077 &`Escape character is &#x0027;^]&#x0027;.`&
24078 &`220 server.example ESMTP Exim 4.20 ...`&
24079 &*&`ehlo client.example`&*&
24080 &`250-server.example Hello client.example [10.8.4.5]`&
24081 &`250-SIZE 52428800`&
24082 &`250-PIPELINING`&
24083 &`250-AUTH PLAIN`&
24084 &`250 HELP`&
24085 .endd
24086 The second-last line of this example output shows that the server supports
24087 authentication using the PLAIN mechanism. In Exim, the different authentication
24088 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24089 routers and transports, which authenticators are included in the binary is
24090 controlled by build-time definitions. The following are currently available,
24091 included by setting
24092 .code
24093 AUTH_CRAM_MD5=yes
24094 AUTH_CYRUS_SASL=yes
24095 AUTH_DOVECOT=yes
24096 AUTH_GSASL=yes
24097 AUTH_HEIMDAL_GSSAPI=yes
24098 AUTH_PLAINTEXT=yes
24099 AUTH_SPA=yes
24100 .endd
24101 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24102 authentication mechanism (RFC 2195), and the second provides an interface to
24103 the Cyrus SASL authentication library.
24104 The third is an interface to Dovecot's authentication system, delegating the
24105 work via a socket interface.
24106 The fourth provides an interface to the GNU SASL authentication library, which
24107 provides mechanisms but typically not data sources.
24108 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24109 supporting setting a server keytab.
24110 The sixth can be configured to support
24111 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24112 not formally documented, but used by several MUAs. The seventh authenticator
24113 supports Microsoft's &'Secure Password Authentication'& mechanism.
24114
24115 The authenticators are configured using the same syntax as other drivers (see
24116 section &<<SECTfordricon>>&). If no authenticators are required, no
24117 authentication section need be present in the configuration file. Each
24118 authenticator can in principle have both server and client functions. When Exim
24119 is receiving SMTP mail, it is acting as a server; when it is sending out
24120 messages over SMTP, it is acting as a client. Authenticator configuration
24121 options are provided for use in both these circumstances.
24122
24123 To make it clear which options apply to which situation, the prefixes
24124 &%server_%& and &%client_%& are used on option names that are specific to
24125 either the server or the client function, respectively. Server and client
24126 functions are disabled if none of their options are set. If an authenticator is
24127 to be used for both server and client functions, a single definition, using
24128 both sets of options, is required. For example:
24129 .code
24130 cram:
24131   driver = cram_md5
24132   public_name = CRAM-MD5
24133   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24134   client_name = ph10
24135   client_secret = secret2
24136 .endd
24137 The &%server_%& option is used when Exim is acting as a server, and the
24138 &%client_%& options when it is acting as a client.
24139
24140 Descriptions of the individual authenticators are given in subsequent chapters.
24141 The remainder of this chapter covers the generic options for the
24142 authenticators, followed by general discussion of the way authentication works
24143 in Exim.
24144
24145 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24146 per-mechanism basis.  Please read carefully to determine which variables hold
24147 account labels such as usercodes and which hold passwords or other
24148 authenticating data.
24149
24150 Note that some mechanisms support two different identifiers for accounts: the
24151 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24152 and &'authz'& are commonly encountered.  The American spelling is standard here.
24153 Conceptually, authentication data such as passwords are tied to the identifier
24154 used to authenticate; servers may have rules to permit one user to act as a
24155 second user, so that after login the session is treated as though that second
24156 user had logged in.  That second user is the &'authorization id'&.  A robust
24157 configuration might confirm that the &'authz'& field is empty or matches the
24158 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24159 as verified data, the &'authz'& as an unverified request which the server might
24160 choose to honour.
24161
24162 A &'realm'& is a text string, typically a domain name, presented by a server
24163 to a client to help it select an account and credentials to use.  In some
24164 mechanisms, the client and server provably agree on the realm, but clients
24165 typically can not treat the realm as secure data to be blindly trusted.
24166
24167
24168
24169 .section "Generic options for authenticators" "SECID168"
24170 .cindex "authentication" "generic options"
24171 .cindex "options" "generic; for authenticators"
24172
24173 .option client_condition authenticators string&!! unset
24174 When Exim is authenticating as a client, it skips any authenticator whose
24175 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24176 used, for example, to skip plain text authenticators when the connection is not
24177 encrypted by a setting such as:
24178 .code
24179 client_condition = ${if !eq{$tls_out_cipher}{}}
24180 .endd
24181
24182
24183 .option client_set_id authenticators string&!! unset
24184 When client authentication succeeds, this condition is expanded; the
24185 result is used in the log lines for outbound messasges.
24186 Typically it will be the user name used for authentication.
24187
24188
24189 .option driver authenticators string unset
24190 This option must always be set. It specifies which of the available
24191 authenticators is to be used.
24192
24193
24194 .option public_name authenticators string unset
24195 This option specifies the name of the authentication mechanism that the driver
24196 implements, and by which it is known to the outside world. These names should
24197 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24198 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24199 defaults to the driver's instance name.
24200
24201
24202 .option server_advertise_condition authenticators string&!! unset
24203 When a server is about to advertise an authentication mechanism, the condition
24204 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24205 mechanism is not advertised.
24206 If the expansion fails, the mechanism is not advertised. If the failure was not
24207 forced, and was not caused by a lookup defer, the incident is logged.
24208 See section &<<SECTauthexiser>>& below for further discussion.
24209
24210
24211 .option server_condition authenticators string&!! unset
24212 This option must be set for a &%plaintext%& server authenticator, where it
24213 is used directly to control authentication. See section &<<SECTplainserver>>&
24214 for details.
24215
24216 For the &(gsasl)& authenticator, this option is required for various
24217 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24218
24219 For the other authenticators, &%server_condition%& can be used as an additional
24220 authentication or authorization mechanism that is applied after the other
24221 authenticator conditions succeed. If it is set, it is expanded when the
24222 authenticator would otherwise return a success code. If the expansion is forced
24223 to fail, authentication fails. Any other expansion failure causes a temporary
24224 error code to be returned. If the result of a successful expansion is an empty
24225 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24226 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24227 other result, a temporary error code is returned, with the expanded string as
24228 the error text.
24229
24230
24231 .option server_debug_print authenticators string&!! unset
24232 If this option is set and authentication debugging is enabled (see the &%-d%&
24233 command line option), the string is expanded and included in the debugging
24234 output when the authenticator is run as a server. This can help with checking
24235 out the values of variables.
24236 If expansion of the string fails, the error message is written to the debugging
24237 output, and Exim carries on processing.
24238
24239
24240 .option server_set_id authenticators string&!! unset
24241 .vindex "&$authenticated_id$&"
24242 When an Exim server successfully authenticates a client, this string is
24243 expanded using data from the authentication, and preserved for any incoming
24244 messages in the variable &$authenticated_id$&. It is also included in the log
24245 lines for incoming messages. For example, a user/password authenticator
24246 configuration might preserve the user name that was used to authenticate, and
24247 refer to it subsequently during delivery of the message.
24248 If expansion fails, the option is ignored.
24249
24250
24251 .option server_mail_auth_condition authenticators string&!! unset
24252 This option allows a server to discard authenticated sender addresses supplied
24253 as part of MAIL commands in SMTP connections that are authenticated by the
24254 driver on which &%server_mail_auth_condition%& is set. The option is not used
24255 as part of the authentication process; instead its (unexpanded) value is
24256 remembered for later use.
24257 How it is used is described in the following section.
24258
24259
24260
24261
24262
24263 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24264 .cindex "authentication" "sender; authenticated"
24265 .cindex "AUTH" "on MAIL command"
24266 When a client supplied an AUTH= item on a MAIL command, Exim applies
24267 the following checks before accepting it as the authenticated sender of the
24268 message:
24269
24270 .ilist
24271 If the connection is not using extended SMTP (that is, HELO was used rather
24272 than EHLO), the use of AUTH= is a syntax error.
24273 .next
24274 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24275 .next
24276 .vindex "&$authenticated_sender$&"
24277 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24278 running, the value of &$authenticated_sender$& is set to the value obtained
24279 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24280 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24281 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24282 given for the MAIL command.
24283 .next
24284 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24285 is accepted and placed in &$authenticated_sender$& only if the client has
24286 authenticated.
24287 .next
24288 If the AUTH= value was accepted by either of the two previous rules, and
24289 the client has authenticated, and the authenticator has a setting for the
24290 &%server_mail_auth_condition%&, the condition is checked at this point. The
24291 valued that was saved from the authenticator is expanded. If the expansion
24292 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24293 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24294 the value of &$authenticated_sender$& is retained and passed on with the
24295 message.
24296 .endlist
24297
24298
24299 When &$authenticated_sender$& is set for a message, it is passed on to other
24300 hosts to which Exim authenticates as a client. Do not confuse this value with
24301 &$authenticated_id$&, which is a string obtained from the authentication
24302 process, and which is not usually a complete email address.
24303
24304 .vindex "&$sender_address$&"
24305 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24306 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24307 therefore make use of &$authenticated_sender$&. The converse is not true: the
24308 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24309 ACL is run.
24310
24311
24312
24313 .section "Authentication on an Exim server" "SECTauthexiser"
24314 .cindex "authentication" "on an Exim server"
24315 When Exim receives an EHLO command, it advertises the public names of those
24316 authenticators that are configured as servers, subject to the following
24317 conditions:
24318
24319 .ilist
24320 The client host must match &%auth_advertise_hosts%& (default *).
24321 .next
24322 It the &%server_advertise_condition%& option is set, its expansion must not
24323 yield the empty string, &"0"&, &"no"&, or &"false"&.
24324 .endlist
24325
24326 The order in which the authenticators are defined controls the order in which
24327 the mechanisms are advertised.
24328
24329 Some mail clients (for example, some versions of Netscape) require the user to
24330 provide a name and password for authentication whenever AUTH is advertised,
24331 even though authentication may not in fact be needed (for example, Exim may be
24332 set up to allow unconditional relaying from the client by an IP address check).
24333 You can make such clients more friendly by not advertising AUTH to them.
24334 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24335 that runs for RCPT) to relay without authentication, you should set
24336 .code
24337 auth_advertise_hosts = ! 10.9.8.0/24
24338 .endd
24339 so that no authentication mechanisms are advertised to them.
24340
24341 The &%server_advertise_condition%& controls the advertisement of individual
24342 authentication mechanisms. For example, it can be used to restrict the
24343 advertisement of a particular mechanism to encrypted connections, by a setting
24344 such as:
24345 .code
24346 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24347 .endd
24348 .vindex "&$tls_in_cipher$&"
24349 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24350 yields &"yes"&, which allows the advertisement to happen.
24351
24352 When an Exim server receives an AUTH command from a client, it rejects it
24353 immediately if AUTH was not advertised in response to an earlier EHLO
24354 command. This is the case if
24355
24356 .ilist
24357 The client host does not match &%auth_advertise_hosts%&; or
24358 .next
24359 No authenticators are configured with server options; or
24360 .next
24361 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24362 server authenticators.
24363 .endlist
24364
24365
24366 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24367 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24368 AUTH is accepted from any client host.
24369
24370 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24371 server authentication mechanism that was advertised in response to EHLO and
24372 that matches the one named in the AUTH command. If it finds one, it runs
24373 the appropriate authentication protocol, and authentication either succeeds or
24374 fails. If there is no matching advertised mechanism, the AUTH command is
24375 rejected with a 504 error.
24376
24377 .vindex "&$received_protocol$&"
24378 .vindex "&$sender_host_authenticated$&"
24379 When a message is received from an authenticated host, the value of
24380 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24381 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24382 public name) of the authenticator driver that successfully authenticated the
24383 client from which the message was received. This variable is empty if there was
24384 no successful authentication.
24385
24386
24387
24388
24389 .section "Testing server authentication" "SECID169"
24390 .cindex "authentication" "testing a server"
24391 .cindex "AUTH" "testing a server"
24392 .cindex "base64 encoding" "creating authentication test data"
24393 Exim's &%-bh%& option can be useful for testing server authentication
24394 configurations. The data for the AUTH command has to be sent using base64
24395 encoding. A quick way to produce such data for testing is the following Perl
24396 script:
24397 .code
24398 use MIME::Base64;
24399 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24400 .endd
24401 .cindex "binary zero" "in authentication data"
24402 This interprets its argument as a Perl string, and then encodes it. The
24403 interpretation as a Perl string allows binary zeros, which are required for
24404 some kinds of authentication, to be included in the data. For example, a
24405 command line to run this script on such data might be
24406 .code
24407 encode '\0user\0password'
24408 .endd
24409 Note the use of single quotes to prevent the shell interpreting the
24410 backslashes, so that they can be interpreted by Perl to specify characters
24411 whose code value is zero.
24412
24413 &*Warning 1*&: If either of the user or password strings starts with an octal
24414 digit, you must use three zeros instead of one after the leading backslash. If
24415 you do not, the octal digit that starts your string will be incorrectly
24416 interpreted as part of the code for the first character.
24417
24418 &*Warning 2*&: If there are characters in the strings that Perl interprets
24419 specially, you must use a Perl escape to prevent them being misinterpreted. For
24420 example, a command such as
24421 .code
24422 encode '\0user@domain.com\0pas$$word'
24423 .endd
24424 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24425
24426 If you have the &%mimencode%& command installed, another way to do produce
24427 base64-encoded strings is to run the command
24428 .code
24429 echo -e -n `\0user\0password' | mimencode
24430 .endd
24431 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24432 in the argument, and the &%-n%& option specifies no newline at the end of its
24433 output. However, not all versions of &%echo%& recognize these options, so you
24434 should check your version before relying on this suggestion.
24435
24436
24437
24438 .section "Authentication by an Exim client" "SECID170"
24439 .cindex "authentication" "on an Exim client"
24440 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24441 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24442 announces support for authentication, and the host matches an entry in either
24443 of these options, Exim (as a client) tries to authenticate as follows:
24444
24445 .ilist
24446 For each authenticator that is configured as a client, in the order in which
24447 they are defined in the configuration, it searches the authentication
24448 mechanisms announced by the server for one whose name matches the public name
24449 of the authenticator.
24450 .next
24451 .vindex "&$host$&"
24452 .vindex "&$host_address$&"
24453 When it finds one that matches, it runs the authenticator's client code. The
24454 variables &$host$& and &$host_address$& are available for any string expansions
24455 that the client might do. They are set to the server's name and IP address. If
24456 any expansion is forced to fail, the authentication attempt is abandoned, and
24457 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24458 delivery to be deferred.
24459 .next
24460 If the result of the authentication attempt is a temporary error or a timeout,
24461 Exim abandons trying to send the message to the host for the moment. It will
24462 try again later. If there are any backup hosts available, they are tried in the
24463 usual way.
24464 .next
24465 If the response to authentication is a permanent error (5&'xx'& code), Exim
24466 carries on searching the list of authenticators and tries another one if
24467 possible. If all authentication attempts give permanent errors, or if there are
24468 no attempts because no mechanisms match (or option expansions force failure),
24469 what happens depends on whether the host matches &%hosts_require_auth%& or
24470 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24471 delivery is deferred. The error can be detected in the retry rules, and thereby
24472 turned into a permanent error if you wish. In the second case, Exim tries to
24473 deliver the message unauthenticated.
24474 .endlist
24475
24476 .cindex "AUTH" "on MAIL command"
24477 When Exim has authenticated itself to a remote server, it adds the AUTH
24478 parameter to the MAIL commands it sends, if it has an authenticated sender for
24479 the message. If the message came from a remote host, the authenticated sender
24480 is the one that was receiving on an incoming MAIL command, provided that the
24481 incoming connection was authenticated and the &%server_mail_auth%& condition
24482 allowed the authenticated sender to be retained. If a local process calls Exim
24483 to send a message, the sender address that is built from the login name and
24484 &%qualify_domain%& is treated as authenticated. However, if the
24485 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24486 the authenticated sender that was received with the message.
24487 .ecindex IIDauthconf1
24488 .ecindex IIDauthconf2
24489
24490
24491
24492
24493
24494
24495 . ////////////////////////////////////////////////////////////////////////////
24496 . ////////////////////////////////////////////////////////////////////////////
24497
24498 .chapter "The plaintext authenticator" "CHAPplaintext"
24499 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24500 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24501 The &(plaintext)& authenticator can be configured to support the PLAIN and
24502 LOGIN authentication mechanisms, both of which transfer authentication data as
24503 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24504 security risk; you are strongly advised to insist on the use of SMTP encryption
24505 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24506 use unencrypted plain text, you should not use the same passwords for SMTP
24507 connections as you do for login accounts.
24508
24509 .section "Plaintext options" "SECID171"
24510 .cindex "options" "&(plaintext)& authenticator (server)"
24511 When configured as a server, &(plaintext)& uses the following options:
24512
24513 .option server_condition authenticators string&!! unset
24514 This is actually a global authentication option, but it must be set in order to
24515 configure the &(plaintext)& driver as a server. Its use is described below.
24516
24517 .option server_prompts plaintext string&!! unset
24518 The contents of this option, after expansion, must be a colon-separated list of
24519 prompt strings. If expansion fails, a temporary authentication rejection is
24520 given.
24521
24522 .section "Using plaintext in a server" "SECTplainserver"
24523 .cindex "AUTH" "in &(plaintext)& authenticator"
24524 .cindex "binary zero" "in &(plaintext)& authenticator"
24525 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24526         "in &(plaintext)& authenticator"
24527 .vindex "&$auth1$&, &$auth2$&, etc"
24528 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24529
24530 When running as a server, &(plaintext)& performs the authentication test by
24531 expanding a string. The data sent by the client with the AUTH command, or in
24532 response to subsequent prompts, is base64 encoded, and so may contain any byte
24533 values when decoded. If any data is supplied with the command, it is treated as
24534 a list of strings, separated by NULs (binary zeros), the first three of which
24535 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24536 (neither LOGIN nor PLAIN uses more than three strings).
24537
24538 For compatibility with previous releases of Exim, the values are also placed in
24539 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24540 variables for this purpose is now deprecated, as it can lead to confusion in
24541 string expansions that also use them for other things.
24542
24543 If there are more strings in &%server_prompts%& than the number of strings
24544 supplied with the AUTH command, the remaining prompts are used to obtain more
24545 data. Each response from the client may be a list of NUL-separated strings.
24546
24547 .vindex "&$authenticated_id$&"
24548 Once a sufficient number of data strings have been received,
24549 &%server_condition%& is expanded. If the expansion is forced to fail,
24550 authentication fails. Any other expansion failure causes a temporary error code
24551 to be returned. If the result of a successful expansion is an empty string,
24552 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24553 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24554 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24555 For any other result, a temporary error code is returned, with the expanded
24556 string as the error text, and the failed id saved in
24557 &$authenticated_fail_id$&.
24558
24559 &*Warning*&: If you use a lookup in the expansion to find the user's
24560 password, be sure to make the authentication fail if the user is unknown.
24561 There are good and bad examples at the end of the next section.
24562
24563
24564
24565 .section "The PLAIN authentication mechanism" "SECID172"
24566 .cindex "PLAIN authentication mechanism"
24567 .cindex "authentication" "PLAIN mechanism"
24568 .cindex "binary zero" "in &(plaintext)& authenticator"
24569 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24570 sent as one item of data (that is, one combined string containing two NUL
24571 separators). The data is sent either as part of the AUTH command, or
24572 subsequently in response to an empty prompt from the server.
24573
24574 The second and third strings are a user name and a corresponding password.
24575 Using a single fixed user name and password as an example, this could be
24576 configured as follows:
24577 .code
24578 fixed_plain:
24579   driver = plaintext
24580   public_name = PLAIN
24581   server_prompts = :
24582   server_condition = \
24583     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24584   server_set_id = $auth2
24585 .endd
24586 Note that the default result strings from &%if%& (&"true"& or an empty string)
24587 are exactly what we want here, so they need not be specified. Obviously, if the
24588 password contains expansion-significant characters such as dollar, backslash,
24589 or closing brace, they have to be escaped.
24590
24591 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24592 the end of a string list are ignored). If all the data comes as part of the
24593 AUTH command, as is commonly the case, the prompt is not used. This
24594 authenticator is advertised in the response to EHLO as
24595 .code
24596 250-AUTH PLAIN
24597 .endd
24598 and a client host can authenticate itself by sending the command
24599 .code
24600 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24601 .endd
24602 As this contains three strings (more than the number of prompts), no further
24603 data is required from the client. Alternatively, the client may just send
24604 .code
24605 AUTH PLAIN
24606 .endd
24607 to initiate authentication, in which case the server replies with an empty
24608 prompt. The client must respond with the combined data string.
24609
24610 The data string is base64 encoded, as required by the RFC. This example,
24611 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24612 represents a zero byte. This is split up into three strings, the first of which
24613 is empty. The &%server_condition%& option in the authenticator checks that the
24614 second two are &`username`& and &`mysecret`& respectively.
24615
24616 Having just one fixed user name and password, as in this example, is not very
24617 realistic, though for a small organization with only a handful of
24618 authenticating clients it could make sense.
24619
24620 A more sophisticated instance of this authenticator could use the user name in
24621 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24622 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24623 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24624 This is an incorrect example:
24625 .code
24626 server_condition = \
24627   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24628 .endd
24629 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24630 which it then compares to the supplied password (&$auth3$&). Why is this example
24631 incorrect? It works fine for existing users, but consider what happens if a
24632 non-existent user name is given. The lookup fails, but as no success/failure
24633 strings are given for the lookup, it yields an empty string. Thus, to defeat
24634 the authentication, all a client has to do is to supply a non-existent user
24635 name and an empty password. The correct way of writing this test is:
24636 .code
24637 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24638   {${if eq{$value}{$auth3}}} {false}}
24639 .endd
24640 In this case, if the lookup succeeds, the result is checked; if the lookup
24641 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24642 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24643 always fails if its second argument is empty. However, the second way of
24644 writing the test makes the logic clearer.
24645
24646
24647 .section "The LOGIN authentication mechanism" "SECID173"
24648 .cindex "LOGIN authentication mechanism"
24649 .cindex "authentication" "LOGIN mechanism"
24650 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24651 in a number of programs. No data is sent with the AUTH command. Instead, a
24652 user name and password are supplied separately, in response to prompts. The
24653 plaintext authenticator can be configured to support this as in this example:
24654 .code
24655 fixed_login:
24656   driver = plaintext
24657   public_name = LOGIN
24658   server_prompts = User Name : Password
24659   server_condition = \
24660     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24661   server_set_id = $auth1
24662 .endd
24663 Because of the way plaintext operates, this authenticator accepts data supplied
24664 with the AUTH command (in contravention of the specification of LOGIN), but
24665 if the client does not supply it (as is the case for LOGIN clients), the prompt
24666 strings are used to obtain two data items.
24667
24668 Some clients are very particular about the precise text of the prompts. For
24669 example, Outlook Express is reported to recognize only &"Username:"& and
24670 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24671 strings. It uses the &%ldapauth%& expansion condition to check the user
24672 name and password by binding to an LDAP server:
24673 .code
24674 login:
24675   driver = plaintext
24676   public_name = LOGIN
24677   server_prompts = Username:: : Password::
24678   server_condition = ${if and{{ \
24679     !eq{}{$auth1} }{ \
24680     ldapauth{\
24681       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24682       pass=${quote:$auth2} \
24683       ldap://ldap.example.org/} }} }
24684   server_set_id = uid=$auth1,ou=people,o=example.org
24685 .endd
24686 We have to check that the username is not empty before using it, because LDAP
24687 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24688 operator to correctly quote the DN for authentication. However, the basic
24689 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24690 correct one to use for the password, because quoting is needed only to make
24691 the password conform to the Exim syntax. At the LDAP level, the password is an
24692 uninterpreted string.
24693
24694
24695 .section "Support for different kinds of authentication" "SECID174"
24696 A number of string expansion features are provided for the purpose of
24697 interfacing to different ways of user authentication. These include checking
24698 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24699 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24700 &<<SECTexpcond>>&.
24701
24702
24703
24704
24705 .section "Using plaintext in a client" "SECID175"
24706 .cindex "options" "&(plaintext)& authenticator (client)"
24707 The &(plaintext)& authenticator has two client options:
24708
24709 .option client_ignore_invalid_base64 plaintext boolean false
24710 If the client receives a server prompt that is not a valid base64 string,
24711 authentication is abandoned by default. However, if this option is set true,
24712 the error in the challenge is ignored and the client sends the response as
24713 usual.
24714
24715 .option client_send plaintext string&!! unset
24716 The string is a colon-separated list of authentication data strings. Each
24717 string is independently expanded before being sent to the server. The first
24718 string is sent with the AUTH command; any more strings are sent in response
24719 to prompts from the server. Before each string is expanded, the value of the
24720 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24721 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24722 way. Thus, the prompt that is received in response to sending the first string
24723 (with the AUTH command) can be used in the expansion of the second string, and
24724 so on. If an invalid base64 string is received when
24725 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24726 &$auth$&<&'n'&> variable.
24727
24728 &*Note*&: You cannot use expansion to create multiple strings, because
24729 splitting takes priority and happens first.
24730
24731 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24732 the data, further processing is applied to each string before it is sent. If
24733 there are any single circumflex characters in the string, they are converted to
24734 NULs. Should an actual circumflex be required as data, it must be doubled in
24735 the string.
24736
24737 This is an example of a client configuration that implements the PLAIN
24738 authentication mechanism with a fixed user name and password:
24739 .code
24740 fixed_plain:
24741   driver = plaintext
24742   public_name = PLAIN
24743   client_send = ^username^mysecret
24744 .endd
24745 The lack of colons means that the entire text is sent with the AUTH
24746 command, with the circumflex characters converted to NULs. A similar example
24747 that uses the LOGIN mechanism is:
24748 .code
24749 fixed_login:
24750   driver = plaintext
24751   public_name = LOGIN
24752   client_send = : username : mysecret
24753 .endd
24754 The initial colon means that the first string is empty, so no data is sent with
24755 the AUTH command itself. The remaining strings are sent in response to
24756 prompts.
24757 .ecindex IIDplaiauth1
24758 .ecindex IIDplaiauth2
24759
24760
24761
24762
24763 . ////////////////////////////////////////////////////////////////////////////
24764 . ////////////////////////////////////////////////////////////////////////////
24765
24766 .chapter "The cram_md5 authenticator" "CHID9"
24767 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24768 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24769 .cindex "CRAM-MD5 authentication mechanism"
24770 .cindex "authentication" "CRAM-MD5 mechanism"
24771 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24772 sends a challenge string to the client, and the response consists of a user
24773 name and the CRAM-MD5 digest of the challenge string combined with a secret
24774 string (password) which is known to both server and client. Thus, the secret
24775 is not sent over the network as plain text, which makes this authenticator more
24776 secure than &(plaintext)&. However, the downside is that the secret has to be
24777 available in plain text at either end.
24778
24779
24780 .section "Using cram_md5 as a server" "SECID176"
24781 .cindex "options" "&(cram_md5)& authenticator (server)"
24782 This authenticator has one server option, which must be set to configure the
24783 authenticator as a server:
24784
24785 .option server_secret cram_md5 string&!! unset
24786 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24787 When the server receives the client's response, the user name is placed in
24788 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24789 obtain the password for that user. The server then computes the CRAM-MD5 digest
24790 that the client should have sent, and checks that it received the correct
24791 string. If the expansion of &%server_secret%& is forced to fail, authentication
24792 fails. If the expansion fails for some other reason, a temporary error code is
24793 returned to the client.
24794
24795 For compatibility with previous releases of Exim, the user name is also placed
24796 in &$1$&. However, the use of this variables for this purpose is now
24797 deprecated, as it can lead to confusion in string expansions that also use
24798 numeric variables for other things.
24799
24800 For example, the following authenticator checks that the user name given by the
24801 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24802 user name, authentication fails.
24803 .code
24804 fixed_cram:
24805   driver = cram_md5
24806   public_name = CRAM-MD5
24807   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24808   server_set_id = $auth1
24809 .endd
24810 .vindex "&$authenticated_id$&"
24811 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24812 name in &$authenticated_id$&. A more typical configuration might look up the
24813 secret string in a file, using the user name as the key. For example:
24814 .code
24815 lookup_cram:
24816   driver = cram_md5
24817   public_name = CRAM-MD5
24818   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24819                   {$value}fail}
24820   server_set_id = $auth1
24821 .endd
24822 Note that this expansion explicitly forces failure if the lookup fails
24823 because &$auth1$& contains an unknown user name.
24824
24825 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24826 using the relevant libraries, you need to know the realm to specify in the
24827 lookup and then ask for the &"userPassword"& attribute for that user in that
24828 realm, with:
24829 .code
24830 cyrusless_crammd5:
24831   driver = cram_md5
24832   public_name = CRAM-MD5
24833   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24834                   dbmjz{/etc/sasldb2}}
24835   server_set_id = $auth1
24836 .endd
24837
24838 .section "Using cram_md5 as a client" "SECID177"
24839 .cindex "options" "&(cram_md5)& authenticator (client)"
24840 When used as a client, the &(cram_md5)& authenticator has two options:
24841
24842
24843
24844 .option client_name cram_md5 string&!! "the primary host name"
24845 This string is expanded, and the result used as the user name data when
24846 computing the response to the server's challenge.
24847
24848
24849 .option client_secret cram_md5 string&!! unset
24850 This option must be set for the authenticator to work as a client. Its value is
24851 expanded and the result used as the secret string when computing the response.
24852
24853
24854 .vindex "&$host$&"
24855 .vindex "&$host_address$&"
24856 Different user names and secrets can be used for different servers by referring
24857 to &$host$& or &$host_address$& in the options. Forced failure of either
24858 expansion string is treated as an indication that this authenticator is not
24859 prepared to handle this case. Exim moves on to the next configured client
24860 authenticator. Any other expansion failure causes Exim to give up trying to
24861 send the message to the current server.
24862
24863 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24864 strings, is:
24865 .code
24866 fixed_cram:
24867   driver = cram_md5
24868   public_name = CRAM-MD5
24869   client_name = ph10
24870   client_secret = secret
24871 .endd
24872 .ecindex IIDcramauth1
24873 .ecindex IIDcramauth2
24874
24875
24876
24877 . ////////////////////////////////////////////////////////////////////////////
24878 . ////////////////////////////////////////////////////////////////////////////
24879
24880 .chapter "The cyrus_sasl authenticator" "CHID10"
24881 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24882 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24883 .cindex "Cyrus" "SASL library"
24884 .cindex "Kerberos"
24885 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24886 Digital Ltd (&url(http://www.aldigital.co.uk)).
24887
24888 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24889 library implementation of the RFC 2222 (&"Simple Authentication and Security
24890 Layer"&). This library supports a number of authentication mechanisms,
24891 including PLAIN and LOGIN, but also several others that Exim does not support
24892 directly. In particular, there is support for Kerberos authentication.
24893
24894 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24895 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24896 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24897 name of the driver to determine which mechanism to support.
24898
24899 Where access to some kind of secret file is required, for example in GSSAPI
24900 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24901 user, and that the Cyrus SASL library has no way of escalating privileges
24902 by default. You may also find you need to set environment variables,
24903 depending on the driver you are using.
24904
24905 The application name provided by Exim is &"exim"&, so various SASL options may
24906 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24907 Kerberos, note that because of limitations in the GSSAPI interface,
24908 changing the server keytab might need to be communicated down to the Kerberos
24909 layer independently. The mechanism for doing so is dependent upon the Kerberos
24910 implementation.
24911
24912 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24913 may be set to point to an alternative keytab file. Exim will pass this
24914 variable through from its own inherited environment when started as root or the
24915 Exim user. The keytab file needs to be readable by the Exim user.
24916 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24917 environment variable.  In practice, for those releases, the Cyrus authenticator
24918 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24919 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24920
24921
24922 .section "Using cyrus_sasl as a server" "SECID178"
24923 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24924 (on a successful authentication) into &$auth1$&. For compatibility with
24925 previous releases of Exim, the username is also placed in &$1$&. However, the
24926 use of this variable for this purpose is now deprecated, as it can lead to
24927 confusion in string expansions that also use numeric variables for other
24928 things.
24929
24930
24931 .option server_hostname cyrus_sasl string&!! "see below"
24932 This option selects the hostname that is used when communicating with the
24933 library. The default value is &`$primary_hostname`&. It is up to the underlying
24934 SASL plug-in what it does with this data.
24935
24936
24937 .option server_mech cyrus_sasl string "see below"
24938 This option selects the authentication mechanism this driver should use. The
24939 default is the value of the generic &%public_name%& option. This option allows
24940 you to use a different underlying mechanism from the advertised name. For
24941 example:
24942 .code
24943 sasl:
24944   driver = cyrus_sasl
24945   public_name = X-ANYTHING
24946   server_mech = CRAM-MD5
24947   server_set_id = $auth1
24948 .endd
24949
24950 .option server_realm cyrus_sasl string&!! unset
24951 This specifies the SASL realm that the server claims to be in.
24952
24953
24954 .option server_service cyrus_sasl string &`smtp`&
24955 This is the SASL service that the server claims to implement.
24956
24957
24958 For straightforward cases, you do not need to set any of the authenticator's
24959 private options. All you need to do is to specify an appropriate mechanism as
24960 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24961 PLAIN, you could have two authenticators as follows:
24962 .code
24963 sasl_cram_md5:
24964   driver = cyrus_sasl
24965   public_name = CRAM-MD5
24966   server_set_id = $auth1
24967
24968 sasl_plain:
24969   driver = cyrus_sasl
24970   public_name = PLAIN
24971   server_set_id = $auth2
24972 .endd
24973 Cyrus SASL does implement the LOGIN authentication method, even though it is
24974 not a standard method. It is disabled by default in the source distribution,
24975 but it is present in many binary distributions.
24976 .ecindex IIDcyrauth1
24977 .ecindex IIDcyrauth2
24978
24979
24980
24981
24982 . ////////////////////////////////////////////////////////////////////////////
24983 . ////////////////////////////////////////////////////////////////////////////
24984 .chapter "The dovecot authenticator" "CHAPdovecot"
24985 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24986 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24987 This authenticator is an interface to the authentication facility of the
24988 Dovecot POP/IMAP server, which can support a number of authentication methods.
24989 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24990 to use the same mechanisms for SMTP authentication. This is a server
24991 authenticator only. There is only one option:
24992
24993 .option server_socket dovecot string unset
24994
24995 This option must specify the socket that is the interface to Dovecot
24996 authentication. The &%public_name%& option must specify an authentication
24997 mechanism that Dovecot is configured to support. You can have several
24998 authenticators for different mechanisms. For example:
24999 .code
25000 dovecot_plain:
25001   driver = dovecot
25002   public_name = PLAIN
25003   server_socket = /var/run/dovecot/auth-client
25004   server_set_id = $auth2
25005
25006 dovecot_ntlm:
25007   driver = dovecot
25008   public_name = NTLM
25009   server_socket = /var/run/dovecot/auth-client
25010   server_set_id = $auth1
25011 .endd
25012 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25013 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25014 option is passed in the Dovecot authentication command. If, for a TLS
25015 connection, a client certificate has been verified, the &"valid-client-cert"&
25016 option is passed. When authentication succeeds, the identity of the user
25017 who authenticated is placed in &$auth1$&.
25018 .ecindex IIDdcotauth1
25019 .ecindex IIDdcotauth2
25020
25021
25022 . ////////////////////////////////////////////////////////////////////////////
25023 . ////////////////////////////////////////////////////////////////////////////
25024 .chapter "The gsasl authenticator" "CHAPgsasl"
25025 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25026 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25027 .cindex "authentication" "GNU SASL"
25028 .cindex "authentication" "SASL"
25029 .cindex "authentication" "EXTERNAL"
25030 .cindex "authentication" "ANONYMOUS"
25031 .cindex "authentication" "PLAIN"
25032 .cindex "authentication" "LOGIN"
25033 .cindex "authentication" "DIGEST-MD5"
25034 .cindex "authentication" "CRAM-MD5"
25035 .cindex "authentication" "SCRAM-SHA-1"
25036 The &(gsasl)& authenticator provides server integration for the GNU SASL
25037 library and the mechanisms it provides.  This is new as of the 4.80 release
25038 and there are a few areas where the library does not let Exim smoothly
25039 scale to handle future authentication mechanisms, so no guarantee can be
25040 made that any particular new authentication mechanism will be supported
25041 without code changes in Exim.
25042
25043
25044 .option server_channelbinding gsasl boolean false
25045 Some authentication mechanisms are able to use external context at both ends
25046 of the session to bind the authentication to that context, and fail the
25047 authentication process if that context differs.  Specifically, some TLS
25048 ciphersuites can provide identifying information about the cryptographic
25049 context.
25050
25051 This means that certificate identity and verification becomes a non-issue,
25052 as a man-in-the-middle attack will cause the correct client and server to
25053 see different identifiers and authentication will fail.
25054
25055 This is currently only supported when using the GnuTLS library.  This is
25056 only usable by mechanisms which support "channel binding"; at time of
25057 writing, that's the SCRAM family.
25058
25059 This defaults off to ensure smooth upgrade across Exim releases, in case
25060 this option causes some clients to start failing.  Some future release
25061 of Exim may switch the default to be true.
25062
25063
25064 .option server_hostname gsasl string&!! "see below"
25065 This option selects the hostname that is used when communicating with the
25066 library. The default value is &`$primary_hostname`&.
25067 Some mechanisms will use this data.
25068
25069
25070 .option server_mech gsasl string "see below"
25071 This option selects the authentication mechanism this driver should use. The
25072 default is the value of the generic &%public_name%& option. This option allows
25073 you to use a different underlying mechanism from the advertised name. For
25074 example:
25075 .code
25076 sasl:
25077   driver = gsasl
25078   public_name = X-ANYTHING
25079   server_mech = CRAM-MD5
25080   server_set_id = $auth1
25081 .endd
25082
25083
25084 .option server_password gsasl string&!! unset
25085 Various mechanisms need access to the cleartext password on the server, so
25086 that proof-of-possession can be demonstrated on the wire, without sending
25087 the password itself.
25088
25089 The data available for lookup varies per mechanism.
25090 In all cases, &$auth1$& is set to the &'authentication id'&.
25091 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25092 if available, else the empty string.
25093 The &$auth3$& variable will always be the &'realm'& if available,
25094 else the empty string.
25095
25096 A forced failure will cause authentication to defer.
25097
25098 If using this option, it may make sense to set the &%server_condition%&
25099 option to be simply "true".
25100
25101
25102 .option server_realm gsasl string&!! unset
25103 This specifies the SASL realm that the server claims to be in.
25104 Some mechanisms will use this data.
25105
25106
25107 .option server_scram_iter gsasl string&!! unset
25108 This option provides data for the SCRAM family of mechanisms.
25109 &$auth1$& is not available at evaluation time.
25110 (This may change, as we receive feedback on use)
25111
25112
25113 .option server_scram_salt gsasl string&!! unset
25114 This option provides data for the SCRAM family of mechanisms.
25115 &$auth1$& is not available at evaluation time.
25116 (This may change, as we receive feedback on use)
25117
25118
25119 .option server_service gsasl string &`smtp`&
25120 This is the SASL service that the server claims to implement.
25121 Some mechanisms will use this data.
25122
25123
25124 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25125 .vindex "&$auth1$&, &$auth2$&, etc"
25126 These may be set when evaluating specific options, as detailed above.
25127 They will also be set when evaluating &%server_condition%&.
25128
25129 Unless otherwise stated below, the &(gsasl)& integration will use the following
25130 meanings for these variables:
25131
25132 .ilist
25133 .vindex "&$auth1$&"
25134 &$auth1$&: the &'authentication id'&
25135 .next
25136 .vindex "&$auth2$&"
25137 &$auth2$&: the &'authorization id'&
25138 .next
25139 .vindex "&$auth3$&"
25140 &$auth3$&: the &'realm'&
25141 .endlist
25142
25143 On a per-mechanism basis:
25144
25145 .ilist
25146 .cindex "authentication" "EXTERNAL"
25147 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25148 the &%server_condition%& option must be present.
25149 .next
25150 .cindex "authentication" "ANONYMOUS"
25151 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25152 the &%server_condition%& option must be present.
25153 .next
25154 .cindex "authentication" "GSSAPI"
25155 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25156 &$auth2$& will be set to the &'authorization id'&,
25157 the &%server_condition%& option must be present.
25158 .endlist
25159
25160 An &'anonymous token'& is something passed along as an unauthenticated
25161 identifier; this is analogous to FTP anonymous authentication passing an
25162 email address, or software-identifier@, as the "password".
25163
25164
25165 An example showing the password having the realm specified in the callback
25166 and demonstrating a Cyrus SASL to GSASL migration approach is:
25167 .code
25168 gsasl_cyrusless_crammd5:
25169   driver = gsasl
25170   public_name = CRAM-MD5
25171   server_realm = imap.example.org
25172   server_password = ${lookup{$auth1:$auth3:userPassword}\
25173                     dbmjz{/etc/sasldb2}{$value}fail}
25174   server_set_id = ${quote:$auth1}
25175   server_condition = yes
25176 .endd
25177
25178
25179 . ////////////////////////////////////////////////////////////////////////////
25180 . ////////////////////////////////////////////////////////////////////////////
25181
25182 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25183 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25184 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25185 .cindex "authentication" "GSSAPI"
25186 .cindex "authentication" "Kerberos"
25187 The &(heimdal_gssapi)& authenticator provides server integration for the
25188 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25189 reliably.
25190
25191 .option server_hostname heimdal_gssapi string&!! "see below"
25192 This option selects the hostname that is used, with &%server_service%&,
25193 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25194 identifier.  The default value is &`$primary_hostname`&.
25195
25196 .option server_keytab heimdal_gssapi string&!! unset
25197 If set, then Heimdal will not use the system default keytab (typically
25198 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25199 The value should be a pathname, with no &"file:"& prefix.
25200
25201 .option server_service heimdal_gssapi string&!! "smtp"
25202 This option specifies the service identifier used, in conjunction with
25203 &%server_hostname%&, for building the identifer for finding credentials
25204 from the keytab.
25205
25206
25207 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25208 Beware that these variables will typically include a realm, thus will appear
25209 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25210 not verified, so a malicious client can set it to anything.
25211
25212 The &$auth1$& field should be safely trustable as a value from the Key
25213 Distribution Center.  Note that these are not quite email addresses.
25214 Each identifier is for a role, and so the left-hand-side may include a
25215 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25216
25217 .vindex "&$auth1$&, &$auth2$&, etc"
25218 .ilist
25219 .vindex "&$auth1$&"
25220 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25221 .next
25222 .vindex "&$auth2$&"
25223 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25224 authentication.  If that was empty, this will also be set to the
25225 GSS Display Name.
25226 .endlist
25227
25228
25229 . ////////////////////////////////////////////////////////////////////////////
25230 . ////////////////////////////////////////////////////////////////////////////
25231
25232 .chapter "The spa authenticator" "CHAPspa"
25233 .scindex IIDspaauth1 "&(spa)& authenticator"
25234 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25235 .cindex "authentication" "Microsoft Secure Password"
25236 .cindex "authentication" "NTLM"
25237 .cindex "Microsoft Secure Password Authentication"
25238 .cindex "NTLM authentication"
25239 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25240 Password Authentication'& mechanism,
25241 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25242 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25243 taken from the Samba project (&url(http://www.samba.org)). The code for the
25244 server side was subsequently contributed by Tom Kistner. The mechanism works as
25245 follows:
25246
25247 .ilist
25248 After the AUTH command has been accepted, the client sends an SPA
25249 authentication request based on the user name and optional domain.
25250 .next
25251 The server sends back a challenge.
25252 .next
25253 The client builds a challenge response which makes use of the user's password
25254 and sends it to the server, which then accepts or rejects it.
25255 .endlist
25256
25257 Encryption is used to protect the password in transit.
25258
25259
25260
25261 .section "Using spa as a server" "SECID179"
25262 .cindex "options" "&(spa)& authenticator (server)"
25263 The &(spa)& authenticator has just one server option:
25264
25265 .option server_password spa string&!! unset
25266 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25267 This option is expanded, and the result must be the cleartext password for the
25268 authenticating user, whose name is at this point in &$auth1$&. For
25269 compatibility with previous releases of Exim, the user name is also placed in
25270 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25271 it can lead to confusion in string expansions that also use numeric variables
25272 for other things. For example:
25273 .code
25274 spa:
25275   driver = spa
25276   public_name = NTLM
25277   server_password = \
25278     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25279 .endd
25280 If the expansion is forced to fail, authentication fails. Any other expansion
25281 failure causes a temporary error code to be returned.
25282
25283
25284
25285
25286
25287 .section "Using spa as a client" "SECID180"
25288 .cindex "options" "&(spa)& authenticator (client)"
25289 The &(spa)& authenticator has the following client options:
25290
25291
25292
25293 .option client_domain spa string&!! unset
25294 This option specifies an optional domain for the authentication.
25295
25296
25297 .option client_password spa string&!! unset
25298 This option specifies the user's password, and must be set.
25299
25300
25301 .option client_username spa string&!! unset
25302 This option specifies the user name, and must be set. Here is an example of a
25303 configuration of this authenticator for use with the mail servers at
25304 &'msn.com'&:
25305 .code
25306 msn:
25307   driver = spa
25308   public_name = MSN
25309   client_username = msn/msn_username
25310   client_password = msn_plaintext_password
25311   client_domain = DOMAIN_OR_UNSET
25312 .endd
25313 .ecindex IIDspaauth1
25314 .ecindex IIDspaauth2
25315
25316
25317
25318
25319
25320 . ////////////////////////////////////////////////////////////////////////////
25321 . ////////////////////////////////////////////////////////////////////////////
25322
25323 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25324          "Encrypted SMTP connections"
25325 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25326 .scindex IIDencsmtp2 "SMTP" "encryption"
25327 .cindex "TLS" "on SMTP connection"
25328 .cindex "OpenSSL"
25329 .cindex "GnuTLS"
25330 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25331 Sockets Layer), is implemented by making use of the OpenSSL library or the
25332 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25333 cryptographic code in the Exim distribution itself for implementing TLS. In
25334 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25335 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25336 You also need to understand the basic concepts of encryption at a managerial
25337 level, and in particular, the way that public keys, private keys, and
25338 certificates are used.
25339
25340 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25341 connection is established, the client issues a STARTTLS command. If the
25342 server accepts this, the client and the server negotiate an encryption
25343 mechanism. If the negotiation succeeds, the data that subsequently passes
25344 between them is encrypted.
25345
25346 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25347 and if so, what cipher suite is in use, whether the client supplied a
25348 certificate, and whether or not that certificate was verified. This makes it
25349 possible for an Exim server to deny or accept certain commands based on the
25350 encryption state.
25351
25352 &*Warning*&: Certain types of firewall and certain anti-virus products can
25353 disrupt TLS connections. You need to turn off SMTP scanning for these products
25354 in order to get TLS to work.
25355
25356
25357
25358 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25359          "SECID284"
25360 .cindex "ssmtp protocol"
25361 .cindex "smtps protocol"
25362 .cindex "SMTP" "ssmtp protocol"
25363 .cindex "SMTP" "smtps protocol"
25364 Early implementations of encrypted SMTP used a different TCP port from normal
25365 SMTP, and expected an encryption negotiation to start immediately, instead of
25366 waiting for a STARTTLS command from the client using the standard SMTP
25367 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25368 allocated for this purpose.
25369
25370 This approach was abandoned when encrypted SMTP was standardized, but there are
25371 still some legacy clients that use it. Exim supports these clients by means of
25372 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25373 numbers; the most common use is expected to be:
25374 .code
25375 tls_on_connect_ports = 465
25376 .endd
25377 The port numbers specified by this option apply to all SMTP connections, both
25378 via the daemon and via &'inetd'&. You still need to specify all the ports that
25379 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25380 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25381 an extra port &-- rather, it specifies different behaviour on a port that is
25382 defined elsewhere.
25383
25384 There is also a &%-tls-on-connect%& command line option. This overrides
25385 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25386
25387
25388
25389
25390
25391
25392 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25393 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25394 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25395 followed later, when the first versions of GnuTLS were released. To build Exim
25396 to use GnuTLS, you need to set
25397 .code
25398 USE_GNUTLS=yes
25399 .endd
25400 in Local/Makefile, in addition to
25401 .code
25402 SUPPORT_TLS=yes
25403 .endd
25404 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25405 include files and libraries for GnuTLS can be found.
25406
25407 There are some differences in usage when using GnuTLS instead of OpenSSL:
25408
25409 .ilist
25410 The &%tls_verify_certificates%& option must contain the name of a file, not the
25411 name of a directory (for OpenSSL it can be either).
25412 .next
25413 The default value for &%tls_dhparam%& differs for historical reasons.
25414 .next
25415 .vindex "&$tls_in_peerdn$&"
25416 .vindex "&$tls_out_peerdn$&"
25417 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25418 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25419 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25420 .next
25421 OpenSSL identifies cipher suites using hyphens as separators, for example:
25422 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25423 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25424 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25425 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25426 to handle its own older variants) when processing lists of cipher suites in the
25427 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25428 option).
25429 .next
25430 The &%tls_require_ciphers%& options operate differently, as described in the
25431 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25432 .next
25433 .new
25434 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25435 When using OpenSSL, this option is ignored.
25436 (If an API is found to let OpenSSL be configured in this way,
25437 let the Exim Maintainers know and we'll likely use it).
25438 .wen
25439 .next
25440 Some other recently added features may only be available in one or the other.
25441 This should be documented with the feature.  If the documentation does not
25442 explicitly state that the feature is infeasible in the other TLS
25443 implementation, then patches are welcome.
25444 .endlist
25445
25446
25447 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25448 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25449 an explicit path; if the latter, then the text about generation still applies,
25450 but not the chosen filename.
25451 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25452 See the documentation of &%tls_dhparam%& for more information.
25453
25454 GnuTLS uses D-H parameters that may take a substantial amount of time
25455 to compute. It is unreasonable to re-compute them for every TLS session.
25456 Therefore, Exim keeps this data in a file in its spool directory, called
25457 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25458 of bits requested.
25459 The file is owned by the Exim user and is readable only by
25460 its owner. Every Exim process that start up GnuTLS reads the D-H
25461 parameters from this file. If the file does not exist, the first Exim process
25462 that needs it computes the data and writes it to a temporary file which is
25463 renamed once it is complete. It does not matter if several Exim processes do
25464 this simultaneously (apart from wasting a few resources). Once a file is in
25465 place, new Exim processes immediately start using it.
25466
25467 For maximum security, the parameters that are stored in this file should be
25468 recalculated periodically, the frequency depending on your paranoia level.
25469 If you are avoiding using the fixed D-H primes published in RFCs, then you
25470 are concerned about some advanced attacks and will wish to do this; if you do
25471 not regenerate then you might as well stick to the standard primes.
25472
25473 Arranging this is easy in principle; just delete the file when you want new
25474 values to be computed. However, there may be a problem. The calculation of new
25475 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25476 If the system is not very active, &_/dev/random_& may delay returning data
25477 until enough randomness (entropy) is available. This may cause Exim to hang for
25478 a substantial amount of time, causing timeouts on incoming connections.
25479
25480 The solution is to generate the parameters externally to Exim. They are stored
25481 in &_gnutls-params-N_& in PEM format, which means that they can be
25482 generated externally using the &(certtool)& command that is part of GnuTLS.
25483
25484 To replace the parameters with new ones, instead of deleting the file
25485 and letting Exim re-create it, you can generate new parameters using
25486 &(certtool)& and, when this has been done, replace Exim's cache file by
25487 renaming. The relevant commands are something like this:
25488 .code
25489 # ls
25490 [ look for file; assume gnutls-params-2236 is the most recent ]
25491 # rm -f new-params
25492 # touch new-params
25493 # chown exim:exim new-params
25494 # chmod 0600 new-params
25495 # certtool --generate-dh-params --bits 2236 >>new-params
25496 # openssl dhparam -noout -text -in new-params | head
25497 [ check the first line, make sure it's not more than 2236;
25498   if it is, then go back to the start ("rm") and repeat
25499   until the size generated is at most the size requested ]
25500 # chmod 0400 new-params
25501 # mv new-params gnutls-params-2236
25502 .endd
25503 If Exim never has to generate the parameters itself, the possibility of
25504 stalling is removed.
25505
25506 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25507 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25508 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25509 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25510 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25511 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25512 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25513 which applies to all D-H usage, client or server.  If the value returned by
25514 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25515 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25516 limit, which is still much higher than Exim historically used.
25517
25518 The filename and bits used will change as the GnuTLS maintainers change the
25519 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25520 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25521 2432 bits, while NSS is limited to 2236 bits.
25522
25523 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25524 increase the chance of the generated prime actually being within acceptable
25525 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25526 procedure above.  There is no sane procedure available to Exim to double-check
25527 the size of the generated prime, so it might still be too large.
25528
25529
25530 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25531 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25532 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25533 There is a function in the OpenSSL library that can be passed a list of cipher
25534 suites before the cipher negotiation takes place. This specifies which ciphers
25535 are acceptable. The list is colon separated and may contain names like
25536 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25537 directly to this function call.
25538 Many systems will install the OpenSSL manual-pages, so you may have
25539 &'ciphers(1)'& available to you.
25540 The following quotation from the OpenSSL
25541 documentation specifies what forms of item are allowed in the cipher string:
25542
25543 .ilist
25544 It can consist of a single cipher suite such as RC4-SHA.
25545 .next
25546 It can represent a list of cipher suites containing a certain algorithm,
25547 or cipher suites of a certain type. For example SHA1 represents all
25548 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25549 SSL v3 algorithms.
25550 .next
25551 Lists of cipher suites can be combined in a single cipher string using
25552 the + character. This is used as a logical and operation. For example
25553 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25554 algorithms.
25555 .endlist
25556
25557 Each cipher string can be optionally preceded by one of the characters &`!`&,
25558 &`-`& or &`+`&.
25559 .ilist
25560 If &`!`& is used, the ciphers are permanently deleted from the list. The
25561 ciphers deleted can never reappear in the list even if they are explicitly
25562 stated.
25563 .next
25564 If &`-`& is used, the ciphers are deleted from the list, but some or all
25565 of the ciphers can be added again by later options.
25566 .next
25567 If &`+`& is used, the ciphers are moved to the end of the list. This
25568 option does not add any new ciphers; it just moves matching existing ones.
25569 .endlist
25570
25571 If none of these characters is present, the string is interpreted as
25572 a list of ciphers to be appended to the current preference list. If the list
25573 includes any ciphers already present they will be ignored: that is, they will
25574 not be moved to the end of the list.
25575 .endlist
25576
25577 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25578 string:
25579 .code
25580 # note single-quotes to get ! past any shell history expansion
25581 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25582 .endd
25583
25584 This example will let the library defaults be permitted on the MX port, where
25585 there's probably no identity verification anyway, but ups the ante on the
25586 submission ports where the administrator might have some influence on the
25587 choice of clients used:
25588 .code
25589 # OpenSSL variant; see man ciphers(1)
25590 tls_require_ciphers = ${if =={$received_port}{25}\
25591                            {DEFAULT}\
25592                            {HIGH:!MD5:!SHA1}}
25593 .endd
25594
25595
25596
25597 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25598          "SECTreqciphgnu"
25599 .cindex "GnuTLS" "specifying parameters for"
25600 .cindex "TLS" "specifying ciphers (GnuTLS)"
25601 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25602 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25603 .cindex "TLS" "specifying protocols (GnuTLS)"
25604 .cindex "TLS" "specifying priority string (GnuTLS)"
25605 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25606 The GnuTLS library allows the caller to provide a "priority string", documented
25607 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25608 ciphersuite specification in OpenSSL.
25609
25610 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25611
25612 The &%tls_require_ciphers%& option is available both as an global option,
25613 controlling how Exim behaves as a server, and also as an option of the
25614 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25615 the value is string expanded.  The resulting string is not an Exim list and
25616 the string is given to the GnuTLS library, so that Exim does not need to be
25617 aware of future feature enhancements of GnuTLS.
25618
25619 Documentation of the strings accepted may be found in the GnuTLS manual, under
25620 "Priority strings".  This is online as
25621 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
25622 but beware that this relates to GnuTLS 3, which may be newer than the version
25623 installed on your system.  If you are using GnuTLS 3,
25624 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
25625 on that site can be used to test a given string.
25626
25627 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25628 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25629 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25630
25631 This example will let the library defaults be permitted on the MX port, where
25632 there's probably no identity verification anyway, and lowers security further
25633 by increasing compatibility; but this ups the ante on the submission ports
25634 where the administrator might have some influence on the choice of clients
25635 used:
25636 .code
25637 # GnuTLS variant
25638 tls_require_ciphers = ${if =={$received_port}{25}\
25639                            {NORMAL:%COMPAT}\
25640                            {SECURE128}}
25641 .endd
25642
25643
25644 .section "Configuring an Exim server to use TLS" "SECID182"
25645 .cindex "TLS" "configuring an Exim server"
25646 When Exim has been built with TLS support, it advertises the availability of
25647 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25648 but not to any others. The default value of this option is unset, which means
25649 that STARTTLS is not advertised at all. This default is chosen because you
25650 need to set some other options in order to make TLS available, and also it is
25651 sensible for systems that want to use TLS only as a client.
25652
25653 If a client issues a STARTTLS command and there is some configuration
25654 problem in the server, the command is rejected with a 454 error. If the client
25655 persists in trying to issue SMTP commands, all except QUIT are rejected
25656 with the error
25657 .code
25658 554 Security failure
25659 .endd
25660 If a STARTTLS command is issued within an existing TLS session, it is
25661 rejected with a 554 error code.
25662
25663 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25664 match some hosts. You can, of course, set it to * to match all hosts.
25665 However, this is not all you need to do. TLS sessions to a server won't work
25666 without some further configuration at the server end.
25667
25668 It is rumoured that all existing clients that support TLS/SSL use RSA
25669 encryption. To make this work you need to set, in the server,
25670 .code
25671 tls_certificate = /some/file/name
25672 tls_privatekey = /some/file/name
25673 .endd
25674 These options are, in fact, expanded strings, so you can make them depend on
25675 the identity of the client that is connected if you wish. The first file
25676 contains the server's X509 certificate, and the second contains the private key
25677 that goes with it. These files need to be readable by the Exim user, and must
25678 always be given as full path names. They can be the same file if both the
25679 certificate and the key are contained within it. If &%tls_privatekey%& is not
25680 set, or if its expansion is forced to fail or results in an empty string, this
25681 is assumed to be the case. The certificate file may also contain intermediate
25682 certificates that need to be sent to the client to enable it to authenticate
25683 the server's certificate.
25684
25685 If you do not understand about certificates and keys, please try to find a
25686 source of this background information, which is not Exim-specific. (There are a
25687 few comments below in section &<<SECTcerandall>>&.)
25688
25689 &*Note*&: These options do not apply when Exim is operating as a client &--
25690 they apply only in the case of a server. If you need to use a certificate in an
25691 Exim client, you must set the options of the same names in an &(smtp)&
25692 transport.
25693
25694 With just these options, an Exim server will be able to use TLS. It does not
25695 require the client to have a certificate (but see below for how to insist on
25696 this). There is one other option that may be needed in other situations. If
25697 .code
25698 tls_dhparam = /some/file/name
25699 .endd
25700 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25701 with the parameters contained in the file.
25702 Set this to &`none`& to disable use of DH entirely, by making no prime
25703 available:
25704 .code
25705 tls_dhparam = none
25706 .endd
25707 This may also be set to a string identifying a standard prime to be used for
25708 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25709 used is &`ike23`&.  There are a few standard primes available, see the
25710 documentation for &%tls_dhparam%& for the complete list.
25711
25712 See the command
25713 .code
25714 openssl dhparam
25715 .endd
25716 for a way of generating file data.
25717
25718 The strings supplied for these three options are expanded every time a client
25719 host connects. It is therefore possible to use different certificates and keys
25720 for different hosts, if you so wish, by making use of the client's IP address
25721 in &$sender_host_address$& to control the expansion. If a string expansion is
25722 forced to fail, Exim behaves as if the option is not set.
25723
25724 .cindex "cipher" "logging"
25725 .cindex "log" "TLS cipher"
25726 .vindex "&$tls_in_cipher$&"
25727 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
25728 an incoming TLS connection. It is included in the &'Received:'& header of an
25729 incoming message (by default &-- you can, of course, change this), and it is
25730 also included in the log line that records a message's arrival, keyed by
25731 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25732 condition can be used to test for specific cipher suites in ACLs.
25733
25734 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25735 can check the name of the cipher suite and vary their actions accordingly. The
25736 cipher suite names vary, depending on which TLS library is being used. For
25737 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25738 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25739 documentation for more details.
25740
25741 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
25742 (again depending on the &%tls_cipher%& log selector).
25743
25744
25745 .section "Requesting and verifying client certificates" "SECID183"
25746 .cindex "certificate" "verification of client"
25747 .cindex "TLS" "client certificate verification"
25748 If you want an Exim server to request a certificate when negotiating a TLS
25749 session with a client, you must set either &%tls_verify_hosts%& or
25750 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25751 apply to all TLS connections. For any host that matches one of these options,
25752 Exim requests a certificate as part of the setup of the TLS session. The
25753 contents of the certificate are verified by comparing it with a list of
25754 expected certificates. These must be available in a file or,
25755 for OpenSSL only (not GnuTLS), a directory, identified by
25756 &%tls_verify_certificates%&.
25757
25758 A file can contain multiple certificates, concatenated end to end. If a
25759 directory is used
25760 (OpenSSL only),
25761 each certificate must be in a separate file, with a name (or a symbolic link)
25762 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25763 certificate. You can compute the relevant hash by running the command
25764 .code
25765 openssl x509 -hash -noout -in /cert/file
25766 .endd
25767 where &_/cert/file_& contains a single certificate.
25768
25769 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25770 what happens if the client does not supply a certificate, or if the certificate
25771 does not match any of the certificates in the collection named by
25772 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25773 attempt to set up a TLS session is aborted, and the incoming connection is
25774 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25775 session continues. ACLs that run for subsequent SMTP commands can detect the
25776 fact that no certificate was verified, and vary their actions accordingly. For
25777 example, you can insist on a certificate before accepting a message for
25778 relaying, but not when the message is destined for local delivery.
25779
25780 .vindex "&$tls_in_peerdn$&"
25781 When a client supplies a certificate (whether it verifies or not), the value of
25782 the Distinguished Name of the certificate is made available in the variable
25783 &$tls_in_peerdn$& during subsequent processing of the message.
25784
25785 .cindex "log" "distinguished name"
25786 Because it is often a long text string, it is not included in the log line or
25787 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25788 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25789 &%received_header_text%& to change the &'Received:'& header. When no
25790 certificate is supplied, &$tls_in_peerdn$& is empty.
25791
25792
25793 .section "Revoked certificates" "SECID184"
25794 .cindex "TLS" "revoked certificates"
25795 .cindex "revocation list"
25796 .cindex "certificate" "revocation list"
25797 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25798 certificates are revoked. If you have such a list, you can pass it to an Exim
25799 server using the global option called &%tls_crl%& and to an Exim client using
25800 an identically named option for the &(smtp)& transport. In each case, the value
25801 of the option is expanded and must then be the name of a file that contains a
25802 CRL in PEM format.
25803
25804
25805 .section "Configuring an Exim client to use TLS" "SECID185"
25806 .cindex "cipher" "logging"
25807 .cindex "log" "TLS cipher"
25808 .cindex "log" "distinguished name"
25809 .cindex "TLS" "configuring an Exim client"
25810 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25811 deliveries as well as to incoming, the latter one causing logging of the
25812 server certificate's DN. The remaining client configuration for TLS is all
25813 within the &(smtp)& transport.
25814
25815 It is not necessary to set any options to have TLS work in the &(smtp)&
25816 transport. If Exim is built with TLS support, and TLS is advertised by a
25817 server, the &(smtp)& transport always tries to start a TLS session. However,
25818 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25819 transport) to a list of server hosts for which TLS should not be used.
25820
25821 If you do not want Exim to attempt to send messages unencrypted when an attempt
25822 to set up an encrypted connection fails in any way, you can set
25823 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25824 those hosts, delivery is always deferred if an encrypted connection cannot be
25825 set up. If there are any other hosts for the address, they are tried in the
25826 usual way.
25827
25828 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25829 the message unencrypted. It always does this if the response to STARTTLS is
25830 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25831 session after a success response code, what happens is controlled by the
25832 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25833 delivery to this host is deferred, and other hosts (if available) are tried. If
25834 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25835 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25836 negotiation fails, Exim closes the current connection (because it is in an
25837 unknown state), opens a new one to the same host, and then tries the delivery
25838 unencrypted.
25839
25840 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25841 transport provide the client with a certificate, which is passed to the server
25842 if it requests it. If the server is Exim, it will request a certificate only if
25843 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25844
25845 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25846 must name a file or,
25847 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25848 expected server certificates. The client verifies the server's certificate
25849 against this collection, taking into account any revoked certificates that are
25850 in the list defined by &%tls_crl%&.
25851
25852 If
25853 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25854 list of permitted cipher suites. If either of these checks fails, delivery to
25855 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25856 alternative hosts, if any.
25857
25858  &*Note*&:
25859 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25860 is operating as a client. Exim does not assume that a server certificate (set
25861 by the global options of the same name) should also be used when operating as a
25862 client.
25863
25864 .vindex "&$host$&"
25865 .vindex "&$host_address$&"
25866 All the TLS options in the &(smtp)& transport are expanded before use, with
25867 &$host$& and &$host_address$& containing the name and address of the server to
25868 which the client is connected. Forced failure of an expansion causes Exim to
25869 behave as if the relevant option were unset.
25870
25871 .vindex &$tls_out_bits$&
25872 .vindex &$tls_out_cipher$&
25873 .vindex &$tls_out_peerdn$&
25874 .vindex &$tls_out_sni$&
25875 Before an SMTP connection is established, the
25876 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
25877 variables are emptied. (Until the first connection, they contain the values
25878 that were set when the message was received.) If STARTTLS is subsequently
25879 successfully obeyed, these variables are set to the relevant values for the
25880 outgoing connection.
25881
25882
25883
25884 .section "Use of TLS Server Name Indication" "SECTtlssni"
25885 .cindex "TLS" "Server Name Indication"
25886 .vindex "&$tls_in_sni$&"
25887 .oindex "&%tls_in_sni%&"
25888 With TLS1.0 or above, there is an extension mechanism by which extra
25889 information can be included at various points in the protocol.  One of these
25890 extensions, documented in RFC 6066 (and before that RFC 4366) is
25891 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25892 client in the initial handshake, so that the server can examine the servername
25893 within and possibly choose to use different certificates and keys (and more)
25894 for this session.
25895
25896 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25897 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25898 address.
25899
25900 With SMTP to MX, there are the same problems here as in choosing the identity
25901 against which to validate a certificate: you can't rely on insecure DNS to
25902 provide the identity which you then cryptographically verify.  So this will
25903 be of limited use in that environment.
25904
25905 With SMTP to Submission, there is a well-defined hostname which clients are
25906 connecting to and can validate certificates against.  Thus clients &*can*&
25907 choose to include this information in the TLS negotiation.  If this becomes
25908 wide-spread, then hosters can choose to present different certificates to
25909 different clients.  Or even negotiate different cipher suites.
25910
25911 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25912 if not empty, will be sent on a TLS session as part of the handshake.  There's
25913 nothing more to it.  Choosing a sensible value not derived insecurely is the
25914 only point of caution.  The &$tls_out_sni$& variable will be set to this string
25915 for the lifetime of the client connection (including during authentication).
25916
25917 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
25918 received from a client.
25919 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25920
25921 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
25922 option (prior to expansion) then the following options will be re-expanded
25923 during TLS session handshake, to permit alternative values to be chosen:
25924
25925 .ilist
25926 .vindex "&%tls_certificate%&"
25927 &%tls_certificate%&
25928 .next
25929 .vindex "&%tls_crl%&"
25930 &%tls_crl%&
25931 .next
25932 .vindex "&%tls_privatekey%&"
25933 &%tls_privatekey%&
25934 .next
25935 .vindex "&%tls_verify_certificates%&"
25936 &%tls_verify_certificates%&
25937 .endlist
25938
25939 Great care should be taken to deal with matters of case, various injection
25940 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25941 can always be referenced; it is important to remember that &$tls_sni$& is
25942 arbitrary unverified data provided prior to authentication.
25943
25944 The Exim developers are proceeding cautiously and so far no other TLS options
25945 are re-expanded.
25946
25947 When Exim is built againt OpenSSL, OpenSSL must have been built with support
25948 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
25949 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
25950 see &`-servername`& in the output, then OpenSSL has support.
25951
25952 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
25953 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
25954 built, then you have SNI support).
25955
25956
25957
25958 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25959          "SECTmulmessam"
25960 .cindex "multiple SMTP deliveries with TLS"
25961 .cindex "TLS" "multiple message deliveries"
25962 Exim sends multiple messages down the same TCP/IP connection by starting up
25963 an entirely new delivery process for each message, passing the socket from
25964 one process to the next. This implementation does not fit well with the use
25965 of TLS, because there is quite a lot of state information associated with a TLS
25966 connection, not just a socket identification. Passing all the state information
25967 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25968 session before passing the socket to a new process. The new process may then
25969 try to start a new TLS session, and if successful, may try to re-authenticate
25970 if AUTH is in use, before sending the next message.
25971
25972 The RFC is not clear as to whether or not an SMTP session continues in clear
25973 after TLS has been shut down, or whether TLS may be restarted again later, as
25974 just described. However, if the server is Exim, this shutdown and
25975 reinitialization works. It is not known which (if any) other servers operate
25976 successfully if the client closes a TLS session and continues with unencrypted
25977 SMTP, but there are certainly some that do not work. For such servers, Exim
25978 should not pass the socket to another process, because the failure of the
25979 subsequent attempt to use it would cause Exim to record a temporary host error,
25980 and delay other deliveries to that host.
25981
25982 To test for this case, Exim sends an EHLO command to the server after
25983 closing down the TLS session. If this fails in any way, the connection is
25984 closed instead of being passed to a new delivery process, but no retry
25985 information is recorded.
25986
25987 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25988 &(smtp)& transport to match those hosts for which Exim should not pass
25989 connections to new processes if TLS has been used.
25990
25991
25992
25993
25994 .section "Certificates and all that" "SECTcerandall"
25995 .cindex "certificate" "references to discussion"
25996 In order to understand fully how TLS works, you need to know about
25997 certificates, certificate signing, and certificate authorities. This is not the
25998 place to give a tutorial, especially as I do not know very much about it
25999 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26000 to Apache, currently at
26001 .display
26002 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26003 .endd
26004 Other parts of the &'modssl'& documentation are also helpful, and have
26005 links to further files.
26006 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26007 0-201-61598-3), contains both introductory and more in-depth descriptions.
26008 Some sample programs taken from the book are available from
26009 .display
26010 &url(http://www.rtfm.com/openssl-examples/)
26011 .endd
26012
26013
26014 .section "Certificate chains" "SECID186"
26015 The file named by &%tls_certificate%& may contain more than one
26016 certificate. This is useful in the case where the certificate that is being
26017 sent is validated by an intermediate certificate which the other end does
26018 not have. Multiple certificates must be in the correct order in the file.
26019 First the host's certificate itself, then the first intermediate
26020 certificate to validate the issuer of the host certificate, then the next
26021 intermediate certificate to validate the issuer of the first intermediate
26022 certificate, and so on, until finally (optionally) the root certificate.
26023 The root certificate must already be trusted by the recipient for
26024 validation to succeed, of course, but if it's not preinstalled, sending the
26025 root certificate along with the rest makes it available for the user to
26026 install if the receiving end is a client MUA that can interact with a user.
26027
26028
26029 .section "Self-signed certificates" "SECID187"
26030 .cindex "certificate" "self-signed"
26031 You can create a self-signed certificate using the &'req'& command provided
26032 with OpenSSL, like this:
26033 . ==== Do not shorten the duration here without reading and considering
26034 . ==== the text below.  Please leave it at 9999 days.
26035 .code
26036 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26037             -days 9999 -nodes
26038 .endd
26039 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26040 delimited and so can be identified independently. The &%-days%& option
26041 specifies a period for which the certificate is valid. The &%-nodes%& option is
26042 important: if you do not set it, the key is encrypted with a passphrase
26043 that you are prompted for, and any use that is made of the key causes more
26044 prompting for the passphrase. This is not helpful if you are going to use
26045 this certificate and key in an MTA, where prompting is not possible.
26046
26047 . ==== I expect to still be working 26 years from now.  The less technical
26048 . ==== debt I create, in terms of storing up trouble for my later years, the
26049 . ==== happier I will be then.  We really have reached the point where we
26050 . ==== should start, at the very least, provoking thought and making folks
26051 . ==== pause before proceeding, instead of leaving all the fixes until two
26052 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26053 . ==== -pdp, 2012
26054 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26055 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26056 the above command might produce a date in the past.  Think carefully about
26057 the lifetime of the systems you're deploying, and either reduce the duration
26058 of the certificate or reconsider your platform deployment.  (At time of
26059 writing, reducing the duration is the most likely choice, but the inexorable
26060 progression of time takes us steadily towards an era where this will not
26061 be a sensible resolution).
26062
26063 A self-signed certificate made in this way is sufficient for testing, and
26064 may be adequate for all your requirements if you are mainly interested in
26065 encrypting transfers, and not in secure identification.
26066
26067 However, many clients require that the certificate presented by the server be a
26068 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26069 certificate. In this situation, the self-signed certificate described above
26070 must be installed on the client host as a trusted root &'certification
26071 authority'& (CA), and the certificate used by Exim must be a user certificate
26072 signed with that self-signed certificate.
26073
26074 For information on creating self-signed CA certificates and using them to sign
26075 user certificates, see the &'General implementation overview'& chapter of the
26076 Open-source PKI book, available online at
26077 &url(http://ospkibook.sourceforge.net/).
26078 .ecindex IIDencsmtp1
26079 .ecindex IIDencsmtp2
26080
26081
26082
26083 . ////////////////////////////////////////////////////////////////////////////
26084 . ////////////////////////////////////////////////////////////////////////////
26085
26086 .chapter "Access control lists" "CHAPACL"
26087 .scindex IIDacl "&ACL;" "description"
26088 .cindex "control of incoming mail"
26089 .cindex "message" "controlling incoming"
26090 .cindex "policy control" "access control lists"
26091 Access Control Lists (ACLs) are defined in a separate section of the run time
26092 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26093 name, terminated by a colon. Here is a complete ACL section that contains just
26094 one very small ACL:
26095 .code
26096 begin acl
26097 small_acl:
26098   accept   hosts = one.host.only
26099 .endd
26100 You can have as many lists as you like in the ACL section, and the order in
26101 which they appear does not matter. The lists are self-terminating.
26102
26103 The majority of ACLs are used to control Exim's behaviour when it receives
26104 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26105 when a local process submits a message using SMTP by specifying the &%-bs%&
26106 option. The most common use is for controlling which recipients are accepted
26107 in incoming messages. In addition, you can define an ACL that is used to check
26108 local non-SMTP messages. The default configuration file contains an example of
26109 a realistic ACL for checking RCPT commands. This is discussed in chapter
26110 &<<CHAPdefconfil>>&.
26111
26112
26113 .section "Testing ACLs" "SECID188"
26114 The &%-bh%& command line option provides a way of testing your ACL
26115 configuration locally by running a fake SMTP session with which you interact.
26116 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26117 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26118
26119
26120
26121 .section "Specifying when ACLs are used" "SECID189"
26122 .cindex "&ACL;" "options for specifying"
26123 In order to cause an ACL to be used, you have to name it in one of the relevant
26124 options in the main part of the configuration. These options are:
26125 .cindex "AUTH" "ACL for"
26126 .cindex "DATA" "ACLs for"
26127 .cindex "ETRN" "ACL for"
26128 .cindex "EXPN" "ACL for"
26129 .cindex "HELO" "ACL for"
26130 .cindex "EHLO" "ACL for"
26131 .cindex "MAIL" "ACL for"
26132 .cindex "QUIT, ACL for"
26133 .cindex "RCPT" "ACL for"
26134 .cindex "STARTTLS, ACL for"
26135 .cindex "VRFY" "ACL for"
26136 .cindex "SMTP" "connection, ACL for"
26137 .cindex "non-SMTP messages" "ACLs for"
26138 .cindex "MIME content scanning" "ACL for"
26139
26140 .table2 140pt
26141 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26142 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26143 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26144 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26145 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26146 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26147 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26148 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26149 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26150 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26151 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26152 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26153 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26154 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26155 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26156 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26157 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26158 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26159 .endtable
26160
26161 For example, if you set
26162 .code
26163 acl_smtp_rcpt = small_acl
26164 .endd
26165 the little ACL defined above is used whenever Exim receives a RCPT command
26166 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26167 done when RCPT commands arrive. A rejection of RCPT should cause the
26168 sending MTA to give up on the recipient address contained in the RCPT
26169 command, whereas rejection at other times may cause the client MTA to keep on
26170 trying to deliver the message. It is therefore recommended that you do as much
26171 testing as possible at RCPT time.
26172
26173
26174 .section "The non-SMTP ACLs" "SECID190"
26175 .cindex "non-SMTP messages" "ACLs for"
26176 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26177 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26178 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26179 the state of the SMTP connection such as encryption and authentication) are not
26180 relevant and are forbidden in these ACLs. However, the sender and recipients
26181 are known, so the &%senders%& and &%sender_domains%& conditions and the
26182 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26183 &$authenticated_sender$& are also available. You can specify added header lines
26184 in any of these ACLs.
26185
26186 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26187 non-SMTP message, before any of the message has been read. (This is the
26188 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26189 batched SMTP input, it runs after the DATA command has been reached. The
26190 result of this ACL is ignored; it cannot be used to reject a message. If you
26191 really need to, you could set a value in an ACL variable here and reject based
26192 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26193 controls, and in particular, it can be used to set
26194 .code
26195 control = suppress_local_fixups
26196 .endd
26197 This cannot be used in the other non-SMTP ACLs because by the time they are
26198 run, it is too late.
26199
26200 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26201 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26202
26203 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26204 kind of rejection is treated as permanent, because there is no way of sending a
26205 temporary error for these kinds of message.
26206
26207
26208 .section "The SMTP connect ACL" "SECID191"
26209 .cindex "SMTP" "connection, ACL for"
26210 .oindex &%smtp_banner%&
26211 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26212 session, after the test specified by &%host_reject_connection%& (which is now
26213 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26214 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26215 the message override the banner message that is otherwise specified by the
26216 &%smtp_banner%& option.
26217
26218
26219 .section "The EHLO/HELO ACL" "SECID192"
26220 .cindex "EHLO" "ACL for"
26221 .cindex "HELO" "ACL for"
26222 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26223 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26224 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26225 Note that a client may issue more than one EHLO or HELO command in an SMTP
26226 session, and indeed is required to issue a new EHLO or HELO after successfully
26227 setting up encryption following a STARTTLS command.
26228
26229 If the command is accepted by an &%accept%& verb that has a &%message%&
26230 modifier, the message may not contain more than one line (it will be truncated
26231 at the first newline and a panic logged if it does). Such a message cannot
26232 affect the EHLO options that are listed on the second and subsequent lines of
26233 an EHLO response.
26234
26235
26236 .section "The DATA ACLs" "SECID193"
26237 .cindex "DATA" "ACLs for"
26238 Two ACLs are associated with the DATA command, because it is two-stage
26239 command, with two responses being sent to the client.
26240 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26241 is obeyed. This gives you control after all the RCPT commands, but before
26242 the message itself is received. It offers the opportunity to give a negative
26243 response to the DATA command before the data is transmitted. Header lines
26244 added by MAIL or RCPT ACLs are not visible at this time, but any that
26245 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26246
26247 You cannot test the contents of the message, for example, to verify addresses
26248 in the headers, at RCPT time or when the DATA command is received. Such
26249 tests have to appear in the ACL that is run after the message itself has been
26250 received, before the final response to the DATA command is sent. This is
26251 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26252 associated with the DATA command.
26253
26254 For both of these ACLs, it is not possible to reject individual recipients. An
26255 error response rejects the entire message. Unfortunately, it is known that some
26256 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26257 before or after the data) correctly &-- they keep the message on their queues
26258 and try again later, but that is their problem, though it does waste some of
26259 your resources.
26260
26261 The &%acl_smtp_data%& ACL is run after both the &%acl_smtp_dkim%& and
26262 the &%acl_smtp_mime%& ACLs.
26263
26264
26265 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26266 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26267 enabled (which is the default).
26268
26269 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26270 received, and is executed for each DKIM signature found in a message.  If not
26271 otherwise specified, the default action is to accept.
26272
26273 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26274
26275 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26276
26277
26278 .section "The SMTP MIME ACL" "SECID194"
26279 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26280 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26281
26282 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26283
26284
26285 .section "The QUIT ACL" "SECTQUITACL"
26286 .cindex "QUIT, ACL for"
26287 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26288 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26289 does not in fact control any access. For this reason, the only verbs that are
26290 permitted are &%accept%& and &%warn%&.
26291
26292 This ACL can be used for tasks such as custom logging at the end of an SMTP
26293 session. For example, you can use ACL variables in other ACLs to count
26294 messages, recipients, etc., and log the totals at QUIT time using one or
26295 more &%logwrite%& modifiers on a &%warn%& verb.
26296
26297 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26298 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26299
26300 You do not need to have a final &%accept%&, but if you do, you can use a
26301 &%message%& modifier to specify custom text that is sent as part of the 221
26302 response to QUIT.
26303
26304 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26305 failure (for example, failure to open a log file, or when Exim is bombing out
26306 because it has detected an unrecoverable error), all SMTP commands from the
26307 client are given temporary error responses until QUIT is received or the
26308 connection is closed. In these special cases, the QUIT ACL does not run.
26309
26310
26311 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26312 .vindex &$acl_smtp_notquit$&
26313 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26314 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26315 trouble, such as being unable to write to its log files, this ACL is not run,
26316 because it might try to do things (such as write to log files) that make the
26317 situation even worse.
26318
26319 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26320 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26321 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26322 and &%warn%&.
26323
26324 .vindex &$smtp_notquit_reason$&
26325 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26326 to a string that indicates the reason for the termination of the SMTP
26327 connection. The possible values are:
26328 .table2
26329 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26330 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26331 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26332 .irow &`connection-lost`&          "The SMTP connection has been lost"
26333 .irow &`data-timeout`&             "Timeout while reading message data"
26334 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26335 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26336 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26337 .irow &`synchronization-error`&    "SMTP synchronization error"
26338 .irow &`tls-failed`&               "TLS failed to start"
26339 .endtable
26340 In most cases when an SMTP connection is closed without having received QUIT,
26341 Exim sends an SMTP response message before actually closing the connection.
26342 With the exception of the &`acl-drop`& case, the default message can be
26343 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26344 &%drop%& verb in another ACL, it is the message from the other ACL that is
26345 used.
26346
26347
26348 .section "Finding an ACL to use" "SECID195"
26349 .cindex "&ACL;" "finding which to use"
26350 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26351 you can use different ACLs in different circumstances. For example,
26352 .code
26353 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26354                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26355 .endd
26356 In the default configuration file there are some example settings for
26357 providing an RFC 4409 message submission service on port 587 and a
26358 non-standard &"smtps"& service on port 465. You can use a string
26359 expansion like this to choose an ACL for MUAs on these ports which is
26360 more appropriate for this purpose than the default ACL on port 25.
26361
26362 The expanded string does not have to be the name of an ACL in the
26363 configuration file; there are other possibilities. Having expanded the
26364 string, Exim searches for an ACL as follows:
26365
26366 .ilist
26367 If the string begins with a slash, Exim uses it as a file name, and reads its
26368 contents as an ACL. The lines are processed in the same way as lines in the
26369 Exim configuration file. In particular, continuation lines are supported, blank
26370 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26371 If the file does not exist or cannot be read, an error occurs (typically
26372 causing a temporary failure of whatever caused the ACL to be run). For example:
26373 .code
26374 acl_smtp_data = /etc/acls/\
26375   ${lookup{$sender_host_address}lsearch\
26376   {/etc/acllist}{$value}{default}}
26377 .endd
26378 This looks up an ACL file to use on the basis of the host's IP address, falling
26379 back to a default if the lookup fails. If an ACL is successfully read from a
26380 file, it is retained in memory for the duration of the Exim process, so that it
26381 can be re-used without having to re-read the file.
26382 .next
26383 If the string does not start with a slash, and does not contain any spaces,
26384 Exim searches the ACL section of the configuration for an ACL whose name
26385 matches the string.
26386 .next
26387 If no named ACL is found, or if the string contains spaces, Exim parses
26388 the string as an inline ACL. This can save typing in cases where you just
26389 want to have something like
26390 .code
26391 acl_smtp_vrfy = accept
26392 .endd
26393 in order to allow free use of the VRFY command. Such a string may contain
26394 newlines; it is processed in the same way as an ACL that is read from a file.
26395 .endlist
26396
26397
26398
26399
26400 .section "ACL return codes" "SECID196"
26401 .cindex "&ACL;" "return codes"
26402 Except for the QUIT ACL, which does not affect the SMTP return code (see
26403 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26404 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26405 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26406 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
26407 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
26408 This also causes a 4&'xx'& return code.
26409
26410 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
26411 &"deny"&, because there is no mechanism for passing temporary errors to the
26412 submitters of non-SMTP messages.
26413
26414
26415 ACLs that are relevant to message reception may also return &"discard"&. This
26416 has the effect of &"accept"&, but causes either the entire message or an
26417 individual recipient address to be discarded. In other words, it is a
26418 blackholing facility. Use it with care.
26419
26420 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
26421 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
26422 RCPT ACL is to discard just the one recipient address. If there are no
26423 recipients left when the message's data is received, the DATA ACL is not
26424 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
26425 remaining recipients. The &"discard"& return is not permitted for the
26426 &%acl_smtp_predata%& ACL.
26427
26428
26429 .cindex "&[local_scan()]& function" "when all recipients discarded"
26430 The &[local_scan()]& function is always run, even if there are no remaining
26431 recipients; it may create new recipients.
26432
26433
26434
26435 .section "Unset ACL options" "SECID197"
26436 .cindex "&ACL;" "unset options"
26437 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
26438 all the same. &*Note*&: These defaults apply only when the relevant ACL is
26439 not defined at all. For any defined ACL, the default action when control
26440 reaches the end of the ACL statements is &"deny"&.
26441
26442 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
26443 these two are ACLs that are used only for their side effects. They cannot be
26444 used to accept or reject anything.
26445
26446 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
26447 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
26448 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
26449 when the ACL is not defined is &"accept"&.
26450
26451 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
26452 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
26453 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
26454 messages over an SMTP connection. For an example, see the ACL in the default
26455 configuration file.
26456
26457
26458
26459
26460 .section "Data for message ACLs" "SECID198"
26461 .cindex "&ACL;" "data for message ACL"
26462 .vindex &$domain$&
26463 .vindex &$local_part$&
26464 .vindex &$sender_address$&
26465 .vindex &$sender_host_address$&
26466 .vindex &$smtp_command$&
26467 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
26468 that contain information about the host and the message's sender (for example,
26469 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
26470 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
26471 &$local_part$& are set from the argument address. The entire SMTP command
26472 is available in &$smtp_command$&.
26473
26474 When an ACL for the AUTH parameter of MAIL is running, the variables that
26475 contain information about the host are set, but &$sender_address$& is not yet
26476 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
26477 how it is used.
26478
26479 .vindex "&$message_size$&"
26480 The &$message_size$& variable is set to the value of the SIZE parameter on
26481 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
26482 that parameter is not given. The value is updated to the true message size by
26483 the time the final DATA ACL is run (after the message data has been
26484 received).
26485
26486 .vindex "&$rcpt_count$&"
26487 .vindex "&$recipients_count$&"
26488 The &$rcpt_count$& variable increases by one for each RCPT command received.
26489 The &$recipients_count$& variable increases by one each time a RCPT command is
26490 accepted, so while an ACL for RCPT is being processed, it contains the number
26491 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26492 &$rcpt_count$& contains the total number of RCPT commands, and
26493 &$recipients_count$& contains the total number of accepted recipients.
26494
26495
26496
26497
26498
26499 .section "Data for non-message ACLs" "SECTdatfornon"
26500 .cindex "&ACL;" "data for non-message ACL"
26501 .vindex &$smtp_command_argument$&
26502 .vindex &$smtp_command$&
26503 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26504 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26505 and the entire SMTP command is available in &$smtp_command$&.
26506 These variables can be tested using a &%condition%& condition. For example,
26507 here is an ACL for use with AUTH, which insists that either the session is
26508 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26509 does not permit authentication methods that use cleartext passwords on
26510 unencrypted connections.
26511 .code
26512 acl_check_auth:
26513   accept encrypted = *
26514   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26515                      {CRAM-MD5}}
26516   deny   message   = TLS encryption or CRAM-MD5 required
26517 .endd
26518 (Another way of applying this restriction is to arrange for the authenticators
26519 that use cleartext passwords not to be advertised when the connection is not
26520 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26521 option to do this.)
26522
26523
26524
26525 .section "Format of an ACL" "SECID199"
26526 .cindex "&ACL;" "format of"
26527 .cindex "&ACL;" "verbs, definition of"
26528 An individual ACL consists of a number of statements. Each statement starts
26529 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26530 Modifiers can change the way the verb operates, define error and log messages,
26531 set variables, insert delays, and vary the processing of accepted messages.
26532
26533 If all the conditions are met, the verb is obeyed. The same condition may be
26534 used (with different arguments) more than once in the same statement. This
26535 provides a means of specifying an &"and"& conjunction between conditions. For
26536 example:
26537 .code
26538 deny  dnslists = list1.example
26539 dnslists = list2.example
26540 .endd
26541 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26542 the conditions and modifiers when it reaches a condition that fails. What
26543 happens then depends on the verb (and in one case, on a special modifier). Not
26544 all the conditions make sense at every testing point. For example, you cannot
26545 test a sender address in the ACL that is run for a VRFY command.
26546
26547
26548 .section "ACL verbs" "SECID200"
26549 The ACL verbs are as follows:
26550
26551 .ilist
26552 .cindex "&%accept%& ACL verb"
26553 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26554 of the conditions are not met, what happens depends on whether &%endpass%&
26555 appears among the conditions (for syntax see below). If the failing condition
26556 is before &%endpass%&, control is passed to the next ACL statement; if it is
26557 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26558 check a RCPT command:
26559 .code
26560 accept domains = +local_domains
26561 endpass
26562 verify = recipient
26563 .endd
26564 If the recipient domain does not match the &%domains%& condition, control
26565 passes to the next statement. If it does match, the recipient is verified, and
26566 the command is accepted if verification succeeds. However, if verification
26567 fails, the ACL yields &"deny"&, because the failing condition is after
26568 &%endpass%&.
26569
26570 The &%endpass%& feature has turned out to be confusing to many people, so its
26571 use is not recommended nowadays. It is always possible to rewrite an ACL so
26572 that &%endpass%& is not needed, and it is no longer used in the default
26573 configuration.
26574
26575 .cindex "&%message%& ACL modifier" "with &%accept%&"
26576 If a &%message%& modifier appears on an &%accept%& statement, its action
26577 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26578 (when an &%accept%& verb either accepts or passes control to the next
26579 statement), &%message%& can be used to vary the message that is sent when an
26580 SMTP command is accepted. For example, in a RCPT ACL you could have:
26581 .display
26582 &`accept  `&<&'some conditions'&>
26583 &`        message = OK, I will allow you through today`&
26584 .endd
26585 You can specify an SMTP response code, optionally followed by an &"extended
26586 response code"& at the start of the message, but the first digit must be the
26587 same as would be sent by default, which is 2 for an &%accept%& verb.
26588
26589 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26590 an error message that is used when access is denied. This behaviour is retained
26591 for backward compatibility, but current &"best practice"& is to avoid the use
26592 of &%endpass%&.
26593
26594
26595 .next
26596 .cindex "&%defer%& ACL verb"
26597 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26598 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26599 &%defer%& is the same as &%deny%&, because there is no way of sending a
26600 temporary error. For a RCPT command, &%defer%& is much the same as using a
26601 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26602 be used in any ACL, and even for a recipient it might be a simpler approach.
26603
26604
26605 .next
26606 .cindex "&%deny%& ACL verb"
26607 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26608 the conditions are not met, control is passed to the next ACL statement. For
26609 example,
26610 .code
26611 deny dnslists = blackholes.mail-abuse.org
26612 .endd
26613 rejects commands from hosts that are on a DNS black list.
26614
26615
26616 .next
26617 .cindex "&%discard%& ACL verb"
26618 &%discard%&: This verb behaves like &%accept%&, except that it returns
26619 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26620 that are concerned with receiving messages. When all the conditions are true,
26621 the sending entity receives a &"success"& response. However, &%discard%& causes
26622 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26623 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26624 message's recipients are discarded. Recipients that are discarded before DATA
26625 do not appear in the log line when the &%received_recipients%& log selector is set.
26626
26627 If the &%log_message%& modifier is set when &%discard%& operates,
26628 its contents are added to the line that is automatically written to the log.
26629 The &%message%& modifier operates exactly as it does for &%accept%&.
26630
26631
26632 .next
26633 .cindex "&%drop%& ACL verb"
26634 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26635 forcibly closed after the 5&'xx'& error message has been sent. For example:
26636 .code
26637 drop   message   = I don't take more than 20 RCPTs
26638        condition = ${if > {$rcpt_count}{20}}
26639 .endd
26640 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26641 The connection is always dropped after sending a 550 response.
26642
26643 .next
26644 .cindex "&%require%& ACL verb"
26645 &%require%&: If all the conditions are met, control is passed to the next ACL
26646 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26647 example, when checking a RCPT command,
26648 .code
26649 require message = Sender did not verify
26650         verify  = sender
26651 .endd
26652 passes control to subsequent statements only if the message's sender can be
26653 verified. Otherwise, it rejects the command. Note the positioning of the
26654 &%message%& modifier, before the &%verify%& condition. The reason for this is
26655 discussed in section &<<SECTcondmodproc>>&.
26656
26657 .next
26658 .cindex "&%warn%& ACL verb"
26659 &%warn%&: If all the conditions are true, a line specified by the
26660 &%log_message%& modifier is written to Exim's main log. Control always passes
26661 to the next ACL statement. If any condition is false, the log line is not
26662 written. If an identical log line is requested several times in the same
26663 message, only one copy is actually written to the log. If you want to force
26664 duplicates to be written, use the &%logwrite%& modifier instead.
26665
26666 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26667 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26668 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
26669 first failing condition. There is more about adding header lines in section
26670 &<<SECTaddheadacl>>&.
26671
26672 If any condition on a &%warn%& statement cannot be completed (that is, there is
26673 some sort of defer), the log line specified by &%log_message%& is not written.
26674 This does not include the case of a forced failure from a lookup, which
26675 is considered to be a successful completion. After a defer, no further
26676 conditions or modifiers in the &%warn%& statement are processed. The incident
26677 is logged, and the ACL continues to be processed, from the next statement
26678 onwards.
26679
26680
26681 .vindex "&$acl_verify_message$&"
26682 When one of the &%warn%& conditions is an address verification that fails, the
26683 text of the verification failure message is in &$acl_verify_message$&. If you
26684 want this logged, you must set it up explicitly. For example:
26685 .code
26686 warn   !verify = sender
26687        log_message = sender verify failed: $acl_verify_message
26688 .endd
26689 .endlist
26690
26691 At the end of each ACL there is an implicit unconditional &%deny%&.
26692
26693 As you can see from the examples above, the conditions and modifiers are
26694 written one to a line, with the first one on the same line as the verb, and
26695 subsequent ones on following lines. If you have a very long condition, you can
26696 continue it onto several physical lines by the usual backslash continuation
26697 mechanism. It is conventional to align the conditions vertically.
26698
26699
26700
26701 .section "ACL variables" "SECTaclvariables"
26702 .cindex "&ACL;" "variables"
26703 There are some special variables that can be set during ACL processing. They
26704 can be used to pass information between different ACLs, different invocations
26705 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26706 transports, and filters that are used to deliver a message. The names of these
26707 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26708 an underscore, but the remainder of the name can be any sequence of
26709 alphanumeric characters and underscores that you choose. There is no limit on
26710 the number of ACL variables. The two sets act as follows:
26711 .ilist
26712 The values of those variables whose names begin with &$acl_c$& persist
26713 throughout an SMTP connection. They are never reset. Thus, a value that is set
26714 while receiving one message is still available when receiving the next message
26715 on the same SMTP connection.
26716 .next
26717 The values of those variables whose names begin with &$acl_m$& persist only
26718 while a message is being received. They are reset afterwards. They are also
26719 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26720 .endlist
26721
26722 When a message is accepted, the current values of all the ACL variables are
26723 preserved with the message and are subsequently made available at delivery
26724 time. The ACL variables are set by a modifier called &%set%&. For example:
26725 .code
26726 accept hosts = whatever
26727        set acl_m4 = some value
26728 accept authenticated = *
26729        set acl_c_auth = yes
26730 .endd
26731 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26732 be set. If you want to set a variable without taking any action, you can use a
26733 &%warn%& verb without any other modifiers or conditions.
26734
26735 .oindex &%strict_acl_vars%&
26736 What happens if a syntactically valid but undefined ACL variable is
26737 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26738 false (the default), an empty string is substituted; if it is true, an
26739 error is generated.
26740
26741 Versions of Exim before 4.64 have a limited set of numbered variables, but
26742 their names are compatible, so there is no problem with upgrading.
26743
26744
26745 .section "Condition and modifier processing" "SECTcondmodproc"
26746 .cindex "&ACL;" "conditions; processing"
26747 .cindex "&ACL;" "modifiers; processing"
26748 An exclamation mark preceding a condition negates its result. For example:
26749 .code
26750 deny   domains = *.dom.example
26751       !verify  = recipient
26752 .endd
26753 causes the ACL to return &"deny"& if the recipient domain ends in
26754 &'dom.example'& and the recipient address cannot be verified. Sometimes
26755 negation can be used on the right-hand side of a condition. For example, these
26756 two statements are equivalent:
26757 .code
26758 deny  hosts = !192.168.3.4
26759 deny !hosts =  192.168.3.4
26760 .endd
26761 However, for many conditions (&%verify%& being a good example), only left-hand
26762 side negation of the whole condition is possible.
26763
26764 The arguments of conditions and modifiers are expanded. A forced failure
26765 of an expansion causes a condition to be ignored, that is, it behaves as if the
26766 condition is true. Consider these two statements:
26767 .code
26768 accept  senders = ${lookup{$host_name}lsearch\
26769                   {/some/file}{$value}fail}
26770 accept  senders = ${lookup{$host_name}lsearch\
26771                   {/some/file}{$value}{}}
26772 .endd
26773 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26774 the returned list is searched, but if the lookup fails the behaviour is
26775 different in the two cases. The &%fail%& in the first statement causes the
26776 condition to be ignored, leaving no further conditions. The &%accept%& verb
26777 therefore succeeds. The second statement, however, generates an empty list when
26778 the lookup fails. No sender can match an empty list, so the condition fails,
26779 and therefore the &%accept%& also fails.
26780
26781 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26782 specify actions that are taken as the conditions for a statement are checked;
26783 others specify text for messages that are used when access is denied or a
26784 warning is generated. The &%control%& modifier affects the way an incoming
26785 message is handled.
26786
26787 The positioning of the modifiers in an ACL statement is important, because the
26788 processing of a verb ceases as soon as its outcome is known. Only those
26789 modifiers that have already been encountered will take effect. For example,
26790 consider this use of the &%message%& modifier:
26791 .code
26792 require message = Can't verify sender
26793         verify  = sender
26794         message = Can't verify recipient
26795         verify  = recipient
26796         message = This message cannot be used
26797 .endd
26798 If sender verification fails, Exim knows that the result of the statement is
26799 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26800 so its text is used as the error message. If sender verification succeeds, but
26801 recipient verification fails, the second message is used. If recipient
26802 verification succeeds, the third message becomes &"current"&, but is never used
26803 because there are no more conditions to cause failure.
26804
26805 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26806 modifier that is used, because all the conditions must be true for rejection to
26807 happen. Specifying more than one &%message%& modifier does not make sense, and
26808 the message can even be specified after all the conditions. For example:
26809 .code
26810 deny   hosts = ...
26811       !senders = *@my.domain.example
26812        message = Invalid sender from client host
26813 .endd
26814 The &"deny"& result does not happen until the end of the statement is reached,
26815 by which time Exim has set up the message.
26816
26817
26818
26819 .section "ACL modifiers" "SECTACLmodi"
26820 .cindex "&ACL;" "modifiers; list of"
26821 The ACL modifiers are as follows:
26822
26823 .vlist
26824 .vitem &*add_header*&&~=&~<&'text'&>
26825 This modifier specifies one or more header lines that are to be added to an
26826 incoming message, assuming, of course, that the message is ultimately
26827 accepted. For details, see section &<<SECTaddheadacl>>&.
26828
26829 .vitem &*continue*&&~=&~<&'text'&>
26830 .cindex "&%continue%& ACL modifier"
26831 .cindex "database" "updating in ACL"
26832 This modifier does nothing of itself, and processing of the ACL always
26833 continues with the next condition or modifier. The value of &%continue%& is in
26834 the side effects of expanding its argument. Typically this could be used to
26835 update a database. It is really just a syntactic tidiness, to avoid having to
26836 write rather ugly lines like this:
26837 .display
26838 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26839 .endd
26840 Instead, all you need is
26841 .display
26842 &`continue = `&<&'some expansion'&>
26843 .endd
26844
26845 .vitem &*control*&&~=&~<&'text'&>
26846 .cindex "&%control%& ACL modifier"
26847 This modifier affects the subsequent processing of the SMTP connection or of an
26848 incoming message that is accepted. The effect of the first type of control
26849 lasts for the duration of the connection, whereas the effect of the second type
26850 lasts only until the current message has been received. The message-specific
26851 controls always apply to the whole message, not to individual recipients,
26852 even if the &%control%& modifier appears in a RCPT ACL.
26853
26854 As there are now quite a few controls that can be applied, they are described
26855 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26856 in several different ways. For example:
26857
26858 . ==== As this is a nested list, any displays it contains must be indented
26859 . ==== as otherwise they are too far to the left. That comment applies only
26860 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26861 . ==== way.
26862
26863 .ilist
26864 It can be at the end of an &%accept%& statement:
26865 .code
26866     accept  ...some conditions
26867             control = queue_only
26868 .endd
26869 In this case, the control is applied when this statement yields &"accept"&, in
26870 other words, when the conditions are all true.
26871
26872 .next
26873 It can be in the middle of an &%accept%& statement:
26874 .code
26875     accept  ...some conditions...
26876             control = queue_only
26877             ...some more conditions...
26878 .endd
26879 If the first set of conditions are true, the control is applied, even if the
26880 statement does not accept because one of the second set of conditions is false.
26881 In this case, some subsequent statement must yield &"accept"& for the control
26882 to be relevant.
26883
26884 .next
26885 It can be used with &%warn%& to apply the control, leaving the
26886 decision about accepting or denying to a subsequent verb. For
26887 example:
26888 .code
26889     warn    ...some conditions...
26890             control = freeze
26891     accept  ...
26892 .endd
26893 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26894 &%logwrite%&, so it does not add anything to the message and does not write a
26895 log entry.
26896
26897 .next
26898 If you want to apply a control unconditionally, you can use it with a
26899 &%require%& verb. For example:
26900 .code
26901     require  control = no_multiline_responses
26902 .endd
26903 .endlist
26904
26905 .vitem &*delay*&&~=&~<&'time'&>
26906 .cindex "&%delay%& ACL modifier"
26907 .oindex "&%-bh%&"
26908 This modifier may appear in any ACL except notquit. It causes Exim to wait for
26909 the time interval before proceeding. However, when testing Exim using the
26910 &%-bh%& option, the delay is not actually imposed (an appropriate message is
26911 output instead). The time is given in the usual Exim notation, and the delay
26912 happens as soon as the modifier is processed. In an SMTP session, pending
26913 output is flushed before the delay is imposed.
26914
26915 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26916 example:
26917 .code
26918 deny    ...some conditions...
26919         delay = 30s
26920 .endd
26921 The delay happens if all the conditions are true, before the statement returns
26922 &"deny"&. Compare this with:
26923 .code
26924 deny    delay = 30s
26925         ...some conditions...
26926 .endd
26927 which waits for 30s before processing the conditions. The &%delay%& modifier
26928 can also be used with &%warn%& and together with &%control%&:
26929 .code
26930 warn    ...some conditions...
26931         delay = 2m
26932         control = freeze
26933 accept  ...
26934 .endd
26935
26936 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26937 responses to several commands are no longer buffered and sent in one packet (as
26938 they would normally be) because all output is flushed before imposing the
26939 delay. This optimization is disabled so that a number of small delays do not
26940 appear to the client as one large aggregated delay that might provoke an
26941 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26942 using a &%control%& modifier to set &%no_delay_flush%&.
26943
26944
26945 .vitem &*endpass*&
26946 .cindex "&%endpass%& ACL modifier"
26947 This modifier, which has no argument, is recognized only in &%accept%& and
26948 &%discard%& statements. It marks the boundary between the conditions whose
26949 failure causes control to pass to the next statement, and the conditions whose
26950 failure causes the ACL to return &"deny"&. This concept has proved to be
26951 confusing to some people, so the use of &%endpass%& is no longer recommended as
26952 &"best practice"&. See the description of &%accept%& above for more details.
26953
26954
26955 .vitem &*log_message*&&~=&~<&'text'&>
26956 .cindex "&%log_message%& ACL modifier"
26957 This modifier sets up a message that is used as part of the log message if the
26958 ACL denies access or a &%warn%& statement's conditions are true. For example:
26959 .code
26960 require log_message = wrong cipher suite $tls_in_cipher
26961         encrypted   = DES-CBC3-SHA
26962 .endd
26963 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26964 example:
26965 .display
26966 &`discard `&<&'some conditions'&>
26967 &`        log_message = Discarded $local_part@$domain because...`&
26968 .endd
26969 When access is denied, &%log_message%& adds to any underlying error message
26970 that may exist because of a condition failure. For example, while verifying a
26971 recipient address, a &':fail:'& redirection might have already set up a
26972 message.
26973
26974 The message may be defined before the conditions to which it applies, because
26975 the string expansion does not happen until Exim decides that access is to be
26976 denied. This means that any variables that are set by the condition are
26977 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26978 variables are set after a DNS black list lookup succeeds. If the expansion of
26979 &%log_message%& fails, or if the result is an empty string, the modifier is
26980 ignored.
26981
26982 .vindex "&$acl_verify_message$&"
26983 If you want to use a &%warn%& statement to log the result of an address
26984 verification, you can use &$acl_verify_message$& to include the verification
26985 error message.
26986
26987 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26988 the start of the logged message. If the same warning log message is requested
26989 more than once while receiving  a single email message, only one copy is
26990 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26991 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26992 is logged for a successful &%warn%& statement.
26993
26994 If &%log_message%& is not present and there is no underlying error message (for
26995 example, from the failure of address verification), but &%message%& is present,
26996 the &%message%& text is used for logging rejections. However, if any text for
26997 logging contains newlines, only the first line is logged. In the absence of
26998 both &%log_message%& and &%message%&, a default built-in message is used for
26999 logging rejections.
27000
27001
27002 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27003 .cindex "&%log_reject_target%& ACL modifier"
27004 .cindex "logging in ACL" "specifying which log"
27005 This modifier makes it possible to specify which logs are used for messages
27006 about ACL rejections. Its argument is a colon-separated list of words that can
27007 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27008 may be empty, in which case a rejection is not logged at all. For example, this
27009 ACL fragment writes no logging information when access is denied:
27010 .display
27011 &`deny `&<&'some conditions'&>
27012 &`     log_reject_target =`&
27013 .endd
27014 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27015 permanent and temporary rejections. Its effect lasts for the rest of the
27016 current ACL.
27017
27018
27019 .vitem &*logwrite*&&~=&~<&'text'&>
27020 .cindex "&%logwrite%& ACL modifier"
27021 .cindex "logging in ACL" "immediate"
27022 This modifier writes a message to a log file as soon as it is encountered when
27023 processing an ACL. (Compare &%log_message%&, which, except in the case of
27024 &%warn%& and &%discard%&, is used only if the ACL statement denies
27025 access.) The &%logwrite%& modifier can be used to log special incidents in
27026 ACLs. For example:
27027 .display
27028 &`accept `&<&'some special conditions'&>
27029 &`       control  = freeze`&
27030 &`       logwrite = froze message because ...`&
27031 .endd
27032 By default, the message is written to the main log. However, it may begin
27033 with a colon, followed by a comma-separated list of log names, and then
27034 another colon, to specify exactly which logs are to be written. For
27035 example:
27036 .code
27037 logwrite = :main,reject: text for main and reject logs
27038 logwrite = :panic: text for panic log only
27039 .endd
27040
27041
27042 .vitem &*message*&&~=&~<&'text'&>
27043 .cindex "&%message%& ACL modifier"
27044 This modifier sets up a text string that is expanded and used as a response
27045 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27046 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27047 there is some complication if &%endpass%& is involved; see the description of
27048 &%accept%& for details.)
27049
27050 The expansion of the message happens at the time Exim decides that the ACL is
27051 to end, not at the time it processes &%message%&. If the expansion fails, or
27052 generates an empty string, the modifier is ignored. Here is an example where
27053 &%message%& must be specified first, because the ACL ends with a rejection if
27054 the &%hosts%& condition fails:
27055 .code
27056 require  message = Host not recognized
27057          hosts = 10.0.0.0/8
27058 .endd
27059 (Once a condition has failed, no further conditions or modifiers are
27060 processed.)
27061
27062 .cindex "SMTP" "error codes"
27063 .oindex "&%smtp_banner%&
27064 For ACLs that are triggered by SMTP commands, the message is returned as part
27065 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27066 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27067 is accepted. In the case of the connect ACL, accepting with a message modifier
27068 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27069 accept message may not contain more than one line (otherwise it will be
27070 truncated at the first newline and a panic logged), and it cannot affect the
27071 EHLO options.
27072
27073 When SMTP is involved, the message may begin with an overriding response code,
27074 consisting of three digits optionally followed by an &"extended response code"&
27075 of the form &'n.n.n'&, each code being followed by a space. For example:
27076 .code
27077 deny  message = 599 1.2.3 Host not welcome
27078       hosts = 192.168.34.0/24
27079 .endd
27080 The first digit of the supplied response code must be the same as would be sent
27081 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27082 access, but for the predata ACL, note that the default success code is 354, not
27083 2&'xx'&.
27084
27085 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27086 the message modifier cannot override the 221 response code.
27087
27088 The text in a &%message%& modifier is literal; any quotes are taken as
27089 literals, but because the string is expanded, backslash escapes are processed
27090 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27091 response.
27092
27093 .vindex "&$acl_verify_message$&"
27094 If &%message%& is used on a statement that verifies an address, the message
27095 specified overrides any message that is generated by the verification process.
27096 However, the original message is available in the variable
27097 &$acl_verify_message$&, so you can incorporate it into your message if you
27098 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27099 routers to be passed back as part of the SMTP response, you should either not
27100 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27101
27102 For compatibility with previous releases of Exim, a &%message%& modifier that
27103 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27104 modifier, but this usage is now deprecated. However, &%message%& acts only when
27105 all the conditions are true, wherever it appears in an ACL command, whereas
27106 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27107 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27108 effect.
27109
27110
27111 .vitem &*remove_header*&&~=&~<&'text'&>
27112 This modifier specifies one or more header names in a colon-separated list
27113  that are to be removed from an incoming message, assuming, of course, that
27114 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27115
27116
27117 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27118 .cindex "&%set%& ACL modifier"
27119 This modifier puts a value into one of the ACL variables (see section
27120 &<<SECTaclvariables>>&).
27121
27122
27123 .vitem &*udpsend*&&~=&~<&'parameters'&>
27124 This modifier sends a UDP packet, for purposes such as statistics
27125 collection or behaviour monitoring. The parameters are expanded, and
27126 the result of the expansion must be a colon-separated list consisting
27127 of a destination server, port number, and the packet contents. The
27128 server can be specified as a host name or IPv4 or IPv6 address. The
27129 separator can be changed with the usual angle bracket syntax. For
27130 example, you might want to collect information on which hosts connect
27131 when:
27132 .code
27133 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27134              $tod_zulu $sender_host_address
27135 .endd
27136 .endlist
27137
27138
27139
27140
27141
27142 .section "Use of the control modifier" "SECTcontrols"
27143 .cindex "&%control%& ACL modifier"
27144 The &%control%& modifier supports the following settings:
27145
27146 .vlist
27147 .vitem &*control&~=&~allow_auth_unadvertised*&
27148 This modifier allows a client host to use the SMTP AUTH command even when it
27149 has not been advertised in response to EHLO. Furthermore, because there are
27150 apparently some really broken clients that do this, Exim will accept AUTH after
27151 HELO (rather than EHLO) when this control is set. It should be used only if you
27152 really need it, and you should limit its use to those broken clients that do
27153 not work without it. For example:
27154 .code
27155 warn hosts   = 192.168.34.25
27156      control = allow_auth_unadvertised
27157 .endd
27158 Normally, when an Exim server receives an AUTH command, it checks the name of
27159 the authentication mechanism that is given in the command to ensure that it
27160 matches an advertised mechanism. When this control is set, the check that a
27161 mechanism has been advertised is bypassed. Any configured mechanism can be used
27162 by the client. This control is permitted only in the connection and HELO ACLs.
27163
27164
27165 .vitem &*control&~=&~caseful_local_part*& &&&
27166        &*control&~=&~caselower_local_part*&
27167 .cindex "&ACL;" "case of local part in"
27168 .cindex "case of local parts"
27169 .vindex "&$local_part$&"
27170 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27171 (that is, during RCPT processing). By default, the contents of &$local_part$&
27172 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27173 any uppercase letters in the original local part are restored in &$local_part$&
27174 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27175 is encountered.
27176
27177 These controls affect only the current recipient. Moreover, they apply only to
27178 local part handling that takes place directly in the ACL (for example, as a key
27179 in lookups). If a test to verify the recipient is obeyed, the case-related
27180 handling of the local part during the verification is controlled by the router
27181 configuration (see the &%caseful_local_part%& generic router option).
27182
27183 This facility could be used, for example, to add a spam score to local parts
27184 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27185 spam score:
27186 .code
27187 warn  control = caseful_local_part
27188       set acl_m4 = ${eval:\
27189                      $acl_m4 + \
27190                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27191                     }
27192       control = caselower_local_part
27193 .endd
27194 Notice that we put back the lower cased version afterwards, assuming that
27195 is what is wanted for subsequent tests.
27196
27197
27198 .new
27199 .vitem &*control&~=&~cutthrough_delivery*&
27200 .cindex "&ACL;" "cutthrough routing"
27201 .cindex "cutthrough" "requesting"
27202 This option requests delivery be attempted while the item is being received.
27203 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27204 from one SMTP connection to another.  If a recipient-verify callout connection is
27205 requested in the same ACL it is held open and used for the data, otherwise one is made
27206 after the ACL completes.  Note that routers are used in verify mode.
27207
27208 Should the ultimate destination system positively accept or reject the mail,
27209 a corresponding indication is given to the source system and nothing is queued.
27210 If there is a temporary error the item is queued for later delivery in the
27211 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27212 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27213 line.
27214
27215 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27216 sender when the destination system is doing content-scan based rejection.
27217 .wen
27218
27219
27220 .new
27221 .vitem &*control&~=&~debug/*&<&'options'&>
27222 .cindex "&ACL;" "enabling debug logging"
27223 .cindex "debugging" "enabling from an ACL"
27224 This control turns on debug logging, almost as though Exim had been invoked
27225 with &`-d`&, with the output going to a new logfile, by default called
27226 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27227 may access any variables already defined.  The logging may be adjusted with
27228 the &'opts'& option, which takes the same values as the &`-d`& command-line
27229 option.  Some examples (which depend on variables that don't exist in all
27230 contexts):
27231 .code
27232       control = debug
27233       control = debug/tag=.$sender_host_address
27234       control = debug/opts=+expand+acl
27235       control = debug/tag=.$message_exim_id/opts=+expand
27236 .endd
27237 .wen
27238
27239
27240 .new
27241 .vitem &*control&~=&~dkim_disable_verify*&
27242 .cindex "disable DKIM verify"
27243 .cindex "DKIM" "disable verify"
27244 This control turns off DKIM verification processing entirely.  For details on
27245 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27246 .wen
27247
27248
27249 .new
27250 .vitem &*control&~=&~dscp/*&<&'value'&>
27251 .cindex "&ACL;" "setting DSCP value"
27252 .cindex "DSCP" "inbound"
27253 This option causes the DSCP value associated with the socket for the inbound
27254 connection to be adjusted to a given value, given as one of a number of fixed
27255 strings or to numeric value.
27256 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27257 Common values include &`throughput`&, &`mincost`&, and on newer systems
27258 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27259
27260 The outbound packets from Exim will be marked with this value in the header
27261 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27262 that these values will have any effect, not be stripped by networking
27263 equipment, or do much of anything without cooperation with your Network
27264 Engineer and those of all network operators between the source and destination.
27265 .wen
27266
27267
27268 .vitem &*control&~=&~enforce_sync*& &&&
27269        &*control&~=&~no_enforce_sync*&
27270 .cindex "SMTP" "synchronization checking"
27271 .cindex "synchronization checking in SMTP"
27272 These controls make it possible to be selective about when SMTP synchronization
27273 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27274 state of the switch (it is true by default). See the description of this option
27275 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27276
27277 The effect of these two controls lasts for the remainder of the SMTP
27278 connection. They can appear in any ACL except the one for the non-SMTP
27279 messages. The most straightforward place to put them is in the ACL defined by
27280 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27281 before the first synchronization check. The expected use is to turn off the
27282 synchronization checks for badly-behaved hosts that you nevertheless need to
27283 work with.
27284
27285
27286 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27287 .cindex "fake defer"
27288 .cindex "defer, fake"
27289 This control works in exactly the same way as &%fakereject%& (described below)
27290 except that it causes an SMTP 450 response after the message data instead of a
27291 550 response. You must take care when using &%fakedefer%& because it causes the
27292 messages to be duplicated when the sender retries. Therefore, you should not
27293 use &%fakedefer%& if the message is to be delivered normally.
27294
27295 .vitem &*control&~=&~fakereject/*&<&'message'&>
27296 .cindex "fake rejection"
27297 .cindex "rejection, fake"
27298 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27299 words, only when an SMTP message is being received. If Exim accepts the
27300 message, instead the final 250 response, a 550 rejection message is sent.
27301 However, Exim proceeds to deliver the message as normal. The control applies
27302 only to the current message, not to any subsequent ones that may be received in
27303 the same SMTP connection.
27304
27305 The text for the 550 response is taken from the &%control%& modifier. If no
27306 message is supplied, the following is used:
27307 .code
27308 550-Your message has been rejected but is being
27309 550-kept for evaluation.
27310 550-If it was a legitimate message, it may still be
27311 550 delivered to the target recipient(s).
27312 .endd
27313 This facility should be used with extreme caution.
27314
27315 .vitem &*control&~=&~freeze*&
27316 .cindex "frozen messages" "forcing in ACL"
27317 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27318 other words, only when a message is being received. If the message is accepted,
27319 it is placed on Exim's queue and frozen. The control applies only to the
27320 current message, not to any subsequent ones that may be received in the same
27321 SMTP connection.
27322
27323 This modifier can optionally be followed by &`/no_tell`&. If the global option
27324 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27325 is told about the freezing), provided all the &*control=freeze*& modifiers that
27326 are obeyed for the current message have the &`/no_tell`& option.
27327
27328 .vitem &*control&~=&~no_delay_flush*&
27329 .cindex "SMTP" "output flushing, disabling for delay"
27330 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27331 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27332 use. This control, as long as it is encountered before the &%delay%& modifier,
27333 disables such output flushing.
27334
27335 .vitem &*control&~=&~no_callout_flush*&
27336 .cindex "SMTP" "output flushing, disabling for callout"
27337 Exim normally flushes SMTP output before performing a callout in an ACL, to
27338 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27339 use. This control, as long as it is encountered before the &%verify%& condition
27340 that causes the callout, disables such output flushing.
27341
27342 .vitem &*control&~=&~no_mbox_unspool*&
27343 This control is available when Exim is compiled with the content scanning
27344 extension. Content scanning may require a copy of the current message, or parts
27345 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27346 or spam scanner. Normally, such copies are deleted when they are no longer
27347 needed. If this control is set, the copies are not deleted. The control applies
27348 only to the current message, not to any subsequent ones that may be received in
27349 the same SMTP connection. It is provided for debugging purposes and is unlikely
27350 to be useful in production.
27351
27352 .vitem &*control&~=&~no_multiline_responses*&
27353 .cindex "multiline responses, suppressing"
27354 This control is permitted for any ACL except the one for non-SMTP messages.
27355 It seems that there are broken clients in use that cannot handle multiline
27356 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27357
27358 If this control is set, multiline SMTP responses from ACL rejections are
27359 suppressed. One way of doing this would have been to put out these responses as
27360 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27361 (&"use multiline responses for more"& it says &-- ha!), and some of the
27362 responses might get close to that. So this facility, which is after all only a
27363 sop to broken clients, is implemented by doing two very easy things:
27364
27365 .ilist
27366 Extra information that is normally output as part of a rejection caused by
27367 sender verification failure is omitted. Only the final line (typically &"sender
27368 verification failed"&) is sent.
27369 .next
27370 If a &%message%& modifier supplies a multiline response, only the first
27371 line is output.
27372 .endlist
27373
27374 The setting of the switch can, of course, be made conditional on the
27375 calling host. Its effect lasts until the end of the SMTP connection.
27376
27377 .vitem &*control&~=&~no_pipelining*&
27378 .cindex "PIPELINING" "suppressing advertising"
27379 This control turns off the advertising of the PIPELINING extension to SMTP in
27380 the current session. To be useful, it must be obeyed before Exim sends its
27381 response to an EHLO command. Therefore, it should normally appear in an ACL
27382 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27383 &%pipelining_advertise_hosts%&.
27384
27385 .vitem &*control&~=&~queue_only*&
27386 .oindex "&%queue_only%&"
27387 .cindex "queueing incoming messages"
27388 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27389 other words, only when a message is being received. If the message is accepted,
27390 it is placed on Exim's queue and left there for delivery by a subsequent queue
27391 runner. No immediate delivery process is started. In other words, it has the
27392 effect as the &%queue_only%& global option. However, the control applies only
27393 to the current message, not to any subsequent ones that may be received in the
27394 same SMTP connection.
27395
27396 .vitem &*control&~=&~submission/*&<&'options'&>
27397 .cindex "message" "submission"
27398 .cindex "submission mode"
27399 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27400 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
27401 the current message is a submission from a local MUA. In this case, Exim
27402 operates in &"submission mode"&, and applies certain fixups to the message if
27403 necessary. For example, it adds a &'Date:'& header line if one is not present.
27404 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
27405 late (the message has already been created).
27406
27407 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
27408 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
27409 submission mode; the available options for this control are described there.
27410 The control applies only to the current message, not to any subsequent ones
27411 that may be received in the same SMTP connection.
27412
27413 .vitem &*control&~=&~suppress_local_fixups*&
27414 .cindex "submission fixups, suppressing"
27415 This control applies to locally submitted (non TCP/IP) messages, and is the
27416 complement of &`control = submission`&. It disables the fixups that are
27417 normally applied to locally-submitted messages. Specifically:
27418
27419 .ilist
27420 Any &'Sender:'& header line is left alone (in this respect, it is a
27421 dynamic version of &%local_sender_retain%&).
27422 .next
27423 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
27424 .next
27425 There is no check that &'From:'& corresponds to the actual sender.
27426 .endlist ilist
27427
27428 This control may be useful when a remotely-originated message is accepted,
27429 passed to some scanning program, and then re-submitted for delivery. It can be
27430 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27431 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
27432 data is read.
27433
27434 &*Note:*& This control applies only to the current message, not to any others
27435 that are being submitted at the same time using &%-bs%& or &%-bS%&.
27436 .endlist vlist
27437
27438
27439 .section "Summary of message fixup control" "SECTsummesfix"
27440 All four possibilities for message fixups can be specified:
27441
27442 .ilist
27443 Locally submitted, fixups applied: the default.
27444 .next
27445 Locally submitted, no fixups applied: use
27446 &`control = suppress_local_fixups`&.
27447 .next
27448 Remotely submitted, no fixups applied: the default.
27449 .next
27450 Remotely submitted, fixups applied: use &`control = submission`&.
27451 .endlist
27452
27453
27454
27455 .section "Adding header lines in ACLs" "SECTaddheadacl"
27456 .cindex "header lines" "adding in an ACL"
27457 .cindex "header lines" "position of added lines"
27458 .cindex "&%add_header%& ACL modifier"
27459 The &%add_header%& modifier can be used to add one or more extra header lines
27460 to an incoming message, as in this example:
27461 .code
27462 warn dnslists = sbl.spamhaus.org : \
27463                 dialup.mail-abuse.org
27464      add_header = X-blacklisted-at: $dnslist_domain
27465 .endd
27466 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27467 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27468 receiving a message). The message must ultimately be accepted for
27469 &%add_header%& to have any significant effect. You can use &%add_header%& with
27470 any ACL verb, including &%deny%& (though this is potentially useful only in a
27471 RCPT ACL).
27472
27473 Leading and trailing newlines are removed from
27474 the data for the &%add_header%& modifier; if it then
27475 contains one or more newlines that
27476 are not followed by a space or a tab, it is assumed to contain multiple header
27477 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
27478 front of any line that is not a valid header line.
27479
27480 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27481 They are added to the message before processing the DATA and MIME ACLs.
27482 However, if an identical header line is requested more than once, only one copy
27483 is actually added to the message. Further header lines may be accumulated
27484 during the DATA and MIME ACLs, after which they are added to the message, again
27485 with duplicates suppressed. Thus, it is possible to add two identical header
27486 lines to an SMTP message, but only if one is added before DATA and one after.
27487 In the case of non-SMTP messages, new headers are accumulated during the
27488 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
27489 message is rejected after DATA or by the non-SMTP ACL, all added header lines
27490 are included in the entry that is written to the reject log.
27491
27492 .cindex "header lines" "added; visibility of"
27493 Header lines are not visible in string expansions
27494 of message headers
27495 until they are added to the
27496 message. It follows that header lines defined in the MAIL, RCPT, and predata
27497 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
27498 header lines that are added by the DATA or MIME ACLs are not visible in those
27499 ACLs. Because of this restriction, you cannot use header lines as a way of
27500 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
27501 this, you can use ACL variables, as described in section
27502 &<<SECTaclvariables>>&.
27503
27504 The list of headers yet to be added is given by the &%$headers_added%& variable.
27505
27506 The &%add_header%& modifier acts immediately as it is encountered during the
27507 processing of an ACL. Notice the difference between these two cases:
27508 .display
27509 &`accept add_header = ADDED: some text`&
27510 &`       `&<&'some condition'&>
27511
27512 &`accept `&<&'some condition'&>
27513 &`       add_header = ADDED: some text`&
27514 .endd
27515 In the first case, the header line is always added, whether or not the
27516 condition is true. In the second case, the header line is added only if the
27517 condition is true. Multiple occurrences of &%add_header%& may occur in the same
27518 ACL statement. All those that are encountered before a condition fails are
27519 honoured.
27520
27521 .cindex "&%warn%& ACL verb"
27522 For compatibility with previous versions of Exim, a &%message%& modifier for a
27523 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
27524 effect only if all the conditions are true, even if it appears before some of
27525 them. Furthermore, only the last occurrence of &%message%& is honoured. This
27526 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
27527 are present on a &%warn%& verb, both are processed according to their
27528 specifications.
27529
27530 By default, new header lines are added to a message at the end of the existing
27531 header lines. However, you can specify that any particular header line should
27532 be added right at the start (before all the &'Received:'& lines), immediately
27533 after the first block of &'Received:'& lines, or immediately before any line
27534 that is not a &'Received:'& or &'Resent-something:'& header.
27535
27536 This is done by specifying &":at_start:"&, &":after_received:"&, or
27537 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
27538 header line, respectively. (Header text cannot start with a colon, as there has
27539 to be a header name first.) For example:
27540 .code
27541 warn add_header = \
27542        :after_received:X-My-Header: something or other...
27543 .endd
27544 If more than one header line is supplied in a single &%add_header%& modifier,
27545 each one is treated independently and can therefore be placed differently. If
27546 you add more than one line at the start, or after the Received: block, they end
27547 up in reverse order.
27548
27549 &*Warning*&: This facility currently applies only to header lines that are
27550 added in an ACL. It does NOT work for header lines that are added in a
27551 system filter or in a router or transport.
27552
27553
27554
27555 .section "Removing header lines in ACLs" "SECTremoveheadacl"
27556 .cindex "header lines" "removing in an ACL"
27557 .cindex "header lines" "position of removed lines"
27558 .cindex "&%remove_header%& ACL modifier"
27559 The &%remove_header%& modifier can be used to remove one or more header lines
27560 from an incoming message, as in this example:
27561 .code
27562 warn   message        = Remove internal headers
27563        remove_header  = x-route-mail1 : x-route-mail2
27564 .endd
27565 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27566 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27567 receiving a message). The message must ultimately be accepted for
27568 &%remove_header%& to have any significant effect. You can use &%remove_header%&
27569 with any ACL verb, including &%deny%&, though this is really not useful for
27570 any verb that doesn't result in a delivered message.
27571
27572 More than one header can be removed at the same time by using a colon separated
27573 list of header names. The header matching is case insensitive. Wildcards are
27574 not permitted, nor is list expansion performed, so you cannot use hostlists to
27575 create a list of headers, however both connection and message variable expansion
27576 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
27577 .code
27578 warn   hosts           = +internal_hosts
27579        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
27580 warn   message         = Remove internal headers
27581        remove_header   = $acl_c_ihdrs
27582 .endd
27583 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27584 They are removed from the message before processing the DATA and MIME ACLs.
27585 There is no harm in attempting to remove the same header twice nor is removing
27586 a non-existent header. Further header lines to be removed may be accumulated
27587 during the DATA and MIME ACLs, after which they are removed from the message,
27588 if present. In the case of non-SMTP messages, headers to be removed are
27589 accumulated during the non-SMTP ACLs, and are removed from the message after
27590 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
27591 ACL, there really is no effect because there is no logging of what headers
27592 would have been removed.
27593
27594 .cindex "header lines" "removed; visibility of"
27595 Header lines are not visible in string expansions until the DATA phase when it
27596 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
27597 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
27598 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
27599 this restriction, you cannot use header lines as a way of controlling data
27600 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
27601 you should instead use ACL variables, as described in section
27602 &<<SECTaclvariables>>&.
27603
27604 The &%remove_header%& modifier acts immediately as it is encountered during the
27605 processing of an ACL. Notice the difference between these two cases:
27606 .display
27607 &`accept remove_header = X-Internal`&
27608 &`       `&<&'some condition'&>
27609
27610 &`accept `&<&'some condition'&>
27611 &`       remove_header = X-Internal`&
27612 .endd
27613 In the first case, the header line is always removed, whether or not the
27614 condition is true. In the second case, the header line is removed only if the
27615 condition is true. Multiple occurrences of &%remove_header%& may occur in the
27616 same ACL statement. All those that are encountered before a condition fails
27617 are honoured.
27618
27619 &*Warning*&: This facility currently applies only to header lines that are
27620 present during ACL processing. It does NOT remove header lines that are added
27621 in a system filter or in a router or transport.
27622
27623
27624
27625
27626
27627 .section "ACL conditions" "SECTaclconditions"
27628 .cindex "&ACL;" "conditions; list of"
27629 Some of the conditions listed in this section are available only when Exim is
27630 compiled with the content-scanning extension. They are included here briefly
27631 for completeness. More detailed descriptions can be found in the discussion on
27632 content scanning in chapter &<<CHAPexiscan>>&.
27633
27634 Not all conditions are relevant in all circumstances. For example, testing
27635 senders and recipients does not make sense in an ACL that is being run as the
27636 result of the arrival of an ETRN command, and checks on message headers can be
27637 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27638 can use the same condition (with different parameters) more than once in the
27639 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27640 The conditions are as follows:
27641
27642
27643 .vlist
27644 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27645 .cindex "&ACL;" "nested"
27646 .cindex "&ACL;" "indirect"
27647 .cindex "&ACL;" "arguments"
27648 .cindex "&%acl%& ACL condition"
27649 The possible values of the argument are the same as for the
27650 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27651 &"accept"& the condition is true; if it returns &"deny"& the condition is
27652 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27653 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27654 condition false. This means that further processing of the &%warn%& verb
27655 ceases, but processing of the ACL continues.
27656
27657 If the argument is a named ACL, up to nine space-separated optional values
27658 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
27659 and $acl_narg is set to the count of values.
27660 Previous values of these variables are restored after the call returns.
27661 The name and values are expanded separately.
27662
27663 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27664 the connection is dropped. If it returns &"discard"&, the verb must be
27665 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27666 conditions are tested.
27667
27668 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27669 loops. This condition allows you to use different ACLs in different
27670 circumstances. For example, different ACLs can be used to handle RCPT commands
27671 for different local users or different local domains.
27672
27673 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27674 .cindex "&%authenticated%& ACL condition"
27675 .cindex "authentication" "ACL checking"
27676 .cindex "&ACL;" "testing for authentication"
27677 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27678 the name of the authenticator is tested against the list. To test for
27679 authentication by any authenticator, you can set
27680 .code
27681 authenticated = *
27682 .endd
27683
27684 .vitem &*condition&~=&~*&<&'string'&>
27685 .cindex "&%condition%& ACL condition"
27686 .cindex "customizing" "ACL condition"
27687 .cindex "&ACL;" "customized test"
27688 .cindex "&ACL;" "testing, customized"
27689 This feature allows you to make up custom conditions. If the result of
27690 expanding the string is an empty string, the number zero, or one of the strings
27691 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27692 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27693 any other value, some error is assumed to have occurred, and the ACL returns
27694 &"defer"&. However, if the expansion is forced to fail, the condition is
27695 ignored. The effect is to treat it as true, whether it is positive or
27696 negative.
27697
27698 .vitem &*decode&~=&~*&<&'location'&>
27699 .cindex "&%decode%& ACL condition"
27700 This condition is available only when Exim is compiled with the
27701 content-scanning extension, and it is allowed only in the ACL defined by
27702 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27703 If all goes well, the condition is true. It is false only if there are
27704 problems such as a syntax error or a memory shortage. For more details, see
27705 chapter &<<CHAPexiscan>>&.
27706
27707 .vitem &*demime&~=&~*&<&'extension&~list'&>
27708 .cindex "&%demime%& ACL condition"
27709 This condition is available only when Exim is compiled with the
27710 content-scanning extension. Its use is described in section
27711 &<<SECTdemimecond>>&.
27712
27713 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27714 .cindex "&%dnslists%& ACL condition"
27715 .cindex "DNS list" "in ACL"
27716 .cindex "black list (DNS)"
27717 .cindex "&ACL;" "testing a DNS list"
27718 This condition checks for entries in DNS black lists. These are also known as
27719 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27720 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27721 different variants of this condition to describe briefly here. See sections
27722 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27723
27724 .vitem &*domains&~=&~*&<&'domain&~list'&>
27725 .cindex "&%domains%& ACL condition"
27726 .cindex "domain" "ACL checking"
27727 .cindex "&ACL;" "testing a recipient domain"
27728 .vindex "&$domain_data$&"
27729 This condition is relevant only after a RCPT command. It checks that the domain
27730 of the recipient address is in the domain list. If percent-hack processing is
27731 enabled, it is done before this test is done. If the check succeeds with a
27732 lookup, the result of the lookup is placed in &$domain_data$& until the next
27733 &%domains%& test.
27734
27735 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27736 use &%domains%& in a DATA ACL.
27737
27738
27739 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27740 .cindex "&%encrypted%& ACL condition"
27741 .cindex "encryption" "checking in an ACL"
27742 .cindex "&ACL;" "testing for encryption"
27743 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27744 name of the cipher suite in use is tested against the list. To test for
27745 encryption without testing for any specific cipher suite(s), set
27746 .code
27747 encrypted = *
27748 .endd
27749
27750
27751 .vitem &*hosts&~=&~*&<&'host&~list'&>
27752 .cindex "&%hosts%& ACL condition"
27753 .cindex "host" "ACL checking"
27754 .cindex "&ACL;" "testing the client host"
27755 This condition tests that the calling host matches the host list. If you have
27756 name lookups or wildcarded host names and IP addresses in the same host list,
27757 you should normally put the IP addresses first. For example, you could have:
27758 .code
27759 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27760 .endd
27761 The lookup in this example uses the host name for its key. This is implied by
27762 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27763 and it wouldn't matter which way round you had these two items.)
27764
27765 The reason for the problem with host names lies in the left-to-right way that
27766 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27767 but when it reaches an item that requires a host name, it fails if it cannot
27768 find a host name to compare with the pattern. If the above list is given in the
27769 opposite order, the &%accept%& statement fails for a host whose name cannot be
27770 found, even if its IP address is 10.9.8.7.
27771
27772 If you really do want to do the name check first, and still recognize the IP
27773 address even if the name lookup fails, you can rewrite the ACL like this:
27774 .code
27775 accept hosts = dbm;/etc/friendly/hosts
27776 accept hosts = 10.9.8.7
27777 .endd
27778 The default action on failing to find the host name is to assume that the host
27779 is not in the list, so the first &%accept%& statement fails. The second
27780 statement can then check the IP address.
27781
27782 .vindex "&$host_data$&"
27783 If a &%hosts%& condition is satisfied by means of a lookup, the result
27784 of the lookup is made available in the &$host_data$& variable. This
27785 allows you, for example, to set up a statement like this:
27786 .code
27787 deny  hosts = net-lsearch;/some/file
27788 message = $host_data
27789 .endd
27790 which gives a custom error message for each denied host.
27791
27792 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27793 .cindex "&%local_parts%& ACL condition"
27794 .cindex "local part" "ACL checking"
27795 .cindex "&ACL;" "testing a local part"
27796 .vindex "&$local_part_data$&"
27797 This condition is relevant only after a RCPT command. It checks that the local
27798 part of the recipient address is in the list. If percent-hack processing is
27799 enabled, it is done before this test. If the check succeeds with a lookup, the
27800 result of the lookup is placed in &$local_part_data$&, which remains set until
27801 the next &%local_parts%& test.
27802
27803 .vitem &*malware&~=&~*&<&'option'&>
27804 .cindex "&%malware%& ACL condition"
27805 .cindex "&ACL;" "virus scanning"
27806 .cindex "&ACL;" "scanning for viruses"
27807 This condition is available only when Exim is compiled with the
27808 content-scanning extension. It causes the incoming message to be scanned for
27809 viruses. For details, see chapter &<<CHAPexiscan>>&.
27810
27811 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27812 .cindex "&%mime_regex%& ACL condition"
27813 .cindex "&ACL;" "testing by regex matching"
27814 This condition is available only when Exim is compiled with the
27815 content-scanning extension, and it is allowed only in the ACL defined by
27816 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27817 with any of the regular expressions. For details, see chapter
27818 &<<CHAPexiscan>>&.
27819
27820 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27821 .cindex "rate limiting"
27822 This condition can be used to limit the rate at which a user or host submits
27823 messages. Details are given in section &<<SECTratelimiting>>&.
27824
27825 .vitem &*recipients&~=&~*&<&'address&~list'&>
27826 .cindex "&%recipients%& ACL condition"
27827 .cindex "recipient" "ACL checking"
27828 .cindex "&ACL;" "testing a recipient"
27829 This condition is relevant only after a RCPT command. It checks the entire
27830 recipient address against a list of recipients.
27831
27832 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27833 .cindex "&%regex%& ACL condition"
27834 .cindex "&ACL;" "testing by regex matching"
27835 This condition is available only when Exim is compiled with the
27836 content-scanning extension, and is available only in the DATA, MIME, and
27837 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27838 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27839
27840 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27841 .cindex "&%sender_domains%& ACL condition"
27842 .cindex "sender" "ACL checking"
27843 .cindex "&ACL;" "testing a sender domain"
27844 .vindex "&$domain$&"
27845 .vindex "&$sender_address_domain$&"
27846 This condition tests the domain of the sender of the message against the given
27847 domain list. &*Note*&: The domain of the sender address is in
27848 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27849 of this condition. This is an exception to the general rule for testing domain
27850 lists. It is done this way so that, if this condition is used in an ACL for a
27851 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27852 influence the sender checking.
27853
27854 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27855 relaying, because sender addresses are easily, and commonly, forged.
27856
27857 .vitem &*senders&~=&~*&<&'address&~list'&>
27858 .cindex "&%senders%& ACL condition"
27859 .cindex "sender" "ACL checking"
27860 .cindex "&ACL;" "testing a sender"
27861 This condition tests the sender of the message against the given list. To test
27862 for a bounce message, which has an empty sender, set
27863 .code
27864 senders = :
27865 .endd
27866 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27867 relaying, because sender addresses are easily, and commonly, forged.
27868
27869 .vitem &*spam&~=&~*&<&'username'&>
27870 .cindex "&%spam%& ACL condition"
27871 .cindex "&ACL;" "scanning for spam"
27872 This condition is available only when Exim is compiled with the
27873 content-scanning extension. It causes the incoming message to be scanned by
27874 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27875
27876 .vitem &*verify&~=&~certificate*&
27877 .cindex "&%verify%& ACL condition"
27878 .cindex "TLS" "client certificate verification"
27879 .cindex "certificate" "verification of client"
27880 .cindex "&ACL;" "certificate verification"
27881 .cindex "&ACL;" "testing a TLS certificate"
27882 This condition is true in an SMTP session if the session is encrypted, and a
27883 certificate was received from the client, and the certificate was verified. The
27884 server requests a certificate only if the client matches &%tls_verify_hosts%&
27885 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27886
27887 .vitem &*verify&~=&~csa*&
27888 .cindex "CSA verification"
27889 This condition checks whether the sending host (the client) is authorized to
27890 send email. Details of how this works are given in section
27891 &<<SECTverifyCSA>>&.
27892
27893 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27894 .cindex "&%verify%& ACL condition"
27895 .cindex "&ACL;" "verifying sender in the header"
27896 .cindex "header lines" "verifying the sender in"
27897 .cindex "sender" "verifying in header"
27898 .cindex "verifying" "sender in header"
27899 This condition is relevant only in an ACL that is run after a message has been
27900 received, that is, in an ACL specified by &%acl_smtp_data%& or
27901 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27902 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27903 is loosely thought of as a &"sender"& address (hence the name of the test).
27904 However, an address that appears in one of these headers need not be an address
27905 that accepts bounce messages; only sender addresses in envelopes are required
27906 to accept bounces. Therefore, if you use the callout option on this check, you
27907 might want to arrange for a non-empty address in the MAIL command.
27908
27909 Details of address verification and the options are given later, starting at
27910 section &<<SECTaddressverification>>& (callouts are described in section
27911 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27912 condition to restrict it to bounce messages only:
27913 .code
27914 deny    senders = :
27915         message = A valid sender header is required for bounces
27916        !verify  = header_sender
27917 .endd
27918
27919 .vitem &*verify&~=&~header_syntax*&
27920 .cindex "&%verify%& ACL condition"
27921 .cindex "&ACL;" "verifying header syntax"
27922 .cindex "header lines" "verifying syntax"
27923 .cindex "verifying" "header syntax"
27924 This condition is relevant only in an ACL that is run after a message has been
27925 received, that is, in an ACL specified by &%acl_smtp_data%& or
27926 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27927 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27928 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27929 permitted only in locally generated messages and from hosts that match
27930 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27931 appropriate.
27932
27933 Note that this condition is a syntax check only. However, a common spamming
27934 ploy used to be to send syntactically invalid headers such as
27935 .code
27936 To: @
27937 .endd
27938 and this condition can be used to reject such messages, though they are not as
27939 common as they used to be.
27940
27941 .vitem &*verify&~=&~helo*&
27942 .cindex "&%verify%& ACL condition"
27943 .cindex "&ACL;" "verifying HELO/EHLO"
27944 .cindex "HELO" "verifying"
27945 .cindex "EHLO" "verifying"
27946 .cindex "verifying" "EHLO"
27947 .cindex "verifying" "HELO"
27948 This condition is true if a HELO or EHLO command has been received from the
27949 client host, and its contents have been verified. If there has been no previous
27950 attempt to verify the HELO/EHLO contents, it is carried out when this
27951 condition is encountered. See the description of the &%helo_verify_hosts%& and
27952 &%helo_try_verify_hosts%& options for details of how to request verification
27953 independently of this condition.
27954
27955 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27956 option), this condition is always true.
27957
27958
27959 .vitem &*verify&~=&~not_blind*&
27960 .cindex "verifying" "not blind"
27961 .cindex "bcc recipients, verifying none"
27962 This condition checks that there are no blind (bcc) recipients in the message.
27963 Every envelope recipient must appear either in a &'To:'& header line or in a
27964 &'Cc:'& header line for this condition to be true. Local parts are checked
27965 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27966 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27967 used only in a DATA or non-SMTP ACL.
27968
27969 There are, of course, many legitimate messages that make use of blind (bcc)
27970 recipients. This check should not be used on its own for blocking messages.
27971
27972
27973 .vitem &*verify&~=&~recipient/*&<&'options'&>
27974 .cindex "&%verify%& ACL condition"
27975 .cindex "&ACL;" "verifying recipient"
27976 .cindex "recipient" "verifying"
27977 .cindex "verifying" "recipient"
27978 .vindex "&$address_data$&"
27979 This condition is relevant only after a RCPT command. It verifies the current
27980 recipient. Details of address verification are given later, starting at section
27981 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27982 of &$address_data$& is the last value that was set while routing the address.
27983 This applies even if the verification fails. When an address that is being
27984 verified is redirected to a single address, verification continues with the new
27985 address, and in that case, the subsequent value of &$address_data$& is the
27986 value for the child address.
27987
27988 .vitem &*verify&~=&~reverse_host_lookup*&
27989 .cindex "&%verify%& ACL condition"
27990 .cindex "&ACL;" "verifying host reverse lookup"
27991 .cindex "host" "verifying reverse lookup"
27992 This condition ensures that a verified host name has been looked up from the IP
27993 address of the client host. (This may have happened already if the host name
27994 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27995 Verification ensures that the host name obtained from a reverse DNS lookup, or
27996 one of its aliases, does, when it is itself looked up in the DNS, yield the
27997 original IP address.
27998
27999 If this condition is used for a locally generated message (that is, when there
28000 is no client host involved), it always succeeds.
28001
28002 .vitem &*verify&~=&~sender/*&<&'options'&>
28003 .cindex "&%verify%& ACL condition"
28004 .cindex "&ACL;" "verifying sender"
28005 .cindex "sender" "verifying"
28006 .cindex "verifying" "sender"
28007 This condition is relevant only after a MAIL or RCPT command, or after a
28008 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28009 the message's sender is empty (that is, this is a bounce message), the
28010 condition is true. Otherwise, the sender address is verified.
28011
28012 .vindex "&$address_data$&"
28013 .vindex "&$sender_address_data$&"
28014 If there is data in the &$address_data$& variable at the end of routing, its
28015 value is placed in &$sender_address_data$& at the end of verification. This
28016 value can be used in subsequent conditions and modifiers in the same ACL
28017 statement. It does not persist after the end of the current statement. If you
28018 want to preserve the value for longer, you can save it in an ACL variable.
28019
28020 Details of verification are given later, starting at section
28021 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28022 to avoid doing it more than once per message.
28023
28024 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28025 .cindex "&%verify%& ACL condition"
28026 This is a variation of the previous option, in which a modified address is
28027 verified as a sender.
28028 .endlist
28029
28030
28031
28032 .section "Using DNS lists" "SECTmorednslists"
28033 .cindex "DNS list" "in ACL"
28034 .cindex "black list (DNS)"
28035 .cindex "&ACL;" "testing a DNS list"
28036 In its simplest form, the &%dnslists%& condition tests whether the calling host
28037 is on at least one of a number of DNS lists by looking up the inverted IP
28038 address in one or more DNS domains. (Note that DNS list domains are not mail
28039 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28040 special options instead.) For example, if the calling host's IP
28041 address is 192.168.62.43, and the ACL statement is
28042 .code
28043 deny dnslists = blackholes.mail-abuse.org : \
28044                 dialups.mail-abuse.org
28045 .endd
28046 the following records are looked up:
28047 .code
28048 43.62.168.192.blackholes.mail-abuse.org
28049 43.62.168.192.dialups.mail-abuse.org
28050 .endd
28051 As soon as Exim finds an existing DNS record, processing of the list stops.
28052 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28053 to test that a host is on more than one list (an &"and"& conjunction), you can
28054 use two separate conditions:
28055 .code
28056 deny dnslists = blackholes.mail-abuse.org
28057      dnslists = dialups.mail-abuse.org
28058 .endd
28059 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28060 behaves as if the host does not match the list item, that is, as if the DNS
28061 record does not exist. If there are further items in the DNS list, they are
28062 processed.
28063
28064 This is usually the required action when &%dnslists%& is used with &%deny%&
28065 (which is the most common usage), because it prevents a DNS failure from
28066 blocking mail. However, you can change this behaviour by putting one of the
28067 following special items in the list:
28068 .display
28069 &`+include_unknown `&   behave as if the item is on the list
28070 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28071 &`+defer_unknown   `&   give a temporary error
28072 .endd
28073 .cindex "&`+include_unknown`&"
28074 .cindex "&`+exclude_unknown`&"
28075 .cindex "&`+defer_unknown`&"
28076 Each of these applies to any subsequent items on the list. For example:
28077 .code
28078 deny dnslists = +defer_unknown : foo.bar.example
28079 .endd
28080 Testing the list of domains stops as soon as a match is found. If you want to
28081 warn for one list and block for another, you can use two different statements:
28082 .code
28083 deny  dnslists = blackholes.mail-abuse.org
28084 warn  message  = X-Warn: sending host is on dialups list
28085       dnslists = dialups.mail-abuse.org
28086 .endd
28087 DNS list lookups are cached by Exim for the duration of the SMTP session,
28088 so a lookup based on the IP address is done at most once for any incoming
28089 connection. Exim does not share information between multiple incoming
28090 connections (but your local name server cache should be active).
28091
28092
28093
28094 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28095 .cindex "DNS list" "keyed by explicit IP address"
28096 By default, the IP address that is used in a DNS list lookup is the IP address
28097 of the calling host. However, you can specify another IP address by listing it
28098 after the domain name, introduced by a slash. For example:
28099 .code
28100 deny dnslists = black.list.tld/192.168.1.2
28101 .endd
28102 This feature is not very helpful with explicit IP addresses; it is intended for
28103 use with IP addresses that are looked up, for example, the IP addresses of the
28104 MX hosts or nameservers of an email sender address. For an example, see section
28105 &<<SECTmulkeyfor>>& below.
28106
28107
28108
28109
28110 .section "DNS lists keyed on domain names" "SECID202"
28111 .cindex "DNS list" "keyed by domain name"
28112 There are some lists that are keyed on domain names rather than inverted IP
28113 addresses (see for example the &'domain based zones'& link at
28114 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28115 with these lists. You can change the name that is looked up in a DNS list by
28116 listing it after the domain name, introduced by a slash. For example,
28117 .code
28118 deny  message  = Sender's domain is listed at $dnslist_domain
28119       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28120 .endd
28121 This particular example is useful only in ACLs that are obeyed after the
28122 RCPT or DATA commands, when a sender address is available. If (for
28123 example) the message's sender is &'user@tld.example'& the name that is looked
28124 up by this example is
28125 .code
28126 tld.example.dsn.rfc-ignorant.org
28127 .endd
28128 A single &%dnslists%& condition can contain entries for both names and IP
28129 addresses. For example:
28130 .code
28131 deny dnslists = sbl.spamhaus.org : \
28132                 dsn.rfc-ignorant.org/$sender_address_domain
28133 .endd
28134 The first item checks the sending host's IP address; the second checks a domain
28135 name. The whole condition is true if either of the DNS lookups succeeds.
28136
28137
28138
28139
28140 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28141 .cindex "DNS list" "multiple keys for"
28142 The syntax described above for looking up explicitly-defined values (either
28143 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28144 name for the DNS list, what follows the slash can in fact be a list of items.
28145 As with all lists in Exim, the default separator is a colon. However, because
28146 this is a sublist within the list of DNS blacklist domains, it is necessary
28147 either to double the separators like this:
28148 .code
28149 dnslists = black.list.tld/name.1::name.2
28150 .endd
28151 or to change the separator character, like this:
28152 .code
28153 dnslists = black.list.tld/<;name.1;name.2
28154 .endd
28155 If an item in the list is an IP address, it is inverted before the DNS
28156 blacklist domain is appended. If it is not an IP address, no inversion
28157 occurs. Consider this condition:
28158 .code
28159 dnslists = black.list.tld/<;192.168.1.2;a.domain
28160 .endd
28161 The DNS lookups that occur are:
28162 .code
28163 2.1.168.192.black.list.tld
28164 a.domain.black.list.tld
28165 .endd
28166 Once a DNS record has been found (that matches a specific IP return
28167 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28168 are done. If there is a temporary DNS error, the rest of the sublist of domains
28169 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28170 only if no other DNS lookup in this sublist succeeds. In other words, a
28171 successful lookup for any of the items in the sublist overrides a temporary
28172 error for a previous item.
28173
28174 The ability to supply a list of items after the slash is in some sense just a
28175 syntactic convenience. These two examples have the same effect:
28176 .code
28177 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28178 dnslists = black.list.tld/a.domain::b.domain
28179 .endd
28180 However, when the data for the list is obtained from a lookup, the second form
28181 is usually much more convenient. Consider this example:
28182 .code
28183 deny message  = The mail servers for the domain \
28184                 $sender_address_domain \
28185                 are listed at $dnslist_domain ($dnslist_value); \
28186                 see $dnslist_text.
28187      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28188                                    ${lookup dnsdb {>|mxh=\
28189                                    $sender_address_domain} }} }
28190 .endd
28191 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28192 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28193 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28194 of expanding the condition might be something like this:
28195 .code
28196 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28197 .endd
28198 Thus, this example checks whether or not the IP addresses of the sender
28199 domain's mail servers are on the Spamhaus black list.
28200
28201 The key that was used for a successful DNS list lookup is put into the variable
28202 &$dnslist_matched$& (see section &<<SECID204>>&).
28203
28204
28205
28206
28207 .section "Data returned by DNS lists" "SECID203"
28208 .cindex "DNS list" "data returned from"
28209 DNS lists are constructed using address records in the DNS. The original RBL
28210 just used the address 127.0.0.1 on the right hand side of each record, but the
28211 RBL+ list and some other lists use a number of values with different meanings.
28212 The values used on the RBL+ list are:
28213 .display
28214 127.1.0.1  RBL
28215 127.1.0.2  DUL
28216 127.1.0.3  DUL and RBL
28217 127.1.0.4  RSS
28218 127.1.0.5  RSS and RBL
28219 127.1.0.6  RSS and DUL
28220 127.1.0.7  RSS and DUL and RBL
28221 .endd
28222 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28223 different values. Some DNS lists may return more than one address record;
28224 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28225
28226
28227 .section "Variables set from DNS lists" "SECID204"
28228 .cindex "expansion" "variables, set from DNS list"
28229 .cindex "DNS list" "variables set from"
28230 .vindex "&$dnslist_domain$&"
28231 .vindex "&$dnslist_matched$&"
28232 .vindex "&$dnslist_text$&"
28233 .vindex "&$dnslist_value$&"
28234 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28235 the name of the overall domain that matched (for example,
28236 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28237 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28238 the DNS record. When the key is an IP address, it is not reversed in
28239 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28240 cases, for example:
28241 .code
28242 deny dnslists = spamhaus.example
28243 .endd
28244 the key is also available in another variable (in this case,
28245 &$sender_host_address$&). In more complicated cases, however, this is not true.
28246 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28247 might generate a dnslists lookup like this:
28248 .code
28249 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28250 .endd
28251 If this condition succeeds, the value in &$dnslist_matched$& might be
28252 &`192.168.6.7`& (for example).
28253
28254 If more than one address record is returned by the DNS lookup, all the IP
28255 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28256 The variable &$dnslist_text$& contains the contents of any associated TXT
28257 record. For lists such as RBL+ the TXT record for a merged entry is often not
28258 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28259 information.
28260
28261 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28262 &-- although these appear before the condition in the ACL, they are not
28263 expanded until after it has failed. For example:
28264 .code
28265 deny    hosts = !+local_networks
28266         message = $sender_host_address is listed \
28267                   at $dnslist_domain
28268         dnslists = rbl-plus.mail-abuse.example
28269 .endd
28270
28271
28272
28273 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28274 .cindex "DNS list" "matching specific returned data"
28275 You can add an equals sign and an IP address after a &%dnslists%& domain name
28276 in order to restrict its action to DNS records with a matching right hand side.
28277 For example,
28278 .code
28279 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28280 .endd
28281 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28282 any address record is considered to be a match. For the moment, we assume
28283 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28284 describes how multiple records are handled.
28285
28286 More than one IP address may be given for checking, using a comma as a
28287 separator. These are alternatives &-- if any one of them matches, the
28288 &%dnslists%& condition is true. For example:
28289 .code
28290 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28291 .endd
28292 If you want to specify a constraining address list and also specify names or IP
28293 addresses to be looked up, the constraining address list must be specified
28294 first. For example:
28295 .code
28296 deny dnslists = dsn.rfc-ignorant.org\
28297                 =127.0.0.2/$sender_address_domain
28298 .endd
28299
28300 If the character &`&&`& is used instead of &`=`&, the comparison for each
28301 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28302 In other words, the listed addresses are used as bit masks. The comparison is
28303 true if all the bits in the mask are present in the address that is being
28304 tested. For example:
28305 .code
28306 dnslists = a.b.c&0.0.0.3
28307 .endd
28308 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
28309 want to test whether one bit or another bit is present (as opposed to both
28310 being present), you must use multiple values. For example:
28311 .code
28312 dnslists = a.b.c&0.0.0.1,0.0.0.2
28313 .endd
28314 matches if the final component of the address is an odd number or two times
28315 an odd number.
28316
28317
28318
28319 .section "Negated DNS matching conditions" "SECID205"
28320 You can supply a negative list of IP addresses as part of a &%dnslists%&
28321 condition. Whereas
28322 .code
28323 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28324 .endd
28325 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28326 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
28327 .code
28328 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28329 .endd
28330 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28331 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28332 words, the result of the test is inverted if an exclamation mark appears before
28333 the &`=`& (or the &`&&`&) sign.
28334
28335 &*Note*&: This kind of negation is not the same as negation in a domain,
28336 host, or address list (which is why the syntax is different).
28337
28338 If you are using just one list, the negation syntax does not gain you much. The
28339 previous example is precisely equivalent to
28340 .code
28341 deny  dnslists = a.b.c
28342      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28343 .endd
28344 However, if you are using multiple lists, the negation syntax is clearer.
28345 Consider this example:
28346 .code
28347 deny  dnslists = sbl.spamhaus.org : \
28348                  list.dsbl.org : \
28349                  dnsbl.njabl.org!=127.0.0.3 : \
28350                  relays.ordb.org
28351 .endd
28352 Using only positive lists, this would have to be:
28353 .code
28354 deny  dnslists = sbl.spamhaus.org : \
28355                  list.dsbl.org
28356 deny  dnslists = dnsbl.njabl.org
28357      !dnslists = dnsbl.njabl.org=127.0.0.3
28358 deny  dnslists = relays.ordb.org
28359 .endd
28360 which is less clear, and harder to maintain.
28361
28362
28363
28364
28365 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28366 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28367 thereby providing more than one IP address. When an item in a &%dnslists%& list
28368 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28369 the match to specific results from the DNS lookup, there are two ways in which
28370 the checking can be handled. For example, consider the condition:
28371 .code
28372 dnslists = a.b.c=127.0.0.1
28373 .endd
28374 What happens if the DNS lookup for the incoming IP address yields both
28375 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28376 condition true because at least one given value was found, or is it false
28377 because at least one of the found values was not listed? And how does this
28378 affect negated conditions? Both possibilities are provided for with the help of
28379 additional separators &`==`& and &`=&&`&.
28380
28381 .ilist
28382 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
28383 IP addresses matches one of the listed addresses. For the example above, the
28384 condition is true because 127.0.0.1 matches.
28385 .next
28386 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
28387 looked up IP addresses matches one of the listed addresses. If the condition is
28388 changed to:
28389 .code
28390 dnslists = a.b.c==127.0.0.1
28391 .endd
28392 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28393 false because 127.0.0.2 is not listed. You would need to have:
28394 .code
28395 dnslists = a.b.c==127.0.0.1,127.0.0.2
28396 .endd
28397 for the condition to be true.
28398 .endlist
28399
28400 When &`!`& is used to negate IP address matching, it inverts the result, giving
28401 the precise opposite of the behaviour above. Thus:
28402 .ilist
28403 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
28404 addresses matches one of the listed addresses. Consider:
28405 .code
28406 dnslists = a.b.c!&0.0.0.1
28407 .endd
28408 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28409 false because 127.0.0.1 matches.
28410 .next
28411 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
28412 looked up IP address that does not match. Consider:
28413 .code
28414 dnslists = a.b.c!=&0.0.0.1
28415 .endd
28416 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28417 true, because 127.0.0.2 does not match. You would need to have:
28418 .code
28419 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
28420 .endd
28421 for the condition to be false.
28422 .endlist
28423 When the DNS lookup yields only a single IP address, there is no difference
28424 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
28425
28426
28427
28428
28429 .section "Detailed information from merged DNS lists" "SECTmordetinf"
28430 .cindex "DNS list" "information from merged"
28431 When the facility for restricting the matching IP values in a DNS list is used,
28432 the text from the TXT record that is set in &$dnslist_text$& may not reflect
28433 the true reason for rejection. This happens when lists are merged and the IP
28434 address in the A record is used to distinguish them; unfortunately there is
28435 only one TXT record. One way round this is not to use merged lists, but that
28436 can be inefficient because it requires multiple DNS lookups where one would do
28437 in the vast majority of cases when the host of interest is not on any of the
28438 lists.
28439
28440 A less inefficient way of solving this problem is available. If
28441 two domain names, comma-separated, are given, the second is used first to
28442 do an initial check, making use of any IP value restrictions that are set.
28443 If there is a match, the first domain is used, without any IP value
28444 restrictions, to get the TXT record. As a byproduct of this, there is also
28445 a check that the IP being tested is indeed on the first list. The first
28446 domain is the one that is put in &$dnslist_domain$&. For example:
28447 .code
28448 reject message  = \
28449          rejected because $sender_host_address is blacklisted \
28450          at $dnslist_domain\n$dnslist_text
28451        dnslists = \
28452          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
28453          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28454 .endd
28455 For the first blacklist item, this starts by doing a lookup in
28456 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
28457 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
28458 value, and as long as something is found, it looks for the corresponding TXT
28459 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
28460 The second blacklist item is processed similarly.
28461
28462 If you are interested in more than one merged list, the same list must be
28463 given several times, but because the results of the DNS lookups are cached,
28464 the DNS calls themselves are not repeated. For example:
28465 .code
28466 reject dnslists = \
28467          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
28468          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
28469          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
28470          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28471 .endd
28472 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
28473 values matches (or if no record is found), this is the only lookup that is
28474 done. Only if there is a match is one of the more specific lists consulted.
28475
28476
28477
28478 .section "DNS lists and IPv6" "SECTmorednslistslast"
28479 .cindex "IPv6" "DNS black lists"
28480 .cindex "DNS list" "IPv6 usage"
28481 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
28482 nibble by nibble. For example, if the calling host's IP address is
28483 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
28484 .code
28485 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
28486   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
28487 .endd
28488 (split over two lines here to fit on the page). Unfortunately, some of the DNS
28489 lists contain wildcard records, intended for IPv4, that interact badly with
28490 IPv6. For example, the DNS entry
28491 .code
28492 *.3.some.list.example.    A    127.0.0.1
28493 .endd
28494 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
28495 Unfortunately, it also matches the entire 3::/4 IPv6 network.
28496
28497 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
28498 &%condition%& condition, as in this example:
28499 .code
28500 deny   condition = ${if isip4{$sender_host_address}}
28501        dnslists  = some.list.example
28502 .endd
28503
28504 .section "Rate limiting incoming messages" "SECTratelimiting"
28505 .cindex "rate limiting" "client sending"
28506 .cindex "limiting client sending rates"
28507 .oindex "&%smtp_ratelimit_*%&"
28508 The &%ratelimit%& ACL condition can be used to measure and control the rate at
28509 which clients can send email. This is more powerful than the
28510 &%smtp_ratelimit_*%& options, because those options control the rate of
28511 commands in a single SMTP session only, whereas the &%ratelimit%& condition
28512 works across all connections (concurrent and sequential) from the same client
28513 host. The syntax of the &%ratelimit%& condition is:
28514 .display
28515 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
28516 .endd
28517 If the average client sending rate is less than &'m'& messages per time
28518 period &'p'& then the condition is false; otherwise it is true.
28519
28520 As a side-effect, the &%ratelimit%& condition sets the expansion variable
28521 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
28522 configured value of &'m'&, and &$sender_rate_period$& to the configured value
28523 of &'p'&.
28524
28525 The parameter &'p'& is the smoothing time constant, in the form of an Exim
28526 time interval, for example, &`8h`& for eight hours. A larger time constant
28527 means that it takes Exim longer to forget a client's past behaviour. The
28528 parameter &'m'& is the maximum number of messages that a client is permitted to
28529 send in each time interval. It also specifies the number of messages permitted
28530 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
28531 constant, you can allow a client to send more messages in a burst without
28532 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
28533 both small, messages must be sent at an even rate.
28534
28535 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
28536 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
28537 when deploying the &%ratelimit%& ACL condition. The script prints usage
28538 instructions when it is run with no arguments.
28539
28540 The key is used to look up the data for calculating the client's average
28541 sending rate. This data is stored in Exim's spool directory, alongside the
28542 retry and other hints databases. The default key is &$sender_host_address$&,
28543 which means Exim computes the sending rate of each client host IP address.
28544 By changing the key you can change how Exim identifies clients for the purpose
28545 of ratelimiting. For example, to limit the sending rate of each authenticated
28546 user, independent of the computer they are sending from, set the key to
28547 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
28548 example, &$authenticated_id$& is only meaningful if the client has
28549 authenticated (which you can check with the &%authenticated%& ACL condition).
28550
28551 The lookup key does not have to identify clients: If you want to limit the
28552 rate at which a recipient receives messages, you can use the key
28553 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
28554 ACL.
28555
28556 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
28557 specifies what Exim measures the rate of, for example messages or recipients
28558 or bytes. You can adjust the measurement using the &%unique=%& and/or
28559 &%count=%& options. You can also control when Exim updates the recorded rate
28560 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
28561 separated by a slash, like the other parameters. They may appear in any order.
28562
28563 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
28564 any options that alter the meaning of the stored data. The limit &'m'& is not
28565 stored, so you can alter the configured maximum rate and Exim will still
28566 remember clients' past behaviour. If you change the &%per_*%& mode or add or
28567 remove the &%unique=%& option, the lookup key changes so Exim will forget past
28568 behaviour. The lookup key is not affected by changes to the update mode and
28569 the &%count=%& option.
28570
28571
28572 .section "Ratelimit options for what is being measured" "ratoptmea"
28573 .cindex "rate limiting" "per_* options"
28574 The &%per_conn%& option limits the client's connection rate. It is not
28575 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
28576 &%acl_not_smtp_start%& ACLs.
28577
28578 The &%per_mail%& option limits the client's rate of sending messages. This is
28579 the default if none of the &%per_*%& options is specified. It can be used in
28580 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
28581 &%acl_smtp_data%&, or &%acl_not_smtp%&.
28582
28583 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
28584 the same ACLs as the &%per_mail%& option, though it is best to use this option
28585 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
28586 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
28587 in its MAIL command, which may be inaccurate or completely missing. You can
28588 follow the limit &'m'& in the configuration with K, M, or G to specify limits
28589 in kilobytes, megabytes, or gigabytes, respectively.
28590
28591 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
28592 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28593 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
28594 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
28595 ACLs the rate is updated with the total recipient count in one go. Note that
28596 in either case the rate limiting engine will see a message with many
28597 recipients as a large high-speed burst.
28598
28599 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
28600 number of different recipients that the client has sent messages to in the
28601 last time period. That is, if the client repeatedly sends messages to the same
28602 recipient, its measured rate is not increased. This option can only be used in
28603 &%acl_smtp_rcpt%&.
28604
28605 The &%per_cmd%& option causes Exim to recompute the rate every time the
28606 condition is processed. This can be used to limit the rate of any SMTP
28607 command. If it is used in multiple ACLs it can limit the aggregate rate of
28608 multiple different commands.
28609
28610 The &%count=%& option can be used to alter how much Exim adds to the client's
28611 measured rate. For example, the &%per_byte%& option is equivalent to
28612 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
28613 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
28614 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
28615
28616 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
28617
28618
28619 .section "Ratelimit update modes" "ratoptupd"
28620 .cindex "rate limiting" "reading data without updating"
28621 You can specify one of three options with the &%ratelimit%& condition to
28622 control when its database is updated. This section describes the &%readonly%&
28623 mode, and the next section describes the &%strict%& and &%leaky%& modes.
28624
28625 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
28626 previously-computed rate to check against the limit.
28627
28628 For example, you can test the client's sending rate and deny it access (when
28629 it is too fast) in the connect ACL. If the client passes this check then it
28630 can go on to send a message, in which case its recorded rate will be updated
28631 in the MAIL ACL. Subsequent connections from the same client will check this
28632 new rate.
28633 .code
28634 acl_check_connect:
28635  deny ratelimit = 100 / 5m / readonly
28636     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
28637                   (max $sender_rate_limit)
28638 # ...
28639 acl_check_mail:
28640  warn ratelimit = 100 / 5m / strict
28641     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
28642                   (max $sender_rate_limit)
28643 .endd
28644
28645 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28646 processing a message then it may increase the client's measured rate more than
28647 it should. For example, this will happen if you check the &%per_rcpt%& option
28648 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28649 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28650 multiple update problems by using the &%readonly%& option on later ratelimit
28651 checks.
28652
28653 The &%per_*%& options described above do not make sense in some ACLs. If you
28654 use a &%per_*%& option in an ACL where it is not normally permitted then the
28655 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28656 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28657 next section) so you must specify the &%readonly%& option explicitly.
28658
28659
28660 .section "Ratelimit options for handling fast clients" "ratoptfast"
28661 .cindex "rate limiting" "strict and leaky modes"
28662 If a client's average rate is greater than the maximum, the rate limiting
28663 engine can react in two possible ways, depending on the presence of the
28664 &%strict%& or &%leaky%& update modes. This is independent of the other
28665 counter-measures (such as rejecting the message) that may be specified by the
28666 rest of the ACL.
28667
28668 The &%leaky%& (default) option means that the client's recorded rate is not
28669 updated if it is above the limit. The effect of this is that Exim measures the
28670 client's average rate of successfully sent email, which cannot be greater than
28671 the maximum allowed. If the client is over the limit it may suffer some
28672 counter-measures (as specified in the ACL), but it will still be able to send
28673 email at the configured maximum rate, whatever the rate of its attempts. This
28674 is generally the better choice if you have clients that retry automatically.
28675 For example, it does not prevent a sender with an over-aggressive retry rate
28676 from getting any email through.
28677
28678 The &%strict%& option means that the client's recorded rate is always
28679 updated. The effect of this is that Exim measures the client's average rate
28680 of attempts to send email, which can be much higher than the maximum it is
28681 actually allowed. If the client is over the limit it may be subjected to
28682 counter-measures by the ACL. It must slow down and allow sufficient time to
28683 pass that its computed rate falls below the maximum before it can send email
28684 again. The time (the number of smoothing periods) it must wait and not
28685 attempt to send mail can be calculated with this formula:
28686 .code
28687         ln(peakrate/maxrate)
28688 .endd
28689
28690
28691 .section "Limiting the rate of different events" "ratoptuniq"
28692 .cindex "rate limiting" "counting unique events"
28693 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28694 rate of different events. For example, the &%per_addr%& option uses this
28695 mechanism to count the number of different recipients that the client has
28696 sent messages to in the last time period; it is equivalent to
28697 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28698 measure the rate that a client uses different sender addresses with the
28699 options &`per_mail/unique=$sender_address`&.
28700
28701 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28702 has seen for that key. The whole set is thrown away when it is older than the
28703 rate smoothing period &'p'&, so each different event is counted at most once
28704 per period. In the &%leaky%& update mode, an event that causes the client to
28705 go over the limit is not added to the set, in the same way that the client's
28706 recorded rate is not updated in the same situation.
28707
28708 When you combine the &%unique=%& and &%readonly%& options, the specific
28709 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28710 rate.
28711
28712 The &%unique=%& mechanism needs more space in the ratelimit database than the
28713 other &%ratelimit%& options in order to store the event set. The number of
28714 unique values is potentially as large as the rate limit, so the extra space
28715 required increases with larger limits.
28716
28717 The uniqueification is not perfect: there is a small probability that Exim
28718 will think a new event has happened before. If the sender's rate is less than
28719 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28720 the measured rate can go above the limit, in which case Exim may under-count
28721 events by a significant margin. Fortunately, if the rate is high enough (2.7
28722 times the limit) that the false positive rate goes above 9%, then Exim will
28723 throw away the over-full event set before the measured rate falls below the
28724 limit. Therefore the only harm should be that exceptionally high sending rates
28725 are logged incorrectly; any countermeasures you configure will be as effective
28726 as intended.
28727
28728
28729 .section "Using rate limiting" "useratlim"
28730 Exim's other ACL facilities are used to define what counter-measures are taken
28731 when the rate limit is exceeded. This might be anything from logging a warning
28732 (for example, while measuring existing sending rates in order to define
28733 policy), through time delays to slow down fast senders, up to rejecting the
28734 message. For example:
28735 .code
28736 # Log all senders' rates
28737 warn ratelimit = 0 / 1h / strict
28738      log_message = Sender rate $sender_rate / $sender_rate_period
28739
28740 # Slow down fast senders; note the need to truncate $sender_rate
28741 # at the decimal point.
28742 warn ratelimit = 100 / 1h / per_rcpt / strict
28743      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28744                    $sender_rate_limit }s
28745
28746 # Keep authenticated users under control
28747 deny authenticated = *
28748      ratelimit = 100 / 1d / strict / $authenticated_id
28749
28750 # System-wide rate limit
28751 defer message = Sorry, too busy. Try again later.
28752      ratelimit = 10 / 1s / $primary_hostname
28753
28754 # Restrict incoming rate from each host, with a default
28755 # set using a macro and special cases looked up in a table.
28756 defer message = Sender rate exceeds $sender_rate_limit \
28757                messages per $sender_rate_period
28758      ratelimit = ${lookup {$sender_host_address} \
28759                    cdb {DB/ratelimits.cdb} \
28760                    {$value} {RATELIMIT} }
28761 .endd
28762 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28763 especially with the &%per_rcpt%& option, you may suffer from a performance
28764 bottleneck caused by locking on the ratelimit hints database. Apart from
28765 making your ACLs less complicated, you can reduce the problem by using a
28766 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28767 this means that Exim will lose its hints data after a reboot (including retry
28768 hints, the callout cache, and ratelimit data).
28769
28770
28771
28772 .section "Address verification" "SECTaddressverification"
28773 .cindex "verifying address" "options for"
28774 .cindex "policy control" "address verification"
28775 Several of the &%verify%& conditions described in section
28776 &<<SECTaclconditions>>& cause addresses to be verified. Section
28777 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28778 The verification conditions can be followed by options that modify the
28779 verification process. The options are separated from the keyword and from each
28780 other by slashes, and some of them contain parameters. For example:
28781 .code
28782 verify = sender/callout
28783 verify = recipient/defer_ok/callout=10s,defer_ok
28784 .endd
28785 The first stage of address verification, which always happens, is to run the
28786 address through the routers, in &"verify mode"&. Routers can detect the
28787 difference between verification and routing for delivery, and their actions can
28788 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28789 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28790 The available options are as follows:
28791
28792 .ilist
28793 If the &%callout%& option is specified, successful routing to one or more
28794 remote hosts is followed by a &"callout"& to those hosts as an additional
28795 check. Callouts and their sub-options are discussed in the next section.
28796 .next
28797 If there is a defer error while doing verification routing, the ACL
28798 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28799 options, the condition is forced to be true instead. Note that this is a main
28800 verification option as well as a suboption for callouts.
28801 .next
28802 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28803 discusses the reporting of sender address verification failures.
28804 .next
28805 The &%success_on_redirect%& option causes verification always to succeed
28806 immediately after a successful redirection. By default, if a redirection
28807 generates just one address, that address is also verified. See further
28808 discussion in section &<<SECTredirwhilveri>>&.
28809 .endlist
28810
28811 .cindex "verifying address" "differentiating failures"
28812 .vindex "&$recipient_verify_failure$&"
28813 .vindex "&$sender_verify_failure$&"
28814 .vindex "&$acl_verify_message$&"
28815 After an address verification failure, &$acl_verify_message$& contains the
28816 error message that is associated with the failure. It can be preserved by
28817 coding like this:
28818 .code
28819 warn  !verify = sender
28820        set acl_m0 = $acl_verify_message
28821 .endd
28822 If you are writing your own custom rejection message or log message when
28823 denying access, you can use this variable to include information about the
28824 verification failure.
28825
28826 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28827 appropriate) contains one of the following words:
28828
28829 .ilist
28830 &%qualify%&: The address was unqualified (no domain), and the message
28831 was neither local nor came from an exempted host.
28832 .next
28833 &%route%&: Routing failed.
28834 .next
28835 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28836 occurred at or before the MAIL command (that is, on initial
28837 connection, HELO, or MAIL).
28838 .next
28839 &%recipient%&: The RCPT command in a callout was rejected.
28840 .next
28841 &%postmaster%&: The postmaster check in a callout was rejected.
28842 .endlist
28843
28844 The main use of these variables is expected to be to distinguish between
28845 rejections of MAIL and rejections of RCPT in callouts.
28846
28847
28848
28849
28850 .section "Callout verification" "SECTcallver"
28851 .cindex "verifying address" "by callout"
28852 .cindex "callout" "verification"
28853 .cindex "SMTP" "callout verification"
28854 For non-local addresses, routing verifies the domain, but is unable to do any
28855 checking of the local part. There are situations where some means of verifying
28856 the local part is desirable. One way this can be done is to make an SMTP
28857 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28858 a subsequent host for a recipient address, to see if the host accepts the
28859 address. We use the term &'callout'& to cover both cases. Note that for a
28860 sender address, the callback is not to the client host that is trying to
28861 deliver the message, but to one of the hosts that accepts incoming mail for the
28862 sender's domain.
28863
28864 Exim does not do callouts by default. If you want them to happen, you must
28865 request them by setting appropriate options on the &%verify%& condition, as
28866 described below. This facility should be used with care, because it can add a
28867 lot of resource usage to the cost of verifying an address. However, Exim does
28868 cache the results of callouts, which helps to reduce the cost. Details of
28869 caching are in section &<<SECTcallvercache>>&.
28870
28871 Recipient callouts are usually used only between hosts that are controlled by
28872 the same administration. For example, a corporate gateway host could use
28873 callouts to check for valid recipients on an internal mailserver. A successful
28874 callout does not guarantee that a real delivery to the address would succeed;
28875 on the other hand, a failing callout does guarantee that a delivery would fail.
28876
28877 If the &%callout%& option is present on a condition that verifies an address, a
28878 second stage of verification occurs if the address is successfully routed to
28879 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28880 &(manualroute)& router, where the router specifies the hosts. However, if a
28881 router that does not set up hosts routes to an &(smtp)& transport with a
28882 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28883 &%hosts_override%& set, its hosts are always used, whether or not the router
28884 supplies a host list.
28885
28886 The port that is used is taken from the transport, if it is specified and is a
28887 remote transport. (For routers that do verification only, no transport need be
28888 specified.) Otherwise, the default SMTP port is used. If a remote transport
28889 specifies an outgoing interface, this is used; otherwise the interface is not
28890 specified. Likewise, the text that is used for the HELO command is taken from
28891 the transport's &%helo_data%& option; if there is no transport, the value of
28892 &$smtp_active_hostname$& is used.
28893
28894 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28895 test whether a bounce message could be delivered to the sender address. The
28896 following SMTP commands are sent:
28897 .display
28898 &`HELO `&<&'local host name'&>
28899 &`MAIL FROM:<>`&
28900 &`RCPT TO:`&<&'the address to be tested'&>
28901 &`QUIT`&
28902 .endd
28903 LHLO is used instead of HELO if the transport's &%protocol%& option is
28904 set to &"lmtp"&.
28905
28906 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
28907 settings.
28908
28909 A recipient callout check is similar. By default, it also uses an empty address
28910 for the sender. This default is chosen because most hosts do not make use of
28911 the sender address when verifying a recipient. Using the same address means
28912 that a single cache entry can be used for each recipient. Some sites, however,
28913 do make use of the sender address when verifying. These are catered for by the
28914 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28915
28916 If the response to the RCPT command is a 2&'xx'& code, the verification
28917 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28918 Exim tries the next host, if any. If there is a problem with all the remote
28919 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28920 &%callout%& option is given, in which case the condition is forced to succeed.
28921
28922 .cindex "SMTP" "output flushing, disabling for callout"
28923 A callout may take a little time. For this reason, Exim normally flushes SMTP
28924 output before performing a callout in an ACL, to avoid unexpected timeouts in
28925 clients when the SMTP PIPELINING extension is in use. The flushing can be
28926 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28927
28928
28929
28930
28931 .section "Additional parameters for callouts" "CALLaddparcall"
28932 .cindex "callout" "additional parameters for"
28933 The &%callout%& option can be followed by an equals sign and a number of
28934 optional parameters, separated by commas. For example:
28935 .code
28936 verify = recipient/callout=10s,defer_ok
28937 .endd
28938 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28939 separate verify options, is retained for backwards compatibility, but is now
28940 deprecated. The additional parameters for &%callout%& are as follows:
28941
28942
28943 .vlist
28944 .vitem <&'a&~time&~interval'&>
28945 .cindex "callout" "timeout, specifying"
28946 This specifies the timeout that applies for the callout attempt to each host.
28947 For example:
28948 .code
28949 verify = sender/callout=5s
28950 .endd
28951 The default is 30 seconds. The timeout is used for each response from the
28952 remote host. It is also used for the initial connection, unless overridden by
28953 the &%connect%& parameter.
28954
28955
28956 .vitem &*connect&~=&~*&<&'time&~interval'&>
28957 .cindex "callout" "connection timeout, specifying"
28958 This parameter makes it possible to set a different (usually smaller) timeout
28959 for making the SMTP connection. For example:
28960 .code
28961 verify = sender/callout=5s,connect=1s
28962 .endd
28963 If not specified, this timeout defaults to the general timeout value.
28964
28965 .vitem &*defer_ok*&
28966 .cindex "callout" "defer, action on"
28967 When this parameter is present, failure to contact any host, or any other kind
28968 of temporary error, is treated as success by the ACL. However, the cache is not
28969 updated in this circumstance.
28970
28971 .vitem &*fullpostmaster*&
28972 .cindex "callout" "full postmaster check"
28973 This operates like the &%postmaster%& option (see below), but if the check for
28974 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28975 accordance with the specification in RFC 2821. The RFC states that the
28976 unqualified address &'postmaster'& should be accepted.
28977
28978
28979 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28980 .cindex "callout" "sender when verifying header"
28981 When verifying addresses in header lines using the &%header_sender%&
28982 verification option, Exim behaves by default as if the addresses are envelope
28983 sender addresses from a message. Callout verification therefore tests to see
28984 whether a bounce message could be delivered, by using an empty address in the
28985 MAIL command. However, it is arguable that these addresses might never be used
28986 as envelope senders, and could therefore justifiably reject bounce messages
28987 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28988 address to use in the MAIL command. For example:
28989 .code
28990 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28991 .endd
28992 This parameter is available only for the &%header_sender%& verification option.
28993
28994
28995 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28996 .cindex "callout" "overall timeout, specifying"
28997 This parameter sets an overall timeout for performing a callout verification.
28998 For example:
28999 .code
29000 verify = sender/callout=5s,maxwait=30s
29001 .endd
29002 This timeout defaults to four times the callout timeout for individual SMTP
29003 commands. The overall timeout applies when there is more than one host that can
29004 be tried. The timeout is checked before trying the next host. This prevents
29005 very long delays if there are a large number of hosts and all are timing out
29006 (for example, when network connections are timing out).
29007
29008
29009 .vitem &*no_cache*&
29010 .cindex "callout" "cache, suppressing"
29011 .cindex "caching callout, suppressing"
29012 When this parameter is given, the callout cache is neither read nor updated.
29013
29014 .vitem &*postmaster*&
29015 .cindex "callout" "postmaster; checking"
29016 When this parameter is set, a successful callout check is followed by a similar
29017 check for the local part &'postmaster'& at the same domain. If this address is
29018 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29019 the postmaster check is recorded in a cache record; if it is a failure, this is
29020 used to fail subsequent callouts for the domain without a connection being
29021 made, until the cache record expires.
29022
29023 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29024 The postmaster check uses an empty sender in the MAIL command by default.
29025 You can use this parameter to do a postmaster check using a different address.
29026 For example:
29027 .code
29028 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29029 .endd
29030 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29031 one overrides. The &%postmaster%& parameter is equivalent to this example:
29032 .code
29033 require  verify = sender/callout=postmaster_mailfrom=
29034 .endd
29035 &*Warning*&: The caching arrangements for postmaster checking do not take
29036 account of the sender address. It is assumed that either the empty address or
29037 a fixed non-empty address will be used. All that Exim remembers is that the
29038 postmaster check for the domain succeeded or failed.
29039
29040
29041 .vitem &*random*&
29042 .cindex "callout" "&""random""& check"
29043 When this parameter is set, before doing the normal callout check, Exim does a
29044 check for a &"random"& local part at the same domain. The local part is not
29045 really random &-- it is defined by the expansion of the option
29046 &%callout_random_local_part%&, which defaults to
29047 .code
29048 $primary_hostname-$tod_epoch-testing
29049 .endd
29050 The idea here is to try to determine whether the remote host accepts all local
29051 parts without checking. If it does, there is no point in doing callouts for
29052 specific local parts. If the &"random"& check succeeds, the result is saved in
29053 a cache record, and used to force the current and subsequent callout checks to
29054 succeed without a connection being made, until the cache record expires.
29055
29056 .vitem &*use_postmaster*&
29057 .cindex "callout" "sender for recipient check"
29058 This parameter applies to recipient callouts only. For example:
29059 .code
29060 deny  !verify = recipient/callout=use_postmaster
29061 .endd
29062 .vindex "&$qualify_domain$&"
29063 It causes a non-empty postmaster address to be used in the MAIL command when
29064 performing the callout for the recipient, and also for a &"random"& check if
29065 that is configured. The local part of the address is &`postmaster`& and the
29066 domain is the contents of &$qualify_domain$&.
29067
29068 .vitem &*use_sender*&
29069 This option applies to recipient callouts only. For example:
29070 .code
29071 require  verify = recipient/callout=use_sender
29072 .endd
29073 It causes the message's actual sender address to be used in the MAIL
29074 command when performing the callout, instead of an empty address. There is no
29075 need to use this option unless you know that the called hosts make use of the
29076 sender when checking recipients. If used indiscriminately, it reduces the
29077 usefulness of callout caching.
29078 .endlist
29079
29080 If you use any of the parameters that set a non-empty sender for the MAIL
29081 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29082 &%use_sender%&), you should think about possible loops. Recipient checking is
29083 usually done between two hosts that are under the same management, and the host
29084 that receives the callouts is not normally configured to do callouts itself.
29085 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29086 these circumstances.
29087
29088 However, if you use a non-empty sender address for a callout to an arbitrary
29089 host, there is the likelihood that the remote host will itself initiate a
29090 callout check back to your host. As it is checking what appears to be a message
29091 sender, it is likely to use an empty address in MAIL, thus avoiding a
29092 callout loop. However, to be on the safe side it would be best to set up your
29093 own ACLs so that they do not do sender verification checks when the recipient
29094 is the address you use for header sender or postmaster callout checking.
29095
29096 Another issue to think about when using non-empty senders for callouts is
29097 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29098 by the sender/recipient combination; thus, for any given recipient, many more
29099 actual callouts are performed than when an empty sender or postmaster is used.
29100
29101
29102
29103
29104 .section "Callout caching" "SECTcallvercache"
29105 .cindex "hints database" "callout cache"
29106 .cindex "callout" "cache, description of"
29107 .cindex "caching" "callout"
29108 Exim caches the results of callouts in order to reduce the amount of resources
29109 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29110 option. A hints database called &"callout"& is used for the cache. Two
29111 different record types are used: one records the result of a callout check for
29112 a specific address, and the other records information that applies to the
29113 entire domain (for example, that it accepts the local part &'postmaster'&).
29114
29115 When an original callout fails, a detailed SMTP error message is given about
29116 the failure. However, for subsequent failures use the cache data, this message
29117 is not available.
29118
29119 The expiry times for negative and positive address cache records are
29120 independent, and can be set by the global options &%callout_negative_expire%&
29121 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29122
29123 If a host gives a negative response to an SMTP connection, or rejects any
29124 commands up to and including
29125 .code
29126 MAIL FROM:<>
29127 .endd
29128 (but not including the MAIL command with a non-empty address),
29129 any callout attempt is bound to fail. Exim remembers such failures in a
29130 domain cache record, which it uses to fail callouts for the domain without
29131 making new connections, until the domain record times out. There are two
29132 separate expiry times for domain cache records:
29133 &%callout_domain_negative_expire%& (default 3h) and
29134 &%callout_domain_positive_expire%& (default 7d).
29135
29136 Domain records expire when the negative expiry time is reached if callouts
29137 cannot be made for the domain, or if the postmaster check failed.
29138 Otherwise, they expire when the positive expiry time is reached. This
29139 ensures that, for example, a host that stops accepting &"random"& local parts
29140 will eventually be noticed.
29141
29142 The callout caching mechanism is based on the domain of the address that is
29143 being tested. If the domain routes to several hosts, it is assumed that their
29144 behaviour will be the same.
29145
29146
29147
29148 .section "Sender address verification reporting" "SECTsenaddver"
29149 .cindex "verifying" "suppressing error details"
29150 See section &<<SECTaddressverification>>& for a general discussion of
29151 verification. When sender verification fails in an ACL, the details of the
29152 failure are given as additional output lines before the 550 response to the
29153 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29154 you might see:
29155 .code
29156 MAIL FROM:<xyz@abc.example>
29157 250 OK
29158 RCPT TO:<pqr@def.example>
29159 550-Verification failed for <xyz@abc.example>
29160 550-Called:   192.168.34.43
29161 550-Sent:     RCPT TO:<xyz@abc.example>
29162 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29163 550 Sender verification failed
29164 .endd
29165 If more than one RCPT command fails in the same way, the details are given
29166 only for the first of them. However, some administrators do not want to send
29167 out this much information. You can suppress the details by adding
29168 &`/no_details`& to the ACL statement that requests sender verification. For
29169 example:
29170 .code
29171 verify = sender/no_details
29172 .endd
29173
29174 .section "Redirection while verifying" "SECTredirwhilveri"
29175 .cindex "verifying" "redirection while"
29176 .cindex "address redirection" "while verifying"
29177 A dilemma arises when a local address is redirected by aliasing or forwarding
29178 during verification: should the generated addresses themselves be verified,
29179 or should the successful expansion of the original address be enough to verify
29180 it? By default, Exim takes the following pragmatic approach:
29181
29182 .ilist
29183 When an incoming address is redirected to just one child address, verification
29184 continues with the child address, and if that fails to verify, the original
29185 verification also fails.
29186 .next
29187 When an incoming address is redirected to more than one child address,
29188 verification does not continue. A success result is returned.
29189 .endlist
29190
29191 This seems the most reasonable behaviour for the common use of aliasing as a
29192 way of redirecting different local parts to the same mailbox. It means, for
29193 example, that a pair of alias entries of the form
29194 .code
29195 A.Wol:   aw123
29196 aw123:   :fail: Gone away, no forwarding address
29197 .endd
29198 work as expected, with both local parts causing verification failure. When a
29199 redirection generates more than one address, the behaviour is more like a
29200 mailing list, where the existence of the alias itself is sufficient for
29201 verification to succeed.
29202
29203 It is possible, however, to change the default behaviour so that all successful
29204 redirections count as successful verifications, however many new addresses are
29205 generated. This is specified by the &%success_on_redirect%& verification
29206 option. For example:
29207 .code
29208 require verify = recipient/success_on_redirect/callout=10s
29209 .endd
29210 In this example, verification succeeds if a router generates a new address, and
29211 the callout does not occur, because no address was routed to a remote host.
29212
29213 When verification is being tested via the &%-bv%& option, the treatment of
29214 redirections is as just described, unless the &%-v%& or any debugging option is
29215 also specified. In that case, full verification is done for every generated
29216 address and a report is output for each of them.
29217
29218
29219
29220 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29221 .cindex "CSA" "verifying"
29222 Client SMTP Authorization is a system that allows a site to advertise
29223 which machines are and are not permitted to send email. This is done by placing
29224 special SRV records in the DNS; these are looked up using the client's HELO
29225 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29226 Authorization checks in Exim are performed by the ACL condition:
29227 .code
29228 verify = csa
29229 .endd
29230 This fails if the client is not authorized. If there is a DNS problem, or if no
29231 valid CSA SRV record is found, or if the client is authorized, the condition
29232 succeeds. These three cases can be distinguished using the expansion variable
29233 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29234 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29235 be likely to cause problems for legitimate email.
29236
29237 The error messages produced by the CSA code include slightly more
29238 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29239 looking up the CSA SRV record, or problems looking up the CSA target
29240 address record. There are four reasons for &$csa_status$& being &"fail"&:
29241
29242 .ilist
29243 The client's host name is explicitly not authorized.
29244 .next
29245 The client's IP address does not match any of the CSA target IP addresses.
29246 .next
29247 The client's host name is authorized but it has no valid target IP addresses
29248 (for example, the target's addresses are IPv6 and the client is using IPv4).
29249 .next
29250 The client's host name has no CSA SRV record but a parent domain has asserted
29251 that all subdomains must be explicitly authorized.
29252 .endlist
29253
29254 The &%csa%& verification condition can take an argument which is the domain to
29255 use for the DNS query. The default is:
29256 .code
29257 verify = csa/$sender_helo_name
29258 .endd
29259 This implementation includes an extension to CSA. If the query domain
29260 is an address literal such as [192.0.2.95], or if it is a bare IP
29261 address, Exim searches for CSA SRV records in the reverse DNS as if
29262 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29263 meaningful to say:
29264 .code
29265 verify = csa/$sender_host_address
29266 .endd
29267 In fact, this is the check that Exim performs if the client does not say HELO.
29268 This extension can be turned off by setting the main configuration option
29269 &%dns_csa_use_reverse%& to be false.
29270
29271 If a CSA SRV record is not found for the domain itself, a search
29272 is performed through its parent domains for a record which might be
29273 making assertions about subdomains. The maximum depth of this search is limited
29274 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29275 default. Exim does not look for CSA SRV records in a top level domain, so the
29276 default settings handle HELO domains as long as seven
29277 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29278 of legitimate HELO domains.
29279
29280 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29281 direct SRV lookups, this is not sufficient because of the extra parent domain
29282 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29283 addresses into lookups in the reverse DNS space. The result of a successful
29284 lookup such as:
29285 .code
29286 ${lookup dnsdb {csa=$sender_helo_name}}
29287 .endd
29288 has two space-separated fields: an authorization code and a target host name.
29289 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29290 authorization required but absent, or &"?"& for unknown.
29291
29292
29293
29294
29295 .section "Bounce address tag validation" "SECTverifyPRVS"
29296 .cindex "BATV, verifying"
29297 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
29298 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
29299 Genuine incoming bounce messages should therefore always be addressed to
29300 recipients that have a valid tag. This scheme is a way of detecting unwanted
29301 bounce messages caused by sender address forgeries (often called &"collateral
29302 spam"&), because the recipients of such messages do not include valid tags.
29303
29304 There are two expansion items to help with the implementation of the BATV
29305 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
29306 the original envelope sender address by using a simple key to add a hash of the
29307 address and some time-based randomizing information. The &%prvs%& expansion
29308 item creates a signed address, and the &%prvscheck%& expansion item checks one.
29309 The syntax of these expansion items is described in section
29310 &<<SECTexpansionitems>>&.
29311
29312 As an example, suppose the secret per-address keys are stored in an MySQL
29313 database. A query to look up the key for an address could be defined as a macro
29314 like this:
29315 .code
29316 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
29317                 WHERE sender='${quote_mysql:$prvscheck_address}'\
29318                 }{$value}}
29319 .endd
29320 Suppose also that the senders who make use of BATV are defined by an address
29321 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
29322 use this:
29323 .code
29324 # Bounces: drop unsigned addresses for BATV senders
29325 deny message = This address does not send an unsigned reverse path
29326      senders = :
29327      recipients = +batv_senders
29328
29329 # Bounces: In case of prvs-signed address, check signature.
29330 deny message = Invalid reverse path signature.
29331      senders = :
29332      condition  = ${prvscheck {$local_part@$domain}\
29333                   {PRVSCHECK_SQL}{1}}
29334      !condition = $prvscheck_result
29335 .endd
29336 The first statement rejects recipients for bounce messages that are addressed
29337 to plain BATV sender addresses, because it is known that BATV senders do not
29338 send out messages with plain sender addresses. The second statement rejects
29339 recipients that are prvs-signed, but with invalid signatures (either because
29340 the key is wrong, or the signature has timed out).
29341
29342 A non-prvs-signed address is not rejected by the second statement, because the
29343 &%prvscheck%& expansion yields an empty string if its first argument is not a
29344 prvs-signed address, thus causing the &%condition%& condition to be false. If
29345 the first argument is a syntactically valid prvs-signed address, the yield is
29346 the third string (in this case &"1"&), whether or not the cryptographic and
29347 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29348 of the checks (empty for failure, &"1"& for success).
29349
29350 There is one more issue you must consider when implementing prvs-signing:
29351 you have to ensure that the routers accept prvs-signed addresses and
29352 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29353 router to remove the signature with a configuration along these lines:
29354 .code
29355 batv_redirect:
29356   driver = redirect
29357   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29358 .endd
29359 This works because, if the third argument of &%prvscheck%& is empty, the result
29360 of the expansion of a prvs-signed address is the decoded value of the original
29361 address. This router should probably be the first of your routers that handles
29362 local addresses.
29363
29364 To create BATV-signed addresses in the first place, a transport of this form
29365 can be used:
29366 .code
29367 external_smtp_batv:
29368   driver = smtp
29369   return_path = ${prvs {$return_path} \
29370                        {${lookup mysql{SELECT \
29371                        secret FROM batv_prvs WHERE \
29372                        sender='${quote_mysql:$sender_address}'} \
29373                        {$value}fail}}}
29374 .endd
29375 If no key can be found for the existing return path, no signing takes place.
29376
29377
29378
29379 .section "Using an ACL to control relaying" "SECTrelaycontrol"
29380 .cindex "&ACL;" "relay control"
29381 .cindex "relaying" "control by ACL"
29382 .cindex "policy control" "relay control"
29383 An MTA is said to &'relay'& a message if it receives it from some host and
29384 delivers it directly to another host as a result of a remote address contained
29385 within it. Redirecting a local address via an alias or forward file and then
29386 passing the message on to another host is not relaying,
29387 .cindex "&""percent hack""&"
29388 but a redirection as a result of the &"percent hack"& is.
29389
29390 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
29391 A host which is acting as a gateway or an MX backup is concerned with incoming
29392 relaying from arbitrary hosts to a specific set of domains. On the other hand,
29393 a host which is acting as a smart host for a number of clients is concerned
29394 with outgoing relaying from those clients to the Internet at large. Often the
29395 same host is fulfilling both functions,
29396 . ///
29397 . as illustrated in the diagram below,
29398 . ///
29399 but in principle these two kinds of relaying are entirely independent. What is
29400 not wanted is the transmission of mail from arbitrary remote hosts through your
29401 system to arbitrary domains.
29402
29403
29404 You can implement relay control by means of suitable statements in the ACL that
29405 runs for each RCPT command. For convenience, it is often easiest to use
29406 Exim's named list facility to define the domains and hosts involved. For
29407 example, suppose you want to do the following:
29408
29409 .ilist
29410 Deliver a number of domains to mailboxes on the local host (or process them
29411 locally in some other way). Let's say these are &'my.dom1.example'& and
29412 &'my.dom2.example'&.
29413 .next
29414 Relay mail for a number of other domains for which you are the secondary MX.
29415 These might be &'friend1.example'& and &'friend2.example'&.
29416 .next
29417 Relay mail from the hosts on your local LAN, to whatever domains are involved.
29418 Suppose your LAN is 192.168.45.0/24.
29419 .endlist
29420
29421
29422 In the main part of the configuration, you put the following definitions:
29423 .code
29424 domainlist local_domains    = my.dom1.example : my.dom2.example
29425 domainlist relay_to_domains = friend1.example : friend2.example
29426 hostlist   relay_from_hosts = 192.168.45.0/24
29427 .endd
29428 Now you can use these definitions in the ACL that is run for every RCPT
29429 command:
29430 .code
29431 acl_check_rcpt:
29432   accept domains = +local_domains : +relay_to_domains
29433   accept hosts   = +relay_from_hosts
29434 .endd
29435 The first statement accepts any RCPT command that contains an address in
29436 the local or relay domains. For any other domain, control passes to the second
29437 statement, which accepts the command only if it comes from one of the relay
29438 hosts. In practice, you will probably want to make your ACL more sophisticated
29439 than this, for example, by including sender and recipient verification. The
29440 default configuration includes a more comprehensive example, which is described
29441 in chapter &<<CHAPdefconfil>>&.
29442
29443
29444
29445 .section "Checking a relay configuration" "SECTcheralcon"
29446 .cindex "relaying" "checking control of"
29447 You can check the relay characteristics of your configuration in the same way
29448 that you can test any ACL behaviour for an incoming SMTP connection, by using
29449 the &%-bh%& option to run a fake SMTP session with which you interact.
29450
29451 For specifically testing for unwanted relaying, the host
29452 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
29453 host from the host on which Exim is running, using the normal telnet port, you
29454 will see a normal telnet connection message and then quite a long delay. Be
29455 patient. The remote host is making an SMTP connection back to your host, and
29456 trying a number of common probes to test for open relay vulnerability. The
29457 results of the tests will eventually appear on your terminal.
29458 .ecindex IIDacl
29459
29460
29461
29462 . ////////////////////////////////////////////////////////////////////////////
29463 . ////////////////////////////////////////////////////////////////////////////
29464
29465 .chapter "Content scanning at ACL time" "CHAPexiscan"
29466 .scindex IIDcosca "content scanning" "at ACL time"
29467 The extension of Exim to include content scanning at ACL time, formerly known
29468 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
29469 was integrated into the main source for Exim release 4.50, and Tom continues to
29470 maintain it. Most of the wording of this chapter is taken from Tom's
29471 specification.
29472
29473 It is also possible to scan the content of messages at other times. The
29474 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
29475 scanning after all the ACLs have run. A transport filter can be used to scan
29476 messages at delivery time (see the &%transport_filter%& option, described in
29477 chapter &<<CHAPtransportgeneric>>&).
29478
29479 If you want to include the ACL-time content-scanning features when you compile
29480 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
29481 &_Local/Makefile_&. When you do that, the Exim binary is built with:
29482
29483 .ilist
29484 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
29485 for all MIME parts for SMTP and non-SMTP messages, respectively.
29486 .next
29487 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
29488 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
29489 run at the end of message reception (the &%acl_smtp_data%& ACL).
29490 .next
29491 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
29492 of messages, or parts of messages, for debugging purposes.
29493 .next
29494 Additional expansion variables that are set in the new ACL and by the new
29495 conditions.
29496 .next
29497 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
29498 .endlist
29499
29500 There is another content-scanning configuration option for &_Local/Makefile_&,
29501 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
29502 condition is compiled, in addition to all the other content-scanning features.
29503
29504 Content-scanning is continually evolving, and new features are still being
29505 added. While such features are still unstable and liable to incompatible
29506 changes, they are made available in Exim by setting options whose names begin
29507 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
29508 this manual. You can find out about them by reading the file called
29509 &_doc/experimental.txt_&.
29510
29511 All the content-scanning facilities work on a MBOX copy of the message that is
29512 temporarily created in a file called:
29513 .display
29514 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
29515 .endd
29516 The &_.eml_& extension is a friendly hint to virus scanners that they can
29517 expect an MBOX-like structure inside that file. The file is created when the
29518 first content scanning facility is called. Subsequent calls to content
29519 scanning conditions open the same file again. The directory is recursively
29520 removed when the &%acl_smtp_data%& ACL has finished running, unless
29521 .code
29522 control = no_mbox_unspool
29523 .endd
29524 has been encountered. When the MIME ACL decodes files, they are put into the
29525 same directory by default.
29526
29527
29528
29529 .section "Scanning for viruses" "SECTscanvirus"
29530 .cindex "virus scanning"
29531 .cindex "content scanning" "for viruses"
29532 .cindex "content scanning" "the &%malware%& condition"
29533 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
29534 It supports a &"generic"& interface to scanners called via the shell, and
29535 specialized interfaces for &"daemon"& type virus scanners, which are resident
29536 in memory and thus are much faster.
29537
29538
29539 .oindex "&%av_scanner%&"
29540 You can set the &%av_scanner%& option in first part of the Exim configuration
29541 file to specify which scanner to use, together with any additional options that
29542 are needed. The basic syntax is as follows:
29543 .display
29544 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
29545 .endd
29546 If you do not set &%av_scanner%&, it defaults to
29547 .code
29548 av_scanner = sophie:/var/run/sophie
29549 .endd
29550 If the value of &%av_scanner%& starts with a dollar character, it is expanded
29551 before use. The following scanner types are supported in this release:
29552
29553 .vlist
29554 .vitem &%aveserver%&
29555 .cindex "virus scanners" "Kaspersky"
29556 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
29557 at &url(http://www.kaspersky.com). This scanner type takes one option,
29558 which is the path to the daemon's UNIX socket. The default is shown in this
29559 example:
29560 .code
29561 av_scanner = aveserver:/var/run/aveserver
29562 .endd
29563
29564
29565 .vitem &%clamd%&
29566 .cindex "virus scanners" "clamd"
29567 This daemon-type scanner is GPL and free. You can get it at
29568 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
29569 unpack MIME containers, so it used to be recommended to unpack MIME attachments
29570 in the MIME ACL. This no longer believed to be necessary. One option is
29571 required: either the path and name of a UNIX socket file, or a hostname or IP
29572 number, and a port, separated by space, as in the second of these examples:
29573 .code
29574 av_scanner = clamd:/opt/clamd/socket
29575 av_scanner = clamd:192.0.2.3 1234
29576 av_scanner = clamd:192.0.2.3 1234:local
29577 .endd
29578 If the value of av_scanner points to a UNIX socket file or contains the local
29579 keyword, then the ClamAV interface will pass a filename containing the data
29580 to be scanned, which will should normally result in less I/O happening and be
29581 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
29582 Exim does not assume that there is a common filesystem with the remote host.
29583 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
29584 you be running a version of ClamAV prior to 0.95.
29585 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
29586 contributing the code for this scanner.
29587
29588 .vitem &%cmdline%&
29589 .cindex "virus scanners" "command line interface"
29590 This is the keyword for the generic command line scanner interface. It can be
29591 used to attach virus scanners that are invoked from the shell. This scanner
29592 type takes 3 mandatory options:
29593
29594 .olist
29595 The full path and name of the scanner binary, with all command line options,
29596 and a placeholder (&`%s`&) for the directory to scan.
29597
29598 .next
29599 A regular expression to match against the STDOUT and STDERR output of the
29600 virus scanner. If the expression matches, a virus was found. You must make
29601 absolutely sure that this expression matches on &"virus found"&. This is called
29602 the &"trigger"& expression.
29603
29604 .next
29605 Another regular expression, containing exactly one pair of parentheses, to
29606 match the name of the virus found in the scanners output. This is called the
29607 &"name"& expression.
29608 .endlist olist
29609
29610 For example, Sophos Sweep reports a virus on a line like this:
29611 .code
29612 Virus 'W32/Magistr-B' found in file ./those.bat
29613 .endd
29614 For the trigger expression, we can match the phrase &"found in file"&. For the
29615 name expression, we want to extract the W32/Magistr-B string, so we can match
29616 for the single quotes left and right of it. Altogether, this makes the
29617 configuration setting:
29618 .code
29619 av_scanner = cmdline:\
29620              /path/to/sweep -ss -all -rec -archive %s:\
29621              found in file:'(.+)'
29622 .endd
29623 .vitem &%drweb%&
29624 .cindex "virus scanners" "DrWeb"
29625 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
29626 argument, either a full path to a UNIX socket, or an IP address and port
29627 separated by white space, as in these examples:
29628 .code
29629 av_scanner = drweb:/var/run/drwebd.sock
29630 av_scanner = drweb:192.168.2.20 31337
29631 .endd
29632 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
29633 is used. Thanks to Alex Miller for contributing the code for this scanner.
29634
29635 .vitem &%fsecure%&
29636 .cindex "virus scanners" "F-Secure"
29637 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
29638 argument which is the path to a UNIX socket. For example:
29639 .code
29640 av_scanner = fsecure:/path/to/.fsav
29641 .endd
29642 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
29643 Thelmen for contributing the code for this scanner.
29644
29645 .vitem &%kavdaemon%&
29646 .cindex "virus scanners" "Kaspersky"
29647 This is the scanner daemon of Kaspersky Version 4. This version of the
29648 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29649 scanner type takes one option, which is the path to the daemon's UNIX socket.
29650 For example:
29651 .code
29652 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29653 .endd
29654 The default path is &_/var/run/AvpCtl_&.
29655
29656 .vitem &%mksd%&
29657 .cindex "virus scanners" "mksd"
29658 This is a daemon type scanner that is aimed mainly at Polish users, though some
29659 parts of documentation are now available in English. You can get it at
29660 &url(http://linux.mks.com.pl/). The only option for this scanner type is
29661 the maximum number of processes used simultaneously to scan the attachments,
29662 provided that the demime facility is employed and also provided that mksd has
29663 been run with at least the same number of child processes. For example:
29664 .code
29665 av_scanner = mksd:2
29666 .endd
29667 You can safely omit this option (the default value is 1).
29668
29669 .vitem &%sophie%&
29670 .cindex "virus scanners" "Sophos and Sophie"
29671 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
29672 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
29673 for this scanner type is the path to the UNIX socket that Sophie uses for
29674 client communication. For example:
29675 .code
29676 av_scanner = sophie:/tmp/sophie
29677 .endd
29678 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
29679 the option.
29680 .endlist
29681
29682 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29683 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29684 ACL.
29685
29686 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29687 makes it possible to use different scanners. See further below for an example.
29688 The &%malware%& condition caches its results, so when you use it multiple times
29689 for the same message, the actual scanning process is only carried out once.
29690 However, using expandable items in &%av_scanner%& disables this caching, in
29691 which case each use of the &%malware%& condition causes a new scan of the
29692 message.
29693
29694 The &%malware%& condition takes a right-hand argument that is expanded before
29695 use. It can then be one of
29696
29697 .ilist
29698 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29699 The condition succeeds if a virus was found, and fail otherwise. This is the
29700 recommended usage.
29701 .next
29702 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29703 the condition fails immediately.
29704 .next
29705 A regular expression, in which case the message is scanned for viruses. The
29706 condition succeeds if a virus is found and its name matches the regular
29707 expression. This allows you to take special actions on certain types of virus.
29708 .endlist
29709
29710 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29711 even if there is a problem with the virus scanner. Otherwise, such a problem
29712 causes the ACL to defer.
29713
29714 .vindex "&$malware_name$&"
29715 When a virus is found, the condition sets up an expansion variable called
29716 &$malware_name$& that contains the name of the virus. You can use it in a
29717 &%message%& modifier that specifies the error returned to the sender, and/or in
29718 logging data.
29719
29720 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29721 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29722 &%malware%& condition.
29723
29724 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29725 imposed by your anti-virus scanner.
29726
29727 Here is a very simple scanning example:
29728 .code
29729 deny message = This message contains malware ($malware_name)
29730      demime = *
29731      malware = *
29732 .endd
29733 The next example accepts messages when there is a problem with the scanner:
29734 .code
29735 deny message = This message contains malware ($malware_name)
29736      demime = *
29737      malware = */defer_ok
29738 .endd
29739 The next example shows how to use an ACL variable to scan with both sophie and
29740 aveserver. It assumes you have set:
29741 .code
29742 av_scanner = $acl_m0
29743 .endd
29744 in the main Exim configuration.
29745 .code
29746 deny message = This message contains malware ($malware_name)
29747      set acl_m0 = sophie
29748      malware = *
29749
29750 deny message = This message contains malware ($malware_name)
29751      set acl_m0 = aveserver
29752      malware = *
29753 .endd
29754
29755
29756 .section "Scanning with SpamAssassin" "SECTscanspamass"
29757 .cindex "content scanning" "for spam"
29758 .cindex "spam scanning"
29759 .cindex "SpamAssassin"
29760 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29761 score and a report for the message. You can get SpamAssassin at
29762 &url(http://www.spamassassin.org), or, if you have a working Perl
29763 installation, you can use CPAN by running:
29764 .code
29765 perl -MCPAN -e 'install Mail::SpamAssassin'
29766 .endd
29767 SpamAssassin has its own set of configuration files. Please review its
29768 documentation to see how you can tweak it. The default installation should work
29769 nicely, however.
29770
29771 .oindex "&%spamd_address%&"
29772 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29773 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29774 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29775 part of the Exim configuration as follows (example):
29776 .code
29777 spamd_address = 192.168.99.45 387
29778 .endd
29779 You do not need to set this option if you use the default. As of version 2.60,
29780 &%spamd%& also supports communication over UNIX sockets. If you want to use
29781 these, supply &%spamd_address%& with an absolute file name instead of a
29782 address/port pair:
29783 .code
29784 spamd_address = /var/run/spamd_socket
29785 .endd
29786 You can have multiple &%spamd%& servers to improve scalability. These can
29787 reside on other hardware reachable over the network. To specify multiple
29788 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29789 option, separated with colons:
29790 .code
29791 spamd_address = 192.168.2.10 783 : \
29792                 192.168.2.11 783 : \
29793                 192.168.2.12 783
29794 .endd
29795 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29796 fashion. When a server fails to respond to the connection attempt, all other
29797 servers are tried until one succeeds. If no server responds, the &%spam%&
29798 condition defers.
29799
29800 &*Warning*&: It is not possible to use the UNIX socket connection method with
29801 multiple &%spamd%& servers.
29802
29803 The &%spamd_address%& variable is expanded before use if it starts with
29804 a dollar sign. In this case, the expansion may return a string that is
29805 used as the list so that multiple spamd servers can be the result of an
29806 expansion.
29807
29808 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29809 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29810 .code
29811 deny message = This message was classified as SPAM
29812      spam = joe
29813 .endd
29814 The right-hand side of the &%spam%& condition specifies a name. This is
29815 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29816 to scan using a specific profile, but rather use the SpamAssassin system-wide
29817 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29818 However, you must put something on the right-hand side.
29819
29820 The name allows you to use per-domain or per-user antispam profiles in
29821 principle, but this is not straightforward in practice, because a message may
29822 have multiple recipients, not necessarily all in the same domain. Because the
29823 &%spam%& condition has to be called from a DATA ACL in order to be able to
29824 read the contents of the message, the variables &$local_part$& and &$domain$&
29825 are not set.
29826
29827 The right-hand side of the &%spam%& condition is expanded before being used, so
29828 you can put lookups or conditions there. When the right-hand side evaluates to
29829 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29830
29831
29832 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29833 large ones may cause significant performance degradation. As most spam messages
29834 are quite small, it is recommended that you do not scan the big ones. For
29835 example:
29836 .code
29837 deny message = This message was classified as SPAM
29838      condition = ${if < {$message_size}{10K}}
29839      spam = nobody
29840 .endd
29841
29842 The &%spam%& condition returns true if the threshold specified in the user's
29843 SpamAssassin profile has been matched or exceeded. If you want to use the
29844 &%spam%& condition for its side effects (see the variables below), you can make
29845 it always return &"true"& by appending &`:true`& to the username.
29846
29847 .cindex "spam scanning" "returned variables"
29848 When the &%spam%& condition is run, it sets up a number of expansion
29849 variables. These variables are saved with the received message, thus they are
29850 available for use at delivery time.
29851
29852 .vlist
29853 .vitem &$spam_score$&
29854 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29855 for inclusion in log or reject messages.
29856
29857 .vitem &$spam_score_int$&
29858 The spam score of the message, multiplied by ten, as an integer value. For
29859 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29860 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29861 The integer value is useful for numeric comparisons in conditions.
29862
29863 .vitem &$spam_bar$&
29864 A string consisting of a number of &"+"& or &"-"& characters, representing the
29865 integer part of the spam score value. A spam score of 4.4 would have a
29866 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29867 headers, since MUAs can match on such strings.
29868
29869 .vitem &$spam_report$&
29870 A multiline text table, containing the full SpamAssassin report for the
29871 message. Useful for inclusion in headers or reject messages.
29872 .endlist
29873
29874 The &%spam%& condition caches its results unless expansion in
29875 spamd_address was used. If you call it again with the same user name, it
29876 does not scan again, but rather returns the same values as before.
29877
29878 The &%spam%& condition returns DEFER if there is any error while running
29879 the message through SpamAssassin or if the expansion of spamd_address
29880 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29881 statement block), append &`/defer_ok`& to the right-hand side of the
29882 spam condition, like this:
29883 .code
29884 deny message = This message was classified as SPAM
29885      spam    = joe/defer_ok
29886 .endd
29887 This causes messages to be accepted even if there is a problem with &%spamd%&.
29888
29889 Here is a longer, commented example of the use of the &%spam%&
29890 condition:
29891 .code
29892 # put headers in all messages (no matter if spam or not)
29893 warn  spam = nobody:true
29894       add_header = X-Spam-Score: $spam_score ($spam_bar)
29895       add_header = X-Spam-Report: $spam_report
29896
29897 # add second subject line with *SPAM* marker when message
29898 # is over threshold
29899 warn  spam = nobody
29900       add_header = Subject: *SPAM* $h_Subject:
29901
29902 # reject spam at high scores (> 12)
29903 deny  message = This message scored $spam_score spam points.
29904       spam = nobody:true
29905       condition = ${if >{$spam_score_int}{120}{1}{0}}
29906 .endd
29907
29908
29909
29910 .section "Scanning MIME parts" "SECTscanmimepart"
29911 .cindex "content scanning" "MIME parts"
29912 .cindex "MIME content scanning"
29913 .oindex "&%acl_smtp_mime%&"
29914 .oindex "&%acl_not_smtp_mime%&"
29915 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29916 each MIME part of an SMTP message, including multipart types, in the sequence
29917 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29918 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29919 options may both refer to the same ACL if you want the same processing in both
29920 cases.
29921
29922 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29923 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29924 the case of a non-SMTP message. However, a MIME ACL is called only if the
29925 message contains a &'Content-Type:'& header line. When a call to a MIME
29926 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29927 result code is sent to the client. In the case of an SMTP message, the
29928 &%acl_smtp_data%& ACL is not called when this happens.
29929
29930 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29931 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29932 condition to match against the raw MIME part. You can also use the
29933 &%mime_regex%& condition to match against the decoded MIME part (see section
29934 &<<SECTscanregex>>&).
29935
29936 At the start of a MIME ACL, a number of variables are set from the header
29937 information for the relevant MIME part. These are described below. The contents
29938 of the MIME part are not by default decoded into a disk file except for MIME
29939 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29940 part into a disk file, you can use the &%decode%& condition. The general
29941 syntax is:
29942 .display
29943 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29944 .endd
29945 The right hand side is expanded before use. After expansion,
29946 the value can be:
29947
29948 .olist
29949 &"0"& or &"false"&, in which case no decoding is done.
29950 .next
29951 The string &"default"&. In that case, the file is put in the temporary
29952 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29953 a sequential file name consisting of the message id and a sequence number. The
29954 full path and name is available in &$mime_decoded_filename$& after decoding.
29955 .next
29956 A full path name starting with a slash. If the full name is an existing
29957 directory, it is used as a replacement for the default directory. The filename
29958 is then sequentially assigned. If the path does not exist, it is used as
29959 the full path and file name.
29960 .next
29961 If the string does not start with a slash, it is used as the
29962 filename, and the default path is then used.
29963 .endlist
29964 The &%decode%& condition normally succeeds. It is only false for syntax
29965 errors or unusual circumstances such as memory shortages. You can easily decode
29966 a file with its original, proposed filename using
29967 .code
29968 decode = $mime_filename
29969 .endd
29970 However, you should keep in mind that &$mime_filename$& might contain
29971 anything. If you place files outside of the default path, they are not
29972 automatically unlinked.
29973
29974 For RFC822 attachments (these are messages attached to messages, with a
29975 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29976 as for the primary message, only that the &$mime_is_rfc822$& expansion
29977 variable is set (see below). Attached messages are always decoded to disk
29978 before being checked, and the files are unlinked once the check is done.
29979
29980 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29981 used to match regular expressions against raw and decoded MIME parts,
29982 respectively. They are described in section &<<SECTscanregex>>&.
29983
29984 .cindex "MIME content scanning" "returned variables"
29985 The following list describes all expansion variables that are
29986 available in the MIME ACL:
29987
29988 .vlist
29989 .vitem &$mime_boundary$&
29990 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29991 have a boundary string, which is stored in this variable. If the current part
29992 has no boundary parameter in the &'Content-Type:'& header, this variable
29993 contains the empty string.
29994
29995 .vitem &$mime_charset$&
29996 This variable contains the character set identifier, if one was found in the
29997 &'Content-Type:'& header. Examples for charset identifiers are:
29998 .code
29999 us-ascii
30000 gb2312 (Chinese)
30001 iso-8859-1
30002 .endd
30003 Please note that this value is not normalized, so you should do matches
30004 case-insensitively.
30005
30006 .vitem &$mime_content_description$&
30007 This variable contains the normalized content of the &'Content-Description:'&
30008 header. It can contain a human-readable description of the parts content. Some
30009 implementations repeat the filename for attachments here, but they are usually
30010 only used for display purposes.
30011
30012 .vitem &$mime_content_disposition$&
30013 This variable contains the normalized content of the &'Content-Disposition:'&
30014 header. You can expect strings like &"attachment"& or &"inline"& here.
30015
30016 .vitem &$mime_content_id$&
30017 This variable contains the normalized content of the &'Content-ID:'& header.
30018 This is a unique ID that can be used to reference a part from another part.
30019
30020 .vitem &$mime_content_size$&
30021 This variable is set only after the &%decode%& modifier (see above) has been
30022 successfully run. It contains the size of the decoded part in kilobytes. The
30023 size is always rounded up to full kilobytes, so only a completely empty part
30024 has a &$mime_content_size$& of zero.
30025
30026 .vitem &$mime_content_transfer_encoding$&
30027 This variable contains the normalized content of the
30028 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30029 type. Typical values are &"base64"& and &"quoted-printable"&.
30030
30031 .vitem &$mime_content_type$&
30032 If the MIME part has a &'Content-Type:'& header, this variable contains its
30033 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30034 are some examples of popular MIME types, as they may appear in this variable:
30035 .code
30036 text/plain
30037 text/html
30038 application/octet-stream
30039 image/jpeg
30040 audio/midi
30041 .endd
30042 If the MIME part has no &'Content-Type:'& header, this variable contains the
30043 empty string.
30044
30045 .vitem &$mime_decoded_filename$&
30046 This variable is set only after the &%decode%& modifier (see above) has been
30047 successfully run. It contains the full path and file name of the file
30048 containing the decoded data.
30049 .endlist
30050
30051 .cindex "RFC 2047"
30052 .vlist
30053 .vitem &$mime_filename$&
30054 This is perhaps the most important of the MIME variables. It contains a
30055 proposed filename for an attachment, if one was found in either the
30056 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30057 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30058 found, this variable contains the empty string.
30059
30060 .vitem &$mime_is_coverletter$&
30061 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30062 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30063 content in the cover letter, while not restricting attachments at all.
30064
30065 The variable contains 1 (true) for a MIME part believed to be part of the
30066 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30067 follows:
30068
30069 .olist
30070 The outermost MIME part of a message is always a cover letter.
30071
30072 .next
30073 If a multipart/alternative or multipart/related MIME part is a cover letter,
30074 so are all MIME subparts within that multipart.
30075
30076 .next
30077 If any other multipart is a cover letter, the first subpart is a cover letter,
30078 and the rest are attachments.
30079
30080 .next
30081 All parts contained within an attachment multipart are attachments.
30082 .endlist olist
30083
30084 As an example, the following will ban &"HTML mail"& (including that sent with
30085 alternative plain text), while allowing HTML files to be attached. HTML
30086 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30087 .code
30088 deny message = HTML mail is not accepted here
30089 !condition = $mime_is_rfc822
30090 condition = $mime_is_coverletter
30091 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30092 .endd
30093 .vitem &$mime_is_multipart$&
30094 This variable has the value 1 (true) when the current part has the main type
30095 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30096 Since multipart entities only serve as containers for other parts, you may not
30097 want to carry out specific actions on them.
30098
30099 .vitem &$mime_is_rfc822$&
30100 This variable has the value 1 (true) if the current part is not a part of the
30101 checked message itself, but part of an attached message. Attached message
30102 decoding is fully recursive.
30103
30104 .vitem &$mime_part_count$&
30105 This variable is a counter that is raised for each processed MIME part. It
30106 starts at zero for the very first part (which is usually a multipart). The
30107 counter is per-message, so it is reset when processing RFC822 attachments (see
30108 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
30109 complete, so you can use it in the DATA ACL to determine the number of MIME
30110 parts of a message. For non-MIME messages, this variable contains the value -1.
30111 .endlist
30112
30113
30114
30115 .section "Scanning with regular expressions" "SECTscanregex"
30116 .cindex "content scanning" "with regular expressions"
30117 .cindex "regular expressions" "content scanning with"
30118 You can specify your own custom regular expression matches on the full body of
30119 the message, or on individual MIME parts.
30120
30121 The &%regex%& condition takes one or more regular expressions as arguments and
30122 matches them against the full message (when called in the DATA ACL) or a raw
30123 MIME part (when called in the MIME ACL). The &%regex%& condition matches
30124 linewise, with a maximum line length of 32K characters. That means you cannot
30125 have multiline matches with the &%regex%& condition.
30126
30127 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30128 to 32K of decoded content (the whole content at once, not linewise). If the
30129 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30130 is decoded automatically when &%mime_regex%& is executed (using default path
30131 and filename values). If the decoded data is larger than  32K, only the first
30132 32K characters are checked.
30133
30134 The regular expressions are passed as a colon-separated list. To include a
30135 literal colon, you must double it. Since the whole right-hand side string is
30136 expanded before being used, you must also escape dollar signs and backslashes
30137 with more backslashes, or use the &`\N`& facility to disable expansion.
30138 Here is a simple example that contains two regular expressions:
30139 .code
30140 deny message = contains blacklisted regex ($regex_match_string)
30141      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30142 .endd
30143 The conditions returns true if any one of the regular expressions matches. The
30144 &$regex_match_string$& expansion variable is then set up and contains the
30145 matching regular expression.
30146
30147 &*Warning*&: With large messages, these conditions can be fairly
30148 CPU-intensive.
30149
30150
30151
30152
30153 .section "The demime condition" "SECTdemimecond"
30154 .cindex "content scanning" "MIME checking"
30155 .cindex "MIME content scanning"
30156 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30157 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30158 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30159 ACL functionality, but provides no additional facilities. Please note that this
30160 condition is deprecated and kept only for backward compatibility. You must set
30161 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30162 use the &%demime%& condition.
30163
30164 The &%demime%& condition unpacks MIME containers in the message. It detects
30165 errors in MIME containers and can match file extensions found in the message
30166 against a list. Using this facility produces files containing the unpacked MIME
30167 parts of the message in the temporary scan directory. If you do antivirus
30168 scanning, it is recommended that you use the &%demime%& condition before the
30169 antivirus (&%malware%&) condition.
30170
30171 On the right-hand side of the &%demime%& condition you can pass a
30172 colon-separated list of file extensions that it should match against. For
30173 example:
30174 .code
30175 deny message = Found blacklisted file attachment
30176      demime  = vbs:com:bat:pif:prf:lnk
30177 .endd
30178 If one of the file extensions is found, the condition is true, otherwise it is
30179 false. If there is a temporary error while demimeing (for example, &"disk
30180 full"&), the condition defers, and the message is temporarily rejected (unless
30181 the condition is on a &%warn%& verb).
30182
30183 The right-hand side is expanded before being treated as a list, so you can have
30184 conditions and lookups there. If it expands to an empty string, &"false"&, or
30185 zero (&"0"&), no demimeing is done and the condition is false.
30186
30187 The &%demime%& condition set the following variables:
30188
30189 .vlist
30190 .vitem &$demime_errorlevel$&
30191 .vindex "&$demime_errorlevel$&"
30192 When an error is detected in a MIME container, this variable contains the
30193 severity of the error, as an integer number. The higher the value, the more
30194 severe the error (the current maximum value is 3). If this variable is unset or
30195 zero, no error occurred.
30196
30197 .vitem &$demime_reason$&
30198 .vindex "&$demime_reason$&"
30199 When &$demime_errorlevel$& is greater than zero, this variable contains a
30200 human-readable text string describing the MIME error that occurred.
30201 .endlist
30202
30203 .vlist
30204 .vitem &$found_extension$&
30205 .vindex "&$found_extension$&"
30206 When the &%demime%& condition is true, this variable contains the file
30207 extension it found.
30208 .endlist
30209
30210 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30211 the &%demime%& condition, and are not changed on subsequent calls.
30212
30213 If you do not want to check for file extensions, but rather use the &%demime%&
30214 condition for unpacking or error checking purposes, pass &"*"& as the
30215 right-hand side value. Here is a more elaborate example of how to use this
30216 facility:
30217 .code
30218 # Reject messages with serious MIME container errors
30219 deny  message = Found MIME error ($demime_reason).
30220       demime = *
30221       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30222
30223 # Reject known virus spreading file extensions.
30224 # Accepting these is pretty much braindead.
30225 deny  message = contains $found_extension file (blacklisted).
30226       demime  = com:vbs:bat:pif:scr
30227
30228 # Freeze .exe and .doc files. Postmaster can
30229 # examine them and eventually thaw them.
30230 deny  log_message = Another $found_extension file.
30231       demime = exe:doc
30232       control = freeze
30233 .endd
30234 .ecindex IIDcosca
30235
30236
30237
30238
30239 . ////////////////////////////////////////////////////////////////////////////
30240 . ////////////////////////////////////////////////////////////////////////////
30241
30242 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30243          "Local scan function"
30244 .scindex IIDlosca "&[local_scan()]& function" "description of"
30245 .cindex "customizing" "input scan using C function"
30246 .cindex "policy control" "by local scan function"
30247 In these days of email worms, viruses, and ever-increasing spam, some sites
30248 want to apply a lot of checking to messages before accepting them.
30249
30250 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30251 passing messages to external virus and spam scanning software. You can also do
30252 a certain amount in Exim itself through string expansions and the &%condition%&
30253 condition in the ACL that runs after the SMTP DATA command or the ACL for
30254 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30255
30256 To allow for further customization to a site's own requirements, there is the
30257 possibility of linking Exim with a private message scanning function, written
30258 in C. If you want to run code that is written in something other than C, you
30259 can of course use a little C stub to call it.
30260
30261 The local scan function is run once for every incoming message, at the point
30262 when Exim is just about to accept the message.
30263 It can therefore be used to control non-SMTP messages from local processes as
30264 well as messages arriving via SMTP.
30265
30266 Exim applies a timeout to calls of the local scan function, and there is an
30267 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
30268 Zero means &"no timeout"&.
30269 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
30270 before calling the local scan function, so that the most common types of crash
30271 are caught. If the timeout is exceeded or one of those signals is caught, the
30272 incoming message is rejected with a temporary error if it is an SMTP message.
30273 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
30274 code. The incident is logged on the main and reject logs.
30275
30276
30277
30278 .section "Building Exim to use a local scan function" "SECID207"
30279 .cindex "&[local_scan()]& function" "building Exim to use"
30280 To make use of the local scan function feature, you must tell Exim where your
30281 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
30282 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
30283 directory, so you might set
30284 .code
30285 LOCAL_SCAN_SOURCE=Local/local_scan.c
30286 .endd
30287 for example. The function must be called &[local_scan()]&. It is called by
30288 Exim after it has received a message, when the success return code is about to
30289 be sent. This is after all the ACLs have been run. The return code from your
30290 function controls whether the message is actually accepted or not. There is a
30291 commented template function (that just accepts the message) in the file
30292 _src/local_scan.c_.
30293
30294 If you want to make use of Exim's run time configuration file to set options
30295 for your &[local_scan()]& function, you must also set
30296 .code
30297 LOCAL_SCAN_HAS_OPTIONS=yes
30298 .endd
30299 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
30300
30301
30302
30303
30304 .section "API for local_scan()" "SECTapiforloc"
30305 .cindex "&[local_scan()]& function" "API description"
30306 You must include this line near the start of your code:
30307 .code
30308 #include "local_scan.h"
30309 .endd
30310 This header file defines a number of variables and other values, and the
30311 prototype for the function itself. Exim is coded to use unsigned char values
30312 almost exclusively, and one of the things this header defines is a shorthand
30313 for &`unsigned char`& called &`uschar`&.
30314 It also contains the following macro definitions, to simplify casting character
30315 strings and pointers to character strings:
30316 .code
30317 #define CS   (char *)
30318 #define CCS  (const char *)
30319 #define CSS  (char **)
30320 #define US   (unsigned char *)
30321 #define CUS  (const unsigned char *)
30322 #define USS  (unsigned char **)
30323 .endd
30324 The function prototype for &[local_scan()]& is:
30325 .code
30326 extern int local_scan(int fd, uschar **return_text);
30327 .endd
30328 The arguments are as follows:
30329
30330 .ilist
30331 &%fd%& is a file descriptor for the file that contains the body of the message
30332 (the -D file). The file is open for reading and writing, but updating it is not
30333 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30334
30335 The descriptor is positioned at character 19 of the file, which is the first
30336 character of the body itself, because the first 19 characters are the message
30337 id followed by &`-D`& and a newline. If you rewind the file, you should use the
30338 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
30339 case this changes in some future version.
30340 .next
30341 &%return_text%& is an address which you can use to return a pointer to a text
30342 string at the end of the function. The value it points to on entry is NULL.
30343 .endlist
30344
30345 The function must return an &%int%& value which is one of the following macros:
30346
30347 .vlist
30348 .vitem &`LOCAL_SCAN_ACCEPT`&
30349 .vindex "&$local_scan_data$&"
30350 The message is accepted. If you pass back a string of text, it is saved with
30351 the message, and made available in the variable &$local_scan_data$&. No
30352 newlines are permitted (if there are any, they are turned into spaces) and the
30353 maximum length of text is 1000 characters.
30354
30355 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
30356 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30357 queued without immediate delivery, and is frozen.
30358
30359 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
30360 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30361 queued without immediate delivery.
30362
30363 .vitem &`LOCAL_SCAN_REJECT`&
30364 The message is rejected; the returned text is used as an error message which is
30365 passed back to the sender and which is also logged. Newlines are permitted &--
30366 they cause a multiline response for SMTP rejections, but are converted to
30367 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
30368 used.
30369
30370 .vitem &`LOCAL_SCAN_TEMPREJECT`&
30371 The message is temporarily rejected; the returned text is used as an error
30372 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
30373 problem"& is used.
30374
30375 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
30376 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
30377 message is not written to the reject log. It has the effect of unsetting the
30378 &%rejected_header%& log selector for just this rejection. If
30379 &%rejected_header%& is already unset (see the discussion of the
30380 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
30381 same as LOCAL_SCAN_REJECT.
30382
30383 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
30384 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
30385 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
30386 .endlist
30387
30388 If the message is not being received by interactive SMTP, rejections are
30389 reported by writing to &%stderr%& or by sending an email, as configured by the
30390 &%-oe%& command line options.
30391
30392
30393
30394 .section "Configuration options for local_scan()" "SECTconoptloc"
30395 .cindex "&[local_scan()]& function" "configuration options"
30396 It is possible to have option settings in the main configuration file
30397 that set values in static variables in the &[local_scan()]& module. If you
30398 want to do this, you must have the line
30399 .code
30400 LOCAL_SCAN_HAS_OPTIONS=yes
30401 .endd
30402 in your &_Local/Makefile_& when you build Exim. (This line is in
30403 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
30404 file, you must define static variables to hold the option values, and a table
30405 to define them.
30406
30407 The table must be a vector called &%local_scan_options%&, of type
30408 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
30409 and a pointer to the variable that holds the value. The entries must appear in
30410 alphabetical order. Following &%local_scan_options%& you must also define a
30411 variable called &%local_scan_options_count%& that contains the number of
30412 entries in the table. Here is a short example, showing two kinds of option:
30413 .code
30414 static int my_integer_option = 42;
30415 static uschar *my_string_option = US"a default string";
30416
30417 optionlist local_scan_options[] = {
30418   { "my_integer", opt_int,       &my_integer_option },
30419   { "my_string",  opt_stringptr, &my_string_option }
30420 };
30421
30422 int local_scan_options_count =
30423   sizeof(local_scan_options)/sizeof(optionlist);
30424 .endd
30425 The values of the variables can now be changed from Exim's runtime
30426 configuration file by including a local scan section as in this example:
30427 .code
30428 begin local_scan
30429 my_integer = 99
30430 my_string = some string of text...
30431 .endd
30432 The available types of option data are as follows:
30433
30434 .vlist
30435 .vitem &*opt_bool*&
30436 This specifies a boolean (true/false) option. The address should point to a
30437 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
30438 that are defined as &"1"& and &"0"&, respectively. If you want to detect
30439 whether such a variable has been set at all, you can initialize it to
30440 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
30441 values.)
30442
30443 .vitem &*opt_fixed*&
30444 This specifies a fixed point number, such as is used for load averages.
30445 The address should point to a variable of type &`int`&. The value is stored
30446 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
30447
30448 .vitem &*opt_int*&
30449 This specifies an integer; the address should point to a variable of type
30450 &`int`&. The value may be specified in any of the integer formats accepted by
30451 Exim.
30452
30453 .vitem &*opt_mkint*&
30454 This is the same as &%opt_int%&, except that when such a value is output in a
30455 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
30456 printed with the suffix K or M.
30457
30458 .vitem &*opt_octint*&
30459 This also specifies an integer, but the value is always interpreted as an
30460 octal integer, whether or not it starts with the digit zero, and it is
30461 always output in octal.
30462
30463 .vitem &*opt_stringptr*&
30464 This specifies a string value; the address must be a pointer to a
30465 variable that points to a string (for example, of type &`uschar *`&).
30466
30467 .vitem &*opt_time*&
30468 This specifies a time interval value. The address must point to a variable of
30469 type &`int`&. The value that is placed there is a number of seconds.
30470 .endlist
30471
30472 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
30473 out the values of all the &[local_scan()]& options.
30474
30475
30476
30477 .section "Available Exim variables" "SECID208"
30478 .cindex "&[local_scan()]& function" "available Exim variables"
30479 The header &_local_scan.h_& gives you access to a number of C variables. These
30480 are the only ones that are guaranteed to be maintained from release to release.
30481 Note, however, that you can obtain the value of any Exim expansion variable,
30482 including &$recipients$&, by calling &'expand_string()'&. The exported
30483 C variables are as follows:
30484
30485 .vlist
30486 .vitem &*int&~body_linecount*&
30487 This variable contains the number of lines in the message's body.
30488
30489 .vitem &*int&~body_zerocount*&
30490 This variable contains the number of binary zero bytes in the message's body.
30491
30492 .vitem &*unsigned&~int&~debug_selector*&
30493 This variable is set to zero when no debugging is taking place. Otherwise, it
30494 is a bitmap of debugging selectors. Two bits are identified for use in
30495 &[local_scan()]&; they are defined as macros:
30496
30497 .ilist
30498 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
30499 testing option that is not privileged &-- any caller may set it. All the
30500 other selector bits can be set only by admin users.
30501
30502 .next
30503 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
30504 by the &`+local_scan`& debug selector. It is not included in the default set
30505 of debugging bits.
30506 .endlist ilist
30507
30508 Thus, to write to the debugging output only when &`+local_scan`& has been
30509 selected, you should use code like this:
30510 .code
30511 if ((debug_selector & D_local_scan) != 0)
30512   debug_printf("xxx", ...);
30513 .endd
30514 .vitem &*uschar&~*expand_string_message*&
30515 After a failing call to &'expand_string()'& (returned value NULL), the
30516 variable &%expand_string_message%& contains the error message, zero-terminated.
30517
30518 .vitem &*header_line&~*header_list*&
30519 A pointer to a chain of header lines. The &%header_line%& structure is
30520 discussed below.
30521
30522 .vitem &*header_line&~*header_last*&
30523 A pointer to the last of the header lines.
30524
30525 .vitem &*uschar&~*headers_charset*&
30526 The value of the &%headers_charset%& configuration option.
30527
30528 .vitem &*BOOL&~host_checking*&
30529 This variable is TRUE during a host checking session that is initiated by the
30530 &%-bh%& command line option.
30531
30532 .vitem &*uschar&~*interface_address*&
30533 The IP address of the interface that received the message, as a string. This
30534 is NULL for locally submitted messages.
30535
30536 .vitem &*int&~interface_port*&
30537 The port on which this message was received. When testing with the &%-bh%&
30538 command line option, the value of this variable is -1 unless a port has been
30539 specified via the &%-oMi%& option.
30540
30541 .vitem &*uschar&~*message_id*&
30542 This variable contains Exim's message id for the incoming message (the value of
30543 &$message_exim_id$&) as a zero-terminated string.
30544
30545 .vitem &*uschar&~*received_protocol*&
30546 The name of the protocol by which the message was received.
30547
30548 .vitem &*int&~recipients_count*&
30549 The number of accepted recipients.
30550
30551 .vitem &*recipient_item&~*recipients_list*&
30552 .cindex "recipient" "adding in local scan"
30553 .cindex "recipient" "removing in local scan"
30554 The list of accepted recipients, held in a vector of length
30555 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
30556 can add additional recipients by calling &'receive_add_recipient()'& (see
30557 below). You can delete recipients by removing them from the vector and
30558 adjusting the value in &%recipients_count%&. In particular, by setting
30559 &%recipients_count%& to zero you remove all recipients. If you then return the
30560 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
30561 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
30562 and then call &'receive_add_recipient()'& as often as needed.
30563
30564 .vitem &*uschar&~*sender_address*&
30565 The envelope sender address. For bounce messages this is the empty string.
30566
30567 .vitem &*uschar&~*sender_host_address*&
30568 The IP address of the sending host, as a string. This is NULL for
30569 locally-submitted messages.
30570
30571 .vitem &*uschar&~*sender_host_authenticated*&
30572 The name of the authentication mechanism that was used, or NULL if the message
30573 was not received over an authenticated SMTP connection.
30574
30575 .vitem &*uschar&~*sender_host_name*&
30576 The name of the sending host, if known.
30577
30578 .vitem &*int&~sender_host_port*&
30579 The port on the sending host.
30580
30581 .vitem &*BOOL&~smtp_input*&
30582 This variable is TRUE for all SMTP input, including BSMTP.
30583
30584 .vitem &*BOOL&~smtp_batched_input*&
30585 This variable is TRUE for BSMTP input.
30586
30587 .vitem &*int&~store_pool*&
30588 The contents of this variable control which pool of memory is used for new
30589 requests. See section &<<SECTmemhanloc>>& for details.
30590 .endlist
30591
30592
30593 .section "Structure of header lines" "SECID209"
30594 The &%header_line%& structure contains the members listed below.
30595 You can add additional header lines by calling the &'header_add()'& function
30596 (see below). You can cause header lines to be ignored (deleted) by setting
30597 their type to *.
30598
30599
30600 .vlist
30601 .vitem &*struct&~header_line&~*next*&
30602 A pointer to the next header line, or NULL for the last line.
30603
30604 .vitem &*int&~type*&
30605 A code identifying certain headers that Exim recognizes. The codes are printing
30606 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
30607 Notice in particular that any header line whose type is * is not transmitted
30608 with the message. This flagging is used for header lines that have been
30609 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
30610 lines.) Effectively, * means &"deleted"&.
30611
30612 .vitem &*int&~slen*&
30613 The number of characters in the header line, including the terminating and any
30614 internal newlines.
30615
30616 .vitem &*uschar&~*text*&
30617 A pointer to the text of the header. It always ends with a newline, followed by
30618 a zero byte. Internal newlines are preserved.
30619 .endlist
30620
30621
30622
30623 .section "Structure of recipient items" "SECID210"
30624 The &%recipient_item%& structure contains these members:
30625
30626 .vlist
30627 .vitem &*uschar&~*address*&
30628 This is a pointer to the recipient address as it was received.
30629
30630 .vitem &*int&~pno*&
30631 This is used in later Exim processing when top level addresses are created by
30632 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
30633 and must always contain -1 at this stage.
30634
30635 .vitem &*uschar&~*errors_to*&
30636 If this value is not NULL, bounce messages caused by failing to deliver to the
30637 recipient are sent to the address it contains. In other words, it overrides the
30638 envelope sender for this one recipient. (Compare the &%errors_to%& generic
30639 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
30640 an unqualified address, Exim qualifies it using the domain from
30641 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
30642 is NULL for all recipients.
30643 .endlist
30644
30645
30646
30647 .section "Available Exim functions" "SECID211"
30648 .cindex "&[local_scan()]& function" "available Exim functions"
30649 The header &_local_scan.h_& gives you access to a number of Exim functions.
30650 These are the only ones that are guaranteed to be maintained from release to
30651 release:
30652
30653 .vlist
30654 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
30655        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
30656
30657 This function creates a child process that runs the command specified by
30658 &%argv%&. The environment for the process is specified by &%envp%&, which can
30659 be NULL if no environment variables are to be passed. A new umask is supplied
30660 for the process in &%newumask%&.
30661
30662 Pipes to the standard input and output of the new process are set up
30663 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
30664 standard error is cloned to the standard output. If there are any file
30665 descriptors &"in the way"& in the new process, they are closed. If the final
30666 argument is TRUE, the new process is made into a process group leader.
30667
30668 The function returns the pid of the new process, or -1 if things go wrong.
30669
30670 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
30671 This function waits for a child process to terminate, or for a timeout (in
30672 seconds) to expire. A timeout value of zero means wait as long as it takes. The
30673 return value is as follows:
30674
30675 .ilist
30676 >= 0
30677
30678 The process terminated by a normal exit and the value is the process
30679 ending status.
30680
30681 .next
30682 < 0 and > &--256
30683
30684 The process was terminated by a signal and the value is the negation of the
30685 signal number.
30686
30687 .next
30688 &--256
30689
30690 The process timed out.
30691 .next
30692 &--257
30693
30694 The was some other error in wait(); &%errno%& is still set.
30695 .endlist
30696
30697 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30698 This function provide you with a means of submitting a new message to
30699 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30700 want, but this packages it all up for you.) The function creates a pipe,
30701 forks a subprocess that is running
30702 .code
30703 exim -t -oem -oi -f <>
30704 .endd
30705 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30706 that is connected to the standard input. The yield of the function is the PID
30707 of the subprocess. You can then write a message to the file descriptor, with
30708 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30709
30710 When you have finished, call &'child_close()'& to wait for the process to
30711 finish and to collect its ending status. A timeout value of zero is usually
30712 fine in this circumstance. Unless you have made a mistake with the recipient
30713 addresses, you should get a return code of zero.
30714
30715
30716 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30717        *sender_authentication)*&
30718 This function is a more sophisticated version of &'child_open()'&. The command
30719 that it runs is:
30720 .display
30721 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30722 .endd
30723 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30724
30725
30726 .vitem &*void&~debug_printf(char&~*,&~...)*&
30727 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30728 output is written to the standard error stream. If no debugging is selected,
30729 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30730 conditional on the &`local_scan`& debug selector by coding like this:
30731 .code
30732 if ((debug_selector & D_local_scan) != 0)
30733   debug_printf("xxx", ...);
30734 .endd
30735
30736 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30737 This is an interface to Exim's string expansion code. The return value is the
30738 expanded string, or NULL if there was an expansion failure.
30739 The C variable &%expand_string_message%& contains an error message after an
30740 expansion failure. If expansion does not change the string, the return value is
30741 the pointer to the input string. Otherwise, the return value points to a new
30742 block of memory that was obtained by a call to &'store_get()'&. See section
30743 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30744
30745 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30746 This function allows you to an add additional header line at the end of the
30747 existing ones. The first argument is the type, and should normally be a space
30748 character. The second argument is a format string and any number of
30749 substitution arguments as for &[sprintf()]&. You may include internal newlines
30750 if you want, and you must ensure that the string ends with a newline.
30751
30752 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30753         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30754 This function adds a new header line at a specified point in the header
30755 chain. The header itself is specified as for &'header_add()'&.
30756
30757 If &%name%& is NULL, the new header is added at the end of the chain if
30758 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30759 NULL, the header lines are searched for the first non-deleted header that
30760 matches the name. If one is found, the new header is added before it if
30761 &%after%& is false. If &%after%& is true, the new header is added after the
30762 found header and any adjacent subsequent ones with the same name (even if
30763 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30764 option controls where the header is added. If it is true, addition is at the
30765 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30766 headers, or at the top if there are no &'Received:'& headers, you could use
30767 .code
30768 header_add_at_position(TRUE, US"Received", TRUE,
30769   ' ', "X-xxx: ...");
30770 .endd
30771 Normally, there is always at least one non-deleted &'Received:'& header, but
30772 there may not be if &%received_header_text%& expands to an empty string.
30773
30774
30775 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30776 This function removes header lines. If &%occurrence%& is zero or negative, all
30777 occurrences of the header are removed. If occurrence is greater than zero, that
30778 particular instance of the header is removed. If no header(s) can be found that
30779 match the specification, the function does nothing.
30780
30781
30782 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30783         int&~length,&~BOOL&~notdel)*&"
30784 This function tests whether the given header has the given name. It is not just
30785 a string comparison, because white space is permitted between the name and the
30786 colon. If the &%notdel%& argument is true, a false return is forced for all
30787 &"deleted"& headers; otherwise they are not treated specially. For example:
30788 .code
30789 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30790 .endd
30791 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30792 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30793 This function base64-encodes a string, which is passed by address and length.
30794 The text may contain bytes of any value, including zero. The result is passed
30795 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30796 zero-terminated.
30797
30798 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30799 This function decodes a base64-encoded string. Its arguments are a
30800 zero-terminated base64-encoded string and the address of a variable that is set
30801 to point to the result, which is in dynamic memory. The length of the decoded
30802 string is the yield of the function. If the input is invalid base64 data, the
30803 yield is -1. A zero byte is added to the end of the output string to make it
30804 easy to interpret as a C string (assuming it contains no zeros of its own). The
30805 added zero byte is not included in the returned count.
30806
30807 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30808 This function checks for a match in a domain list. Domains are always
30809 matched caselessly. The return value is one of the following:
30810 .display
30811 &`OK     `& match succeeded
30812 &`FAIL   `& match failed
30813 &`DEFER  `& match deferred
30814 .endd
30815 DEFER is usually caused by some kind of lookup defer, such as the
30816 inability to contact a database.
30817
30818 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30819         BOOL&~caseless)*&"
30820 This function checks for a match in a local part list. The third argument
30821 controls case-sensitivity. The return values are as for
30822 &'lss_match_domain()'&.
30823
30824 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30825         BOOL&~caseless)*&"
30826 This function checks for a match in an address list. The third argument
30827 controls the case-sensitivity of the local part match. The domain is always
30828 matched caselessly. The return values are as for &'lss_match_domain()'&.
30829
30830 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30831         uschar&~*list)*&"
30832 This function checks for a match in a host list. The most common usage is
30833 expected to be
30834 .code
30835 lss_match_host(sender_host_name, sender_host_address, ...)
30836 .endd
30837 .vindex "&$sender_host_address$&"
30838 An empty address field matches an empty item in the host list. If the host name
30839 is NULL, the name corresponding to &$sender_host_address$& is automatically
30840 looked up if a host name is required to match an item in the list. The return
30841 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30842 returns ERROR in the case when it had to look up a host name, but the lookup
30843 failed.
30844
30845 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30846         *format,&~...)*&"
30847 This function writes to Exim's log files. The first argument should be zero (it
30848 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30849 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30850 them. It specifies to which log or logs the message is written. The remaining
30851 arguments are a format and relevant insertion arguments. The string should not
30852 contain any newlines, not even at the end.
30853
30854
30855 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30856 This function adds an additional recipient to the message. The first argument
30857 is the recipient address. If it is unqualified (has no domain), it is qualified
30858 with the &%qualify_recipient%& domain. The second argument must always be -1.
30859
30860 This function does not allow you to specify a private &%errors_to%& address (as
30861 described with the structure of &%recipient_item%& above), because it pre-dates
30862 the addition of that field to the structure. However, it is easy to add such a
30863 value afterwards. For example:
30864 .code
30865  receive_add_recipient(US"monitor@mydom.example", -1);
30866  recipients_list[recipients_count-1].errors_to =
30867    US"postmaster@mydom.example";
30868 .endd
30869
30870 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30871 This is a convenience function to remove a named recipient from the list of
30872 recipients. It returns true if a recipient was removed, and false if no
30873 matching recipient could be found. The argument must be a complete email
30874 address.
30875 .endlist
30876
30877
30878 .cindex "RFC 2047"
30879 .vlist
30880 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30881   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30882 This function decodes strings that are encoded according to RFC 2047. Typically
30883 these are the contents of header lines. First, each &"encoded word"& is decoded
30884 from the Q or B encoding into a byte-string. Then, if provided with the name of
30885 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30886 made  to translate the result to the named character set. If this fails, the
30887 binary string is returned with an error message.
30888
30889 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30890 maximum MIME word length is enforced. The third argument is the target
30891 encoding, or NULL if no translation is wanted.
30892
30893 .cindex "binary zero" "in RFC 2047 decoding"
30894 .cindex "RFC 2047" "binary zero in"
30895 If a binary zero is encountered in the decoded string, it is replaced by the
30896 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30897 not be 0 because header lines are handled as zero-terminated strings.
30898
30899 The function returns the result of processing the string, zero-terminated; if
30900 &%lenptr%& is not NULL, the length of the result is set in the variable to
30901 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30902
30903 If an error is encountered, the function returns NULL and uses the &%error%&
30904 argument to return an error message. The variable pointed to by &%error%& is
30905 set to NULL if there is no error; it may be set non-NULL even when the function
30906 returns a non-NULL value if decoding was successful, but there was a problem
30907 with translation.
30908
30909
30910 .vitem &*int&~smtp_fflush(void)*&
30911 This function is used in conjunction with &'smtp_printf()'&, as described
30912 below.
30913
30914 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30915 The arguments of this function are like &[printf()]&; it writes to the SMTP
30916 output stream. You should use this function only when there is an SMTP output
30917 stream, that is, when the incoming message is being received via interactive
30918 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30919 is FALSE. If you want to test for an incoming message from another host (as
30920 opposed to a local process that used the &%-bs%& command line option), you can
30921 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30922 is involved.
30923
30924 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30925 output function, so it can be used for all forms of SMTP connection.
30926
30927 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30928 must start with an appropriate response code: 550 if you are going to return
30929 LOCAL_SCAN_REJECT, 451 if you are going to return
30930 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30931 initial lines of a multi-line response, the code must be followed by a hyphen
30932 to indicate that the line is not the final response line. You must also ensure
30933 that the lines you write terminate with CRLF. For example:
30934 .code
30935 smtp_printf("550-this is some extra info\r\n");
30936 return LOCAL_SCAN_REJECT;
30937 .endd
30938 Note that you can also create multi-line responses by including newlines in
30939 the data returned via the &%return_text%& argument. The added value of using
30940 &'smtp_printf()'& is that, for instance, you could introduce delays between
30941 multiple output lines.
30942
30943 The &'smtp_printf()'& function does not return any error indication, because it
30944 does not automatically flush pending output, and therefore does not test
30945 the state of the stream. (In the main code of Exim, flushing and error
30946 detection is done when Exim is ready for the next SMTP input command.) If
30947 you want to flush the output and check for an error (for example, the
30948 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30949 arguments. It flushes the output stream, and returns a non-zero value if there
30950 is an error.
30951
30952 .vitem &*void&~*store_get(int)*&
30953 This function accesses Exim's internal store (memory) manager. It gets a new
30954 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30955 runs out of memory. See the next section for a discussion of memory handling.
30956
30957 .vitem &*void&~*store_get_perm(int)*&
30958 This function is like &'store_get()'&, but it always gets memory from the
30959 permanent pool. See the next section for a discussion of memory handling.
30960
30961 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30962 See below.
30963
30964 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30965 See below.
30966
30967 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30968 These three functions create strings using Exim's dynamic memory facilities.
30969 The first makes a copy of an entire string. The second copies up to a maximum
30970 number of characters, indicated by the second argument. The third uses a format
30971 and insertion arguments to create a new string. In each case, the result is a
30972 pointer to a new string in the current memory pool. See the next section for
30973 more discussion.
30974 .endlist
30975
30976
30977
30978 .section "More about Exim's memory handling" "SECTmemhanloc"
30979 .cindex "&[local_scan()]& function" "memory handling"
30980 No function is provided for freeing memory, because that is never needed.
30981 The dynamic memory that Exim uses when receiving a message is automatically
30982 recycled if another message is received by the same process (this applies only
30983 to incoming SMTP connections &-- other input methods can supply only one
30984 message at a time). After receiving the last message, a reception process
30985 terminates.
30986
30987 Because it is recycled, the normal dynamic memory cannot be used for holding
30988 data that must be preserved over a number of incoming messages on the same SMTP
30989 connection. However, Exim in fact uses two pools of dynamic memory; the second
30990 one is not recycled, and can be used for this purpose.
30991
30992 If you want to allocate memory that remains available for subsequent messages
30993 in the same SMTP connection, you should set
30994 .code
30995 store_pool = POOL_PERM
30996 .endd
30997 before calling the function that does the allocation. There is no need to
30998 restore the value if you do not need to; however, if you do want to revert to
30999 the normal pool, you can either restore the previous value of &%store_pool%& or
31000 set it explicitly to POOL_MAIN.
31001
31002 The pool setting applies to all functions that get dynamic memory, including
31003 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31004 There is also a convenience function called &'store_get_perm()'& that gets a
31005 block of memory from the permanent pool while preserving the value of
31006 &%store_pool%&.
31007 .ecindex IIDlosca
31008
31009
31010
31011
31012 . ////////////////////////////////////////////////////////////////////////////
31013 . ////////////////////////////////////////////////////////////////////////////
31014
31015 .chapter "System-wide message filtering" "CHAPsystemfilter"
31016 .scindex IIDsysfil1 "filter" "system filter"
31017 .scindex IIDsysfil2 "filtering all mail"
31018 .scindex IIDsysfil3 "system filter"
31019 The previous chapters (on ACLs and the local scan function) describe checks
31020 that can be applied to messages before they are accepted by a host. There is
31021 also a mechanism for checking messages once they have been received, but before
31022 they are delivered. This is called the &'system filter'&.
31023
31024 The system filter operates in a similar manner to users' filter files, but it
31025 is run just once per message (however many recipients the message has).
31026 It should not normally be used as a substitute for routing, because &%deliver%&
31027 commands in a system router provide new envelope recipient addresses.
31028 The system filter must be an Exim filter. It cannot be a Sieve filter.
31029
31030 The system filter is run at the start of a delivery attempt, before any routing
31031 is done. If a message fails to be completely delivered at the first attempt,
31032 the system filter is run again at the start of every retry.
31033 If you want your filter to do something only once per message, you can make use
31034 of the &%first_delivery%& condition in an &%if%& command in the filter to
31035 prevent it happening on retries.
31036
31037 .vindex "&$domain$&"
31038 .vindex "&$local_part$&"
31039 &*Warning*&: Because the system filter runs just once, variables that are
31040 specific to individual recipient addresses, such as &$local_part$& and
31041 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31042 you want to run a centrally-specified filter for each recipient address
31043 independently, you can do so by setting up a suitable &(redirect)& router, as
31044 described in section &<<SECTperaddfil>>& below.
31045
31046
31047 .section "Specifying a system filter" "SECID212"
31048 .cindex "uid (user id)" "system filter"
31049 .cindex "gid (group id)" "system filter"
31050 The name of the file that contains the system filter must be specified by
31051 setting &%system_filter%&. If you want the filter to run under a uid and gid
31052 other than root, you must also set &%system_filter_user%& and
31053 &%system_filter_group%& as appropriate. For example:
31054 .code
31055 system_filter = /etc/mail/exim.filter
31056 system_filter_user = exim
31057 .endd
31058 If a system filter generates any deliveries directly to files or pipes (via the
31059 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31060 specified by setting &%system_filter_file_transport%& and
31061 &%system_filter_pipe_transport%&, respectively. Similarly,
31062 &%system_filter_reply_transport%& must be set to handle any messages generated
31063 by the &%reply%& command.
31064
31065
31066 .section "Testing a system filter" "SECID213"
31067 You can run simple tests of a system filter in the same way as for a user
31068 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31069 are permitted only in system filters are recognized.
31070
31071 If you want to test the combined effect of a system filter and a user filter,
31072 you can use both &%-bF%& and &%-bf%& on the same command line.
31073
31074
31075
31076 .section "Contents of a system filter" "SECID214"
31077 The language used to specify system filters is the same as for users' filter
31078 files. It is described in the separate end-user document &'Exim's interface to
31079 mail filtering'&. However, there are some additional features that are
31080 available only in system filters; these are described in subsequent sections.
31081 If they are encountered in a user's filter file or when testing with &%-bf%&,
31082 they cause errors.
31083
31084 .cindex "frozen messages" "manual thaw; testing in filter"
31085 There are two special conditions which, though available in users' filter
31086 files, are designed for use in system filters. The condition &%first_delivery%&
31087 is true only for the first attempt at delivering a message, and
31088 &%manually_thawed%& is true only if the message has been frozen, and
31089 subsequently thawed by an admin user. An explicit forced delivery counts as a
31090 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31091
31092 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31093 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31094 succeed, it will not be tried again.
31095 If you want Exim to retry an unseen delivery until it succeeds, you should
31096 arrange to set it up every time the filter runs.
31097
31098 When a system filter finishes running, the values of the variables &$n0$& &--
31099 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31100 users' filter files. Thus a system filter can, for example, set up &"scores"&
31101 to which users' filter files can refer.
31102
31103
31104
31105 .section "Additional variable for system filters" "SECID215"
31106 .vindex "&$recipients$&"
31107 The expansion variable &$recipients$&, containing a list of all the recipients
31108 of the message (separated by commas and white space), is available in system
31109 filters. It is not available in users' filters for privacy reasons.
31110
31111
31112
31113 .section "Defer, freeze, and fail commands for system filters" "SECID216"
31114 .cindex "freezing messages"
31115 .cindex "message" "freezing"
31116 .cindex "message" "forced failure"
31117 .cindex "&%fail%&" "in system filter"
31118 .cindex "&%freeze%& in system filter"
31119 .cindex "&%defer%& in system filter"
31120 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
31121 always available in system filters, but are not normally enabled in users'
31122 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
31123 for the &(redirect)& router.) These commands can optionally be followed by the
31124 word &%text%& and a string containing an error message, for example:
31125 .code
31126 fail text "this message looks like spam to me"
31127 .endd
31128 The keyword &%text%& is optional if the next character is a double quote.
31129
31130 The &%defer%& command defers delivery of the original recipients of the
31131 message. The &%fail%& command causes all the original recipients to be failed,
31132 and a bounce message to be created. The &%freeze%& command suspends all
31133 delivery attempts for the original recipients. In all cases, any new deliveries
31134 that are specified by the filter are attempted as normal after the filter has
31135 run.
31136
31137 The &%freeze%& command is ignored if the message has been manually unfrozen and
31138 not manually frozen since. This means that automatic freezing by a system
31139 filter can be used as a way of checking out suspicious messages. If a message
31140 is found to be all right, manually unfreezing it allows it to be delivered.
31141
31142 .cindex "log" "&%fail%& command log line"
31143 .cindex "&%fail%&" "log line; reducing"
31144 The text given with a fail command is used as part of the bounce message as
31145 well as being written to the log. If the message is quite long, this can fill
31146 up a lot of log space when such failures are common. To reduce the size of the
31147 log message, Exim interprets the text in a special way if it starts with the
31148 two characters &`<<`& and contains &`>>`& later. The text between these two
31149 strings is written to the log, and the rest of the text is used in the bounce
31150 message. For example:
31151 .code
31152 fail "<<filter test 1>>Your message is rejected \
31153      because it contains attachments that we are \
31154      not prepared to receive."
31155 .endd
31156
31157 .cindex "loop" "caused by &%fail%&"
31158 Take great care with the &%fail%& command when basing the decision to fail on
31159 the contents of the message, because the bounce message will of course include
31160 the contents of the original message and will therefore trigger the &%fail%&
31161 command again (causing a mail loop) unless steps are taken to prevent this.
31162 Testing the &%error_message%& condition is one way to prevent this. You could
31163 use, for example
31164 .code
31165 if $message_body contains "this is spam" and not error_message
31166 then fail text "spam is not wanted here" endif
31167 .endd
31168 though of course that might let through unwanted bounce messages. The
31169 alternative is clever checking of the body and/or headers to detect bounces
31170 generated by the filter.
31171
31172 The interpretation of a system filter file ceases after a
31173 &%defer%&,
31174 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31175 set up earlier in the filter file are honoured, so you can use a sequence such
31176 as
31177 .code
31178 mail ...
31179 freeze
31180 .endd
31181 to send a specified message when the system filter is freezing (or deferring or
31182 failing) a message. The normal deliveries for the message do not, of course,
31183 take place.
31184
31185
31186
31187 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31188 .cindex "header lines" "adding; in system filter"
31189 .cindex "header lines" "removing; in system filter"
31190 .cindex "filter" "header lines; adding/removing"
31191 Two filter commands that are available only in system filters are:
31192 .code
31193 headers add <string>
31194 headers remove <string>
31195 .endd
31196 The argument for the &%headers add%& is a string that is expanded and then
31197 added to the end of the message's headers. It is the responsibility of the
31198 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31199 space is ignored, and if the string is otherwise empty, or if the expansion is
31200 forced to fail, the command has no effect.
31201
31202 You can use &"\n"& within the string, followed by white space, to specify
31203 continued header lines. More than one header may be added in one command by
31204 including &"\n"& within the string without any following white space. For
31205 example:
31206 .code
31207 headers add "X-header-1: ....\n  \
31208              continuation of X-header-1 ...\n\
31209              X-header-2: ...."
31210 .endd
31211 Note that the header line continuation white space after the first newline must
31212 be placed before the backslash that continues the input string, because white
31213 space after input continuations is ignored.
31214
31215 The argument for &%headers remove%& is a colon-separated list of header names.
31216 This command applies only to those headers that are stored with the message;
31217 those that are added at delivery time (such as &'Envelope-To:'& and
31218 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31219 header with the same name, they are all removed.
31220
31221 The &%headers%& command in a system filter makes an immediate change to the set
31222 of header lines that was received with the message (with possible additions
31223 from ACL processing). Subsequent commands in the system filter operate on the
31224 modified set, which also forms the basis for subsequent message delivery.
31225 Unless further modified during routing or transporting, this set of headers is
31226 used for all recipients of the message.
31227
31228 During routing and transporting, the variables that refer to the contents of
31229 header lines refer only to those lines that are in this set. Thus, header lines
31230 that are added by a system filter are visible to users' filter files and to all
31231 routers and transports. This contrasts with the manipulation of header lines by
31232 routers and transports, which is not immediate, but which instead is saved up
31233 until the message is actually being written (see section
31234 &<<SECTheadersaddrem>>&).
31235
31236 If the message is not delivered at the first attempt, header lines that were
31237 added by the system filter are stored with the message, and so are still
31238 present at the next delivery attempt. Header lines that were removed are still
31239 present, but marked &"deleted"& so that they are not transported with the
31240 message. For this reason, it is usual to make the &%headers%& command
31241 conditional on &%first_delivery%& so that the set of header lines is not
31242 modified more than once.
31243
31244 Because header modification in a system filter acts immediately, you have to
31245 use an indirect approach if you want to modify the contents of a header line.
31246 For example:
31247 .code
31248 headers add "Old-Subject: $h_subject:"
31249 headers remove "Subject"
31250 headers add "Subject: new subject (was: $h_old-subject:)"
31251 headers remove "Old-Subject"
31252 .endd
31253
31254
31255
31256 .section "Setting an errors address in a system filter" "SECID217"
31257 .cindex "envelope sender"
31258 In a system filter, if a &%deliver%& command is followed by
31259 .code
31260 errors_to <some address>
31261 .endd
31262 in order to change the envelope sender (and hence the error reporting) for that
31263 delivery, any address may be specified. (In a user filter, only the current
31264 user's address can be set.) For example, if some mail is being monitored, you
31265 might use
31266 .code
31267 unseen deliver monitor@spying.example errors_to root@local.example
31268 .endd
31269 to take a copy which would not be sent back to the normal error reporting
31270 address if its delivery failed.
31271
31272
31273
31274 .section "Per-address filtering" "SECTperaddfil"
31275 .vindex "&$domain$&"
31276 .vindex "&$local_part$&"
31277 In contrast to the system filter, which is run just once per message for each
31278 delivery attempt, it is also possible to set up a system-wide filtering
31279 operation that runs once for each recipient address. In this case, variables
31280 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
31281 filter file could be made dependent on them. This is an example of a router
31282 which implements such a filter:
31283 .code
31284 central_filter:
31285   check_local_user
31286   driver = redirect
31287   domains = +local_domains
31288   file = /central/filters/$local_part
31289   no_verify
31290   allow_filter
31291   allow_freeze
31292 .endd
31293 The filter is run in a separate process under its own uid. Therefore, either
31294 &%check_local_user%& must be set (as above), in which case the filter is run as
31295 the local user, or the &%user%& option must be used to specify which user to
31296 use. If both are set, &%user%& overrides.
31297
31298 Care should be taken to ensure that none of the commands in the filter file
31299 specify a significant delivery if the message is to go on to be delivered to
31300 its intended recipient. The router will not then claim to have dealt with the
31301 address, so it will be passed on to subsequent routers to be delivered in the
31302 normal way.
31303 .ecindex IIDsysfil1
31304 .ecindex IIDsysfil2
31305 .ecindex IIDsysfil3
31306
31307
31308
31309
31310
31311
31312 . ////////////////////////////////////////////////////////////////////////////
31313 . ////////////////////////////////////////////////////////////////////////////
31314
31315 .chapter "Message processing" "CHAPmsgproc"
31316 .scindex IIDmesproc "message" "general processing"
31317 Exim performs various transformations on the sender and recipient addresses of
31318 all messages that it handles, and also on the messages' header lines. Some of
31319 these are optional and configurable, while others always take place. All of
31320 this processing, except rewriting as a result of routing, and the addition or
31321 removal of header lines while delivering, happens when a message is received,
31322 before it is placed on Exim's queue.
31323
31324 Some of the automatic processing takes place by default only for
31325 &"locally-originated"& messages. This adjective is used to describe messages
31326 that are not received over TCP/IP, but instead are passed to an Exim process on
31327 its standard input. This includes the interactive &"local SMTP"& case that is
31328 set up by the &%-bs%& command line option.
31329
31330 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
31331 or ::1) are not considered to be locally-originated. Exim does not treat the
31332 loopback interface specially in any way.
31333
31334 If you want the loopback interface to be treated specially, you must ensure
31335 that there are appropriate entries in your ACLs.
31336
31337
31338
31339
31340 .section "Submission mode for non-local messages" "SECTsubmodnon"
31341 .cindex "message" "submission"
31342 .cindex "submission mode"
31343 Processing that happens automatically for locally-originated messages (unless
31344 &%suppress_local_fixups%& is set) can also be requested for messages that are
31345 received over TCP/IP. The term &"submission mode"& is used to describe this
31346 state. Submission mode is set by the modifier
31347 .code
31348 control = submission
31349 .endd
31350 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
31351 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
31352 a local submission, and is normally used when the source of the message is
31353 known to be an MUA running on a client host (as opposed to an MTA). For
31354 example, to set submission mode for messages originating on the IPv4 loopback
31355 interface, you could include the following in the MAIL ACL:
31356 .code
31357 warn  hosts = 127.0.0.1
31358       control = submission
31359 .endd
31360 .cindex "&%sender_retain%& submission option"
31361 There are some options that can be used when setting submission mode. A slash
31362 is used to separate options. For example:
31363 .code
31364 control = submission/sender_retain
31365 .endd
31366 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
31367 true and &%local_from_check%& false for the current incoming message. The first
31368 of these allows an existing &'Sender:'& header in the message to remain, and
31369 the second suppresses the check to ensure that &'From:'& matches the
31370 authenticated sender. With this setting, Exim still fixes up messages by adding
31371 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
31372 attempt to check sender authenticity in header lines.
31373
31374 When &%sender_retain%& is not set, a submission mode setting may specify a
31375 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
31376 example:
31377 .code
31378 control = submission/domain=some.domain
31379 .endd
31380 The domain may be empty. How this value is used is described in sections
31381 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
31382 that allows you to specify the user's full name for inclusion in a created
31383 &'Sender:'& or &'From:'& header line. For example:
31384 .code
31385 accept authenticated = *
31386        control = submission/domain=wonderland.example/\
31387                             name=${lookup {$authenticated_id} \
31388                                    lsearch {/etc/exim/namelist}}
31389 .endd
31390 Because the name may contain any characters, including slashes, the &%name%&
31391 option must be given last. The remainder of the string is used as the name. For
31392 the example above, if &_/etc/exim/namelist_& contains:
31393 .code
31394 bigegg:  Humpty Dumpty
31395 .endd
31396 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
31397 line would be:
31398 .code
31399 Sender: Humpty Dumpty <bigegg@wonderland.example>
31400 .endd
31401 .cindex "return path" "in submission mode"
31402 By default, submission mode forces the return path to the same address as is
31403 used to create the &'Sender:'& header. However, if &%sender_retain%& is
31404 specified, the return path is also left unchanged.
31405
31406 &*Note*&: The changes caused by submission mode take effect after the predata
31407 ACL. This means that any sender checks performed before the fix-ups use the
31408 untrusted sender address specified by the user, not the trusted sender address
31409 specified by submission mode. Although this might be slightly unexpected, it
31410 does mean that you can configure ACL checks to spot that a user is trying to
31411 spoof another's address.
31412
31413 .section "Line endings" "SECTlineendings"
31414 .cindex "line endings"
31415 .cindex "carriage return"
31416 .cindex "linefeed"
31417 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
31418 linefeed) is the line ending for messages transmitted over the Internet using
31419 SMTP over TCP/IP. However, within individual operating systems, different
31420 conventions are used. For example, Unix-like systems use just LF, but others
31421 use CRLF or just CR.
31422
31423 Exim was designed for Unix-like systems, and internally, it stores messages
31424 using the system's convention of a single LF as a line terminator. When
31425 receiving a message, all line endings are translated to this standard format.
31426 Originally, it was thought that programs that passed messages directly to an
31427 MTA within an operating system would use that system's convention. Experience
31428 has shown that this is not the case; for example, there are Unix applications
31429 that use CRLF in this circumstance. For this reason, and for compatibility with
31430 other MTAs, the way Exim handles line endings for all messages is now as
31431 follows:
31432
31433 .ilist
31434 LF not preceded by CR is treated as a line ending.
31435 .next
31436 CR is treated as a line ending; if it is immediately followed by LF, the LF
31437 is ignored.
31438 .next
31439 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
31440 nor a local message in the state where a line containing only a dot is a
31441 terminator.
31442 .next
31443 If a bare CR is encountered within a header line, an extra space is added after
31444 the line terminator so as not to end the header line. The reasoning behind this
31445 is that bare CRs in header lines are most likely either to be mistakes, or
31446 people trying to play silly games.
31447 .next
31448 If the first header line received in a message ends with CRLF, a subsequent
31449 bare LF in a header line is treated in the same way as a bare CR in a header
31450 line.
31451 .endlist
31452
31453
31454
31455
31456
31457 .section "Unqualified addresses" "SECID218"
31458 .cindex "unqualified addresses"
31459 .cindex "address" "qualification"
31460 By default, Exim expects every envelope address it receives from an external
31461 host to be fully qualified. Unqualified addresses cause negative responses to
31462 SMTP commands. However, because SMTP is used as a means of transporting
31463 messages from MUAs running on personal workstations, there is sometimes a
31464 requirement to accept unqualified addresses from specific hosts or IP networks.
31465
31466 Exim has two options that separately control which hosts may send unqualified
31467 sender or recipient addresses in SMTP commands, namely
31468 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
31469 cases, if an unqualified address is accepted, it is qualified by adding the
31470 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
31471
31472 .oindex "&%qualify_domain%&"
31473 .oindex "&%qualify_recipient%&"
31474 Unqualified addresses in header lines are automatically qualified for messages
31475 that are locally originated, unless the &%-bnq%& option is given on the command
31476 line. For messages received over SMTP, unqualified addresses in header lines
31477 are qualified only if unqualified addresses are permitted in SMTP commands. In
31478 other words, such qualification is also controlled by
31479 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
31480
31481
31482
31483
31484 .section "The UUCP From line" "SECID219"
31485 .cindex "&""From""& line"
31486 .cindex "UUCP" "&""From""& line"
31487 .cindex "sender" "address"
31488 .oindex "&%uucp_from_pattern%&"
31489 .oindex "&%uucp_from_sender%&"
31490 .cindex "envelope sender"
31491 .cindex "Sendmail compatibility" "&""From""& line"
31492 Messages that have come from UUCP (and some other applications) often begin
31493 with a line containing the envelope sender and a timestamp, following the word
31494 &"From"&. Examples of two common formats are:
31495 .code
31496 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
31497 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
31498 .endd
31499 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
31500 Exim recognizes such lines at the start of messages that are submitted to it
31501 via the command line (that is, on the standard input). It does not recognize
31502 such lines in incoming SMTP messages, unless the sending host matches
31503 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
31504 and &%ignore_fromline_local%& is set. The recognition is controlled by a
31505 regular expression that is defined by the &%uucp_from_pattern%& option, whose
31506 default value matches the two common cases shown above and puts the address
31507 that follows &"From"& into &$1$&.
31508
31509 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
31510 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
31511 a trusted user, the message's sender address is constructed by expanding the
31512 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
31513 then parsed as an RFC 2822 address. If there is no domain, the local part is
31514 qualified with &%qualify_domain%& unless it is the empty string. However, if
31515 the command line &%-f%& option is used, it overrides the &"From"& line.
31516
31517 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
31518 sender address is not changed. This is also the case for incoming SMTP messages
31519 that are permitted to contain &"From"& lines.
31520
31521 Only one &"From"& line is recognized. If there is more than one, the second is
31522 treated as a data line that starts the body of the message, as it is not valid
31523 as a header line. This also happens if a &"From"& line is present in an
31524 incoming SMTP message from a source that is not permitted to send them.
31525
31526
31527
31528 .section "Resent- header lines" "SECID220"
31529 .cindex "&%Resent-%& header lines"
31530 RFC 2822 makes provision for sets of header lines starting with the string
31531 &`Resent-`& to be added to a message when it is resent by the original
31532 recipient to somebody else. These headers are &'Resent-Date:'&,
31533 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
31534 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
31535
31536 .blockquote
31537 &'Resent fields are strictly informational. They MUST NOT be used in the normal
31538 processing of replies or other such automatic actions on messages.'&
31539 .endblockquote
31540
31541 This leaves things a bit vague as far as other processing actions such as
31542 address rewriting are concerned. Exim treats &%Resent-%& header lines as
31543 follows:
31544
31545 .ilist
31546 A &'Resent-From:'& line that just contains the login id of the submitting user
31547 is automatically rewritten in the same way as &'From:'& (see below).
31548 .next
31549 If there's a rewriting rule for a particular header line, it is also applied to
31550 &%Resent-%& header lines of the same type. For example, a rule that rewrites
31551 &'From:'& also rewrites &'Resent-From:'&.
31552 .next
31553 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
31554 also removed.
31555 .next
31556 For a locally-submitted message,
31557 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
31558 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
31559 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
31560 included in log lines in this case.
31561 .next
31562 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
31563 &%Resent-%& header lines are present.
31564 .endlist
31565
31566
31567
31568
31569 .section "The Auto-Submitted: header line" "SECID221"
31570 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
31571 includes the header line:
31572 .code
31573 Auto-Submitted: auto-replied
31574 .endd
31575
31576 .section "The Bcc: header line" "SECID222"
31577 .cindex "&'Bcc:'& header line"
31578 If Exim is called with the &%-t%& option, to take recipient addresses from a
31579 message's header, it removes any &'Bcc:'& header line that may exist (after
31580 extracting its addresses). If &%-t%& is not present on the command line, any
31581 existing &'Bcc:'& is not removed.
31582
31583
31584 .section "The Date: header line" "SECID223"
31585 .cindex "&'Date:'& header line"
31586 If a locally-generated or submission-mode message has no &'Date:'& header line,
31587 Exim adds one, using the current date and time, unless the
31588 &%suppress_local_fixups%& control has been specified.
31589
31590 .section "The Delivery-date: header line" "SECID224"
31591 .cindex "&'Delivery-date:'& header line"
31592 .oindex "&%delivery_date_remove%&"
31593 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
31594 set. Exim can be configured to add them to the final delivery of messages. (See
31595 the generic &%delivery_date_add%& transport option.) They should not be present
31596 in messages in transit. If the &%delivery_date_remove%& configuration option is
31597 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
31598 messages.
31599
31600
31601 .section "The Envelope-to: header line" "SECID225"
31602 .cindex "&'Envelope-to:'& header line"
31603 .oindex "&%envelope_to_remove%&"
31604 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
31605 Exim can be configured to add them to the final delivery of messages. (See the
31606 generic &%envelope_to_add%& transport option.) They should not be present in
31607 messages in transit. If the &%envelope_to_remove%& configuration option is set
31608 (the default), Exim removes &'Envelope-to:'& header lines from incoming
31609 messages.
31610
31611
31612 .section "The From: header line" "SECTthefrohea"
31613 .cindex "&'From:'& header line"
31614 .cindex "Sendmail compatibility" "&""From""& line"
31615 .cindex "message" "submission"
31616 .cindex "submission mode"
31617 If a submission-mode message does not contain a &'From:'& header line, Exim
31618 adds one if either of the following conditions is true:
31619
31620 .ilist
31621 The envelope sender address is not empty (that is, this is not a bounce
31622 message). The added header line copies the envelope sender address.
31623 .next
31624 .vindex "&$authenticated_id$&"
31625 The SMTP session is authenticated and &$authenticated_id$& is not empty.
31626 .olist
31627 .vindex "&$qualify_domain$&"
31628 If no domain is specified by the submission control, the local part is
31629 &$authenticated_id$& and the domain is &$qualify_domain$&.
31630 .next
31631 If a non-empty domain is specified by the submission control, the local
31632 part is &$authenticated_id$&, and the domain is the specified domain.
31633 .next
31634 If an empty domain is specified by the submission control,
31635 &$authenticated_id$& is assumed to be the complete address.
31636 .endlist
31637 .endlist
31638
31639 A non-empty envelope sender takes precedence.
31640
31641 If a locally-generated incoming message does not contain a &'From:'& header
31642 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
31643 containing the sender's address. The calling user's login name and full name
31644 are used to construct the address, as described in section &<<SECTconstr>>&.
31645 They are obtained from the password data by calling &[getpwuid()]& (but see the
31646 &%unknown_login%& configuration option). The address is qualified with
31647 &%qualify_domain%&.
31648
31649 For compatibility with Sendmail, if an incoming, non-SMTP message has a
31650 &'From:'& header line containing just the unqualified login name of the calling
31651 user, this is replaced by an address containing the user's login name and full
31652 name as described in section &<<SECTconstr>>&.
31653
31654
31655 .section "The Message-ID: header line" "SECID226"
31656 .cindex "&'Message-ID:'& header line"
31657 .cindex "message" "submission"
31658 .oindex "&%message_id_header_text%&"
31659 If a locally-generated or submission-mode incoming message does not contain a
31660 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
31661 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
31662 to the message. If there are any &'Resent-:'& headers in the message, it
31663 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
31664 message id, preceded by the letter E to ensure it starts with a letter, and
31665 followed by @ and the primary host name. Additional information can be included
31666 in this header line by setting the &%message_id_header_text%& and/or
31667 &%message_id_header_domain%& options.
31668
31669
31670 .section "The Received: header line" "SECID227"
31671 .cindex "&'Received:'& header line"
31672 A &'Received:'& header line is added at the start of every message. The
31673 contents are defined by the &%received_header_text%& configuration option, and
31674 Exim automatically adds a semicolon and a timestamp to the configured string.
31675
31676 The &'Received:'& header is generated as soon as the message's header lines
31677 have been received. At this stage, the timestamp in the &'Received:'& header
31678 line is the time that the message started to be received. This is the value
31679 that is seen by the DATA ACL and by the &[local_scan()]& function.
31680
31681 Once a message is accepted, the timestamp in the &'Received:'& header line is
31682 changed to the time of acceptance, which is (apart from a small delay while the
31683 -H spool file is written) the earliest time at which delivery could start.
31684
31685
31686 .section "The References: header line" "SECID228"
31687 .cindex "&'References:'& header line"
31688 Messages created by the &(autoreply)& transport include a &'References:'&
31689 header line. This is constructed according to the rules that are described in
31690 section 3.64 of RFC 2822 (which states that replies should contain such a
31691 header line), and section 3.14 of RFC 3834 (which states that automatic
31692 responses are not different in this respect). However, because some mail
31693 processing software does not cope well with very long header lines, no more
31694 than 12 message IDs are copied from the &'References:'& header line in the
31695 incoming message. If there are more than 12, the first one and then the final
31696 11 are copied, before adding the message ID of the incoming message.
31697
31698
31699
31700 .section "The Return-path: header line" "SECID229"
31701 .cindex "&'Return-path:'& header line"
31702 .oindex "&%return_path_remove%&"
31703 &'Return-path:'& header lines are defined as something an MTA may insert when
31704 it does the final delivery of messages. (See the generic &%return_path_add%&
31705 transport option.) Therefore, they should not be present in messages in
31706 transit. If the &%return_path_remove%& configuration option is set (the
31707 default), Exim removes &'Return-path:'& header lines from incoming messages.
31708
31709
31710
31711 .section "The Sender: header line" "SECTthesenhea"
31712 .cindex "&'Sender:'& header line"
31713 .cindex "message" "submission"
31714 For a locally-originated message from an untrusted user, Exim may remove an
31715 existing &'Sender:'& header line, and it may add a new one. You can modify
31716 these actions by setting the &%local_sender_retain%& option true, the
31717 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31718 control setting.
31719
31720 When a local message is received from an untrusted user and
31721 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31722 control has not been set, a check is made to see if the address given in the
31723 &'From:'& header line is the correct (local) sender of the message. The address
31724 that is expected has the login name as the local part and the value of
31725 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31726 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31727 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31728 line is added to the message.
31729
31730 If you set &%local_from_check%& false, this checking does not occur. However,
31731 the removal of an existing &'Sender:'& line still happens, unless you also set
31732 &%local_sender_retain%& to be true. It is not possible to set both of these
31733 options true at the same time.
31734
31735 .cindex "submission mode"
31736 By default, no processing of &'Sender:'& header lines is done for messages
31737 received over TCP/IP or for messages submitted by trusted users. However, when
31738 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31739 not specified on the submission control, the following processing takes place:
31740
31741 .vindex "&$authenticated_id$&"
31742 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31743 authenticated, and &$authenticated_id$& is not empty, a sender address is
31744 created as follows:
31745
31746 .ilist
31747 .vindex "&$qualify_domain$&"
31748 If no domain is specified by the submission control, the local part is
31749 &$authenticated_id$& and the domain is &$qualify_domain$&.
31750 .next
31751 If a non-empty domain is specified by the submission control, the local part
31752 is &$authenticated_id$&, and the domain is the specified domain.
31753 .next
31754 If an empty domain is specified by the submission control,
31755 &$authenticated_id$& is assumed to be the complete address.
31756 .endlist
31757
31758 This address is compared with the address in the &'From:'& header line. If they
31759 are different, a &'Sender:'& header line containing the created address is
31760 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31761 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31762
31763 .cindex "return path" "created from &'Sender:'&"
31764 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31765 the message (the envelope sender address) is changed to be the same address,
31766 except in the case of submission mode when &%sender_retain%& is specified.
31767
31768
31769
31770 .section "Adding and removing header lines in routers and transports" &&&
31771          "SECTheadersaddrem"
31772 .cindex "header lines" "adding; in router or transport"
31773 .cindex "header lines" "removing; in router or transport"
31774 When a message is delivered, the addition and removal of header lines can be
31775 specified in a system filter, or on any of the routers and transports that
31776 process the message. Section &<<SECTaddremheasys>>& contains details about
31777 modifying headers in a system filter. Header lines can also be added in an ACL
31778 as a message is received (see section &<<SECTaddheadacl>>&).
31779
31780 In contrast to what happens in a system filter, header modifications that are
31781 specified on routers and transports apply only to the particular recipient
31782 addresses that are being processed by those routers and transports. These
31783 changes do not actually take place until a copy of the message is being
31784 transported. Therefore, they do not affect the basic set of header lines, and
31785 they do not affect the values of the variables that refer to header lines.
31786
31787 &*Note*&: In particular, this means that any expansions in the configuration of
31788 the transport cannot refer to the modified header lines, because such
31789 expansions all occur before the message is actually transported.
31790
31791 For both routers and transports, the result of expanding a &%headers_add%&
31792 option must be in the form of one or more RFC 2822 header lines, separated by
31793 newlines (coded as &"\n"&). For example:
31794 .code
31795 headers_add = X-added-header: added by $primary_hostname\n\
31796               X-added-second: another added header line
31797 .endd
31798 Exim does not check the syntax of these added header lines.
31799
31800 Multiple &%headers_add%& options for a single router or transport can be
31801 specified; the values will be concatenated (with a separating newline
31802 added) before expansion.
31803
31804 The result of expanding &%headers_remove%& must consist of a colon-separated
31805 list of header names. This is confusing, because header names themselves are
31806 often terminated by colons. In this case, the colons are the list separators,
31807 not part of the names. For example:
31808 .code
31809 headers_remove = return-receipt-to:acknowledge-to
31810 .endd
31811
31812 Multiple &%headers_remove%& options for a single router or transport can be
31813 specified; the values will be concatenated (with a separating colon
31814 added) before expansion.
31815
31816 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31817 is expanded at routing time, and then associated with all addresses that are
31818 accepted by that router, and also with any new addresses that it generates. If
31819 an address passes through several routers as a result of aliasing or
31820 forwarding, the changes are cumulative.
31821
31822 .oindex "&%unseen%&"
31823 However, this does not apply to multiple routers that result from the use of
31824 the &%unseen%& option. Any header modifications that were specified by the
31825 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31826
31827 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31828 settings cannot be delivered together in a batch, so a transport is always
31829 dealing with a set of addresses that have the same header-processing
31830 requirements.
31831
31832 The transport starts by writing the original set of header lines that arrived
31833 with the message, possibly modified by the system filter. As it writes out
31834 these lines, it consults the list of header names that were attached to the
31835 recipient address(es) by &%headers_remove%& options in routers, and it also
31836 consults the transport's own &%headers_remove%& option. Header lines whose
31837 names are on either of these lists are not written out. If there are multiple
31838 instances of any listed header, they are all skipped.
31839
31840 After the remaining original header lines have been written, new header
31841 lines that were specified by routers' &%headers_add%& options are written, in
31842 the order in which they were attached to the address. These are followed by any
31843 header lines specified by the transport's &%headers_add%& option.
31844
31845 This way of handling header line modifications in routers and transports has
31846 the following consequences:
31847
31848 .ilist
31849 The original set of header lines, possibly modified by the system filter,
31850 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31851 to it, at all times.
31852 .next
31853 Header lines that are added by a router's
31854 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31855 expansion syntax in subsequent routers or the transport.
31856 .next
31857 Conversely, header lines that are specified for removal by &%headers_remove%&
31858 in a router remain visible to subsequent routers and the transport.
31859 .next
31860 Headers added to an address by &%headers_add%& in a router cannot be removed by
31861 a later router or by a transport.
31862 .next
31863 An added header can refer to the contents of an original header that is to be
31864 removed, even it has the same name as the added header. For example:
31865 .code
31866 headers_remove = subject
31867 headers_add = Subject: new subject (was: $h_subject:)
31868 .endd
31869 .endlist
31870
31871 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31872 for a &(redirect)& router that has the &%one_time%& option set.
31873
31874
31875
31876
31877
31878 .section "Constructed addresses" "SECTconstr"
31879 .cindex "address" "constructed"
31880 .cindex "constructed address"
31881 When Exim constructs a sender address for a locally-generated message, it uses
31882 the form
31883 .display
31884 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31885 .endd
31886 For example:
31887 .code
31888 Zaphod Beeblebrox <zaphod@end.univ.example>
31889 .endd
31890 The user name is obtained from the &%-F%& command line option if set, or
31891 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31892 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31893 ampersand character, this is replaced by the login name with the first letter
31894 upper cased, as is conventional in a number of operating systems. See the
31895 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31896 The &%unknown_username%& option can be used to specify user names in cases when
31897 there is no password file entry.
31898
31899 .cindex "RFC 2047"
31900 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31901 parts of it if necessary. In addition, if it contains any non-printing
31902 characters, it is encoded as described in RFC 2047, which defines a way of
31903 including non-ASCII characters in header lines. The value of the
31904 &%headers_charset%& option specifies the name of the encoding that is used (the
31905 characters are assumed to be in this encoding). The setting of
31906 &%print_topbitchars%& controls whether characters with the top bit set (that
31907 is, with codes greater than 127) count as printing characters or not.
31908
31909
31910
31911 .section "Case of local parts" "SECID230"
31912 .cindex "case of local parts"
31913 .cindex "local part" "case of"
31914 RFC 2822 states that the case of letters in the local parts of addresses cannot
31915 be assumed to be non-significant. Exim preserves the case of local parts of
31916 addresses, but by default it uses a lower-cased form when it is routing,
31917 because on most Unix systems, usernames are in lower case and case-insensitive
31918 routing is required. However, any particular router can be made to use the
31919 original case for local parts by setting the &%caseful_local_part%& generic
31920 router option.
31921
31922 .cindex "mixed-case login names"
31923 If you must have mixed-case user names on your system, the best way to proceed,
31924 assuming you want case-independent handling of incoming email, is to set up
31925 your first router to convert incoming local parts in your domains to the
31926 correct case by means of a file lookup. For example:
31927 .code
31928 correct_case:
31929   driver = redirect
31930   domains = +local_domains
31931   data = ${lookup{$local_part}cdb\
31932               {/etc/usercased.cdb}{$value}fail}\
31933               @$domain
31934 .endd
31935 For this router, the local part is forced to lower case by the default action
31936 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31937 up a new local part in the correct case. If you then set &%caseful_local_part%&
31938 on any subsequent routers which process your domains, they will operate on
31939 local parts with the correct case in a case-sensitive manner.
31940
31941
31942
31943 .section "Dots in local parts" "SECID231"
31944 .cindex "dot" "in local part"
31945 .cindex "local part" "dots in"
31946 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31947 part may not begin or end with a dot, nor have two consecutive dots in the
31948 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31949 empty components for compatibility.
31950
31951
31952
31953 .section "Rewriting addresses" "SECID232"
31954 .cindex "rewriting" "addresses"
31955 Rewriting of sender and recipient addresses, and addresses in headers, can
31956 happen automatically, or as the result of configuration options, as described
31957 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31958 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31959
31960 Automatic rewriting includes qualification, as mentioned above. The other case
31961 in which it can happen is when an incomplete non-local domain is given. The
31962 routing process may cause this to be expanded into the full domain name. For
31963 example, a header such as
31964 .code
31965 To: hare@teaparty
31966 .endd
31967 might get rewritten as
31968 .code
31969 To: hare@teaparty.wonderland.fict.example
31970 .endd
31971 Rewriting as a result of routing is the one kind of message processing that
31972 does not happen at input time, as it cannot be done until the address has
31973 been routed.
31974
31975 Strictly, one should not do &'any'& deliveries of a message until all its
31976 addresses have been routed, in case any of the headers get changed as a
31977 result of routing. However, doing this in practice would hold up many
31978 deliveries for unreasonable amounts of time, just because one address could not
31979 immediately be routed. Exim therefore does not delay other deliveries when
31980 routing of one or more addresses is deferred.
31981 .ecindex IIDmesproc
31982
31983
31984
31985 . ////////////////////////////////////////////////////////////////////////////
31986 . ////////////////////////////////////////////////////////////////////////////
31987
31988 .chapter "SMTP processing" "CHAPSMTP"
31989 .scindex IIDsmtpproc1 "SMTP" "processing details"
31990 .scindex IIDsmtpproc2 "LMTP" "processing details"
31991 Exim supports a number of different ways of using the SMTP protocol, and its
31992 LMTP variant, which is an interactive protocol for transferring messages into a
31993 closed mail store application. This chapter contains details of how SMTP is
31994 processed. For incoming mail, the following are available:
31995
31996 .ilist
31997 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31998 .next
31999 SMTP over the standard input and output (the &%-bs%& option);
32000 .next
32001 Batched SMTP on the standard input (the &%-bS%& option).
32002 .endlist
32003
32004 For mail delivery, the following are available:
32005
32006 .ilist
32007 SMTP over TCP/IP (the &(smtp)& transport);
32008 .next
32009 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32010 &"lmtp"&);
32011 .next
32012 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32013 transport);
32014 .next
32015 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32016 the &%use_bsmtp%& option set).
32017 .endlist
32018
32019 &'Batched SMTP'& is the name for a process in which batches of messages are
32020 stored in or read from files (or pipes), in a format in which SMTP commands are
32021 used to contain the envelope information.
32022
32023
32024
32025 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32026 .cindex "SMTP" "outgoing over TCP/IP"
32027 .cindex "outgoing SMTP over TCP/IP"
32028 .cindex "LMTP" "over TCP/IP"
32029 .cindex "outgoing LMTP over TCP/IP"
32030 .cindex "EHLO"
32031 .cindex "HELO"
32032 .cindex "SIZE option on MAIL command"
32033 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32034 The &%protocol%& option selects which protocol is to be used, but the actual
32035 processing is the same in both cases.
32036
32037 If, in response to its EHLO command, Exim is told that the SIZE
32038 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32039 command. The value of <&'n'&> is the message size plus the value of the
32040 &%size_addition%& option (default 1024) to allow for additions to the message
32041 such as per-transport header lines, or changes made in a
32042 .cindex "transport" "filter"
32043 .cindex "filter" "transport filter"
32044 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32045 suppressed.
32046
32047 If the remote server advertises support for PIPELINING, Exim uses the
32048 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32049 required for the transaction.
32050
32051 If the remote server advertises support for the STARTTLS command, and Exim
32052 was built to support TLS encryption, it tries to start a TLS session unless the
32053 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32054 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32055 is called for verification.
32056
32057 If the remote server advertises support for the AUTH command, Exim scans
32058 the authenticators configuration for any suitable client settings, as described
32059 in chapter &<<CHAPSMTPAUTH>>&.
32060
32061 .cindex "carriage return"
32062 .cindex "linefeed"
32063 Responses from the remote host are supposed to be terminated by CR followed by
32064 LF. However, there are known to be hosts that do not send CR characters, so in
32065 order to be able to interwork with such hosts, Exim treats LF on its own as a
32066 line terminator.
32067
32068 If a message contains a number of different addresses, all those with the same
32069 characteristics (for example, the same envelope sender) that resolve to the
32070 same set of hosts, in the same order, are sent in a single SMTP transaction,
32071 even if they are for different domains, unless there are more than the setting
32072 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32073 they are split into groups containing no more than &%max_rcpt%&s addresses
32074 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32075 in parallel sessions. The order of hosts with identical MX values is not
32076 significant when checking whether addresses can be batched in this way.
32077
32078 When the &(smtp)& transport suffers a temporary failure that is not
32079 message-related, Exim updates its transport-specific database, which contains
32080 records indexed by host name that remember which messages are waiting for each
32081 particular host. It also updates the retry database with new retry times.
32082
32083 .cindex "hints database" "retry keys"
32084 Exim's retry hints are based on host name plus IP address, so if one address of
32085 a multi-homed host is broken, it will soon be skipped most of the time.
32086 See the next section for more detail about error handling.
32087
32088 .cindex "SMTP" "passed connection"
32089 .cindex "SMTP" "batching over TCP/IP"
32090 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32091 looks in the hints database for the transport to see if there are any queued
32092 messages waiting for the host to which it is connected. If it finds one, it
32093 creates a new Exim process using the &%-MC%& option (which can only be used by
32094 a process running as root or the Exim user) and passes the TCP/IP socket to it
32095 so that it can deliver another message using the same socket. The new process
32096 does only those deliveries that are routed to the connected host, and may in
32097 turn pass the socket on to a third process, and so on.
32098
32099 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32100 limit the number of messages sent down a single TCP/IP connection.
32101
32102 .cindex "asterisk" "after IP address"
32103 The second and subsequent messages delivered down an existing connection are
32104 identified in the main log by the addition of an asterisk after the closing
32105 square bracket of the IP address.
32106
32107
32108
32109
32110 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
32111 .cindex "error" "in outgoing SMTP"
32112 .cindex "SMTP" "errors in outgoing"
32113 .cindex "host" "error"
32114 Three different kinds of error are recognized for outgoing SMTP: host errors,
32115 message errors, and recipient errors.
32116
32117 .vlist
32118 .vitem "&*Host errors*&"
32119 A host error is not associated with a particular message or with a
32120 particular recipient of a message. The host errors are:
32121
32122 .ilist
32123 Connection refused or timed out,
32124 .next
32125 Any error response code on connection,
32126 .next
32127 Any error response code to EHLO or HELO,
32128 .next
32129 Loss of connection at any time, except after &"."&,
32130 .next
32131 I/O errors at any time,
32132 .next
32133 Timeouts during the session, other than in response to MAIL, RCPT or
32134 the &"."& at the end of the data.
32135 .endlist ilist
32136
32137 For a host error, a permanent error response on connection, or in response to
32138 EHLO, causes all addresses routed to the host to be failed. Any other host
32139 error causes all addresses to be deferred, and retry data to be created for the
32140 host. It is not tried again, for any message, until its retry time arrives. If
32141 the current set of addresses are not all delivered in this run (to some
32142 alternative host), the message is added to the list of those waiting for this
32143 host, so if it is still undelivered when a subsequent successful delivery is
32144 made to the host, it will be sent down the same SMTP connection.
32145
32146 .vitem "&*Message errors*&"
32147 .cindex "message" "error"
32148 A message error is associated with a particular message when sent to a
32149 particular host, but not with a particular recipient of the message. The
32150 message errors are:
32151
32152 .ilist
32153 Any error response code to MAIL, DATA, or the &"."& that terminates
32154 the data,
32155 .next
32156 Timeout after MAIL,
32157 .next
32158 Timeout or loss of connection after the &"."& that terminates the data. A
32159 timeout after the DATA command itself is treated as a host error, as is loss of
32160 connection at any other time.
32161 .endlist ilist
32162
32163 For a message error, a permanent error response (5&'xx'&) causes all addresses
32164 to be failed, and a delivery error report to be returned to the sender. A
32165 temporary error response (4&'xx'&), or one of the timeouts, causes all
32166 addresses to be deferred. Retry data is not created for the host, but instead,
32167 a retry record for the combination of host plus message id is created. The
32168 message is not added to the list of those waiting for this host. This ensures
32169 that the failing message will not be sent to this host again until the retry
32170 time arrives. However, other messages that are routed to the host are not
32171 affected, so if it is some property of the message that is causing the error,
32172 it will not stop the delivery of other mail.
32173
32174 If the remote host specified support for the SIZE parameter in its response
32175 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32176 over-large message will cause a message error because the error arrives as a
32177 response to MAIL.
32178
32179 .vitem "&*Recipient errors*&"
32180 .cindex "recipient" "error"
32181 A recipient error is associated with a particular recipient of a message. The
32182 recipient errors are:
32183
32184 .ilist
32185 Any error response to RCPT,
32186 .next
32187 Timeout after RCPT.
32188 .endlist
32189
32190 For a recipient error, a permanent error response (5&'xx'&) causes the
32191 recipient address to be failed, and a bounce message to be returned to the
32192 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32193 address to be deferred, and routing retry data to be created for it. This is
32194 used to delay processing of the address in subsequent queue runs, until its
32195 routing retry time arrives. This applies to all messages, but because it
32196 operates only in queue runs, one attempt will be made to deliver a new message
32197 to the failing address before the delay starts to operate. This ensures that,
32198 if the failure is really related to the message rather than the recipient
32199 (&"message too big for this recipient"& is a possible example), other messages
32200 have a chance of getting delivered. If a delivery to the address does succeed,
32201 the retry information gets cleared, so all stuck messages get tried again, and
32202 the retry clock is reset.
32203
32204 The message is not added to the list of those waiting for this host. Use of the
32205 host for other messages is unaffected, and except in the case of a timeout,
32206 other recipients are processed independently, and may be successfully delivered
32207 in the current SMTP session. After a timeout it is of course impossible to
32208 proceed with the session, so all addresses get deferred. However, those other
32209 than the one that failed do not suffer any subsequent retry delays. Therefore,
32210 if one recipient is causing trouble, the others have a chance of getting
32211 through when a subsequent delivery attempt occurs before the failing
32212 recipient's retry time.
32213 .endlist
32214
32215 In all cases, if there are other hosts (or IP addresses) available for the
32216 current set of addresses (for example, from multiple MX records), they are
32217 tried in this run for any undelivered addresses, subject of course to their
32218 own retry data. In other words, recipient error retry data does not take effect
32219 until the next delivery attempt.
32220
32221 Some hosts have been observed to give temporary error responses to every
32222 MAIL command at certain times (&"insufficient space"& has been seen). It
32223 would be nice if such circumstances could be recognized, and defer data for the
32224 host itself created, but this is not possible within the current Exim design.
32225 What actually happens is that retry data for every (host, message) combination
32226 is created.
32227
32228 The reason that timeouts after MAIL and RCPT are treated specially is that
32229 these can sometimes arise as a result of the remote host's verification
32230 procedures. Exim makes this assumption, and treats them as if a temporary error
32231 response had been received. A timeout after &"."& is treated specially because
32232 it is known that some broken implementations fail to recognize the end of the
32233 message if the last character of the last line is a binary zero. Thus, it is
32234 helpful to treat this case as a message error.
32235
32236 Timeouts at other times are treated as host errors, assuming a problem with the
32237 host, or the connection to it. If a timeout after MAIL, RCPT,
32238 or &"."& is really a connection problem, the assumption is that at the next try
32239 the timeout is likely to occur at some other point in the dialogue, causing it
32240 then to be treated as a host error.
32241
32242 There is experimental evidence that some MTAs drop the connection after the
32243 terminating &"."& if they do not like the contents of the message for some
32244 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32245 should be given. That is why Exim treats this case as a message rather than a
32246 host error, in order not to delay other messages to the same host.
32247
32248
32249
32250
32251 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32252 .cindex "SMTP" "incoming over TCP/IP"
32253 .cindex "incoming SMTP over TCP/IP"
32254 .cindex "inetd"
32255 .cindex "daemon"
32256 Incoming SMTP messages can be accepted in one of two ways: by running a
32257 listening daemon, or by using &'inetd'&. In the latter case, the entry in
32258 &_/etc/inetd.conf_& should be like this:
32259 .code
32260 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
32261 .endd
32262 Exim distinguishes between this case and the case of a locally running user
32263 agent using the &%-bs%& option by checking whether or not the standard input is
32264 a socket. When it is, either the port must be privileged (less than 1024), or
32265 the caller must be root or the Exim user. If any other user passes a socket
32266 with an unprivileged port number, Exim prints a message on the standard error
32267 stream and exits with an error code.
32268
32269 By default, Exim does not make a log entry when a remote host connects or
32270 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
32271 unexpected. It can be made to write such log entries by setting the
32272 &%smtp_connection%& log selector.
32273
32274 .cindex "carriage return"
32275 .cindex "linefeed"
32276 Commands from the remote host are supposed to be terminated by CR followed by
32277 LF. However, there are known to be hosts that do not send CR characters. In
32278 order to be able to interwork with such hosts, Exim treats LF on its own as a
32279 line terminator.
32280 Furthermore, because common code is used for receiving messages from all
32281 sources, a CR on its own is also interpreted as a line terminator. However, the
32282 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
32283
32284 .cindex "EHLO" "invalid data"
32285 .cindex "HELO" "invalid data"
32286 One area that sometimes gives rise to problems concerns the EHLO or
32287 HELO commands. Some clients send syntactically invalid versions of these
32288 commands, which Exim rejects by default. (This is nothing to do with verifying
32289 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
32290 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
32291 match the broken hosts that send invalid commands.
32292
32293 .cindex "SIZE option on MAIL command"
32294 .cindex "MAIL" "SIZE option"
32295 The amount of disk space available is checked whenever SIZE is received on
32296 a MAIL command, independently of whether &%message_size_limit%& or
32297 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
32298 false. A temporary error is given if there is not enough space. If
32299 &%check_spool_space%& is set, the check is for that amount of space plus the
32300 value given with SIZE, that is, it checks that the addition of the incoming
32301 message will not reduce the space below the threshold.
32302
32303 When a message is successfully received, Exim includes the local message id in
32304 its response to the final &"."& that terminates the data. If the remote host
32305 logs this text it can help with tracing what has happened to a message.
32306
32307 The Exim daemon can limit the number of simultaneous incoming connections it is
32308 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
32309 number of simultaneous incoming connections from a single remote host (see the
32310 &%smtp_accept_max_per_host%& option). Additional connection attempts are
32311 rejected using the SMTP temporary error code 421.
32312
32313 The Exim daemon does not rely on the SIGCHLD signal to detect when a
32314 subprocess has finished, as this can get lost at busy times. Instead, it looks
32315 for completed subprocesses every time it wakes up. Provided there are other
32316 things happening (new incoming calls, starts of queue runs), completed
32317 processes will be noticed and tidied away. On very quiet systems you may
32318 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
32319 it will be noticed when the daemon next wakes up.
32320
32321 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
32322 and can also be set up to reject SMTP calls from non-reserved hosts at times of
32323 high system load &-- for details see the &%smtp_accept_reserve%&,
32324 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
32325 applies in both the daemon and &'inetd'& cases.
32326
32327 Exim normally starts a delivery process for each message received, though this
32328 can be varied by means of the &%-odq%& command line option and the
32329 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
32330 number of simultaneously running delivery processes started in this way from
32331 SMTP input can be limited by the &%smtp_accept_queue%& and
32332 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
32333 subsequently received messages are just put on the input queue without starting
32334 a delivery process.
32335
32336 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
32337 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
32338 started up from the &'inetd'& daemon, because in that case each connection is
32339 handled by an entirely independent Exim process. Control by load average is,
32340 however, available with &'inetd'&.
32341
32342 Exim can be configured to verify addresses in incoming SMTP commands as they
32343 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
32344 to rewrite addresses at this time &-- before any syntax checking is done. See
32345 section &<<SECTrewriteS>>&.
32346
32347 Exim can also be configured to limit the rate at which a client host submits
32348 MAIL and RCPT commands in a single SMTP session. See the
32349 &%smtp_ratelimit_hosts%& option.
32350
32351
32352
32353 .section "Unrecognized SMTP commands" "SECID234"
32354 .cindex "SMTP" "unrecognized commands"
32355 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
32356 commands during a single SMTP connection, it drops the connection after sending
32357 the error response to the last command. The default value for
32358 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
32359 abuse that subvert web servers into making connections to SMTP ports; in these
32360 circumstances, a number of non-SMTP lines are sent first.
32361
32362
32363 .section "Syntax and protocol errors in SMTP commands" "SECID235"
32364 .cindex "SMTP" "syntax errors"
32365 .cindex "SMTP" "protocol errors"
32366 A syntax error is detected if an SMTP command is recognized, but there is
32367 something syntactically wrong with its data, for example, a malformed email
32368 address in a RCPT command. Protocol errors include invalid command
32369 sequencing such as RCPT before MAIL. If Exim receives more than
32370 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
32371 drops the connection after sending the error response to the last command. The
32372 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
32373 broken clients that loop sending bad commands (yes, it has been seen).
32374
32375
32376
32377 .section "Use of non-mail SMTP commands" "SECID236"
32378 .cindex "SMTP" "non-mail commands"
32379 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
32380 DATA. Exim counts such commands, and drops the connection if there are too
32381 many of them in a single SMTP session. This action catches some
32382 denial-of-service attempts and things like repeated failing AUTHs, or a mad
32383 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
32384 defines what &"too many"& means. Its default value is 10.
32385
32386 When a new message is expected, one occurrence of RSET is not counted. This
32387 allows a client to send one RSET between messages (this is not necessary,
32388 but some clients do it). Exim also allows one uncounted occurrence of HELO
32389 or EHLO, and one occurrence of STARTTLS between messages. After
32390 starting up a TLS session, another EHLO is expected, and so it too is not
32391 counted.
32392
32393 The first occurrence of AUTH in a connection, or immediately following
32394 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
32395 RCPT, DATA, and QUIT are counted.
32396
32397 You can control which hosts are subject to the limit set by
32398 &%smtp_accept_max_nonmail%& by setting
32399 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
32400 the limit apply to all hosts. This option means that you can exclude any
32401 specific badly-behaved hosts that you have to live with.
32402
32403
32404
32405
32406 .section "The VRFY and EXPN commands" "SECID237"
32407 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
32408 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
32409 appropriate) in order to decide whether the command should be accepted or not.
32410 If no ACL is defined, the command is rejected.
32411
32412 .cindex "VRFY" "processing"
32413 When VRFY is accepted, it runs exactly the same code as when Exim is
32414 called with the &%-bv%& option.
32415
32416 .cindex "EXPN" "processing"
32417 When EXPN is accepted, a single-level expansion of the address is done.
32418 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
32419 than a verification (the &%-bv%& option). If an unqualified local part is given
32420 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
32421 of VRFY and EXPN commands are logged on the main and reject logs, and
32422 VRFY verification failures are logged on the main log for consistency with
32423 RCPT failures.
32424
32425
32426
32427 .section "The ETRN command" "SECTETRN"
32428 .cindex "ETRN" "processing"
32429 RFC 1985 describes an SMTP command called ETRN that is designed to
32430 overcome the security problems of the TURN command (which has fallen into
32431 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
32432 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
32433 should be accepted or not. If no ACL is defined, the command is rejected.
32434
32435 The ETRN command is concerned with &"releasing"& messages that are awaiting
32436 delivery to certain hosts. As Exim does not organize its message queue by host,
32437 the only form of ETRN that is supported by default is the one where the
32438 text starts with the &"#"& prefix, in which case the remainder of the text is
32439 specific to the SMTP server. A valid ETRN command causes a run of Exim with
32440 the &%-R%& option to happen, with the remainder of the ETRN text as its
32441 argument. For example,
32442 .code
32443 ETRN #brigadoon
32444 .endd
32445 runs the command
32446 .code
32447 exim -R brigadoon
32448 .endd
32449 which causes a delivery attempt on all messages with undelivered addresses
32450 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
32451 default), Exim prevents the simultaneous execution of more than one queue run
32452 for the same argument string as a result of an ETRN command. This stops
32453 a misbehaving client from starting more than one queue runner at once.
32454
32455 .cindex "hints database" "ETRN serialization"
32456 Exim implements the serialization by means of a hints database in which a
32457 record is written whenever a process is started by ETRN, and deleted when
32458 the process completes. However, Exim does not keep the SMTP session waiting for
32459 the ETRN process to complete. Once ETRN is accepted, the client is sent
32460 a &"success"& return code. Obviously there is scope for hints records to get
32461 left lying around if there is a system or program crash. To guard against this,
32462 Exim ignores any records that are more than six hours old.
32463
32464 .oindex "&%smtp_etrn_command%&"
32465 For more control over what ETRN does, the &%smtp_etrn_command%& option can
32466 used. This specifies a command that is run whenever ETRN is received,
32467 whatever the form of its argument. For
32468 example:
32469 .code
32470 smtp_etrn_command = /etc/etrn_command $domain \
32471                     $sender_host_address
32472 .endd
32473 .vindex "&$domain$&"
32474 The string is split up into arguments which are independently expanded. The
32475 expansion variable &$domain$& is set to the argument of the ETRN command,
32476 and no syntax checking is done on the contents of this argument. Exim does not
32477 wait for the command to complete, so its status code is not checked. Exim runs
32478 under its own uid and gid when receiving incoming SMTP, so it is not possible
32479 for it to change them before running the command.
32480
32481
32482
32483 .section "Incoming local SMTP" "SECID238"
32484 .cindex "SMTP" "local incoming"
32485 Some user agents use SMTP to pass messages to their local MTA using the
32486 standard input and output, as opposed to passing the envelope on the command
32487 line and writing the message to the standard input. This is supported by the
32488 &%-bs%& option. This form of SMTP is handled in the same way as incoming
32489 messages over TCP/IP (including the use of ACLs), except that the envelope
32490 sender given in a MAIL command is ignored unless the caller is trusted. In
32491 an ACL you can detect this form of SMTP input by testing for an empty host
32492 identification. It is common to have this as the first line in the ACL that
32493 runs for RCPT commands:
32494 .code
32495 accept hosts = :
32496 .endd
32497 This accepts SMTP messages from local processes without doing any other tests.
32498
32499
32500
32501 .section "Outgoing batched SMTP" "SECTbatchSMTP"
32502 .cindex "SMTP" "batched outgoing"
32503 .cindex "batched SMTP output"
32504 Both the &(appendfile)& and &(pipe)& transports can be used for handling
32505 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
32506 be output in BSMTP format. No SMTP responses are possible for this form of
32507 delivery. All it is doing is using SMTP commands as a way of transmitting the
32508 envelope along with the message.
32509
32510 The message is written to the file or pipe preceded by the SMTP commands
32511 MAIL and RCPT, and followed by a line containing a single dot. Lines in
32512 the message that start with a dot have an extra dot added. The SMTP command
32513 HELO is not normally used. If it is required, the &%message_prefix%& option
32514 can be used to specify it.
32515
32516 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
32517 one recipient address at a time by default. However, you can arrange for them
32518 to handle several addresses at once by setting the &%batch_max%& option. When
32519 this is done for BSMTP, messages may contain multiple RCPT commands. See
32520 chapter &<<CHAPbatching>>& for more details.
32521
32522 .vindex "&$host$&"
32523 When one or more addresses are routed to a BSMTP transport by a router that
32524 sets up a host list, the name of the first host on the list is available to the
32525 transport in the variable &$host$&. Here is an example of such a transport and
32526 router:
32527 .code
32528 begin routers
32529 route_append:
32530   driver = manualroute
32531   transport = smtp_appendfile
32532   route_list = domain.example  batch.host.example
32533
32534 begin transports
32535 smtp_appendfile:
32536   driver = appendfile
32537   directory = /var/bsmtp/$host
32538   batch_max = 1000
32539   use_bsmtp
32540   user = exim
32541 .endd
32542 This causes messages addressed to &'domain.example'& to be written in BSMTP
32543 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
32544 message (unless there are more than 1000 recipients).
32545
32546
32547
32548 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
32549 .cindex "SMTP" "batched incoming"
32550 .cindex "batched SMTP input"
32551 The &%-bS%& command line option causes Exim to accept one or more messages by
32552 reading SMTP on the standard input, but to generate no responses. If the caller
32553 is trusted, the senders in the MAIL commands are believed; otherwise the
32554 sender is always the caller of Exim. Unqualified senders and receivers are not
32555 rejected (there seems little point) but instead just get qualified. HELO
32556 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
32557 as NOOP; QUIT quits.
32558
32559 Minimal policy checking is done for BSMTP input. Only the non-SMTP
32560 ACL is run in the same way as for non-SMTP local input.
32561
32562 If an error is detected while reading a message, including a missing &"."& at
32563 the end, Exim gives up immediately. It writes details of the error to the
32564 standard output in a stylized way that the calling program should be able to
32565 make some use of automatically, for example:
32566 .code
32567 554 Unexpected end of file
32568 Transaction started in line 10
32569 Error detected in line 14
32570 .endd
32571 It writes a more verbose version, for human consumption, to the standard error
32572 file, for example:
32573 .code
32574 An error was detected while processing a file of BSMTP input.
32575 The error message was:
32576
32577 501 '>' missing at end of address
32578
32579 The SMTP transaction started in line 10.
32580 The error was detected in line 12.
32581 The SMTP command at fault was:
32582
32583 rcpt to:<malformed@in.com.plete
32584
32585 1 previous message was successfully processed.
32586 The rest of the batch was abandoned.
32587 .endd
32588 The return code from Exim is zero only if there were no errors. It is 1 if some
32589 messages were accepted before an error was detected, and 2 if no messages were
32590 accepted.
32591 .ecindex IIDsmtpproc1
32592 .ecindex IIDsmtpproc2
32593
32594
32595
32596 . ////////////////////////////////////////////////////////////////////////////
32597 . ////////////////////////////////////////////////////////////////////////////
32598
32599 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
32600          "Customizing messages"
32601 When a message fails to be delivered, or remains on the queue for more than a
32602 configured amount of time, Exim sends a message to the original sender, or
32603 to an alternative configured address. The text of these messages is built into
32604 the code of Exim, but it is possible to change it, either by adding a single
32605 string, or by replacing each of the paragraphs by text supplied in a file.
32606
32607 The &'From:'& and &'To:'& header lines are automatically generated; you can
32608 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
32609 option. Exim also adds the line
32610 .code
32611 Auto-Submitted: auto-generated
32612 .endd
32613 to all warning and bounce messages,
32614
32615
32616 .section "Customizing bounce messages" "SECID239"
32617 .cindex "customizing" "bounce message"
32618 .cindex "bounce message" "customizing"
32619 If &%bounce_message_text%& is set, its contents are included in the default
32620 message immediately after &"This message was created automatically by mail
32621 delivery software."& The string is not expanded. It is not used if
32622 &%bounce_message_file%& is set.
32623
32624 When &%bounce_message_file%& is set, it must point to a template file for
32625 constructing error messages. The file consists of a series of text items,
32626 separated by lines consisting of exactly four asterisks. If the file cannot be
32627 opened, default text is used and a message is written to the main and panic
32628 logs. If any text item in the file is empty, default text is used for that
32629 item.
32630
32631 .vindex "&$bounce_recipient$&"
32632 .vindex "&$bounce_return_size_limit$&"
32633 Each item of text that is read from the file is expanded, and there are two
32634 expansion variables which can be of use here: &$bounce_recipient$& is set to
32635 the recipient of an error message while it is being created, and
32636 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
32637 option, rounded to a whole number.
32638
32639 The items must appear in the file in the following order:
32640
32641 .ilist
32642 The first item is included in the headers, and should include at least a
32643 &'Subject:'& header. Exim does not check the syntax of these headers.
32644 .next
32645 The second item forms the start of the error message. After it, Exim lists the
32646 failing addresses with their error messages.
32647 .next
32648 The third item is used to introduce any text from pipe transports that is to be
32649 returned to the sender. It is omitted if there is no such text.
32650 .next
32651 The fourth item is used to introduce the copy of the message that is returned
32652 as part of the error report.
32653 .next
32654 The fifth item is added after the fourth one if the returned message is
32655 truncated because it is bigger than &%return_size_limit%&.
32656 .next
32657 The sixth item is added after the copy of the original message.
32658 .endlist
32659
32660 The default state (&%bounce_message_file%& unset) is equivalent to the
32661 following file, in which the sixth item is empty. The &'Subject:'& and some
32662 other lines have been split in order to fit them on the page:
32663 .code
32664 Subject: Mail delivery failed
32665   ${if eq{$sender_address}{$bounce_recipient}
32666   {: returning message to sender}}
32667 ****
32668 This message was created automatically by mail delivery software.
32669
32670 A message ${if eq{$sender_address}{$bounce_recipient}
32671   {that you sent }{sent by
32672
32673 <$sender_address>
32674
32675 }}could not be delivered to all of its recipients.
32676 This is a permanent error. The following address(es) failed:
32677 ****
32678 The following text was generated during the delivery attempt(s):
32679 ****
32680 ------ This is a copy of the message, including all the headers.
32681   ------
32682 ****
32683 ------ The body of the message is $message_size characters long;
32684   only the first
32685 ------ $bounce_return_size_limit or so are included here.
32686 ****
32687 .endd
32688 .section "Customizing warning messages" "SECTcustwarn"
32689 .cindex "customizing" "warning message"
32690 .cindex "warning of delay" "customizing the message"
32691 The option &%warn_message_file%& can be pointed at a template file for use when
32692 warnings about message delays are created. In this case there are only three
32693 text sections:
32694
32695 .ilist
32696 The first item is included in the headers, and should include at least a
32697 &'Subject:'& header. Exim does not check the syntax of these headers.
32698 .next
32699 The second item forms the start of the warning message. After it, Exim lists
32700 the delayed addresses.
32701 .next
32702 The third item then ends the message.
32703 .endlist
32704
32705 The default state is equivalent to the following file, except that some lines
32706 have been split here, in order to fit them on the page:
32707 .code
32708 Subject: Warning: message $message_exim_id delayed
32709   $warn_message_delay
32710 ****
32711 This message was created automatically by mail delivery software.
32712
32713 A message ${if eq{$sender_address}{$warn_message_recipients}
32714 {that you sent }{sent by
32715
32716 <$sender_address>
32717
32718 }}has not been delivered to all of its recipients after
32719 more than $warn_message_delay on the queue on $primary_hostname.
32720
32721 The message identifier is:     $message_exim_id
32722 The subject of the message is: $h_subject
32723 The date of the message is:    $h_date
32724
32725 The following address(es) have not yet been delivered:
32726 ****
32727 No action is required on your part. Delivery attempts will
32728 continue for some time, and this warning may be repeated at
32729 intervals if the message remains undelivered. Eventually the
32730 mail delivery software will give up, and when that happens,
32731 the message will be returned to you.
32732 .endd
32733 .vindex "&$warn_message_delay$&"
32734 .vindex "&$warn_message_recipients$&"
32735 However, in the default state the subject and date lines are omitted if no
32736 appropriate headers exist. During the expansion of this file,
32737 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32738 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32739 of recipients for the warning message. There may be more than one if there are
32740 multiple addresses with different &%errors_to%& settings on the routers that
32741 handled them.
32742
32743
32744
32745
32746 . ////////////////////////////////////////////////////////////////////////////
32747 . ////////////////////////////////////////////////////////////////////////////
32748
32749 .chapter "Some common configuration settings" "CHAPcomconreq"
32750 This chapter discusses some configuration settings that seem to be fairly
32751 common. More examples and discussion can be found in the Exim book.
32752
32753
32754
32755 .section "Sending mail to a smart host" "SECID240"
32756 .cindex "smart host" "example router"
32757 If you want to send all mail for non-local domains to a &"smart host"&, you
32758 should replace the default &(dnslookup)& router with a router which does the
32759 routing explicitly:
32760 .code
32761 send_to_smart_host:
32762   driver = manualroute
32763   route_list = !+local_domains smart.host.name
32764   transport = remote_smtp
32765 .endd
32766 You can use the smart host's IP address instead of the name if you wish.
32767 If you are using Exim only to submit messages to a smart host, and not for
32768 receiving incoming messages, you can arrange for it to do the submission
32769 synchronously by setting the &%mua_wrapper%& option (see chapter
32770 &<<CHAPnonqueueing>>&).
32771
32772
32773
32774
32775 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32776 .cindex "mailing lists"
32777 Exim can be used to run simple mailing lists, but for large and/or complicated
32778 requirements, the use of additional specialized mailing list software such as
32779 Majordomo or Mailman is recommended.
32780
32781 The &(redirect)& router can be used to handle mailing lists where each list
32782 is maintained in a separate file, which can therefore be managed by an
32783 independent manager. The &%domains%& router option can be used to run these
32784 lists in a separate domain from normal mail. For example:
32785 .code
32786 lists:
32787   driver = redirect
32788   domains = lists.example
32789   file = /usr/lists/$local_part
32790   forbid_pipe
32791   forbid_file
32792   errors_to = $local_part-request@lists.example
32793   no_more
32794 .endd
32795 This router is skipped for domains other than &'lists.example'&. For addresses
32796 in that domain, it looks for a file that matches the local part. If there is no
32797 such file, the router declines, but because &%no_more%& is set, no subsequent
32798 routers are tried, and so the whole delivery fails.
32799
32800 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32801 expanded into a file name or a pipe delivery, which is usually inappropriate in
32802 a mailing list.
32803
32804 .oindex "&%errors_to%&"
32805 The &%errors_to%& option specifies that any delivery errors caused by addresses
32806 taken from a mailing list are to be sent to the given address rather than the
32807 original sender of the message. However, before acting on this, Exim verifies
32808 the error address, and ignores it if verification fails.
32809
32810 For example, using the configuration above, mail sent to
32811 &'dicts@lists.example'& is passed on to those addresses contained in
32812 &_/usr/lists/dicts_&, with error reports directed to
32813 &'dicts-request@lists.example'&, provided that this address can be verified.
32814 There could be a file called &_/usr/lists/dicts-request_& containing
32815 the address(es) of this particular list's manager(s), but other approaches,
32816 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32817 or &%local_part_suffix%& options) to handle addresses of the form
32818 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32819
32820
32821
32822 .section "Syntax errors in mailing lists" "SECID241"
32823 .cindex "mailing lists" "syntax errors in"
32824 If an entry in redirection data contains a syntax error, Exim normally defers
32825 delivery of the original address. That means that a syntax error in a mailing
32826 list holds up all deliveries to the list. This may not be appropriate when a
32827 list is being maintained automatically from data supplied by users, and the
32828 addresses are not rigorously checked.
32829
32830 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32831 entries that fail to parse, noting the incident in the log. If in addition
32832 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32833 whenever a broken address is skipped. It is usually appropriate to set
32834 &%syntax_errors_to%& to the same address as &%errors_to%&.
32835
32836
32837
32838 .section "Re-expansion of mailing lists" "SECID242"
32839 .cindex "mailing lists" "re-expansion of"
32840 Exim remembers every individual address to which a message has been delivered,
32841 in order to avoid duplication, but it normally stores only the original
32842 recipient addresses with a message. If all the deliveries to a mailing list
32843 cannot be done at the first attempt, the mailing list is re-expanded when the
32844 delivery is next tried. This means that alterations to the list are taken into
32845 account at each delivery attempt, so addresses that have been added to
32846 the list since the message arrived will therefore receive a copy of the
32847 message, even though it pre-dates their subscription.
32848
32849 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32850 on the &(redirect)& router. If this is done, any addresses generated by the
32851 router that fail to deliver at the first attempt are added to the message as
32852 &"top level"& addresses, and the parent address that generated them is marked
32853 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32854 subsequent delivery attempts. The disadvantage of this is that if any of the
32855 failing addresses are incorrect, correcting them in the file has no effect on
32856 pre-existing messages.
32857
32858 The original top-level address is remembered with each of the generated
32859 addresses, and is output in any log messages. However, any intermediate parent
32860 addresses are not recorded. This makes a difference to the log only if the
32861 &%all_parents%& selector is set, but for mailing lists there is normally only
32862 one level of expansion anyway.
32863
32864
32865
32866 .section "Closed mailing lists" "SECID243"
32867 .cindex "mailing lists" "closed"
32868 The examples so far have assumed open mailing lists, to which anybody may
32869 send mail. It is also possible to set up closed lists, where mail is accepted
32870 from specified senders only. This is done by making use of the generic
32871 &%senders%& option to restrict the router that handles the list.
32872
32873 The following example uses the same file as a list of recipients and as a list
32874 of permitted senders. It requires three routers:
32875 .code
32876 lists_request:
32877   driver = redirect
32878   domains = lists.example
32879   local_part_suffix = -request
32880   file = /usr/lists/$local_part$local_part_suffix
32881   no_more
32882
32883 lists_post:
32884   driver = redirect
32885   domains = lists.example
32886   senders = ${if exists {/usr/lists/$local_part}\
32887              {lsearch;/usr/lists/$local_part}{*}}
32888   file = /usr/lists/$local_part
32889   forbid_pipe
32890   forbid_file
32891   errors_to = $local_part-request@lists.example
32892   no_more
32893
32894 lists_closed:
32895   driver = redirect
32896   domains = lists.example
32897   allow_fail
32898   data = :fail: $local_part@lists.example is a closed mailing list
32899 .endd
32900 All three routers have the same &%domains%& setting, so for any other domains,
32901 they are all skipped. The first router runs only if the local part ends in
32902 &%-request%&. It handles messages to the list manager(s) by means of an open
32903 mailing list.
32904
32905 The second router runs only if the &%senders%& precondition is satisfied. It
32906 checks for the existence of a list that corresponds to the local part, and then
32907 checks that the sender is on the list by means of a linear search. It is
32908 necessary to check for the existence of the file before trying to search it,
32909 because otherwise Exim thinks there is a configuration error. If the file does
32910 not exist, the expansion of &%senders%& is *, which matches all senders. This
32911 means that the router runs, but because there is no list, declines, and
32912 &%no_more%& ensures that no further routers are run. The address fails with an
32913 &"unrouteable address"& error.
32914
32915 The third router runs only if the second router is skipped, which happens when
32916 a mailing list exists, but the sender is not on it. This router forcibly fails
32917 the address, giving a suitable error message.
32918
32919
32920
32921
32922 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32923 .cindex "VERP"
32924 .cindex "Variable Envelope Return Paths"
32925 .cindex "envelope sender"
32926 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32927 are a way of helping mailing list administrators discover which subscription
32928 address is the cause of a particular delivery failure. The idea is to encode
32929 the original recipient address in the outgoing envelope sender address, so that
32930 if the message is forwarded by another host and then subsequently bounces, the
32931 original recipient can be extracted from the recipient address of the bounce.
32932
32933 .oindex &%errors_to%&
32934 .oindex &%return_path%&
32935 Envelope sender addresses can be modified by Exim using two different
32936 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32937 list examples), or the &%return_path%& option on a transport. The second of
32938 these is effective only if the message is successfully delivered to another
32939 host; it is not used for errors detected on the local host (see the description
32940 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32941 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32942 .code
32943 verp_smtp:
32944   driver = smtp
32945   max_rcpt = 1
32946   return_path = \
32947     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32948       {$1-request+$local_part=$domain@your.dom.example}fail}
32949 .endd
32950 This has the effect of rewriting the return path (envelope sender) on outgoing
32951 SMTP messages, if the local part of the original return path ends in
32952 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32953 local part and domain of the recipient into the return path. Suppose, for
32954 example, that a message whose return path has been set to
32955 &'somelist-request@your.dom.example'& is sent to
32956 &'subscriber@other.dom.example'&. In the transport, the return path is
32957 rewritten as
32958 .code
32959 somelist-request+subscriber=other.dom.example@your.dom.example
32960 .endd
32961 .vindex "&$local_part$&"
32962 For this to work, you must tell Exim to send multiple copies of messages that
32963 have more than one recipient, so that each copy has just one recipient. This is
32964 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32965 might be sent to several different recipients in the same domain, in which case
32966 &$local_part$& is not available in the transport, because it is not unique.
32967
32968 Unless your host is doing nothing but mailing list deliveries, you should
32969 probably use a separate transport for the VERP deliveries, so as not to use
32970 extra resources in making one-per-recipient copies for other deliveries. This
32971 can easily be done by expanding the &%transport%& option in the router:
32972 .code
32973 dnslookup:
32974   driver = dnslookup
32975   domains = ! +local_domains
32976   transport = \
32977     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32978       {verp_smtp}{remote_smtp}}
32979   no_more
32980 .endd
32981 If you want to change the return path using &%errors_to%& in a router instead
32982 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32983 routers that handle mailing list addresses. This will ensure that all delivery
32984 errors, including those detected on the local host, are sent to the VERP
32985 address.
32986
32987 On a host that does no local deliveries and has no manual routing, only the
32988 &(dnslookup)& router needs to be changed. A special transport is not needed for
32989 SMTP deliveries. Every mailing list recipient has its own return path value,
32990 and so Exim must hand them to the transport one at a time. Here is an example
32991 of a &(dnslookup)& router that implements VERP:
32992 .code
32993 verp_dnslookup:
32994   driver = dnslookup
32995   domains = ! +local_domains
32996   transport = remote_smtp
32997   errors_to = \
32998     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32999      {$1-request+$local_part=$domain@your.dom.example}fail}
33000   no_more
33001 .endd
33002 Before you start sending out messages with VERPed return paths, you must also
33003 configure Exim to accept the bounce messages that come back to those paths.
33004 Typically this is done by setting a &%local_part_suffix%& option for a
33005 router, and using this to route the messages to wherever you want to handle
33006 them.
33007
33008 The overhead incurred in using VERP depends very much on the size of the
33009 message, the number of recipient addresses that resolve to the same remote
33010 host, and the speed of the connection over which the message is being sent. If
33011 a lot of addresses resolve to the same host and the connection is slow, sending
33012 a separate copy of the message for each address may take substantially longer
33013 than sending a single copy with many recipients (for which VERP cannot be
33014 used).
33015
33016
33017
33018
33019
33020
33021 .section "Virtual domains" "SECTvirtualdomains"
33022 .cindex "virtual domains"
33023 .cindex "domain" "virtual"
33024 The phrase &'virtual domain'& is unfortunately used with two rather different
33025 meanings:
33026
33027 .ilist
33028 A domain for which there are no real mailboxes; all valid local parts are
33029 aliases for other email addresses. Common examples are organizational
33030 top-level domains and &"vanity"& domains.
33031 .next
33032 One of a number of independent domains that are all handled by the same host,
33033 with mailboxes on that host, but where the mailbox owners do not necessarily
33034 have login accounts on that host.
33035 .endlist
33036
33037 The first usage is probably more common, and does seem more &"virtual"& than
33038 the second. This kind of domain can be handled in Exim with a straightforward
33039 aliasing router. One approach is to create a separate alias file for each
33040 virtual domain. Exim can test for the existence of the alias file to determine
33041 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33042 to a router of this form:
33043 .code
33044 virtual:
33045   driver = redirect
33046   domains = dsearch;/etc/mail/virtual
33047   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33048   no_more
33049 .endd
33050 The &%domains%& option specifies that the router is to be skipped, unless there
33051 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33052 domain that is being processed. When the router runs, it looks up the local
33053 part in the file to find a new address (or list of addresses). The &%no_more%&
33054 setting ensures that if the lookup fails (leading to &%data%& being an empty
33055 string), Exim gives up on the address without trying any subsequent routers.
33056
33057 This one router can handle all the virtual domains because the alias file names
33058 follow a fixed pattern. Permissions can be arranged so that appropriate people
33059 can edit the different alias files. A successful aliasing operation results in
33060 a new envelope recipient address, which is then routed from scratch.
33061
33062 The other kind of &"virtual"& domain can also be handled in a straightforward
33063 way. One approach is to create a file for each domain containing a list of
33064 valid local parts, and use it in a router like this:
33065 .code
33066 my_domains:
33067   driver = accept
33068   domains = dsearch;/etc/mail/domains
33069   local_parts = lsearch;/etc/mail/domains/$domain
33070   transport = my_mailboxes
33071 .endd
33072 The address is accepted if there is a file for the domain, and the local part
33073 can be found in the file. The &%domains%& option is used to check for the
33074 file's existence because &%domains%& is tested before the &%local_parts%&
33075 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33076 because that option is tested after &%local_parts%&. The transport is as
33077 follows:
33078 .code
33079 my_mailboxes:
33080   driver = appendfile
33081   file = /var/mail/$domain/$local_part
33082   user = mail
33083 .endd
33084 This uses a directory of mailboxes for each domain. The &%user%& setting is
33085 required, to specify which uid is to be used for writing to the mailboxes.
33086
33087 The configuration shown here is just one example of how you might support this
33088 requirement. There are many other ways this kind of configuration can be set
33089 up, for example, by using a database instead of separate files to hold all the
33090 information about the domains.
33091
33092
33093
33094 .section "Multiple user mailboxes" "SECTmulbox"
33095 .cindex "multiple mailboxes"
33096 .cindex "mailbox" "multiple"
33097 .cindex "local part" "prefix"
33098 .cindex "local part" "suffix"
33099 Heavy email users often want to operate with multiple mailboxes, into which
33100 incoming mail is automatically sorted. A popular way of handling this is to
33101 allow users to use multiple sender addresses, so that replies can easily be
33102 identified. Users are permitted to add prefixes or suffixes to their local
33103 parts for this purpose. The wildcard facility of the generic router options
33104 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33105 example, consider this router:
33106 .code
33107 userforward:
33108   driver = redirect
33109   check_local_user
33110   file = $home/.forward
33111   local_part_suffix = -*
33112   local_part_suffix_optional
33113   allow_filter
33114 .endd
33115 .vindex "&$local_part_suffix$&"
33116 It runs a user's &_.forward_& file for all local parts of the form
33117 &'username-*'&. Within the filter file the user can distinguish different
33118 cases by testing the variable &$local_part_suffix$&. For example:
33119 .code
33120 if $local_part_suffix contains -special then
33121 save /home/$local_part/Mail/special
33122 endif
33123 .endd
33124 If the filter file does not exist, or does not deal with such addresses, they
33125 fall through to subsequent routers, and, assuming no subsequent use of the
33126 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33127 control over which suffixes are valid.
33128
33129 Alternatively, a suffix can be used to trigger the use of a different
33130 &_.forward_& file &-- which is the way a similar facility is implemented in
33131 another MTA:
33132 .code
33133 userforward:
33134   driver = redirect
33135   check_local_user
33136   file = $home/.forward$local_part_suffix
33137   local_part_suffix = -*
33138   local_part_suffix_optional
33139   allow_filter
33140 .endd
33141 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33142 example, &_.forward-special_& is used. Once again, if the appropriate file
33143 does not exist, or does not deal with the address, it is passed on to
33144 subsequent routers, which could, if required, look for an unqualified
33145 &_.forward_& file to use as a default.
33146
33147
33148
33149 .section "Simplified vacation processing" "SECID244"
33150 .cindex "vacation processing"
33151 The traditional way of running the &'vacation'& program is for a user to set up
33152 a pipe command in a &_.forward_& file
33153 (see section &<<SECTspecitredli>>& for syntax details).
33154 This is prone to error by inexperienced users. There are two features of Exim
33155 that can be used to make this process simpler for users:
33156
33157 .ilist
33158 A local part prefix such as &"vacation-"& can be specified on a router which
33159 can cause the message to be delivered directly to the &'vacation'& program, or
33160 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33161 &_.forward_& file are then much simpler. For example:
33162 .code
33163 spqr, vacation-spqr
33164 .endd
33165 .next
33166 The &%require_files%& generic router option can be used to trigger a
33167 vacation delivery by checking for the existence of a certain file in the
33168 user's home directory. The &%unseen%& generic option should also be used, to
33169 ensure that the original delivery also proceeds. In this case, all the user has
33170 to do is to create a file called, say, &_.vacation_&, containing a vacation
33171 message.
33172 .endlist
33173
33174 Another advantage of both these methods is that they both work even when the
33175 use of arbitrary pipes by users is locked out.
33176
33177
33178
33179 .section "Taking copies of mail" "SECID245"
33180 .cindex "message" "copying every"
33181 Some installations have policies that require archive copies of all messages to
33182 be made. A single copy of each message can easily be taken by an appropriate
33183 command in a system filter, which could, for example, use a different file for
33184 each day's messages.
33185
33186 There is also a shadow transport mechanism that can be used to take copies of
33187 messages that are successfully delivered by local transports, one copy per
33188 delivery. This could be used, &'inter alia'&, to implement automatic
33189 notification of delivery by sites that insist on doing such things.
33190
33191
33192
33193 .section "Intermittently connected hosts" "SECID246"
33194 .cindex "intermittently connected hosts"
33195 It has become quite common (because it is cheaper) for hosts to connect to the
33196 Internet periodically rather than remain connected all the time. The normal
33197 arrangement is that mail for such hosts accumulates on a system that is
33198 permanently connected.
33199
33200 Exim was designed for use on permanently connected hosts, and so it is not
33201 particularly well-suited to use in an intermittently connected environment.
33202 Nevertheless there are some features that can be used.
33203
33204
33205 .section "Exim on the upstream server host" "SECID247"
33206 It is tempting to arrange for incoming mail for the intermittently connected
33207 host to remain on Exim's queue until the client connects. However, this
33208 approach does not scale very well. Two different kinds of waiting message are
33209 being mixed up in the same queue &-- those that cannot be delivered because of
33210 some temporary problem, and those that are waiting for their destination host
33211 to connect. This makes it hard to manage the queue, as well as wasting
33212 resources, because each queue runner scans the entire queue.
33213
33214 A better approach is to separate off those messages that are waiting for an
33215 intermittently connected host. This can be done by delivering these messages
33216 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33217 format, from where they are transmitted by other software when their
33218 destination connects. This makes it easy to collect all the mail for one host
33219 in a single directory, and to apply local timeout rules on a per-message basis
33220 if required.
33221
33222 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33223 you are doing this, you should configure Exim with a long retry period for the
33224 intermittent host. For example:
33225 .code
33226 cheshire.wonderland.fict.example    *   F,5d,24h
33227 .endd
33228 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33229 which messages it has queued up for that host. Once the intermittent host comes
33230 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33231 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33232 causes all the queued up messages to be delivered, often down a single SMTP
33233 connection. While the host remains connected, any new messages get delivered
33234 immediately.
33235
33236 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33237 issued with a different IP address each time it connects, Exim's retry
33238 mechanisms on the holding host get confused, because the IP address is normally
33239 used as part of the key string for holding retry information. This can be
33240 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33241 Since this has disadvantages for permanently connected hosts, it is best to
33242 arrange a separate transport for the intermittently connected ones.
33243
33244
33245
33246 .section "Exim on the intermittently connected client host" "SECID248"
33247 The value of &%smtp_accept_queue_per_connection%& should probably be
33248 increased, or even set to zero (that is, disabled) on the intermittently
33249 connected host, so that all incoming messages down a single connection get
33250 delivered immediately.
33251
33252 .cindex "SMTP" "passed connection"
33253 .cindex "SMTP" "multiple deliveries"
33254 .cindex "multiple SMTP deliveries"
33255 Mail waiting to be sent from an intermittently connected host will probably
33256 not have been routed, because without a connection DNS lookups are not
33257 possible. This means that if a normal queue run is done at connection time,
33258 each message is likely to be sent in a separate SMTP session. This can be
33259 avoided by starting the queue run with a command line option beginning with
33260 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
33261 first pass, routing is done but no deliveries take place. The second pass is a
33262 normal queue run; since all the messages have been previously routed, those
33263 destined for the same host are likely to get sent as multiple deliveries in a
33264 single SMTP connection.
33265
33266
33267
33268 . ////////////////////////////////////////////////////////////////////////////
33269 . ////////////////////////////////////////////////////////////////////////////
33270
33271 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
33272          "Exim as a non-queueing client"
33273 .cindex "client, non-queueing"
33274 .cindex "smart host" "suppressing queueing"
33275 On a personal computer, it is a common requirement for all
33276 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
33277 configured to operate that way, for all the popular operating systems.
33278 However, there are some MUAs for Unix-like systems that cannot be so
33279 configured: they submit messages using the command line interface of
33280 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
33281 messages this way.
33282
33283 If the personal computer runs continuously, there is no problem, because it can
33284 run a conventional MTA that handles delivery to the smart host, and deal with
33285 any delays via its queueing mechanism. However, if the computer does not run
33286 continuously or runs different operating systems at different times, queueing
33287 email is not desirable.
33288
33289 There is therefore a requirement for something that can provide the
33290 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
33291 any queueing or retrying facilities. Furthermore, the delivery to the smart
33292 host should be synchronous, so that if it fails, the sending MUA is immediately
33293 informed. In other words, we want something that extends an MUA that submits
33294 to a local MTA via the command line so that it behaves like one that submits
33295 to a remote smart host using TCP/SMTP.
33296
33297 There are a number of applications (for example, there is one called &'ssmtp'&)
33298 that do this job. However, people have found them to be lacking in various
33299 ways. For instance, you might want to allow aliasing and forwarding to be done
33300 before sending a message to the smart host.
33301
33302 Exim already had the necessary infrastructure for doing this job. Just a few
33303 tweaks were needed to make it behave as required, though it is somewhat of an
33304 overkill to use a fully-featured MTA for this purpose.
33305
33306 .oindex "&%mua_wrapper%&"
33307 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
33308 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
33309 assumes that it is being used to &"wrap"& a command-line MUA in the manner
33310 just described. As well as setting &%mua_wrapper%&, you also need to provide a
33311 compatible router and transport configuration. Typically there will be just one
33312 router and one transport, sending everything to a smart host.
33313
33314 When run in MUA wrapping mode, the behaviour of Exim changes in the
33315 following ways:
33316
33317 .ilist
33318 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
33319 In other words, the only way to submit messages is via the command line.
33320 .next
33321 Each message is synchronously delivered as soon as it is received (&%-odi%& is
33322 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
33323 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
33324 does not finish until the delivery attempt is complete. If the delivery is
33325 successful, a zero return code is given.
33326 .next
33327 Address redirection is permitted, but the final routing for all addresses must
33328 be to the same remote transport, and to the same list of hosts. Furthermore,
33329 the return address (envelope sender) must be the same for all recipients, as
33330 must any added or deleted header lines. In other words, it must be possible to
33331 deliver the message in a single SMTP transaction, however many recipients there
33332 are.
33333 .next
33334 If these conditions are not met, or if routing any address results in a
33335 failure or defer status, or if Exim is unable to deliver all the recipients
33336 successfully to one of the smart hosts, delivery of the entire message fails.
33337 .next
33338 Because no queueing is allowed, all failures are treated as permanent; there
33339 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
33340 smart host. Furthermore, because only a single yes/no response can be given to
33341 the caller, it is not possible to deliver to some recipients and not others. If
33342 there is an error (temporary or permanent) for any recipient, all are failed.
33343 .next
33344 If more than one smart host is listed, Exim will try another host after a
33345 connection failure or a timeout, in the normal way. However, if this kind of
33346 failure happens for all the hosts, the delivery fails.
33347 .next
33348 When delivery fails, an error message is written to the standard error stream
33349 (as well as to Exim's log), and Exim exits to the caller with a return code
33350 value 1. The message is expunged from Exim's spool files. No bounce messages
33351 are ever generated.
33352 .next
33353 No retry data is maintained, and any retry rules are ignored.
33354 .next
33355 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
33356 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
33357 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
33358 .endlist
33359
33360 The overall effect is that Exim makes a single synchronous attempt to deliver
33361 the message, failing if there is any kind of problem. Because no local
33362 deliveries are done and no daemon can be run, Exim does not need root
33363 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
33364 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
33365 the advantages and disadvantages of running without root privilege.
33366
33367
33368
33369
33370 . ////////////////////////////////////////////////////////////////////////////
33371 . ////////////////////////////////////////////////////////////////////////////
33372
33373 .chapter "Log files" "CHAPlog"
33374 .scindex IIDloggen "log" "general description"
33375 .cindex "log" "types of"
33376 Exim writes three different logs, referred to as the main log, the reject log,
33377 and the panic log:
33378
33379 .ilist
33380 .cindex "main log"
33381 The main log records the arrival of each message and each delivery in a single
33382 line in each case. The format is as compact as possible, in an attempt to keep
33383 down the size of log files. Two-character flag sequences make it easy to pick
33384 out these lines. A number of other events are recorded in the main log. Some of
33385 them are optional, in which case the &%log_selector%& option controls whether
33386 they are included or not. A Perl script called &'eximstats'&, which does simple
33387 analysis of main log files, is provided in the Exim distribution (see section
33388 &<<SECTmailstat>>&).
33389 .next
33390 .cindex "reject log"
33391 The reject log records information from messages that are rejected as a result
33392 of a configuration option (that is, for policy reasons).
33393 The first line of each rejection is a copy of the line that is also written to
33394 the main log. Then, if the message's header has been read at the time the log
33395 is written, its contents are written to this log. Only the original header
33396 lines are available; header lines added by ACLs are not logged. You can use the
33397 reject log to check that your policy controls are working correctly; on a busy
33398 host this may be easier than scanning the main log for rejection messages. You
33399 can suppress the writing of the reject log by setting &%write_rejectlog%&
33400 false.
33401 .next
33402 .cindex "panic log"
33403 .cindex "system log"
33404 When certain serious errors occur, Exim writes entries to its panic log. If the
33405 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
33406 are usually written to the main log as well, but can get lost amid the mass of
33407 other entries. The panic log should be empty under normal circumstances. It is
33408 therefore a good idea to check it (or to have a &'cron'& script check it)
33409 regularly, in order to become aware of any problems. When Exim cannot open its
33410 panic log, it tries as a last resort to write to the system log (syslog). This
33411 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
33412 message itself is written at priority LOG_CRIT.
33413 .endlist
33414
33415 Every log line starts with a timestamp, in the format shown in the following
33416 example. Note that many of the examples shown in this chapter are line-wrapped.
33417 In the log file, this would be all on one line:
33418 .code
33419 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
33420   by QUIT
33421 .endd
33422 By default, the timestamps are in the local timezone. There are two
33423 ways of changing this:
33424
33425 .ilist
33426 You can set the &%timezone%& option to a different time zone; in particular, if
33427 you set
33428 .code
33429 timezone = UTC
33430 .endd
33431 the timestamps will be in UTC (aka GMT).
33432 .next
33433 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
33434 example:
33435 .code
33436 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
33437 .endd
33438 .endlist
33439
33440 .cindex "log" "process ids in"
33441 .cindex "pid (process id)" "in log lines"
33442 Exim does not include its process id in log lines by default, but you can
33443 request that it does so by specifying the &`pid`& log selector (see section
33444 &<<SECTlogselector>>&). When this is set, the process id is output, in square
33445 brackets, immediately after the time and date.
33446
33447
33448
33449
33450 .section "Where the logs are written" "SECTwhelogwri"
33451 .cindex "log" "destination"
33452 .cindex "log" "to file"
33453 .cindex "log" "to syslog"
33454 .cindex "syslog"
33455 The logs may be written to local files, or to syslog, or both. However, it
33456 should be noted that many syslog implementations use UDP as a transport, and
33457 are therefore unreliable in the sense that messages are not guaranteed to
33458 arrive at the loghost, nor is the ordering of messages necessarily maintained.
33459 It has also been reported that on large log files (tens of megabytes) you may
33460 need to tweak syslog to prevent it syncing the file with each write &-- on
33461 Linux this has been seen to make syslog take 90% plus of CPU time.
33462
33463 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
33464 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
33465 configuration. This latter string is expanded, so it can contain, for example,
33466 references to the host name:
33467 .code
33468 log_file_path = /var/log/$primary_hostname/exim_%slog
33469 .endd
33470 It is generally advisable, however, to set the string in &_Local/Makefile_&
33471 rather than at run time, because then the setting is available right from the
33472 start of Exim's execution. Otherwise, if there's something it wants to log
33473 before it has read the configuration file (for example, an error in the
33474 configuration file) it will not use the path you want, and may not be able to
33475 log at all.
33476
33477 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
33478 list, currently limited to at most two items. This is one option where the
33479 facility for changing a list separator may not be used. The list must always be
33480 colon-separated. If an item in the list is &"syslog"& then syslog is used;
33481 otherwise the item must either be an absolute path, containing &`%s`& at the
33482 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
33483 implying the use of a default path.
33484
33485 When Exim encounters an empty item in the list, it searches the list defined by
33486 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
33487 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
33488 mean &"use the path specified at build time"&. It no such item exists, log
33489 files are written in the &_log_& subdirectory of the spool directory. This is
33490 equivalent to the setting:
33491 .code
33492 log_file_path = $spool_directory/log/%slog
33493 .endd
33494 If you do not specify anything at build time or run time, that is where the
33495 logs are written.
33496
33497 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
33498 are in use &-- see section &<<SECTdatlogfil>>& below.
33499
33500 Here are some examples of possible settings:
33501 .display
33502 &`LOG_FILE_PATH=syslog                    `& syslog only
33503 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
33504 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
33505 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
33506 .endd
33507 If there are more than two paths in the list, the first is used and a panic
33508 error is logged.
33509
33510
33511
33512 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
33513 .cindex "log" "cycling local files"
33514 .cindex "cycling logs"
33515 .cindex "&'exicyclog'&"
33516 .cindex "log" "local files; writing to"
33517 Some operating systems provide centralized and standardized methods for cycling
33518 log files. For those that do not, a utility script called &'exicyclog'& is
33519 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
33520 main and reject logs each time it is called. The maximum number of old logs to
33521 keep can be set. It is suggested this script is run as a daily &'cron'& job.
33522
33523 An Exim delivery process opens the main log when it first needs to write to it,
33524 and it keeps the file open in case subsequent entries are required &-- for
33525 example, if a number of different deliveries are being done for the same
33526 message. However, remote SMTP deliveries can take a long time, and this means
33527 that the file may be kept open long after it is renamed if &'exicyclog'& or
33528 something similar is being used to rename log files on a regular basis. To
33529 ensure that a switch of log files is noticed as soon as possible, Exim calls
33530 &[stat()]& on the main log's name before reusing an open file, and if the file
33531 does not exist, or its inode has changed, the old file is closed and Exim
33532 tries to open the main log from scratch. Thus, an old log file may remain open
33533 for quite some time, but no Exim processes should write to it once it has been
33534 renamed.
33535
33536
33537
33538 .section "Datestamped log files" "SECTdatlogfil"
33539 .cindex "log" "datestamped files"
33540 Instead of cycling the main and reject log files by renaming them
33541 periodically, some sites like to use files whose names contain a datestamp,
33542 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
33543 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
33544 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
33545 point where the datestamp is required. For example:
33546 .code
33547 log_file_path = /var/spool/exim/log/%slog-%D
33548 log_file_path = /var/log/exim-%s-%D.log
33549 log_file_path = /var/spool/exim/log/%D-%slog
33550 log_file_path = /var/log/exim/%s.%M
33551 .endd
33552 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
33553 examples of names generated by the above examples:
33554 .code
33555 /var/spool/exim/log/mainlog-20021225
33556 /var/log/exim-reject-20021225.log
33557 /var/spool/exim/log/20021225-mainlog
33558 /var/log/exim/main.200212
33559 .endd
33560 When this form of log file is specified, Exim automatically switches to new
33561 files at midnight. It does not make any attempt to compress old logs; you
33562 will need to write your own script if you require this. You should not
33563 run &'exicyclog'& with this form of logging.
33564
33565 The location of the panic log is also determined by &%log_file_path%&, but it
33566 is not datestamped, because rotation of the panic log does not make sense.
33567 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
33568 the string. In addition, if it immediately follows a slash, a following
33569 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
33570 character is removed. Thus, the four examples above would give these panic
33571 log names:
33572 .code
33573 /var/spool/exim/log/paniclog
33574 /var/log/exim-panic.log
33575 /var/spool/exim/log/paniclog
33576 /var/log/exim/panic
33577 .endd
33578
33579
33580 .section "Logging to syslog" "SECID249"
33581 .cindex "log" "syslog; writing to"
33582 The use of syslog does not change what Exim logs or the format of its messages,
33583 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
33584 Exim's log lines are omitted when these lines are sent to syslog. Apart from
33585 that, the same strings are written to syslog as to log files. The syslog
33586 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
33587 by default, but you can change these by setting the &%syslog_facility%& and
33588 &%syslog_processname%& options, respectively. If Exim was compiled with
33589 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
33590 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
33591 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
33592 the time and host name to each line.
33593 The three log streams are mapped onto syslog priorities as follows:
33594
33595 .ilist
33596 &'mainlog'& is mapped to LOG_INFO
33597 .next
33598 &'rejectlog'& is mapped to LOG_NOTICE
33599 .next
33600 &'paniclog'& is mapped to LOG_ALERT
33601 .endlist
33602
33603 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
33604 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
33605 these are routed by syslog to the same place. You can suppress this duplication
33606 by setting &%syslog_duplication%& false.
33607
33608 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
33609 entries contain multiple lines when headers are included. To cope with both
33610 these cases, entries written to syslog are split into separate &[syslog()]&
33611 calls at each internal newline, and also after a maximum of
33612 870 data characters. (This allows for a total syslog line length of 1024, when
33613 additions such as timestamps are added.) If you are running a syslog
33614 replacement that can handle lines longer than the 1024 characters allowed by
33615 RFC 3164, you should set
33616 .code
33617 SYSLOG_LONG_LINES=yes
33618 .endd
33619 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
33620 lines, but it still splits at internal newlines in &'reject'& log entries.
33621
33622 To make it easy to re-assemble split lines later, each component of a split
33623 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
33624 where <&'n'&> is the component number and <&'m'&> is the total number of
33625 components in the entry. The / delimiter is used when the line was split
33626 because it was too long; if it was split because of an internal newline, the \
33627 delimiter is used. For example, supposing the length limit to be 50 instead of
33628 870, the following would be the result of a typical rejection message to
33629 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
33630 name, and pid as added by syslog:
33631 .code
33632 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
33633 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
33634 [3/5]  when scanning for sender: missing or malformed lo
33635 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
33636 [5/5] mple>)
33637 .endd
33638 The same error might cause the following lines to be written to &"rejectlog"&
33639 (LOG_NOTICE):
33640 .code
33641 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
33642 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
33643 [3/18] er when scanning for sender: missing or malformed
33644 [4/18]  local part in "<>" (envelope sender is <ph10@cam
33645 [5\18] .example>)
33646 [6\18] Recipients: ph10@some.domain.cam.example
33647 [7\18] P Received: from [127.0.0.1] (ident=ph10)
33648 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
33649 [9\18]        id 16RdAL-0006pc-00
33650 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
33651 [11\18] 09:43 +0100
33652 [12\18] F From: <>
33653 [13\18]   Subject: this is a test header
33654 [18\18]   X-something: this is another header
33655 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
33656 [16\18] le>
33657 [17\18] B Bcc:
33658 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
33659 .endd
33660 Log lines that are neither too long nor contain newlines are written to syslog
33661 without modification.
33662
33663 If only syslog is being used, the Exim monitor is unable to provide a log tail
33664 display, unless syslog is routing &'mainlog'& to a file on the local host and
33665 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
33666 where it is.
33667
33668
33669
33670 .section "Log line flags" "SECID250"
33671 One line is written to the main log for each message received, and for each
33672 successful, unsuccessful, and delayed delivery. These lines can readily be
33673 picked out by the distinctive two-character flags that immediately follow the
33674 timestamp. The flags are:
33675 .display
33676 &`<=`&     message arrival
33677 &`=>`&     normal message delivery
33678 &`->`&     additional address in same delivery
33679 &`>>`&     cutthrough message delivery
33680 &`*>`&     delivery suppressed by &%-N%&
33681 &`**`&     delivery failed; address bounced
33682 &`==`&     delivery deferred; temporary problem
33683 .endd
33684
33685
33686 .section "Logging message reception" "SECID251"
33687 .cindex "log" "reception line"
33688 The format of the single-line entry in the main log that is written for every
33689 message received is shown in the basic example below, which is split over
33690 several lines in order to fit it on the page:
33691 .code
33692 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
33693   H=mailer.fict.example [192.168.123.123] U=exim
33694   P=smtp S=5678 id=<incoming message id>
33695 .endd
33696 The address immediately following &"<="& is the envelope sender address. A
33697 bounce message is shown with the sender address &"<>"&, and if it is locally
33698 generated, this is followed by an item of the form
33699 .code
33700 R=<message id>
33701 .endd
33702 which is a reference to the message that caused the bounce to be sent.
33703
33704 .cindex "HELO"
33705 .cindex "EHLO"
33706 For messages from other hosts, the H and U fields identify the remote host and
33707 record the RFC 1413 identity of the user that sent the message, if one was
33708 received. The number given in square brackets is the IP address of the sending
33709 host. If there is a single, unparenthesized  host name in the H field, as
33710 above, it has been verified to correspond to the IP address (see the
33711 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33712 by the remote host in the SMTP HELO or EHLO command, and has not been
33713 verified. If verification yields a different name to that given for HELO or
33714 EHLO, the verified name appears first, followed by the HELO or EHLO
33715 name in parentheses.
33716
33717 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33718 without brackets, in the HELO or EHLO command, leading to entries in
33719 the log containing text like these examples:
33720 .code
33721 H=(10.21.32.43) [192.168.8.34]
33722 H=([10.21.32.43]) [192.168.8.34]
33723 .endd
33724 This can be confusing. Only the final address in square brackets can be relied
33725 on.
33726
33727 For locally generated messages (that is, messages not received over TCP/IP),
33728 the H field is omitted, and the U field contains the login name of the caller
33729 of Exim.
33730
33731 .cindex "authentication" "logging"
33732 .cindex "AUTH" "logging"
33733 For all messages, the P field specifies the protocol used to receive the
33734 message. This is the value that is stored in &$received_protocol$&. In the case
33735 of incoming SMTP messages, the value indicates whether or not any SMTP
33736 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33737 session was encrypted, there is an additional X field that records the cipher
33738 suite that was used.
33739
33740 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33741 hosts that have authenticated themselves using the SMTP AUTH command. The first
33742 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33743 there is an additional item A= followed by the name of the authenticator that
33744 was used. If an authenticated identification was set up by the authenticator's
33745 &%server_set_id%& option, this is logged too, separated by a colon from the
33746 authenticator name.
33747
33748 .cindex "size" "of message"
33749 The id field records the existing message id, if present. The size of the
33750 received message is given by the S field. When the message is delivered,
33751 headers may be removed or added, so that the size of delivered copies of the
33752 message may not correspond with this value (and indeed may be different to each
33753 other).
33754
33755 The &%log_selector%& option can be used to request the logging of additional
33756 data when a message is received. See section &<<SECTlogselector>>& below.
33757
33758
33759
33760 .section "Logging deliveries" "SECID252"
33761 .cindex "log" "delivery line"
33762 The format of the single-line entry in the main log that is written for every
33763 delivery is shown in one of the examples below, for local and remote
33764 deliveries, respectively. Each example has been split into two lines in order
33765 to fit it on the page:
33766 .code
33767 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33768   <marv@hitch.fict.example> R=localuser T=local_delivery
33769 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33770   monk@holistic.fict.example R=dnslookup T=remote_smtp
33771   H=holistic.fict.example [192.168.234.234]
33772 .endd
33773 For ordinary local deliveries, the original address is given in angle brackets
33774 after the final delivery address, which might be a pipe or a file. If
33775 intermediate address(es) exist between the original and the final address, the
33776 last of these is given in parentheses after the final address. The R and T
33777 fields record the router and transport that were used to process the address.
33778
33779 If SMTP AUTH was used for the delivery there is an additional item A=
33780 followed by the name of the authenticator that was used.
33781 If an authenticated identification was set up by the authenticator's &%client_set_id%&
33782 option, this is logged too, separated by a colon from the authenticator name.
33783
33784 If a shadow transport was run after a successful local delivery, the log line
33785 for the successful delivery has an item added on the end, of the form
33786 .display
33787 &`ST=<`&&'shadow transport name'&&`>`&
33788 .endd
33789 If the shadow transport did not succeed, the error message is put in
33790 parentheses afterwards.
33791
33792 .cindex "asterisk" "after IP address"
33793 When more than one address is included in a single delivery (for example, two
33794 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33795 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33796 down a single SMTP connection, an asterisk follows the IP address in the log
33797 lines for the second and subsequent messages.
33798
33799 .cindex "delivery" "cutthrough; logging"
33800 .cindex "cutthrough" "logging"
33801 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
33802 line precedes the reception line, since cutthrough waits for a possible
33803 rejection from the destination in case it can reject the sourced item.
33804
33805 The generation of a reply message by a filter file gets logged as a
33806 &"delivery"& to the addressee, preceded by &">"&.
33807
33808 The &%log_selector%& option can be used to request the logging of additional
33809 data when a message is delivered. See section &<<SECTlogselector>>& below.
33810
33811
33812 .section "Discarded deliveries" "SECID253"
33813 .cindex "discarded messages"
33814 .cindex "message" "discarded"
33815 .cindex "delivery" "discarded; logging"
33816 When a message is discarded as a result of the command &"seen finish"& being
33817 obeyed in a filter file which generates no deliveries, a log entry of the form
33818 .code
33819 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33820   <low.club@bridge.example> R=userforward
33821 .endd
33822 is written, to record why no deliveries are logged. When a message is discarded
33823 because it is aliased to &":blackhole:"& the log line is like this:
33824 .code
33825 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33826   <hole@nowhere.example> R=blackhole_router
33827 .endd
33828
33829
33830 .section "Deferred deliveries" "SECID254"
33831 When a delivery is deferred, a line of the following form is logged:
33832 .code
33833 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33834   R=dnslookup T=smtp defer (146): Connection refused
33835 .endd
33836 In the case of remote deliveries, the error is the one that was given for the
33837 last IP address that was tried. Details of individual SMTP failures are also
33838 written to the log, so the above line would be preceded by something like
33839 .code
33840 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33841   mail1.endrest.example [192.168.239.239]: Connection refused
33842 .endd
33843 When a deferred address is skipped because its retry time has not been reached,
33844 a message is written to the log, but this can be suppressed by setting an
33845 appropriate value in &%log_selector%&.
33846
33847
33848
33849 .section "Delivery failures" "SECID255"
33850 .cindex "delivery" "failure; logging"
33851 If a delivery fails because an address cannot be routed, a line of the
33852 following form is logged:
33853 .code
33854 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33855   <jim@trek99.example>: unknown mail domain
33856 .endd
33857 If a delivery fails at transport time, the router and transport are shown, and
33858 the response from the remote host is included, as in this example:
33859 .code
33860 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33861   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33862   after pipelined RCPT TO:<ace400@pb.example>: host
33863   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33864   <ace400@pb.example>...Addressee unknown
33865 .endd
33866 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33867 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33868 disabling PIPELINING. The log lines for all forms of delivery failure are
33869 flagged with &`**`&.
33870
33871
33872
33873 .section "Fake deliveries" "SECID256"
33874 .cindex "delivery" "fake; logging"
33875 If a delivery does not actually take place because the &%-N%& option has been
33876 used to suppress it, a normal delivery line is written to the log, except that
33877 &"=>"& is replaced by &"*>"&.
33878
33879
33880
33881 .section "Completion" "SECID257"
33882 A line of the form
33883 .code
33884 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33885 .endd
33886 is written to the main log when a message is about to be removed from the spool
33887 at the end of its processing.
33888
33889
33890
33891
33892 .section "Summary of Fields in Log Lines" "SECID258"
33893 .cindex "log" "summary of fields"
33894 A summary of the field identifiers that are used in log lines is shown in
33895 the following table:
33896 .display
33897 &`A   `&        authenticator name (and optional id and sender)
33898 &`C   `&        SMTP confirmation on delivery
33899 &`    `&        command list for &"no mail in SMTP session"&
33900 &`CV  `&        certificate verification status
33901 &`D   `&        duration of &"no mail in SMTP session"&
33902 &`DN  `&        distinguished name from peer certificate
33903 &`DT  `&        on &`=>`& lines: time taken for a delivery
33904 &`F   `&        sender address (on delivery lines)
33905 &`H   `&        host name and IP address
33906 &`I   `&        local interface used
33907 &`id  `&        message id for incoming message
33908 &`P   `&        on &`<=`& lines: protocol used
33909 &`    `&        on &`=>`& and &`**`& lines: return path
33910 &`QT  `&        on &`=>`& lines: time spent on queue so far
33911 &`    `&        on &"Completed"& lines: time spent on queue
33912 &`R   `&        on &`<=`& lines: reference for local bounce
33913 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33914 &`S   `&        size of message
33915 &`ST  `&        shadow transport name
33916 &`T   `&        on &`<=`& lines: message subject (topic)
33917 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33918 &`U   `&        local user or RFC 1413 identity
33919 &`X   `&        TLS cipher suite
33920 .endd
33921
33922
33923 .section "Other log entries" "SECID259"
33924 Various other types of log entry are written from time to time. Most should be
33925 self-explanatory. Among the more common are:
33926
33927 .ilist
33928 .cindex "retry" "time not reached"
33929 &'retry time not reached'&&~&~An address previously suffered a temporary error
33930 during routing or local delivery, and the time to retry has not yet arrived.
33931 This message is not written to an individual message log file unless it happens
33932 during the first delivery attempt.
33933 .next
33934 &'retry time not reached for any host'&&~&~An address previously suffered
33935 temporary errors during remote delivery, and the retry time has not yet arrived
33936 for any of the hosts to which it is routed.
33937 .next
33938 .cindex "spool directory" "file locked"
33939 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33940 some other Exim process is already working on the message. This can be quite
33941 common if queue running processes are started at frequent intervals. The
33942 &'exiwhat'& utility script can be used to find out what Exim processes are
33943 doing.
33944 .next
33945 .cindex "error" "ignored"
33946 &'error ignored'&&~&~There are several circumstances that give rise to this
33947 message:
33948 .olist
33949 Exim failed to deliver a bounce message whose age was greater than
33950 &%ignore_bounce_errors_after%&. The bounce was discarded.
33951 .next
33952 A filter file set up a delivery using the &"noerror"& option, and the delivery
33953 failed. The delivery was discarded.
33954 .next
33955 A delivery set up by a router configured with
33956 . ==== As this is a nested list, any displays it contains must be indented
33957 . ==== as otherwise they are too far to the left.
33958 .code
33959     errors_to = <>
33960 .endd
33961 failed. The delivery was discarded.
33962 .endlist olist
33963 .endlist ilist
33964
33965
33966
33967
33968
33969 .section "Reducing or increasing what is logged" "SECTlogselector"
33970 .cindex "log" "selectors"
33971 By setting the &%log_selector%& global option, you can disable some of Exim's
33972 default logging, or you can request additional logging. The value of
33973 &%log_selector%& is made up of names preceded by plus or minus characters. For
33974 example:
33975 .code
33976 log_selector = +arguments -retry_defer
33977 .endd
33978 The list of optional log items is in the following table, with the default
33979 selection marked by asterisks:
33980 .display
33981 &` 8bitmime                   `&  received 8BITMIME status
33982 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33983 &` address_rewrite            `&  address rewriting
33984 &` all_parents                `&  all parents in => lines
33985 &` arguments                  `&  command line arguments
33986 &`*connection_reject          `&  connection rejections
33987 &`*delay_delivery             `&  immediate delivery delayed
33988 &` deliver_time               `&  time taken to perform delivery
33989 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33990 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33991 &`*etrn                       `&  ETRN commands
33992 &`*host_lookup_failed         `&  as it says
33993 &` ident_timeout              `&  timeout for ident connection
33994 &` incoming_interface         `&  incoming interface on <= lines
33995 &` incoming_port              `&  incoming port on <= lines
33996 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33997 &` outgoing_port              `&  add remote port to => lines
33998 &`*queue_run                  `&  start and end queue runs
33999 &` queue_time                 `&  time on queue for one recipient
34000 &` queue_time_overall         `&  time on queue for whole message
34001 &` pid                        `&  Exim process id
34002 &` received_recipients        `&  recipients on <= lines
34003 &` received_sender            `&  sender on <= lines
34004 &`*rejected_header            `&  header contents on reject log
34005 &`*retry_defer                `&  &"retry time not reached"&
34006 &` return_path_on_delivery    `&  put return path on => and ** lines
34007 &` sender_on_delivery         `&  add sender to => lines
34008 &`*sender_verify_fail         `&  sender verification failures
34009 &`*size_reject                `&  rejection because too big
34010 &`*skip_delivery              `&  delivery skipped in a queue run
34011 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34012 &` smtp_connection            `&  SMTP connections
34013 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34014 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34015 &` smtp_no_mail               `&  session with no MAIL commands
34016 &` smtp_protocol_error        `&  SMTP protocol errors
34017 &` smtp_syntax_error          `&  SMTP syntax errors
34018 &` subject                    `&  contents of &'Subject:'& on <= lines
34019 &` tls_certificate_verified   `&  certificate verification status
34020 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34021 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34022 &` tls_sni                    `&  TLS SNI on <= lines
34023 &` unknown_in_list            `&  DNS lookup failed in list match
34024
34025 &` all                        `&  all of the above
34026 .endd
34027 More details on each of these items follows:
34028
34029 .ilist
34030 .cindex "8BITMIME"
34031 .cindex "log" "8BITMIME"
34032 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34033 which may help in tracking down interoperability issues with ancient MTAs
34034 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34035 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34036 &`7BIT`& and &`8BITMIME`& respectively.
34037 .next
34038 .cindex "&%warn%& ACL verb" "log when skipping"
34039 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34040 its conditions cannot be evaluated, a log line to this effect is written if
34041 this log selector is set.
34042 .next
34043 .cindex "log" "rewriting"
34044 .cindex "rewriting" "logging"
34045 &%address_rewrite%&: This applies both to global rewrites and per-transport
34046 rewrites, but not to rewrites in filters run as an unprivileged user (because
34047 such users cannot access the log).
34048 .next
34049 .cindex "log" "full parentage"
34050 &%all_parents%&: Normally only the original and final addresses are logged on
34051 delivery lines; with this selector, intermediate parents are given in
34052 parentheses between them.
34053 .next
34054 .cindex "log" "Exim arguments"
34055 .cindex "Exim arguments, logging"
34056 &%arguments%&: This causes Exim to write the arguments with which it was called
34057 to the main log, preceded by the current working directory. This is a debugging
34058 feature, added to make it easier to find out how certain MUAs call
34059 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34060 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34061 that are empty or that contain white space are quoted. Non-printing characters
34062 are shown as escape sequences. This facility cannot log unrecognized arguments,
34063 because the arguments are checked before the configuration file is read. The
34064 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34065 between the caller and Exim.
34066 .next
34067 .cindex "log" "connection rejections"
34068 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34069 connection is rejected, for whatever reason.
34070 .next
34071 .cindex "log" "delayed delivery"
34072 .cindex "delayed delivery, logging"
34073 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34074 started for an incoming message because the load is too high or too many
34075 messages were received on one connection. Logging does not occur if no delivery
34076 process is started because &%queue_only%& is set or &%-odq%& was used.
34077 .next
34078 .cindex "log" "delivery duration"
34079 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34080 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34081 .next
34082 .cindex "log" "message size on delivery"
34083 .cindex "size" "of message"
34084 &%delivery_size%&: For each delivery, the size of message delivered is added to
34085 the &"=>"& line, tagged with S=.
34086 .next
34087 .cindex "log" "dnslist defer"
34088 .cindex "DNS list" "logging defer"
34089 .cindex "black list (DNS)"
34090 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34091 DNS black list suffers a temporary error.
34092 .next
34093 .cindex "log" "ETRN commands"
34094 .cindex "ETRN" "logging"
34095 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34096 is run to determine whether or not it is actually accepted. An invalid ETRN
34097 command, or one received within a message transaction is not logged by this
34098 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34099 .next
34100 .cindex "log" "host lookup failure"
34101 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34102 any addresses, or when a lookup of an IP address fails to find a host name, a
34103 log line is written. This logging does not apply to direct DNS lookups when
34104 routing email addresses, but it does apply to &"byname"& lookups.
34105 .next
34106 .cindex "log" "ident timeout"
34107 .cindex "RFC 1413" "logging timeout"
34108 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
34109 client's ident port times out.
34110 .next
34111 .cindex "log" "incoming interface"
34112 .cindex "interface" "logging"
34113 &%incoming_interface%&: The interface on which a message was received is added
34114 to the &"<="& line as an IP address in square brackets, tagged by I= and
34115 followed by a colon and the port number. The local interface and port are also
34116 added to other SMTP log lines, for example &"SMTP connection from"&, and to
34117 rejection lines.
34118 .next
34119 .cindex "log" "incoming remote port"
34120 .cindex "port" "logging remote"
34121 .cindex "TCP/IP" "logging incoming remote port"
34122 .vindex "&$sender_fullhost$&"
34123 .vindex "&$sender_rcvhost$&"
34124 &%incoming_port%&: The remote port number from which a message was received is
34125 added to log entries and &'Received:'& header lines, following the IP address
34126 in square brackets, and separated from it by a colon. This is implemented by
34127 changing the value that is put in the &$sender_fullhost$& and
34128 &$sender_rcvhost$& variables. Recording the remote port number has become more
34129 important with the widening use of NAT (see RFC 2505).
34130 .next
34131 .cindex "log" "dropped connection"
34132 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34133 connection is unexpectedly dropped.
34134 .next
34135 .cindex "log" "outgoing remote port"
34136 .cindex "port" "logging outgoint remote"
34137 .cindex "TCP/IP" "logging ougtoing remote port"
34138 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34139 containing => tags) following the IP address. This option is not included in
34140 the default setting, because for most ordinary configurations, the remote port
34141 number is always 25 (the SMTP port).
34142 .next
34143 .cindex "log" "process ids in"
34144 .cindex "pid (process id)" "in log lines"
34145 &%pid%&: The current process id is added to every log line, in square brackets,
34146 immediately after the time and date.
34147 .next
34148 .cindex "log" "queue run"
34149 .cindex "queue runner" "logging"
34150 &%queue_run%&: The start and end of every queue run are logged.
34151 .next
34152 .cindex "log" "queue time"
34153 &%queue_time%&: The amount of time the message has been in the queue on the
34154 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34155 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34156 includes reception time as well as the delivery time for the current address.
34157 This means that it may be longer than the difference between the arrival and
34158 delivery log line times, because the arrival log line is not written until the
34159 message has been successfully received.
34160 .next
34161 &%queue_time_overall%&: The amount of time the message has been in the queue on
34162 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34163 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34164 message, so it includes reception time as well as the total delivery time.
34165 .next
34166 .cindex "log" "recipients"
34167 &%received_recipients%&: The recipients of a message are listed in the main log
34168 as soon as the message is received. The list appears at the end of the log line
34169 that is written when a message is received, preceded by the word &"for"&. The
34170 addresses are listed after they have been qualified, but before any rewriting
34171 has taken place.
34172 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34173 in the list.
34174 .next
34175 .cindex "log" "sender reception"
34176 &%received_sender%&: The unrewritten original sender of a message is added to
34177 the end of the log line that records the message's arrival, after the word
34178 &"from"& (before the recipients if &%received_recipients%& is also set).
34179 .next
34180 .cindex "log" "header lines for rejection"
34181 &%rejected_header%&: If a message's header has been received at the time a
34182 rejection is written to the reject log, the complete header is added to the
34183 log. Header logging can be turned off individually for messages that are
34184 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34185 .next
34186 .cindex "log" "retry defer"
34187 &%retry_defer%&: A log line is written if a delivery is deferred because a
34188 retry time has not yet been reached. However, this &"retry time not reached"&
34189 message is always omitted from individual message logs after the first delivery
34190 attempt.
34191 .next
34192 .cindex "log" "return path"
34193 &%return_path_on_delivery%&: The return path that is being transmitted with
34194 the message is included in delivery and bounce lines, using the tag P=.
34195 This is omitted if no delivery actually happens, for example, if routing fails,
34196 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
34197 .next
34198 .cindex "log" "sender on delivery"
34199 &%sender_on_delivery%&: The message's sender address is added to every delivery
34200 and bounce line, tagged by F= (for &"from"&).
34201 This is the original sender that was received with the message; it is not
34202 necessarily the same as the outgoing return path.
34203 .next
34204 .cindex "log" "sender verify failure"
34205 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34206 gives details of a sender verification failure is not written. Log lines for
34207 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34208 detail is lost.
34209 .next
34210 .cindex "log" "size rejection"
34211 &%size_reject%&: A log line is written whenever a message is rejected because
34212 it is too big.
34213 .next
34214 .cindex "log" "frozen messages; skipped"
34215 .cindex "frozen messages" "logging skipping"
34216 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34217 queue run because it is frozen or because another process is already delivering
34218 it.
34219 .cindex "&""spool file is locked""&"
34220 The message that is written is &"spool file is locked"&.
34221 .next
34222 .cindex "log" "smtp confirmation"
34223 .cindex "SMTP" "logging confirmation"
34224 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
34225 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34226 A number of MTAs (including Exim) return an identifying string in this
34227 response.
34228 .next
34229 .cindex "log" "SMTP connections"
34230 .cindex "SMTP" "logging connections"
34231 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34232 established or closed, unless the connection is from a host that matches
34233 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34234 only when the closure is unexpected.) This applies to connections from local
34235 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34236 dropped in the middle of a message, a log line is always written, whether or
34237 not this selector is set, but otherwise nothing is written at the start and end
34238 of connections unless this selector is enabled.
34239
34240 For TCP/IP connections to an Exim daemon, the current number of connections is
34241 included in the log message for each new connection, but note that the count is
34242 reset if the daemon is restarted.
34243 Also, because connections are closed (and the closure is logged) in
34244 subprocesses, the count may not include connections that have been closed but
34245 whose termination the daemon has not yet noticed. Thus, while it is possible to
34246 match up the opening and closing of connections in the log, the value of the
34247 logged counts may not be entirely accurate.
34248 .next
34249 .cindex "log" "SMTP transaction; incomplete"
34250 .cindex "SMTP" "logging incomplete transactions"
34251 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
34252 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
34253 and the message sender plus any accepted recipients are included in the log
34254 line. This can provide evidence of dictionary attacks.
34255 .next
34256 .cindex "log" "non-MAIL SMTP sessions"
34257 .cindex "MAIL" "logging session without"
34258 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
34259 connection terminates without having issued a MAIL command. This includes both
34260 the case when the connection is dropped, and the case when QUIT is used. It
34261 does not include cases where the connection is rejected right at the start (by
34262 an ACL, or because there are too many connections, or whatever). These cases
34263 already have their own log lines.
34264
34265 The log line that is written contains the identity of the client in the usual
34266 way, followed by D= and a time, which records the duration of the connection.
34267 If the connection was authenticated, this fact is logged exactly as it is for
34268 an incoming message, with an A= item. If the connection was encrypted, CV=,
34269 DN=, and X= items may appear as they do for an incoming message, controlled by
34270 the same logging options.
34271
34272 Finally, if any SMTP commands were issued during the connection, a C= item
34273 is added to the line, listing the commands that were used. For example,
34274 .code
34275 C=EHLO,QUIT
34276 .endd
34277 shows that the client issued QUIT straight after EHLO. If there were fewer
34278 than 20 commands, they are all listed. If there were more than 20 commands,
34279 the last 20 are listed, preceded by &"..."&. However, with the default
34280 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
34281 have been aborted before 20 non-mail commands are processed.
34282 .next
34283 &%smtp_mailauth%&: A third subfield with the authenticated sender,
34284 colon-separated, is appended to the A= item for a message arrival or delivery
34285 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
34286 was accepted or used.
34287 .next
34288 .cindex "log" "SMTP protocol error"
34289 .cindex "SMTP" "logging protocol error"
34290 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
34291 encountered. Exim does not have perfect detection of all protocol errors
34292 because of transmission delays and the use of pipelining. If PIPELINING has
34293 been advertised to a client, an Exim server assumes that the client will use
34294 it, and therefore it does not count &"expected"& errors (for example, RCPT
34295 received after rejecting MAIL) as protocol errors.
34296 .next
34297 .cindex "SMTP" "logging syntax errors"
34298 .cindex "SMTP" "syntax errors; logging"
34299 .cindex "SMTP" "unknown command; logging"
34300 .cindex "log" "unknown SMTP command"
34301 .cindex "log" "SMTP syntax error"
34302 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
34303 encountered. An unrecognized command is treated as a syntax error. For an
34304 external connection, the host identity is given; for an internal connection
34305 using &%-bs%& the sender identification (normally the calling user) is given.
34306 .next
34307 .cindex "log" "subject"
34308 .cindex "subject, logging"
34309 &%subject%&: The subject of the message is added to the arrival log line,
34310 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
34311 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
34312 specifies whether characters with values greater than 127 should be logged
34313 unchanged, or whether they should be rendered as escape sequences.
34314 .next
34315 .cindex "log" "certificate verification"
34316 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
34317 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
34318 verified, and &`CV=no`& if not.
34319 .next
34320 .cindex "log" "TLS cipher"
34321 .cindex "TLS" "logging cipher"
34322 &%tls_cipher%&: When a message is sent or received over an encrypted
34323 connection, the cipher suite used is added to the log line, preceded by X=.
34324 .next
34325 .cindex "log" "TLS peer DN"
34326 .cindex "TLS" "logging peer DN"
34327 &%tls_peerdn%&: When a message is sent or received over an encrypted
34328 connection, and a certificate is supplied by the remote host, the peer DN is
34329 added to the log line, preceded by DN=.
34330 .next
34331 .cindex "log" "TLS SNI"
34332 .cindex "TLS" "logging SNI"
34333 &%tls_sni%&: When a message is received over an encrypted connection, and
34334 the remote host provided the Server Name Indication extension, the SNI is
34335 added to the log line, preceded by SNI=.
34336 .next
34337 .cindex "log" "DNS failure in list"
34338 &%unknown_in_list%&: This setting causes a log entry to be written when the
34339 result of a list match is failure because a DNS lookup failed.
34340 .endlist
34341
34342
34343 .section "Message log" "SECID260"
34344 .cindex "message" "log file for"
34345 .cindex "log" "message log; description of"
34346 .cindex "&_msglog_& directory"
34347 .oindex "&%preserve_message_logs%&"
34348 In addition to the general log files, Exim writes a log file for each message
34349 that it handles. The names of these per-message logs are the message ids, and
34350 they are kept in the &_msglog_& sub-directory of the spool directory. Each
34351 message log contains copies of the log lines that apply to the message. This
34352 makes it easier to inspect the status of an individual message without having
34353 to search the main log. A message log is deleted when processing of the message
34354 is complete, unless &%preserve_message_logs%& is set, but this should be used
34355 only with great care because they can fill up your disk very quickly.
34356
34357 On a heavily loaded system, it may be desirable to disable the use of
34358 per-message logs, in order to reduce disk I/O. This can be done by setting the
34359 &%message_logs%& option false.
34360 .ecindex IIDloggen
34361
34362
34363
34364
34365 . ////////////////////////////////////////////////////////////////////////////
34366 . ////////////////////////////////////////////////////////////////////////////
34367
34368 .chapter "Exim utilities" "CHAPutils"
34369 .scindex IIDutils "utilities"
34370 A number of utility scripts and programs are supplied with Exim and are
34371 described in this chapter. There is also the Exim Monitor, which is covered in
34372 the next chapter. The utilities described here are:
34373
34374 .itable none 0 0 3  7* left  15* left  40* left
34375 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
34376   "list what Exim processes are doing"
34377 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
34378 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
34379 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
34380 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
34381                                                 various criteria"
34382 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
34383 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
34384   "extract statistics from the log"
34385 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
34386   "check address acceptance from given IP"
34387 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
34388 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
34389 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
34390 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
34391 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
34392 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
34393 .endtable
34394
34395 Another utility that might be of use to sites with many MTAs is Tom Kistner's
34396 &'exilog'&. It provides log visualizations across multiple Exim servers. See
34397 &url(http://duncanthrax.net/exilog/) for details.
34398
34399
34400
34401
34402 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
34403 .cindex "&'exiwhat'&"
34404 .cindex "process, querying"
34405 .cindex "SIGUSR1"
34406 On operating systems that can restart a system call after receiving a signal
34407 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
34408 a line describing what it is doing to the file &_exim-process.info_& in the
34409 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
34410 processes it can find, having first emptied the file. It then waits for one
34411 second to allow the Exim processes to react before displaying the results. In
34412 order to run &'exiwhat'& successfully you have to have sufficient privilege to
34413 send the signal to the Exim processes, so it is normally run as root.
34414
34415 &*Warning*&: This is not an efficient process. It is intended for occasional
34416 use by system administrators. It is not sensible, for example, to set up a
34417 script that sends SIGUSR1 signals to Exim processes at short intervals.
34418
34419
34420 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
34421 varies in different operating systems. Not only are different options used,
34422 but the format of the output is different. For this reason, there are some
34423 system configuration options that configure exactly how &'exiwhat'& works. If
34424 it doesn't seem to be working for you, check the following compile-time
34425 options:
34426 .display
34427 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
34428 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
34429 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
34430 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
34431 .endd
34432 An example of typical output from &'exiwhat'& is
34433 .code
34434 164 daemon: -q1h, listening on port 25
34435 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
34436 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
34437   [10.19.42.42] (editor@ref.example)
34438 10592 handling incoming call from [192.168.243.242]
34439 10628 accepting a local non-SMTP message
34440 .endd
34441 The first number in the output line is the process number. The third line has
34442 been split here, in order to fit it on the page.
34443
34444
34445
34446 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
34447 .cindex "&'exiqgrep'&"
34448 .cindex "queue" "grepping"
34449 This utility is a Perl script contributed by Matt Hubbard. It runs
34450 .code
34451 exim -bpu
34452 .endd
34453 to obtain a queue listing with undelivered recipients only, and then greps the
34454 output to select messages that match given criteria. The following selection
34455 options are available:
34456
34457 .vlist
34458 .vitem &*-f*&&~<&'regex'&>
34459 Match the sender address using a case-insensitive search. The field that is
34460 tested is enclosed in angle brackets, so you can test for bounce messages with
34461 .code
34462 exiqgrep -f '^<>$'
34463 .endd
34464 .vitem &*-r*&&~<&'regex'&>
34465 Match a recipient address using a case-insensitve search. The field that is
34466 tested is not enclosed in angle brackets.
34467
34468 .vitem &*-s*&&~<&'regex'&>
34469 Match against the size field.
34470
34471 .vitem &*-y*&&~<&'seconds'&>
34472 Match messages that are younger than the given time.
34473
34474 .vitem &*-o*&&~<&'seconds'&>
34475 Match messages that are older than the given time.
34476
34477 .vitem &*-z*&
34478 Match only frozen messages.
34479
34480 .vitem &*-x*&
34481 Match only non-frozen messages.
34482 .endlist
34483
34484 The following options control the format of the output:
34485
34486 .vlist
34487 .vitem &*-c*&
34488 Display only the count of matching messages.
34489
34490 .vitem &*-l*&
34491 Long format &-- display the full message information as output by Exim. This is
34492 the default.
34493
34494 .vitem &*-i*&
34495 Display message ids only.
34496
34497 .vitem &*-b*&
34498 Brief format &-- one line per message.
34499
34500 .vitem &*-R*&
34501 Display messages in reverse order.
34502 .endlist
34503
34504 There is one more option, &%-h%&, which outputs a list of options.
34505
34506
34507
34508 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
34509 .cindex "&'exiqsumm'&"
34510 .cindex "queue" "summary"
34511 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
34512 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
34513 running a command such as
34514 .code
34515 exim -bp | exiqsumm
34516 .endd
34517 The output consists of one line for each domain that has messages waiting for
34518 it, as in the following example:
34519 .code
34520 3   2322   74m   66m  msn.com.example
34521 .endd
34522 Each line lists the number of pending deliveries for a domain, their total
34523 volume, and the length of time that the oldest and the newest messages have
34524 been waiting. Note that the number of pending deliveries is greater than the
34525 number of messages when messages have more than one recipient.
34526
34527 A summary line is output at the end. By default the output is sorted on the
34528 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
34529 the output to be sorted by oldest message and by count of messages,
34530 respectively. There are also three options that split the messages for each
34531 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
34532 separates frozen messages, and &%-s%& separates messages according to their
34533 sender.
34534
34535 The output of &'exim -bp'& contains the original addresses in the message, so
34536 this also applies to the output from &'exiqsumm'&. No domains from addresses
34537 generated by aliasing or forwarding are included (unless the &%one_time%&
34538 option of the &(redirect)& router has been used to convert them into &"top
34539 level"& addresses).
34540
34541
34542
34543
34544 .section "Extracting specific information from the log (exigrep)" &&&
34545          "SECTextspeinf"
34546 .cindex "&'exigrep'&"
34547 .cindex "log" "extracts; grepping for"
34548 The &'exigrep'& utility is a Perl script that searches one or more main log
34549 files for entries that match a given pattern. When it finds a match, it
34550 extracts all the log entries for the relevant message, not just those that
34551 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
34552 given message, or all mail for a given user, or for a given host, for example.
34553 The input files can be in Exim log format or syslog format.
34554 If a matching log line is not associated with a specific message, it is
34555 included in &'exigrep'&'s output without any additional lines. The usage is:
34556 .display
34557 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
34558 .endd
34559 If no log file names are given on the command line, the standard input is read.
34560
34561 The &%-t%& argument specifies a number of seconds. It adds an additional
34562 condition for message selection. Messages that are complete are shown only if
34563 they spent more than <&'n'&> seconds on the queue.
34564
34565 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
34566 makes it case-sensitive. This may give a performance improvement when searching
34567 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
34568 option; with &%-I%& they do not. In both cases it is possible to change the
34569 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
34570
34571 The &%-l%& option means &"literal"&, that is, treat all characters in the
34572 pattern as standing for themselves. Otherwise the pattern must be a Perl
34573 regular expression.
34574
34575 The &%-v%& option inverts the matching condition. That is, a line is selected
34576 if it does &'not'& match the pattern.
34577
34578 If the location of a &'zcat'& command is known from the definition of
34579 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
34580 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
34581
34582
34583 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
34584 .cindex "&'exipick'&"
34585 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
34586 lists messages from the queue according to a variety of criteria. For details
34587 of &'exipick'&'s facilities, visit the web page at
34588 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
34589 the &%--help%& option.
34590
34591
34592 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
34593 .cindex "log" "cycling local files"
34594 .cindex "cycling logs"
34595 .cindex "&'exicyclog'&"
34596 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
34597 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
34598 you are using log files with datestamps in their names (see section
34599 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
34600 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
34601 There are two command line options for &'exicyclog'&:
34602 .ilist
34603 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
34604 default that is set when Exim is built. The default default is 10.
34605 .next
34606 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
34607 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
34608 overriding the script's default, which is to find the setting from Exim's
34609 configuration.
34610 .endlist
34611
34612 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
34613 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
34614 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
34615 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
34616 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
34617 logs are handled similarly.
34618
34619 If the limit is greater than 99, the script uses 3-digit numbers such as
34620 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
34621 to one that is greater, or &'vice versa'&, you will have to fix the names of
34622 any existing log files.
34623
34624 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
34625 the end are deleted. All files with numbers greater than 01 are compressed,
34626 using a compression command which is configured by the COMPRESS_COMMAND
34627 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
34628 root &%crontab%& entry of the form
34629 .code
34630 1 0 * * * su exim -c /usr/exim/bin/exicyclog
34631 .endd
34632 assuming you have used the name &"exim"& for the Exim user. You can run
34633 &'exicyclog'& as root if you wish, but there is no need.
34634
34635
34636
34637 .section "Mail statistics (eximstats)" "SECTmailstat"
34638 .cindex "statistics"
34639 .cindex "&'eximstats'&"
34640 A Perl script called &'eximstats'& is provided for extracting statistical
34641 information from log files. The output is either plain text, or HTML.
34642 Exim log files are also supported by the &'Lire'& system produced by the
34643 LogReport Foundation &url(http://www.logreport.org).
34644
34645 The &'eximstats'& script has been hacked about quite a bit over time. The
34646 latest version is the result of some extensive revision by Steve Campbell. A
34647 lot of information is given by default, but there are options for suppressing
34648 various parts of it. Following any options, the arguments to the script are a
34649 list of files, which should be main log files. For example:
34650 .code
34651 eximstats -nr /var/spool/exim/log/mainlog.01
34652 .endd
34653 By default, &'eximstats'& extracts information about the number and volume of
34654 messages received from or delivered to various hosts. The information is sorted
34655 both by message count and by volume, and the top fifty hosts in each category
34656 are listed on the standard output. Similar information, based on email
34657 addresses or domains instead of hosts can be requested by means of various
34658 options. For messages delivered and received locally, similar statistics are
34659 also produced per user.
34660
34661 The output also includes total counts and statistics about delivery errors, and
34662 histograms showing the number of messages received and deliveries made in each
34663 hour of the day. A delivery with more than one address in its envelope (for
34664 example, an SMTP transaction with more than one RCPT command) is counted
34665 as a single delivery by &'eximstats'&.
34666
34667 Though normally more deliveries than receipts are reported (as messages may
34668 have multiple recipients), it is possible for &'eximstats'& to report more
34669 messages received than delivered, even though the queue is empty at the start
34670 and end of the period in question. If an incoming message contains no valid
34671 recipients, no deliveries are recorded for it. A bounce message is handled as
34672 an entirely separate message.
34673
34674 &'eximstats'& always outputs a grand total summary giving the volume and number
34675 of messages received and deliveries made, and the number of hosts involved in
34676 each case. It also outputs the number of messages that were delayed (that is,
34677 not completely delivered at the first attempt), and the number that had at
34678 least one address that failed.
34679
34680 The remainder of the output is in sections that can be independently disabled
34681 or modified by various options. It consists of a summary of deliveries by
34682 transport, histograms of messages received and delivered per time interval
34683 (default per hour), information about the time messages spent on the queue,
34684 a list of relayed messages, lists of the top fifty sending hosts, local
34685 senders, destination hosts, and destination local users by count and by volume,
34686 and a list of delivery errors that occurred.
34687
34688 The relay information lists messages that were actually relayed, that is, they
34689 came from a remote host and were directly delivered to some other remote host,
34690 without being processed (for example, for aliasing or forwarding) locally.
34691
34692 There are quite a few options for &'eximstats'& to control exactly what it
34693 outputs. These are documented in the Perl script itself, and can be extracted
34694 by running the command &(perldoc)& on the script. For example:
34695 .code
34696 perldoc /usr/exim/bin/eximstats
34697 .endd
34698
34699 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
34700 .cindex "&'exim_checkaccess'&"
34701 .cindex "policy control" "checking access"
34702 .cindex "checking access"
34703 The &%-bh%& command line argument allows you to run a fake SMTP session with
34704 debugging output, in order to check what Exim is doing when it is applying
34705 policy controls to incoming SMTP mail. However, not everybody is sufficiently
34706 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
34707 sometimes you just want to answer the question &"Does this address have
34708 access?"& without bothering with any further details.
34709
34710 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
34711 two arguments, an IP address and an email address:
34712 .code
34713 exim_checkaccess 10.9.8.7 A.User@a.domain.example
34714 .endd
34715 The utility runs a call to Exim with the &%-bh%& option, to test whether the
34716 given email address would be accepted in a RCPT command in a TCP/IP
34717 connection from the host with the given IP address. The output of the utility
34718 is either the word &"accepted"&, or the SMTP error response, for example:
34719 .code
34720 Rejected:
34721 550 Relay not permitted
34722 .endd
34723 When running this test, the utility uses &`<>`& as the envelope sender address
34724 for the MAIL command, but you can change this by providing additional
34725 options. These are passed directly to the Exim command. For example, to specify
34726 that the test is to be run with the sender address &'himself@there.example'&
34727 you can use:
34728 .code
34729 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34730                  -f himself@there.example
34731 .endd
34732 Note that these additional Exim command line items must be given after the two
34733 mandatory arguments.
34734
34735 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34736 while running its checks. You can run checks that include callouts by using
34737 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34738
34739
34740
34741 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34742 .cindex "DBM" "building dbm files"
34743 .cindex "building DBM files"
34744 .cindex "&'exim_dbmbuild'&"
34745 .cindex "lower casing"
34746 .cindex "binary zero" "in lookup key"
34747 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34748 the format used by the &(lsearch)& lookup (see section
34749 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34750 names as keys and the remainder of the information as data. The lower-casing
34751 can be prevented by calling the program with the &%-nolc%& option.
34752
34753 A terminating zero is included as part of the key string. This is expected by
34754 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34755 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34756 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34757 files.
34758
34759 The program requires two arguments: the name of the input file (which can be a
34760 single hyphen to indicate the standard input), and the name of the output file.
34761 It creates the output under a temporary name, and then renames it if all went
34762 well.
34763
34764 .cindex "USE_DB"
34765 If the native DB interface is in use (USE_DB is set in a compile-time
34766 configuration file &-- this is common in free versions of Unix) the two file
34767 names must be different, because in this mode the Berkeley DB functions create
34768 a single output file using exactly the name given. For example,
34769 .code
34770 exim_dbmbuild /etc/aliases /etc/aliases.db
34771 .endd
34772 reads the system alias file and creates a DBM version of it in
34773 &_/etc/aliases.db_&.
34774
34775 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34776 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34777 environment, the suffixes are added to the second argument of
34778 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34779 when the Berkeley functions are used in compatibility mode (though this is not
34780 recommended), because in that case it adds a &_.db_& suffix to the file name.
34781
34782 If a duplicate key is encountered, the program outputs a warning, and when it
34783 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34784 option is used. By default, only the first of a set of duplicates is used &--
34785 this makes it compatible with &(lsearch)& lookups. There is an option
34786 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34787 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34788 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34789 return code is 2.
34790
34791
34792
34793
34794 .section "Finding individual retry times (exinext)" "SECTfinindret"
34795 .cindex "retry" "times"
34796 .cindex "&'exinext'&"
34797 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34798 fish specific information out of the retry database. Given a mail domain (or a
34799 complete address), it looks up the hosts for that domain, and outputs any retry
34800 information for the hosts or for the domain. At present, the retry information
34801 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34802 output. For example:
34803 .code
34804 $ exinext piglet@milne.fict.example
34805 kanga.milne.example:192.168.8.1 error 146: Connection refused
34806   first failed: 21-Feb-1996 14:57:34
34807   last tried:   21-Feb-1996 14:57:34
34808   next try at:  21-Feb-1996 15:02:34
34809 roo.milne.example:192.168.8.3 error 146: Connection refused
34810   first failed: 20-Jan-1996 13:12:08
34811   last tried:   21-Feb-1996 11:42:03
34812   next try at:  21-Feb-1996 19:42:03
34813   past final cutoff time
34814 .endd
34815 You can also give &'exinext'& a local part, without a domain, and it
34816 will give any retry information for that local part in your default domain.
34817 A message id can be used to obtain retry information pertaining to a specific
34818 message. This exists only when an attempt to deliver a message to a remote host
34819 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34820 &'exinext'& is not particularly efficient, but then it is not expected to be
34821 run very often.
34822
34823 The &'exinext'& utility calls Exim to find out information such as the location
34824 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34825 passed on to the &'exim'& commands. The first specifies an alternate Exim
34826 configuration file, and the second sets macros for use within the configuration
34827 file. These features are mainly to help in testing, but might also be useful in
34828 environments where more than one configuration file is in use.
34829
34830
34831
34832 .section "Hints database maintenance" "SECThindatmai"
34833 .cindex "hints database" "maintenance"
34834 .cindex "maintaining Exim's hints database"
34835 Three utility programs are provided for maintaining the DBM files that Exim
34836 uses to contain its delivery hint information. Each program requires two
34837 arguments. The first specifies the name of Exim's spool directory, and the
34838 second is the name of the database it is to operate on. These are as follows:
34839
34840 .ilist
34841 &'retry'&: the database of retry information
34842 .next
34843 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34844 for remote hosts
34845 .next
34846 &'callout'&: the callout cache
34847 .next
34848 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34849 .next
34850 &'misc'&: other hints data
34851 .endlist
34852
34853 The &'misc'& database is used for
34854
34855 .ilist
34856 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34857 .next
34858 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34859 &(smtp)& transport)
34860 .endlist
34861
34862
34863
34864 .section "exim_dumpdb" "SECID261"
34865 .cindex "&'exim_dumpdb'&"
34866 The entire contents of a database are written to the standard output by the
34867 &'exim_dumpdb'& program, which has no options or arguments other than the
34868 spool and database names. For example, to dump the retry database:
34869 .code
34870 exim_dumpdb /var/spool/exim retry
34871 .endd
34872 Two lines of output are produced for each entry:
34873 .code
34874 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34875 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34876 .endd
34877 The first item on the first line is the key of the record. It starts with one
34878 of the letters R, or T, depending on whether it refers to a routing or
34879 transport retry. For a local delivery, the next part is the local address; for
34880 a remote delivery it is the name of the remote host, followed by its failing IP
34881 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34882 transport). If the remote port is not the standard one (port 25), it is added
34883 to the IP address. Then there follows an error code, an additional error code,
34884 and a textual description of the error.
34885
34886 The three times on the second line are the time of first failure, the time of
34887 the last delivery attempt, and the computed time for the next attempt. The line
34888 ends with an asterisk if the cutoff time for the last retry rule has been
34889 exceeded.
34890
34891 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34892 consists of a host name followed by a list of ids for messages that are or were
34893 waiting to be delivered to that host. If there are a very large number for any
34894 one host, continuation records, with a sequence number added to the host name,
34895 may be seen. The data in these records is often out of date, because a message
34896 may be routed to several alternative hosts, and Exim makes no effort to keep
34897 cross-references.
34898
34899
34900
34901 .section "exim_tidydb" "SECID262"
34902 .cindex "&'exim_tidydb'&"
34903 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34904 database. If run with no options, it removes all records that are more than 30
34905 days old. The age is calculated from the date and time that the record was last
34906 updated. Note that, in the case of the retry database, it is &'not'& the time
34907 since the first delivery failure. Information about a host that has been down
34908 for more than 30 days will remain in the database, provided that the record is
34909 updated sufficiently often.
34910
34911 The cutoff date can be altered by means of the &%-t%& option, which must be
34912 followed by a time. For example, to remove all records older than a week from
34913 the retry database:
34914 .code
34915 exim_tidydb -t 7d /var/spool/exim retry
34916 .endd
34917 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34918 message ids. In the former these appear as data in records keyed by host &--
34919 they were messages that were waiting for that host &-- and in the latter they
34920 are the keys for retry information for messages that have suffered certain
34921 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34922 message ids in database records are those of messages that are still on the
34923 queue. Message ids for messages that no longer exist are removed from
34924 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34925 For the &'retry'& database, records whose keys are non-existent message ids are
34926 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34927 whenever it removes information from the database.
34928
34929 Certain records are automatically removed by Exim when they are no longer
34930 needed, but others are not. For example, if all the MX hosts for a domain are
34931 down, a retry record is created for each one. If the primary MX host comes back
34932 first, its record is removed when Exim successfully delivers to it, but the
34933 records for the others remain because Exim has not tried to use those hosts.
34934
34935 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34936 hints databases. You should do this at a quiet time of day, because it requires
34937 a database to be locked (and therefore inaccessible to Exim) while it does its
34938 work. Removing records from a DBM file does not normally make the file smaller,
34939 but all the common DBM libraries are able to re-use the space that is released.
34940 After an initial phase of increasing in size, the databases normally reach a
34941 point at which they no longer get any bigger, as long as they are regularly
34942 tidied.
34943
34944 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34945 databases is likely to keep on increasing.
34946
34947
34948
34949
34950 .section "exim_fixdb" "SECID263"
34951 .cindex "&'exim_fixdb'&"
34952 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34953 Its main use is for testing Exim, but it might also be occasionally useful for
34954 getting round problems in a live system. It has no options, and its interface
34955 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34956 key of a database record can then be entered, and the data for that record is
34957 displayed.
34958
34959 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34960 except the &'retry'& database, that is the only operation that can be carried
34961 out. For the &'retry'& database, each field is output preceded by a number, and
34962 data for individual fields can be changed by typing the field number followed
34963 by new data, for example:
34964 .code
34965 > 4 951102:1000
34966 .endd
34967 resets the time of the next delivery attempt. Time values are given as a
34968 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34969 used as optional separators.
34970
34971
34972
34973
34974 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34975 .cindex "mailbox" "maintenance"
34976 .cindex "&'exim_lock'&"
34977 .cindex "locking mailboxes"
34978 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34979 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34980 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34981 a user agent while investigating a problem. The utility requires the name of
34982 the file as its first argument. If the locking is successful, the second
34983 argument is run as a command (using C's &[system()]& function); if there is no
34984 second argument, the value of the SHELL environment variable is used; if this
34985 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34986 is unlocked and the utility ends. The following options are available:
34987
34988 .vlist
34989 .vitem &%-fcntl%&
34990 Use &[fcntl()]& locking on the open mailbox.
34991
34992 .vitem &%-flock%&
34993 Use &[flock()]& locking on the open mailbox, provided the operating system
34994 supports it.
34995
34996 .vitem &%-interval%&
34997 This must be followed by a number, which is a number of seconds; it sets the
34998 interval to sleep between retries (default 3).
34999
35000 .vitem &%-lockfile%&
35001 Create a lock file before opening the mailbox.
35002
35003 .vitem &%-mbx%&
35004 Lock the mailbox using MBX rules.
35005
35006 .vitem &%-q%&
35007 Suppress verification output.
35008
35009 .vitem &%-retries%&
35010 This must be followed by a number; it sets the number of times to try to get
35011 the lock (default 10).
35012
35013 .vitem &%-restore_time%&
35014 This option causes &%exim_lock%& to restore the modified and read times to the
35015 locked file before exiting. This allows you to access a locked mailbox (for
35016 example, to take a backup copy) without disturbing the times that the user
35017 subsequently sees.
35018
35019 .vitem &%-timeout%&
35020 This must be followed by a number, which is a number of seconds; it sets a
35021 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35022 default), a non-blocking call is used.
35023
35024 .vitem &%-v%&
35025 Generate verbose output.
35026 .endlist
35027
35028 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35029 default is to create a lock file and also to use &[fcntl()]& locking on the
35030 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35031 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35032 requires that the directory containing the file be writeable. Locking by lock
35033 file does not last for ever; Exim assumes that a lock file is expired if it is
35034 more than 30 minutes old.
35035
35036 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35037 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35038 to be taken out on the open mailbox, and an exclusive lock on the file
35039 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35040 number of the mailbox file. When the locking is released, if an exclusive lock
35041 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35042
35043 The default output contains verification of the locking that takes place. The
35044 &%-v%& option causes some additional information to be given. The &%-q%& option
35045 suppresses all output except error messages.
35046
35047 A command such as
35048 .code
35049 exim_lock /var/spool/mail/spqr
35050 .endd
35051 runs an interactive shell while the file is locked, whereas
35052 .display
35053 &`exim_lock -q /var/spool/mail/spqr <<End`&
35054 <&'some commands'&>
35055 &`End`&
35056 .endd
35057 runs a specific non-interactive sequence of commands while the file is locked,
35058 suppressing all verification output. A single command can be run by a command
35059 such as
35060 .code
35061 exim_lock -q /var/spool/mail/spqr \
35062   "cp /var/spool/mail/spqr /some/where"
35063 .endd
35064 Note that if a command is supplied, it must be entirely contained within the
35065 second argument &-- hence the quotes.
35066 .ecindex IIDutils
35067
35068
35069 . ////////////////////////////////////////////////////////////////////////////
35070 . ////////////////////////////////////////////////////////////////////////////
35071
35072 .chapter "The Exim monitor" "CHAPeximon"
35073 .scindex IIDeximon "Exim monitor" "description"
35074 .cindex "X-windows"
35075 .cindex "&'eximon'&"
35076 .cindex "Local/eximon.conf"
35077 .cindex "&_exim_monitor/EDITME_&"
35078 The Exim monitor is an application which displays in an X window information
35079 about the state of Exim's queue and what Exim is doing. An admin user can
35080 perform certain operations on messages from this GUI interface; however all
35081 such facilities are also available from the command line, and indeed, the
35082 monitor itself makes use of the command line to perform any actions requested.
35083
35084
35085
35086 .section "Running the monitor" "SECID264"
35087 The monitor is started by running the script called &'eximon'&. This is a shell
35088 script that sets up a number of environment variables, and then runs the
35089 binary called &_eximon.bin_&. The default appearance of the monitor window can
35090 be changed by editing the &_Local/eximon.conf_& file created by editing
35091 &_exim_monitor/EDITME_&. Comments in that file describe what the various
35092 parameters are for.
35093
35094 The parameters that get built into the &'eximon'& script can be overridden for
35095 a particular invocation by setting up environment variables of the same names,
35096 preceded by &`EXIMON_`&. For example, a shell command such as
35097 .code
35098 EXIMON_LOG_DEPTH=400 eximon
35099 .endd
35100 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
35101 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
35102 overrides the Exim log file configuration. This makes it possible to have
35103 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
35104 syslog messages are routed to a file on the local host.
35105
35106 X resources can be used to change the appearance of the window in the normal
35107 way. For example, a resource setting of the form
35108 .code
35109 Eximon*background: gray94
35110 .endd
35111 changes the colour of the background to light grey rather than white. The
35112 stripcharts are drawn with both the data lines and the reference lines in
35113 black. This means that the reference lines are not visible when on top of the
35114 data. However, their colour can be changed by setting a resource called
35115 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
35116 For example, if your X server is running Unix, you could set up lighter
35117 reference lines in the stripcharts by obeying
35118 .code
35119 xrdb -merge <<End
35120 Eximon*highlight: gray
35121 End
35122 .endd
35123 .cindex "admin user"
35124 In order to see the contents of messages on the queue, and to operate on them,
35125 &'eximon'& must either be run as root or by an admin user.
35126
35127 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35128 contain X11 resource parameters interpreted by the X11 library.  In addition,
35129 if the first parameter starts with the string "gdb" then it is removed and the
35130 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35131 versioned variants of gdb can be invoked).
35132
35133 The monitor's window is divided into three parts. The first contains one or
35134 more stripcharts and two action buttons, the second contains a &"tail"& of the
35135 main log file, and the third is a display of the queue of messages awaiting
35136 delivery, with two more action buttons. The following sections describe these
35137 different parts of the display.
35138
35139
35140
35141
35142 .section "The stripcharts" "SECID265"
35143 .cindex "stripchart"
35144 The first stripchart is always a count of messages on the queue. Its name can
35145 be configured by setting QUEUE_STRIPCHART_NAME in the
35146 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35147 configuration script by regular expression matches on log file entries, making
35148 it possible to display, for example, counts of messages delivered to certain
35149 hosts or using certain transports. The supplied defaults display counts of
35150 received and delivered messages, and of local and SMTP deliveries. The default
35151 period between stripchart updates is one minute; this can be adjusted by a
35152 parameter in the &_Local/eximon.conf_& file.
35153
35154 The stripchart displays rescale themselves automatically as the value they are
35155 displaying changes. There are always 10 horizontal lines in each chart; the
35156 title string indicates the value of each division when it is greater than one.
35157 For example, &"x2"& means that each division represents a value of 2.
35158
35159 It is also possible to have a stripchart which shows the percentage fullness of
35160 a particular disk partition, which is useful when local deliveries are confined
35161 to a single partition.
35162
35163 .cindex "&%statvfs%& function"
35164 This relies on the availability of the &[statvfs()]& function or equivalent in
35165 the operating system. Most, but not all versions of Unix that support Exim have
35166 this. For this particular stripchart, the top of the chart always represents
35167 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35168 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35169 &_Local/eximon.conf_& file.
35170
35171
35172
35173
35174 .section "Main action buttons" "SECID266"
35175 .cindex "size" "of monitor window"
35176 .cindex "Exim monitor" "window size"
35177 .cindex "window size"
35178 Below the stripcharts there is an action button for quitting the monitor. Next
35179 to this is another button marked &"Size"&. They are placed here so that
35180 shrinking the window to its default minimum size leaves just the queue count
35181 stripchart and these two buttons visible. Pressing the &"Size"& button causes
35182 the window to expand to its maximum size, unless it is already at the maximum,
35183 in which case it is reduced to its minimum.
35184
35185 When expanding to the maximum, if the window cannot be fully seen where it
35186 currently is, it is moved back to where it was the last time it was at full
35187 size. When it is expanding from its minimum size, the old position is
35188 remembered, and next time it is reduced to the minimum it is moved back there.
35189
35190 The idea is that you can keep a reduced window just showing one or two
35191 stripcharts at a convenient place on your screen, easily expand it to show
35192 the full window when required, and just as easily put it back to what it was.
35193 The idea is copied from what the &'twm'& window manager does for its
35194 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
35195 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
35196
35197 Normally, the monitor starts up with the window at its full size, but it can be
35198 built so that it starts up with the window at its smallest size, by setting
35199 START_SMALL=yes in &_Local/eximon.conf_&.
35200
35201
35202
35203 .section "The log display" "SECID267"
35204 .cindex "log" "tail of; in monitor"
35205 The second section of the window is an area in which a display of the tail of
35206 the main log is maintained.
35207 To save space on the screen, the timestamp on each log line is shortened by
35208 removing the date and, if &%log_timezone%& is set, the timezone.
35209 The log tail is not available when the only destination for logging data is
35210 syslog, unless the syslog lines are routed to a local file whose name is passed
35211 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
35212
35213 The log sub-window has a scroll bar at its lefthand side which can be used to
35214 move back to look at earlier text, and the up and down arrow keys also have a
35215 scrolling effect. The amount of log that is kept depends on the setting of
35216 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
35217 to use. When this is full, the earlier 50% of data is discarded &-- this is
35218 much more efficient than throwing it away line by line. The sub-window also has
35219 a horizontal scroll bar for accessing the ends of long log lines. This is the
35220 only means of horizontal scrolling; the right and left arrow keys are not
35221 available. Text can be cut from this part of the window using the mouse in the
35222 normal way. The size of this subwindow is controlled by parameters in the
35223 configuration file &_Local/eximon.conf_&.
35224
35225 Searches of the text in the log window can be carried out by means of the ^R
35226 and ^S keystrokes, which default to a reverse and a forward search,
35227 respectively. The search covers only the text that is displayed in the window.
35228 It cannot go further back up the log.
35229
35230 The point from which the search starts is indicated by a caret marker. This is
35231 normally at the end of the text in the window, but can be positioned explicitly
35232 by pointing and clicking with the left mouse button, and is moved automatically
35233 by a successful search. If new text arrives in the window when it is scrolled
35234 back, the caret remains where it is, but if the window is not scrolled back,
35235 the caret is moved to the end of the new text.
35236
35237 Pressing ^R or ^S pops up a window into which the search text can be typed.
35238 There are buttons for selecting forward or reverse searching, for carrying out
35239 the search, and for cancelling. If the &"Search"& button is pressed, the search
35240 happens and the window remains so that further searches can be done. If the
35241 &"Return"& key is pressed, a single search is done and the window is closed. If
35242 ^C is typed the search is cancelled.
35243
35244 The searching facility is implemented using the facilities of the Athena text
35245 widget. By default this pops up a window containing both &"search"& and
35246 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
35247 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
35248 However, the linkers in BSDI and HP-UX seem unable to handle an externally
35249 provided version of &%TextPop%& when the remaining parts of the text widget
35250 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
35251 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
35252 on these systems, at the expense of having unwanted items in the search popup
35253 window.
35254
35255
35256
35257 .section "The queue display" "SECID268"
35258 .cindex "queue" "display in monitor"
35259 The bottom section of the monitor window contains a list of all messages that
35260 are on the queue, which includes those currently being received or delivered,
35261 as well as those awaiting delivery. The size of this subwindow is controlled by
35262 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
35263 at which it is updated is controlled by another parameter in the same file &--
35264 the default is 5 minutes, since queue scans can be quite expensive. However,
35265 there is an &"Update"& action button just above the display which can be used
35266 to force an update of the queue display at any time.
35267
35268 When a host is down for some time, a lot of pending mail can build up for it,
35269 and this can make it hard to deal with other messages on the queue. To help
35270 with this situation there is a button next to &"Update"& called &"Hide"&. If
35271 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
35272 type anything in here and press &"Return"&, the text is added to a chain of
35273 such texts, and if every undelivered address in a message matches at least one
35274 of the texts, the message is not displayed.
35275
35276 If there is an address that does not match any of the texts, all the addresses
35277 are displayed as normal. The matching happens on the ends of addresses so, for
35278 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
35279 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
35280 has been set up, a button called &"Unhide"& is displayed. If pressed, it
35281 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
35282 a hide request is automatically cancelled after one hour.
35283
35284 While the dialogue box is displayed, you can't press any buttons or do anything
35285 else to the monitor window. For this reason, if you want to cut text from the
35286 queue display to use in the dialogue box, you have to do the cutting before
35287 pressing the &"Hide"& button.
35288
35289 The queue display contains, for each unhidden queued message, the length of
35290 time it has been on the queue, the size of the message, the message id, the
35291 message sender, and the first undelivered recipient, all on one line. If it is
35292 a bounce message, the sender is shown as &"<>"&. If there is more than one
35293 recipient to which the message has not yet been delivered, subsequent ones are
35294 listed on additional lines, up to a maximum configured number, following which
35295 an ellipsis is displayed. Recipients that have already received the message are
35296 not shown.
35297
35298 .cindex "frozen messages" "display"
35299 If a message is frozen, an asterisk is displayed at the left-hand side.
35300
35301 The queue display has a vertical scroll bar, and can also be scrolled by means
35302 of the arrow keys. Text can be cut from it using the mouse in the normal way.
35303 The text searching facilities, as described above for the log window, are also
35304 available, but the caret is always moved to the end of the text when the queue
35305 display is updated.
35306
35307
35308
35309 .section "The queue menu" "SECID269"
35310 .cindex "queue" "menu in monitor"
35311 If the &%shift%& key is held down and the left button is clicked when the mouse
35312 pointer is over the text for any message, an action menu pops up, and the first
35313 line of the queue display for the message is highlighted. This does not affect
35314 any selected text.
35315
35316 If you want to use some other event for popping up the menu, you can set the
35317 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
35318 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
35319 value set in this parameter is a standard X event description. For example, to
35320 run eximon using &%ctrl%& rather than &%shift%& you could use
35321 .code
35322 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
35323 .endd
35324 The title of the menu is the message id, and it contains entries which act as
35325 follows:
35326
35327 .ilist
35328 &'message log'&: The contents of the message log for the message are displayed
35329 in a new text window.
35330 .next
35331 &'headers'&: Information from the spool file that contains the envelope
35332 information and headers is displayed in a new text window. See chapter
35333 &<<CHAPspool>>& for a description of the format of spool files.
35334 .next
35335 &'body'&: The contents of the spool file containing the body of the message are
35336 displayed in a new text window. There is a default limit of 20,000 bytes to the
35337 amount of data displayed. This can be changed by setting the BODY_MAX
35338 option at compile time, or the EXIMON_BODY_MAX option at run time.
35339 .next
35340 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
35341 delivery of the message. This causes an automatic thaw if the message is
35342 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
35343 a new text window. The delivery is run in a separate process, to avoid holding
35344 up the monitor while the delivery proceeds.
35345 .next
35346 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
35347 that the message be frozen.
35348 .next
35349 .cindex "thawing messages"
35350 .cindex "unfreezing messages"
35351 .cindex "frozen messages" "thawing"
35352 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
35353 that the message be thawed.
35354 .next
35355 .cindex "delivery" "forcing failure"
35356 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
35357 that Exim gives up trying to deliver the message. A bounce message is generated
35358 for any remaining undelivered addresses.
35359 .next
35360 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
35361 that the message be deleted from the system without generating a bounce
35362 message.
35363 .next
35364 &'add recipient'&: A dialog box is displayed into which a recipient address can
35365 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35366 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35367 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35368 causes a call to Exim to be made using the &%-Mar%& option to request that an
35369 additional recipient be added to the message, unless the entry box is empty, in
35370 which case no action is taken.
35371 .next
35372 &'mark delivered'&: A dialog box is displayed into which a recipient address
35373 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35374 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35375 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35376 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
35377 recipient address as already delivered, unless the entry box is empty, in which
35378 case no action is taken.
35379 .next
35380 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
35381 mark all recipient addresses as already delivered.
35382 .next
35383 &'edit sender'&: A dialog box is displayed initialized with the current
35384 sender's address. Pressing RETURN causes a call to Exim to be made using the
35385 &%-Mes%& option to replace the sender address, unless the entry box is empty,
35386 in which case no action is taken. If you want to set an empty sender (as in
35387 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
35388 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
35389 the address is qualified with that domain.
35390 .endlist
35391
35392 When a delivery is forced, a window showing the &%-v%& output is displayed. In
35393 other cases when a call to Exim is made, if there is any output from Exim (in
35394 particular, if the command fails) a window containing the command and the
35395 output is displayed. Otherwise, the results of the action are normally apparent
35396 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
35397 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
35398 if no output is generated.
35399
35400 The queue display is automatically updated for actions such as freezing and
35401 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
35402 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
35403 force an update of the display after one of these actions.
35404
35405 In any text window that is displayed as result of a menu action, the normal
35406 cut-and-paste facility is available, and searching can be carried out using ^R
35407 and ^S, as described above for the log tail window.
35408 .ecindex IIDeximon
35409
35410
35411
35412
35413
35414 . ////////////////////////////////////////////////////////////////////////////
35415 . ////////////////////////////////////////////////////////////////////////////
35416
35417 .chapter "Security considerations" "CHAPsecurity"
35418 .scindex IIDsecurcon "security" "discussion of"
35419 This chapter discusses a number of issues concerned with security, some of
35420 which are also covered in other parts of this manual.
35421
35422 For reasons that this author does not understand, some people have promoted
35423 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
35424 existence of this chapter in the documentation. However, the intent of the
35425 chapter is simply to describe the way Exim works in relation to certain
35426 security concerns, not to make any specific claims about the effectiveness of
35427 its security as compared with other MTAs.
35428
35429 What follows is a description of the way Exim is supposed to be. Best efforts
35430 have been made to try to ensure that the code agrees with the theory, but an
35431 absence of bugs can never be guaranteed. Any that are reported will get fixed
35432 as soon as possible.
35433
35434
35435 .section "Building a more &""hardened""& Exim" "SECID286"
35436 .cindex "security" "build-time features"
35437 There are a number of build-time options that can be set in &_Local/Makefile_&
35438 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
35439 Exim administrator who does not have the root password, or by someone who has
35440 penetrated the Exim (but not the root) account. These options are as follows:
35441
35442 .ilist
35443 ALT_CONFIG_PREFIX can be set to a string that is required to match the
35444 start of any file names used with the &%-C%& option. When it is set, these file
35445 names are also not allowed to contain the sequence &"/../"&. (However, if the
35446 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
35447 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
35448 default setting for &%ALT_CONFIG_PREFIX%&.
35449
35450 If the permitted configuration files are confined to a directory to
35451 which only root has access, this guards against someone who has broken
35452 into the Exim account from running a privileged Exim with an arbitrary
35453 configuration file, and using it to break into other accounts.
35454 .next
35455
35456 If a non-trusted configuration file (i.e. not the default configuration file
35457 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
35458 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
35459 the next item), then root privilege is retained only if the caller of Exim is
35460 root. This locks out the possibility of testing a configuration using &%-C%&
35461 right through message reception and delivery, even if the caller is root. The
35462 reception works, but by that time, Exim is running as the Exim user, so when
35463 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
35464 privilege to be lost. However, root can test reception and delivery using two
35465 separate commands.
35466
35467 .next
35468 The WHITELIST_D_MACROS build option declares some macros to be safe to override
35469 with &%-D%& if the real uid is one of root, the Exim run-time user or the
35470 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
35471 requiring the run-time value supplied to &%-D%& to match a regex that errs on
35472 the restrictive side.  Requiring build-time selection of safe macros is onerous
35473 but this option is intended solely as a transition mechanism to permit
35474 previously-working configurations to continue to work after release 4.73.
35475 .next
35476 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
35477 is disabled.
35478 .next
35479 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
35480 never to be used for any deliveries. This is like the &%never_users%& runtime
35481 option, but it cannot be overridden; the runtime option adds additional users
35482 to the list. The default setting is &"root"&; this prevents a non-root user who
35483 is permitted to modify the runtime file from using Exim as a way to get root.
35484 .endlist
35485
35486
35487
35488 .section "Root privilege" "SECID270"
35489 .cindex "setuid"
35490 .cindex "root privilege"
35491 The Exim binary is normally setuid to root, which means that it gains root
35492 privilege (runs as root) when it starts execution. In some special cases (for
35493 example, when the daemon is not in use and there are no local deliveries), it
35494 may be possible to run Exim setuid to some user other than root. This is
35495 discussed in the next section. However, in most installations, root privilege
35496 is required for two things:
35497
35498 .ilist
35499 To set up a socket connected to the standard SMTP port (25) when initialising
35500 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
35501 not required.
35502 .next
35503 To be able to change uid and gid in order to read users' &_.forward_& files and
35504 perform local deliveries as the receiving user or as specified in the
35505 configuration.
35506 .endlist
35507
35508 It is not necessary to be root to do any of the other things Exim does, such as
35509 receiving messages and delivering them externally over SMTP, and it is
35510 obviously more secure if Exim does not run as root except when necessary.
35511 For this reason, a user and group for Exim to use must be defined in
35512 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
35513 group"&. Their values can be changed by the run time configuration, though this
35514 is not recommended. Often a user called &'exim'& is used, but some sites use
35515 &'mail'& or another user name altogether.
35516
35517 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
35518 abdication; the process cannot regain root afterwards. Prior to release 4.00,
35519 &[seteuid()]& was used in some circumstances, but this is no longer the case.
35520
35521 After a new Exim process has interpreted its command line options, it changes
35522 uid and gid in the following cases:
35523
35524 .ilist
35525 .oindex "&%-C%&"
35526 .oindex "&%-D%&"
35527 If the &%-C%& option is used to specify an alternate configuration file, or if
35528 the &%-D%& option is used to define macro values for the configuration, and the
35529 calling process is not running as root, the uid and gid are changed to those of
35530 the calling process.
35531 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
35532 option may not be used at all.
35533 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
35534 can be supplied if the calling process is running as root, the Exim run-time
35535 user or CONFIGURE_OWNER, if defined.
35536 .next
35537 .oindex "&%-be%&"
35538 .oindex "&%-bf%&"
35539 .oindex "&%-bF%&"
35540 If the expansion test option (&%-be%&) or one of the filter testing options
35541 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
35542 calling process.
35543 .next
35544 If the process is not a daemon process or a queue runner process or a delivery
35545 process or a process for testing address routing (started with &%-bt%&), the
35546 uid and gid are changed to the Exim user and group. This means that Exim always
35547 runs under its own uid and gid when receiving messages. This also applies when
35548 testing address verification
35549 .oindex "&%-bv%&"
35550 .oindex "&%-bh%&"
35551 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
35552 option).
35553 .next
35554 For a daemon, queue runner, delivery, or address testing process, the uid
35555 remains as root at this stage, but the gid is changed to the Exim group.
35556 .endlist
35557
35558 The processes that initially retain root privilege behave as follows:
35559
35560 .ilist
35561 A daemon process changes the gid to the Exim group and the uid to the Exim
35562 user after setting up one or more listening sockets. The &[initgroups()]&
35563 function is called, so that if the Exim user is in any additional groups, they
35564 will be used during message reception.
35565 .next
35566 A queue runner process retains root privilege throughout its execution. Its
35567 job is to fork a controlled sequence of delivery processes.
35568 .next
35569 A delivery process retains root privilege throughout most of its execution,
35570 but any actual deliveries (that is, the transports themselves) are run in
35571 subprocesses which always change to a non-root uid and gid. For local
35572 deliveries this is typically the uid and gid of the owner of the mailbox; for
35573 remote deliveries, the Exim uid and gid are used. Once all the delivery
35574 subprocesses have been run, a delivery process changes to the Exim uid and gid
35575 while doing post-delivery tidying up such as updating the retry database and
35576 generating bounce and warning messages.
35577
35578 While the recipient addresses in a message are being routed, the delivery
35579 process runs as root. However, if a user's filter file has to be processed,
35580 this is done in a subprocess that runs under the individual user's uid and
35581 gid. A system filter is run as root unless &%system_filter_user%& is set.
35582 .next
35583 A process that is testing addresses (the &%-bt%& option) runs as root so that
35584 the routing is done in the same environment as a message delivery.
35585 .endlist
35586
35587
35588
35589
35590 .section "Running Exim without privilege" "SECTrunexiwitpri"
35591 .cindex "privilege, running without"
35592 .cindex "unprivileged running"
35593 .cindex "root privilege" "running without"
35594 Some installations like to run Exim in an unprivileged state for more of its
35595 operation, for added security. Support for this mode of operation is provided
35596 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
35597 gid are changed to the Exim user and group at the start of a delivery process
35598 (and also queue runner and address testing processes). This means that address
35599 routing is no longer run as root, and the deliveries themselves cannot change
35600 to any other uid.
35601
35602 .cindex SIGHUP
35603 .cindex "daemon" "restarting"
35604 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
35605 that the daemon can still be started in the usual way, and it can respond
35606 correctly to SIGHUP because the re-invocation regains root privilege.
35607
35608 An alternative approach is to make Exim setuid to the Exim user and also setgid
35609 to the Exim group. If you do this, the daemon must be started from a root
35610 process. (Calling Exim from a root process makes it behave in the way it does
35611 when it is setuid root.) However, the daemon cannot restart itself after a
35612 SIGHUP signal because it cannot regain privilege.
35613
35614 It is still useful to set &%deliver_drop_privilege%& in this case, because it
35615 stops Exim from trying to re-invoke itself to do a delivery after a message has
35616 been received. Such a re-invocation is a waste of resources because it has no
35617 effect.
35618
35619 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
35620 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
35621 to the Exim user seems a clean approach, but there is one complication:
35622
35623 In this style of operation, Exim is running with the real uid and gid set to
35624 those of the calling process, and the effective uid/gid set to Exim's values.
35625 Ideally, any association with the calling process' uid/gid should be dropped,
35626 that is, the real uid/gid should be reset to the effective values so as to
35627 discard any privileges that the caller may have. While some operating systems
35628 have a function that permits this action for a non-root effective uid, quite a
35629 number of them do not. Because of this lack of standardization, Exim does not
35630 address this problem at this time.
35631
35632 For this reason, the recommended approach for &"mostly unprivileged"& running
35633 is to keep the Exim binary setuid to root, and to set
35634 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
35635 be used in the most straightforward way.
35636
35637 If you configure Exim not to run delivery processes as root, there are a
35638 number of restrictions on what you can do:
35639
35640 .ilist
35641 You can deliver only as the Exim user/group. You should  explicitly use the
35642 &%user%& and &%group%& options to override routers or local transports that
35643 normally deliver as the recipient. This makes sure that configurations that
35644 work in this mode function the same way in normal mode. Any implicit or
35645 explicit specification of another user causes an error.
35646 .next
35647 Use of &_.forward_& files is severely restricted, such that it is usually
35648 not worthwhile to include them in the configuration.
35649 .next
35650 Users who wish to use &_.forward_& would have to make their home directory and
35651 the file itself accessible to the Exim user. Pipe and append-to-file entries,
35652 and their equivalents in Exim filters, cannot be used. While they could be
35653 enabled in the Exim user's name, that would be insecure and not very useful.
35654 .next
35655 Unless the local user mailboxes are all owned by the Exim user (possible in
35656 some POP3 or IMAP-only environments):
35657
35658 .olist
35659 They must be owned by the Exim group and be writeable by that group. This
35660 implies you must set &%mode%& in the appendfile configuration, as well as the
35661 mode of the mailbox files themselves.
35662 .next
35663 You must set &%no_check_owner%&, since most or all of the files will not be
35664 owned by the Exim user.
35665 .next
35666 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
35667 on a newly created mailbox when unprivileged. This also implies that new
35668 mailboxes need to be created manually.
35669 .endlist olist
35670 .endlist ilist
35671
35672
35673 These restrictions severely restrict what can be done in local deliveries.
35674 However, there are no restrictions on remote deliveries. If you are running a
35675 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
35676 gives more security at essentially no cost.
35677
35678 If you are using the &%mua_wrapper%& facility (see chapter
35679 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
35680
35681
35682
35683
35684 .section "Delivering to local files" "SECID271"
35685 Full details of the checks applied by &(appendfile)& before it writes to a file
35686 are given in chapter &<<CHAPappendfile>>&.
35687
35688
35689
35690 .section "Running local commands" "SECTsecconslocalcmds"
35691 There are a number of ways in which an administrator can configure Exim to run
35692 commands based upon received, untrustworthy, data. Further, in some
35693 configurations a user who can control a &_.forward_& file can also arrange to
35694 run commands. Configuration to check includes, but is not limited to:
35695
35696 .ilist
35697 Use of &%use_shell%& in the pipe transport: various forms of shell command
35698 injection may be possible with this option present. It is dangerous and should
35699 be used only with considerable caution. Consider constraints which whitelist
35700 allowed characters in a variable which is to be used in a pipe transport that
35701 has &%use_shell%& enabled.
35702 .next
35703 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
35704 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
35705 &_.forward_& files in a redirect router. If Exim is running on a central mail
35706 hub to which ordinary users do not have shell access, but home directories are
35707 NFS mounted (for instance) then administrators should review the list of these
35708 forbid options available, and should bear in mind that the options that may
35709 need forbidding can change as new features are added between releases.
35710 .next
35711 The &%${run...}%& expansion item does not use a shell by default, but
35712 administrators can configure use of &_/bin/sh_& as part of the command.
35713 Such invocations should be viewed with prejudicial suspicion.
35714 .next
35715 Administrators who use embedded Perl are advised to explore how Perl's
35716 taint checking might apply to their usage.
35717 .next
35718 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
35719 administrators are well advised to view its use with suspicion, in case (for
35720 instance) it allows a local-part to contain embedded Exim directives.
35721 .next
35722 Use of &%${match_local_part...}%& and friends becomes more dangerous if
35723 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
35724 each can reference arbitrary lists and files, rather than just being a list
35725 of opaque strings.
35726 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
35727 real-world security vulnerabilities caused by its use with untrustworthy data
35728 injected in, for SQL injection attacks.
35729 Consider the use of the &%inlisti%& expansion condition instead.
35730 .endlist
35731
35732
35733
35734 .section "IPv4 source routing" "SECID272"
35735 .cindex "source routing" "in IP packets"
35736 .cindex "IP source routing"
35737 Many operating systems suppress IP source-routed packets in the kernel, but
35738 some cannot be made to do this, so Exim does its own check. It logs incoming
35739 IPv4 source-routed TCP calls, and then drops them. Things are all different in
35740 IPv6. No special checking is currently done.
35741
35742
35743
35744 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
35745 Support for these SMTP commands is disabled by default. If required, they can
35746 be enabled by defining suitable ACLs.
35747
35748
35749
35750
35751 .section "Privileged users" "SECID274"
35752 .cindex "trusted users"
35753 .cindex "admin user"
35754 .cindex "privileged user"
35755 .cindex "user" "trusted"
35756 .cindex "user" "admin"
35757 Exim recognizes two sets of users with special privileges. Trusted users are
35758 able to submit new messages to Exim locally, but supply their own sender
35759 addresses and information about a sending host. For other users submitting
35760 local messages, Exim sets up the sender address from the uid, and doesn't
35761 permit a remote host to be specified.
35762
35763 .oindex "&%-f%&"
35764 However, an untrusted user is permitted to use the &%-f%& command line option
35765 in the special form &%-f <>%& to indicate that a delivery failure for the
35766 message should not cause an error report. This affects the message's envelope,
35767 but it does not affect the &'Sender:'& header. Untrusted users may also be
35768 permitted to use specific forms of address with the &%-f%& option by setting
35769 the &%untrusted_set_sender%& option.
35770
35771 Trusted users are used to run processes that receive mail messages from some
35772 other mail domain and pass them on to Exim for delivery either locally, or over
35773 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35774 as any user listed in the &%trusted_users%& configuration option, or under any
35775 group listed in the &%trusted_groups%& option.
35776
35777 Admin users are permitted to do things to the messages on Exim's queue. They
35778 can freeze or thaw messages, cause them to be returned to their senders, remove
35779 them entirely, or modify them in various ways. In addition, admin users can run
35780 the Exim monitor and see all the information it is capable of providing, which
35781 includes the contents of files on the spool.
35782
35783 .oindex "&%-M%&"
35784 .oindex "&%-q%&"
35785 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35786 delivery of messages on its queue is restricted to admin users. This
35787 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35788 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35789 queue is also restricted to admin users. This restriction can be relaxed by
35790 setting &%no_queue_list_requires_admin%&.
35791
35792 Exim recognizes an admin user if the calling process is running as root or as
35793 the Exim user or if any of the groups associated with the calling process is
35794 the Exim group. It is not necessary actually to be running under the Exim
35795 group. However, if admin users who are not root or the Exim user are to access
35796 the contents of files on the spool via the Exim monitor (which runs
35797 unprivileged), Exim must be built to allow group read access to its spool
35798 files.
35799
35800
35801
35802 .section "Spool files" "SECID275"
35803 .cindex "spool directory" "files"
35804 Exim's spool directory and everything it contains is owned by the Exim user and
35805 set to the Exim group. The mode for spool files is defined in the
35806 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35807 any user who is a member of the Exim group can access these files.
35808
35809
35810
35811 .section "Use of argv[0]" "SECID276"
35812 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35813 of specific strings, Exim assumes certain options. For example, calling Exim
35814 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35815 to calling it with the option &%-bS%&. There are no security implications in
35816 this.
35817
35818
35819
35820 .section "Use of %f formatting" "SECID277"
35821 The only use made of &"%f"& by Exim is in formatting load average values. These
35822 are actually stored in integer variables as 1000 times the load average.
35823 Consequently, their range is limited and so therefore is the length of the
35824 converted output.
35825
35826
35827
35828 .section "Embedded Exim path" "SECID278"
35829 Exim uses its own path name, which is embedded in the code, only when it needs
35830 to re-exec in order to regain root privilege. Therefore, it is not root when it
35831 does so. If some bug allowed the path to get overwritten, it would lead to an
35832 arbitrary program's being run as exim, not as root.
35833
35834
35835
35836 .section "Dynamic module directory" "SECTdynmoddir"
35837 Any dynamically loadable modules must be installed into the directory
35838 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35839 loading it.
35840
35841
35842 .section "Use of sprintf()" "SECID279"
35843 .cindex "&[sprintf()]&"
35844 A large number of occurrences of &"sprintf"& in the code are actually calls to
35845 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35846 The intermediate formatting is done into a large fixed buffer by a function
35847 that runs through the format string itself, and checks the length of each
35848 conversion before performing it, thus preventing buffer overruns.
35849
35850 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35851 the output buffer is known to be sufficiently long to contain the converted
35852 string.
35853
35854
35855
35856 .section "Use of debug_printf() and log_write()" "SECID280"
35857 Arbitrary strings are passed to both these functions, but they do their
35858 formatting by calling the function &'string_vformat()'&, which runs through
35859 the format string itself, and checks the length of each conversion.
35860
35861
35862
35863 .section "Use of strcat() and strcpy()" "SECID281"
35864 These are used only in cases where the output buffer is known to be large
35865 enough to hold the result.
35866 .ecindex IIDsecurcon
35867
35868
35869
35870
35871 . ////////////////////////////////////////////////////////////////////////////
35872 . ////////////////////////////////////////////////////////////////////////////
35873
35874 .chapter "Format of spool files" "CHAPspool"
35875 .scindex IIDforspo1 "format" "spool files"
35876 .scindex IIDforspo2 "spool directory" "format of files"
35877 .scindex IIDforspo3 "spool files" "format of"
35878 .cindex "spool files" "editing"
35879 A message on Exim's queue consists of two files, whose names are the message id
35880 followed by -D and -H, respectively. The data portion of the message is kept in
35881 the -D file on its own. The message's envelope, status, and headers are all
35882 kept in the -H file, whose format is described in this chapter. Each of these
35883 two files contains the final component of its own name as its first line. This
35884 is insurance against disk crashes where the directory is lost but the files
35885 themselves are recoverable.
35886
35887 Some people are tempted into editing -D files in order to modify messages. You
35888 need to be extremely careful if you do this; it is not recommended and you are
35889 on your own if you do it. Here are some of the pitfalls:
35890
35891 .ilist
35892 You must ensure that Exim does not try to deliver the message while you are
35893 fiddling with it. The safest way is to take out a write lock on the -D file,
35894 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35895 place, the lock will be retained. If you write a new file and rename it, the
35896 lock will be lost at the instant of rename.
35897 .next
35898 .vindex "&$body_linecount$&"
35899 If you change the number of lines in the file, the value of
35900 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35901 present, this value is not used by Exim, but there is no guarantee that this
35902 will always be the case.
35903 .next
35904 If the message is in MIME format, you must take care not to break it.
35905 .next
35906 If the message is cryptographically signed, any change will invalidate the
35907 signature.
35908 .endlist
35909 All in all, modifying -D files is fraught with danger.
35910
35911 Files whose names end with -J may also be seen in the &_input_& directory (or
35912 its subdirectories when &%split_spool_directory%& is set). These are journal
35913 files, used to record addresses to which the message has been delivered during
35914 the course of a delivery attempt. If there are still undelivered recipients at
35915 the end, the -H file is updated, and the -J file is deleted. If, however, there
35916 is some kind of crash (for example, a power outage) before this happens, the -J
35917 file remains in existence. When Exim next processes the message, it notices the
35918 -J file and uses it to update the -H file before starting the next delivery
35919 attempt.
35920
35921 .section "Format of the -H file" "SECID282"
35922 .cindex "uid (user id)" "in spool file"
35923 .cindex "gid (group id)" "in spool file"
35924 The second line of the -H file contains the login name for the uid of the
35925 process that called Exim to read the message, followed by the numerical uid and
35926 gid. For a locally generated message, this is normally the user who sent the
35927 message. For a message received over TCP/IP via the daemon, it is
35928 normally the Exim user.
35929
35930 The third line of the file contains the address of the message's sender as
35931 transmitted in the envelope, contained in angle brackets. The sender address is
35932 empty for bounce messages. For incoming SMTP mail, the sender address is given
35933 in the MAIL command. For locally generated mail, the sender address is
35934 created by Exim from the login name of the current user and the configured
35935 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35936 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35937 &"<>"& or an address that matches &%untrusted_set_senders%&.
35938
35939 The fourth line contains two numbers. The first is the time that the message
35940 was received, in the conventional Unix form &-- the number of seconds since the
35941 start of the epoch. The second number is a count of the number of messages
35942 warning of delayed delivery that have been sent to the sender.
35943
35944 There follow a number of lines starting with a hyphen. These can appear in any
35945 order, and are omitted when not relevant:
35946
35947 .vlist
35948 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35949 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35950 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35951 recognized, to provide backward compatibility. In the old format, a line of
35952 this form is present for every ACL variable that is not empty. The number
35953 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35954 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35955 the data string for the variable. The string itself starts at the beginning of
35956 the next line, and is followed by a newline character. It may contain internal
35957 newlines.
35958
35959 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35960 A line of this form is present for every ACL connection variable that is
35961 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35962 The length is the length of the data string for the variable. The string itself
35963 starts at the beginning of the next line, and is followed by a newline
35964 character. It may contain internal newlines.
35965
35966 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35967 A line of this form is present for every ACL message variable that is defined.
35968 Note that there is a space between &%-aclm%& and the rest of the name. The
35969 length is the length of the data string for the variable. The string itself
35970 starts at the beginning of the next line, and is followed by a newline
35971 character. It may contain internal newlines.
35972
35973 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35974 This is present if, when the message was received over SMTP, the value of
35975 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35976
35977 .vitem &%-allow_unqualified_recipient%&
35978 This is present if unqualified recipient addresses are permitted in header
35979 lines (to stop such addresses from being qualified if rewriting occurs at
35980 transport time). Local messages that were input using &%-bnq%& and remote
35981 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35982
35983 .vitem &%-allow_unqualified_sender%&
35984 This is present if unqualified sender addresses are permitted in header lines
35985 (to stop such addresses from being qualified if rewriting occurs at transport
35986 time). Local messages that were input using &%-bnq%& and remote messages from
35987 hosts that match &%sender_unqualified_hosts%& set this flag.
35988
35989 .vitem "&%-auth_id%&&~<&'text'&>"
35990 The id information for a message received on an authenticated SMTP connection
35991 &-- the value of the &$authenticated_id$& variable.
35992
35993 .vitem "&%-auth_sender%&&~<&'address'&>"
35994 The address of an authenticated sender &-- the value of the
35995 &$authenticated_sender$& variable.
35996
35997 .vitem "&%-body_linecount%&&~<&'number'&>"
35998 This records the number of lines in the body of the message, and is always
35999 present.
36000
36001 .vitem "&%-body_zerocount%&&~<&'number'&>"
36002 This records the number of binary zero bytes in the body of the message, and is
36003 present if the number is greater than zero.
36004
36005 .vitem &%-deliver_firsttime%&
36006 This is written when a new message is first added to the spool. When the spool
36007 file is updated after a deferral, it is omitted.
36008
36009 .vitem "&%-frozen%&&~<&'time'&>"
36010 .cindex "frozen messages" "spool data"
36011 The message is frozen, and the freezing happened at <&'time'&>.
36012
36013 .vitem "&%-helo_name%&&~<&'text'&>"
36014 This records the host name as specified by a remote host in a HELO or EHLO
36015 command.
36016
36017 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36018 This records the IP address of the host from which the message was received and
36019 the remote port number that was used. It is omitted for locally generated
36020 messages.
36021
36022 .vitem "&%-host_auth%&&~<&'text'&>"
36023 If the message was received on an authenticated SMTP connection, this records
36024 the name of the authenticator &-- the value of the
36025 &$sender_host_authenticated$& variable.
36026
36027 .vitem &%-host_lookup_failed%&
36028 This is present if an attempt to look up the sending host's name from its IP
36029 address failed. It corresponds to the &$host_lookup_failed$& variable.
36030
36031 .vitem "&%-host_name%&&~<&'text'&>"
36032 .cindex "reverse DNS lookup"
36033 .cindex "DNS" "reverse lookup"
36034 This records the name of the remote host from which the message was received,
36035 if the host name was looked up from the IP address when the message was being
36036 received. It is not present if no reverse lookup was done.
36037
36038 .vitem "&%-ident%&&~<&'text'&>"
36039 For locally submitted messages, this records the login of the originating user,
36040 unless it was a trusted user and the &%-oMt%& option was used to specify an
36041 ident value. For messages received over TCP/IP, this records the ident string
36042 supplied by the remote host, if any.
36043
36044 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
36045 This records the IP address of the local interface and the port number through
36046 which a message was received from a remote host. It is omitted for locally
36047 generated messages.
36048
36049 .vitem &%-local%&
36050 The message is from a local sender.
36051
36052 .vitem &%-localerror%&
36053 The message is a locally-generated bounce message.
36054
36055 .vitem "&%-local_scan%&&~<&'string'&>"
36056 This records the data string that was returned by the &[local_scan()]& function
36057 when the message was received &-- the value of the &$local_scan_data$&
36058 variable. It is omitted if no data was returned.
36059
36060 .vitem &%-manual_thaw%&
36061 The message was frozen but has been thawed manually, that is, by an explicit
36062 Exim command rather than via the auto-thaw process.
36063
36064 .vitem &%-N%&
36065 A testing delivery process was started using the &%-N%& option to suppress any
36066 actual deliveries, but delivery was deferred. At any further delivery attempts,
36067 &%-N%& is assumed.
36068
36069 .vitem &%-received_protocol%&
36070 This records the value of the &$received_protocol$& variable, which contains
36071 the name of the protocol by which the message was received.
36072
36073 .vitem &%-sender_set_untrusted%&
36074 The envelope sender of this message was set by an untrusted local caller (used
36075 to ensure that the caller is displayed in queue listings).
36076
36077 .vitem "&%-spam_score_int%&&~<&'number'&>"
36078 If a message was scanned by SpamAssassin, this is present. It records the value
36079 of &$spam_score_int$&.
36080
36081 .vitem &%-tls_certificate_verified%&
36082 A TLS certificate was received from the client that sent this message, and the
36083 certificate was verified by the server.
36084
36085 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
36086 When the message was received over an encrypted connection, this records the
36087 name of the cipher suite that was used.
36088
36089 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
36090 When the message was received over an encrypted connection, and a certificate
36091 was received from the client, this records the Distinguished Name from that
36092 certificate.
36093 .endlist
36094
36095 Following the options there is a list of those addresses to which the message
36096 is not to be delivered. This set of addresses is initialized from the command
36097 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
36098 is set; otherwise it starts out empty. Whenever a successful delivery is made,
36099 the address is added to this set. The addresses are kept internally as a
36100 balanced binary tree, and it is a representation of that tree which is written
36101 to the spool file. If an address is expanded via an alias or forward file, the
36102 original address is added to the tree when deliveries to all its child
36103 addresses are complete.
36104
36105 If the tree is empty, there is a single line in the spool file containing just
36106 the text &"XX"&. Otherwise, each line consists of two letters, which are either
36107 Y or N, followed by an address. The address is the value for the node of the
36108 tree, and the letters indicate whether the node has a left branch and/or a
36109 right branch attached to it, respectively. If branches exist, they immediately
36110 follow. Here is an example of a three-node tree:
36111 .code
36112 YY darcy@austen.fict.example
36113 NN alice@wonderland.fict.example
36114 NN editor@thesaurus.ref.example
36115 .endd
36116 After the non-recipients tree, there is a list of the message's recipients.
36117 This is a simple list, preceded by a count. It includes all the original
36118 recipients of the message, including those to whom the message has already been
36119 delivered. In the simplest case, the list contains one address per line. For
36120 example:
36121 .code
36122 4
36123 editor@thesaurus.ref.example
36124 darcy@austen.fict.example
36125 rdo@foundation
36126 alice@wonderland.fict.example
36127 .endd
36128 However, when a child address has been added to the top-level addresses as a
36129 result of the use of the &%one_time%& option on a &(redirect)& router, each
36130 line is of the following form:
36131 .display
36132 <&'top-level address'&> <&'errors_to address'&> &&&
36133   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
36134 .endd
36135 The 01 flag bit indicates the presence of the three other fields that follow
36136 the top-level address. Other bits may be used in future to support additional
36137 fields. The <&'parent number'&> is the offset in the recipients list of the
36138 original parent of the &"one time"& address. The first two fields are the
36139 envelope sender that is associated with this address and its length. If the
36140 length is zero, there is no special envelope sender (there are then two space
36141 characters in the line). A non-empty field can arise from a &(redirect)& router
36142 that has an &%errors_to%& setting.
36143
36144
36145 A blank line separates the envelope and status information from the headers
36146 which follow. A header may occupy several lines of the file, and to save effort
36147 when reading it in, each header is preceded by a number and an identifying
36148 character. The number is the number of characters in the header, including any
36149 embedded newlines and the terminating newline. The character is one of the
36150 following:
36151
36152 .table2 50pt
36153 .row <&'blank'&>         "header in which Exim has no special interest"
36154 .row &`B`&               "&'Bcc:'& header"
36155 .row &`C`&               "&'Cc:'& header"
36156 .row &`F`&               "&'From:'& header"
36157 .row &`I`&               "&'Message-id:'& header"
36158 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
36159 .row &`R`&               "&'Reply-To:'& header"
36160 .row &`S`&               "&'Sender:'& header"
36161 .row &`T`&               "&'To:'& header"
36162 .row &`*`&               "replaced or deleted header"
36163 .endtable
36164
36165 Deleted or replaced (rewritten) headers remain in the spool file for debugging
36166 purposes. They are not transmitted when the message is delivered. Here is a
36167 typical set of headers:
36168 .code
36169 111P Received: by hobbit.fict.example with local (Exim 4.00)
36170 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
36171 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
36172 038* X-rewrote-sender: bb@hobbit.fict.example
36173 042* From: Bilbo Baggins <bb@hobbit.fict.example>
36174 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
36175 099* To: alice@wonderland.fict.example, rdo@foundation,
36176 darcy@austen.fict.example, editor@thesaurus.ref.example
36177 104T To: alice@wonderland.fict.example, rdo@foundation.example,
36178 darcy@austen.fict.example, editor@thesaurus.ref.example
36179 038  Date: Fri, 11 May 2001 10:28:59 +0100
36180 .endd
36181 The asterisked headers indicate that the envelope sender, &'From:'& header, and
36182 &'To:'& header have been rewritten, the last one because routing expanded the
36183 unqualified domain &'foundation'&.
36184 .ecindex IIDforspo1
36185 .ecindex IIDforspo2
36186 .ecindex IIDforspo3
36187
36188 . ////////////////////////////////////////////////////////////////////////////
36189 . ////////////////////////////////////////////////////////////////////////////
36190
36191 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
36192          "DKIM Support"
36193 .cindex "DKIM"
36194
36195 DKIM is a mechanism by which messages sent by some entity can be provably
36196 linked to a domain which that entity controls.  It permits reputation to
36197 be tracked on a per-domain basis, rather than merely upon source IP address.
36198 DKIM is documented in RFC 4871.
36199
36200 Since version 4.70, DKIM support is compiled into Exim by default. It can be
36201 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
36202
36203 Exim's DKIM implementation allows to
36204 .olist
36205 Sign outgoing messages: This function is implemented in the SMTP transport.
36206 It can co-exist with all other Exim features, including transport filters.
36207 .next
36208 Verify signatures in incoming messages: This is implemented by an additional
36209 ACL (acl_smtp_dkim), which can be called several times per message, with
36210 different signature contexts.
36211 .endlist
36212
36213 In typical Exim style, the verification implementation does not include any
36214 default "policy". Instead it enables you to build your own policy using
36215 Exim's standard controls.
36216
36217 Please note that verification of DKIM signatures in incoming mail is turned
36218 on by default for logging purposes. For each signature in incoming email,
36219 exim will log a line displaying the most important signature details, and the
36220 signature status. Here is an example (with line-breaks added for clarity):
36221 .code
36222 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
36223     d=facebookmail.com s=q1-2009b
36224     c=relaxed/relaxed a=rsa-sha1
36225     i=@facebookmail.com t=1252484542 [verification succeeded]
36226 .endd
36227 You might want to turn off DKIM verification processing entirely for internal
36228 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
36229 control modifier. This should typically be done in the RCPT ACL, at points
36230 where you accept mail from relay sources (internal hosts or authenticated
36231 senders).
36232
36233
36234 .section "Signing outgoing messages" "SECID513"
36235 .cindex "DKIM" "signing"
36236
36237 Signing is implemented by setting private options on the SMTP transport.
36238 These options take (expandable) strings as arguments.
36239
36240 .option dkim_domain smtp string&!! unset
36241 MANDATORY:
36242 The domain you want to sign with. The result of this expanded
36243 option is put into the &%$dkim_domain%& expansion variable.
36244
36245 .option dkim_selector smtp string&!! unset
36246 MANDATORY:
36247 This sets the key selector string. You can use the &%$dkim_domain%& expansion
36248 variable to look up a matching selector. The result is put in the expansion
36249 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
36250 option along with &%$dkim_domain%&.
36251
36252 .option dkim_private_key smtp string&!! unset
36253 MANDATORY:
36254 This sets the private key to use. You can use the &%$dkim_domain%& and
36255 &%$dkim_selector%& expansion variables to determine the private key to use.
36256 The result can either
36257 .ilist
36258 be a valid RSA private key in ASCII armor, including line breaks.
36259 .next
36260 start with a slash, in which case it is treated as a file that contains
36261 the private key.
36262 .next
36263 be "0", "false" or the empty string, in which case the message will not
36264 be signed. This case will not result in an error, even if &%dkim_strict%&
36265 is set.
36266 .endlist
36267
36268 .option dkim_canon smtp string&!! unset
36269 OPTIONAL:
36270 This option sets the canonicalization method used when signing a message.
36271 The DKIM RFC currently supports two methods: "simple" and "relaxed".
36272 The option defaults to "relaxed" when unset. Note: the current implementation
36273 only supports using the same canonicalization method for both headers and body.
36274
36275 .option dkim_strict smtp string&!! unset
36276 OPTIONAL:
36277 This  option  defines  how  Exim  behaves  when  signing a message that
36278 should be signed fails for some reason.  When the expansion evaluates to
36279 either "1" or "true", Exim will defer. Otherwise Exim will send the message
36280 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
36281 variables here.
36282
36283 .option dkim_sign_headers smtp string&!! unset
36284 OPTIONAL:
36285 When set, this option must expand to (or be specified as) a colon-separated
36286 list of header names. Headers with these names will be included in the message
36287 signature. When unspecified, the header names recommended in RFC4871 will be
36288 used.
36289
36290
36291 .section "Verifying DKIM signatures in incoming mail" "SECID514"
36292 .cindex "DKIM" "verification"
36293
36294 Verification of DKIM signatures in incoming email is implemented via the
36295 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
36296 syntactically(!) correct signature in the incoming message.
36297
36298 To evaluate the signature in the ACL a large number of expansion variables
36299 containing the signature status and its details are set up during the
36300 runtime of the ACL.
36301
36302 Calling the ACL only for existing signatures is not sufficient to build
36303 more advanced policies. For that reason, the global option
36304 &%dkim_verify_signers%&, and a global expansion variable
36305 &%$dkim_signers%& exist.
36306
36307 The global option &%dkim_verify_signers%& can be set to a colon-separated
36308 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
36309 called. It is expanded when the message has been received. At this point,
36310 the expansion variable &%$dkim_signers%& already contains a colon-separated
36311 list of signer domains and identities for the message. When
36312 &%dkim_verify_signers%& is not specified in the main configuration,
36313 it defaults as:
36314 .code
36315 dkim_verify_signers = $dkim_signers
36316 .endd
36317 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
36318 DKIM signature in the message. Current DKIM verifiers may want to explicitly
36319 call the ACL for known domains or identities. This would be achieved as follows:
36320 .code
36321 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
36322 .endd
36323 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
36324 and "ebay.com", plus all domains and identities that have signatures in the message.
36325 You can also be more creative in constructing your policy. For example:
36326 .code
36327 dkim_verify_signers = $sender_address_domain:$dkim_signers
36328 .endd
36329
36330 If a domain or identity is listed several times in the (expanded) value of
36331 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
36332
36333
36334 Inside the &%acl_smtp_dkim%&, the following expansion variables are
36335 available (from most to least important):
36336
36337
36338 .vlist
36339 .vitem &%$dkim_cur_signer%&
36340 The signer that is being evaluated in this ACL run. This can be a domain or
36341 an identity. This is one of the list items from the expanded main option
36342 &%dkim_verify_signers%& (see above).
36343 .vitem &%$dkim_verify_status%&
36344 A string describing the general status of the signature. One of
36345 .ilist
36346 &%none%&: There is no signature in the message for the current domain or
36347 identity (as reflected by &%$dkim_cur_signer%&).
36348 .next
36349 &%invalid%&: The signature could not be verified due to a processing error.
36350 More detail is available in &%$dkim_verify_reason%&.
36351 .next
36352 &%fail%&: Verification of the signature failed.  More detail is
36353 available in &%$dkim_verify_reason%&.
36354 .next
36355 &%pass%&: The signature passed verification. It is valid.
36356 .endlist
36357 .vitem &%$dkim_verify_reason%&
36358 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
36359 "fail" or "invalid". One of
36360 .ilist
36361 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
36362 key for the domain could not be retrieved. This may be a temporary problem.
36363 .next
36364 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
36365 record for the domain is syntactically invalid.
36366 .next
36367 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
36368 body hash does not match the one specified in the signature header. This
36369 means that the message body was modified in transit.
36370 .next
36371 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
36372 could not be verified. This may mean that headers were modified,
36373 re-written or otherwise changed in a way which is incompatible with
36374 DKIM verification. It may of course also mean that the signature is forged.
36375 .endlist
36376 .vitem &%$dkim_domain%&
36377 The signing domain. IMPORTANT: This variable is only populated if there is
36378 an actual signature in the message for the current domain or identity (as
36379 reflected by &%$dkim_cur_signer%&).
36380 .vitem &%$dkim_identity%&
36381 The signing identity, if present. IMPORTANT: This variable is only populated
36382 if there is an actual signature in the message for the current domain or
36383 identity (as reflected by &%$dkim_cur_signer%&).
36384 .vitem &%$dkim_selector%&
36385 The key record selector string.
36386 .vitem &%$dkim_algo%&
36387 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
36388 .vitem &%$dkim_canon_body%&
36389 The body canonicalization method. One of 'relaxed' or 'simple'.
36390 .vitem &%dkim_canon_headers%&
36391 The header canonicalization method. One of 'relaxed' or 'simple'.
36392 .vitem &%$dkim_copiedheaders%&
36393 A transcript of headers and their values which are included in the signature
36394 (copied from the 'z=' tag of the signature).
36395 .vitem &%$dkim_bodylength%&
36396 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
36397 limit was set by the signer, "9999999999999" is returned. This makes sure
36398 that this variable always expands to an integer value.
36399 .vitem &%$dkim_created%&
36400 UNIX timestamp reflecting the date and time when the signature was created.
36401 When this was not specified by the signer, "0" is returned.
36402 .vitem &%$dkim_expires%&
36403 UNIX timestamp reflecting the date and time when the signer wants the
36404 signature to be treated as "expired". When this was not specified by the
36405 signer, "9999999999999" is returned. This makes it possible to do useful
36406 integer size comparisons against this value.
36407 .vitem &%$dkim_headernames%&
36408 A colon-separated list of names of headers included in the signature.
36409 .vitem &%$dkim_key_testing%&
36410 "1" if the key record has the "testing" flag set, "0" if not.
36411 .vitem &%$nosubdomains%&
36412 "1" if the key record forbids subdomaining, "0" otherwise.
36413 .vitem &%$dkim_key_srvtype%&
36414 Service type (tag s=) from the key record. Defaults to "*" if not specified
36415 in the key record.
36416 .vitem &%$dkim_key_granularity%&
36417 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
36418 in the key record.
36419 .vitem &%$dkim_key_notes%&
36420 Notes from the key record (tag n=).
36421 .endlist
36422
36423 In addition, two ACL conditions are provided:
36424
36425 .vlist
36426 .vitem &%dkim_signers%&
36427 ACL condition that checks a colon-separated list of domains or identities
36428 for a match against the domain or identity that the ACL is currently verifying
36429 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
36430 verb to a group of domains or identities. For example:
36431
36432 .code
36433 # Warn when Mail purportedly from GMail has no signature at all
36434 warn log_message = GMail sender without DKIM signature
36435      sender_domains = gmail.com
36436      dkim_signers = gmail.com
36437      dkim_status = none
36438 .endd
36439
36440 .vitem &%dkim_status%&
36441 ACL condition that checks a colon-separated list of possible DKIM verification
36442 results against the actual result of verification. This is typically used
36443 to restrict an ACL verb to a list of verification outcomes, for example:
36444
36445 .code
36446 deny message = Mail from Paypal with invalid/missing signature
36447      sender_domains = paypal.com:paypal.de
36448      dkim_signers = paypal.com:paypal.de
36449      dkim_status = none:invalid:fail
36450 .endd
36451
36452 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
36453 see the documentation of the &%$dkim_verify_status%& expansion variable above
36454 for more information of what they mean.
36455 .endlist
36456
36457 . ////////////////////////////////////////////////////////////////////////////
36458 . ////////////////////////////////////////////////////////////////////////////
36459
36460 .chapter "Adding new drivers or lookup types" "CHID13" &&&
36461          "Adding drivers or lookups"
36462 .cindex "adding drivers"
36463 .cindex "new drivers, adding"
36464 .cindex "drivers" "adding new"
36465 The following actions have to be taken in order to add a new router, transport,
36466 authenticator, or lookup type to Exim:
36467
36468 .olist
36469 Choose a name for the driver or lookup type that does not conflict with any
36470 existing name; I will use &"newdriver"& in what follows.
36471 .next
36472 Add to &_src/EDITME_& the line:
36473 .display
36474 <&'type'&>&`_NEWDRIVER=yes`&
36475 .endd
36476 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
36477 code is not to be included in the binary by default, comment this line out. You
36478 should also add any relevant comments about the driver or lookup type.
36479 .next
36480 Add to &_src/config.h.defaults_& the line:
36481 .code
36482 #define <type>_NEWDRIVER
36483 .endd
36484 .next
36485 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
36486 and create a table entry as is done for all the other drivers and lookup types.
36487 .next
36488 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
36489 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
36490 Add your &`NEWDRIVER`& to that list.
36491 As long as the dynamic module would be named &_newdriver.so_&, you can use the
36492 simple form that most lookups have.
36493 .next
36494 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
36495 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
36496 driver or lookup type and add it to the definition of OBJ.
36497 .next
36498 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
36499 &_src_&.
36500 .next
36501 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
36502 as for other drivers and lookups.
36503 .endlist
36504
36505 Then all you need to do is write the code! A good way to start is to make a
36506 proforma by copying an existing module of the same type, globally changing all
36507 occurrences of the name, and cutting out most of the code. Note that any
36508 options you create must be listed in alphabetical order, because the tables are
36509 searched using a binary chop procedure.
36510
36511 There is a &_README_& file in each of the sub-directories of &_src_& describing
36512 the interface that is expected.
36513
36514
36515
36516
36517 . ////////////////////////////////////////////////////////////////////////////
36518 . ////////////////////////////////////////////////////////////////////////////
36519
36520 . /////////////////////////////////////////////////////////////////////////////
36521 . These lines are processing instructions for the Simple DocBook Processor that
36522 . Philip Hazel has developed as a less cumbersome way of making PostScript and
36523 . PDFs than using xmlto and fop. They will be ignored by all other XML
36524 . processors.
36525 . /////////////////////////////////////////////////////////////////////////////
36526
36527 .literal xml
36528 <?sdop
36529   format="newpage"
36530   foot_right_recto="&chaptertitle;"
36531   foot_right_verso="&chaptertitle;"
36532 ?>
36533 .literal off
36534
36535 .makeindex "Options index"   "option"
36536 .makeindex "Variables index" "variable"
36537 .makeindex "Concept index"   "concept"
36538
36539
36540 . /////////////////////////////////////////////////////////////////////////////
36541 . /////////////////////////////////////////////////////////////////////////////